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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(response = nil) ⇒ Error

Returns a new instance of Error.



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

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

Instance Attribute Details

#context ⇒ Object (readonly)

Returns the value of attribute context.



6
7
8
 
# File 'lib/octokit/error.rb', line 6

def context
  @context
end

Class Method Details

.error_for_401(headers) ⇒ Object

Returns most appropriate error for 401 HTTP status code



60
61
62
63
64
65
66
 
# File 'lib/octokit/error.rb', line 60

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/octokit/error.rb', line 70

def self.error_for_403(body)
  if body =~ /rate limit exceeded/i
    Octokit::TooManyRequests
  elsif body =~ /exceeded a secondary rate limit/i
    Octokit::TooManyRequests
  elsif body =~ /login attempts exceeded/i
    Octokit::TooManyLoginAttempts
  elsif body =~ /returns blobs up to [0-9]+ MB/i
    Octokit::TooLargeContent
  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
  elsif body =~ /billing issue/i
    Octokit::BillingIssue
  elsif body =~ /Resource protected by organization SAML enforcement/i
    Octokit::SAMLProtected
  elsif body =~ /suspended your access|This installation has been suspended/i
    Octokit::InstallationSuspended
  else
    Octokit::Forbidden
  end
end

.error_for_404(body) ⇒ Object

Return most appropriate error for 404 HTTP status code



100
101
102
103
104
105
106
 
# File 'lib/octokit/error.rb', line 100

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

.error_for_422(body) ⇒ Object

Return most appropriate error for 422 HTTP status code



110
111
112
113
114
115
116
117
118
 
# File 'lib/octokit/error.rb', line 110

def self.error_for_422(body)
  if body =~ /PullRequestReviewComment/i && body =~ /(commit_id|end_commit_oid) is not part of the pull request/i
    Octokit::CommitIsNotPartOfPullRequest
  elsif body =~ /Path diff too large/i
    Octokit::PathDiffTooLarge
  else
    Octokit::UnprocessableEntity
  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:



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

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 error_for_422(body)
              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

#build_error_context ⇒ Object 



39
40
41
42
43
 
# File 'lib/octokit/error.rb', line 39

def build_error_context
  if RATE_LIMITED_ERRORS.include?(self.class)
    @context = Octokit::RateLimit.from_response(@response)
  end
end

#documentation_url ⇒ String

Documentation URL returned by the API for some errors

Returns:

  • (String) 


54
55
56
 
# File 'lib/octokit/error.rb', line 54

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

#errors ⇒ Array<Hash>

Array of validation errors

Returns:

  • (Array<Hash>) —

    Error info



122
123
124
125
126
127
128
 
# File 'lib/octokit/error.rb', line 122

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

#response_body ⇒ String

Body returned by the GitHub server.

Returns:

  • (String) 


147
148
149
 
# File 'lib/octokit/error.rb', line 147

def response_body
  @response[:body]
end

#response_headers ⇒ Hash

Headers returned by the GitHub server.

Returns:

  • (Hash) 


140
141
142
 
# File 'lib/octokit/error.rb', line 140

def response_headers
  @response[:response_headers]
end

#response_status ⇒ Integer

Status code returned by the GitHub server.

Returns:

  • (Integer) 


133
134
135
 
# File 'lib/octokit/error.rb', line 133

def response_status
  @response[:status]
end