refworks 0.0.2

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

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

data/lib/refworks/retrieve/quick/retrieve_quick_request.rb

@@ -0,0 +1,23 @@
+class RetrieveQuickRequest < RetrieveRequest
+
+  def self.call_method
+    'quick'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Retrieve parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the quick 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/quick/retrieve_quick_response.rb

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

data/lib/refworks/retrieve/retrieve_request.rb

@@ -0,0 +1,22 @@
+class RetrieveRequest < Request
+  def self.call_class
+    "retrieve"
+  end
+
+  def self.generate_class_params(params)
+    # handle params common to all Retrieve calls
+    class_name = call_class()
+
+    # query parameters common to all Retrieve calls
+    {
+      :class => class_name,
+      :pgsize => params[:pgsize] || 50,
+      :pgnum => params[:pgnum] || 1,
+      :format => params[:format] || 'html',
+      :sort => params[:sort], # no default set; according to API, default depends on method called
+      :style => 0,  # no alternate styles currently supported; passed-in param will be ignored
+      :language => 'en', # only differs if a style is set, which is not possible currently; passed-in param ignored
+      :biblist => 'false' # only differs if a style is set, which is not possible currently; passed-in param ignored
+    }
+  end
+end

data/lib/refworks/retrieve/retrieve_response.rb

@@ -0,0 +1,34 @@
+class RetrieveResponse < Response
+
+  attr_reader :total_hits, :total_returned, :references
+
+  def initialize(raw_response)
+    super(raw_response)
+    if result_code != "200"
+      @total_hits = "0"
+      @total_returned = "0"
+      return
+    end
+
+    # If results returned, process the references and metadata
+
+    @total_hits = self.parsed_response["refworks"]["RWResult"]["RetrieveResult"]["totalHits"]
+    @total_returned = self.parsed_response["refworks"]["RWResult"]["RetrieveResult"]["totalReturned"]
+
+    refs = self.parsed_response["refworks"]["RWResult"]["RetrieveResult"]["reference"]
+
+    # here we parse out references into an array of actual Reference objects (even if only 1 ref returned)
+    @references = Array.new
+
+    # The RefWorks API can return an array or a single element depending on how many references were returned.
+    if refs.class == Array
+      refs.each do |ref|
+        @references << Reference.new(ref)
+      end
+    else
+      # here, "refs" is just a hash representing a single reference
+      # in other words, only one reference was returned
+      @references << Reference.new(refs)
+    end
+  end
+end

data/lib/refworks/retrieve/saved/retrieve_saved_request.rb

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

data/lib/refworks/retrieve/saved/retrieve_saved_response.rb

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

data/lib/refworks/retrieve/specialfolder/retrieve_specialfolder_request.rb

@@ -0,0 +1,21 @@
+class RetrieveSpecialfolderRequest < RetrieveRequest
+  def self.call_method
+    'specialfolder'
+  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],
+    }
+
+    query_string_params = class_params.merge(method_params)
+
+    # return the request info
+    {:params => query_string_params}
+  end
+end

data/lib/refworks/retrieve/specialfolder/retrieve_specialfolder_response.rb

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

data/lib/refworks/savedsearch/all/savedsearch_all_request.rb

@@ -0,0 +1,21 @@
+class SavedsearchAllRequest < SavedsearchRequest
+  def self.call_method
+    'all'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Savedsearch parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the all 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/savedsearch/all/savedsearch_all_response.rb

@@ -0,0 +1,3 @@
+class SavedsearchAllResponse < SavedsearchResponse
+
+end

data/lib/refworks/savedsearch/get/savedsearch_get_request.rb

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

data/lib/refworks/savedsearch/get/savedsearch_get_response.rb

@@ -0,0 +1,3 @@
+class SavedsearchGetResponse < SavedsearchResponse
+
+end

data/lib/refworks/savedsearch/savedsearch.rb

@@ -0,0 +1,21 @@
+class Savedsearch
+  attr_reader :name, :parameterlist, :folderlist
+
+  def initialize(rawss)
+    @name = rawss["name"]
+    paramlist = rawss["ParameterList"]
+
+    @parameterlist = Array.new
+
+    if paramlist.class == Array
+      paramlist.each do |param|
+        @parameterlist << SavedsearchParameter.new(param)
+      end
+    else
+      @parameterlist << SavedsearchParameter.new(paramlist)
+    end
+
+    @folderlist = Array.new
+    @folderlist << rawss["FolderList"]
+  end
+end

data/lib/refworks/savedsearch/savedsearch_parameter.rb

@@ -0,0 +1,18 @@
+class SavedsearchParameter
+  attr_reader :components
+
+  def initialize(rawparam)
+
+    comps = rawparam["Parameter"]
+
+    @components = Array.new
+
+    if comps.class == Array
+      comps.each do |comp|
+        @components << SavedsearchParameterComponent.new(comp)
+      end
+    else
+      @components << SavedsearchParameterComponent.new(comps)
+    end
+  end
+end

data/lib/refworks/savedsearch/savedsearch_parameter_component.rb

@@ -0,0 +1,10 @@
+class SavedsearchParameterComponent
+  attr_reader :connector, :field, :searchempty, :content
+
+  def initialize(rawcomponent)
+    @content = rawcomponent["__content__"]
+    @connector = rawcomponent["connector"]
+    @field = rawcomponent["field"]
+    @searchempty = rawcomponent["searchempty"]
+  end
+end

data/lib/refworks/savedsearch/savedsearch_request.rb

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

data/lib/refworks/savedsearch/savedsearch_response.rb

@@ -0,0 +1,24 @@
+class SavedsearchResponse < Response
+  attr_reader :savedsearches
+
+  def initialize(raw_response)
+    super(raw_response)
+    if result_code != "200"
+      @total = "0"
+      return
+    end
+
+    # If results returned, process the savedsearches and metadata
+
+    srchs = self.parsed_response["refworks"]["RWResult"]["AdvancedSearchStrategy"]
+
+    @savedsearches = Array.new
+    if srchs.class == Array
+     srchs.each do |srch|
+        @savedsearches << Savedsearch.new(srch)
+      end
+    else
+       @savedsearches << Savedsearch.new(srchs)
+    end
+  end
+end

data/lib/refworks/version.rb

@@ -0,0 +1,3 @@
+class Refworks
+  VERSION = '0.0.2'
+end

metadata

@@ -0,0 +1,224 @@
+--- !ruby/object:Gem::Specification
+name: refworks
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Fran Fabrizio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby interface to the RefWorks API, implementing a subset of the API
+  (see README for specifics).
+email:
+- fran@umn.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/refworks.rb
+- lib/refworks/authentication/authentication_request.rb
+- lib/refworks/authentication/authentication_response.rb
+- lib/refworks/authentication/delsess/authentication_delsess_request.rb
+- lib/refworks/authentication/delsess/authentication_delsess_response.rb
+- lib/refworks/authentication/newsess/authentication_newsess_request.rb
+- lib/refworks/authentication/newsess/authentication_newsess_response.rb
+- lib/refworks/authentication/newtempusersess/authentication_newtempusersess_request.rb
+- lib/refworks/authentication/newtempusersess/authentication_newtempusersess_response.rb
+- lib/refworks/authentication/ping/authentication_ping_request.rb
+- lib/refworks/authentication/ping/authentication_ping_response.rb
+- lib/refworks/authentication/userexists/authentication_userexists_request.rb
+- lib/refworks/authentication/userexists/authentication_userexists_response.rb
+- lib/refworks/authors/all/authors_all_request.rb
+- lib/refworks/authors/all/authors_all_response.rb
+- lib/refworks/authors/author.rb
+- lib/refworks/authors/authors_request.rb
+- lib/refworks/authors/authors_response.rb
+- lib/refworks/authors/search/authors_search_request.rb
+- lib/refworks/authors/search/authors_search_response.rb
+- lib/refworks/descriptors/all/descriptors_all_request.rb
+- lib/refworks/descriptors/all/descriptors_all_response.rb
+- lib/refworks/descriptors/descriptor.rb
+- lib/refworks/descriptors/descriptors_request.rb
+- lib/refworks/descriptors/descriptors_response.rb
+- lib/refworks/descriptors/search/descriptors_search_request.rb
+- lib/refworks/descriptors/search/descriptors_search_response.rb
+- lib/refworks/folders/all/folders_all_request.rb
+- lib/refworks/folders/all/folders_all_response.rb
+- lib/refworks/folders/folder.rb
+- lib/refworks/folders/folders_request.rb
+- lib/refworks/folders/folders_response.rb
+- lib/refworks/folders/search/folders_search_request.rb
+- lib/refworks/folders/search/folders_search_response.rb
+- lib/refworks/importfilter/allavailable/importfilter_allavailable_request.rb
+- lib/refworks/importfilter/allavailable/importfilter_allavailable_response.rb
+- lib/refworks/importfilter/allglobal/importfilter_allglobal_request.rb
+- lib/refworks/importfilter/allglobal/importfilter_allglobal_response.rb
+- lib/refworks/importfilter/favorites/importfilter_favorites_request.rb
+- lib/refworks/importfilter/favorites/importfilter_favorites_response.rb
+- lib/refworks/importfilter/importfilter.rb
+- lib/refworks/importfilter/importfilter_request.rb
+- lib/refworks/importfilter/importfilter_response.rb
+- lib/refworks/importfilter/search/importfilter_search_request.rb
+- lib/refworks/importfilter/search/importfilter_search_response.rb
+- lib/refworks/manuscript/all/manuscript_all_request.rb
+- lib/refworks/manuscript/all/manuscript_all_response.rb
+- lib/refworks/manuscript/baseurl/manuscript_baseurl_request.rb
+- lib/refworks/manuscript/baseurl/manuscript_baseurl_response.rb
+- lib/refworks/manuscript/byid/manuscript_byid_request.rb
+- lib/refworks/manuscript/byid/manuscript_byid_response.rb
+- lib/refworks/manuscript/file/manuscript_file_request.rb
+- lib/refworks/manuscript/file/manuscript_file_response.rb
+- lib/refworks/manuscript/folder/manuscript_folder_request.rb
+- lib/refworks/manuscript/folder/manuscript_folder_response.rb
+- lib/refworks/manuscript/manuscript_request.rb
+- lib/refworks/manuscript/manuscript_response.rb
+- lib/refworks/manuscript/mylist/manuscript_mylist_request.rb
+- lib/refworks/manuscript/mylist/manuscript_mylist_response.rb
+- lib/refworks/periodicals/all/periodicals_all_request.rb
+- lib/refworks/periodicals/all/periodicals_all_response.rb
+- lib/refworks/periodicals/periodical.rb
+- lib/refworks/periodicals/periodicals_request.rb
+- lib/refworks/periodicals/periodicals_response.rb
+- lib/refworks/periodicals/search/periodicals_search_request.rb
+- lib/refworks/periodicals/search/periodicals_search_response.rb
+- lib/refworks/properties/encoding/encoding.rb
+- lib/refworks/properties/encoding/properties_encoding_request.rb
+- lib/refworks/properties/encoding/properties_encoding_response.rb
+- lib/refworks/properties/fieldlabels/fieldlabel.rb
+- lib/refworks/properties/fieldlabels/properties_fieldlabels_request.rb
+- lib/refworks/properties/fieldlabels/properties_fieldlabels_response.rb
+- lib/refworks/properties/fieldlabels/reftypeFieldlabels.rb
+- lib/refworks/properties/languages/language.rb
+- lib/refworks/properties/languages/properties_languages_request.rb
+- lib/refworks/properties/languages/properties_languages_response.rb
+- lib/refworks/properties/outputlanguage/outputlanguage.rb
+- lib/refworks/properties/outputlanguage/properties_outputlanguage_request.rb
+- lib/refworks/properties/outputlanguage/properties_outputlanguage_response.rb
+- lib/refworks/properties/properties_request.rb
+- lib/refworks/properties/properties_response.rb
+- lib/refworks/properties/sortlocales/properties_sortlocales_request.rb
+- lib/refworks/properties/sortlocales/properties_sortlocales_response.rb
+- lib/refworks/properties/sortlocales/sortlocale.rb
+- lib/refworks/properties/sourcetypes/properties_sourcetypes_request.rb
+- lib/refworks/properties/sourcetypes/properties_sourcetypes_response.rb
+- lib/refworks/properties/sourcetypes/sourcetype.rb
+- lib/refworks/properties/typelabels/properties_typelabels_request.rb
+- lib/refworks/properties/typelabels/properties_typelabels_response.rb
+- lib/refworks/properties/typelabels/typelabel.rb
+- lib/refworks/reference.rb
+- lib/refworks/reference/get/reference_get_request.rb
+- lib/refworks/reference/get/reference_get_response.rb
+- lib/refworks/reference/reference_request.rb
+- lib/refworks/reference/reference_response.rb
+- lib/refworks/request.rb
+- lib/refworks/response.rb
+- lib/refworks/retrieve/advancesearch/retrieve_advancesearch_request.rb
+- lib/refworks/retrieve/advancesearch/retrieve_advancesearch_response.rb
+- lib/refworks/retrieve/all/retrieve_all_request.rb
+- lib/refworks/retrieve/all/retrieve_all_response.rb
+- lib/refworks/retrieve/author/retrieve_author_request.rb
+- lib/refworks/retrieve/author/retrieve_author_response.rb
+- lib/refworks/retrieve/byid/retrieve_byid_request.rb
+- lib/refworks/retrieve/byid/retrieve_byid_response.rb
+- lib/refworks/retrieve/count/retrieve_count_request.rb
+- lib/refworks/retrieve/count/retrieve_count_response.rb
+- lib/refworks/retrieve/descriptor/retrieve_descriptor_request.rb
+- lib/refworks/retrieve/descriptor/retrieve_descriptor_response.rb
+- lib/refworks/retrieve/dup/retrieve_dup_request.rb
+- lib/refworks/retrieve/dup/retrieve_dup_response.rb
+- lib/refworks/retrieve/folder/retrieve_folder_request.rb
+- lib/refworks/retrieve/folder/retrieve_folder_response.rb
+- lib/refworks/retrieve/modsince/retrieve_modsince_request.rb
+- lib/refworks/retrieve/modsince/retrieve_modsince_response.rb
+- lib/refworks/retrieve/nofolder/retrieve_nofolder_request.rb
+- lib/refworks/retrieve/nofolder/retrieve_nofolder_response.rb
+- lib/refworks/retrieve/periodical/retrieve_periodical_request.rb
+- lib/refworks/retrieve/periodical/retrieve_periodical_response.rb
+- lib/refworks/retrieve/quick/retrieve_quick_request.rb
+- lib/refworks/retrieve/quick/retrieve_quick_response.rb
+- lib/refworks/retrieve/retrieve_request.rb
+- lib/refworks/retrieve/retrieve_response.rb
+- lib/refworks/retrieve/saved/retrieve_saved_request.rb
+- lib/refworks/retrieve/saved/retrieve_saved_response.rb
+- lib/refworks/retrieve/specialfolder/retrieve_specialfolder_request.rb
+- lib/refworks/retrieve/specialfolder/retrieve_specialfolder_response.rb
+- lib/refworks/savedsearch/all/savedsearch_all_request.rb
+- lib/refworks/savedsearch/all/savedsearch_all_response.rb
+- lib/refworks/savedsearch/get/savedsearch_get_request.rb
+- lib/refworks/savedsearch/get/savedsearch_get_response.rb
+- lib/refworks/savedsearch/savedsearch.rb
+- lib/refworks/savedsearch/savedsearch_parameter.rb
+- lib/refworks/savedsearch/savedsearch_parameter_component.rb
+- lib/refworks/savedsearch/savedsearch_request.rb
+- lib/refworks/savedsearch/savedsearch_response.rb
+- lib/refworks/version.rb
+homepage: http://github.umn.edu/mpc/refworks-api-ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: refworks
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: A Ruby interface to the RefWorks API.
+test_files: []