Exception: Github::Error::ServiceError

Inherits:

GithubError

• Object
• StandardError
• GithubError
• Github::Error::ServiceError

Defined in:

lib/github_api/error/service_error.rb

Direct Known Subclasses

BadGateway, BadRequest, Conflict, Forbidden, InternalServerError, MethodNotAllowed, NotAcceptable, NotFound, NotImplemented, ServiceUnavailable, Unauthorized, UnavailableForLegalReasons, UnprocessableEntity, UnsupportedMediaType

Constant Summary

MIN_BODY_LENGTH =

2

Instance Attribute Summary

Attributes inherited from GithubError

#response_headers, #response_message

Class Method Summary

• .error_mapping ⇒ Hash[Integer, Object]

  A mapping of status codes and error types.

• .http_status_code(code) ⇒ Object

  Add http status code method to error type.

Instance Method Summary

• #data ⇒ Hash[Symbol]|String

  Expose response payload as JSON object if possible.

• #error_messages ⇒ Array[Hash[Symbol]]

  Stores error message(s) returned in response body.

• #initialize(response) ⇒ ServiceError constructor

  Create a ServiceError.

Methods inherited from GithubError

#backtrace

Constructor Details

#initialize(response) ⇒ ServiceError

Create a ServiceError

Parameters:

• response (Hash[Symbol])

# File 'lib/github_api/error/service_error.rb', line 41

def initialize(response)
  @headers = response[:response_headers]
  @body    = response[:body]
  @status  = response[:status]

  @response_headers = @headers
  @response_message = @body

  super(create_message(response))
end

Class Method Details

.error_mapping ⇒ Hash[Integer, Object]

A mapping of status codes and error types

Returns:

• (Hash[Integer, Object])

# File 'lib/github_api/error/service_error.rb', line 26

def self.error_mapping
  @error_mapping ||= Hash[
    descendants.map do |klass|
      [klass.new({}).http_status_code, klass]
    end
  ]
end

.http_status_code(code) ⇒ Object

Add http status code method to error type

Parameters:

• code (Integer) —

  the status code

# File 'lib/github_api/error/service_error.rb', line 17

def self.http_status_code(code)
  define_method(:http_status_code) { code }
end

Instance Method Details

#data ⇒ Hash[Symbol]|String

Expose response payload as JSON object if possible

Returns:

• (Hash[Symbol]|String)

# File 'lib/github_api/error/service_error.rb', line 57

def data
  @data ||= decode_data(@body)
end

#error_messages ⇒ Array[Hash[Symbol]]

Stores error message(s) returned in response body

Returns:

• (Array[Hash[Symbol]]) —

  the array of hash error objects

# File 'lib/github_api/error/service_error.rb', line 67

def error_messages
  @error_messages ||= begin
    data[:errors] ? data[:errors] : [data]
  end
end