module Octokit::Configurable

Configuration options for {Client}, defaulting to values in {Default}

Attributes

access_token[RW]

@!attribute [w] access_token

@see https://developer.github.com/v3/oauth/
@return [String] OAuth2 access token for authentication

@!attribute api_endpoint

@return [String] Base URL for API requests. default: https://api.github.com/

@!attribute auto_paginate

@return [Boolean] Auto fetch next page of results until rate limit reached

@!attribute [w] bearer_token

@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration
@return [String] JWT bearer token for authentication

@!attribute client_id

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app key

@!attribute [w] client_secret

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app secret

@!attribute default_media_type

@see https://developer.github.com/v3/media/
@return [String] Configure preferred media type (for API versioning, for example)

@!attribute connection_options

@see https://github.com/lostisland/faraday
@return [Hash] Configure connection options for Faraday

@!attribute login

@return [String] GitHub username for Basic Authentication

@!attribute management_console_password

@return [String] An admin password set up for your GitHub Enterprise management console

@!attribute management_console_endpoint

@return [String] Base URL for API requests to the GitHub Enterprise management console

@!attribute middleware

@see https://github.com/lostisland/faraday
@return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday

@!attribute netrc

@return [Boolean] Instruct Octokit to get credentials from .netrc file

@!attribute netrc_file

@return [String] Path to .netrc file. default: ~/.netrc

@!attribute [w] password

@return [String] GitHub password for Basic Authentication

@!attribute per_page

@return [String] Configure page size for paginated results. API default: 30

@!attribute proxy

@see https://github.com/lostisland/faraday
@return [String] URI for proxy server

@!attribute ssl_verify_mode

@see https://github.com/lostisland/faraday
@return [String] SSL verify mode for ssl connections

@!attribute user_agent

@return [String] Configure User-Agent header for requests.

@!attribute web_endpoint

@return [String] Base URL for web URLs. default: https://github.com/
api_endpoint[W]
auto_paginate[RW]

@!attribute [w] access_token

@see https://developer.github.com/v3/oauth/
@return [String] OAuth2 access token for authentication

@!attribute api_endpoint

@return [String] Base URL for API requests. default: https://api.github.com/

@!attribute auto_paginate

@return [Boolean] Auto fetch next page of results until rate limit reached

@!attribute [w] bearer_token

@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration
@return [String] JWT bearer token for authentication

@!attribute client_id

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app key

@!attribute [w] client_secret

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app secret

@!attribute default_media_type

@see https://developer.github.com/v3/media/
@return [String] Configure preferred media type (for API versioning, for example)

@!attribute connection_options

@see https://github.com/lostisland/faraday
@return [Hash] Configure connection options for Faraday

@!attribute login

@return [String] GitHub username for Basic Authentication

@!attribute management_console_password

@return [String] An admin password set up for your GitHub Enterprise management console

@!attribute management_console_endpoint

@return [String] Base URL for API requests to the GitHub Enterprise management console

@!attribute middleware

@see https://github.com/lostisland/faraday
@return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday

@!attribute netrc

@return [Boolean] Instruct Octokit to get credentials from .netrc file

@!attribute netrc_file

@return [String] Path to .netrc file. default: ~/.netrc

@!attribute [w] password

@return [String] GitHub password for Basic Authentication

@!attribute per_page

@return [String] Configure page size for paginated results. API default: 30

@!attribute proxy

@see https://github.com/lostisland/faraday
@return [String] URI for proxy server

@!attribute ssl_verify_mode

@see https://github.com/lostisland/faraday
@return [String] SSL verify mode for ssl connections

@!attribute user_agent

@return [String] Configure User-Agent header for requests.

@!attribute web_endpoint

@return [String] Base URL for web URLs. default: https://github.com/
bearer_token[RW]

@!attribute [w] access_token

@see https://developer.github.com/v3/oauth/
@return [String] OAuth2 access token for authentication

@!attribute api_endpoint

@return [String] Base URL for API requests. default: https://api.github.com/

@!attribute auto_paginate

@return [Boolean] Auto fetch next page of results until rate limit reached

@!attribute [w] bearer_token

@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration
@return [String] JWT bearer token for authentication

@!attribute client_id

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app key

@!attribute [w] client_secret

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app secret

@!attribute default_media_type

@see https://developer.github.com/v3/media/
@return [String] Configure preferred media type (for API versioning, for example)

@!attribute connection_options

@see https://github.com/lostisland/faraday
@return [Hash] Configure connection options for Faraday

@!attribute login

@return [String] GitHub username for Basic Authentication

@!attribute management_console_password

@return [String] An admin password set up for your GitHub Enterprise management console

@!attribute management_console_endpoint

@return [String] Base URL for API requests to the GitHub Enterprise management console

@!attribute middleware

@see https://github.com/lostisland/faraday
@return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday

@!attribute netrc

@return [Boolean] Instruct Octokit to get credentials from .netrc file

@!attribute netrc_file

@return [String] Path to .netrc file. default: ~/.netrc

@!attribute [w] password

@return [String] GitHub password for Basic Authentication

@!attribute per_page

@return [String] Configure page size for paginated results. API default: 30

@!attribute proxy

@see https://github.com/lostisland/faraday
@return [String] URI for proxy server

@!attribute ssl_verify_mode

@see https://github.com/lostisland/faraday
@return [String] SSL verify mode for ssl connections

@!attribute user_agent

@return [String] Configure User-Agent header for requests.

@!attribute web_endpoint

@return [String] Base URL for web URLs. default: https://github.com/
client_id[RW]

@!attribute [w] access_token

@see https://developer.github.com/v3/oauth/
@return [String] OAuth2 access token for authentication

@!attribute api_endpoint

@return [String] Base URL for API requests. default: https://api.github.com/

@!attribute auto_paginate

@return [Boolean] Auto fetch next page of results until rate limit reached

@!attribute [w] bearer_token

@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration
@return [String] JWT bearer token for authentication

@!attribute client_id

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app key

@!attribute [w] client_secret

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app secret

@!attribute default_media_type

@see https://developer.github.com/v3/media/
@return [String] Configure preferred media type (for API versioning, for example)

@!attribute connection_options

@see https://github.com/lostisland/faraday
@return [Hash] Configure connection options for Faraday

@!attribute login

@return [String] GitHub username for Basic Authentication

@!attribute management_console_password

@return [String] An admin password set up for your GitHub Enterprise management console

@!attribute management_console_endpoint

@return [String] Base URL for API requests to the GitHub Enterprise management console

@!attribute middleware

@see https://github.com/lostisland/faraday
@return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday

@!attribute netrc

@return [Boolean] Instruct Octokit to get credentials from .netrc file

@!attribute netrc_file

@return [String] Path to .netrc file. default: ~/.netrc

@!attribute [w] password

@return [String] GitHub password for Basic Authentication

@!attribute per_page

@return [String] Configure page size for paginated results. API default: 30

@!attribute proxy

@see https://github.com/lostisland/faraday
@return [String] URI for proxy server

@!attribute ssl_verify_mode

@see https://github.com/lostisland/faraday
@return [String] SSL verify mode for ssl connections

@!attribute user_agent

@return [String] Configure User-Agent header for requests.

@!attribute web_endpoint

@return [String] Base URL for web URLs. default: https://github.com/
client_secret[RW]

@!attribute [w] access_token

@see https://developer.github.com/v3/oauth/
@return [String] OAuth2 access token for authentication

@!attribute api_endpoint

@return [String] Base URL for API requests. default: https://api.github.com/

@!attribute auto_paginate

@return [Boolean] Auto fetch next page of results until rate limit reached

@!attribute [w] bearer_token

@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration
@return [String] JWT bearer token for authentication

@!attribute client_id

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app key

@!attribute [w] client_secret

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app secret

@!attribute default_media_type

@see https://developer.github.com/v3/media/
@return [String] Configure preferred media type (for API versioning, for example)

@!attribute connection_options

@see https://github.com/lostisland/faraday
@return [Hash] Configure connection options for Faraday

@!attribute login

@return [String] GitHub username for Basic Authentication

@!attribute management_console_password

@return [String] An admin password set up for your GitHub Enterprise management console

@!attribute management_console_endpoint

@return [String] Base URL for API requests to the GitHub Enterprise management console

@!attribute middleware

@see https://github.com/lostisland/faraday
@return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday

@!attribute netrc

@return [Boolean] Instruct Octokit to get credentials from .netrc file

@!attribute netrc_file

@return [String] Path to .netrc file. default: ~/.netrc

@!attribute [w] password

@return [String] GitHub password for Basic Authentication

@!attribute per_page

@return [String] Configure page size for paginated results. API default: 30

@!attribute proxy

@see https://github.com/lostisland/faraday
@return [String] URI for proxy server

@!attribute ssl_verify_mode

@see https://github.com/lostisland/faraday
@return [String] SSL verify mode for ssl connections

@!attribute user_agent

@return [String] Configure User-Agent header for requests.

@!attribute web_endpoint

@return [String] Base URL for web URLs. default: https://github.com/
connection_options[RW]

@!attribute [w] access_token

@see https://developer.github.com/v3/oauth/
@return [String] OAuth2 access token for authentication

@!attribute api_endpoint

@return [String] Base URL for API requests. default: https://api.github.com/

@!attribute auto_paginate

@return [Boolean] Auto fetch next page of results until rate limit reached

@!attribute [w] bearer_token

@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration
@return [String] JWT bearer token for authentication

@!attribute client_id

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app key

@!attribute [w] client_secret

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app secret

@!attribute default_media_type

@see https://developer.github.com/v3/media/
@return [String] Configure preferred media type (for API versioning, for example)

@!attribute connection_options

@see https://github.com/lostisland/faraday
@return [Hash] Configure connection options for Faraday

@!attribute login

@return [String] GitHub username for Basic Authentication

@!attribute management_console_password

@return [String] An admin password set up for your GitHub Enterprise management console

@!attribute management_console_endpoint

@return [String] Base URL for API requests to the GitHub Enterprise management console

@!attribute middleware

@see https://github.com/lostisland/faraday
@return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday

@!attribute netrc

@return [Boolean] Instruct Octokit to get credentials from .netrc file

@!attribute netrc_file

@return [String] Path to .netrc file. default: ~/.netrc

@!attribute [w] password

@return [String] GitHub password for Basic Authentication

@!attribute per_page

@return [String] Configure page size for paginated results. API default: 30

@!attribute proxy

@see https://github.com/lostisland/faraday
@return [String] URI for proxy server

@!attribute ssl_verify_mode

@see https://github.com/lostisland/faraday
@return [String] SSL verify mode for ssl connections

@!attribute user_agent

@return [String] Configure User-Agent header for requests.

@!attribute web_endpoint

@return [String] Base URL for web URLs. default: https://github.com/
default_media_type[RW]

@!attribute [w] access_token

@see https://developer.github.com/v3/oauth/
@return [String] OAuth2 access token for authentication

@!attribute api_endpoint

@return [String] Base URL for API requests. default: https://api.github.com/

@!attribute auto_paginate

@return [Boolean] Auto fetch next page of results until rate limit reached

@!attribute [w] bearer_token

@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration
@return [String] JWT bearer token for authentication

@!attribute client_id

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app key

@!attribute [w] client_secret

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app secret

@!attribute default_media_type

@see https://developer.github.com/v3/media/
@return [String] Configure preferred media type (for API versioning, for example)

@!attribute connection_options

@see https://github.com/lostisland/faraday
@return [Hash] Configure connection options for Faraday

@!attribute login

@return [String] GitHub username for Basic Authentication

@!attribute management_console_password

@return [String] An admin password set up for your GitHub Enterprise management console

@!attribute management_console_endpoint

@return [String] Base URL for API requests to the GitHub Enterprise management console

@!attribute middleware

@see https://github.com/lostisland/faraday
@return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday

@!attribute netrc

@return [Boolean] Instruct Octokit to get credentials from .netrc file

@!attribute netrc_file

@return [String] Path to .netrc file. default: ~/.netrc

@!attribute [w] password

@return [String] GitHub password for Basic Authentication

@!attribute per_page

@return [String] Configure page size for paginated results. API default: 30

@!attribute proxy

@see https://github.com/lostisland/faraday
@return [String] URI for proxy server

@!attribute ssl_verify_mode

@see https://github.com/lostisland/faraday
@return [String] SSL verify mode for ssl connections

@!attribute user_agent

@return [String] Configure User-Agent header for requests.

@!attribute web_endpoint

@return [String] Base URL for web URLs. default: https://github.com/
login[W]
management_console_endpoint[W]
management_console_password[W]
middleware[RW]

@!attribute [w] access_token

@see https://developer.github.com/v3/oauth/
@return [String] OAuth2 access token for authentication

@!attribute api_endpoint

@return [String] Base URL for API requests. default: https://api.github.com/

@!attribute auto_paginate

@return [Boolean] Auto fetch next page of results until rate limit reached

@!attribute [w] bearer_token

@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration
@return [String] JWT bearer token for authentication

@!attribute client_id

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app key

@!attribute [w] client_secret

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app secret

@!attribute default_media_type

@see https://developer.github.com/v3/media/
@return [String] Configure preferred media type (for API versioning, for example)

@!attribute connection_options

@see https://github.com/lostisland/faraday
@return [Hash] Configure connection options for Faraday

@!attribute login

@return [String] GitHub username for Basic Authentication

@!attribute management_console_password

@return [String] An admin password set up for your GitHub Enterprise management console

@!attribute management_console_endpoint

@return [String] Base URL for API requests to the GitHub Enterprise management console

@!attribute middleware

@see https://github.com/lostisland/faraday
@return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday

@!attribute netrc

@return [Boolean] Instruct Octokit to get credentials from .netrc file

@!attribute netrc_file

@return [String] Path to .netrc file. default: ~/.netrc

@!attribute [w] password

@return [String] GitHub password for Basic Authentication

@!attribute per_page

@return [String] Configure page size for paginated results. API default: 30

@!attribute proxy

@see https://github.com/lostisland/faraday
@return [String] URI for proxy server

@!attribute ssl_verify_mode

@see https://github.com/lostisland/faraday
@return [String] SSL verify mode for ssl connections

@!attribute user_agent

@return [String] Configure User-Agent header for requests.

@!attribute web_endpoint

@return [String] Base URL for web URLs. default: https://github.com/
netrc[RW]

@!attribute [w] access_token

@see https://developer.github.com/v3/oauth/
@return [String] OAuth2 access token for authentication

@!attribute api_endpoint

@return [String] Base URL for API requests. default: https://api.github.com/

@!attribute auto_paginate

@return [Boolean] Auto fetch next page of results until rate limit reached

@!attribute [w] bearer_token

@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration
@return [String] JWT bearer token for authentication

@!attribute client_id

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app key

@!attribute [w] client_secret

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app secret

@!attribute default_media_type

@see https://developer.github.com/v3/media/
@return [String] Configure preferred media type (for API versioning, for example)

@!attribute connection_options

@see https://github.com/lostisland/faraday
@return [Hash] Configure connection options for Faraday

@!attribute login

@return [String] GitHub username for Basic Authentication

@!attribute management_console_password

@return [String] An admin password set up for your GitHub Enterprise management console

@!attribute management_console_endpoint

@return [String] Base URL for API requests to the GitHub Enterprise management console

@!attribute middleware

@see https://github.com/lostisland/faraday
@return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday

@!attribute netrc

@return [Boolean] Instruct Octokit to get credentials from .netrc file

@!attribute netrc_file

@return [String] Path to .netrc file. default: ~/.netrc

@!attribute [w] password

@return [String] GitHub password for Basic Authentication

@!attribute per_page

@return [String] Configure page size for paginated results. API default: 30

@!attribute proxy

@see https://github.com/lostisland/faraday
@return [String] URI for proxy server

@!attribute ssl_verify_mode

@see https://github.com/lostisland/faraday
@return [String] SSL verify mode for ssl connections

@!attribute user_agent

@return [String] Configure User-Agent header for requests.

@!attribute web_endpoint

@return [String] Base URL for web URLs. default: https://github.com/
netrc_file[RW]

@!attribute [w] access_token

@see https://developer.github.com/v3/oauth/
@return [String] OAuth2 access token for authentication

@!attribute api_endpoint

@return [String] Base URL for API requests. default: https://api.github.com/

@!attribute auto_paginate

@return [Boolean] Auto fetch next page of results until rate limit reached

@!attribute [w] bearer_token

@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration
@return [String] JWT bearer token for authentication

@!attribute client_id

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app key

@!attribute [w] client_secret

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app secret

@!attribute default_media_type

@see https://developer.github.com/v3/media/
@return [String] Configure preferred media type (for API versioning, for example)

@!attribute connection_options

@see https://github.com/lostisland/faraday
@return [Hash] Configure connection options for Faraday

@!attribute login

@return [String] GitHub username for Basic Authentication

@!attribute management_console_password

@return [String] An admin password set up for your GitHub Enterprise management console

@!attribute management_console_endpoint

@return [String] Base URL for API requests to the GitHub Enterprise management console

@!attribute middleware

@see https://github.com/lostisland/faraday
@return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday

@!attribute netrc

@return [Boolean] Instruct Octokit to get credentials from .netrc file

@!attribute netrc_file

@return [String] Path to .netrc file. default: ~/.netrc

@!attribute [w] password

@return [String] GitHub password for Basic Authentication

@!attribute per_page

@return [String] Configure page size for paginated results. API default: 30

@!attribute proxy

@see https://github.com/lostisland/faraday
@return [String] URI for proxy server

@!attribute ssl_verify_mode

@see https://github.com/lostisland/faraday
@return [String] SSL verify mode for ssl connections

@!attribute user_agent

@return [String] Configure User-Agent header for requests.

@!attribute web_endpoint

@return [String] Base URL for web URLs. default: https://github.com/
password[W]
per_page[RW]

@!attribute [w] access_token

@see https://developer.github.com/v3/oauth/
@return [String] OAuth2 access token for authentication

@!attribute api_endpoint

@return [String] Base URL for API requests. default: https://api.github.com/

@!attribute auto_paginate

@return [Boolean] Auto fetch next page of results until rate limit reached

@!attribute [w] bearer_token

@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration
@return [String] JWT bearer token for authentication

@!attribute client_id

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app key

@!attribute [w] client_secret

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app secret

@!attribute default_media_type

@see https://developer.github.com/v3/media/
@return [String] Configure preferred media type (for API versioning, for example)

@!attribute connection_options

@see https://github.com/lostisland/faraday
@return [Hash] Configure connection options for Faraday

@!attribute login

@return [String] GitHub username for Basic Authentication

@!attribute management_console_password

@return [String] An admin password set up for your GitHub Enterprise management console

@!attribute management_console_endpoint

@return [String] Base URL for API requests to the GitHub Enterprise management console

@!attribute middleware

@see https://github.com/lostisland/faraday
@return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday

@!attribute netrc

@return [Boolean] Instruct Octokit to get credentials from .netrc file

@!attribute netrc_file

@return [String] Path to .netrc file. default: ~/.netrc

@!attribute [w] password

@return [String] GitHub password for Basic Authentication

@!attribute per_page

@return [String] Configure page size for paginated results. API default: 30

@!attribute proxy

@see https://github.com/lostisland/faraday
@return [String] URI for proxy server

@!attribute ssl_verify_mode

@see https://github.com/lostisland/faraday
@return [String] SSL verify mode for ssl connections

@!attribute user_agent

@return [String] Configure User-Agent header for requests.

@!attribute web_endpoint

@return [String] Base URL for web URLs. default: https://github.com/
proxy[RW]

@!attribute [w] access_token

@see https://developer.github.com/v3/oauth/
@return [String] OAuth2 access token for authentication

@!attribute api_endpoint

@return [String] Base URL for API requests. default: https://api.github.com/

@!attribute auto_paginate

@return [Boolean] Auto fetch next page of results until rate limit reached

@!attribute [w] bearer_token

@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration
@return [String] JWT bearer token for authentication

@!attribute client_id

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app key

@!attribute [w] client_secret

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app secret

@!attribute default_media_type

@see https://developer.github.com/v3/media/
@return [String] Configure preferred media type (for API versioning, for example)

@!attribute connection_options

@see https://github.com/lostisland/faraday
@return [Hash] Configure connection options for Faraday

@!attribute login

@return [String] GitHub username for Basic Authentication

@!attribute management_console_password

@return [String] An admin password set up for your GitHub Enterprise management console

@!attribute management_console_endpoint

@return [String] Base URL for API requests to the GitHub Enterprise management console

@!attribute middleware

@see https://github.com/lostisland/faraday
@return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday

@!attribute netrc

@return [Boolean] Instruct Octokit to get credentials from .netrc file

@!attribute netrc_file

@return [String] Path to .netrc file. default: ~/.netrc

@!attribute [w] password

@return [String] GitHub password for Basic Authentication

@!attribute per_page

@return [String] Configure page size for paginated results. API default: 30

@!attribute proxy

@see https://github.com/lostisland/faraday
@return [String] URI for proxy server

@!attribute ssl_verify_mode

@see https://github.com/lostisland/faraday
@return [String] SSL verify mode for ssl connections

@!attribute user_agent

@return [String] Configure User-Agent header for requests.

@!attribute web_endpoint

@return [String] Base URL for web URLs. default: https://github.com/
ssl_verify_mode[RW]

@!attribute [w] access_token

@see https://developer.github.com/v3/oauth/
@return [String] OAuth2 access token for authentication

@!attribute api_endpoint

@return [String] Base URL for API requests. default: https://api.github.com/

@!attribute auto_paginate

@return [Boolean] Auto fetch next page of results until rate limit reached

@!attribute [w] bearer_token

@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration
@return [String] JWT bearer token for authentication

@!attribute client_id

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app key

@!attribute [w] client_secret

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app secret

@!attribute default_media_type

@see https://developer.github.com/v3/media/
@return [String] Configure preferred media type (for API versioning, for example)

@!attribute connection_options

@see https://github.com/lostisland/faraday
@return [Hash] Configure connection options for Faraday

@!attribute login

@return [String] GitHub username for Basic Authentication

@!attribute management_console_password

@return [String] An admin password set up for your GitHub Enterprise management console

@!attribute management_console_endpoint

@return [String] Base URL for API requests to the GitHub Enterprise management console

@!attribute middleware

@see https://github.com/lostisland/faraday
@return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday

@!attribute netrc

@return [Boolean] Instruct Octokit to get credentials from .netrc file

@!attribute netrc_file

@return [String] Path to .netrc file. default: ~/.netrc

@!attribute [w] password

@return [String] GitHub password for Basic Authentication

@!attribute per_page

@return [String] Configure page size for paginated results. API default: 30

@!attribute proxy

@see https://github.com/lostisland/faraday
@return [String] URI for proxy server

@!attribute ssl_verify_mode

@see https://github.com/lostisland/faraday
@return [String] SSL verify mode for ssl connections

@!attribute user_agent

@return [String] Configure User-Agent header for requests.

@!attribute web_endpoint

@return [String] Base URL for web URLs. default: https://github.com/
user_agent[RW]

@!attribute [w] access_token

@see https://developer.github.com/v3/oauth/
@return [String] OAuth2 access token for authentication

@!attribute api_endpoint

@return [String] Base URL for API requests. default: https://api.github.com/

@!attribute auto_paginate

@return [Boolean] Auto fetch next page of results until rate limit reached

@!attribute [w] bearer_token

@see https://developer.github.com/early-access/integrations/authentication/#as-an-integration
@return [String] JWT bearer token for authentication

@!attribute client_id

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app key

@!attribute [w] client_secret

@see https://developer.github.com/v3/oauth/
@return [String] Configure OAuth app secret

@!attribute default_media_type

@see https://developer.github.com/v3/media/
@return [String] Configure preferred media type (for API versioning, for example)

@!attribute connection_options

@see https://github.com/lostisland/faraday
@return [Hash] Configure connection options for Faraday

@!attribute login

@return [String] GitHub username for Basic Authentication

@!attribute management_console_password

@return [String] An admin password set up for your GitHub Enterprise management console

@!attribute management_console_endpoint

@return [String] Base URL for API requests to the GitHub Enterprise management console

@!attribute middleware

@see https://github.com/lostisland/faraday
@return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday

@!attribute netrc

@return [Boolean] Instruct Octokit to get credentials from .netrc file

@!attribute netrc_file

@return [String] Path to .netrc file. default: ~/.netrc

@!attribute [w] password

@return [String] GitHub password for Basic Authentication

@!attribute per_page

@return [String] Configure page size for paginated results. API default: 30

@!attribute proxy

@see https://github.com/lostisland/faraday
@return [String] URI for proxy server

@!attribute ssl_verify_mode

@see https://github.com/lostisland/faraday
@return [String] SSL verify mode for ssl connections

@!attribute user_agent

@return [String] Configure User-Agent header for requests.

@!attribute web_endpoint

@return [String] Base URL for web URLs. default: https://github.com/
web_endpoint[W]

Public Class Methods

keys() click to toggle source

List of configurable keys for {Octokit::Client} @return [Array] of option keys

# File lib/octokit/configurable.rb, line 67
def keys
  @keys ||= [
    :access_token,
    :api_endpoint,
    :auto_paginate,
    :bearer_token,
    :client_id,
    :client_secret,
    :connection_options,
    :default_media_type,
    :login,
    :management_console_endpoint,
    :management_console_password,
    :middleware,
    :netrc,
    :netrc_file,
    :per_page,
    :password,
    :proxy,
    :ssl_verify_mode,
    :user_agent,
    :web_endpoint
  ]
end

Public Instance Methods

api_endpoint() click to toggle source
# File lib/octokit/configurable.rb, line 115
def api_endpoint
  File.join(@api_endpoint, "")
end
configure() { |self| ... } click to toggle source

Set configuration options using a block

# File lib/octokit/configurable.rb, line 94
def configure
  yield self
end
login() click to toggle source
# File lib/octokit/configurable.rb, line 130
def login
  @login ||= begin
    user.login if token_authenticated?
  end
end
management_console_endpoint() click to toggle source
# File lib/octokit/configurable.rb, line 119
def management_console_endpoint
  File.join(@management_console_endpoint, "")
end
netrc?() click to toggle source
# File lib/octokit/configurable.rb, line 136
def netrc?
  !!@netrc
end
reset!() click to toggle source

Reset configuration options to default values

# File lib/octokit/configurable.rb, line 99
def reset!
  Octokit::Configurable.keys.each do |key|
    instance_variable_set(:"@#{key}", Octokit::Default.options[key])
  end
  self
end
Also aliased as: setup
same_options?(opts) click to toggle source

Compares client options to a Hash of requested options

@param opts [Hash] Options to compare with current client options @return [Boolean]

# File lib/octokit/configurable.rb, line 111
def same_options?(opts)
  opts.hash == options.hash
end
setup()
Alias for: reset!
web_endpoint() click to toggle source

Base URL for generated web URLs

@return [String] Default: github.com/

# File lib/octokit/configurable.rb, line 126
def web_endpoint
  File.join(@web_endpoint, "")
end

Private Instance Methods

fetch_client_id_and_secret(overrides = {}) click to toggle source
# File lib/octokit/configurable.rb, line 146
def fetch_client_id_and_secret(overrides = {})
  opts = options.merge(overrides)
  opts.values_at :client_id, :client_secret
end
options() click to toggle source
# File lib/octokit/configurable.rb, line 142
def options
  Hash[Octokit::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
end