Exception: MergeHRISClient::ApiError
- Inherits:
 - 
      StandardError
      
        
- Object
 - StandardError
 - MergeHRISClient::ApiError
 
 
- Defined in:
 - lib/merge_hris_client/api_error.rb
 
Instance Attribute Summary collapse
- 
  
    
      #code  ⇒ Object 
    
    
  
  
  
  
    
      readonly
    
    
  
  
  
  
  
  
    
Returns the value of attribute code.
 - 
  
    
      #response_body  ⇒ Object 
    
    
  
  
  
  
    
      readonly
    
    
  
  
  
  
  
  
    
Returns the value of attribute response_body.
 - 
  
    
      #response_headers  ⇒ Object 
    
    
  
  
  
  
    
      readonly
    
    
  
  
  
  
  
  
    
Returns the value of attribute response_headers.
 
Instance Method Summary collapse
- 
  
    
      #initialize(arg = nil)  ⇒ ApiError 
    
    
  
  
  
    constructor
  
  
  
  
  
  
  
    
Usage examples: ApiError.new ApiError.new(“message”) ApiError.new(:code => 500, :response_headers => {}, :response_body => “”) ApiError.new(:code => 404, :message => “Not Found”).
 - #message ⇒ Object
 - 
  
    
      #to_s  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Override to_s to display a friendly error message.
 
Constructor Details
#initialize(arg = nil) ⇒ ApiError
      22 23 24 25 26 27 28 29 30 31 32 33 34 35 36  | 
    
      # File 'lib/merge_hris_client/api_error.rb', line 22 def initialize(arg = nil) if arg.is_a? Hash if arg.key?(:message) || arg.key?('message') super(arg[:message] || arg['message']) else super arg end arg.each do |k, v| instance_variable_set "@#{k}", v end else super arg end end  | 
  
Instance Attribute Details
#code ⇒ Object (readonly)
Returns the value of attribute code.
      15 16 17  | 
    
      # File 'lib/merge_hris_client/api_error.rb', line 15 def code @code end  | 
  
#response_body ⇒ Object (readonly)
Returns the value of attribute response_body.
      15 16 17  | 
    
      # File 'lib/merge_hris_client/api_error.rb', line 15 def response_body @response_body end  | 
  
#response_headers ⇒ Object (readonly)
Returns the value of attribute response_headers.
      15 16 17  | 
    
      # File 'lib/merge_hris_client/api_error.rb', line 15 def response_headers @response_headers end  | 
  
Instance Method Details
#message ⇒ Object
      43 44 45 46 47 48 49 50 51 52 53 54 55  | 
    
      # File 'lib/merge_hris_client/api_error.rb', line 43 def if @message.nil? msg = "Error message: the server returns an error" else msg = @message end msg += "\nHTTP status code: #{code}" if code msg += "\nResponse headers: #{response_headers}" if response_headers msg += "\nResponse body: #{response_body}" if response_body msg end  | 
  
#to_s ⇒ Object
Override to_s to display a friendly error message
      39 40 41  | 
    
      # File 'lib/merge_hris_client/api_error.rb', line 39 def to_s end  |