Class: Github::GitData::Blobs

Inherits:

API

• Object
• API
• Github::GitData::Blobs

Defined in:

lib/github_api/git_data/blobs.rb

Overview

Since blobs can be any arbitrary binary data, the input and responses for the blob api takes an encoding parameter that can be either utf-8 or base64. If your data cannot be losslessly sent as a UTF-8 string, you can base64 encode it.

Constant Summary

VALID_BLOB_PARAM_NAMES =

%w[ content encoding ].freeze

Constants included from Request

Request::METHODS, Request::METHODS_WITH_BODIES

Constants included from Connection

Connection::ALLOWED_OPTIONS

Constants included from Constants

Constants::ACCEPT, Constants::ACCEPTED_OAUTH_SCOPES, Constants::ACCEPT_CHARSET, Constants::CACHE_CONTROL, Constants::CONTENT_LENGTH, Constants::CONTENT_TYPE, Constants::DATE, Constants::ETAG, Constants::HEADER_LAST, Constants::HEADER_LINK, Constants::HEADER_NEXT, Constants::LOCATION, Constants::META_FIRST, Constants::META_LAST, Constants::META_NEXT, Constants::META_PREV, Constants::META_REL, Constants::OAUTH_SCOPES, Constants::PARAM_PAGE, Constants::PARAM_PER_PAGE, Constants::PARAM_START_PAGE, Constants::RATELIMIT_LIMIT, Constants::RATELIMIT_REMAINING, Constants::SERVER, Constants::USER_AGENT

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Instance Attribute Summary

Attributes inherited from API

#current_options

Attributes included from Authorization

#scopes

Instance Method Summary

• #create(*args) ⇒ Object

  Create a blob.

• #get(*args) ⇒ Object (also: #find)

  Get a blob.

Methods inherited from API

#api_methods_in, #append_arguments, #arguments, inherited, #initialize, #method_missing, #process_basic_auth, #set, #setup, #with, #yield_or_eval

Methods included from RateLimit

#ratelimit, #ratelimit_remaining

Methods included from Request

#delete_request, #get_request, #patch_request, #post_request, #put_request, #request

Methods included from Connection

#caching?, #clear_cache, #connection, #default_middleware, #default_options, #stack

Methods included from MimeType

#lookup_media, #parse

Methods included from Authorization

#auth_code, #authenticated?, #authentication, #authorize_url, #basic_authed?, #client, #get_token

Constructor Details

This class inherits a constructor from Github::API

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Github::API

Instance Method Details

#create(*args) ⇒ Object

Create a blob

Inputs

• :content - String of content

• :encoding - String containing encodingutf-8 or base64

Examples

github = Github.new
github.git_data.blobs.create 'user-name', 'repo-name',
  "content" => "Content of the blob",
  "encoding" => "utf-8"

# File 'lib/github_api/git_data/blobs.rb', line 36

def create(*args)
  arguments(args, :required => [:user, :repo]) do
    sift VALID_BLOB_PARAM_NAMES
    assert_required VALID_BLOB_PARAM_NAMES
  end

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

#get(*args) ⇒ Object Also known as: find

Get a blob

Examples

github = Github.new
github.git_data.blobs.get 'user-name', 'repo-name', 'sha'

# File 'lib/github_api/git_data/blobs.rb', line 18

def get(*args)
  arguments(args, :required => [:user, :repo, :sha])

  get_request("/repos/#{user}/#{repo}/git/blobs/#{sha}", arguments.params)
end