module Octokit::Default

Default configuration options for {Client}

Constants

API_ENDPOINT

Default API endpoint

MEDIA_TYPE

Default media type

MIDDLEWARE

Default Faraday middleware stack

RACK_BUILDER_CLASS

In Faraday 0.9, Faraday::Builder was renamed to Faraday::RackBuilder

USER_AGENT

Default User Agent header string

WEB_ENDPOINT

Default WEB endpoint

Public Class Methods

access_token() click to toggle source

Default access token from ENV @return [String]

# File lib/octokit/default.rb, line 45
def access_token
  ENV['OCTOKIT_ACCESS_TOKEN']
end
api_endpoint() click to toggle source

Default API endpoint from ENV or {API_ENDPOINT} @return [String]

# File lib/octokit/default.rb, line 51
def api_endpoint
  ENV['OCTOKIT_API_ENDPOINT'] || API_ENDPOINT
end
auto_paginate() click to toggle source

Default pagination preference from ENV @return [String]

# File lib/octokit/default.rb, line 57
def auto_paginate
  ENV['OCTOKIT_AUTO_PAGINATE']
end
bearer_token() click to toggle source

Default bearer token from ENV @return [String]

# File lib/octokit/default.rb, line 63
def bearer_token
  ENV['OCTOKIT_BEARER_TOKEN']
end
client_id() click to toggle source

Default OAuth app key from ENV @return [String]

# File lib/octokit/default.rb, line 69
def client_id
  ENV['OCTOKIT_CLIENT_ID']
end
client_secret() click to toggle source

Default OAuth app secret from ENV @return [String]

# File lib/octokit/default.rb, line 75
def client_secret
  ENV['OCTOKIT_SECRET']
end
connection_options() click to toggle source

Default options for Faraday::Connection @return [Hash]

# File lib/octokit/default.rb, line 93
def connection_options
  {
    :headers => {
      :accept => default_media_type,
      :user_agent => user_agent
    }
  }
end
default_media_type() click to toggle source

Default media type from ENV or {MEDIA_TYPE} @return [String]

# File lib/octokit/default.rb, line 104
def default_media_type
  ENV['OCTOKIT_DEFAULT_MEDIA_TYPE'] || MEDIA_TYPE
end
login() click to toggle source

Default GitHub username for Basic Auth from ENV @return [String]

# File lib/octokit/default.rb, line 110
def login
  ENV['OCTOKIT_LOGIN']
end
management_console_endpoint() click to toggle source

Default management console endpoint from ENV @return [String]

# File lib/octokit/default.rb, line 87
def management_console_endpoint
  ENV['OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_ENDPOINT']
end
management_console_password() click to toggle source

Default management console password from ENV @return [String]

# File lib/octokit/default.rb, line 81
def management_console_password
  ENV['OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_PASSWORD']
end
middleware() click to toggle source

Default middleware stack for Faraday::Connection from {MIDDLEWARE} @return [Faraday::RackBuilder or Faraday::Builder]

# File lib/octokit/default.rb, line 117
def middleware
  MIDDLEWARE
end
netrc() click to toggle source

Default behavior for reading .netrc file @return [Boolean]

# File lib/octokit/default.rb, line 164
def netrc
  ENV['OCTOKIT_NETRC'] || false
end
netrc_file() click to toggle source

Default path for .netrc file @return [String]

# File lib/octokit/default.rb, line 170
def netrc_file
  ENV['OCTOKIT_NETRC_FILE'] || File.join(ENV['HOME'].to_s, '.netrc')
end
options() click to toggle source

Configuration options @return [Hash]

# File lib/octokit/default.rb, line 39
def options
  Hash[Octokit::Configurable.keys.map{|key| [key, send(key)]}]
end
password() click to toggle source

Default GitHub password for Basic Auth from ENV @return [String]

# File lib/octokit/default.rb, line 123
def password
  ENV['OCTOKIT_PASSWORD']
end
per_page() click to toggle source

Default pagination page size from ENV @return [Integer] Page size

# File lib/octokit/default.rb, line 129
def per_page
  page_size = ENV['OCTOKIT_PER_PAGE']

  page_size.to_i if page_size
end
proxy() click to toggle source

Default proxy server URI for Faraday connection from ENV @return [String]

# File lib/octokit/default.rb, line 137
def proxy
  ENV['OCTOKIT_PROXY']
end
ssl_verify_mode() click to toggle source

Default SSL verify mode from ENV @return [Integer]

# File lib/octokit/default.rb, line 143
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() click to toggle source

Default User-Agent header string from ENV or {USER_AGENT} @return [String]

# File lib/octokit/default.rb, line 152
def user_agent
  ENV['OCTOKIT_USER_AGENT'] || USER_AGENT
end
web_endpoint() click to toggle source

Default web endpoint from ENV or {WEB_ENDPOINT} @return [String]

# File lib/octokit/default.rb, line 158
def web_endpoint
  ENV['OCTOKIT_WEB_ENDPOINT'] || WEB_ENDPOINT
end