module Octokit::Authentication
Authentication
methods for {Octokit::Client}
Public Instance Methods
Indicates if the client has OAuth Application client_id and secret credentials to make anonymous requests at a higher rate limit
@see developer.github.com/v3/#unauthenticated-rate-limited-requests @return [Boolean]
# File lib/octokit/authentication.rb, line 47 def application_authenticated? @client_id && @client_secret end
Indicates if the client was supplied Basic Auth username and password
@see developer.github.com/v3/#authentication @return [Boolean]
# File lib/octokit/authentication.rb, line 11 def basic_authenticated? !!(@login && @password) end
Indicates if the client was supplied a bearer token
@see developer.github.com/early-access/integrations/authentication/#as-an-integration @return [Boolean]
# File lib/octokit/authentication.rb, line 28 def bearer_authenticated? !!@bearer_token end
Indicates if the client was supplied an OAuth access token
@see developer.github.com/v3/#authentication @return [Boolean]
# File lib/octokit/authentication.rb, line 20 def token_authenticated? !!@access_token end
Indicates if the client was supplied an OAuth access token or Basic Auth username and password
@see developer.github.com/v3/#authentication @return [Boolean]
# File lib/octokit/authentication.rb, line 37 def user_authenticated? basic_authenticated? || token_authenticated? end
Private Instance Methods
# File lib/octokit/authentication.rb, line 53 def login_from_netrc return unless netrc? require 'netrc' info = Netrc.read netrc_file netrc_host = URI.parse(api_endpoint).host creds = info[netrc_host] if creds.nil? # creds will be nil if there is no netrc for this end point octokit_warn "Error loading credentials from netrc file for #{api_endpoint}" else creds = creds.to_a self.login = creds.shift self.password = creds.shift end rescue LoadError octokit_warn "Please install netrc gem for .netrc support" end