refworks 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDY3YTk4NGZkNjk5Y2UwZmVlNmM1Y2NkMWJiYTg4MWQ2ODI5ODM3OQ==
+    MWIwYjRiNzYzNDMyMjhmMTM4NzVkNTUwNWQwZjJjNzNjODI0OGRjZA==
   data.tar.gz: !binary |-
-    OGFjOTc1ODY1ODhkOWUyZDY4OTE0YzIzZjBjMWRkMDhhN2FlNWNiZg==
+    ZDdmNWIzNjgzM2Y2MTY5ZWQ0MDg5NWYwYTM5MDk0YTY4ZDI3OGU4YQ==
 SHA512:
   metadata.gz: !binary |-
-    NzY5MDA5YjQxYjY2ODcwODQ0MTI2Y2VlNTIxZGNmMTc0NTU0NGNlZDljOWNk
-    NzhlZTM1N2M1YzczOTc3ZmJkMDUxZmM1NTZkZWFlZDgyODBjNTQwYzRkZTVk
-    YmQ4ZDFjMTNmNWQzZTkzYjVhYTg4ZDgyOTQwOThlMDM4MDk0YTI=
+    ZWNjMzZjZmNlMTc0MGYwODkwOGZhZjUzMTljOTg3Y2I5ZTFlZWRmNTJjNDIz
+    ZWE2ZDNmYjkxZWZiNDQwOTE4YWNjZThkNTY5MTcxYmM0MWM3YjMyMjNjNzVm
+    OTk5ZmIzY2QxMzAwYTZiMThmYzFjYWI4YWNkYmY5M2Y2NDIyMmI=
   data.tar.gz: !binary |-
-    YTY3ZmZhZTdlMzIxOWIxZWRhYzgwNGRhYmMyNmU5NWJiMjc1YjFkZTlhNTEy
-    NDIxMWQxYjBlZGRjNzIyN2JiZDFkNmJkODgyNjNmODZiMjY0Mjk5NGU2Zjdl
-    ZWE2YTBlM2Y4NjFkODcwYTMzOWViYzQ5ZTU4YTYyNDUxNTg5OTk=
+    NTNhYmQ2ZjhjYTA3OWI1YTc3MjEzYjYyZGE3NDVmZjA5MTUzY2FhZTFhOGU0
+    MjY2MzE5MTA2YmEzNTJhYjEwODJkNTNmZTg2OTVmMWU3NmQ0ZjM5NGMxYzNl
+    NzNmNTU5ZDVjMGFjMzk5M2YyMTcyMmE3ZjU4M2JiZjMyMDY0N2U=

data/README.md

@@ -29,7 +29,7 @@ Authentication
   - newrefsharesess not implemented.
 
 Authors,Descriptors,Periodicals,Folders
-  - all and search are implemented.
+  - all, search are implemented.
   - addref (GET), addref (POST), clear, create, delete, edit, removeref (GET), removeref (POST) are not implemented.
   - note that in the code, these are broken out into four different classes.
 
@@ -60,12 +60,12 @@ PubMed
   - Nothing implemented.
 
 Reference
-  - get implemented.
-  - add, addcomment, delete (GET), delete (POST), deletecomment, edit, editcomment, globaledit, import,
+  - get, add, addcomment, delete (GET), edit implemented.
+  - delete (POST), deletecomment, editcomment, globaledit, import,
     importendnote, importpreview, openurl not implemented.
 
 Retrieve
-  - advancesearch, all, author, byid, count, descriptor, dup, folder, modsince, nofolder, periodical, quick,
+  - advancesearch, all, author, byid (GET), count, descriptor, dup, folder, modsince, nofolder, periodical, quick,
     saved, specialfolder implemented.
   - byid (POST), openurl not implemented.
 

data/lib/refworks/reference.rb

@@ -3,7 +3,7 @@ require "mash"
 
 #noinspection RubyTooManyInstanceVariablesInspection,RubyTooManyMethodsInspection
 class Reference
-  attr_reader :rt, :rt_num, :rt_string, :sr, :id, :a1, :t1, :jf, :jo, :yr, :fd,
+  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,
               :cn, :db, :ds, :ip, :rd, :st, :u1, :u2, :u3, :u4, :u5, :u6, :u7,
@@ -144,6 +144,86 @@ class Reference
     @md = ref[:md]
   end
 
+  # method to produce RefWorks XML format
+  def to_refworks_xml
+    @xml = "<reference>"
+
+    @xml << "<rt>#{rt_string}</rt>" if @rt
+    @xml << "<sr>#{sr}</sr>" if @sr
+    @xml << "<id>#{id}</id>" if @id
+    a1.each {|a| @xml << "<a1>#{a}</a1>"} if @a1
+    @xml << "<t1>#{t1}</t1>" if @t1
+    @xml << "<jf>#{jf}</jf>" if @jf
+    @xml << "<jo>#{jo}</jo>" if @jo
+    @xml << "<yr>#{yr}</yr>" if @yr
+    @xml << "<fd>#{fd}</fd>" if @fd
+    @xml << "<vo>#{vo}</vo>" if @vo
+    @xml << "<is>#{is}</is>" if @is
+    @xml << "<sp>#{sp}</sp>" if @sp
+    @xml << "<op>#{op}</op>" if @op
+    k1.each {|k| @xml << "<k1>#{k1}</k1>"} if @k1
+    @xml << "<ab>#{ab}</ab>" if @ab
+    @xml << "<no>#{no}</no>" if @no
+    a2.each {|a| @xml << "<a2>#{a}</a2>"} if @a2
+    @xml << "<t2>#{t2}</t2>" if @t2
+    @xml << "<ed>#{ed}</ed>" if @ed
+    @xml << "<pb>#{pb}</pb>" if @pb
+    @xml << "<pp>#{pp}</pp>" if @pp
+    a3.each {|a| @xml << "<a3>#{a}</a3>"} if @a3
+    a4.each {|a| @xml << "<a4>#{a}</a4>"} if @a4
+    a5.each {|a| @xml << "<a5>#{a}</a5>"} if @a5
+    @xml << "<t3>#{t3}</t3>" if @t3
+    @xml << "<sn>#{sn}</sn>" if @sn
+    @xml << "<av>#{av}</av>" if @av
+    @xml << "<ad>#{ad}</ad>" if @ad
+    @xml << "<an>#{an}</an>" if @an
+    @xml << "<la>#{la}</la>" if @la
+    @xml << "<cl>#{cl}</cl>" if @cl
+    @xml << "<sf>#{sf}</sf>" if @sf
+    @xml << "<ot>#{ot}</ot>" if @ot
+    @xml << "<lk>#{lk}</lk>" if @lk
+    @xml << "<do>#{@do}</do>" if @do
+    @xml << "<cn>#{cn}</cn>" if @cn
+    @xml << "<db>#{db}</db>" if @db
+    @xml << "<ds>#{ds}</ds>" if @ds
+    @xml << "<ip>#{ip}</ip>" if @ip
+    @xml << "<rd>#{rd}</rd>" if @rd
+    @xml << "<st>#{st}</st>" if @st
+    @xml << "<u1>#{u1}</u1>" if @u1
+    @xml << "<u2>#{u2}</u2>" if @u2
+    @xml << "<u3>#{u3}</u3>" if @u3
+    @xml << "<u4>#{u4}</u4>" if @u4
+    @xml << "<u5>#{u5}</u5>" if @u5
+    @xml << "<u6>#{u6}</u6>" if @u6
+    @xml << "<u7>#{u7}</u7>" if @u7
+    @xml << "<u8>#{u8}</u8>" if @u8
+    @xml << "<u9>#{u9}</u9>" if @u9
+    @xml << "<u10>#{u10}</u10>" if @u10
+    @xml << "<u11>#{u11}</u11>" if @u11
+    @xml << "<u12>#{u12}</u12>" if @u12
+    @xml << "<u13>#{u13}</u13>" if @u13
+    @xml << "<u14>#{u14}</u14>" if @u14
+    @xml << "<u15>#{u15}</u15>" if @u15
+    @xml << "<ul>#{ul}</ul>" if @ul
+    @xml << "<sl>#{sl}</sl>" if @sl
+    @xml << "<ll>#{ll}</ll>" if @ll
+    @xml << "<cr>#{cr}</cr>" if @cr
+    @xml << "<wt>#{wt}</wt>" if @wt
+    a6.each {|a| @xml << "<a6>#{a}</a6>"} if @a6
+    @xml << "<wv>#{wv}</wv>" if @wv
+    @xml << "<wp>#{wp}</wp>" if @wp
+    @xml << "<ol>#{ol}</ol>" if @ol
+    @xml << "<pmid>#{pmid}</pmid>" if @pmid
+    @xml << "<pmcid>#{pmcid}</pmcid>" if @pmcid
+    # suppressing these - they are not part of the spec and RW trips if you try to add a ref with these
+    #@xml << "<fl>#{fl}</fl>" if @fl
+    #@xml << "<cd>#{cd}</cd>" if @cd
+    #@xml << "<md>#{md}</md>" if @md
+
+    @xml << "</reference>"
+    @xml
+  end
+
   # setup human-readable aliases as accessors
   # I've been consistent with the RefWorks tagged format legend (see end of this file)
   # plus I added some additional ones (like "authors" as a synonym for "primary_authors")
@@ -153,6 +233,10 @@ class Reference
     rt
   end
 
+  def reference_type=(val)
+    rt = val
+  end
+
   # extension
   def reference_type_num
     rt_num
@@ -167,275 +251,547 @@ class Reference
     sr
   end
 
+  def source_type=(val)
+    sr = val
+  end
+
   def primary_authors
     a1
   end
 
+  def primary_authors=(val)
+    a1 = val
+  end
+
   # alias
   def authors
     a1
   end
 
+  # alias
+  def authors=(val)
+    a1 = val
+  end
+
   def primary_title
     t1
   end
 
+  def primary_title=(val)
+    t1 = val
+  end
+
   # alias
   def title
     t1
   end
 
+  def title=(val)
+    t1=val
+  end
+
   def periodical_full
     jf
   end
 
+  def periodical_full=(val)
+    jf=val
+  end
+
   def periodical_abbrev
     jo
   end
 
+  def periodical_abbrev=(val)
+    jo=val
+  end
+
   def publication_year
     yr
   end
 
+  def publication_year=(val)
+    yr=val
+  end
+
   def publication_data_free_form
     fd
   end
 
+  def publication_data_free_form=(val)
+    fd=val
+  end
+
   def volume
     vo
   end
 
+  def volume=(val)
+    vo=val
+  end
+
   def issue
     is
   end
 
+  def issue=(val)
+    is=val
+  end
+
   def start_page
     sp
   end
 
+  def start_page=(val)
+    sp=val
+  end
+
   def other_pages
     op
   end
 
+  def other_pages=(val)
+    op=val
+  end
+
   def keyword
     k1
   end
 
+  def keyword=(val)
+    k1=val
+  end
+
   def keywords
     k1
   end
 
+  def keywords=(val)
+    k1=val
+  end
+
   def abstract
     ab
   end
 
+  def abstract=(val)
+    ab=val
+  end
+
   def notes
     no
   end
 
+  def notes=(val)
+    no=val
+  end
+
   def secondary_authors
     a2
   end
 
+  def secondary_authors=(val)
+    a2=val
+  end
+
   def secondary_title
     t2
   end
 
+  def secondary_title=(val)
+    t2=val
+  end
+
   def edition
     ed
   end
 
+  def edition=(val)
+    ed=val
+  end
+
   def publisher
     pb
   end
 
+  def publisher=(val)
+    pb=val
+  end
+
   def place_of_publication
     pp
   end
 
+  def place_of_publication=(val)
+    pp=val
+  end
+
   def tertiary_authors
     a3
   end
 
+  def tertiary_authors=(val)
+    a3=val
+  end
+
   def quaternary_authors
     a4
   end
 
+  def quaternary_authors=(val)
+    a4=val
+  end
+
   def quinary_authors
     a5
   end
 
+  def quinary_authors=(val)
+    a5=val
+  end
+
   def tertiary_title
     t3
   end
 
+  def tertiary_title=(val)
+    t3=val
+  end
+
   def issn_isbn
     sn
   end
 
+  def issn_isbn=(val)
+    sn=val
+  end
+
   def availability
     av
   end
 
+  def availability=(val)
+    av=val
+  end
+
   def author_address
     ad
   end
 
+  def author_address=(val)
+    ad=val
+  end
+
   def accession_number
     an
   end
 
+  def accession_number=(val)
+    an=val
+  end
+
   def language
     la
   end
 
+  def language=(val)
+    la=val
+  end
+
   def classification
     cl
   end
 
+  def classification=(val)
+    cl=val
+  end
+
   def subfile_database
     sf
   end
 
+  def subfile_database=(val)
+    sf=val
+  end
+
   def original_foreign_title
     ot
   end
 
+  def original_foreign_title=(val)
+    ot=val
+  end
+
   def links
     lk
   end
 
+  def links=(val)
+    lk=val
+  end
+
   def digital_object_identifier
     # @ sign to avoid collision with Ruby keyword 'do'
     @do
   end
 
+  def digital_object_identifier=(val)
+    # @ sign to avoid collision with Ruby keyword 'do'
+    @do=val
+  end
+
   # alias
   def doi
     # @ sign to avoid collision with Ruby keyword 'do'
     @do
   end
 
+  # alias
+  def doi=(val)
+    # @ sign to avoid collision with Ruby keyword 'do'
+    @do=val
+  end
+
   def call_number
     cn
   end
 
+  def call_number=(val)
+    cn=val
+  end
+
   def database
     db
   end
 
+  def database=(val)
+    db=val
+  end
+
   def data_source
     ds
   end
 
+  def data_source=(val)
+    ds=val
+  end
+
   def identifying_phrase
     ip
   end
 
+  def identifying_phrase=(val)
+    ip=val
+  end
+
   def retrieved_date
     rd
   end
 
+  def retrieved_date=(val)
+    rd=val
+  end
+
   def shortened_title
     st
   end
 
+  def shortened_title=(val)
+    st=val
+  end
+
   def user_1
     u1
   end
 
+  def user_1=(val)
+    u1=val
+  end
+
   def user_2
     u2
   end
 
+  def user_2=(val)
+    u2=val
+  end
+
   def user_3
     u3
   end
 
+  def user_3=(val)
+    u3=val
+  end
+
   def user_4
     u4
   end
 
+  def user_4=(val)
+    u4=val
+  end
+
   def user_5
     u5
   end
 
+  def user_5=(val)
+    u5=val
+  end
+
   def user_6
     u6
   end
 
+  def user_6=(val)
+    u6=val
+  end
+
   def user_7
     u7
   end
 
+  def user_7=(val)
+    u7=val
+  end
+
   def user_8
     u8
   end
 
+  def user_8=(val)
+    u8=val
+  end
+
   def user_9
     u9
   end
 
+  def user_9=(val)
+    u9=val
+  end
+
   def user_10
     u10
   end
 
+  def user_10=(val)
+    u10=val
+  end
+
   def user_11
     u11
   end
 
+  def user_11=(val)
+    u11=val
+  end
+
   def user_12
     u12
   end
 
+  def user_12=(val)
+    u12=val
+  end
+
   def user_13
     u13
   end
 
+  def user_13=(val)
+    u13=val
+  end
+
   def user_14
     u14
   end
 
+  def user_14=(val)
+    u14=val
+  end
+
   def user_15
     u15
   end
 
+  def user_15=(val)
+    u15=val
+  end
+
   def url
     ul
   end
 
+  def url=(val)
+    ul=val
+  end
+
   def sponsoring_library
     sl
   end
 
+  def sponsoring_library=(val)
+    sl=val
+  end
+
   def sponsoring_library_location
     ll
   end
 
+  def sponsoring_library_location=(val)
+    ll=val
+  end
+
   def cited_references
     cr
   end
 
+  def cited_references=(val)
+    cr=val
+  end
+
   def website_title
     wt
   end
 
+  def website_title=(val)
+    wt=val
+  end
+
   def website_editors
     a6
   end
 
+  def website_editors=(val)
+    a6=val
+  end
+
   def website_version
     wv
   end
 
+  def website_version=(val)
+    wv=val
+  end
+
   def date_of_electronic_publication
     wp
   end
 
+  def date_of_electronic_publication=(val)
+    wp=val
+  end
+
   def output_language
     ol
   end
 
+  def output_language=(val)
+    ol=val
+  end
+
   # extension
   def folder
     fl

data/lib/refworks/reference/add/reference_add_request.rb

@@ -0,0 +1,63 @@
+class ReferenceAddRequest < ReferenceRequest
+  def self.call_method
+    'add'
+  end
+
+  def self.http_request_verb
+    'POST'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Reference parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the add call
+    method_params = { :method => call_method,
+                      :folder => params[:folder], # this is optional
+                      :returnrefs => params[:returnrefs] || "0", # this is technically optional but I'm explicitly passing default of 0
+    }
+
+    query_string_params = class_params.merge(method_params)
+    # add has a POST payload
+
+    # construct XML payload
+    xml_payload = '<RWRequest class="reference" method="add"><RWRefData><refworks xmlns:refworks="www.refworks.com/xml/">'
+    params[:references].each do |ref|
+      xml_payload << ref.to_refworks_xml
+    end
+#    xml_payload << '<reference>
+#<rt>Book, Whole</rt>
+#<sr>Print(0)</sr>
+#<id>330</id>
+#<t1>
+#4898816 <B>Mediat</B>&lt;&gt;ors for bioelectrochemical <SUP>cells</SUP> h20 to test for microbiologlklklkicakkkl activity. <U>Anthony</U> P F Turner, Ann Swain, Graha <I>Ramsay</I>, Marc Cardosi, Bernard H Schneider, www.refworks.com?a=23&amp;b=34 Cranfield, United Kingdom assigned to Paul de la Pena Limitedl
+#</t1>
+#<jf>Biotechnology Advances</jf>
+#<jo>Biotechnol.Adv.</jo>
+#<yr>1990</yr>
+#<vo>8</vo>
+#<is>3</is>
+#<sp>613</sp>
+#<no>JID: 8403708; <I>ppublish</I></no>
+#<a1>Aggarwal,A.</a1>
+#<a1>Schneider,D. J.</a1>
+#<a1>Sobel,B. E.</a1>
+#<a1>Dauerman,H. L.</a1>
+#<t3>this is a title</t3>
+#<sn>0734-9750</sn>
+#<an>14549739; 0</an>
+#<la>ENG</la>
+#<sf>JOURNAL ARTICLE</sf>
+#<do>073497509090779B [pii]</do>
+#<st>this is a <U>shortened</U> title</st>
+#<ol>Unknown(0)</ol>
+#</reference>'
+    xml_payload << '</refworks></RWRefData></RWRequest>'
+
+    message_body = xml_payload
+
+    # return the request info
+    {:params => query_string_params, :body => message_body, :headers => {'Content-type' => 'text/xml'}}
+  end
+end

data/lib/refworks/reference/add/reference_add_response.rb

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

data/lib/refworks/reference/addcomment/reference_addcomment_request.rb

@@ -0,0 +1,41 @@
+class ReferenceAddcommentRequest < ReferenceRequest
+  def self.call_method
+    'addcomment'
+  end
+
+  def self.http_request_verb
+    'POST'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Reference parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the addcomment call
+    method_params = { :method => call_method,
+                      :id => params[:id],
+    }
+
+    query_string_params = class_params.merge(method_params)
+    # addcomment has a POST payload
+
+    # construct XML payload
+    xml_payload = '<RWRequest class="reference" method="addcomment">'
+    params[:comments].each do |cmnt|
+      title = cmnt[:title]
+      name = cmnt[:name]
+      inetinfo = cmnt[:inetinfo]
+      comment = cmnt[:comment]
+      parentid = cmnt[:parentid] || "-1"
+      xml_payload << "<comment id=\"\" title=\"#{title}\" name=\"#{name}\" inetinfo=\"#{inetinfo}\" created=\"\" comment=\"#{comment}\" parentid=\"#{parentid}\"/>"
+    end
+
+    xml_payload << '</RWRequest>'
+
+    message_body = xml_payload
+
+    # return the request info
+    {:params => query_string_params, :body => message_body, :headers => {'Content-type' => 'text/xml'}}
+  end
+end

data/lib/refworks/reference/addcomment/reference_addcomment_response.rb

@@ -0,0 +1,2 @@
+class ReferenceAddcommentResponse < ReferenceResponse
+end

data/lib/refworks/reference/delete/reference_delete_request.rb

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

data/lib/refworks/reference/delete/reference_delete_response.rb

@@ -0,0 +1,2 @@
+class ReferenceDeleteResponse < ReferenceResponse
+end

data/lib/refworks/reference/edit/reference_edit_request.rb

@@ -0,0 +1,35 @@
+class ReferenceEditRequest < ReferenceRequest
+  def self.call_method
+    'edit'
+  end
+
+  def self.http_request_verb
+    'POST'
+  end
+
+  def self.generate_request_info(params)
+
+    # get common Reference parameters
+    class_params = generate_class_params(params)
+
+    # query parameters for the edit call
+    method_params = { :method => call_method,
+    }
+
+    query_string_params = class_params.merge(method_params)
+    # add has a POST payload
+
+    # construct XML payload
+    xml_payload = '<RWRequest class="reference" method="edit"><RWRefData><refworks xmlns:refworks="www.refworks.com/xml/">'
+    params[:references].each do |ref|
+      xml_payload << ref.to_refworks_xml
+    end
+
+    xml_payload << '</refworks></RWRefData></RWRequest>'
+
+    message_body = xml_payload
+
+    # return the request info
+    {:params => query_string_params, :body => message_body, :headers => {'Content-type' => 'text/xml'}}
+  end
+end

data/lib/refworks/reference/edit/reference_edit_response.rb

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

data/lib/refworks/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: refworks
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Fran Fabrizio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-03 00:00:00.000000000 Z
+date: 2014-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -152,6 +152,14 @@ files:
 - 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
+- lib/refworks/reference/addcomment/reference_addcomment_response.rb
+- lib/refworks/reference/delete/reference_delete_request.rb
+- lib/refworks/reference/delete/reference_delete_response.rb
+- lib/refworks/reference/edit/reference_edit_request.rb
+- lib/refworks/reference/edit/reference_edit_response.rb
 - lib/refworks/reference/get/reference_get_request.rb
 - lib/refworks/reference/get/reference_get_response.rb
 - lib/refworks/reference/reference_request.rb