Exception: CFoundry::APIError

Inherits:
RuntimeError
  • Object
show all
Defined in:
lib/cfoundry/errors.rb

Overview

Exception representing errors returned by the API.

Direct Known Subclasses

Denied, NotFound, TargetRefused, UploadFailed

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(error_code = nil, description = nil) ⇒ APIError

Create an APIError with a given error code and description.



14
15
16
17
 
# File 'lib/cfoundry/errors.rb', line 14

def initialize(error_code = nil, description = nil)
  @error_code = error_code
  @description = description
end

Class Attribute Details

.description ⇒ Object (readonly)

:nodoc:



5
6
7
 
# File 'lib/cfoundry/errors.rb', line 5

def description
  @description
end

.error_code ⇒ Object (readonly)

:nodoc:



5
6
7
 
# File 'lib/cfoundry/errors.rb', line 5

def error_code
  @error_code
end

Class Method Details

.setup(code, description = nil) ⇒ Object

:nodoc:



7
8
9
10
 
# File 'lib/cfoundry/errors.rb', line 7

def setup(code, description = nil) # :nodoc:
  @error_code = code
  @description = description
end

Instance Method Details

#description ⇒ Object

A description of the error.



25
26
27
 
# File 'lib/cfoundry/errors.rb', line 25

def description
  @description || self.class.description
end

#error_code ⇒ Object

A number representing the error.



20
21
22
 
# File 'lib/cfoundry/errors.rb', line 20

def error_code
  @error_code || self.class.error_code
end

#to_s ⇒ Object

:nodoc:



29
30
31
32
33
34
35
 
# File 'lib/cfoundry/errors.rb', line 29

def to_s # :nodoc:
  if error_code
    "#{error_code}: #{description}"
  else
    description
  end
end