### Home Classes Methods

### In Files

- lib/github_api/git_data/trees.rb

### Parent

API

### Methods

- #create
- #find
- #get

### Class/Module Index

Quicksearch

- Github
- Github::API
- Github::Activity
- Github::Activity::Events
- Github::Activity::Notifications
- Github::Activity::Starring
- Github::Activity::Watching
- Github::ApiFactory
- Github::Arguments
- Github::Authorization
- Github::Authorizations
- Github::AutoloadHelper
- Github::Client
- Github::Configuration
- Github::Connection
- Github::Constants
- Github::CoreExt
- Github::CoreExt::OrderedHash
- Github::Descendants
- Github::Emojis
- Github::Error
- Github::Error::BadRequest
- Github::Error::ClientError
- Github::Error::Forbidden
- Github::Error::GithubError
- Github::Error::InternalServerError
- Github::Error::InvalidOptions
- Github::Error::NotAcceptable
- Github::Error::NotFound
- Github::Error::RequiredParams
- Github::Error::ServiceError
- Github::Error::ServiceUnavailable
- Github::Error::Unauthorized
- Github::Error::UnknownValue
- Github::Error::UnprocessableEntity
- Github::Error::Validations
- Github::Gists
- Github::Gists::Comments
- Github::GitData
- Github::GitData::Blobs
- Github::GitData::Commits
- Github::GitData::References
- Github::GitData::Tags
- Github::GitData::Trees
- Github::Gitignore
- Github::Issues
- Github::Issues::Assignees
- Github::Issues::Comments
- Github::Issues::Events
- Github::Issues::Labels
- Github::Issues::Milestones
- Github::Jsonable
- Github::Markdown
- Github::Meta
- Github::MimeType
- Github::Normalizer
- Github::Orgs
- Github::Orgs::Members
- Github::Orgs::Teams
- Github::PageIterator
- Github::PageLinks
- Github::PagedRequest
- Github::Pagination
- Github::ParameterFilter
- Github::ParamsHash
- Github::PullRequests
- Github::PullRequests::Comments
- Github::RateLimit
- Github::Repos
- Github::Repos::Collaborators
- Github::Repos::Comments
- Github::Repos::Commits
- Github::Repos::Contents
- Github::Repos::Downloads
- Github::Repos::Forks
- Github::Repos::Hooks
- Github::Repos::Keys
- Github::Repos::Merging
- Github::Repos::PubSubHubbub
- Github::Repos::Statistics
- Github::Repos::Statuses
- Github::Request
- Github::Request::BasicAuth
- Github::Request::Jsonize
- Github::Request::OAuth2
- Github::Resource
- Github::Response
- Github::Response::Header
- Github::Response::Jsonize
- Github::Response::Mashify
- Github::Response::RaiseError
- Github::Response::Xmlize
- Github::ResponseWrapper
- Github::S3Uploader
- Github::Say
- Github::Scopes
- Github::Search
- Github::Users
- Github::Users::Emails
- Github::Users::Followers
- Github::Users::Keys
- Github::Utils
- Github::Utils::Url
- Github::VERSION
- Github::Validations
- Github::Validations::Format
- Github::Validations::Presence
- Github::Validations::Required
- Github::Validations::Token
- Hash

No matching classes.

# Github::GitData::Trees

### Constants

VALID_TREE_PARAM_NAMES
VALID_TREE_PARAM_VALUES

### Public Instance Methods

create(*args) click to toggle source

Create a tree

The tree creation API will take nested entries as well. If both a tree and a nested path modifying that tree are specified, it will overwrite the contents of that tree with the new path contents and write a new tree out.

# Parameters

- `:base_tree` - optional string of the SHA1 of the tree you want to update with new data

- `:tree` - array of hash objects(of `:path`, `:mode`, `:type` and `sha`)

- tree.path | String of the file referenced in the tree

- tree.mode | String of the file mode - one of `100644` for file(blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit) or `120000` for a blob that specifies the path of a symlink

- tree.type | String of `blob`, `tree`, `commit`

- tree.sha | String of SHA1 checksum ID of the object in the tree

- tree.content | String of content you want this file to have - GitHub will write this blob out and use the SHA for this entry. Use either this or `tree.sha`

# Examples

    github = Github.new
    github.git_data.trees.create 'user-name', 'repo-name',
      "tree" => [
        {
          "path" => "file.rb",
          "mode" => "100644",
          "type" => "blob",
          "sha" => "44b4fc6d56897b048c772eb4087f854f46256132"
        },
        ...
      ]

    # File lib/github_api/git_data/trees.rb, line 80
    def create(*args)
      arguments(args, :required => [:user, :repo]) do
        assert_required ] tree ]
        sift VALID_TREE_PARAM_NAMES, 'tree', { recursive: true }
        assert_values VALID_TREE_PARAM_VALUES, 'tree'
      end

      post_request("/repos/#{user}/#{repo}/git/trees", arguments.params)
    end

find(*args) click to toggle source
Alias for: get
get(*args) click to toggle source

Get a tree

# Examples

    github = Github.new
    github.git_data.trees.get 'user-name', 'repo-name', 'sha'
    github.git_data.trees.get 'user-name', 'repo-name', 'sha' do |file|
      file.path
    end

Get a tree recursively

# Examples

    github = Github.new
    github.git_data.trees.get 'user-name', 'repo-name', 'sha', 'recursive' => true

    # File lib/github_api/git_data/trees.rb, line 36
    def get(*args)
      arguments(args, :required => [:user, :repo, :sha])
      params = arguments.params

      response = if params['recursive']
        params['recursive'] = 1
        get_request("/repos/#{user}/#{repo}/git/trees/#{sha}", params)
      else
        get_request("/repos/#{user}/#{repo}/git/trees/#{sha.to_s}", params)
      end
      return response unless block_given?
      response.tree.each { |el| yield el }
    end

Also aliased as: find

[Validate]

Generated with the Darkfish Rdoc Generator 2.