oai 0.0.3 → 0.0.4

data/test/client/helpers/test_wrapper.rb

@@ -0,0 +1,11 @@
+module Test::Unit
+  class AutoRunner
+    alias_method :real_run, :run
+    
+    def run
+      ProviderServer.wrap { real_run }
+    end
+
+  end
+  
+end

data/test/client/tc_exception.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+class ExceptionTest < Test::Unit::TestCase
+
+  def test_http_error
+    client = OAI::Client.new 'http://www.example.com'
+    assert_raises(OAI::Exception) { client.identify }
+  end
+
+  def test_xml_error
+    client = OAI::Client.new 'http://www.yahoo.com'
+    begin 
+      client.identify
+    rescue OAI::Exception => e
+      assert_match /response not well formed XML/, e.to_s, 'xml error'
+    end
+  end
+
+  def test_oai_error
+    client = OAI::Client.new 'http://localhost:3333/oai'
+    assert_raises(OAI::Exception) do
+      client.list_identifiers :resumption_token => 'bogus'
+    end
+  end
+
+  # must pass in options as a hash 
+  def test_parameter_error
+    client = OAI::Client.new 'http://localhost:3333/oai'
+    assert_raises(OAI::ArgumentException) {client.get_record('foo')}
+    assert_raises(OAI::ArgumentException) {client.list_identifiers('foo')}
+    assert_raises(OAI::ArgumentException) {client.list_records('foo')}
+    assert_raises(OAI::ArgumentException) {client.list_metadata_formats('foo')}
+    assert_raises(OAI::ArgumentException) {client.list_sets('foo')}
+  end
+  
+end

data/test/{tc_get_record.rb → client/tc_get_record.rb}

@@ -1,22 +1,25 @@
+require 'test_helper'
+
 class GetRecordTest < Test::Unit::TestCase
+  
   def test_get_one
-    client = OAI::Client.new 'http://www.pubmedcentral.gov/oai/oai.cgi'
-    response = client.get_record :identifier => 'oai:pubmedcentral.gov:13901'
+    client = OAI::Client.new 'http://localhost:3333/oai'
+    response = client.get_record :identifier => 'oai:test/3'
     assert_kind_of OAI::GetRecordResponse, response
     assert_kind_of OAI::Record, response.record
     assert_kind_of REXML::Element, response.record.metadata
     assert_kind_of OAI::Header, response.record.header
 
     # minimal check that the header is working
-    assert_equal 'oai:pubmedcentral.gov:13901', 
+    assert_equal 'oai:test/3', 
       response.record.header.identifier
 
     # minimal check that the metadata is working
-    assert 'en', response.record.metadata.elements['.//dc:language'].text
+    #assert 'en', response.record.metadata.elements['.//dc:language'].text
   end
 
   def test_missing_identifier
-    client = OAI::Client.new 'http://www.pubmedcentral.gov/oai/oai.cgi'
+    client = OAI::Client.new 'http://localhost:3333/oai'
     begin
       client.get_record :metadata_prefix => 'oai_dc'
       flunk 'invalid get_record did not throw OAI::Exception'
@@ -26,8 +29,9 @@ class GetRecordTest < Test::Unit::TestCase
   end
 
   def test_deleted_record
-    client = OAI::Client.new 'http://ir.library.oregonstate.edu/dspace-oai/request'
-    record = client.get_record :identifier => 'oai:ir.library.oregonstate.edu:1957/19' 
+    client = OAI::Client.new 'http://localhost:3333/oai'
+    record = client.get_record :identifier => 'oai:test/275' 
     assert record.deleted?
   end
+
 end

data/test/client/tc_identify.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+class IdentifyTest < Test::Unit::TestCase
+
+  def test_ok
+    client = OAI::Client.new 'http://localhost:3333/oai'
+    response = client.identify
+    assert_kind_of OAI::IdentifyResponse, response
+    assert_equal 'Complex Provider [http://localhost]', response.to_s
+    #assert_equal 'PubMed Central (PMC3 - NLM DTD) [http://www.pubmedcentral.gov/oai/oai.cgi]', response.to_s
+  end
+
+end

data/test/{tc_libxml.rb → client/tc_libxml.rb}

@@ -1,9 +1,11 @@
+require 'test_helper'
+
 class LibXMLTest < Test::Unit::TestCase
 
   def test_oai_exception
     return unless have_libxml
 
-    uri = 'http://www.pubmedcentral.gov/oai/oai.cgi'
+    uri = 'http://localhost:3333/oai'
     client = OAI::Client.new uri, :parser => 'libxml'
     assert_raises(OAI::Exception) {client.get_record(:identifier => 'nosuchid')}
   end
@@ -14,36 +16,44 @@ class LibXMLTest < Test::Unit::TestCase
     # since there is regex magic going on to remove default oai namespaces 
     # it's worth trying a few different oai targets
     oai_targets = %w{
-      http://etd.caltech.edu:80/ETD-db/OAI/oai
-      http://ir.library.oregonstate.edu/dspace-oai/request
-      http://libeprints.open.ac.uk/perl/oai2
-      http://memory.loc.gov/cgi-bin/oai2_0
+      http://localhost:3333/oai
     }
 
+    #oai_targets = %w{
+    #  http://etd.caltech.edu:80/ETD-db/OAI/oai
+    #  http://ir.library.oregonstate.edu/dspace-oai/request
+    #  http://memory.loc.gov/cgi-bin/oai2_0
+    #  http://libeprints.open.ac.uk/perl/oai2
+    #}
+
+
     oai_targets.each do |uri|
       client = OAI::Client.new uri, :parser => 'libxml'
       records = client.list_records
       records.each do |record|
         assert record.header.identifier
-        next unless record.deleted?
+        next if record.deleted?
         assert_kind_of XML::Node, record.metadata
       end
     end
   end
 
   def test_deleted_record
-    uri = 'http://ir.library.oregonstate.edu/dspace-oai/request'
+    return unless have_libxml
+
+    uri = 'http://localhost:3333/oai'
     client = OAI::Client.new(uri, :parser => 'libxml')
-    record = client.get_record :identifier => 'oai:ir.library.oregonstate.edu:1957/19' 
+    response = client.get_record :identifier => 'oai:test/275'
+    assert response.record.deleted?
   end
-
+  
   private
 
   def have_libxml
     begin
       require 'xml/libxml'
       return true
-    rescue
+    rescue LoadError
       return false
     end
   end

data/test/{tc_list_identifiers.rb → client/tc_list_identifiers.rb}

@@ -1,7 +1,9 @@
+require 'test_helper'
+
 class ListIdentifiersTest < Test::Unit::TestCase
 
   def test_list_with_resumption_token
-    client = OAI::Client.new 'http://www.pubmedcentral.gov/oai/oai.cgi' 
+    client = OAI::Client.new 'http://localhost:3333/oai' 
 
     # get a list of identifier headers
     response = client.list_identifiers :metadata_prefix => 'oai_dc' 
@@ -26,16 +28,16 @@ class ListIdentifiersTest < Test::Unit::TestCase
   end
 
   def test_list_with_date_range
-    client = OAI::Client.new 'http://alcme.oclc.org/xtcat/servlet/OAIHandler'
-    from_date = Date.new(2001,1,1)
-    until_date  = Date.new(2006,1,1)
+    client = OAI::Client.new 'http://localhost:3333/oai'
+    from_date = Date.new(1998,1,1)
+    until_date  = Date.new(2002,1,1)
     response = client.list_identifiers :from => from_date, :until => until_date
     assert response.entries.size > 0
   end
 
   def test_list_with_datetime_range
     # xtcat should support higher granularity
-    client = OAI::Client.new 'http://alcme.oclc.org/xtcat/servlet/OAIHandler'
+    client = OAI::Client.new 'http://localhost:3333/oai'
     from_date = DateTime.new(2001,1,1)
     until_date = DateTime.now
     response = client.list_identifiers :from => from_date, :until => until_date
@@ -43,8 +45,8 @@ class ListIdentifiersTest < Test::Unit::TestCase
   end
 
   def test_invalid_argument
-    client = OAI::Client.new 'http://arXiv.org/oai2'
-    assert_raise(OAI::Exception) {client.list_identifiers :foo => 'bar'}
+    client = OAI::Client.new 'http://localhost:3333/oai'
+    assert_raise(OAI::ArgumentException) {client.list_identifiers :foo => 'bar'}
   end
-
+  
 end

data/test/{tc_list_metadata_formats.rb → client/tc_list_metadata_formats.rb}

@@ -1,6 +1,8 @@
+require 'test_helper'
+
 class ListMetadataFormatsTest < Test::Unit::TestCase
   def test_list
-    client = OAI::Client.new 'http://www.pubmedcentral.gov/oai/oai.cgi' 
+    client = OAI::Client.new 'http://localhost:3333/oai' 
     response = client.list_metadata_formats
     assert_kind_of OAI::ListMetadataFormatsResponse, response
     assert response.entries.size > 0
@@ -11,5 +13,6 @@ class ListMetadataFormatsTest < Test::Unit::TestCase
     assert_equal 'http://www.openarchives.org/OAI/2.0/oai_dc.xsd', format.schema
     assert_equal 'http://www.openarchives.org/OAI/2.0/oai_dc/', format.namespace
   end
+  
 end
 

data/test/{tc_list_records.rb → client/tc_list_records.rb}

@@ -1,9 +1,12 @@
+require 'test_helper'
+
 class GetRecordsTest < Test::Unit::TestCase
   def test_get_records
-    client = OAI::Client.new 'http://www.pubmedcentral.gov/oai/oai.cgi'
+    client = OAI::Client.new 'http://localhost:3333/oai'
     response = client.list_records 
     assert_kind_of OAI::ListRecordsResponse, response
     assert response.entries.size > 0
     assert_kind_of OAI::Record,  response.entries[0]
   end
+  
 end

data/test/{tc_list_sets.rb → client/tc_list_sets.rb}

@@ -1,7 +1,9 @@
+require 'test_helper'
+
 class ListSetsTest < Test::Unit::TestCase
 
   def test_list
-    client = OAI::Client.new 'http://www.pubmedcentral.gov/oai/oai.cgi'
+    client = OAI::Client.new 'http://localhost:3333/oai'
     response = client.list_sets
     assert_kind_of OAI::ListSetsResponse, response
     assert response.entries.size > 0
@@ -12,6 +14,6 @@ class ListSetsTest < Test::Unit::TestCase
       assert_kind_of OAI::Set, set
     end
   end
-
+  
 end
 

data/test/{tc_xpath.rb → client/tc_xpath.rb}

@@ -1,4 +1,4 @@
-require 'oai/xpath'
+require 'test_helper'
 
 class XpathTest < Test::Unit::TestCase
   include OAI::XPath

data/test/client/test_helper.rb

@@ -0,0 +1,5 @@
+require 'oai'
+require 'test/unit'
+
+require File.dirname(__FILE__) + '/helpers/provider'
+require File.dirname(__FILE__) + '/helpers/test_wrapper'

data/test/provider/models.rb

@@ -0,0 +1,230 @@
+class Record
+  attr_accessor :id, :titles, :creator, :tags, :sets, :updated_at, :deleted
+  
+  def initialize(id, 
+      titles = 'title', 
+      creator = 'creator', 
+      tags = 'tag', 
+      sets = nil, 
+      deleted = false,
+      updated_at = Time.new.utc)
+      
+    @id = id;
+    @titles = titles
+    @creator = creator
+    @tags = tags
+    @sets = sets
+    @deleted = deleted
+    @updated_at = updated_at
+  end
+  
+  # Override Object.id
+  def id
+    @id
+  end
+  
+  def in_set(spec)
+    if @sets.respond_to?(:each)
+      @sets.each { |set| return true if set.spec == spec }
+    else
+      return true if @sets.spec == spec
+    end
+    false
+  end
+  
+end
+
+class TestModel < OAI::Provider::Model
+  include OAI::Provider
+  
+  def initialize(limit = nil)
+    super(limit)
+    @records = []
+    @sets = []
+    @earliest = Time.now
+  end
+  
+  def earliest
+    (@records.min {|a,b| a.updated_at <=> b.updated_at }).updated_at
+  end
+  
+  def latest
+    @records.max {|a,b| a.updated_at <=> b.updated_at }.updated_at
+  end
+
+  def sets
+    @sets
+  end
+  
+  def find(selector, opts={})
+    return nil unless selector
+
+    case selector
+    when :all
+      if opts[:resumption_token]
+        raise OAI::ResumptionTokenException.new unless @limit
+        begin
+          token = ResumptionToken.parse(opts[:resumption_token])
+
+          if token.last < @groups.size - 1
+            PartialResult.new(@groups[token.last], token.next(token.last + 1))
+          else
+            @groups[token.last]
+          end
+        rescue
+          raise OAI::ResumptionTokenException.new
+        end
+      else
+        records = @records.select do |rec|
+          ((opts[:set].nil? || rec.in_set(opts[:set])) && 
+          (opts[:from].nil? || rec.updated_at >= opts[:from]) &&
+          (opts[:until].nil? || rec.updated_at <= opts[:until]))
+        end
+
+        if @limit && records.size > @limit
+          @groups = generate_chunks(records, @limit)
+          return PartialResult.new(@groups[0], 
+            ResumptionToken.new(opts.merge({:last => 1})))
+        end
+        return records
+      end
+    else
+      begin
+        @records.each do |record|
+          return record if record.id.to_s == selector
+        end
+      rescue
+      end
+      nil
+    end
+  end
+  
+  def generate_chunks(records, limit)
+    groups = []
+    records.each_slice(limit) do |group|
+      groups << group
+    end
+    groups
+  end
+      
+  def generate_records(number, timestamp = Time.now, sets = [], deleted = false)
+    @earliest = timestamp.dup if @earliest.nil? || timestamp < @earliest
+    
+    # Add any sets we don't already have
+    sets = [sets] unless sets.respond_to?(:each)
+    sets.each do |set|
+      @sets << set unless @sets.include?(set)
+    end 
+    
+    # Generate some records
+    number.times do |id|
+      rec = Record.new(@records.size, "title_#{id}", "creator_#{id}", "tag_#{id}")
+      rec.updated_at = timestamp.utc
+      rec.sets = sets
+      rec.deleted = deleted
+      @records << rec
+    end
+  end
+    
+end
+
+class SimpleModel < TestModel
+  
+  def initialize
+    super
+    # Create a couple of sets
+    set_one = OAI::Set.new()
+    set_one.name = "Test Set One"
+    set_one.spec = "A"
+    set_one.description = "This is test set one."
+
+    set_two = OAI::Set.new()
+    set_two.name = "Test Set Two"
+    set_two.spec = "A:B"
+    set_two.description = "This is test set two."
+
+    generate_records(5, Chronic.parse("oct 5 2002"), set_one)
+    generate_records(1, Chronic.parse("nov 5 2002"), [set_two], true)
+    generate_records(4, Chronic.parse("nov 5 2002"), [set_two])
+  end
+
+end
+
+class BigModel < TestModel
+  
+  def initialize(limit = nil)
+    super(limit)
+    generate_records(100, Chronic.parse("October 2 2000"))
+    generate_records(100, Chronic.parse("November 2 2000"))
+    generate_records(100, Chronic.parse("December 2 2000"))
+    generate_records(100, Chronic.parse("January 2 2001"))
+    generate_records(100, Chronic.parse("February 2 2001"))
+  end
+  
+end
+
+class MappedModel < TestModel
+
+  def initialize
+    super
+    set_one = OAI::Set.new()
+    set_one.name = "Test Set One"
+    set_one.spec = "A"
+    set_one.description = "This is test set one."
+
+    generate_records(5, Chronic.parse("dec 1 2006"), set_one)
+  end
+  
+  def map_oai_dc
+    {:title => :creator, :creator => :titles, :subject => :tags}
+  end
+
+end
+
+class ComplexModel < TestModel
+  
+  def initialize(limit = nil)
+    super(limit)
+    # Create a couple of sets
+    set_one = OAI::Set.new
+    set_one.name = "Set One"
+    set_one.spec = "One"
+    set_one.description = "This is test set one."
+
+    set_two = OAI::Set.new
+    set_two.name = "Set Two"
+    set_two.spec = "Two"
+    set_two.description = "This is test set two."
+
+    set_three = OAI::Set.new
+    set_three.name = "Set Three"
+    set_three.spec = "Three"
+    set_three.description = "This is test set three."
+
+    set_four = OAI::Set.new
+    set_four.name = "Set Four"
+    set_four.spec = "Four"
+    set_four.description = "This is test set four."
+
+    set_one_two = OAI::Set.new
+    set_one_two.name = "Set One and Two"
+    set_one_two.spec = "One:Two"
+    set_one_two.description = "This is combination set of One and Two."
+
+    set_three_four = OAI::Set.new
+    set_three_four.name = "Set Three and Four"
+    set_three_four.spec = "Three:Four"
+    set_three_four.description = "This is combination set of Three and Four."
+
+    generate_records(250, Chronic.parse("May 2 1998"), [set_one, set_one_two])
+    generate_records(50, Chronic.parse("June 2 1998"), [set_one, set_one_two], true)
+    generate_records(50, Chronic.parse("October 10 1998"), [set_three, set_three_four], true)
+    generate_records(250, Chronic.parse("July 2 2002"), [set_two, set_one_two])
+    
+    generate_records(250, Chronic.parse("September 15 2004"), [set_three, set_three_four])
+    generate_records(50, Chronic.parse("October 10 2004"), [set_three, set_three_four], true)
+    generate_records(250, Chronic.parse("December 25 2005"), [set_four, set_three_four])
+  end
+  
+end
+