Module: Octokit::Default

Defined in:
lib/octokit/default.rb

Overview

Default configuration options for Client

Constant Summary collapse

API_ENDPOINT =

Default API endpoint

"https://api.github.com".freeze
USER_AGENT =

Default User Agent header string

"Octokit Ruby Gem #{Octokit::VERSION}".freeze
MEDIA_TYPE =

Default media type

"application/vnd.github.v3+json".freeze
WEB_ENDPOINT =

Default WEB endpoint

"https://github.com".freeze
MIDDLEWARE =

Default Faraday middleware stack

Faraday::RackBuilder.new do |builder|
  # In Faraday 2.x, Faraday::Request::Retry was moved to a separate gem
  # so we use it only when it's available.
  builder.use Faraday::Request::Retry, exceptions: [Octokit::ServerError] if defined?(Faraday::Request::Retry)
  builder.use Faraday::Retry::Middleware, exceptions: [Octokit::ServerError] if defined?(Faraday::Retry::Middleware)

  builder.use Octokit::Middleware::FollowRedirects
  builder.use Octokit::Response::RaiseError
  builder.use Octokit::Response::FeedParser
  builder.adapter Faraday.default_adapter
end

Class Method Summary collapse

Class Method Details

.access_token ⇒ String

Default access token from ENV

Returns:

  • (String) 


55
56
57
 
# File 'lib/octokit/default.rb', line 55

def access_token
  ENV['OCTOKIT_ACCESS_TOKEN']
end

.api_endpoint ⇒ String

Default API endpoint from ENV or API_ENDPOINT

Returns:

  • (String) 


61
62
63
 
# File 'lib/octokit/default.rb', line 61

def api_endpoint
  ENV['OCTOKIT_API_ENDPOINT'] || API_ENDPOINT
end

.auto_paginate ⇒ String

Default pagination preference from ENV

Returns:

  • (String) 


67
68
69
 
# File 'lib/octokit/default.rb', line 67

def auto_paginate
  ENV['OCTOKIT_AUTO_PAGINATE']
end

.bearer_token ⇒ String

Default bearer token from ENV

Returns:

  • (String) 


73
74
75
 
# File 'lib/octokit/default.rb', line 73

def bearer_token
  ENV['OCTOKIT_BEARER_TOKEN']
end

.client_id ⇒ String

Default OAuth app key from ENV

Returns:

  • (String) 


79
80
81
 
# File 'lib/octokit/default.rb', line 79

def client_id
  ENV['OCTOKIT_CLIENT_ID']
end

.client_secret ⇒ String

Default OAuth app secret from ENV

Returns:

  • (String) 


85
86
87
 
# File 'lib/octokit/default.rb', line 85

def client_secret
  ENV['OCTOKIT_SECRET']
end

.connection_options ⇒ Hash

Default options for Faraday::Connection

Returns:

  • (Hash) 


103
104
105
106
107
108
109
110
 
# File 'lib/octokit/default.rb', line 103

def connection_options
  {
    :headers => {
      :accept => default_media_type,
      :user_agent => user_agent
    }
  }
end

.default_media_type ⇒ String

Default media type from ENV or MEDIA_TYPE

Returns:

  • (String) 


114
115
116
 
# File 'lib/octokit/default.rb', line 114

def default_media_type
  ENV['OCTOKIT_DEFAULT_MEDIA_TYPE'] || MEDIA_TYPE
end

.login ⇒ String

Default GitHub username for Basic Auth from ENV

Returns:

  • (String) 


120
121
122
 
# File 'lib/octokit/default.rb', line 120

def 
  ENV['OCTOKIT_LOGIN']
end

.management_console_endpoint ⇒ String

Default management console endpoint from ENV

Returns:

  • (String) 


97
98
99
 
# File 'lib/octokit/default.rb', line 97

def management_console_endpoint
  ENV['OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_ENDPOINT']
end

.management_console_password ⇒ String

Default management console password from ENV

Returns:

  • (String) 


91
92
93
 
# File 'lib/octokit/default.rb', line 91

def management_console_password
  ENV['OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_PASSWORD']
end

.middleware ⇒ Faraday::RackBuilder or Faraday::Builder

Default middleware stack for Faraday::Connection from MIDDLEWARE

Returns:

  • (Faraday::RackBuilder or Faraday::Builder) 


127
128
129
 
# File 'lib/octokit/default.rb', line 127

def middleware
  MIDDLEWARE
end

.netrc ⇒ Boolean

Default behavior for reading .netrc file

Returns:

  • (Boolean) 


174
175
176
 
# File 'lib/octokit/default.rb', line 174

def netrc
  ENV['OCTOKIT_NETRC'] || false
end

.netrc_file ⇒ String

Default path for .netrc file

Returns:

  • (String) 


180
181
182
 
# File 'lib/octokit/default.rb', line 180

def netrc_file
  ENV['OCTOKIT_NETRC_FILE'] || File.join(ENV['HOME'].to_s, '.netrc')
end

.options ⇒ Hash

Configuration options

Returns:

  • (Hash) 


49
50
51
 
# File 'lib/octokit/default.rb', line 49

def options
  Hash[Octokit::Configurable.keys.map{|key| [key, send(key)]}]
end

.password ⇒ String

Default GitHub password for Basic Auth from ENV

Returns:

  • (String) 


133
134
135
 
# File 'lib/octokit/default.rb', line 133

def password
  ENV['OCTOKIT_PASSWORD']
end

.per_page ⇒ Integer

Default pagination page size from ENV

Returns:

  • (Integer) —

    Page size



139
140
141
142
143
 
# File 'lib/octokit/default.rb', line 139

def per_page
  page_size = ENV['OCTOKIT_PER_PAGE']

  page_size.to_i if page_size
end

.proxy ⇒ String

Default proxy server URI for Faraday connection from ENV

Returns:

  • (String) 


147
148
149
 
# File 'lib/octokit/default.rb', line 147

def proxy
  ENV['OCTOKIT_PROXY']
end

.ssl_verify_mode ⇒ Integer

Default SSL verify mode from ENV

Returns:

  • (Integer) 


153
154
155
156
157
158
 
# File 'lib/octokit/default.rb', line 153

def ssl_verify_mode
  # 0 is OpenSSL::SSL::VERIFY_NONE
  # 1 is OpenSSL::SSL::SSL_VERIFY_PEER
  # the standard default for SSL is SSL_VERIFY_PEER which requires a server certificate check on the client
  ENV.fetch('OCTOKIT_SSL_VERIFY_MODE', 1).to_i
end

.user_agent ⇒ String

Default User-Agent header string from ENV or USER_AGENT

Returns:

  • (String) 


162
163
164
 
# File 'lib/octokit/default.rb', line 162

def user_agent
  ENV['OCTOKIT_USER_AGENT'] || USER_AGENT
end

.web_endpoint ⇒ String

Default web endpoint from ENV or WEB_ENDPOINT

Returns:

  • (String) 


168
169
170
 
# File 'lib/octokit/default.rb', line 168

def web_endpoint
  ENV['OCTOKIT_WEB_ENDPOINT'] || WEB_ENDPOINT
end