refworks 0.0.2

data/lib/refworks/reference/get/reference_get_request.rb

@@ -0,0 +1,21 @@
+class ReferenceGetRequest < ReferenceRequest
+  def self.call_method
+    'get'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Reference parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the get call
+    method_params = { :method => call_method,
+                      :id => params[:id],
+    }
+
+    query_string_params = class_params.merge(method_params)
+
+    # return the request info
+    {:params => query_string_params}
+  end
+end

data/lib/refworks/reference/get/reference_get_response.rb

@@ -0,0 +1,7 @@
+class ReferenceGetResponse < RetrieveResponse
+  # Note the weirdness here, that ReferenceGetResponse is a child of RetrieveResponse (not ReferenceResponse).
+  # That's because the get method returns one or more references, which is exactly what Retrieve class is designed
+  # to do, whereas the rest of the Reference class has to do with -modifying- references.
+
+  # In other words, there probably shouldn't be a get method in the Reference class, but that's how the API is done.
+end

data/lib/refworks/reference/reference_request.rb

@@ -0,0 +1,15 @@
+class ReferenceRequest < Request
+  def self.call_class
+    "reference"
+  end
+
+  def self.generate_class_params(params)
+    # handle params common to all Reference calls
+    class_name = call_class()
+
+    # query parameters common to all Reference calls
+    {
+        :class => class_name,
+    }
+  end
+end

data/lib/refworks/reference/reference_response.rb

@@ -0,0 +1,3 @@
+class ReferenceResponse < Response
+
+end

data/lib/refworks/request.rb

@@ -0,0 +1,50 @@
+
+# The base abstract Request class.  Universal request logic is captured here.
+# @abstract
+# @api private
+class Request
+  require 'rubygems'
+  require 'base64'
+  require 'openssl'
+
+  # Returns the verb which should be used to request a particular API method.  Since most of the API
+  # is based on GET requests, we define that as the default behavior here and override in
+  # subclasses where necessary.
+  # @return [String] The string 'GET'
+  def self.http_request_verb
+    'GET'
+  end
+
+  # Generates a signature for the API call per the Refworks API signature specification.
+  # @param [String] call_class The name of the class being called.
+  # @param [String] access_key The user's access key.
+  # @param [String] secret_key The user's secret key.
+  # @return [String] A Refworks signature.
+  def self.generate_signature(call_class, access_key, secret_key)
+
+    # Construct the RW-required signature using the algorithm from their docs
+    # expires should be the current time represented in microseconds since the epoch
+    expires = Time.now.to_i * 1000
+
+    # RW formula for signature message
+    signature = call_class + access_key + expires.to_s.chomp
+
+    # Run it through HMAC SHA1 using secret key
+    hmacsig = OpenSSL::HMAC.digest('sha1', secret_key, signature)
+
+    # Base64 encode it
+    # Ruby 1.8 way
+    #encodedsig = Base64.encode64(hmacsig)
+    # Ruby 1.9.2 way
+    encodedsig = Base64.strict_encode64(hmacsig)
+
+    # Base64.encode64 adds a newline at end of string if not present.  This strips it.
+    # Otherwise, you get an Invalid Signature error from RW
+    # Do this if you are using Ruby 1.8 and don't have access to strict_encode64 as used above
+    #encodedsig.gsub!(/%0A/,'')
+
+    # Return hash
+    {:signature => encodedsig, :accesskeyid => access_key, :expires => expires}
+  end
+
+end

data/lib/refworks/response.rb

@@ -0,0 +1,12 @@
+
+class Response
+  attr_reader :body, :parsed_response, :result_code, :result_msg, :process_time
+
+  def initialize(raw_response)
+    @body = raw_response.body
+    @parsed_response = raw_response.parsed_response
+    @result_code = parsed_response["refworks"]["RWResult"]["result"]
+    @process_time = parsed_response["refworks"]["RWResult"]["processTime"]
+    @result_msg = parsed_response["refworks"]["RWResult"]["resultMsg"]
+  end
+end

data/lib/refworks/retrieve/advancesearch/retrieve_advancesearch_request.rb

@@ -0,0 +1,41 @@
+class RetrieveAdvancesearchRequest < RetrieveRequest
+
+  def self.call_method
+    'advancesearch'
+  end
+
+  def self.http_request_verb
+    'POST'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Retrieve parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the advancesearch call
+    method_params = { :method => call_method,
+                      :classic => params[:classic] || 'true',
+                      :search => params[:search],
+    }
+
+    query_string_params = class_params.merge(method_params)
+    # advancesearch also has a POST payload
+
+    # construct ParameterList
+    parameter_list = "<ParameterList>"
+    params[:parameter_list].each do |param|
+      connector = param[:connector] || "and"
+      field = param[:field] || "ALL"
+      searchempty = param[:searchempty] || "false"
+      parameter_list << "<Parameter connector=\"#{connector}\" field=\"#{field}\" searchempty=\"#{searchempty}\">#{param[:search]}</Parameter>"
+    end
+    parameter_list << "</ParameterList>"
+
+    message_body = parameter_list
+
+    # return the request info
+    {:params => query_string_params, :body => message_body, :headers => {'Content-type' => 'text/xml'}}
+  end
+
+end

data/lib/refworks/retrieve/advancesearch/retrieve_advancesearch_response.rb

@@ -0,0 +1,3 @@
+class RetrieveAdvancesearchResponse < RetrieveResponse
+
+end

data/lib/refworks/retrieve/all/retrieve_all_request.rb

@@ -0,0 +1,21 @@
+class RetrieveAllRequest < RetrieveRequest
+
+  def self.call_method
+    'all'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Retrieve 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
+end

data/lib/refworks/retrieve/all/retrieve_all_response.rb

@@ -0,0 +1,3 @@
+class RetrieveAllResponse < RetrieveResponse
+
+end

data/lib/refworks/retrieve/author/retrieve_author_request.rb

@@ -0,0 +1,23 @@
+class RetrieveAuthorRequest < RetrieveRequest
+
+  def self.call_method
+    'author'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Retrieve parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the author call
+    method_params = { :method => call_method,
+                      :search => params[:search],
+                      :folder => params[:folder], # this is optional, if nil entire account is searched
+    }
+
+    query_string_params = class_params.merge(method_params)
+
+    # return the request info
+    {:params => query_string_params}
+  end
+end

data/lib/refworks/retrieve/author/retrieve_author_response.rb

@@ -0,0 +1,3 @@
+class RetrieveAuthorResponse < RetrieveResponse
+
+end

data/lib/refworks/retrieve/byid/retrieve_byid_request.rb

@@ -0,0 +1,22 @@
+class RetrieveByidRequest < RetrieveRequest
+
+  def self.call_method
+    'byid'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Retrieve parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the byid call
+    method_params = { :method => call_method,
+                      :id => params[:id],
+    }
+
+    query_string_params = class_params.merge(method_params)
+
+    # return the request info
+    {:params => query_string_params}
+  end
+end

data/lib/refworks/retrieve/byid/retrieve_byid_response.rb

@@ -0,0 +1,3 @@
+class RetrieveByidResponse < RetrieveResponse
+
+end

data/lib/refworks/retrieve/count/retrieve_count_request.rb

@@ -0,0 +1,21 @@
+class RetrieveCountRequest < RetrieveRequest
+  def self.call_method
+    'count'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Retrieve parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the count call
+    method_params = { :method => call_method,
+                      :attachonly => params[:attachonly] || 'false',
+    }
+
+    query_string_params = class_params.merge(method_params)
+
+    # return the request info
+    {:params => query_string_params}
+  end
+end

data/lib/refworks/retrieve/count/retrieve_count_response.rb

@@ -0,0 +1,16 @@
+class RetrieveCountResponse < Response
+
+  attr_reader :count
+
+  def initialize(raw_response)
+    super(raw_response)
+    if result_code != "200"
+      return
+    end
+
+    # If results returned, process the references and metadata
+
+    @count = self.parsed_response["refworks"]["RWResult"]["RetrieveCount"]["count"]
+  end
+
+end

data/lib/refworks/retrieve/descriptor/retrieve_descriptor_request.rb

@@ -0,0 +1,22 @@
+class RetrieveDescriptorRequest < RetrieveRequest
+
+  def self.call_method
+    'descriptor'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Retrieve parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the descriptor call
+    method_params = { :method => call_method,
+                      :search => params[:search],
+    }
+
+    query_string_params = class_params.merge(method_params)
+
+    # return the request info
+    {:params => query_string_params}
+  end
+end

data/lib/refworks/retrieve/descriptor/retrieve_descriptor_response.rb

@@ -0,0 +1,3 @@
+class RetrieveDescriptorResponse < RetrieveResponse
+
+end

data/lib/refworks/retrieve/dup/retrieve_dup_request.rb

@@ -0,0 +1,21 @@
+class RetrieveDupRequest < RetrieveRequest
+  def self.call_method
+    'dup'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Retrieve parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the dup call
+    method_params = { :method => call_method,
+                      :search => params[:search],
+    }
+
+    query_string_params = class_params.merge(method_params)
+
+    # return the request info
+    {:params => query_string_params}
+  end
+end

data/lib/refworks/retrieve/dup/retrieve_dup_response.rb

@@ -0,0 +1,3 @@
+class RetrieveDupResponse < RetrieveResponse
+
+end

data/lib/refworks/retrieve/folder/retrieve_folder_request.rb

@@ -0,0 +1,21 @@
+class RetrieveFolderRequest < RetrieveRequest
+  def self.call_method
+    'folder'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Retrieve parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the search call
+    method_params = { :method => call_method,
+                      :search => params[:search],
+    }
+
+    query_string_params = class_params.merge(method_params)
+
+    # return the request info
+    {:params => query_string_params}
+  end
+end

data/lib/refworks/retrieve/folder/retrieve_folder_response.rb

@@ -0,0 +1,3 @@
+class RetrieveFolderResponse < RetrieveResponse
+
+end

data/lib/refworks/retrieve/modsince/retrieve_modsince_request.rb

@@ -0,0 +1,23 @@
+class RetrieveModsinceRequest < RetrieveRequest
+  def self.call_method
+    'modsince'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Retrieve parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the byid call
+    method_params = { :method => call_method,
+                      :search => params[:search],
+                      :skipref => params[:skipref] || 0,
+                      :attachonly => params[:attachonly] || "false",
+    }
+
+    query_string_params = class_params.merge(method_params)
+
+    # return the request info
+    {:params => query_string_params}
+  end
+end

data/lib/refworks/retrieve/modsince/retrieve_modsince_response.rb

@@ -0,0 +1,3 @@
+class RetrieveModsinceResponse < RetrieveResponse
+
+end

data/lib/refworks/retrieve/nofolder/retrieve_nofolder_request.rb

@@ -0,0 +1,20 @@
+class RetrieveNofolderRequest < RetrieveRequest
+  def self.call_method
+    'nofolder'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Retrieve parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the nofolder call
+    method_params = { :method => call_method,
+    }
+
+    query_string_params = class_params.merge(method_params)
+
+    # return the request info
+    {:params => query_string_params}
+  end
+end

data/lib/refworks/retrieve/nofolder/retrieve_nofolder_response.rb

@@ -0,0 +1,3 @@
+class RetrieveNofolderResponse < RetrieveResponse
+
+end

data/lib/refworks/retrieve/periodical/retrieve_periodical_request.rb

@@ -0,0 +1,22 @@
+class RetrievePeriodicalRequest < RetrieveRequest
+
+  def self.call_method
+    'periodical'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Retrieve parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the periodical call
+    method_params = { :method => call_method,
+                      :search => params[:search],
+    }
+
+    query_string_params = class_params.merge(method_params)
+
+    # return the request info
+    {:params => query_string_params}
+  end
+end