123456789_123456789_123456789_123456789_123456789_

Module: Octokit::Client::Objects

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
::Octokit::Client
Defined in: lib/octokit/client/objects.rb

Overview

Methods for the Git Data API

See Also:

Instance Method Summary

Instance Method Details

#blob(repo, blob_sha, options = {}) ⇒ Sawyer::Resource

Get a single blob, fetching its content and encoding

Examples:

Fetch a blob and inspect its contents

blob = Octokit.blob("octocat/Hello-World", "827efc6d56897b048c772eb4087f854f46256132")
blob.encoding # => "utf-8"
blob.content # => "Foo bar baz"

Fetch a base64-encoded blob and inspect its contents

require "base64"
blob = Octokit.blob("octocat/Hello-World", "827efc6d56897b048c772eb4087f854f46256132")
blob.encoding # => "base64"
blob.content # => "Rm9vIGJhciBiYXo="
Base64.decode64(blob.content) # => "Foo bar baz"

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository

  • blob_sha (String) —

    The SHA of the blob to fetch

Returns:

  • (Sawyer::Resource) —

    A hash representing the fetched blob

See Also:

[ GitHub ] 

  


# File 'lib/octokit/client/objects.rb', line 61



def blob(repo, blob_sha, options = {})
  get "#{Repository.path repo}/git/blobs/#{blob_sha}", options
end


  








  

    #create_blob(repo, content, encoding = 'utf-8', options = {})  ⇒ String 
  



  

    
Create a blob


  





    

    
Examples:

        
Create a blob containing foo bar baz



      
Octokit.create_blob("octocat/Hello-World", "foo bar baz")

        
Create a blob containing foo bar baz, encoded using base64



      
require "base64"
Octokit.create_blob("octocat/Hello-World", Base64.encode64("foo bar baz"), "base64")

  


Parameters:


    
  
  • 
    repo
    (Integer, String, Hash, Repository)
—    
    A GitHub repository
    

    
  
    • 
  
  • 
    content
    (String)
—    
    Content of the blob
    

    
  
    • 
  
  • 
    encoding
    (String)
    (defaults to: 'utf-8')
—    
    The content's encoding. utf-8 and base64 are accepted. If your data cannot be losslessly sent as a UTF-8 string, you can base64 encode it
    

    
  
    • 



Returns:


    
  
  • 
    (String)
—    
    The new blob's SHA, e.g. 827efc6d56897b048c772eb4087f854f46256132
    

    
  
    • 


  
See Also:

  



  [ GitHub ]


  

  


# File 'lib/octokit/client/objects.rb', line 77



def create_blob(repo, content, encoding = 'utf-8', options = {})
  parameters = {
    content: content,
    encoding: encoding
  }
  blob = post "#{Repository.path repo}/git/blobs", options.merge(parameters)

  blob.sha
end


  








  

    #create_tag(repo, tag, message, object_sha, type, tagger_name, tagger_email, tagger_date, options = {})  ⇒ Sawyer::Resource 
  



  

    
Create a tag


Requires authenticated client.


  





    

    
Examples:

      
@client.create_tag(
  "octokit/octokit.rb",
  "v9000.0.0",
  "Version 9000\n",
  "f4cdf6eb734f32343ce3f27670c17b35f54fd82e",
  "commit",
  "Wynn Netherland",
  "wynn.netherland@gmail.com",
  "2012-06-03T17:03:11-07:00"
)

  


Parameters:


    
  
  • 
    repo
    (Integer, String, Hash, Repository)
—    
    A GitHub repository.
    

    
  
    • 
  
  • 
    tag
    (String)
—    
    Tag string.
    

    
  
    • 
  
  • 
    message
    (String)
—    
    Tag message.
    

    
  
    • 
  
  • 
    object_sha
    (String)
—    
    SHA of the git object this is tagging.
    

    
  
    • 
  
  • 
    type
    (String)
—    
    Type of the object we're tagging. Normally this is
a commit but it can also be a tree or a blob.
    

    
  
    • 
  
  • 
    tagger_name
    (String)
—    
    Name of the author of the tag.
    

    
  
    • 
  
  • 
    tagger_email
    (String)
—    
    Email of the author of the tag.
    

    
  
    • 
  
  • 
    tagger_date
    (string)
—    
    Timestamp of when this object was tagged.
    

    
  
    • 



Returns:


    
  
  • 
    (Sawyer::Resource)
—    
    Hash representing new tag.
    

    
  
    • 


  
See Also:

  



  [ GitHub ]


  

  


# File 'lib/octokit/client/objects.rb', line 125



def create_tag(repo, tag, message, object_sha, type, tagger_name, tagger_email, tagger_date, options = {})
  options.merge!(
    tag: tag,
    message: message,
    object: object_sha,
    type: type,
    tagger: {
      name: tagger_name,
      email: tagger_email,
      date: tagger_date
    }
  )
  post "#{Repository.path repo}/git/tags", options
end


  








  

    #create_tree(repo, tree, options = {})  ⇒ Sawyer::Resource 
  



  

    
Create a tree


Pass :base_tree => "827efc6..." in options to update an existing tree with new data.


  





    

    
Examples:

        
Create a tree containing one file



      
tree = Octokit.create_tree("octocat/Hello-World", [ { :path => "file.rb", :mode => "100644", :type => "blob", :sha => "44b4fc6d56897b048c772eb4087f854f46256132" } ])
tree.sha # => "cd8274d15fa3ae2ab983129fb037999f264ba9a7"
tree.tree.first.path # => "file.rb"

  


Parameters:


    
  
  • 
    repo
    (Integer, String, Hash, Repository)
—    
    A GitHub repository
    

    
  
    • 
  
  • 
    tree
    (Array)
—    
    An array of hashes representing a tree structure
    

    
  
    • 



Returns:


    
  
  • 
    (Sawyer::Resource)
—    
    A hash representing the new tree
    

    
  
    • 


  
See Also:

  



  [ GitHub ]


  

  


# File 'lib/octokit/client/objects.rb', line 40



def create_tree(repo, tree, options = {})
  parameters = { tree: tree }
  post "#{Repository.path repo}/git/trees", options.merge(parameters)
end


  








  

    #tag(repo, tag_sha, options = {})  ⇒ Sawyer::Resource 
  



  

    
Get a tag


  





    

    
Examples:

        
Fetch a tag



      
Octokit.tag('octokit/octokit.rb', '23aad20633f4d2981b1c7209a800db3014774e96')

  


Parameters:


    
  
  • 
    repo
    (Integer, String, Hash, Repository)
—    
    A GitHub repository.
    

    
  
    • 
  
  • 
    tag_sha
    (String)
—    
    The SHA of the tag to fetch.
    

    
  
    • 



Returns:


    
  
  • 
    (Sawyer::Resource)
—    
    Hash representing the tag.
    

    
  
    • 


  
See Also:

  



  [ GitHub ]


  

  


# File 'lib/octokit/client/objects.rb', line 95



def tag(repo, tag_sha, options = {})
  get "#{Repository.path repo}/git/tags/#{tag_sha}", options
end


  








  

    #tree(repo, tree_sha, options = {})  ⇒ Sawyer::Resource 
  



  

    
Get a single tree, fetching information about its root-level objects


Pass :recursive => true in options to fetch information about all of the tree's objects, including those in subdirectories.


  





    

    
Examples:

        
Fetch a tree and inspect the path of one of its files



      
tree = Octokit.tree("octocat/Hello-World", "9fb037999f264ba9a7fc6274d15fa3ae2ab98312")
tree.tree.first.path # => "file.rb"

        
Fetch a tree recursively



      
tree = Octokit.tree("octocat/Hello-World", "fc6274d15fa3ae2ab983129fb037999f264ba9a7", :recursive => true)
tree.tree.first.path # => "subdir/file.txt"

  


Parameters:


    
  
  • 
    repo
    (Integer, String, Hash, Repository)
—    
    A GitHub repository
    

    
  
    • 
  
  • 
    tree_sha
    (String)
—    
    The SHA of the tree to fetch
    

    
  
    • 



Returns:


    
  
  • 
    (Sawyer::Resource)
—    
    A hash representing the fetched tree
    

    
  
    • 


  
See Also:

  



  [ GitHub ]


  

  


# File 'lib/octokit/client/objects.rb', line 24



def tree(repo, tree_sha, options = {})
  get "#{Repository.path repo}/git/trees/#{tree_sha}", options
end