refworks 0.0.2

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

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

data/lib/refworks/properties/typelabels/properties_typelabels_request.rb

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

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

data/lib/refworks/properties/typelabels/typelabel.rb

@@ -0,0 +1,8 @@
+class Typelabel
+  attr_reader :name, :typeOrd
+
+  def initialize(rawtype)
+    @name = rawtype["rt"]["__content__"]
+    @typeOrd = rawtype["rt"]["typeOrd"]
+  end
+end

data/lib/refworks/reference.rb

@@ -0,0 +1,526 @@
+
+require "mash"
+
+#noinspection RubyTooManyInstanceVariablesInspection,RubyTooManyMethodsInspection
+class Reference
+  attr_reader :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,
+              :u8, :u9, :u10, :u11, :u12, :u13, :u14, :u15, :ul, :sl, :ll, :cr,
+              :wt, :a6, :wv, :wp, :ol, :pmid, :pmcid,
+              :fl, :cd, :md
+
+  # expecting a HTTParty-parsed RWResult reference hash to be passed in
+  def initialize(rawref)
+
+    # Basically, creating an empty ref.  For instance, if you want to
+    # hand-construct the reference one field at a time.
+    unless rawref["rt"]
+      return
+    end
+
+    # using Mash so I can use symbols as keys instead of strings, which is what
+    # is returned from httparty
+    ref = Mash.new(rawref)
+
+    # Here I populate attributes which correspond to RefWorks Tagged Format.
+    # See: http://www.refworks.com/rwathens/help/RefWorks_Tagged_Format.htm
+    # for more details.  The tag list is in a comment at the end of this file.
+
+    @rt = ref[:rt]
+
+    # the next two are my own extensions, not part of the RefWorks tagged format.
+    # They are a decomposition of the rt complex value which I think is useful.
+    @rt_num = ref[:rt][:typeOrd]
+    @rt_string = ref[:rt][:__content__]
+
+    @sr = ref[:sr]
+
+    @id = ref[:id][0]
+
+    # HTTParty will produce either a string or an array when it converts the XML response
+    # 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
+
+    @t1 = ref[:t1]
+
+    @jf = ref[:jf]
+    @jo = ref[:jo]
+    @yr = ref[:yr]
+    @fd = ref[:fd]
+    @vo = ref[:vo]
+    @is = ref[:is]
+    @sp = ref[:sp]
+    @op = ref[:op]
+
+    if ref[:k1]
+      @k1 = ref[:k1].class == Array ? ref[:k1] : ref[:k1].lines.to_a
+    end
+
+    @ab = ref[:ab]
+    @no = ref[:no]
+
+    if ref[:a2]
+      @a2 = ref[:a2].class == Array ? ref[:a2] : ref[:a2].lines.to_a
+    end
+
+    @t2 = ref[:t2]
+
+    @ed = ref[:ed]
+    @pb = ref[:pb]
+    @pp = ref[:pp]
+
+    if ref[:a3]
+      @a3 = ref[:a3].class == Array ? ref[:a3] : ref[:a3].lines.to_a
+    end
+
+    if ref[:a4]
+      @a4 = ref[:a4].class == Array ? ref[:a4] : ref[:a4].lines.to_a
+    end
+
+    if ref[:a5]
+      @a5 = ref[:a5].class == Array ? ref[:a5] : ref[:a5].lines.to_a
+    end
+
+    @t3 = ref[:t3]
+    @sn = ref[:sn]
+    @av = ref[:av]
+    @ad = ref[:ad]
+    @an = ref[:an]
+    @la = ref[:la]
+    @cl = ref[:cl]
+    @sf = ref[:sf]
+    @ot = ref[:ot]
+    @lk = ref[:lk]
+    @do = ref[:do]
+    @cn = ref[:cn]
+    @db = ref[:db]
+    @ds = ref[:ds]
+    @ip = ref[:ip]
+    @rd = ref[:rd]
+    @st = ref[:st]
+    @u1 = ref[:u1]
+    @u2 = ref[:u2]
+    @u3 = ref[:u3]
+    @u4 = ref[:u4]
+    @u5 = ref[:u5]
+    @u6 = ref[:u6]
+    @u7 = ref[:u7]
+    @u8 = ref[:u8]
+    @u9 = ref[:u9]
+    @u10 = ref[:u10]
+    @u11 = ref[:u11]
+    @u12 = ref[:u12]
+    @u13 = ref[:u13]
+    @u14 = ref[:u14]
+    @u15 = ref[:u15]
+    @ul = ref[:ul]
+    @sl = ref[:sl]
+    @ll = ref[:ll]
+    @cr = ref[:cr]
+    @wt = ref[:wt]
+
+    if ref[:a6]
+      @a6 = ref[:a6].class == Array ? ref[:a6] : ref[:a6].lines.to_a
+    end
+
+    @wv = ref[:wv]
+    @wp = ref[:wp]
+    @ol = ref[:ol]
+    @pmid = ref[:pmid]
+    @pmcid = ref[:pmcid]
+
+    # Not documented as part of the RefWorks tagged format, but the API returns these fields
+    @fl = ref[:fl]
+    @cd = ref[:cd]
+    @md = ref[:md]
+  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")
+  # which seemed particularly useful.
+
+  def reference_type
+    rt
+  end
+
+  # extension
+  def reference_type_num
+    rt_num
+  end
+
+  # extension
+  def reference_type_string
+    rt_string
+  end
+
+  def source_type
+    sr
+  end
+
+  def primary_authors
+    a1
+  end
+
+  # alias
+  def authors
+    a1
+  end
+
+  def primary_title
+    t1
+  end
+
+  # alias
+  def title
+    t1
+  end
+
+  def periodical_full
+    jf
+  end
+
+  def periodical_abbrev
+    jo
+  end
+
+  def publication_year
+    yr
+  end
+
+  def publication_data_free_form
+    fd
+  end
+
+  def volume
+    vo
+  end
+
+  def issue
+    is
+  end
+
+  def start_page
+    sp
+  end
+
+  def other_pages
+    op
+  end
+
+  def keyword
+    k1
+  end
+
+  def keywords
+    k1
+  end
+
+  def abstract
+    ab
+  end
+
+  def notes
+    no
+  end
+
+  def secondary_authors
+    a2
+  end
+
+  def secondary_title
+    t2
+  end
+
+  def edition
+    ed
+  end
+
+  def publisher
+    pb
+  end
+
+  def place_of_publication
+    pp
+  end
+
+  def tertiary_authors
+    a3
+  end
+
+  def quaternary_authors
+    a4
+  end
+
+  def quinary_authors
+    a5
+  end
+
+  def tertiary_title
+    t3
+  end
+
+  def issn_isbn
+    sn
+  end
+
+  def availability
+    av
+  end
+
+  def author_address
+    ad
+  end
+
+  def accession_number
+    an
+  end
+
+  def language
+    la
+  end
+
+  def classification
+    cl
+  end
+
+  def subfile_database
+    sf
+  end
+
+  def original_foreign_title
+    ot
+  end
+
+  def links
+    lk
+  end
+
+  def digital_object_identifier
+    # @ sign to avoid collision with Ruby keyword 'do'
+    @do
+  end
+
+  # alias
+  def doi
+    # @ sign to avoid collision with Ruby keyword 'do'
+    @do
+  end
+
+  def call_number
+    cn
+  end
+
+  def database
+    db
+  end
+
+  def data_source
+    ds
+  end
+
+  def identifying_phrase
+    ip
+  end
+
+  def retrieved_date
+    rd
+  end
+
+  def shortened_title
+    st
+  end
+
+  def user_1
+    u1
+  end
+
+  def user_2
+    u2
+  end
+
+  def user_3
+    u3
+  end
+
+  def user_4
+    u4
+  end
+
+  def user_5
+    u5
+  end
+
+  def user_6
+    u6
+  end
+
+  def user_7
+    u7
+  end
+
+  def user_8
+    u8
+  end
+
+  def user_9
+    u9
+  end
+
+  def user_10
+    u10
+  end
+
+  def user_11
+    u11
+  end
+
+  def user_12
+    u12
+  end
+
+  def user_13
+    u13
+  end
+
+  def user_14
+    u14
+  end
+
+  def user_15
+    u15
+  end
+
+  def url
+    ul
+  end
+
+  def sponsoring_library
+    sl
+  end
+
+  def sponsoring_library_location
+    ll
+  end
+
+  def cited_references
+    cr
+  end
+
+  def website_title
+    wt
+  end
+
+  def website_editors
+    a6
+  end
+
+  def website_version
+    wv
+  end
+
+  def date_of_electronic_publication
+    wp
+  end
+
+  def output_language
+    ol
+  end
+
+  # extension
+  def folder
+    fl
+  end
+
+  # extension
+  def created_date
+    cd
+  end
+
+  # extension
+  def modified_data
+    md
+  end
+
+end
+
+=begin
+Refworks Export Tagged Format, Tag legend
+
+RT=Reference Type
+SR=Source Type (field is either Print(0) or  Electronic(1) )
+ID=Reference Identifier
+A1=Primary Authors
+T1=Primary Title
+JF=Periodical Full
+JO=Periodical Abbrev
+YR=Publication Year
+FD=Publication Data, Free Form
+VO=Volume
+IS=Issue
+SP=Start Page
+OP=Other Pages
+K1=Keyword
+AB=Abstract
+NO=Notes
+A2=Secondary Authors
+T2=Secondary Title
+ED=Edition
+PB=Publisher
+PP=Place of Publication
+A3=Tertiary Authors
+A4=Quaternary Authors
+A5=Quinary Authors
+T3=Tertiary Title
+SN=ISSN/ISBN
+AV=Availability
+AD=Author Address
+AN=Accession Number
+LA=Language
+CL=Classification
+SF=Subfile/Database
+OT=Original Foreign Title
+LK=Links
+DO=Digital Object Identifier
+CN=Call Number
+DB=Database
+DS=Data Source
+IP=Identifying Phrase
+RD=Retrieved Date
+ST=Shortened Title
+U1=User 1
+U2=User 2
+U3=User 3
+U4=User 4
+U5=User 5
+U6=User 6
+U7=User 7
+U8=User 8
+U9=User 9
+U10=User 10
+U11=User 11
+U12=User 12
+U13=User 13
+U14=User 14
+U15=User 15
+UL=URL
+SL=Sponsoring Library
+LL=Sponsoring Library Location
+CR=Cited References
+WT=Website Title
+A6=Website editors
+WV=Website version
+WP=Date of Electronic Publication
+OL=Output Language (see codes for specific languages below)
+PMID=PMID
+PMCID=PMCID
+=end