module Octokit::Default

Default configuration options for {Client}

Constants

API_ENDPOINT

Default API endpoint

MEDIA_TYPE

Default media type

MIDDLEWARE

Default Faraday middleware stack

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 59
def access_token
  ENV.fetch('OCTOKIT_ACCESS_TOKEN', nil)
end
api_endpoint() click to toggle source

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

# File lib/octokit/default.rb, line 65
def api_endpoint
  ENV.fetch('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 71
def auto_paginate
  ENV.fetch('OCTOKIT_AUTO_PAGINATE', nil)
end
bearer_token() click to toggle source

Default bearer token from ENV @return [String]

# File lib/octokit/default.rb, line 77
def bearer_token
  ENV.fetch('OCTOKIT_BEARER_TOKEN', nil)
end
client_id() click to toggle source

Default OAuth app key from ENV @return [String]

# File lib/octokit/default.rb, line 83
def client_id
  ENV.fetch('OCTOKIT_CLIENT_ID', nil)
end
client_secret() click to toggle source

Default OAuth app secret from ENV @return [String]

# File lib/octokit/default.rb, line 89
def client_secret
  ENV.fetch('OCTOKIT_SECRET', nil)
end
connection_options() click to toggle source

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

# File lib/octokit/default.rb, line 125
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 136
def default_media_type
  ENV.fetch('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 142
def login
  ENV.fetch('OCTOKIT_LOGIN', nil)
end
manage_ghes_endpoint() click to toggle source

Default GHES Manage API endpoint from ENV @return [String]

# File lib/octokit/default.rb, line 107
def manage_ghes_endpoint
  ENV.fetch('OCTOKIT_MANAGE_GHES_ENDPOINT', nil)
end
manage_ghes_password() click to toggle source

Default GHES Manage API password from ENV @return [String]

# File lib/octokit/default.rb, line 119
def manage_ghes_password
  ENV.fetch('OCTOKIT_MANAGE_GHES_PASSWORD', nil)
end
manage_ghes_username() click to toggle source

Default GHES Manage API username from ENV @return [String]

# File lib/octokit/default.rb, line 113
def manage_ghes_username
  ENV.fetch('OCTOKIT_MANAGE_GHES_USERNAME', nil)
end
management_console_endpoint() click to toggle source

Default management console endpoint from ENV @return [String]

# File lib/octokit/default.rb, line 101
def management_console_endpoint
  ENV.fetch('OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_ENDPOINT', nil)
end
management_console_password() click to toggle source

Default management console password from ENV @return [String]

# File lib/octokit/default.rb, line 95
def management_console_password
  ENV.fetch('OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_PASSWORD', nil)
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 149
def middleware
  MIDDLEWARE
end
netrc() click to toggle source

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

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

Default path for .netrc file @return [String]

# File lib/octokit/default.rb, line 202
def netrc_file
  ENV.fetch('OCTOKIT_NETRC_FILE') { File.join(Dir.home.to_s, '.netrc') }
end
options() click to toggle source

Configuration options @return [Hash]

# File lib/octokit/default.rb, line 53
def options
  Octokit::Configurable.keys.to_h { |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 155
def password
  ENV.fetch('OCTOKIT_PASSWORD', nil)
end
per_page() click to toggle source

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

# File lib/octokit/default.rb, line 161
def per_page
  page_size = ENV.fetch('OCTOKIT_PER_PAGE', nil)

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

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

# File lib/octokit/default.rb, line 169
def proxy
  ENV.fetch('OCTOKIT_PROXY', nil)
end
ssl_verify_mode() click to toggle source

Default SSL verify mode from ENV @return [Integer]

# File lib/octokit/default.rb, line 175
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 184
def user_agent
  ENV.fetch('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 190
def web_endpoint
  ENV.fetch('OCTOKIT_WEB_ENDPOINT') { WEB_ENDPOINT }
end