refworks 0.0.12 → 0.0.13

data/README.md

@@ -118,3 +118,4 @@ Useful Links
 RefWorks API Reference: http://rwt.refworks.com/rwapireference/
 RefWorks Tagged Format Reference: http://www.refworks.com/rwathens/help/RefWorks_Tagged_Format.htm
 
+

data/lib/refworks/reference.rb

@@ -3,13 +3,15 @@ require "mash"
 
 #noinspection RubyTooManyInstanceVariablesInspection,RubyTooManyMethodsInspection
 class Reference
-  attr_accessor :rt, :rt_num, :rt_string, :sr, :id, :a1, :t1, :jf, :jo, :yr, :fd,
-              :vo, :is, :sp, :op, :k1, :ab, :no, :a2, :t2, :ed, :pb, :pp, :a3,
-              :a4, :a5, :t3, :sn, :av, :ad, :an, :la, :cl, :sf, :ot, :lk, :do,
+  attr_accessor :rt, :rt_num, :rt_string, :sr, :id, :t1, :jf, :jo, :yr, :fd,
+              :vo, :is, :sp, :op, :ab, :no, :t2, :ed, :pb, :pp,
+              :t3, :sn, :av, :ad, :an, :la, :cl, :sf, :ot, :lk, :do,
               :cn, :db, :ds, :ip, :rd, :st, :u1, :u2, :u3, :u4, :u5, :u6, :u7,
               :u8, :u9, :u10, :u11, :u12, :u13, :u14, :u15, :ul, :sl, :ll, :cr,
-              :wt, :a6, :wv, :wp, :ol, :pmid, :pmcid,
+              :wt, :wv, :wp, :ol, :pmid, :pmcid,
               :fl, :cd, :md
+  # the following need special setter behavior (custom setters below) so they only get standard readers
+  attr_reader :k1, :a1, :a2, :a3, :a4, :a5, :a6
 
   # expecting a HTTParty-parsed RWResult reference hash to be passed in
   def initialize(rawref)
@@ -43,12 +45,10 @@ class Reference
     # to a Ruby data structure.  Which one it produces depends upon how
     # many authors there are.  All values are converted to Arrays, even one item
     # values, for consistency.  I do this for any field which can have more than one value.
-    # If not an array, and not a value, set nil
-    @a1 = if ref[:a1].class == Array then
-            ref[:a1]
-          else
-            ref[:a1] ? ref[:a1].lines.to_a : nil
-          end
+    # To accomplish this, I use the "friendly name" setters (e.g. self.authors) so that I don't
+    # have to override the auto-generated setters that are created via attr_accessor.  This affects
+    # the a1-a6 fields plus the k1 field.
+    @a1 = self.a1=(ref[:a1])
 
     @t1 = ref[:t1]
 
@@ -62,14 +62,14 @@ class Reference
     @op = ref[:op]
 
     if ref[:k1]
-      @k1 = ref[:k1].class == Array ? ref[:k1] : ref[:k1].lines.to_a
+      self.k1=(ref[:k1])
     end
 
     @ab = ref[:ab]
     @no = ref[:no]
 
     if ref[:a2]
-      @a2 = ref[:a2].class == Array ? ref[:a2] : ref[:a2].lines.to_a
+      self.a2=(ref[:a2])
     end
 
     @t2 = ref[:t2]
@@ -79,15 +79,15 @@ class Reference
     @pp = ref[:pp]
 
     if ref[:a3]
-      @a3 = ref[:a3].class == Array ? ref[:a3] : ref[:a3].lines.to_a
+      self.a3=(ref[:a3])
     end
 
     if ref[:a4]
-      @a4 = ref[:a4].class == Array ? ref[:a4] : ref[:a4].lines.to_a
+      self.a4=(ref[:a4])
     end
 
     if ref[:a5]
-      @a5 = ref[:a5].class == Array ? ref[:a5] : ref[:a5].lines.to_a
+      self.a5=(ref[:a5])
     end
 
     @t3 = ref[:t3]
@@ -129,7 +129,7 @@ class Reference
     @wt = ref[:wt]
 
     if ref[:a6]
-      @a6 = ref[:a6].class == Array ? ref[:a6] : ref[:a6].lines.to_a
+      self.a6=(ref[:a6])
     end
 
     @wv = ref[:wv]
@@ -144,6 +144,38 @@ class Reference
     @md = ref[:md]
   end
 
+  # setters for attributes which need special setter behavior to handle the fact that the input
+  # may be either a string or an Array and we want to standardize on Arrays for our internal storage
+  # this probably could be cleaned up with some sort of metaprogramming hack, but it's only seven of 'em
+
+  def k1=(val)
+    @k1 = val.class == Array ? val : val.lines.to_a
+  end
+
+  def a1=(val)
+    @a1 = val.class == Array ? val : val.lines.to_a
+  end
+
+  def a2=(val)
+    @a2 = val.class == Array ? val : val.lines.to_a
+  end
+
+  def a3=(val)
+    @a3 = val.class == Array ? val : val.lines.to_a
+  end
+
+  def a4=(val)
+    @a4 = val.class == Array ? val : val.lines.to_a
+  end
+
+  def a5=(val)
+    @a5 = val.class == Array ? val : val.lines.to_a
+  end
+
+  def a6=(val)
+    @a6 = val.class == Array ? val : val.lines.to_a
+  end
+
   # method to produce RefWorks XML format
   def to_refworks_xml
     @xml = "<reference>"
@@ -260,7 +292,7 @@ class Reference
   end
 
   def primary_authors=(val)
-    self.a1 = val
+    self.a1 = val.class == Array ? val : val.lines.to_a
   end
 
   # alias
@@ -270,7 +302,7 @@ class Reference
 
   # alias
   def authors=(val)
-    self.a1 = val
+    self.a1 = val.class == Array ? val : val.lines.to_a
   end
 
   def primary_title
@@ -359,7 +391,7 @@ class Reference
   end
 
   def keyword=(val)
-    self.k1=val
+    self.k1 = val
   end
 
   def keywords
@@ -367,7 +399,7 @@ class Reference
   end
 
   def keywords=(val)
-    self.k1=val
+    self.k1 = val
   end
 
   def abstract
@@ -391,7 +423,7 @@ class Reference
   end
 
   def secondary_authors=(val)
-    self.a2=val
+    self.a2= val.class == Array ? val : val.lines.to_a
   end
 
   def secondary_title
@@ -431,7 +463,7 @@ class Reference
   end
 
   def tertiary_authors=(val)
-    self.a3=val
+    self.a3= val.class == Array ? val : val.lines.to_a
   end
 
   def quaternary_authors
@@ -439,7 +471,7 @@ class Reference
   end
 
   def quaternary_authors=(val)
-    self.a4=val
+    self.a4= val.class == Array ? val : val.lines.to_a
   end
 
   def quinary_authors
@@ -447,7 +479,7 @@ class Reference
   end
 
   def quinary_authors=(val)
-    self.a5=val
+    self.a5= val.class == Array ? val : val.lines.to_a
   end
 
   def tertiary_title
@@ -765,7 +797,7 @@ class Reference
   end
 
   def website_editors=(val)
-    self.a6=val
+    self.a6= val.class == Array ? val : val.lines.to_a
   end
 
   def website_version

data/lib/refworks/response.rb

@@ -5,11 +5,13 @@ class Response
   def initialize(raw_response)
     # The RefWorks API emits invalid XML.  Specifically, when the session is invalid, the ResultMsg field
     # which comes back contains some illegal raw characters.  This is the only set of transformations I
-    # could find which completely eliminate the junk characters, but it may be breaking other things.
+    # could find which completely eliminate the junk characters.
 
     # Trying to work around the malformed response bug
     p raw_response.body
+    # Replace non UTF-8 chars with the empty string
     raw_response.body.encode!('UTF-8', 'binary', :invalid => :replace, :undef => :replace, :replace => '')
+    # Remove characters which are not allowed to appear in XML messages
     raw_response.body.gsub!(/[\u0001-\u0019]/,'')
     p raw_response.body
 

data/lib/refworks/version.rb

@@ -1,3 +1,3 @@
 class Refworks
-  VERSION = '0.0.12'
+  VERSION = '0.0.13'
 end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: refworks
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
+  prerelease: 
 platform: ruby
 authors:
 - Fran Fabrizio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-21 00:00:00.000000000 Z
+date: 2014-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: require_all
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mash
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -60,8 +67,6 @@ 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
@@ -151,7 +156,6 @@ files:
 - 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/add/reference_add_request.rb
 - lib/refworks/reference/add/reference_add_response.rb
 - lib/refworks/reference/addcomment/reference_addcomment_request.rb
@@ -164,6 +168,7 @@ files:
 - lib/refworks/reference/get/reference_get_response.rb
 - lib/refworks/reference/reference_request.rb
 - lib/refworks/reference/reference_response.rb
+- lib/refworks/reference.rb
 - lib/refworks/request.rb
 - lib/refworks/response.rb
 - lib/refworks/retrieve/advancesearch/retrieve_advancesearch_request.rb
@@ -206,27 +211,31 @@ files:
 - lib/refworks/savedsearch/savedsearch_request.rb
 - lib/refworks/savedsearch/savedsearch_response.rb
 - lib/refworks/version.rb
+- lib/refworks.rb
+- README.md
 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
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: refworks
-rubygems_version: 2.2.0
+rubygems_version: 1.8.24
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: A Ruby interface to the RefWorks API.
 test_files: []
+has_rdoc: 

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YTRjYjQwNjE2MjBiNmUyY2FmZWFhYzg5OGFkMjU5ODI0OTgyNzI5Zg==
-  data.tar.gz: !binary |-
-    MzZiMmIzY2ZjMzllOTJkMjdkODFiM2UxOWU3YjFhZDYyNjg1NTgwNQ==
-SHA512:
-  metadata.gz: !binary |-
-    OGVhZjY0NzRmY2FhYTllNjhjOWI3MDUxODJmMzEwMjlkMWJlMmIyMWViNzZm
-    YzA2NTNiOGM0Mzc5YTc4MDhiMDQ4NDRmZGEyNjYzNDRkMmI5NDZhZTZhYTBh
-    YzQxZjdjM2QyMWZjMmEzY2M1OTk4MzNlNjVkODliNzMwNzllZWQ=
-  data.tar.gz: !binary |-
-    NzY4MmIxYzE0NjZiNWE5OWIzODc5OTgxNTg1ZTQ5NmRhYjU2OTUxOWQwZDIy
-    NjI0OTRhODgwMjUyNjBlOWNiYTFkNGUxOTNhZDQzMjNkMDBmNmQyOTBmZTM0
-    N2U4Yjk0NTE0NGMwMzhhZWI2YWFiZTNiOGFhZWM1ZWJjMDAxNzE=