oai 0.2.1 → 0.3.0

data/test/client/tc_list_identifiers.rb

@@ -3,10 +3,10 @@ require 'test_helper'
 class ListIdentifiersTest < Test::Unit::TestCase
 
   def test_list_with_resumption_token
-    client = OAI::Client.new 'http://localhost:3333/oai' 
+    client = OAI::Client.new 'http://localhost:3333/oai'
 
     # get a list of identifier headers
-    response = client.list_identifiers :metadata_prefix => 'oai_dc' 
+    response = client.list_identifiers :metadata_prefix => 'oai_dc'
     assert_kind_of OAI::ListIdentifiersResponse, response
     assert_kind_of OAI::Response, response
     assert response.entries.size > 0
@@ -27,6 +27,25 @@ class ListIdentifiersTest < Test::Unit::TestCase
     assert_not_equal response.entries[0].identifier, first_identifier
   end
 
+  def test_list_full
+    client = OAI::Client.new 'http://localhost:3333/oai'
+
+    # get a list of identifier headers
+    response = client.list_identifiers :metadata_prefix => 'oai_dc'
+    assert_kind_of OAI::ListIdentifiersResponse, response
+    assert_kind_of OAI::Response, response
+    assert response.respond_to?(:full), "Should expose :full"
+
+    # Check that it runs through the pages
+    assert_equal 1150, response.full.count
+    response.full.each do |header|
+      assert_kind_of OAI::Header, header
+      assert header.identifier
+      assert header.datestamp
+      assert header.set_spec
+    end
+  end
+
   def test_list_with_date_range
     client = OAI::Client.new 'http://localhost:3333/oai'
     from_date = Date.new(1998,1,1)
@@ -48,5 +67,5 @@ class ListIdentifiersTest < Test::Unit::TestCase
     client = OAI::Client.new 'http://localhost:3333/oai'
     assert_raise(OAI::ArgumentException) {client.list_identifiers :foo => 'bar'}
   end
-  
+
 end

data/test/client/tc_list_records.rb

@@ -1,13 +1,26 @@
 require 'test_helper'
 
-class GetRecordsTest < Test::Unit::TestCase
+class ListRecordsTest < Test::Unit::TestCase
 
-  def test_get_records
+  def test_list
     client = OAI::Client.new 'http://localhost:3333/oai'
-    response = client.list_records 
+    response = client.list_records
     assert_kind_of OAI::ListRecordsResponse, response
     assert response.entries.size > 0
     assert_kind_of OAI::Record,  response.entries[0]
   end
-  
+
+  def test_list_full
+    client = OAI::Client.new 'http://localhost:3333/oai'
+
+    response = client.list_records
+    assert_kind_of OAI::ListRecordsResponse, response
+
+    # Check that it runs through the pages
+    assert_equal 1150, response.full.count
+    response.full.each do |record|
+      assert_kind_of OAI::Record, record
+    end
+  end
+
 end

data/test/client/tc_list_sets.rb

@@ -8,12 +8,27 @@ class ListSetsTest < Test::Unit::TestCase
     assert_kind_of OAI::ListSetsResponse, response
     assert response.entries.size > 0
     assert_kind_of OAI::Set,  response.entries[0]
-  
+
     # test iterator
     for set in response
       assert_kind_of OAI::Set, set
     end
   end
-  
+
+  def test_list_full
+    client = OAI::Client.new 'http://localhost:3333/oai'
+
+    response = client.list_sets
+    assert_kind_of OAI::ListSetsResponse, response
+    assert_kind_of OAI::Response, response
+    assert response.respond_to?(:full), "Should expose :full"
+
+    # This won't page, but it should work anyway
+    assert_equal 6, response.full.count
+    response.full.each do |set|
+      assert_kind_of OAI::Set, set
+    end
+  end
+
 end
 

data/test/provider/models.rb

@@ -1,14 +1,14 @@
 class Record
   attr_accessor :id, :titles, :creator, :tags, :sets, :updated_at, :deleted
-  
-  def initialize(id, 
-      titles = 'title', 
-      creator = 'creator', 
-      tags = 'tag', 
-      sets = nil, 
+
+  def initialize(id,
+      titles = 'title',
+      creator = 'creator',
+      tags = 'tag',
+      sets = nil,
       deleted = false,
       updated_at = Time.now.utc.xmlschema)
-      
+
     @id = id
     @titles = titles
     @creator = creator
@@ -17,12 +17,12 @@ class Record
     @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 }
@@ -35,18 +35,18 @@ end
 
 class TestModel < OAI::Provider::Model
   include OAI::Provider
-  
+
   def initialize(limit = nil)
     super(limit)
     @records = []
     @sets = []
     @earliest = Time.now.utc.xmlschema
   end
-  
+
   def earliest
     (@records.min {|a,b| a.updated_at <=> b.updated_at }).updated_at.utc.xmlschema
   end
-  
+
   def latest
     @records.max {|a,b| a.updated_at <=> b.updated_at }.updated_at.utc.xmlschema
   end
@@ -54,7 +54,7 @@ class TestModel < OAI::Provider::Model
   def sets
     @sets
   end
-  
+
   def find(selector, opts={})
     return nil unless selector
 
@@ -79,7 +79,7 @@ class TestModel < OAI::Provider::Model
 	      (opts[:from].nil? || rec.updated_at >= opts[:from]) &&
 	      (opts[:until].nil? || rec.updated_at <= opts[:until]))
            #else
-           #  ((opts[:set].nil? || rec.in_set(opts[:set])) && 
+           #  ((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
@@ -87,7 +87,7 @@ class TestModel < OAI::Provider::Model
 
         if @limit && records.size > @limit
           @groups = generate_chunks(records, @limit)
-          return PartialResult.new(@groups[0], 
+          return PartialResult.new(@groups[0],
             ResumptionToken.new(opts.merge({:last => 1})))
         end
         return records
@@ -102,7 +102,7 @@ class TestModel < OAI::Provider::Model
       nil
     end
   end
-  
+
   def generate_chunks(records, limit)
     groups = []
     records.each_slice(limit) do |group|
@@ -110,17 +110,17 @@ class TestModel < OAI::Provider::Model
     end
     groups
   end
-      
+
   def generate_records(number, timestamp = Time.now.utc.xmlschema, sets = [], deleted = false)
     @earliest = timestamp.dup if @earliest.nil? || timestamp.to_s < @earliest.to_s
     @earliest = timestamp.dup if @earliest.nil?
-    
+
     # 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 
-    
+    end
+
     # Generate some records
     number.times do |id|
       rec = Record.new(@records.size, "title_#{id}", "creator_#{id}", "tag_#{id}")
@@ -130,11 +130,11 @@ class TestModel < OAI::Provider::Model
       @records << rec
     end
   end
-    
+
 end
 
 class SimpleModel < TestModel
-  
+
   def initialize
     super
     # Create a couple of sets
@@ -156,7 +156,7 @@ class SimpleModel < TestModel
 end
 
 class BigModel < TestModel
-  
+
   def initialize(limit = nil)
     super(limit)
     generate_records(100, Time.parse("October 2 2000"))
@@ -165,7 +165,7 @@ class BigModel < TestModel
     generate_records(100, Time.parse("January 2 2001"))
     generate_records(100, Time.parse("February 2 2001"))
   end
-  
+
 end
 
 class MappedModel < TestModel
@@ -179,7 +179,7 @@ class MappedModel < TestModel
 
     generate_records(5, Time.parse("dec 1 2006"), set_one)
   end
-  
+
   def map_oai_dc
     {:title => :creator, :creator => :titles, :subject => :tags}
   end
@@ -187,7 +187,7 @@ class MappedModel < TestModel
 end
 
 class ComplexModel < TestModel
-  
+
   def initialize(limit = nil)
     super(limit)
     # Create a couple of sets
@@ -225,20 +225,22 @@ class ComplexModel < TestModel
     generate_records(50, Time.parse("June 2 1998"), [set_one, set_one_two], true)
     generate_records(50, Time.parse("October 10 1998"), [set_three, set_three_four], true)
     generate_records(250, Time.parse("July 2 2002"), [set_two, set_one_two])
-    
+
     generate_records(250, Time.parse("September 15 2004"), [set_three, set_three_four])
     generate_records(50, Time.parse("October 10 2004"), [set_three, set_three_four], true)
     generate_records(250, Time.parse("December 25 2005"), [set_four, set_three_four])
   end
-  
+
   def about record
-    <<-eos 
-    <oai_dc:dc 
+    xml = <<-eos
+    <oai_dc:dc
           xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/"
           xmlns:dc="http://purl.org/dc/elements/1.1/">
           <dc:publisher>Ruby OAI test data</dc:publisher>
     </oai_dc:dc>
     eos
+    # Removes new-lines and formatting, which is a problem with Ruby 1.8.x
+    xml.gsub(/\s+/, ' ')
   end
 end
 

data/test/provider/tc_exceptions.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class ProviderExceptions < Test::Unit::TestCase
-  
+
   def setup
     @provider = ComplexProvider.new
   end
@@ -9,7 +9,7 @@ class ProviderExceptions < Test::Unit::TestCase
   def test_argument_exception
     assert_raise(OAI::ArgumentException) do
       @provider.identify(:identifier => 'invalid_arg')
-    end 
+    end
   end
 
   def test_resumption_token_exception
@@ -26,44 +26,54 @@ class ProviderExceptions < Test::Unit::TestCase
       @provider.list_identifiers(:resumption_token => '\:\\:\/$%^&*!@#!:1')
     end
   end
-  
+
   def test_bad_verb_raises_exception
     assert @provider.process_request(:verb => 'BadVerb') =~ /badVerb/
     assert @provider.process_request(:verb => '\a$#^%!@') =~ /badVerb/
     assert @provider.process_request(:verb => 'identity') =~ /badVerb/
     assert @provider.process_request(:verb => '!!\\$\$\.+') =~ /badVerb/
   end
-  
+
   def test_bad_format_raises_exception
     assert_raise(OAI::FormatException) do
       @provider.get_record(:identifier => 'oai:test/1', :metadata_prefix => 'html')
     end
   end
-  
-  def test_bad_id_raises_exception
-    assert_raise(OAI::IdException) do
-      @provider.get_record(:identifier => 'oai:test/5000')
-    end
-    assert_raise(OAI::IdException) do
-      @provider.get_record(:identifier => 'oai:test/-1')
+
+  def test_missing_format_raises_exception
+    assert_raise(OAI::ArgumentException) do
+      @provider.list_records()
     end
-    assert_raise(OAI::IdException) do
-      @provider.get_record(:identifier => 'oai:test/one')
+    assert_raise(OAI::ArgumentException) do
+      @provider.get_record(:identifier => 'oai:test/1')
     end
-    assert_raise(OAI::IdException) do
-      @provider.get_record(:identifier => 'oai:test/\\$1\1!')
+  end
+
+  def test_bad_id_raises_exception
+    badIdentifiers = [
+      'oai:test/5000',
+      'oai:test/-1',
+      'oai:test/one',
+      'oai:test/\\$1\1!']
+    badIdentifiers.each do |id|
+      assert_raise(OAI::IdException) do
+        @provider.get_record(:identifier => id, :metadata_prefix => 'oai_dc')
+      end
     end
   end
-  
+
   def test_no_records_match_dates_that_are_out_of_range
     assert_raise(OAI::NoMatchException) do
-      @provider.list_records(:from => Time.parse("November 2 2000"), 
+      @provider.list_records(:metadata_prefix => 'oai_dc',
+                             :from => Time.parse("November 2 2000"),
                              :until => Time.parse("November 1 2000"))
     end
   end
-  
+
   def test_no_records_match_bad_set
-    assert_raise(OAI::NoMatchException) { @provider.list_records(:set => 'unknown') }
+    assert_raise(OAI::NoMatchException) do
+      @provider.list_records(:metadata_prefix => 'oai_dc', :set => 'unknown')
+    end
   end
-  
+
 end

data/test/provider/tc_functional_tokens.rb

@@ -2,14 +2,16 @@ require 'test_helper'
 
 class ResumptionTokenFunctionalTest < Test::Unit::TestCase
   include REXML
-  
+
   def setup
     @provider = ComplexProvider.new
   end
 
   def test_resumption_tokens
-    assert_nothing_raised { Document.new(@provider.list_records) }
-    doc = Document.new(@provider.list_records)
+    assert_nothing_raised do
+      Document.new(@provider.list_records(:metadata_prefix => 'oai_dc'))
+    end
+    doc = Document.new(@provider.list_records(:metadata_prefix => 'oai_dc'))
     assert_not_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
     assert_equal 101, doc.elements["/OAI-PMH/ListRecords"].to_a.size
     token = doc.elements["/OAI-PMH/ListRecords/resumptionToken"].text
@@ -20,15 +22,18 @@ class ResumptionTokenFunctionalTest < Test::Unit::TestCase
 
   def test_from_and_until_with_resumption_tokens
     # Should return 300 records broken into 3 groups of 100.
-    assert_nothing_raised { Document.new(@provider.list_records) }
+    assert_nothing_raised do
+      Document.new(@provider.list_records(:metadata_prefix => 'oai_dc'))
+    end
     doc = Document.new(
       @provider.list_records(
+        :metadata_prefix => 'oai_dc',
         :from => Time.parse("September 1 2004"),
         :until => Time.parse("November 30 2004"))
       )
     assert_equal 101, doc.elements["/OAI-PMH/ListRecords"].to_a.size
     token = doc.elements["/OAI-PMH/ListRecords/resumptionToken"].text
-  
+
     doc = Document.new(@provider.list_records(:resumption_token => token))
     assert_not_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
     assert_equal 101, doc.elements["/OAI-PMH/ListRecords"].to_a.size
@@ -38,5 +43,5 @@ class ResumptionTokenFunctionalTest < Test::Unit::TestCase
     assert_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
     assert_equal 100, doc.elements["/OAI-PMH/ListRecords"].to_a.size
   end
-    
+
 end

data/test/provider/tc_provider.rb

@@ -13,64 +13,98 @@ class OaiTest < Test::Unit::TestCase
     assert_equal "oai:test:13900", doc.elements['OAI-PMH/Identify/description/oai-identifier/sampleIdentifier'].text
     assert_not_nil doc.elements['OAI-PMH/Identify/my_custom_xml']
   end
-  
+
   def test_list_identifiers_for_correct_xml
     doc = REXML::Document.new(@mapped_provider.list_identifiers)
+    assert_not_nil doc.elements['OAI-PMH/request']
+    assert_not_nil doc.elements['OAI-PMH/request/@verb']
     assert_not_nil doc.elements['OAI-PMH/ListIdentifiers']
     assert_not_nil doc.elements['OAI-PMH/ListIdentifiers/header']
     assert_not_nil doc.elements['OAI-PMH/ListIdentifiers/header/identifier']
     assert_not_nil doc.elements['OAI-PMH/ListIdentifiers/header/datestamp']
     assert_not_nil doc.elements['OAI-PMH/ListIdentifiers/header/setSpec']
   end
-  
+
   def test_list_records_for_correct_xml
-    doc = REXML::Document.new(@mapped_provider.list_records)
+    doc = REXML::Document.new(
+      @mapped_provider.list_records(:metadata_prefix => 'oai_dc'))
+    assert_not_nil doc.elements['OAI-PMH/request']
+    assert_not_nil doc.elements['OAI-PMH/request/@verb']
+    assert_not_nil doc.elements['OAI-PMH/request/@metadata_prefix']
     assert_not_nil doc.elements['OAI-PMH/ListRecords/record/header']
     assert_not_nil doc.elements['OAI-PMH/ListRecords/record/metadata']
   end
-  
+
   def test_mapped_source
-    assert_nothing_raised { REXML::Document.new(@mapped_provider.list_records) }
-    doc = REXML::Document.new(@mapped_provider.list_records)
+    assert_nothing_raised do
+      REXML::Document.new(
+        @mapped_provider.list_records(:metadata_prefix => 'oai_dc'))
+    end
+    doc = REXML::Document.new(
+      @mapped_provider.list_records(:metadata_prefix => 'oai_dc'))
     assert_equal "title_0", doc.elements['OAI-PMH/ListRecords/record/metadata/oai_dc:dc/dc:creator'].text
     assert_equal "creator_0", doc.elements['OAI-PMH/ListRecords/record/metadata/oai_dc:dc/dc:title'].text
     assert_equal "tag_0", doc.elements['OAI-PMH/ListRecords/record/metadata/oai_dc:dc/dc:subject'].text
   end
-  
+
   def test_from
-    assert_nothing_raised { REXML::Document.new(@big_provider.list_records) }
+    assert_nothing_raised do
+      REXML::Document.new(
+        @big_provider.list_records(:metadata_prefix => 'oai_dc'))
+    end
     doc = REXML::Document.new(
-      @big_provider.list_records(:from => Time.parse("February 1 2001"))
-      )
+      @big_provider.list_records(
+        :metadata_prefix => 'oai_dc',
+        :from => Time.parse("February 1 2001"))
+    )
     assert_equal 100, doc.elements['OAI-PMH/ListRecords'].to_a.size
 
     doc = REXML::Document.new(
-      @big_provider.list_records(:from => Time.parse("January 1 2001"))
-      )
+      @big_provider.list_records(
+        :metadata_prefix => 'oai_dc',
+        :from => Time.parse("January 1 2001"))
+    )
     assert_equal 200, doc.elements['OAI-PMH/ListRecords'].to_a.size
   end
-  
+
   def test_until
-    assert_nothing_raised { REXML::Document.new(@big_provider.list_records) }
+    assert_nothing_raised do
+      REXML::Document.new(
+        @big_provider.list_records(:metadata_prefix => 'oai_dc'))
+    end
     doc = REXML::Document.new(
-      @big_provider.list_records(:until => Time.parse("November 1 2000"))
-      )
+      @big_provider.list_records(
+        :metadata_prefix => 'oai_dc', :until => Time.parse("November 1 2000"))
+    )
     assert_equal 100, doc.elements['OAI-PMH/ListRecords'].to_a.size
   end
-  
+
   def test_from_and_until
-    assert_nothing_raised { REXML::Document.new(@big_provider.list_records) }
+    assert_nothing_raised do
+      REXML::Document.new(
+        @big_provider.list_records(:metadata_prefix => 'oai_dc'))
+    end
     doc = REXML::Document.new(
-      @big_provider.list_records(:from => Time.parse("November 1 2000"),
+      @big_provider.list_records(
+        :metadata_prefix => 'oai_dc',
+        :from => Time.parse("November 1 2000"),
         :until => Time.parse("November 30 2000"))
-      )
+    )
+
+    assert_not_nil doc.elements['OAI-PMH/request']
+    assert_not_nil doc.elements['OAI-PMH/request/@verb']
+    assert_not_nil doc.elements['OAI-PMH/request/@from']
+    assert_not_nil doc.elements['OAI-PMH/request/@until']
+
     assert_equal 100, doc.elements['OAI-PMH/ListRecords'].to_a.size
 
     doc = REXML::Document.new(
-      @big_provider.list_records(:from => Time.parse("December 1 2000"),
-      :until => Time.parse("December 31 2000"))
-      )
+      @big_provider.list_records(
+        :metadata_prefix => 'oai_dc',
+        :from => Time.parse("December 1 2000"),
+        :until => Time.parse("December 31 2000"))
+    )
     assert_equal 100, doc.elements['OAI-PMH/ListRecords'].to_a.size
   end
-        
+
 end