Exception: Octokit::OneTimePasswordRequired

Inherits:

ClientError

• Object
• StandardError
• Error
• ClientError
• Octokit::OneTimePasswordRequired

Defined in:

lib/octokit/error.rb

Overview

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

Constant Summary

OTP_DELIVERY_PATTERN =

/required; (\w+)/i

Class Method Summary

• .required_header(headers) ⇒ Object

Instance Method Summary

• #password_delivery ⇒ String

  Delivery method for the user’s OTP.

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

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

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

Instance Method Details

#password_delivery ⇒ String

Delivery method for the user’s OTP

Returns:

• (String)

# File 'lib/octokit/error.rb', line 165

def password_delivery
  @password_delivery ||= delivery_method_from_header
end