Class: Gista::GistRequest

Inherits:

ApiRequest

• Object
• ApiRequest
• Gista::GistRequest

Defined in:

lib/gista/gist_request.rb

Overview

Special Github API request to create a new gist. It requires an OAuth token for authorization, and options for what file to post.

See the API docs for what options are expected to create a new Gist.

Examples:

Creating a Gist

GistRequest.new('acc829df', {
  public: false,
  files: {
    file1: { content: 'my content' }
  }
}).fetch('html_url')
# => "http://gist.github.com/fbed697547047a733434"

See Also:

• http://developer.github.com/v3/gists/#create-a-gist

Constant Summary

Constants inherited from ApiRequest

ApiRequest::CONTENT_TYPE, ApiRequest::OPEN_TIMEOUT, ApiRequest::PORT, ApiRequest::READ_TIMEOUT, ApiRequest::URL

Instance Attribute Summary

• #options ⇒ Hash readonly

  Options containing information about files, filenames and visibility.

• #token ⇒ String readonly

  Authorization token to authorize with Github.

Instance Method Summary

• #initialize(token, options = {}) ⇒ GistRequest constructor

  A new instance of GistRequest.

Methods inherited from ApiRequest

#fetch

Constructor Details

#initialize(token, options = {}) ⇒ GistRequest

Returns a new instance of GistRequest.

# File 'lib/gista/gist_request.rb', line 29

def initialize(token, options = {})
  @token, @options = token, options
end

Instance Attribute Details

#options ⇒ Hash (readonly)

Options containing information about files, filenames and visibility

Returns:

• (Hash)

# File 'lib/gista/gist_request.rb', line 27

def options
  @options
end

#token ⇒ String (readonly)

Authorization token to authorize with Github.

Returns:

• (String)

See Also:

• http://developer.github.com/v3/oauth/#scopes
• TokenRequest

# File 'lib/gista/gist_request.rb', line 23

def token
  @token
end