Exception: Octokit::OneTimePasswordRequired

Inherits:
ClientError show all
Defined in:
lib/octokit/error.rb

Overview

Raised when GitHub returns a 401 HTTP status code and headers include “X-GitHub-OTP”

Constant Summary collapse

HEADER = 
/required; (?<delivery>\w+)/i

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Error

#documentation_url, error_for_401, error_for_403, #errors, from_response, #initialize

Constructor Details

This class inherits a constructor from Octokit::Error

Class Method Details

.required_header(headers) ⇒ Object 



150
151
152
 
# File 'lib/octokit/error.rb', line 150

def self.required_header(headers)
  HEADER.match headers['X-GitHub-OTP'].to_s
end

Instance Method Details

#password_delivery ⇒ String

Delivery method for the user’s OTP

Returns:

  • (String) 


157
158
159
 
# File 'lib/octokit/error.rb', line 157

def password_delivery
  @password_delivery ||= self.class.required_header(@response[:response_headers])[:delivery]
end