openurl 0.1.0 → 0.2.0

data/README

@@ -30,7 +30,30 @@ response format, so parsing the returned value is up to you.
   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
 
@@ -38,10 +61,8 @@ You should be able to install the gem:
 
   gem install openurl
 
-The source lives in subversion:
+The source lives in git on github:
 
-  http://openurl.rubyforge.org/svn/
+  http://github.com/openurl/openurl
 
-== CONTACT
 
-Bugs and suggestions to Ross Singer <rossfsinger@gmail.com>

data/lib/openurl/context_object.rb

@@ -1,7 +1,11 @@
+# encoding: UTF-8
+
 module OpenURL
 
-    
-  require 'jcode'
+  if RUBY_VERSION < '1.9'
+    require 'jcode'
+    $KCODE='UTF-8'
+  end
 
   ## 
   # The ContextObject class is intended to both create new OpenURL 1.0 context
@@ -47,7 +51,6 @@ module OpenURL
       @serviceType = []
       @resolver = []
       @foreign_keys = {}
-      $KCODE='UTF-8'
       @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"}}    
     end
 

data/lib/openurl/context_object_entity.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 module OpenURL
   
   # The ContextObjectEntity is a generic class to define an entity.  It should

data/lib/openurl/metadata_formats/book.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 # 
 # book.rb
 # 

data/lib/openurl/metadata_formats/dissertation.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 # 
 # dissertation.rb
 # 

data/lib/openurl/metadata_formats/dublin_core.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 # 
 # dublin_core.rb
 # 
@@ -54,11 +56,13 @@ module OpenURL
       end                 
     end 
     
-    def import_xml_metadata(node)         
+    def import_xml_metadata(node)     
       mbv = REXML::XPath.first(node, "./ctx:metadata-by-val/ctx:metadata/fmt:dc", {"ctx"=>"info:ofi/fmt:xml:xsd:ctx", "fmt"=>@oai_ns})					              
       if mbv
-        mbv.to_a.each do |m|
-          self.set_metadata(m.name(), CGI.unescapeHTML(m.children.to_s)) unless m.children.empty?                                  
+        mbv.to_a.each do |m|          
+          m.children.each do | value|            
+            self.set_metadata(m.name(), CGI.unescapeHTML(value.to_s))
+          end
         end      
       end					
     end 

data/lib/openurl/metadata_formats/journal.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 # 
 # journal.rb
 # 

data/lib/openurl/metadata_formats/marc.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 # 
 # marc.rb
 # 

data/lib/openurl/metadata_formats/patent.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 # 
 # patent.rb
 # 

data/lib/openurl/metadata_formats/scholarly_common.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 # 
 # scholarly_common.rb
 # 

data/lib/openurl/metadata_formats/scholarly_service_type.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 # 
 # scholarly_service_type.rb
 # 

data/lib/openurl/transport.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'net/http'
 require 'uri'		
 

data/lib/openurl.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 # A library to create and parse NISO Z39.88 OpenURLs
 # Can also work with OpenURL 0.1, but your YMMV
 # See:  http://alcme.oclc.org/openurl/docs/implementation_guidelines/

data/test/context_object_entity_test.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 
 class ContextObjectEntityTest < Test::Unit::TestCase
 

data/test/context_object_test.rb

@@ -1,3 +1,7 @@
+# encoding: UTF-8
+
+Encoding.default_external = "UTF-8" if defined? Encoding
+
 class ContextObjectTest < Test::Unit::TestCase
 
   def test_create_ctx    
@@ -273,30 +277,6 @@ class ContextObjectTest < Test::Unit::TestCase
     test_not_shared_objects( ctx_orig, ctx_with_imported_data )
     
   end
-
-  
-  # Make sure ctx1 and ctx2 don't share the same data objects.
-  # If they did, a change to one would change the other.
-  def test_not_shared_objects(ctx1, ctx2)
-    assert_not_equal( ctx1.referent.object_id, ctx2.referent.object_id );
-    assert_not_equal( ctx1.referent.metadata.object_id, ctx2.referent.metadata.object_id )
-    
-    original_ref_title = ctx1.referent.metadata['title']
-    new_title = "new test title"
-    # just ensure new uniqueness
-    new_title += original_ref_title if original_ref_title 
-    
-    ctx1.referent.set_metadata('title', new_title)
-
-    # That better not have changed ctx2
-
-    assert_not_equal( new_title, ctx2.referent.metadata['title'])
-    
-    # Now fix first title back to what it was originally, to have no
-    # side-effects
-    ctx1.referent.set_metadata('title', original_ref_title )
-  end
-    
   
   
   def test_to_hash
@@ -372,6 +352,30 @@ class ContextObjectTest < Test::Unit::TestCase
     assert_match("ctx_enc=#{CGI.escape("info:ofi/enc:UTF-8")}", ctx.kev)
   end
   
+  protected
+  
+  # Make sure ctx1 and ctx2 don't share the same data objects.
+  # If they did, a change to one would change the other.
+  def test_not_shared_objects(ctx1, ctx2)
+    assert_not_equal( ctx1.referent.object_id, ctx2.referent.object_id );
+    assert_not_equal( ctx1.referent.metadata.object_id, ctx2.referent.metadata.object_id )
+    
+    original_ref_title = ctx1.referent.metadata['title']
+    new_title = "new test title"
+    # just ensure new uniqueness
+    new_title += original_ref_title if original_ref_title 
+    
+    ctx1.referent.set_metadata('title', new_title)
+
+    # That better not have changed ctx2
+
+    assert_not_equal( new_title, ctx2.referent.metadata['title'])
+    
+    # Now fix first title back to what it was originally, to have no
+    # side-effects
+    ctx1.referent.set_metadata('title', original_ref_title )
+  end
+  
   def test_kev_values(ctx)    
     assert_equal(ctx.referent.format, 'book')
     assert_equal(ctx.referent.class, OpenURL::Book)

data/test/encoding_test.rb

@@ -0,0 +1,58 @@
+# encoding: UTF-8
+
+
+require 'yaml'
+
+unless "".respond_to?(:encoding)
+  puts <<eos
+  
+=================================================================
+  WARNING: Can't run encoding tests unless under ruby 1.9 
+      #{__FILE__} 
+  Encoding tests will NOT be run.
+=================================================================
+
+eos
+else
+
+  class EncodingTest < Test::Unit::TestCase
+    
+      
+    def test_kev
+      # Load from string explicitly set to binary, to make sure it ends up utf-8
+      # anyhow. 
+      raw_kev = "url_ver=Z39.88-2004&url_tim=2003-04-11T10%3A09%3A15TZD&url_ctx_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Actx&ctx_ver=Z39.88-2004&ctx_enc=info%3Aofi%2Fenc%3AUTF-8&ctx_id=10_8&ctx_tim=2003-04-11T10%3A08%3A30TZD&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.aulast=Vergnaud&rft.auinit=J.-R&rft.btitle=D%C3%A9pendances+et+niveaux+de+repr%C3%A9sentation+en+syntaxe&rft.date=1985&rft.pub=Benjamins&rft.place=Amsterdam%2C+Philadelphia&rfe_id=urn%3Aisbn%3A0262531283&rfe_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rfe.genre=book&rfe.aulast=Chomsky&rfe.auinit=N&rfe.btitle=Minimalist+Program&rfe.isbn=0262531283&rfe.date=1995&rfe.pub=The+MIT+Press&rfe.place=Cambridge%2C+Mass&svc_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Asch_svc&svc.abstract=yes&rfr_id=info%3Asid%2Febookco.com%3Abookreader".force_encoding("ascii-8bit")
+      
+      assert_equal("ASCII-8BIT", raw_kev.encoding.name)
+      
+      ctx = OpenURL::ContextObject.new_from_kev(raw_kev)
+      
+      assert_equal("UTF-8", ctx.referent.metadata['btitle'].encoding.name) 
+      assert_equal("Dépendances et niveaux de représentation en syntaxe", ctx.referent.metadata["btitle"])
+  
+      # serialized as utf-8
+      assert_equal("UTF-8", ctx.kev.encoding.name)        
+    end
+    
+    def test_xml
+      assert_equal("ASCII-8BIT", @@xml_with_utf8.encoding.name)
+      
+      ctx = OpenURL::ContextObject.new_from_xml(@@xml_with_utf8)
+      
+      assert_equal("UTF-8", ctx.referent.metadata['btitle'].encoding.name) 
+      assert_equal("Dépendances et niveaux de représentation en syntaxe", ctx.referent.metadata["btitle"])
+  
+      # serialized as utf-8
+      assert_equal("UTF-8", ctx.xml.encoding.name)
+    end
+    
+    
+    
+    @@xml_with_utf8 = <<eos
+<ctx:context-objects xmlns:ctx='info:ofi/fmt:xml:xsd:ctx' xsi:schemaLocation='info:ofi/fmt:xml:xsd:ctx http://www.openurl.info/registry/docs/info:ofi/fmt:xml:xsd:ctx' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'><ctx:context-object identifier='10_8' timestamp='2003-04-11T10:08:30TZD' version='Z39.88-2004'><ctx:referent><ctx:metadata-by-val><ctx:format>info:ofi/fmt:xml:xsd:book</ctx:format><ctx:metadata><rft:book xmlns:rft='info:ofi/fmt:xml:xsd:book' xsi:schemaLocation='info:ofi/fmt:xml:xsd:book http://www.openurl.info/registry/docs/info:ofi/fmt:xml:xsd:book'><rft:genre>book</rft:genre><rft:btitle>Dépendances et niveaux de représentation en syntaxe</rft:btitle><rft:date>1985</rft:date><rft:pub>Benjamins</rft:pub><rft:place>Amsterdam, Philadelphia</rft:place><rft:authors><rft:author><rft:aulast>Vergnaud</rft:aulast><rft:auinit>J.-R</rft:auinit></rft:author></rft:authors></rft:book></ctx:metadata></ctx:metadata-by-val></ctx:referent><ctx:referring-entity><ctx:metadata-by-val><ctx:format>info:ofi/fmt:xml:xsd:book</ctx:format><ctx:metadata><rfe:book xmlns:rfe='info:ofi/fmt:xml:xsd:book' xsi:schemaLocation='info:ofi/fmt:xml:xsd:book http://www.openurl.info/registry/docs/info:ofi/fmt:xml:xsd:book'><rfe:genre>book</rfe:genre><rfe:btitle>Minimalist Program</rfe:btitle><rfe:isbn>0262531283</rfe:isbn><rfe:date>1995</rfe:date><rfe:pub>The MIT Press</rfe:pub><rfe:place>Cambridge, Mass</rfe:place><rfe:authors><rfe:author><rfe:aulast>Chomsky</rfe:aulast><rfe:auinit>N</rfe:auinit></rfe:author></rfe:authors></rfe:book></ctx:metadata></ctx:metadata-by-val><ctx:identifier>urn:isbn:0262531283</ctx:identifier></ctx:referring-entity><ctx:referrer><ctx:identifier>info:sid/ebookco.com:bookreader</ctx:identifier></ctx:referrer><ctx:service-type><ctx:metadata-by-val><ctx:format>info:ofi/fmt:xml:xsd:sch_svc</ctx:format><ctx:metadata><svc:abstract xmlns:svc='info:ofi/fmt:xml:xsd:sch_svc'>yes</svc:abstract></ctx:metadata></ctx:metadata-by-val></ctx:service-type></ctx:context-object></ctx:context-objects>
+eos
+  # Make sure it's got a raw encoding, so we can test it winds up utf-8 anyhow
+  @@xml_with_utf8.force_encoding("ascii-8bit")
+      
+  end
+end

metadata

@@ -1,21 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: openurl
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jonathan Rochkind
 - Ross Singer
-autorequire: openurl
+autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-04-14 00:00:00 -04:00
+date: 2011-10-10 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -31,53 +32,58 @@ extra_rdoc_files:
 - README
 files: 
 - lib/openurl.rb
-- lib/openurl/context_object.rb
 - lib/openurl/context_object_entity.rb
 - lib/openurl/metadata_formats/book.rb
-- lib/openurl/metadata_formats/dissertation.rb
-- lib/openurl/metadata_formats/dublin_core.rb
 - lib/openurl/metadata_formats/journal.rb
+- lib/openurl/metadata_formats/scholarly_service_type.rb
+- lib/openurl/metadata_formats/dublin_core.rb
+- lib/openurl/metadata_formats/scholarly_common.rb
 - lib/openurl/metadata_formats/marc.rb
 - lib/openurl/metadata_formats/patent.rb
-- lib/openurl/metadata_formats/scholarly_common.rb
-- lib/openurl/metadata_formats/scholarly_service_type.rb
+- lib/openurl/metadata_formats/dissertation.rb
 - lib/openurl/transport.rb
-- test/context_object_entity_test.rb
-- test/context_object_test.rb
-- test/data/dc_ctx.xml
-- test/data/marc_ctx.xml
+- lib/openurl/context_object.rb
 - test/data/metalib_sap2_post_params.yml
-- test/data/scholarly_au_ctx.xml
+- test/data/dc_ctx.xml
 - test/data/yu.xml
+- test/data/scholarly_au_ctx.xml
+- test/data/marc_ctx.xml
+- test/context_object_entity_test.rb
 - test/test.yml
+- test/context_object_test.rb
+- test/encoding_test.rb
 - README
 has_rdoc: true
-homepage: http://openurl.rubyforge.org/
+homepage: https://github.com/openurl/openurl
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 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 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: a Ruby library to create, parse and use NISO Z39.88 OpenURLs