Class: AuthorsAllRequest Private

Inherits:
AuthorsRequest show all
Defined in:
lib/refworks/authors/all/authors_all_request.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

The Author class all method call. This call has no method-specific parameters.

Users will not instantiate this class directly; the Refworks.request method will do so.

Class Method Summary collapse

Methods inherited from AuthorsRequest

call_class, generate_class_params

Methods inherited from Request

generate_signature, http_request_verb

Class Method Details

.call_methodObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



7
8
9
# File 'lib/refworks/authors/all/authors_all_request.rb', line 7

def self.call_method
  'all'
end

.generate_request_info(params) ⇒ Hash

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Assembles the information needed to construct the query string for this request

Parameters:

  • params (Hash)

    This should be an empty hash. This call has no method-specific parameters.

Returns:

  • (Hash)

    Returns hash of request parameters for this call.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
# File 'lib/refworks/authors/all/authors_all_request.rb', line 14

def self.generate_request_info(params)

  # get common Authors parameters
  class_params = generate_class_params(params)

  # query parameters for the all call
  method_params = { :method => call_method,
  }

  query_string_params = class_params.merge(method_params)

  # return the request info
  {:params => query_string_params}
end