Module: Octokit::Configurable
- Included in:
- Octokit, Client, EnterpriseAdminClient, EnterpriseManagementConsoleClient
- Defined in:
- lib/octokit/configurable.rb
Overview
Instance Attribute Summary collapse
-
#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.
-
#bearer_token ⇒ Object
Returns the value of attribute bearer_token.
-
#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.
-
#management_console_endpoint ⇒ String
Base URL for API requests to the GitHub Enterprise management console.
-
#management_console_password ⇒ String
An admin password set up for your GitHub Enterprise management console.
-
#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.
-
#ssl_verify_mode ⇒ String
SSL verify mode for ssl connections.
-
#user_agent ⇒ String
Configure User-Agent header for requests.
-
#web_endpoint ⇒ String
Base URL for generated web URLs.
Class Method Summary collapse
-
.keys ⇒ Array
List of configurable keys for Client.
Instance Method Summary collapse
-
#configure {|_self| ... } ⇒ Object
Set configuration options using a block.
- #netrc? ⇒ Boolean
-
#reset! ⇒ Object
(also: #setup)
Reset configuration options to default values.
-
#same_options?(opts) ⇒ Boolean
Compares client options to a Hash of requested options.
Instance Attribute Details
#access_token ⇒ Object
Returns the value of attribute access_token
56 57 58 |
# File 'lib/octokit/configurable.rb', line 56 def access_token @access_token end |
#api_endpoint ⇒ String
Returns Base URL for API requests. default: https://api.github.com/
56 57 58 59 |
# File 'lib/octokit/configurable.rb', line 56 attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id, :client_secret, :default_media_type, :connection_options, :middleware, :netrc, :netrc_file, :per_page, :proxy, :ssl_verify_mode, :user_agent |
#auto_paginate ⇒ Boolean
Returns Auto fetch next page of results until rate limit reached
56 57 58 59 |
# File 'lib/octokit/configurable.rb', line 56 attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id, :client_secret, :default_media_type, :connection_options, :middleware, :netrc, :netrc_file, :per_page, :proxy, :ssl_verify_mode, :user_agent |
#bearer_token ⇒ Object
Returns the value of attribute bearer_token
56 57 58 |
# File 'lib/octokit/configurable.rb', line 56 def bearer_token @bearer_token end |
#client_id ⇒ String
Returns Configure OAuth app key
56 57 58 59 |
# File 'lib/octokit/configurable.rb', line 56 attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id, :client_secret, :default_media_type, :connection_options, :middleware, :netrc, :netrc_file, :per_page, :proxy, :ssl_verify_mode, :user_agent |
#client_secret ⇒ Object
Returns the value of attribute client_secret
56 57 58 |
# File 'lib/octokit/configurable.rb', line 56 def client_secret @client_secret end |
#connection_options ⇒ Hash
Returns Configure connection options for Faraday
56 57 58 59 |
# File 'lib/octokit/configurable.rb', line 56 attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id, :client_secret, :default_media_type, :connection_options, :middleware, :netrc, :netrc_file, :per_page, :proxy, :ssl_verify_mode, :user_agent |
#default_media_type ⇒ String
Returns Configure preferred media type (for API versioning, for example)
56 57 58 59 |
# File 'lib/octokit/configurable.rb', line 56 attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id, :client_secret, :default_media_type, :connection_options, :middleware, :netrc, :netrc_file, :per_page, :proxy, :ssl_verify_mode, :user_agent |
#login ⇒ String
Returns GitHub username for Basic Authentication
56 57 58 59 |
# File 'lib/octokit/configurable.rb', line 56 attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id, :client_secret, :default_media_type, :connection_options, :middleware, :netrc, :netrc_file, :per_page, :proxy, :ssl_verify_mode, :user_agent |
#management_console_endpoint ⇒ String
Returns Base URL for API requests to the GitHub Enterprise management console
56 57 58 59 |
# File 'lib/octokit/configurable.rb', line 56 attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id, :client_secret, :default_media_type, :connection_options, :middleware, :netrc, :netrc_file, :per_page, :proxy, :ssl_verify_mode, :user_agent |
#management_console_password ⇒ String
Returns An admin password set up for your GitHub Enterprise management console
56 57 58 59 |
# File 'lib/octokit/configurable.rb', line 56 attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id, :client_secret, :default_media_type, :connection_options, :middleware, :netrc, :netrc_file, :per_page, :proxy, :ssl_verify_mode, :user_agent |
#middleware ⇒ Faraday::Builder or Faraday::RackBuilder
Returns Configure middleware for Faraday
56 57 58 59 |
# File 'lib/octokit/configurable.rb', line 56 attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id, :client_secret, :default_media_type, :connection_options, :middleware, :netrc, :netrc_file, :per_page, :proxy, :ssl_verify_mode, :user_agent |
#netrc ⇒ Boolean
Returns Instruct Octokit to get credentials from .netrc file
56 57 58 59 |
# File 'lib/octokit/configurable.rb', line 56 attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id, :client_secret, :default_media_type, :connection_options, :middleware, :netrc, :netrc_file, :per_page, :proxy, :ssl_verify_mode, :user_agent |
#netrc_file ⇒ String
Returns Path to .netrc file. default: ~/.netrc
56 57 58 59 |
# File 'lib/octokit/configurable.rb', line 56 attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id, :client_secret, :default_media_type, :connection_options, :middleware, :netrc, :netrc_file, :per_page, :proxy, :ssl_verify_mode, :user_agent |
#password=(value) ⇒ String (writeonly)
Returns GitHub password for Basic Authentication
56 57 58 59 |
# File 'lib/octokit/configurable.rb', line 56 attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id, :client_secret, :default_media_type, :connection_options, :middleware, :netrc, :netrc_file, :per_page, :proxy, :ssl_verify_mode, :user_agent |
#per_page ⇒ String
Returns Configure page size for paginated results. API default: 30
56 57 58 59 |
# File 'lib/octokit/configurable.rb', line 56 attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id, :client_secret, :default_media_type, :connection_options, :middleware, :netrc, :netrc_file, :per_page, :proxy, :ssl_verify_mode, :user_agent |
#proxy ⇒ String
Returns URI for proxy server
56 57 58 59 |
# File 'lib/octokit/configurable.rb', line 56 attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id, :client_secret, :default_media_type, :connection_options, :middleware, :netrc, :netrc_file, :per_page, :proxy, :ssl_verify_mode, :user_agent |
#ssl_verify_mode ⇒ String
Returns SSL verify mode for ssl connections
56 57 58 59 |
# File 'lib/octokit/configurable.rb', line 56 attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id, :client_secret, :default_media_type, :connection_options, :middleware, :netrc, :netrc_file, :per_page, :proxy, :ssl_verify_mode, :user_agent |
#user_agent ⇒ String
Returns Configure User-Agent header for requests.
56 57 58 59 |
# File 'lib/octokit/configurable.rb', line 56 attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id, :client_secret, :default_media_type, :connection_options, :middleware, :netrc, :netrc_file, :per_page, :proxy, :ssl_verify_mode, :user_agent |
#web_endpoint ⇒ String
Base URL for generated web URLs
56 57 58 59 |
# File 'lib/octokit/configurable.rb', line 56 attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id, :client_secret, :default_media_type, :connection_options, :middleware, :netrc, :netrc_file, :per_page, :proxy, :ssl_verify_mode, :user_agent |
Class Method Details
.keys ⇒ Array
List of configurable keys for Octokit::Client
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# 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 |
Instance Method Details
#configure {|_self| ... } ⇒ Object
Set configuration options using a block
94 95 96 |
# File 'lib/octokit/configurable.rb', line 94 def configure yield self end |
#netrc? ⇒ Boolean
136 137 138 |
# File 'lib/octokit/configurable.rb', line 136 def netrc? !!@netrc end |
#reset! ⇒ Object Also known as: setup
Reset configuration options to default values
99 100 101 102 103 104 |
# File 'lib/octokit/configurable.rb', line 99 def reset! Octokit::Configurable.keys.each do |key| instance_variable_set(:"@#{key}", Octokit::Default.[key]) end self end |
#same_options?(opts) ⇒ Boolean
Compares client options to a Hash of requested options
111 112 113 |
# File 'lib/octokit/configurable.rb', line 111 def (opts) opts.hash == .hash end |