refworks 0.0.2

data/lib/refworks/folders/search/folders_search_response.rb

@@ -0,0 +1,3 @@
+class FoldersSearchResponse < FoldersResponse
+
+end

data/lib/refworks/importfilter/allavailable/importfilter_allavailable_request.rb

@@ -0,0 +1,20 @@
+class ImportfilterAllavailableRequest < ImportfilterRequest
+  def self.call_method
+    'allavailable'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common ImportFilters 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/importfilter/allavailable/importfilter_allavailable_response.rb

@@ -0,0 +1,3 @@
+class ImportfilterAllavailableResponse < ImportfilterResponse
+
+end

data/lib/refworks/importfilter/allglobal/importfilter_allglobal_request.rb

@@ -0,0 +1,20 @@
+class ImportfilterAllglobalRequest < ImportfilterRequest
+  def self.call_method
+    'allglobal'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common ImportFilter parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the allglobal 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/importfilter/allglobal/importfilter_allglobal_response.rb

@@ -0,0 +1,3 @@
+class ImportfilterAllglobalResponse < ImportfilterResponse
+
+end

data/lib/refworks/importfilter/favorites/importfilter_favorites_request.rb

@@ -0,0 +1,20 @@
+class ImportfilterFavoritesRequest < ImportfilterRequest
+  def self.call_method
+    'favorites'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common ImportFilters parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the favorites 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/importfilter/favorites/importfilter_favorites_response.rb

@@ -0,0 +1,3 @@
+class ImportfilterFavoritesResponse < ImportfilterResponse
+
+end

data/lib/refworks/importfilter/importfilter.rb

@@ -0,0 +1,18 @@
+class Importfilter
+  attr_reader :name, :id, :owner, :databases
+
+  def initialize(rawfilter)
+    @name = rawfilter["Name"]
+    @id = rawfilter["id"]
+    @owner = rawfilter["owner"]
+    @databases = Array.new
+
+    # Promote all returned database values to arrays in the object, even if one database returned, for consistency
+    if rawfilter["Database"].class == Array
+      @databases = rawfilter["Database"]
+    else
+      @databases << rawfilter["Database"]
+    end
+  end
+
+end

data/lib/refworks/importfilter/importfilter_request.rb

@@ -0,0 +1,16 @@
+class ImportfilterRequest < Request
+  def self.call_class
+    "importfilter"
+  end
+
+  def self.generate_class_params(params)
+    # handle params common to all ImportFilters calls
+    class_name = call_class()
+
+    # query parameters common to all ImportFilters calls
+    {
+        :class => class_name,
+        :includedb => params[:includedb] || 'false',
+    }
+  end
+end

data/lib/refworks/importfilter/importfilter_response.rb

@@ -0,0 +1,35 @@
+class ImportfilterResponse < Response
+  attr_reader :totalFilters, :importfilters
+
+  def initialize(raw_response)
+    super(raw_response)
+    if result_code != "200"
+      @totalFilters = "0"
+      return
+    end
+
+    @totalFilters = self.parsed_response["refworks"]["RWResult"]["ImportFilterResult"]["totalFilters"]
+
+    # e.g. case of no favorites
+    if @totalFilters == "0"
+      return
+    end
+
+    # If results returned, process the importfilters and metadata
+    filter_list = self.parsed_response["refworks"]["RWResult"]["ImportFilterResult"]["ImportFilter"]
+
+    # here we parse out authors into an array of actual Importfilter objects (even if only 1 ref returned)
+    @importfilters = Array.new
+
+    # The RefWorks API can return an array or a single element depending on how many importfilters were returned.
+    if filter_list.class == Array
+      filter_list.each do |rawfilter|
+        @importfilters << Importfilter.new(rawfilter)
+      end
+    else
+      # here, "filter_list" is just a hash representing a single author
+      # in other words, only one importfilter was returned
+      @importfilters << Importfilter.new(filter_list)
+    end
+  end
+end

data/lib/refworks/importfilter/search/importfilter_search_request.rb

@@ -0,0 +1,22 @@
+class ImportfilterSearchRequest < ImportfilterRequest
+  def self.call_method
+    'search'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common ImportFilters 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/importfilter/search/importfilter_search_response.rb

@@ -0,0 +1,3 @@
+class ImportfilterSearchResponse < ImportfilterResponse
+
+end

data/lib/refworks/manuscript/all/manuscript_all_request.rb

@@ -0,0 +1,22 @@
+class ManuscriptAllRequest < ManuscriptRequest
+  def self.call_method
+    'all'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Manuscript parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the baseurl 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/manuscript/all/manuscript_all_response.rb

@@ -0,0 +1,13 @@
+class ManuscriptAllResponse < ManuscriptResponse
+  attr_reader :filetoken
+
+  def initialize(raw_response)
+    super(raw_response)
+
+    if result_code != "200"
+      return
+    end
+
+    @filetoken = self.parsed_response["refworks"]["RWResult"]["RWManuscript"]["FileToken"]
+  end
+end

data/lib/refworks/manuscript/baseurl/manuscript_baseurl_request.rb

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

data/lib/refworks/manuscript/baseurl/manuscript_baseurl_response.rb

@@ -0,0 +1,13 @@
+class ManuscriptBaseurlResponse < ManuscriptResponse
+  attr_reader :baseurl
+
+  def initialize(raw_response)
+    super(raw_response)
+
+    if result_code != "200"
+      return
+    end
+
+    @baseurl = self.parsed_response["refworks"]["RWResult"]["BaseURL"]
+  end
+end

data/lib/refworks/manuscript/byid/manuscript_byid_request.rb

@@ -0,0 +1,32 @@
+class ManuscriptByidRequest < ManuscriptRequest
+  def self.call_method
+    'byid'
+  end
+
+  def self.http_request_verb
+    'POST'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Manuscript parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the byid call
+    method_params = { :method => call_method,
+    }
+
+    query_string_params = class_params.merge(method_params)
+
+    # Construct the XML payload for the byid call.
+    ids = params[:ids]
+
+    message_body = '<RWRequest class="manuscript" method="byid">'
+    message_body << ids.collect{ |x| "<id>#{x}</id>"}.join
+    message_body << '</RWRequest>'
+
+    # return the request info
+    {:params => query_string_params, :body => message_body, :headers => {'Content-type' => 'text/xml'}}
+  end
+
+end

data/lib/refworks/manuscript/byid/manuscript_byid_response.rb

@@ -0,0 +1,3 @@
+class ManuscriptByidResponse < ManuscriptResponse
+
+end

data/lib/refworks/manuscript/file/manuscript_file_request.rb

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

data/lib/refworks/manuscript/file/manuscript_file_response.rb

@@ -0,0 +1,18 @@
+class ManuscriptFileResponse < ManuscriptResponse
+  attr_reader :body, :parsed_response, :result_code, :result_msg, :process_time
+
+  def initialize(raw_response)
+
+    @result_code = raw_response.code
+    @body = raw_response.body
+    @parsed_response = nil
+
+    if @result_code != 200
+      @result_code = raw_response.code
+      @result_msg = raw_response.msg
+    else
+      @parsed_response = nil
+      @result_msg = "File retrieved and stored in body attribute.  Parsed response not applicable for file retrievals."
+    end
+  end
+end

data/lib/refworks/manuscript/folder/manuscript_folder_request.rb

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

data/lib/refworks/manuscript/folder/manuscript_folder_response.rb

@@ -0,0 +1,14 @@
+class ManuscriptFolderResponse < ManuscriptResponse
+  attr_reader :filetoken
+
+  def initialize(raw_response)
+    super(raw_response)
+
+    if result_code != "200"
+      return
+    end
+
+    @filetoken = self.parsed_response["refworks"]["RWResult"]["RWManuscript"]["FileToken"]
+  end
+
+end

data/lib/refworks/manuscript/manuscript_request.rb

@@ -0,0 +1,20 @@
+class ManuscriptRequest < Request
+  def self.call_class
+    "manuscript"
+  end
+
+  def self.generate_class_params(params)
+    # handle params common to all Manuscript calls
+    class_name = call_class()
+
+    # query parameters common to all Manuscript calls
+    {
+        :class => class_name,
+        :id => params[:id],
+        :fileformat => params[:fileformat],
+        :maxrefs => params[:maxrefs] || 999999,
+        :language => params[:language] || 'en',
+        :base_url => params[:base_url] || nil,
+    }
+  end
+end

data/lib/refworks/manuscript/manuscript_response.rb

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

data/lib/refworks/manuscript/mylist/manuscript_mylist_request.rb

@@ -0,0 +1,21 @@
+class ManuscriptMylistRequest < ManuscriptRequest
+  def self.call_method
+    'mylist'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Manuscript parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the mylist 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/manuscript/mylist/manuscript_mylist_response.rb

@@ -0,0 +1,14 @@
+class ManuscriptMylistResponse < ManuscriptResponse
+  attr_reader :filetoken
+
+  def initialize(raw_response)
+    super(raw_response)
+
+    if result_code != "200"
+      return
+    end
+
+    @filetoken = self.parsed_response["refworks"]["RWResult"]["RWManuscript"]["FileToken"]
+  end
+
+end