oai_talia 0.0.13

data/test/activerecord_provider/helpers/providers.rb

@@ -0,0 +1,44 @@
+require 'active_record'
+require 'oai'
+require "config/connection.rb"
+
+Dir.glob(File.dirname(__FILE__) + "/../models/*.rb").each do |lib|
+  require lib
+end
+
+class ARProvider < OAI::Provider::Base
+  repository_name 'ActiveRecord Based Provider'
+  repository_url 'http://localhost'
+  record_prefix 'oai:test'
+  source_model ActiveRecordWrapper.new(DCField)
+end
+
+class SimpleResumptionProvider < OAI::Provider::Base
+  repository_name 'ActiveRecord Resumption Provider'
+  repository_url 'http://localhost'
+  record_prefix 'oai:test'
+  source_model ActiveRecordWrapper.new(DCField, :limit => 25)
+end
+
+class CachingResumptionProvider < OAI::Provider::Base
+  repository_name 'ActiveRecord Caching Resumption Provider'
+  repository_url 'http://localhost'
+  record_prefix 'oai:test'
+  source_model ActiveRecordCachingWrapper.new(DCField, :limit => 25)
+end
+  
+
+class ARLoader
+  def self.load
+    fixtures = YAML.load_file(
+      File.join(File.dirname(__FILE__), '..', 'fixtures', 'dc.yml')
+    )
+    fixtures.keys.sort.each do |key|
+      DCField.create(fixtures[key])
+    end
+  end
+  
+  def self.unload
+    DCField.delete_all
+  end
+end

data/test/activerecord_provider/helpers/set_provider.rb

@@ -0,0 +1,36 @@
+# Extend ActiveRecordModel to support sets
+class SetModel < OAI::Provider::ActiveRecordWrapper
+  
+  # Return all available sets
+  def sets
+    DCSet.find(:all)
+  end
+
+  # Scope the find to a set relation if we get a set in the options    
+  def find(selector, opts={})
+    if opts[:set]
+      set = DCSet.find_by_spec(opts.delete(:set))
+      conditions = sql_conditions(opts)
+
+      if :all == selector
+        set.dc_fields.find(selector, :conditions => conditions)
+      else
+        set.dc_fields.find(selector, :conditions => conditions)
+      end
+    else
+      if :all == selector
+        model.find(selector, :conditions => sql_conditions(opts))
+      else
+        model.find(selector, :conditions => sql_conditions(opts))
+      end
+    end
+  end
+        
+end
+
+class ARSetProvider < OAI::Provider::Base
+  repository_name 'ActiveRecord Set Based Provider'
+  repository_url 'http://localhost'
+  record_prefix = 'oai:test'
+  source_model SetModel.new(DCField, :timestamp_field => 'date')
+end

data/test/activerecord_provider/models/dc_field.rb

@@ -0,0 +1,7 @@
+class DCField < ActiveRecord::Base
+  set_inheritance_column 'DONOTINHERIT'
+  has_and_belongs_to_many :sets, 
+    :join_table => "dc_fields_dc_sets", 
+    :foreign_key => "dc_field_id", 
+    :class_name => "DCSet"
+end

data/test/activerecord_provider/models/dc_set.rb

@@ -0,0 +1,6 @@
+class DCSet < ActiveRecord::Base
+  has_and_belongs_to_many :dc_fields, 
+    :join_table => "dc_fields_dc_sets", 
+    :foreign_key => "dc_set_id",
+    :class_name => "DCField"
+end

data/test/activerecord_provider/models/oai_token.rb

@@ -0,0 +1,3 @@
+class OaiToken < ActiveRecord::Base
+  serialize :params
+end

data/test/activerecord_provider/tc_ar_provider.rb

@@ -0,0 +1,113 @@
+require 'test_helper'
+
+class ActiveRecordProviderTest < Test::Unit::TestCase
+
+  def test_identify
+    assert @provider.identify =~ /ActiveRecord Based Provider/
+  end
+  
+  def test_metadata_formats
+    assert_nothing_raised { REXML::Document.new(@provider.list_metadata_formats) }
+    doc =  REXML::Document.new(@provider.list_metadata_formats)
+    assert doc.elements['/OAI-PMH/ListMetadataFormats/metadataFormat/metadataPrefix'].text == 'oai_dc'
+  end
+  
+  def test_metadata_formats_for_record
+    record_id = DCField.find(:first).id
+    assert_nothing_raised { REXML::Document.new(@provider.list_metadata_formats(:identifier => "oai:test/#{record_id}")) }
+    doc =  REXML::Document.new(@provider.list_metadata_formats)
+    assert doc.elements['/OAI-PMH/ListMetadataFormats/metadataFormat/metadataPrefix'].text == 'oai_dc'
+  end
+  
+  def test_list_records
+    assert_nothing_raised { REXML::Document.new(@provider.list_records(:metadata_prefix => 'oai_dc')) }
+    doc = REXML::Document.new(@provider.list_records(:metadata_prefix => 'oai_dc'))
+    assert_equal 100, doc.elements['OAI-PMH/ListRecords'].to_a.size
+  end
+
+  def test_list_identifiers
+    assert_nothing_raised { REXML::Document.new(@provider.list_identifiers(:metadata_prefix => 'oai_dc')) }
+    doc = REXML::Document.new(@provider.list_identifiers(:metadata_prefix => 'oai_dc'))
+    assert_equal 100, doc.elements['OAI-PMH/ListIdentifiers'].to_a.size
+  end
+
+  def test_get_record
+    record_id = DCField.find(:first).id
+    assert_nothing_raised { REXML::Document.new(@provider.get_record(:identifier => "oai:test/#{record_id}", :metadata_prefix => 'oai_dc')) }
+    doc = REXML::Document.new(@provider.get_record(:identifier => "#{record_id}", :metadata_prefix => 'oai_dc'))
+    assert_equal "oai:test/#{record_id}", doc.elements['OAI-PMH/GetRecord/record/header/identifier'].text
+  end
+  
+  def test_deleted
+    record = DCField.find(:first)
+    record.deleted = true;
+    record.save
+    doc = REXML::Document.new(@provider.get_record(:identifier => "oai:test/#{record.id}", :metadata_prefix => 'oai_dc'))
+    assert_equal "oai:test/#{record.id}", doc.elements['OAI-PMH/GetRecord/record/header/identifier'].text
+    assert_equal 'deleted', doc.elements['OAI-PMH/GetRecord/record/header'].attributes["status"]
+  end
+  
+  def test_from
+    first_id = DCField.find(:first, :order => "id asc").id
+    DCField.update_all(['updated_at = ?', Time.parse("January 1 2005")],
+      "id < #{first_id + 90}")
+    DCField.update_all(['updated_at = ?', Time.parse("June 1 2005")],
+      "id < #{first_id + 10}")
+    
+    from_param = Time.parse("January 1 2006")
+    
+    doc = REXML::Document.new(
+      @provider.list_records(:from => from_param, :metadata_prefix => 'oai_dc')
+      )
+    assert_equal DCField.find(:all, :conditions => ["updated_at >= ?", from_param]).size, 
+      doc.elements['OAI-PMH/ListRecords'].size
+
+    doc = REXML::Document.new(
+      @provider.list_records(:from => Time.parse("May 30 2005"), :metadata_prefix => 'oai_dc')
+      )
+    assert_equal 20, doc.elements['OAI-PMH/ListRecords'].to_a.size
+  end
+  
+  def test_until
+    first_id = DCField.find(:first, :order => "id asc").id
+    DCField.update_all(['updated_at = ?', Time.parse("June 1 2005")],
+      "id < #{first_id + 10}")
+
+    doc = REXML::Document.new(
+      @provider.list_records(:until => Time.parse("June 1 2005"), :metadata_prefix => 'oai_dc')
+      )
+    assert_equal 10, doc.elements['OAI-PMH/ListRecords'].to_a.size
+  end
+  
+  def test_from_and_until
+    first_id = DCField.find(:first, :order => "id asc").id
+    DCField.update_all(['updated_at = ?', Time.parse("June 1 2005")])
+    DCField.update_all(['updated_at = ?', Time.parse("June 15 2005")],
+      "id < #{first_id + 50}")
+    DCField.update_all(['updated_at = ?', Time.parse("June 30 2005")],
+      "id < #{first_id + 10}")
+
+    doc = REXML::Document.new(
+      @provider.list_records(:from => Time.parse("June 3 2005"),
+        :until => Time.parse("June 16 2005"), :metadata_prefix => 'oai_dc')
+      )
+    assert_equal 40, doc.elements['OAI-PMH/ListRecords'].to_a.size
+  end
+  
+  def test_bad_identifier_raises_correct_exception
+    assert_raise(OAI::IdException) do
+      @provider.get_record( :identifier => "fjsdklf",
+                            :metadataPrefix => "oai_dc")
+    end
+  end
+
+  def setup
+    @provider = ARProvider.new
+    ARLoader.load
+  end
+  
+  def teardown
+    ARLoader.unload
+  end
+  
+end

data/test/activerecord_provider/tc_ar_sets_provider.rb

@@ -0,0 +1,72 @@
+require 'test_helper'
+
+class ActiveRecordSetProviderTest < Test::Unit::TestCase
+
+  def test_list_sets
+    doc = REXML::Document.new(@provider.list_sets)
+    sets = doc.elements["/OAI-PMH/ListSets"]
+    assert sets.size == 4
+    assert sets[0].elements["//setName"].text == "Set A"
+  end
+  
+  def test_set_a
+    doc = REXML::Document.new(@provider.list_records(:set => "A", :metadata_prefix => 'oai_dc'))
+    assert_equal 20, doc.elements['OAI-PMH/ListRecords'].to_a.size
+  end
+  
+  def test_set_b
+    doc = REXML::Document.new(@provider.list_records(:set => "B", :metadata_prefix => 'oai_dc'))
+    assert_equal 10, doc.elements['OAI-PMH/ListRecords'].to_a.size
+  end
+  
+  def test_set_ab
+    doc = REXML::Document.new(@provider.list_records(:set => "A:B", :metadata_prefix => 'oai_dc'))
+    assert_equal 10, doc.elements['OAI-PMH/ListRecords'].to_a.size
+  end
+  
+  def test_record_with_multiple_sets
+    record = DCSet.find(:first, :conditions => "spec = 'C'").dc_fields.first
+    assert_equal 2, record.sets.size
+  end
+
+  def setup
+    @provider = ARSetProvider.new
+    ARLoader.load
+    define_sets
+  end
+
+  def teardown
+    ARLoader.unload
+    DCSet.connection.execute("delete from dc_fields_dc_sets")
+    DCSet.delete_all
+  end
+
+  def define_sets
+    set_a = DCSet.create(:name => "Set A", :spec => "A")
+    set_b = DCSet.create(:name => "Set B", :spec => "B")
+    set_c = DCSet.create(:name => "Set C", :spec => "C")
+    set_ab = DCSet.create(:name => "Set A:B", :spec => "A:B")
+  
+    next_id = 0
+    DCField.find(:all, :limit => 10, :order => "id asc").each do |record|
+      set_a.dc_fields << record
+      next_id = record.id
+    end
+    
+    DCField.find(:all, :limit => 10, :order => "id asc", :conditions => "id > #{next_id}").each do |record|
+      set_b.dc_fields << record
+      next_id = record.id
+    end
+
+    DCField.find(:all, :limit => 10, :order => "id asc", :conditions => "id > #{next_id}").each do |record|
+      set_ab.dc_fields << record
+      next_id = record.id
+    end
+  
+    DCField.find(:all, :limit => 10, :order => "id asc", :conditions => "id > #{next_id}").each do |record|
+      set_a.dc_fields << record
+      set_c.dc_fields << record
+      next_id = record.id
+    end
+  end
+end

data/test/activerecord_provider/tc_caching_paging_provider.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+
+class CachingPagingProviderTest < Test::Unit::TestCase
+  include REXML
+  
+  def test_full_harvest
+    doc = Document.new(@provider.list_records(:metadata_prefix => 'oai_dc'))
+    assert_not_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
+    assert_equal 26, doc.elements["/OAI-PMH/ListRecords"].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"]
+    token = doc.elements["/OAI-PMH/ListRecords/resumptionToken"].text
+    assert_equal 26, doc.elements["/OAI-PMH/ListRecords"].size
+    doc = Document.new(@provider.list_records(:resumption_token => token))
+    assert_not_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
+    token = doc.elements["/OAI-PMH/ListRecords/resumptionToken"].text
+    assert_equal 26, doc.elements["/OAI-PMH/ListRecords"].size
+    doc = Document.new(@provider.list_records(:resumption_token => token))
+    assert_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
+    assert_equal 25, doc.elements["/OAI-PMH/ListRecords"].size
+  end
+  
+  def test_from_and_until
+    first_id = DCField.find(:first, :order => "id asc").id
+    DCField.update_all(['updated_at = ?', Time.parse("September 15 2005")],
+      "id <= #{first_id + 25}")
+    DCField.update_all(['updated_at = ?', Time.parse("November 1 2005")],
+      "id < #{first_id + 50} and id > #{first_id + 25}")
+
+    # Should return 50 records broken into 2 groups of 25.
+    doc = Document.new(
+      @provider.list_records(
+        :from => Time.parse("September 1 2005"),
+        :until => Time.parse("November 30 2005"),
+        :metadata_prefix => 'oai_dc')
+      )
+    assert_equal 26, doc.elements["/OAI-PMH/ListRecords"].size
+    token = doc.elements["/OAI-PMH/ListRecords/resumptionToken"].text
+    assert_not_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
+    doc = Document.new(@provider.list_records(:resumption_token => token))
+    assert_equal 25, doc.elements["/OAI-PMH/ListRecords"].size
+    assert_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
+  end
+
+  def setup
+    @provider = CachingResumptionProvider.new
+    ARLoader.load
+  end
+  
+  def teardown
+    ARLoader.unload
+  end
+  
+end

data/test/activerecord_provider/tc_simple_paging_provider.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+class SimpleResumptionProviderTest < Test::Unit::TestCase
+  include REXML
+  
+  def test_full_harvest
+    doc = Document.new(@provider.list_records(:metadata_prefix => 'oai_dc'))
+    assert_not_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
+    assert_equal 26, 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"]
+    token = doc.elements["/OAI-PMH/ListRecords/resumptionToken"].text
+    assert_equal 26, doc.elements["/OAI-PMH/ListRecords"].to_a.size
+    doc = Document.new(@provider.list_records(:resumption_token => token))
+    assert_not_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
+    token = doc.elements["/OAI-PMH/ListRecords/resumptionToken"].text
+    assert_equal 26, doc.elements["/OAI-PMH/ListRecords"].to_a.size
+    doc = Document.new(@provider.list_records(:resumption_token => token))
+    assert_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
+    assert_equal 25, doc.elements["/OAI-PMH/ListRecords"].to_a.size
+  end
+  
+  def test_from_and_until
+    first_id = DCField.find(:first, :order => "id asc").id
+    DCField.update_all(['updated_at = ?', Time.parse("September 15 2005")],
+      "id < #{first_id + 25}")
+    DCField.update_all(['updated_at = ?', Time.parse("November 1 2005")],
+      "id <= #{first_id + 50} and id > #{first_id + 25}")
+    
+    total = DCField.count(:id, :conditions => ["updated_at >= ? AND updated_at <= ?", Time.parse("September 1 2005"), Time.parse("November 30 2005")])
+
+    # Should return 50 records broken into 2 groups of 25.
+    doc = Document.new(
+      @provider.list_records(
+        :from => Time.parse("September 1 2005"),
+        :until => Time.parse("November 30 2005"),
+		:metadata_prefix => 'oai_dc')
+      )
+    assert_equal 26, doc.elements["/OAI-PMH/ListRecords"].to_a.size
+    assert_not_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
+    token = doc.elements["/OAI-PMH/ListRecords/resumptionToken"].text
+    doc = Document.new(@provider.list_records(:resumption_token => token))
+    assert_equal 25, doc.elements["/OAI-PMH/ListRecords"].to_a.size
+    assert_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
+  end
+
+  def setup
+    @provider = SimpleResumptionProvider.new
+    ARLoader.load
+  end
+  
+  def teardown
+    ARLoader.unload
+  end
+  
+end

data/test/activerecord_provider/test_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'test/unit'
+require File.dirname(__FILE__) + '/helpers/providers'
+require File.dirname(__FILE__) + '/helpers/set_provider'

data/test/client/helpers/provider.rb

@@ -0,0 +1,68 @@
+require 'webrick'
+require File.dirname(__FILE__) + '/../../provider/models'
+
+class ComplexProvider < OAI::Provider::Base
+  repository_name 'Complex Provider'
+  repository_url 'http://localhost'
+  record_prefix 'oai:test'
+  source_model ComplexModel.new(100)
+end
+
+class ProviderServer < WEBrick::HTTPServlet::AbstractServlet
+  @@server = nil
+  
+  def initialize(server)
+    super(server)
+    @provider = ComplexProvider.new
+  end
+  
+  def do_GET(req, res)
+    begin
+      res.body = @provider.process_request(req.query)
+      res.status = 200
+      res['Content-Type'] = 'text/xml'
+    rescue => err
+      puts err
+      puts err.backtrace.join("\n")
+      res.body = err.backtrace.join("\n")
+      res.status = 500
+    end
+  end
+  
+  def self.start(port)
+    unless @@server
+      @@server = WEBrick::HTTPServer.new(
+        :BindAddress => '127.0.0.1', 
+        :Logger => WEBrick::Log.new('/dev/null'),
+        :AccessLog => [],
+        :Port => port)
+      @@server.mount("/oai", ProviderServer)
+
+      trap("INT") { @@server.shutdown }
+      @@thread = Thread.new { @@server.start }
+      puts "Starting Webrick/Provider on port[#{port}]"
+    end
+  end
+  
+  def self.stop
+    puts "Stopping Webrick/Provider"
+    if @@thread
+      @@thread.exit
+    end
+  end
+  
+  def self.wrap(port = 3333)
+    begin
+      start(port)
+
+      # Wait for startup
+      sleep 2
+    
+      yield
+
+    ensure
+      stop
+    end
+  end
+  
+end

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_not_found
+    client = OAI::Client.new 'http://www.google.com'
+    assert_raises(ArgumentError) { 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/client/tc_get_record.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+class GetRecordTest < Test::Unit::TestCase
+  
+  def test_get_one
+    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:test/3', 
+      response.record.header.identifier
+
+    # minimal check that the metadata is working
+    #assert 'en', response.record.metadata.elements['.//dc:language'].text
+  end
+
+  def test_missing_identifier
+    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'
+    rescue OAI::Exception => e
+      assert_match /The request includes illegal arguments/, e.to_s
+    end
+  end
+
+  def test_deleted_record
+    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/client/tc_libxml.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+class LibXMLTest < Test::Unit::TestCase
+
+  def test_oai_exception
+    return unless have_libxml
+
+    uri = 'http://localhost:3333/oai'
+    client = OAI::Client.new uri, :parser => 'libxml'
+    assert_raises(OAI::Exception) {client.get_record(:identifier => 'nosuchid')}
+  end
+
+  def test_list_records
+    return unless have_libxml
+
+    # 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://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 if record.deleted?
+        assert_kind_of LibXML::XML::Node, record.metadata
+      end
+    end
+  end
+
+  def test_deleted_record
+    return unless have_libxml
+
+    uri = 'http://localhost:3333/oai'
+    client = OAI::Client.new(uri, :parser => 'libxml')
+    response = client.get_record :identifier => 'oai:test/275'
+    assert response.record.deleted?
+  end
+  
+  private
+
+  def have_libxml
+    begin
+      require 'xml/libxml'
+      return true
+    rescue LoadError
+      return false
+    end
+  end
+
+end