openurl 0.2.0 → 0.2.1

data/README.md

@@ -0,0 +1,71 @@
+# openurl
+
+## DESCRIPTION
+
+openurl is a Ruby library creating, parsing and using NISO Z39.88 OpenURLs over 
+HTTP. <http://openurl.info/registry>
+
+While openurl can send requests to OpenURL 1.0 resolvers, there is no 'standard'
+response format, so parsing the returned value is up to you.
+
+## USAGE
+  
+    require 'openurl'    
+  
+    # Create your context object
+    context_object = OpenURL::ContextObject.new
+  
+    # Add metadata to the Context Object Entities
+    context_object.referent.set_format('journal')
+    context_object.referent.add_identifier('info:doi/10.1016/j.ipm.2005.03.024')
+    context_object.referent.set_metadata('issn', '0306-4573')
+    context_object.referent.set_metadata('aulast', 'Bollen')
+    context_object.referrer.add_identifier('info:sid/google')
+    
+    puts context_object.kev  
+  
+    puts context_object.xml  
+    
+    # Send the context object to an OpenURL link resolver
+    transport = OpenURL::Transport.new('http://demo.exlibrisgroup.com:9003/lr_3', context_object)
+    transport.get
+    puts tranport.response
+    
+    # Create a new ContextObject from an existing kev or XML serialization:
+    #
+    # ContextObject.new_from_kev(   kev_context_object )
+    # ContextObject.new_from_xml(   xml_context_object ) # Can be String or REXML::Document
+
+## Ruby 1.9 and encodings
+
+Gem does run and all tests pass under ruby 1.9.  There is very limited
+support for handling character encodings in the proper 1.9 way. 
+
+CTX or XML context objects will be assumed utf-8 even if the ruby string
+they are held in has an ascii-8bit encoding. They will forced into a utf-8 encoding. 
+This seems to be a side effect of the REXML and CGI libraries we use to parse,
+but there are runnable tests that assert it is true. (see test/encoding_test.rb)
+
+Incoming context objects with a non-utf8 ctx_enc value will *not* be handled
+properly, they'll still be forced to utf8. 
+
+Programmatically created context objects, you must ensure all strings are
+represented as utf8 encoded yourself.  
+
+More sophisticated encoding handling can theoretically be added, but it's
+somewhat non-trivial, and it's not clear anyone needs it. 
+
+## INSTALLATION
+
+You should be able to install the gem:
+
+    gem install openurl
+
+The source lives in git on github:
+
+    http://github.com/openurl/openurl
+
+## TESTS
+
+There are some automated tests. Run with `rake test`. They live in `./test`
+and use Test::Unit.

data/lib/openurl/context_object.rb

@@ -37,7 +37,7 @@ module OpenURL
 
     attr_reader :admin, :referent, :referringEntity, :requestor, :referrer, 
       :serviceType, :resolver
-    attr_accessor :foreign_keys
+    attr_accessor :foreign_keys, :openurl_ver
     
     @@defined_entities = {"rft"=>"referent", "rfr"=>"referrer", "rfe"=>"referring-entity", "req"=>"requestor", "svc"=>"service-type", "res"=>"resolver"}
     
@@ -51,7 +51,17 @@ module OpenURL
       @serviceType = []
       @resolver = []
       @foreign_keys = {}
-      @admin = {"ctx_ver"=>{"label"=>"version", "value"=>"Z39.88-2004"}, "ctx_tim"=>{"label"=>"timestamp", "value"=>DateTime.now().to_s}, "ctx_id"=>{"label"=>"identifier", "value"=>""}, "ctx_enc"=>{"label"=>"encoding", "value"=>"info:ofi/enc:UTF-8"}}    
+      @openurl_ver = "Z39.88-2004"
+      @admin = {"ctx_ver"=>{"label"=>"version", "value"=>@openurl_ver}, "ctx_tim"=>{"label"=>"timestamp", "value"=>DateTime.now().to_s}, "ctx_id"=>{"label"=>"identifier", "value"=>""}, "ctx_enc"=>{"label"=>"encoding", "value"=>"info:ofi/enc:UTF-8"}}    
+    end
+    
+    # Any legal OpenURL 1.0 sends url_ver=Z39.88-2004, and usually 
+    # ctx_ver=Z39.88-2004 too. However, sometimes we need to send
+    # an illegal OpenURL with a different openurl ver string, to deal
+    # with weird agents, for instance to trick SFX into doing the right thing.     
+    def openurl_ver=(ver)
+      @openurl_ver = ver
+      @admin["ctx_ver"]["value"] = ver
     end
 
     def deep_copy
@@ -99,7 +109,7 @@ module OpenURL
     # true argument if you do not want the ctx_tim key included.
     
     def kev(no_date=false)
-      kevs = ["url_ver=Z39.88-2004", "url_ctx_fmt=#{CGI.escape("info:ofi/fmt:kev:mtx:ctx")}"]
+      kevs = ["url_ver=#{self.openurl_ver}", "url_ctx_fmt=#{CGI.escape("info:ofi/fmt:kev:mtx:ctx")}"]
       
       # Loop through the administrative metadata      
       @admin.each_key do |k|
@@ -127,7 +137,7 @@ module OpenURL
     # So this function is really deprecated, but here because we have so much 
     # code dependent on it.
     def to_hash            
-      co_hash = {"url_ver"=>"Z39.88-2004", "url_ctx_fmt"=>"info:ofi/fmt:kev:mtx:ctx"}           
+      co_hash = {"url_ver"=>self.openurl_ver, "url_ctx_fmt"=>"info:ofi/fmt:kev:mtx:ctx"}           
       
       @admin.each_key do |k|
         co_hash[k]=@admin[k]["value"] if @admin[k]["value"]
@@ -367,7 +377,9 @@ module OpenURL
                 @referent.add_identifier(val)
               end              
             elsif key == 'sid'
-              @referrer.set_identifier("info:sid/"+val.to_s)            
+              @referrer.set_identifier("info:sid/"+val.to_s) 
+            elsif key == 'pid'
+              @referent.set_private_data(val.to_s)           
             else 
               @referent.set_metadata(key, val)
             end

data/lib/openurl/metadata_formats/scholarly_common.rb

@@ -18,6 +18,7 @@ module OpenURL
       @author_keys = ['aulast','aufirst','auinit','auinit1','auinitm','ausuffix',
         'au', 'aucorp']       
     end
+    
     def method_missing(metadata, value=nil)
       meta = metadata.to_s.sub(/=$/,'')
       raise ArgumentError, "#{meta.to_s} is not a valid #{self.class} metadata field." unless (@author_keys+@metadata_keys).index(meta)
@@ -28,10 +29,16 @@ module OpenURL
         end
       else
         return self.metadata[meta]
-      end
-      
+      end      
     end
     
+    def respond_to?(message)
+      # make it match method_messing
+      key = message.to_s.sub(/=$/,'')
+      super || (@author_keys+@metadata_keys).index(key)
+    end
+    
+    
     def set_metadata(key, val)
       @metadata[key] = val.to_s
       if @author_keys.index(key)

data/test/context_object_test.rb

@@ -352,6 +352,25 @@ class ContextObjectTest < Test::Unit::TestCase
     assert_match("ctx_enc=#{CGI.escape("info:ofi/enc:UTF-8")}", ctx.kev)
   end
   
+  def test_kev_01_pid
+      kev = "sid=CSA:eric-set-c&pid=%3CAN%3EED492558%3C%2FAN%3E%26%3CPY%3E2004%3C%2FPY%3E%26%3CAU%3EHsu%2C%20Jeng-yih%20Tim%3C%2FAU%3E&date=2004&genre=proceeding&aulast=Hsu&aufirst=Jeng-yih&auinitm=T&title=Reading%20without%20Teachers%3A%20Literature%20Circles%20in%20an%20EFL%20Classroom"   
+      ctx = OpenURL::ContextObject.new_from_kev(kev) 
+      assert_equal("<AN>ED492558</AN>&<PY>2004</PY>&<AU>Hsu, Jeng-yih Tim</AU>", ctx.referent.private_data)
+  end
+  
+  def test_set_openurl_ver
+      # manually set 'illegal' openurl_ver is respected
+      kev = "sid=CSA:eric-set-c&pid=%3CAN%3EED492558%3C%2FAN%3E%26%3CPY%3E2004%3C%2FPY%3E%26%3CAU%3EHsu%2C%20Jeng-yih%20Tim%3C%2FAU%3E&date=2004&genre=proceeding&aulast=Hsu&aufirst=Jeng-yih&auinitm=T&title=Reading%20without%20Teachers%3A%20Literature%20Circles%20in%20an%20EFL%20Classroom"   
+      ctx = OpenURL::ContextObject.new_from_kev(kev)
+      
+      ctx.openurl_ver = "" # empty string!
+      
+      kev = ctx.kev
+      
+      assert_match(/url_ver=&/, kev)
+      assert_match(/ctx_ver=&/, kev)
+  end
+  
   protected
   
   # Make sure ctx1 and ctx2 don't share the same data objects.

data/test/scholarly_common_test.rb

@@ -0,0 +1,13 @@
+class ScholarlyCommonTest < Test::Unit::TestCase
+  
+  def test_respond_to
+    kev = "url_ver=Z39.88-2004&rfr_id=info:sid/library.jhu.edu%3Axerxes+%28+OmniFile+Full+Text+Mega%29&rft.genre=article&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Ajournal&rft.issn=00297917&rft.date=2012&rft.tpages=2+pages&rft.jtitle=Occupational+Health&rft.volume=64&rft.issue=5&rft.spage=14&rft.epage=15&rft.atitle=Inhalation+versus+skin+exposure+%3A+have+we+got+the+balance+right%3F+&rft.aulast=Packham&rft.aufirst=Chris+Partner%2C+EnviroDerm+Services"
+    
+    openurl = OpenURL::ContextObject.new_from_kev(kev)
+    
+    assert openurl.referent.respond_to? :jtitle
+    assert openurl.referent.respond_to? :atitle    
+    
+  end
+  
+end

metadata

@@ -1,36 +1,42 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: openurl
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.2.1
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Jonathan Rochkind
 - Ross Singer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-10 00:00:00 -04:00
-default_executable: 
-dependencies: []
-
+date: 2011-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: marc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
-email: 
+email:
 - rochkind@jhu.edu
 - rossfsinger@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README
-files: 
+extra_rdoc_files:
+- README.md
+files:
 - lib/openurl.rb
 - lib/openurl/context_object_entity.rb
 - lib/openurl/metadata_formats/book.rb
@@ -52,40 +58,30 @@ files:
 - test/test.yml
 - test/context_object_test.rb
 - test/encoding_test.rb
-- README
-has_rdoc: true
+- test/scholarly_common_test.rb
+- README.md
 homepage: https://github.com/openurl/openurl
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: a Ruby library to create, parse and use NISO Z39.88 OpenURLs
 test_files: []
-

data/README

@@ -1,68 +0,0 @@
-== openurl
-
-== DESCRIPTION
-
-openurl is a Ruby library creating, parsing and using NISO Z39.88 OpenURLs over 
-HTTP. <http://openurl.info/registry>
-
-While openurl can send requests to OpenURL 1.0 resolvers, there is no 'standard'
-response format, so parsing the returned value is up to you.
-
-== USAGE
-  
-  require 'openurl'    
-
-  # Create your context object
-  context_object = OpenURL::ContextObject.new
-
-  # Add metadata to the Context Object Entities
-  context_object.referent.set_format('journal')
-  context_object.referent.add_identifier('info:doi/10.1016/j.ipm.2005.03.024')
-  context_object.referent.set_metadata('issn', '0306-4573')
-  context_object.referent.set_metadata('aulast', 'Bollen')
-  context_object.referrer.add_identifier('info:sid/google')
-  
-  puts context_object.kev  
-
-  puts context_object.xml  
-  
-  # Send the context object to an OpenURL link resolver
-  transport = OpenURL::Transport.new('http://demo.exlibrisgroup.com:9003/lr_3', context_object)
-  transport.get
-  puts tranport.response
-  
-  # Create a new ContextObject from an existing kev or XML serialization:
-  #
-  # ContextObject.new_from_kev(   kev_context_object )
-  # ContextObject.new_from_xml(   xml_context_object ) # Can be String or REXML::Document
-
-== Ruby 1.9 and encodings
-
-Gem does run and all tests pass under ruby 1.9.  There is very limited
-support for handling character encodings in the proper 1.9 way. 
-
-CTX or XML context objects will be assumed utf-8 even if the ruby string
-they are held in has an ascii-8bit encoding. They will forced into a utf-8 encoding. 
-This seems to be a side effect of the REXML and CGI libraries we use to parse,
-but there are runnable tests that assert it is true. (see test/encoding_test.rb)
-
-Incoming context objects with a non-utf8 ctx_enc value will *not* be handled
-properly, they'll still be forced to utf8. 
-
-Programmatically created context objects, you must ensure all strings are
-represented as utf8 encoded yourself.  
-
-More sophisticated encoding handling can theoretically be added, but it's
-somewhat non-trivial, and it's not clear anyone needs it. 
-
-== INSTALLATION
-
-You should be able to install the gem:
-
-  gem install openurl
-
-The source lives in git on github:
-
-  http://github.com/openurl/openurl
-
-