Class: Apiwork::Introspection::ErrorCode

Inherits:
Object
  • Object
show all
Defined in:
lib/apiwork/introspection/error_code.rb

Overview

Wraps error code definitions.

Examples:

api.error_codes[:not_found].status # => 404
api.error_codes[:not_found].description # => "Resource not found"

Instance Method Summary collapse

Constructor Details

#initialize(dump) ⇒ ErrorCode

Returns a new instance of ErrorCode.



12
13
14
 
# File 'lib/apiwork/introspection/error_code.rb', line 12

def initialize(dump)
  @dump = dump
end

Instance Method Details

#description ⇒ String?

The description for this error code.

Returns:

  • (String, nil) 


20
21
22
 
# File 'lib/apiwork/introspection/error_code.rb', line 20

def description
  @dump[:description]
end

#status ⇒ Integer

The status for this error code.

Returns:

  • (Integer) 


28
29
30
 
# File 'lib/apiwork/introspection/error_code.rb', line 28

def status
  @dump[:status]
end

#to_h ⇒ Hash

Converts this error code to a hash.

Returns:

  • (Hash) 


36
37
38
39
40
41
 
# File 'lib/apiwork/introspection/error_code.rb', line 36

def to_h
  {
    description: description,
    status: status,
  }
end