Class: Imgur::Response::Base

Inherits:

Object

• Object
• Imgur::Response::Base

Defined in:

(ruby-imgur 0.0.1) ruby-imgur/response.rb

Overview

Basic response class. Response class inheritance base from this class. Upon consuming define_endpoint with proper response_type option. A response class will be generated upon definition to proxy the output into the model.

See Also:

• how to define a subclass of Response::Base properly. Documentation will be released once the separate library to generalize the work of endpoint is done.

Instance Attribute Summary

• #result ⇒ Array<Object>, ... readonly

  Processed API result.

• #status ⇒ Integer readonly

  Status code of request.

• #success ⇒ Boolean readonly

  Success flag of request.

Instance Method Summary

• #initialize(data) ⇒ Base constructor

  A new instance of Base.

Constructor Details

#initialize(data) ⇒ Base

Returns a new instance of Base.

Parameters:

• data (Object) —

  Raw JSON data to process. Model that underlies a MultiResultResponse class supports deserialization JSON data into specific Response model.

Instance Attribute Details

#result ⇒ Array<Object>, ... (readonly)

Returns Processed API result.

Returns:

• (Array<Object>, Array<Hash>, Hash) —

  Processed API result

#status ⇒ Integer (readonly)

Returns status code of request.

Returns:

• (Integer) —

  status code of request

#success ⇒ Boolean (readonly)

Returns success flag of request.

Returns:

• (Boolean) —

  success flag of request