Class: Fanforce::API::Result
- Inherits:
-
Hash
- Object
- Hash
- Fanforce::API::Result
- Defined in:
- lib/fanforce/api/response.rb
Instance Attribute Summary collapse
-
#requested_params ⇒ Object
readonly
Returns the value of attribute requested_params.
-
#requested_url ⇒ Object
readonly
Returns the value of attribute requested_url.
Instance Method Summary collapse
- #body ⇒ Object
- #code ⇒ Object
- #curl_command ⇒ Object
- #current_page ⇒ Object
- #current_results ⇒ Object
- #data ⇒ Object (also: #result)
-
#initialize(response_hash, response, request, requested_url, requested_params) ⇒ Result
constructor
A new instance of Result.
- #next_page ⇒ Object
- #next_page_url ⇒ Object
- #prev_page ⇒ Object
- #prev_page_url ⇒ Object
- #total_pages ⇒ Object
- #total_results ⇒ Object
Constructor Details
#initialize(response_hash, response, request, requested_url, requested_params) ⇒ Result
Returns a new instance of Result.
22 23 24 25 26 27 28 29 |
# File 'lib/fanforce/api/response.rb', line 22 def initialize(response_hash, response, request, requested_url, requested_params) @response = response @request = request @requested_url = requested_url @requested_params = requested_params @response_hash = response_hash self.replace(response_hash) end |
Instance Attribute Details
#requested_params ⇒ Object (readonly)
Returns the value of attribute requested_params.
20 21 22 |
# File 'lib/fanforce/api/response.rb', line 20 def requested_params @requested_params end |
#requested_url ⇒ Object (readonly)
Returns the value of attribute requested_url.
20 21 22 |
# File 'lib/fanforce/api/response.rb', line 20 def requested_url @requested_url end |
Instance Method Details
#body ⇒ Object
40 41 42 |
# File 'lib/fanforce/api/response.rb', line 40 def body; @response.to_s end |
#code ⇒ Object
52 |
# File 'lib/fanforce/api/response.rb', line 52 def code; @response.code end |
#curl_command ⇒ Object
36 37 38 |
# File 'lib/fanforce/api/response.rb', line 36 def curl_command @curl_command ||= Fanforce::Utils.curl_command(@request.method, @requested_url, @requested_params) end |
#current_page ⇒ Object
46 |
# File 'lib/fanforce/api/response.rb', line 46 def current_page; 1 end |
#current_results ⇒ Object
44 |
# File 'lib/fanforce/api/response.rb', line 44 def current_results; 1 end |
#data ⇒ Object Also known as: result
31 32 33 |
# File 'lib/fanforce/api/response.rb', line 31 def data self end |
#next_page ⇒ Object
49 |
# File 'lib/fanforce/api/response.rb', line 49 def next_page; nil end |
#next_page_url ⇒ Object
51 |
# File 'lib/fanforce/api/response.rb', line 51 def next_page_url; nil end |
#prev_page ⇒ Object
48 |
# File 'lib/fanforce/api/response.rb', line 48 def prev_page; nil end |
#prev_page_url ⇒ Object
50 |
# File 'lib/fanforce/api/response.rb', line 50 def prev_page_url; nil end |
#total_pages ⇒ Object
47 |
# File 'lib/fanforce/api/response.rb', line 47 def total_pages; 1 end |
#total_results ⇒ Object
45 |
# File 'lib/fanforce/api/response.rb', line 45 def total_results; 1 end |