oai 0.0.1 → 0.0.2

data/lib/oai/client.rb

@@ -2,6 +2,7 @@ require 'uri'
 require 'net/http'
 require 'rexml/document'
 require 'cgi'
+require 'date'
 
 module OAI
 
@@ -9,7 +10,7 @@ module OAI
   # a OAI-PMH server. The 6 OAI-PMH verbs translate directly to methods you 
   # can call on a OAI::Client object. Verb arguments are passed as a hash:
   #
-  #   client = OAI::Harvester.new ''http://www.pubmedcentral.gov/oai/oai.cgi'
+  #   client = OAI::Client.new ''http://www.pubmedcentral.gov/oai/oai.cgi'
   #   client.list_identifiers :metadata_prefix => 'oai_dc'
   #
   # It is worth noting that the api uses methods and parameter names with 
@@ -32,9 +33,14 @@ module OAI
     # service:
     #
     #   client = OAI::Harvseter.new 'http://www.pubmedcentral.gov/oai/oai.cgi'
+    #
+    # If you want to see debugging messages on STDERR use:
+    #
+    #   client = OAI::Harvester.new 'http://example.com', :debug => true
     
-    def initialize(base_url)
+    def initialize(base_url, options={})
       @base = URI.parse base_url
+      @debug = options[:debug]
     end
 
     # Equivalent to a Identify request. You'll get back a OAI::IdentifyResponse
@@ -123,13 +129,17 @@ module OAI
         "#{key}=#{value}"
       end
       uri.query = parts.join('&')
+      debug("doing request: #{uri.to_s}")
 
       # fire off the request and return an REXML::Document object
       begin
         xml = Net::HTTP.get(uri)
+        debug("got response: #{xml}")
         return REXML::Document.new(xml)
-      rescue
-        raise OAI::Exception, 'error during oai operation', caller
+      rescue REXML::ParseException => e
+        raise OAI::Exception, 'response not well formed XML: '+e, caller
+      rescue SystemCallError=> e
+        raise OAI::Exception, 'HTTP level error during OAI request: '+e, caller
       end
     end
 
@@ -159,5 +169,9 @@ module OAI
         end
       end
     end
+
+    def debug(msg)
+      $stderr.print("#{msg}\n") if @debug
+    end
   end
 end

data/lib/oai/record.rb

@@ -1,4 +1,10 @@
 module OAI
+
+  # A class for representing a Record as returned from a GetRecord 
+  # or ListRecords request. Each record will have a header and metadata
+  # attribute. The header is a OAI::Header object and the metadata is 
+  # a REXML::Element object for that chunk of XML. 
+  
   class Record
     include OAI::XPath
     attr_accessor :header, :metadata

data/test.rb

@@ -10,3 +10,4 @@ require 'test/tc_identify'
 require 'test/tc_get_record'
 require 'test/tc_list_records'
 require 'test/tc_list_sets'
+require 'test/tc_exception'

data/test/tc_exception.rb

@@ -0,0 +1,21 @@
+class ExceptionTest < Test::Unit::TestCase
+
+  def test_http_error
+    client = OAI::Client.new 'http://www.example.com'
+    begin
+      client.identify
+      flunk 'did not throw expected exception'
+    rescue OAI::Exception => e
+      assert_match /Connection refused/, e.to_s, 'include error message'
+    end
+  end
+
+  def test_xml_error
+    client = OAI::Client.new 'http://www.google.com'
+    begin 
+      client.identify
+    rescue OAI::Exception => e
+      assert_match /response not well formed XML/, e.to_s, 'xml error'
+    end
+  end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: oai
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
-date: 2006-04-20 00:00:00 -05:00
+  version: 0.0.2
+date: 2006-05-15 00:00:00 -05:00
 summary: A ruby library for working with the Open Archive Initiative Protocol for Metadata Harvesting (OAI-PMH)
 require_paths: 
   - lib
@@ -45,6 +45,7 @@ files:
   - lib/oai/response.rb
   - lib/oai/set.rb
   - lib/oai/xpath.rb
+  - test/tc_exception.rb
   - test/tc_get_record.rb
   - test/tc_identify.rb
   - test/tc_list_identifiers.rb