oai 0.4.0 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 87d0fab6e4343a4b7523ee0559687d2490862932
-  data.tar.gz: 69a74965ef7b9176408befe11bf4a9a9b4e49a74
+SHA256:
+  metadata.gz: a21ec21fadefca115987b42ef91f851406c9893ca6f0efc4bd2a1dfa71282514
+  data.tar.gz: c3ef94d3b809c4cba4d3ea0a02cfc9cc2db370eadc86f06ea3d259b0e4f8571b
 SHA512:
-  metadata.gz: cf7096a011a58d7e37d740d29e0a35195895909356d49af641f9ad80b6e9df2b496da039404371a7a8ab11943e725887b6d251ed804f81a17dd0b3ca1cefac98
-  data.tar.gz: bdac7716fa083f23cb622b5f6a2b64068b1047322728ce88dd40c37be6596cd12b64511a4e92ebaf8db846ff8f7f868b66f974557fe003ba07a6154bdd0b5b1c
+  metadata.gz: b6eba80e5c7c3b2b1ea7512b316796217fbeb45ebf11ec33b22d61790587b84f8a4c78db669eec9bbc38980c6b8a33dd59de3b3f4d5861010aea0c3f737c3c02
+  data.tar.gz: bb188698b9e5e5eddb1df8c87db491e312396547e3a8179ee1d4720c96aa4567391e602b93c4f2c33aa28c33134dda585035884e1c0a5f333b34b02f8071ed35

data/README.md

@@ -1,17 +1,21 @@
 ruby-oai
 ========
 
+[![Build Status](https://travis-ci.org/code4lib/ruby-oai.svg?branch=master)](https://travis-ci.org/code4lib/ruby-oai)
+
+[![Gem Version](https://badge.fury.io/rb/kithe.svg)](https://badge.fury.io/rb/oai)
+
 ruby-oai is a Open Archives Protocol for Metadata Harvesting (OAI-PMH)
-library for Ruby. [OAI-PMH](http://openarchives.org) is a somewhat 
-archaic protocol for sharing metadata between digital library repositories. 
+library for Ruby. [OAI-PMH](http://openarchives.org) is a somewhat
+archaic protocol for sharing metadata between digital library repositories.
 If you are looking to share metadata on the web you are probably better off
-using a feed format like [RSS](http://www.rssboard.org/rss-specification) or 
-[Atom](http://www.atomenabled.org/). If have to work with a backwards 
-digital repository that only offers OAI-PMH access then ruby-oai is your 
+using a feed format like [RSS](http://www.rssboard.org/rss-specification) or
+[Atom](http://www.atomenabled.org/). If have to work with a backwards
+digital repository that only offers OAI-PMH access then ruby-oai is your
 friend.
 
-The [OAI-PMH](http://openarchives.org) spec defines six verbs 
-(`Identify`, `ListIdentifiers`, `ListRecords`, 
+The [OAI-PMH](http://openarchives.org) spec defines six verbs
+(`Identify`, `ListIdentifiers`, `ListRecords`,
 `GetRecords`, `ListSets`, `ListMetadataFormat`) used for discovery and sharing of
 metadata.
 
@@ -21,7 +25,7 @@ a interactive harvesting shell.
 Client
 ------
 
-The OAI client library is used for harvesting metadata from repositories. 
+The OAI client library is used for harvesting metadata from repositories.
 For example to initiate a ListRecords request to pubmed you can:
 
 ```ruby
@@ -29,7 +33,7 @@ For example to initiate a ListRecords request to pubmed you can:
   client = OAI::Client.new 'http://www.pubmedcentral.gov/oai/oai.cgi', :headers => { "From" => "oai@example.com" }
   response = client.list_records
   # Get the first page of records
-  response.each do |record| 
+  response.each do |record|
     puts record.metadata
   end
   # Get the second page of records
@@ -60,7 +64,7 @@ The OAI provider library handles serving local content to other clients. Here's
   end
 ```
 
-See {OAI::Provider} for more details
+See comment docs at top of [OAI::Provider](./lib/oai/provider.rb) for more details, including discussion of the `OAI::Provider::ActiveRecordWrapper` class for quich setup of an OAI provider for an ActiveRecord model class (single database table)
 
 Interactive Harvester
 ---------------------
@@ -81,6 +85,28 @@ Alternately it can be installed globally using RubyGems:
 
     $ gem install oai
 
+Running tests
+-------------
+
+Tests are with Test::Unit, in a somewhat archaic/legacy style. Test setup especially is not how we would do things today. Run all tests with:
+
+    $ bundle exec rake test
+
+There are also convenience tasks to run subsets of tests.
+
+We use [appraisal](https://github.com/thoughtbot/appraisal) to test ActiveRecord-related functionality under multiple versions of ActiveRecord. While the above commands will test with latest ActiveRecord (allowed in our .gemspec development dependency), you can test under a particular version defined in the [Appraisals](./Appraisals) file like so:
+
+    $ bundle exec appraisal rails-52 rake test
+    $ bundle exec appraisal rails-60 rake test
+
+If you run into trouble with appraisal's gemfiles getting out of date and bundler complaining,
+try:
+
+   $ bundle exec appraisal clean
+   $ appraisal generate
+
+That may make changes to appraisal gemfiles that you should commit to repo.
+
 License
 -------
 

data/Rakefile

@@ -14,73 +14,40 @@ require 'yard'
 
 task :default => ["test", "yard"]
 
-task :test => ["test:client", "test:provider", "test:activerecord_provider"]
+Rake::TestTask.new('test') do |t|
+  t.description = "Run all Test::Unit tests"
 
+  t.libs << ['lib', 'test/client', 'test/provider', 'test/activerecord_provider']
+
+  t.pattern = 'test/{client,provider,activerecord_provider}/tc_*.rb'
+  #t.verbose = true
+  t.warning = false
+end
+
+
+# To run just subsets of tests
 namespace :test do
   Rake::TestTask.new('client') do |t|
     t.libs << ['lib', 'test/client']
     t.pattern = 'test/client/tc_*.rb'
-    t.verbose = true
+    #t.verbose = true
+    t.warning = false
   end
 
   Rake::TestTask.new('provider') do |t|
     t.libs << ['lib', 'test/provider']
     t.pattern = 'test/provider/tc_*.rb'
-    t.verbose = true
+    #t.verbose = true
+    t.warning = false
   end
 
-  desc "Active Record base Provider Tests"
   Rake::TestTask.new('activerecord_provider') do |t|
+    t.description = "Active Record base Provider Tests"
+
     t.libs << ['lib', 'test/activerecord_provider']
     t.pattern = 'test/activerecord_provider/tc_*.rb'
-    t.verbose = true
-  end
-
-  desc 'Measures test coverage'
-  # borrowed from here: http://clarkware.com/cgi/blosxom/2007/01/05#RcovRakeTask
-  task :coverage do
-    rm_f "coverage"
-    rm_f "coverage.data"
-    if RUBY_VERSION =~ /^1.8/
-      Rake::Task['rcov:client'].invoke
-      Rake::Task['rcov:provider'].invoke
-      Rake::Task['rcov:activerecord_provider'].invoke
-    else
-      ENV['COVERAGE'] = 'true'
-      Rake::Task['test:client'].invoke
-      Rake::Task['test:provider'].invoke
-      Rake::Task['test:activerecord_provider'].invoke
-    end
-
-    system("open coverage/index.html") if (PLATFORM['darwin'] if Kernel.const_defined? :PLATFORM) || (RUBY_PLATFORM =~ /darwin/ if Kernel.const_defined? :RUBY_PLATFORM)
-  end
-
-end
-
-if RUBY_VERSION =~ /^1.8/
-  require 'rcov/rcovtask'
-  namespace :rcov do
-    Rcov::RcovTask.new do |t|
-      t.name = 'client'
-      t.libs << ['lib', 'test/client']
-      t.pattern = 'test/client/tc_*.rb'
-      t.verbose = true
-      t.rcov_opts = ['--aggregate coverage.data', '--text-summary']
-    end
-
-    Rcov::RcovTask.new('provider') do |t|
-      t.libs << ['lib', 'test/provider']
-      t.pattern = 'test/provider/tc_*.rb'
-      t.verbose = true
-      t.rcov_opts = ['--aggregate coverage.data', '--text-summary']
-    end
-
-    Rcov::RcovTask.new('activerecord_provider') do |t|
-      t.libs << ['lib', 'test/activerecord_provider']
-      t.pattern = 'test/activerecord_provider/tc_*.rb'
-      t.verbose = true
-      t.rcov_opts = ['--aggregate coverage.data', '--text-summary']
-    end
+    #t.verbose = true
+    t.warning = false
   end
 end
 

data/lib/oai/client.rb

@@ -92,11 +92,11 @@ module OAI
       @http_client = options.fetch(:http) do
         Faraday.new(:url => @base.clone) do |builder|
           follow_redirects = options.fetch(:redirects, true)
-          if follow_redirects
-            count = follow_redirects.is_a?(Fixnum) ? follow_redirects : 5
+          follow_redirects = 5 if follow_redirects == true
 
+          if follow_redirects
             require 'faraday_middleware'
-            builder.response :follow_redirects, :limit => count
+            builder.response :follow_redirects, :limit => follow_redirects.to_i
           end
           builder.adapter :net_http
         end

data/lib/oai/provider.rb

@@ -58,7 +58,9 @@ end
 #    repository_url 'http://localhost/provider'
 #    record_prefix 'oai:localhost'
 #    admin_email 'root@localhost'
-#    sample_identifier 'oai:pubmedcentral.gov:13900'
+#    # record_prefix will be automatically prepended to sample_id, so in this
+#    # case it becomes: oai:localhost:13900
+#    sample_id '13900'
 #    source_model MyModel.new
 #  end
 # ```
@@ -107,7 +109,7 @@ end
 #     record_prefix 'oai:blog'
 #     admin_email 'root@localhost'
 #     source_model OAI::Provider::ActiveRecordWrapper.new(Post)
-#     sample_identifier 'oai:pubmedcentral.gov:13900'
+#     sample_id '13900' # record prefix used, so becomes oai:blog:13900
 #   end
 # ```
 #
@@ -116,15 +118,25 @@ end
 # ```ruby
 #   class OaiController < ApplicationController
 #     def index
-#       # Remove controller and action from the options.  Rails adds them automatically.
-#       options = params.delete_if { |k,v| %w{controller action}.include?(k) }
 #       provider = BlogProvider.new
-#       response =  provider.process_request(options)
-#       render :text => response, :content_type => 'text/xml'
+#       response =  provider.process_request(oai_params.to_h)
+#       render :body => response, :content_type => 'text/xml'
+#     end
+#
+#     private
+#
+#     def oai_params
+#       params.permit(:verb, :identifier, :metadataPrefix, :set, :from, :until, :resumptionToken)
 #     end
 #   end
 # ```
 #
+# And route to it in your `config/routes.rb` file:
+#
+# ```ruby
+#    match 'oai', to: "oai#index", via: [:get, :post]
+# ```
+#
 # Special thanks to Jose Hales-Garcia for this solution.
 #
 # ## Supporting custom metadata formats
@@ -137,13 +149,19 @@ end
 # It takes one required paramater, the class name of the AR class to wrap,
 # and optional hash of options.
 #
+# As of `oai` gem 1.0.0, Rails 5.2.x and Rails 6.0.x are supported.
+# Please check the .travis.yml file at root of repo to see what versions of ruby/rails
+# are being tested, in case this is out of date.
+#
 # Valid options include:
 #
-# * `timestamp_field` - Specifies the model field to use as the update
+# * `timestamp_field` - Specifies the model field/method to use as the update
 #   filter.  Defaults to `updated_at`.
+# * `identifier_field` -- specifies the model field/method to use to get value to use
+#    as oai identifier (method return value should not include prefix)
 # * `limit` -           Maximum number of records to return in each page/set.
-#   Defaults to 100.
-#   The wrapper will paginate the result via resumption tokens.
+#   Defaults to 100, set to `nil` for all records in one page. Otherwise
+#   the wrapper will paginate the result via resumption tokens.
 #   _Caution:  specifying too large a limit will adversely affect performance._
 #
 # Mapping from a ActiveRecord object to a specific metadata format follows
@@ -197,6 +215,26 @@ end
 #    end
 #  end
 # ```
+# ### Scopes for restrictions or eager-loading
+#
+# Instead of passing in a Model class to OAI::Provider::ActiveRecordWrapper, you can actually
+# pass in any scope (or ActiveRecord::Relation). This means you can use it for restrictions:
+#
+#     OAI::Provider::ActiveRecordWrapper.new(Post.where(published: true))
+#
+# Or eager-loading an association you will need to create serialization, to avoid n+1 query
+# performance problems:
+#
+#     OAI::Provider::ActiveRecordWrapper.new(Post.includes(:categories))
+#
+# Or both of those in combination, or anything else that returns an ActiveRecord::Relation,
+# including using custom scopes, etc.
+#
+# ### Sets?
+#
+# There is some code written to support oai-pmh "sets" in the ActiveRecord::Wrapper, but
+# it's somewhat inflexible, and not well-documented, and as I write this I don't understand
+# it enough to say more. See https://github.com/code4lib/ruby-oai/issues/67
 #
 module OAI::Provider
   class Base

data/lib/oai/provider/model.rb

@@ -1,12 +1,12 @@
 module OAI::Provider
   # = OAI::Provider::Model
   #
-  # Model implementers should subclass OAI::Provider::Model and override 
+  # Model implementers should subclass OAI::Provider::Model and override
   # Model#earliest, Model#latest, and Model#find.  Optionally Model#sets and
-  # Model#deleted? can be used to support sets and record deletions.  It 
-  # is also the responsibility of the model implementer to account for 
-  # resumption tokens if support is required.  Models that don't support 
-  # resumption tokens should raise an exception if a limit is requested     
+  # Model#deleted? can be used to support sets and record deletions.  It
+  # is also the responsibility of the model implementer to account for
+  # resumption tokens if support is required.  Models that don't support
+  # resumption tokens should raise an exception if a limit is requested
   # during initialization.
   #
   # earliest - should return the earliest update time in the repository.
@@ -14,8 +14,8 @@ module OAI::Provider
   # sets - should return an array of sets supported by the repository.
   # deleted? - individual records returned should respond true or false
   # when sent the deleted? message.
-  # available_formats - if overridden, individual records should return an 
-  # array of prefixes for all formats in which that record is available, 
+  # available_formats - if overridden, individual records should return an
+  # array of prefixes for all formats in which that record is available,
   # if other than ["oai_dc"]
   # about - if overridden, should return a String or Array of XML Strings to
   # insert into the OAI Record <about> chunks.
@@ -28,12 +28,12 @@ module OAI::Provider
   # There are several helper models for dealing with resumption tokens please
   # see the ResumptionToken class for more details.
   #
-
   class Model
-    attr_reader :timestamp_field
-    
-    def initialize(limit = nil, timestamp_field = 'updated_at')
+    attr_reader :timestamp_field, :identifier_field
+
+    def initialize(limit = nil, timestamp_field = 'updated_at', identifier_field = 'id')
       @limit = limit
+      @identifier_field = identifier_field
       @timestamp_field = timestamp_field
     end
 
@@ -41,16 +41,16 @@ module OAI::Provider
     def earliest
       raise NotImplementedError.new
     end
-    
+
     # should return the latest timestamp available from this model.
     def latest
       raise NotImplementedError.new
     end
-    
+
     def sets
       nil
     end
-  
+
     # find is the core method of a model, it returns records from the model
     # bases on the parameters passed in.
     #
@@ -61,12 +61,12 @@ module OAI::Provider
     # * :from => earliest timestamp to be included in the results
     # * :until => latest timestamp to be included in the results
     # * :set => the set from which to retrieve the results
-    # * :metadata_prefix => type of metadata requested (this may be useful if 
+    # * :metadata_prefix => type of metadata requested (this may be useful if
     #                       not all records are available in all formats)
     def find(selector, options={})
       raise NotImplementedError.new
     end
-    
+
     def deleted?
       false
     end
@@ -76,5 +76,5 @@ module OAI::Provider
       nil
     end
   end
-  
+
 end

data/lib/oai/provider/model/activerecord_caching_wrapper.rb

@@ -90,17 +90,16 @@ module OAI::Provider
     # select a subset of the result set, and return it with a
     # resumption token to get the next subset
     def select_partial(token)
-      if 0 == token.last
-        oaitoken = OaiToken.find_or_create_by(token: token.to_s)
-        if oaitoken.new_record_before_save?
-          OaiToken.connection.execute("insert into " +
-            "#{OaiEntry.table_name} (oai_token_id, record_id) " +
-            "select #{oaitoken.id}, id from #{model.table_name} where " +
-            "#{OaiToken.sanitize_sql(token_conditions(token))}")
-        end
+      oaitoken = OaiToken.find_by(token: token.to_s)
+
+      if 0 == token.last && oaitoken.nil?
+        oaitoken = OaiToken.create!(token: token.to_s)
+        OaiToken.connection.execute("insert into " +
+          "#{OaiEntry.table_name} (oai_token_id, record_id) " +
+          "select #{oaitoken.id}, id from #{model.table_name} where " +
+          "#{OaiToken.sanitize_sql(token_conditions(token))}")
       end
 
-      oaitoken = OaiToken.find_by_token(token.to_s)
       raise ResumptionTokenException.new unless oaitoken
 
       PartialResult.new(
@@ -111,7 +110,7 @@ module OAI::Provider
     end
 
     def sweep_cache
-      OaiToken.destroy_all(["created_at < ?", Time.now - expire])
+      OaiToken.where(["created_at < ?", Time.now - expire]).destroy_all
     end
 
     def hydrate_records(records)

data/lib/oai/provider/model/activerecord_wrapper.rb

@@ -10,12 +10,19 @@ module OAI::Provider
   #
   class ActiveRecordWrapper < Model
 
-    attr_reader :model, :timestamp_field
-
+    attr_reader :model, :timestamp_field, :identifier_field
+
+    # If custom 'timestamp_field' is used, be aware this will be an ActiveRecord
+    # attribute that we will limit on, so perhaps should be indexe appropriately.
+    #
+    # If custom `identifier_field` is used, be aware this will be an ActiveRecord
+    # attribute that we will sort on, and use in WHERE clauses with `=` as well as
+    # greater than/less than, so should be indexed appropriately.
     def initialize(model, options={})
       @model = model
       @timestamp_field = options.delete(:timestamp_field) || 'updated_at'
-      @limit = options.delete(:limit)
+      @identifier_field = options.delete(:identifier_field) || model.primary_key || "id"
+      @limit = options.delete(:limit) || 100
 
       unless options.empty?
         raise ArgumentError.new(
@@ -54,7 +61,7 @@ module OAI::Provider
           find_scope.where(conditions)
         end
       else
-        find_scope.where(conditions).find(selector)
+        find_scope.where(conditions).find_by!(identifier_field => selector)
       end
     end
 
@@ -105,7 +112,7 @@ module OAI::Provider
         model.where(set: options[:set])
       else
         # Default to empty set, as we've tried everything else
-        model.scoped(:limit => 0)
+        model.none
       end
     end
 
@@ -129,7 +136,7 @@ module OAI::Provider
       else # end of result set
         find_scope.where(token_conditions(token))
           .limit(@limit)
-          .order("#{model.primary_key} asc")
+          .order("#{identifier_field} asc")
       end
     end
 
@@ -138,9 +145,9 @@ module OAI::Provider
     def select_partial(find_scope, token)
       records = find_scope.where(token_conditions(token))
         .limit(@limit)
-        .order("#{model.primary_key} asc")
+        .order("#{identifier_field} asc")
       raise OAI::ResumptionTokenException.new unless records
-      offset = records.last.send(model.primary_key.to_sym)
+      offset = records.last.send(identifier_field)
 
       PartialResult.new(records, token.next(offset))
     end
@@ -157,7 +164,7 @@ module OAI::Provider
 
       return sql if 0 == last
       # Now add last id constraint
-      sql.first << " AND #{model.primary_key} > :id"
+      sql.first << " AND #{identifier_field} > :id"
       sql.last[:id] = last
 
       return sql

data/lib/oai/provider/response.rb

@@ -51,7 +51,7 @@ module OAI
       }
     end
     def extract_identifier(id)
-      id.sub("#{provider.prefix}/", '')
+      id.sub("#{provider.prefix}:", '')
     end
 
     def valid?

data/lib/oai/provider/response/record_response.rb

@@ -48,8 +48,9 @@ module OAI::Provider::Response
 
     private
 
+    # Namespace syntax suggested in http://www.openarchives.org/OAI/2.0/guidelines-oai-identifier.htm
     def identifier_for(record)
-      "#{provider.prefix}/#{record.id}"
+      "#{provider.prefix}:#{record.send( provider.model.identifier_field )}"
     end
 
     def timestamp_for(record)

data/test/activerecord_provider/config/connection.rb

@@ -3,7 +3,24 @@ require 'logger'
 
 # Configure AR connection
 #ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+if RUBY_PLATFORM == "java"
+  require 'jdbc/sqlite3'
+  Jdbc::SQLite3.load_driver
+end
+
 ActiveRecord::Migration.verbose = false
 ActiveRecord::Base.establish_connection :adapter => "sqlite3",
                                         :database => ":memory:"
-ActiveRecord::Migrator.up File.join(File.dirname(__FILE__), '..', 'database')
+
+if ActiveRecord.version < Gem::Version.new("6.0.0")
+  ActiveRecord::MigrationContext.new(
+    File.join(File.dirname(__FILE__), '..', 'database')
+  ).migrate
+else
+  ActiveRecord::MigrationContext.new(
+    File.join(File.dirname(__FILE__), '..', 'database'),
+    ActiveRecord::Base.connection.schema_migration
+  ).migrate
+end
+

data/test/activerecord_provider/database/0001_oaipmh_tables.rb

@@ -1,4 +1,4 @@
-class OaipmhTables < ActiveRecord::Migration
+class OaipmhTables < ActiveRecord::Migration[5.2]
   def self.up
     create_table :oai_tokens do |t|
       t.column :token,      :string,  :null => false

data/test/activerecord_provider/helpers/providers.rb

@@ -12,6 +12,22 @@ class ARProvider < OAI::Provider::Base
   source_model ActiveRecordWrapper.new(DCField)
 end
 
+class ARProviderCustomIdentifierField < OAI::Provider::Base
+  repository_name 'ActiveRecord Based Provider'
+  repository_url 'http://localhost'
+  record_prefix 'oai:test'
+  source_model ActiveRecordWrapper.new(DCField, identifier_field: "source")
+end
+
+class ARProviderWithScope < OAI::Provider::Base
+  DATE_LESS_THAN_RESTRICTION = Time.parse("2007-03-12 19:30:22 UTC")
+
+  repository_name 'ActiveRecord Based Provider'
+  repository_url 'http://localhost'
+  record_prefix 'oai:test'
+  source_model ActiveRecordWrapper.new(DCField.where("date < ?", DATE_LESS_THAN_RESTRICTION).includes(:sets))
+end
+
 class SimpleResumptionProvider < OAI::Provider::Base
   repository_name 'ActiveRecord Resumption Provider'
   repository_url 'http://localhost'

data/test/activerecord_provider/models/exclusive_set_dc_field.rb

@@ -3,7 +3,7 @@ class ExclusiveSetDCField < ActiveRecord::Base
 
   def self.sets
     klass = Struct.new(:name, :spec)
-    self.uniq.pluck('`set`').compact.map do |spec|
+    self.distinct.pluck(:set).compact.map do |spec|
       klass.new("Set #{spec}", spec)
     end
   end

data/test/activerecord_provider/tc_ar_provider.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_helper_ar_provider'
 
 class ActiveRecordProviderTest < TransactionalTestCase
 
@@ -14,7 +14,7 @@ class ActiveRecordProviderTest < TransactionalTestCase
 
   def test_metadata_formats_for_record
     record_id = DCField.first.id
-    assert_nothing_raised { REXML::Document.new(@provider.list_metadata_formats(:identifier => "oai:test/#{record_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
@@ -28,6 +28,30 @@ class ActiveRecordProviderTest < TransactionalTestCase
     assert_equal 100, doc.elements['OAI-PMH/ListRecords'].to_a.size
   end
 
+  def test_list_records_scope
+    @provider = ARProviderWithScope.new
+
+    doc = nil
+    assert_nothing_raised do
+      doc = REXML::Document.new(@provider.list_records(:metadata_prefix => 'oai_dc'))
+    end
+
+    expected_count = DCField.where("date < ?", ARProviderWithScope::DATE_LESS_THAN_RESTRICTION).count
+    assert_equal expected_count, doc.elements['OAI-PMH/ListRecords'].to_a.size
+  end
+
+
+  def test_get_record_alternate_identifier_column
+    @provider = ARProviderCustomIdentifierField.new
+
+    record_id = DCField.first.send(@provider.class.model.identifier_field)
+
+    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
+  end
+
   def test_list_identifiers
     assert_nothing_raised { REXML::Document.new(@provider.list_identifiers) }
     doc = REXML::Document.new(@provider.list_identifiers)
@@ -38,11 +62,11 @@ class ActiveRecordProviderTest < TransactionalTestCase
     record_id = DCField.first.id
     assert_nothing_raised do
       REXML::Document.new(@provider.get_record(
-        :identifier => "oai:test/#{record_id}", :metadata_prefix => 'oai_dc'))
+        :identifier => "oai:test:#{record_id}", :metadata_prefix => 'oai_dc'))
     end
     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
+    assert_equal "oai:test:#{record_id}", doc.elements['OAI-PMH/GetRecord/record/header/identifier'].text
   end
 
   def test_deleted
@@ -50,8 +74,8 @@ class ActiveRecordProviderTest < TransactionalTestCase
     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
+      :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
 

data/test/activerecord_provider/tc_ar_sets_provider.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_helper_ar_provider'
 
 class ActiveRecordSetProviderTest < TransactionalTestCase
 

data/test/activerecord_provider/tc_caching_paging_provider.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_helper_ar_provider'
 
 class CachingPagingProviderTest < TransactionalTestCase
   include REXML

data/test/activerecord_provider/tc_simple_paging_provider.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_helper_ar_provider'
 
 class SimpleResumptionProviderTest < TransactionalTestCase
   include REXML

data/test/activerecord_provider/{test_helper.rb → test_helper_ar_provider.rb}

@@ -1,12 +1,5 @@
 require 'rubygems'
 
-if ENV['COVERAGE'] and RUBY_VERSION =~ /^1.9/
-  require 'simplecov'
-  require 'simplecov-rcov'
-
-  SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
-  SimpleCov.start
-end
 require 'test/unit'
 require File.dirname(__FILE__) + '/config/connection'
 require File.dirname(__FILE__) + '/helpers/providers'

data/test/client/helpers/provider.rb

@@ -1,20 +1,20 @@
 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
+  class ComplexClientProvider < OAI::Provider::Base
+    repository_name 'Complex Provider'
+    repository_url 'http://localhost'
+    record_prefix 'oai:test'
+    source_model ComplexModel.new(100)
+  end
 
   attr_reader :consumed, :server
 
   def initialize(port, mount_point)
     @consumed = []
-    @provider = ComplexProvider.new
+    @provider = ComplexClientProvider.new
     @server = WEBrick::HTTPServer.new(
       :BindAddress => '127.0.0.1',
       :Logger => WEBrick::Log.new('/dev/null'),
@@ -62,4 +62,4 @@ class ProviderServer
     end
   end
 
-end
+end

data/test/client/tc_exception.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_helper_client'
 
 class ExceptionTest < Test::Unit::TestCase
 
@@ -9,7 +9,7 @@ class ExceptionTest < Test::Unit::TestCase
 
   def test_xml_error
     client = OAI::Client.new 'http://www.yahoo.com'
-    begin 
+    begin
       client.identify
     rescue OAI::Exception => e
       assert_match /response not well formed XML/, e.to_s, 'xml error'
@@ -23,7 +23,7 @@ class ExceptionTest < Test::Unit::TestCase
     end
   end
 
-  # must pass in options as a hash 
+  # 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')}
@@ -32,5 +32,5 @@ class ExceptionTest < Test::Unit::TestCase
     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

@@ -1,10 +1,10 @@
-require 'test_helper'
+require 'test_helper_client'
 
 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'
+    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._source
@@ -13,8 +13,7 @@ class GetRecordTest < Test::Unit::TestCase
     assert_kind_of REXML::Element, response.record.about
 
     # minimal check that the header is working
-    assert_equal 'oai:test/3', 
-      response.record.header.identifier
+    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
@@ -33,7 +32,7 @@ class GetRecordTest < Test::Unit::TestCase
 
   def test_deleted_record
     client = OAI::Client.new 'http://localhost:3333/oai'
-    record = client.get_record :identifier => 'oai:test/275' 
+    record = client.get_record :identifier => 'oai:test:275'
     assert record.deleted?
   end
 

data/test/client/tc_http_client.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_helper_client'
 require 'webrick'
 
 class HttpClientTest < Test::Unit::TestCase

data/test/client/tc_identify.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_helper_client'
 
 class IdentifyTest < Test::Unit::TestCase
 

data/test/client/tc_libxml.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_helper_client'
 
 class LibXMLTest < Test::Unit::TestCase
 
@@ -13,7 +13,7 @@ class LibXMLTest < Test::Unit::TestCase
   def test_list_records
     return unless have_libxml
 
-    # since there is regex magic going on to remove default oai namespaces 
+    # 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
@@ -43,10 +43,10 @@ class LibXMLTest < Test::Unit::TestCase
 
     uri = 'http://localhost:3333/oai'
     client = OAI::Client.new(uri, :parser => 'libxml')
-    response = client.get_record :identifier => 'oai:test/275'
+    response = client.get_record :identifier => 'oai:test:275'
     assert response.record.deleted?
   end
-  
+
   private
 
   def have_libxml

data/test/client/tc_list_identifiers.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_helper_client'
 
 class ListIdentifiersTest < Test::Unit::TestCase
 

data/test/client/tc_list_metadata_formats.rb

@@ -1,8 +1,8 @@
-require 'test_helper'
+require 'test_helper_client'
 
 class ListMetadataFormatsTest < Test::Unit::TestCase
   def test_list
-    client = OAI::Client.new 'http://localhost:3333/oai' 
+    client = OAI::Client.new 'http://localhost:3333/oai'
     response = client.list_metadata_formats
     assert_kind_of OAI::ListMetadataFormatsResponse, response
     assert response.entries.size > 0
@@ -13,6 +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/client/tc_list_records.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_helper_client'
 
 class ListRecordsTest < Test::Unit::TestCase
 

data/test/client/tc_list_sets.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_helper_client'
 
 class ListSetsTest < Test::Unit::TestCase
 

data/test/client/tc_low_resolution_dates.rb

@@ -1,14 +1,14 @@
-require 'test_helper'
+require 'test_helper_client'
 
 class LowResolutionDatesTest < Test::Unit::TestCase
 
   def test_low_res_date_parsing
-    client = OAI::Client.new 'http://authors.library.caltech.edu/cgi/oai2' 
+    client = OAI::Client.new 'http://authors.library.caltech.edu/cgi/oai2'
 
     date = Date.new 2003, 1, 1
-    
+
     # get a list of identifier headers
-    assert_nothing_raised { client.list_identifiers :from => date } 
+    assert_nothing_raised { client.list_identifiers :from => date }
   end
-  
+
 end

data/test/client/tc_utf8_escaping.rb

@@ -1,7 +1,7 @@
-require 'test_helper'
+require 'test_helper_client'
 
 class UTF8Test < Test::Unit::TestCase
-  
+
   def test_escaping_invalid_utf_8_characters
     client = OAI::Client.new 'http://localhost:3333/oai' #, :parser => 'libxml'
     invalid_utf_8 = [2, 3, 4, 104, 5, 101, 6, 108, 66897, 108, 66535, 111, 1114112, 33, 55234123, 33].pack("U*")

data/test/client/tc_xpath.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_helper_client'
 
 class XpathTest < Test::Unit::TestCase
   include OAI::XPath
@@ -11,7 +11,7 @@ class XpathTest < Test::Unit::TestCase
   end
 
   def test_libxml
-    begin 
+    begin
       require 'xml/libxml'
     rescue LoadError
       # libxml not available so nothing to test!

data/test/client/test_helper_client.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/tc_exceptions.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_helper_provider'
 
 class ProviderExceptions < Test::Unit::TestCase
 
@@ -36,7 +36,7 @@ class ProviderExceptions < Test::Unit::TestCase
 
   def test_bad_format_raises_exception
     assert_raise(OAI::FormatException) do
-      @provider.get_record(:identifier => 'oai:test/1', :metadata_prefix => 'html')
+      @provider.get_record(:identifier => 'oai:test:1', :metadata_prefix => 'html')
     end
   end
 
@@ -45,16 +45,18 @@ class ProviderExceptions < Test::Unit::TestCase
       @provider.list_records()
     end
     assert_raise(OAI::ArgumentException) do
-      @provider.get_record(:identifier => 'oai:test/1')
+      @provider.get_record(:identifier => 'oai:test:1')
     end
   end
 
   def test_bad_id_raises_exception
     badIdentifiers = [
-      'oai:test/5000',
-      'oai:test/-1',
+      'oai:test:5000',
+      'oai:test:-1',
+      'oai:test:one',
       'oai:test/one',
-      'oai:test/\\$1\1!']
+      'oai:test/1',
+      'oai:test:\\$1\1!']
     badIdentifiers.each do |id|
       assert_raise(OAI::IdException) do
         @provider.get_record(:identifier => id, :metadata_prefix => 'oai_dc')

data/test/provider/tc_functional_tokens.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_helper_provider'
 
 class ResumptionTokenFunctionalTest < Test::Unit::TestCase
   include REXML
@@ -44,4 +44,4 @@ class ResumptionTokenFunctionalTest < Test::Unit::TestCase
     assert_equal 100, doc.elements["/OAI-PMH/ListRecords"].to_a.size
   end
 
-end
+end

data/test/provider/tc_provider.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_helper_provider'
 
 class OaiTest < Test::Unit::TestCase
 

data/test/provider/tc_resumption_tokens.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_helper_provider'
 
 class ResumptionTokenTest < Test::Unit::TestCase
   include REXML
@@ -43,4 +43,4 @@ class ResumptionTokenTest < Test::Unit::TestCase
     assert_equal "#{@token.to_s}:#{@token.last}", doc.elements['/resumptionToken'].text
   end
 
-end
+end

data/test/provider/tc_simple_provider.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_helper_provider'
 
 class TestSimpleProvider < Test::Unit::TestCase
 
@@ -35,7 +35,7 @@ class TestSimpleProvider < Test::Unit::TestCase
   end
 
   def test_metadata_formats_for_document
-    assert_nothing_raised { REXML::Document.new(@simple_provider.list_metadata_formats(:identifier => "oai:test/1")) }
+    assert_nothing_raised { REXML::Document.new(@simple_provider.list_metadata_formats(:identifier => "oai:test:1")) }
     doc =  REXML::Document.new(@simple_provider.list_metadata_formats)
     assert_equal "oai_dc",
       doc.elements['/OAI-PMH/ListMetadataFormats/metadataFormat/metadataPrefix'].text
@@ -85,18 +85,18 @@ class TestSimpleProvider < Test::Unit::TestCase
     assert_nothing_raised do
       REXML::Document.new(
         @simple_provider.get_record(
-          :identifier => 'oai:test/1',
+          :identifier => 'oai:test:1',
           :metadataPrefix => 'oai_dc'
         )
       )
     end
     doc = REXML::Document.new(
       @simple_provider.get_record(
-        :identifier => 'oai:test/1',
+        :identifier => 'oai:test:1',
         :metadataPrefix => 'oai_dc'
       )
     )
-    assert_equal 'oai:test/1',
+    assert_equal 'oai:test:1',
       doc.elements['OAI-PMH/GetRecord/record/header/identifier'].text
   end
 
@@ -104,18 +104,18 @@ class TestSimpleProvider < Test::Unit::TestCase
     assert_nothing_raised do
       REXML::Document.new(
         @simple_provider.get_record(
-          :identifier => 'oai:test/6',
+          :identifier => 'oai:test:6',
           :metadataPrefix => 'oai_dc'
         )
       )
     end
     doc = REXML::Document.new(
       @simple_provider.get_record(
-        :identifier => 'oai:test/5',
+        :identifier => 'oai:test:5',
         :metadataPrefix => 'oai_dc'
       )
     )
-    assert_equal 'oai:test/5', doc.elements['OAI-PMH/GetRecord/record/header/identifier'].text
+    assert_equal 'oai:test:5', doc.elements['OAI-PMH/GetRecord/record/header/identifier'].text
     assert_equal 'deleted', doc.elements['OAI-PMH/GetRecord/record/header'].attributes["status"]
   end
 

data/test/provider/{test_helper.rb → test_helper_provider.rb}

@@ -1,10 +1,3 @@
-if ENV['COVERAGE'] and RUBY_VERSION =~ /^1.9/
-  require 'simplecov'
-  require 'simplecov-rcov'
-
-  SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
-  SimpleCov.start
-end
 require 'oai'
 require 'test/unit'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oai
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0.beta1
 platform: ruby
 authors:
 - Ed Summers
 autorequire: oai
 bindir: bin
 cert_chain: []
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2019-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -52,6 +52,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: ehs@pobox.com
 executables:
@@ -119,7 +153,7 @@ files:
 - test/activerecord_provider/tc_ar_sets_provider.rb
 - test/activerecord_provider/tc_caching_paging_provider.rb
 - test/activerecord_provider/tc_simple_paging_provider.rb
-- test/activerecord_provider/test_helper.rb
+- test/activerecord_provider/test_helper_ar_provider.rb
 - test/client/helpers/provider.rb
 - test/client/helpers/test_wrapper.rb
 - test/client/tc_exception.rb
@@ -134,14 +168,14 @@ files:
 - test/client/tc_low_resolution_dates.rb
 - test/client/tc_utf8_escaping.rb
 - test/client/tc_xpath.rb
-- test/client/test_helper.rb
+- test/client/test_helper_client.rb
 - test/provider/models.rb
 - test/provider/tc_exceptions.rb
 - test/provider/tc_functional_tokens.rb
 - test/provider/tc_provider.rb
 - test/provider/tc_resumption_tokens.rb
 - test/provider/tc_simple_provider.rb
-- test/provider/test_helper.rb
+- test/provider/test_helper_provider.rb
 - test/test.xml
 homepage: http://github.com/code4lib/ruby-oai
 licenses: []
@@ -157,15 +191,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A ruby library for working with the Open Archive Initiative Protocol for
   Metadata Harvesting (OAI-PMH)
 test_files: []
-has_rdoc: 

data/test/client/test_helper.rb

@@ -1,13 +0,0 @@
-if ENV['COVERAGE'] and RUBY_VERSION =~ /^1.9/
-  require 'simplecov'
-  require 'simplecov-rcov'
-
-  SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
-  SimpleCov.start
-end
-
-require 'oai'
-require 'test/unit'
-
-require File.dirname(__FILE__) + '/helpers/provider'
-require File.dirname(__FILE__) + '/helpers/test_wrapper'