123456789_123456789_123456789_123456789_123456789_

Module: Octokit::Default

Relationships & Source Files
Defined in: lib/octokit/default.rb

Overview

Default configuration options for Client

Constant Summary

Class Method Summary

Class Method Details

.access_tokenString

Default access token from ENV

[ GitHub ]

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

def access_token
  ENV['OCTOKIT_ACCESS_TOKEN']
end

.api_endpointString

Default API endpoint from ENV or API_ENDPOINT

[ GitHub ]

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

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

.auto_paginateString

Default pagination preference from ENV

[ GitHub ]

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

def auto_paginate
  ENV['OCTOKIT_AUTO_PAGINATE']
end

.bearer_tokenString

Default bearer token from ENV

[ GitHub ]

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

def bearer_token
  ENV['OCTOKIT_BEARER_TOKEN']
end

.client_idString

Default OAuth app key from ENV

[ GitHub ]

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

def client_id
  ENV['OCTOKIT_CLIENT_ID']
end

.client_secretString

Default OAuth app secret from ENV

[ GitHub ]

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

def client_secret
  ENV['OCTOKIT_SECRET']
end

.connection_optionsHash

Default options for Faraday::Connection

[ GitHub ]

  
# File 'lib/octokit/default.rb', line 105

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

.default_media_typeString

Default media type from ENV or MEDIA_TYPE

[ GitHub ]

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

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

.loginString

Default GitHub username for Basic Auth from ENV

[ GitHub ]

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

def 
  ENV['OCTOKIT_LOGIN']
end

.management_console_endpointString

Default management console endpoint from ENV

[ GitHub ]

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

def management_console_endpoint
  ENV['OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_ENDPOINT']
end

.management_console_passwordString

Default management console password from ENV

[ GitHub ]

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

def management_console_password
  ENV['OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_PASSWORD']
end

.middlewareFaraday::RackBuilder or Faraday::Builder

Default middleware stack for Faraday::Connection from MIDDLEWARE

[ GitHub ]

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

def middleware
  MIDDLEWARE
end

.netrcBoolean

Default behavior for reading .netrc file

[ GitHub ]

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

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

.netrc_fileString

Default path for .netrc file

[ GitHub ]

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

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

.optionsHash

Configuration options

[ GitHub ]

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

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

.passwordString

Default GitHub password for Basic Auth from ENV

[ GitHub ]

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

def password
  ENV['OCTOKIT_PASSWORD']
end

.per_pageInteger

Default pagination page size from ENV

Returns:

  • (Integer)

    Page size

[ GitHub ]

  
# File 'lib/octokit/default.rb', line 141

def per_page
  page_size = ENV['OCTOKIT_PER_PAGE']

  page_size&.to_i
end

.proxyString

Default proxy server URI for Faraday connection from ENV

[ GitHub ]

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

def proxy
  ENV['OCTOKIT_PROXY']
end

.ssl_verify_modeInteger

Default SSL verify mode from ENV

[ GitHub ]

  
# File 'lib/octokit/default.rb', line 155

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_agentString

Default User-Agent header string from ENV or USER_AGENT

[ GitHub ]

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

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

.web_endpointString

Default web endpoint from ENV or WEB_ENDPOINT

[ GitHub ]

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

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