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.


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

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

.from_response(response) ⇒ Octokit::Error

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

Parameters:

  • response (Hash) —

    HTTP response

Returns:


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
38
 
# File 'lib/octokit/error.rb', line 13

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 


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

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) 

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

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

#errors ⇒ Array<Hash>

Array of validation errors

Returns:

  • (Array<Hash>) —

    Error info


129
130
131
132
133
134
135
 
# File 'lib/octokit/error.rb', line 129

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

#response_body ⇒ String

Body returned by the GitHub server.

Returns:

  • (String) 

154
155
156
 
# File 'lib/octokit/error.rb', line 154

def response_body
  @response[:body]
end

#response_headers ⇒ Hash

Headers returned by the GitHub server.

Returns:

  • (Hash) 

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

def response_headers
  @response[:response_headers]
end

#response_status ⇒ Integer

Status code returned by the GitHub server.

Returns:

  • (Integer) 

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

def response_status
  @response[:status]
end