Module: Octokit::Configurable

Included in:

Octokit, Client

Defined in:

lib/octokit/configurable.rb

Overview

Configuration options for Client, defaulting to values in Default

Instance Attribute Summary

• #access_token ⇒ Object

  Returns the value of attribute access_token.

• #api_endpoint ⇒ String

  Base URL for API requests.

• #auto_paginate ⇒ Boolean

  Auto fetch next page of results until rate limit reached.

• #client_id ⇒ String

  Configure OAuth app key.

• #client_secret ⇒ Object

  Returns the value of attribute client_secret.

• #connection_options ⇒ Hash

  Configure connection options for Faraday.

• #default_media_type ⇒ String

  Configure preferred media type (for API versioning, for example).

• #login ⇒ String

  GitHub username for Basic Authentication.

• #middleware ⇒ Faraday::Builder or Faraday::RackBuilder

  Configure middleware for Faraday.

• #netrc ⇒ Boolean

  Instruct Octokit to get credentials from .netrc file.

• #netrc_file ⇒ String

  Path to .netrc file.

• #password ⇒ String writeonly

  GitHub password for Basic Authentication.

• #per_page ⇒ String

  Configure page size for paginated results.

• #proxy ⇒ String

  URI for proxy server.

• #user_agent ⇒ String

  Configure User-Agent header for requests.

• #web_endpoint ⇒ String

  Base URL for generated web URLs.

Class Method Summary

• .keys ⇒ Array

  List of configurable keys for Client.

Instance Method Summary

• #configure {|_self| ... } ⇒ Object

  Set configuration options using a block.

• #netrc? ⇒ Boolean
• #reset! ⇒ Object (also: #setup)

  Reset configuration options to default values.

Instance Attribute Details

#access_token ⇒ Object

Returns the value of attribute access_token.

# File 'lib/octokit/configurable.rb', line 46

def access_token
  @access_token
end

#api_endpoint ⇒ String

# File 'lib/octokit/configurable.rb', line 46

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent

#auto_paginate ⇒ Boolean

# File 'lib/octokit/configurable.rb', line 46

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent

#client_id ⇒ String

Returns Configure OAuth app key.

See Also:

• http://developer.github.com/v3/oauth/

# File 'lib/octokit/configurable.rb', line 46

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent

#client_secret ⇒ Object

Returns the value of attribute client_secret.

# File 'lib/octokit/configurable.rb', line 46

def client_secret
  @client_secret
end

#connection_options ⇒ Hash

Returns Configure connection options for Faraday.

See Also:

• https://github.com/lostisland/faraday

# File 'lib/octokit/configurable.rb', line 46

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent

#default_media_type ⇒ String

Returns Configure preferred media type (for API versioning, for example).

See Also:

• http://developer.github.com/v3/media/

# File 'lib/octokit/configurable.rb', line 46

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent

#login ⇒ String

# File 'lib/octokit/configurable.rb', line 46

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent

#middleware ⇒ Faraday::Builder or Faraday::RackBuilder

Returns Configure middleware for Faraday.

See Also:

• https://github.com/lostisland/faraday

# File 'lib/octokit/configurable.rb', line 46

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent

#netrc ⇒ Boolean

# File 'lib/octokit/configurable.rb', line 46

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent

#netrc_file ⇒ String

# File 'lib/octokit/configurable.rb', line 46

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent

#password=(value) ⇒ String (writeonly)

# File 'lib/octokit/configurable.rb', line 46

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent

#per_page ⇒ String

# File 'lib/octokit/configurable.rb', line 46

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent

#proxy ⇒ String

Returns URI for proxy server.

See Also:

• https://github.com/lostisland/faraday

# File 'lib/octokit/configurable.rb', line 46

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent

#user_agent ⇒ String

# File 'lib/octokit/configurable.rb', line 46

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent

#web_endpoint ⇒ String

Base URL for generated web URLs

# File 'lib/octokit/configurable.rb', line 46

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent

Class Method Details

.keys ⇒ Array

List of configurable keys for Octokit::Client

# File 'lib/octokit/configurable.rb', line 56

def keys
  @keys ||= [
    :access_token,
    :api_endpoint,
    :auto_paginate,
    :client_id,
    :client_secret,
    :connection_options,
    :default_media_type,
    :login,
    :middleware,
    :netrc,
    :netrc_file,
    :per_page,
    :password,
    :proxy,
    :user_agent,
    :web_endpoint
  ]
end

Instance Method Details

#configure {|_self| ... } ⇒ Object

Set configuration options using a block

Yields:

• (_self)

Yield Parameters:

• _self (Octokit::Configurable) —

  the object that the method was called on

# File 'lib/octokit/configurable.rb', line 79

def configure
  yield self
end

#netrc? ⇒ Boolean

# File 'lib/octokit/configurable.rb', line 109

def netrc?
  !!@netrc
end

#reset! ⇒ Object Also known as: setup

Reset configuration options to default values

# File 'lib/octokit/configurable.rb', line 84

def reset!
  Octokit::Configurable.keys.each do |key|
    instance_variable_set(:"@#{key}", Octokit::Default.options[key])
  end
  self
end