refworks 0.0.2

data/lib/refworks/periodicals/all/periodicals_all_request.rb

@@ -0,0 +1,21 @@
+class PeriodicalsAllRequest < PeriodicalsRequest
+  def self.call_method
+    'all'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Periodicals 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/periodicals/all/periodicals_all_response.rb

@@ -0,0 +1,3 @@
+class PeriodicalsAllResponse < PeriodicalsResponse
+
+end

data/lib/refworks/periodicals/periodical.rb

@@ -0,0 +1,9 @@
+class Periodical
+  attr_reader :name, :nRefs
+
+  def initialize(rawperiodical)
+    @name = rawperiodical["__content__"]
+    @nRefs = rawperiodical["nRefs"]
+  end
+
+end

data/lib/refworks/periodicals/periodicals_request.rb

@@ -0,0 +1,17 @@
+class PeriodicalsRequest < Request
+  def self.call_class
+    "periodicals"
+  end
+
+  def self.generate_class_params(params)
+    # handle params common to all Periodicals calls
+    class_name = call_class()
+
+    # query parameters common to all Periodicals calls
+    {
+        :class => class_name,
+        :pgsize => params[:pgsize] || 50,
+        :pgnum => params[:pgnum] || 1,
+    }
+  end
+end

data/lib/refworks/periodicals/periodicals_response.rb

@@ -0,0 +1,31 @@
+class PeriodicalsResponse < Response
+  attr_reader :total, :periodicals
+
+  def initialize(raw_response)
+    super(raw_response)
+    if result_code != "200"
+      @total = "0"
+      return
+    end
+
+    # If results returned, process the periodicals and metadata
+
+    @total = self.parsed_response["refworks"]["RWResult"]["RWPeriodical"]["total"]
+
+    per_list = self.parsed_response["refworks"]["RWResult"]["RWPeriodical"]["Periodical"]
+
+    # here we parse out periodicals into an array of actual Periodical objects (even if only 1 ref returned)
+    @periodicals = Array.new
+
+    # The RefWorks API can return an array or a single element depending on how many periodicals were returned.
+    if per_list.class == Array
+      per_list.each do |rawperiodical|
+        @periodicals << Periodical.new(rawperiodical)
+      end
+    else
+      # here, "periodical_list" is just a hash representing a single periodical
+      # in other words, only one periodical was returned
+      @periodicals << Periodical.new(per_list)
+    end
+  end
+end

data/lib/refworks/periodicals/search/periodicals_search_request.rb

@@ -0,0 +1,22 @@
+class PeriodicalsSearchRequest < PeriodicalsRequest
+  def self.call_method
+    'search'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Periodicals 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/periodicals/search/periodicals_search_response.rb

@@ -0,0 +1,3 @@
+class PeriodicalsSearchResponse < PeriodicalsResponse
+
+end

data/lib/refworks/properties/encoding/encoding.rb

@@ -0,0 +1,3 @@
+class Encoding
+
+end

data/lib/refworks/properties/encoding/properties_encoding_request.rb

@@ -0,0 +1,20 @@
+class PropertiesEncodingRequest < PropertiesRequest
+  def self.call_method
+    'encoding'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Properties parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the encoding 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/properties/encoding/properties_encoding_response.rb

@@ -0,0 +1,3 @@
+class PropertiesEncodingResponse < PropertiesResponse
+
+end

data/lib/refworks/properties/fieldlabels/fieldlabel.rb

@@ -0,0 +1,13 @@
+class Fieldlabel
+  attr_reader :label, :name, :type, :displayorder, :includefld, :maxlen, :lookup
+
+  def initialize(rawfl)
+    @name = rawfl["__content__"]
+    @type = rawfl["type"]
+    @displayorder = rawfl["displayOrder"]
+    @includefld = rawfl["includefld"]
+    @maxlen = rawfl["maxlen"]
+    @lookup = rawfl["lookup"]
+  end
+
+end

data/lib/refworks/properties/fieldlabels/properties_fieldlabels_request.rb

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

data/lib/refworks/properties/fieldlabels/properties_fieldlabels_response.rb

@@ -0,0 +1,20 @@
+class PropertiesFieldlabelsResponse < PropertiesResponse
+  attr_reader :reftypes
+
+  def initialize(raw_response)
+    super(raw_response)
+    if result_code != "200"
+      @total = "0"
+      return
+    end
+
+    # If results returned, process the fieldlabels and metadata
+
+    rts = self.parsed_response["refworks"]["RWResult"]["PropertiesResult"]["reference"]
+
+    @reftypes = Array.new
+    rts.each do |rt|
+      @reftypes << ReftypeFieldlabels.new(rt)
+    end
+  end
+end

data/lib/refworks/properties/fieldlabels/reftypeFieldlabels.rb

@@ -0,0 +1,11 @@
+class ReftypeFieldlabels
+  attr_reader :typeord, :fieldlabels
+
+  def initialize(raw_rt)
+    @typeord = raw_rt["rt"]["typeOrd"]
+    @fieldLabels = Hash.new
+    raw_rt.each do |field, fieldval|
+      @fieldLabels[field] = Fieldlabel.new(fieldval)
+    end
+  end
+end

data/lib/refworks/properties/languages/language.rb

@@ -0,0 +1,8 @@
+class Language
+  attr_reader :name, :code
+
+  def initialize(rawlang)
+    @name = rawlang["name"]
+    @code = rawlang["code"]
+  end
+end

data/lib/refworks/properties/languages/properties_languages_request.rb

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

data/lib/refworks/properties/languages/properties_languages_response.rb

@@ -0,0 +1,20 @@
+class PropertiesLanguagesResponse < PropertiesResponse
+  attr_reader :languages
+
+  def initialize(raw_response)
+    super(raw_response)
+    if result_code != "200"
+      @total = "0"
+      return
+    end
+
+    # If results returned, process the languages and metadata
+
+    langs = self.parsed_response["refworks"]["RWResult"]["PropertiesResult"]["lang"]
+
+    @languages = Array.new
+    langs.each do |lang|
+      @languages << Language.new(lang)
+    end
+  end
+end

data/lib/refworks/properties/outputlanguage/outputlanguage.rb

@@ -0,0 +1,8 @@
+class Outputlanguage
+  attr_reader :name, :id
+
+  def initialize(rawlang)
+    @name = rawlang["__content__"]
+    @id = rawlang["id"]
+  end
+end

data/lib/refworks/properties/outputlanguage/properties_outputlanguage_request.rb

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

data/lib/refworks/properties/outputlanguage/properties_outputlanguage_response.rb

@@ -0,0 +1,20 @@
+class PropertiesOutputlanguageResponse < PropertiesResponse
+  attr_reader :outputlanguages
+
+  def initialize(raw_response)
+    super(raw_response)
+    if result_code != "200"
+      @total = "0"
+      return
+    end
+
+    # If results returned, process the languages and metadata
+
+    langs = self.parsed_response["refworks"]["RWResult"]["PropertiesResult"]["outputLang"]
+
+    @outputlanguages = Array.new
+    langs.each do |lang|
+      @outputlanguages << Outputlanguage.new(lang)
+    end
+  end
+end

data/lib/refworks/properties/properties_request.rb

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

data/lib/refworks/properties/properties_response.rb

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

data/lib/refworks/properties/sortlocales/properties_sortlocales_request.rb

@@ -0,0 +1,20 @@
+class PropertiesSortlocalesRequest < PropertiesRequest
+  def self.call_method
+    'sortlocales'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Properties parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the sortlocales 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/properties/sortlocales/properties_sortlocales_response.rb

@@ -0,0 +1,20 @@
+class PropertiesSortlocalesResponse < PropertiesResponse
+  attr_reader :sortlocales
+
+  def initialize(raw_response)
+    super(raw_response)
+    if result_code != "200"
+      @total = "0"
+      return
+    end
+
+    # If results returned, process the locales and metadata
+
+    locs = self.parsed_response["refworks"]["RWResult"]["PropertiesResult"]["sortLocale"]
+
+    @sortlocales = Array.new
+    locs.each do |loc|
+      @sortlocales << Sortlocale.new(loc)
+    end
+  end
+end

data/lib/refworks/properties/sortlocales/sortlocale.rb

@@ -0,0 +1,8 @@
+class Sortlocale
+  attr_reader :name, :id
+
+  def initialize(rawlang)
+    @name = rawlang["__content__"]
+    @id = rawlang["id"]
+  end
+end

data/lib/refworks/properties/sourcetypes/properties_sourcetypes_request.rb

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

data/lib/refworks/properties/sourcetypes/properties_sourcetypes_response.rb

@@ -0,0 +1,20 @@
+class PropertiesSourcetypesResponse < PropertiesResponse
+  attr_reader :sourcetypes
+
+  def initialize(raw_response)
+    super(raw_response)
+    if result_code != "200"
+      @total = "0"
+      return
+    end
+
+    # If results returned, process the sourcetypes and metadata
+
+    srcs = self.parsed_response["refworks"]["RWResult"]["PropertiesResult"]["sourcetype"]
+
+    @sourcetypes = Array.new
+    srcs.each do |src|
+      @sourcetypes << Sourcetype.new(src)
+    end
+  end
+end