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_token ⇒ String

Default access token from ENV

[ GitHub ] 

  


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



def access_token
  ENV.fetch('OCTOKIT_ACCESS_TOKEN', nil)
end


  








  

    .api_endpoint  ⇒ String 
  



  

    
Default API endpoint from ENV or API_ENDPOINT


  





  


  [ GitHub ]


  

  


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



def api_endpoint
  ENV.fetch('OCTOKIT_API_ENDPOINT') { API_ENDPOINT }
end


  








  

    .auto_paginate  ⇒ String 
  



  

    
Default pagination preference from ENV


  





  


  [ GitHub ]


  

  


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



def auto_paginate
  ENV.fetch('OCTOKIT_AUTO_PAGINATE', nil)
end


  








  

    .bearer_token  ⇒ String 
  



  

    
Default bearer token from ENV


  





  


  [ GitHub ]


  

  


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



def bearer_token
  ENV.fetch('OCTOKIT_BEARER_TOKEN', nil)
end


  








  

    .client_id  ⇒ String 
  



  

    
Default OAuth app key from ENV


  





  


  [ GitHub ]


  

  


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



def client_id
  ENV.fetch('OCTOKIT_CLIENT_ID', nil)
end


  








  

    .client_secret  ⇒ String 
  



  

    
Default OAuth app secret from ENV


  





  


  [ GitHub ]


  

  


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



def client_secret
  ENV.fetch('OCTOKIT_SECRET', nil)
end


  








  

    .connection_options  ⇒ Hash 
  



  

    
Default options for Faraday::Connection


  





  


  [ GitHub ]


  

  


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



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


  





  


  [ GitHub ]


  

  


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



def default_media_type
  ENV.fetch('OCTOKIT_DEFAULT_MEDIA_TYPE') { MEDIA_TYPE }
end


  








  

    .login  ⇒ String 
  



  

    
Default GitHub username for Basic Auth from ENV


  





  


  [ GitHub ]


  

  


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



def 
  ENV.fetch('OCTOKIT_LOGIN', nil)
end


  








  

    .management_console_endpoint  ⇒ String 
  



  

    
Default management console endpoint from ENV


  





  


  [ GitHub ]


  

  


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



def management_console_endpoint
  ENV.fetch('OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_ENDPOINT', nil)
end


  








  

    .management_console_password  ⇒ String 
  



  

    
Default management console password from ENV


  





  


  [ GitHub ]


  

  


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



def management_console_password
  ENV.fetch('OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_PASSWORD', nil)
end


  








  

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



  

    
Default middleware stack for Faraday::Connection
from MIDDLEWARE


  





  


  [ GitHub ]


  

  


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



def middleware
  MIDDLEWARE
end


  








  

    .netrc  ⇒ Boolean 
  



  

    
Default behavior for reading .netrc file


  





  


  [ GitHub ]


  

  


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



def netrc
  ENV.fetch('OCTOKIT_NETRC', false)
end


  








  

    .netrc_file  ⇒ String 
  



  

    
Default path for .netrc file


  





  


  [ GitHub ]


  

  


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



def netrc_file
  ENV.fetch('OCTOKIT_NETRC_FILE') { File.join(Dir.home.to_s, '.netrc') }
end


  








  

    .options  ⇒ Hash 
  



  

    
Configuration options


  





  


  [ GitHub ]


  

  


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



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


  








  

    .password  ⇒ String 
  



  

    
Default GitHub password for Basic Auth from ENV


  





  


  [ GitHub ]


  

  


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



def password
  ENV.fetch('OCTOKIT_PASSWORD', nil)
end


  








  

    .per_page  ⇒ Integer 
  



  

    
Default pagination page size from ENV


  





  
Returns:


    
  
  • 
    (Integer)
—    
    Page size
    

    
  
    • 





  [ GitHub ]


  

  


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



def per_page
  page_size = ENV.fetch('OCTOKIT_PER_PAGE', nil)

  page_size&.to_i
end


  








  

    .proxy  ⇒ String 
  



  

    
Default proxy server URI for Faraday connection from ENV


  





  


  [ GitHub ]


  

  


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



def proxy
  ENV.fetch('OCTOKIT_PROXY', nil)
end


  








  

    .ssl_verify_mode  ⇒ Integer 
  



  

    
Default SSL verify mode from ENV


  





  


  [ GitHub ]


  

  


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



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


  





  


  [ GitHub ]


  

  


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



def user_agent
  ENV.fetch('OCTOKIT_USER_AGENT') { USER_AGENT }
end


  








  

    .web_endpoint  ⇒ String 
  



  

    
Default web endpoint from ENV or WEB_ENDPOINT


  





  


  [ GitHub ]


  

  


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



def web_endpoint
  ENV.fetch('OCTOKIT_WEB_ENDPOINT') { WEB_ENDPOINT }
end