Exception: Octokit::Error

Inherits:
StandardError
  • Object
show all
Defined in:
lib/octokit/error.rb

Overview

Custom error class for rescuing from all GitHub errors

Direct Known Subclasses

ClientError, ServerError

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(response = nil) ⇒ Error

Returns a new instance of Error



37
38
39
40
# File 'lib/octokit/error.rb', line 37

def initialize(response=nil)
  @response = response
  super(build_error_message)
end

Class Method Details

.error_for_401(headers) ⇒ Object

Returns most appropriate error for 401 HTTP status code



51
52
53
54
55
56
57
# File 'lib/octokit/error.rb', line 51

def self.error_for_401(headers)
  if Octokit::OneTimePasswordRequired.required_header(headers)
    Octokit::OneTimePasswordRequired
  else
    Octokit::Unauthorized
  end
end

.error_for_403(body) ⇒ Object

Returns most appropriate error for 403 HTTP status code



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/octokit/error.rb', line 61

def self.error_for_403(body)
  if body =~ /rate limit exceeded/i
    Octokit::TooManyRequests
  elsif body =~ /login attempts exceeded/i
    Octokit::TooManyLoginAttempts
  elsif body =~ /abuse/i
    Octokit::AbuseDetected
  elsif body =~ /repository access blocked/i
    Octokit::RepositoryUnavailable
  elsif body =~ /email address must be verified/i
    Octokit::UnverifiedEmail
  elsif body =~ /account was suspended/i
    Octokit::AccountSuspended
  else
    Octokit::Forbidden
  end
end

.error_for_404(body) ⇒ Object

Return most appropriate error for 404 HTTP status code



81
82
83
84
85
86
87
# File 'lib/octokit/error.rb', line 81

def self.error_for_404(body)
  if body =~ /Branch not protected/i
    Octokit::BranchNotProtected
  else
    Octokit::NotFound
  end
end

.from_response(response) ⇒ Octokit::Error

Returns the appropriate Octokit::Error subclass based on status and response message

Parameters:

  • response (Hash)

    HTTP response

Returns:



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# File 'lib/octokit/error.rb', line 10

def self.from_response(response)
  status  = response[:status].to_i
  body    = response[:body].to_s
  headers = response[:response_headers]

  if klass =  case status
              when 400      then Octokit::BadRequest
              when 401      then error_for_401(headers)
              when 403      then error_for_403(body)
              when 404      then error_for_404(body)
              when 405      then Octokit::MethodNotAllowed
              when 406      then Octokit::NotAcceptable
              when 409      then Octokit::Conflict
              when 415      then Octokit::UnsupportedMediaType
              when 422      then Octokit::UnprocessableEntity
              when 451      then Octokit::UnavailableForLegalReasons
              when 400..499 then Octokit::ClientError
              when 500      then Octokit::InternalServerError
              when 501      then Octokit::NotImplemented
              when 502      then Octokit::BadGateway
              when 503      then Octokit::ServiceUnavailable
              when 500..599 then Octokit::ServerError
              end
    klass.new(response)
  end
end

Instance Method Details

#documentation_urlString

Documentation URL returned by the API for some errors

Returns:

  • (String)


45
46
47
# File 'lib/octokit/error.rb', line 45

def documentation_url
  data[:documentation_url] if data.is_a? Hash
end

#errorsArray<Hash>

Array of validation errors

Returns:

  • (Array<Hash>)

    Error info



91
92
93
94
95
96
97
# File 'lib/octokit/error.rb', line 91

def errors
  if data && data.is_a?(Hash)
    data[:errors] || []
  else
    []
  end
end

#response_statusInteger

Status code returned by the GitHub server.

Returns:

  • (Integer)


102
103
104
# File 'lib/octokit/error.rb', line 102

def response_status
  @response[:status]
end