blacklight_oai_provider 4.1.0 → 5.0.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c8443a7d656487d8e2aa2cfd0ebd3b7b659d85b
-  data.tar.gz: 07f9b6fb1ca30e96915f1d9ea13f1afc962ec5a1
+  metadata.gz: dac8e80d262005aef4f462074caf7bd88a504ecc
+  data.tar.gz: 863efffd6ba4c5804eec41824fb6419b23c197be
 SHA512:
-  metadata.gz: f0e3e076577da7493f9cb6ed7606720854e270892e85bef93d1e5959585c60cd61deb16790ee99c287625d5ddc971bacfb33446eea2b288b0108171eeb17fc21
-  data.tar.gz: f91efbafee6de242c66fb288b442b01cef71c70a123d6661209cc4a261ba22c1b6c0c598813e2a0b9e2ad77b396b7734fa5690d3d28d272fea29b7d3fd336258
+  metadata.gz: 5edc6116f617c802dca3fd55f9d400621531aeb98fc2123c31a12d3ee3508ef0f34444e02c4c9f063180fcd2f3d4d3b1a1d1776aefed1fbfdd825090023e6a6f
+  data.tar.gz: f6a2457b1876bc34c3fb92a283add8284fb67d64be3776c27903062bbeac1b77346bdabf031e9df14f0e1e2f6024a5b4fe955fc8ea34b992e85de5d50d52d9c4

data/.rubocop.yml

@@ -37,3 +37,15 @@ Bundler/DuplicatedGem:
 Bundler/OrderedGems:
   Exclude:
   - 'Gemfile'
+
+RSpec/DescribeClass:
+  Exclude:
+  - 'spec/requests/**'
+  - 'spec/features/**'
+
+Style/Documentation:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Exclude:
+  - 'lib/blacklight_oai_provider/set.rb'

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-10-26 15:19:14 -0400 using RuboCop version 0.50.0.
+# on 2017-11-09 12:27:39 -0500 using RuboCop version 0.50.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -14,14 +14,14 @@ Layout/EmptyLinesAroundBlockBody:
   Exclude:
     - 'spec/requests/list_metadata_formats_spec.rb'
 
-# Offense count: 4
+# Offense count: 6
 Metrics/AbcSize:
-  Max: 25
+  Max: 28
 
-# Offense count: 2
+# Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 39
+  Max: 47
 
 # Offense count: 2
 RSpec/BeforeAfterAll:
@@ -31,16 +31,6 @@ RSpec/BeforeAfterAll:
     - 'spec/support/**/*.rb'
     - 'spec/requests/list_identifiers_spec.rb'
 
-# Offense count: 6
-RSpec/DescribeClass:
-  Exclude:
-    - 'spec/features/html_rendering_spec.rb'
-    - 'spec/requests/get_record_spec.rb'
-    - 'spec/requests/identify_spec.rb'
-    - 'spec/requests/list_identifiers_spec.rb'
-    - 'spec/requests/list_metadata_formats_spec.rb'
-    - 'spec/requests/list_records_spec.rb'
-
 # Offense count: 1
 # Configuration parameters: CustomIncludeMethods.
 RSpec/EmptyExampleGroup:
@@ -53,7 +43,13 @@ RSpec/ExampleLength:
   Exclude:
     - 'spec/controllers/catalog_controller_spec.rb'
 
-# Offense count: 6
+# Offense count: 1
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/lib/blacklight_oai_provider/solr_document_wrapper_spec.rb'
+
+# Offense count: 9
 RSpec/MultipleExpectations:
   Max: 2
 
@@ -84,24 +80,7 @@ Style/BracesAroundHashParameters:
     - 'lib/blacklight_oai_provider/solr_document_wrapper.rb'
     - 'spec/models/solr_document_spec.rb'
 
-# Offense count: 12
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'app/controllers/concerns/blacklight_oai_provider/controller.rb'
-    - 'app/models/concerns/blacklight_oai_provider/solr_document.rb'
-    - 'lib/blacklight_oai_provider.rb'
-    - 'lib/blacklight_oai_provider/engine.rb'
-    - 'lib/blacklight_oai_provider/exceptions.rb'
-    - 'lib/blacklight_oai_provider/resumption_token.rb'
-    - 'lib/blacklight_oai_provider/routes.rb'
-    - 'lib/blacklight_oai_provider/solr_document_provider.rb'
-    - 'lib/blacklight_oai_provider/solr_document_wrapper.rb'
-    - 'lib/blacklight_oai_provider/version.rb'
-    - 'lib/generators/blacklight_oai_provider/install_generator.rb'
-
-# Offense count: 24
+# Offense count: 31
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: when_needed, always, never
@@ -114,7 +93,7 @@ Style/GuardClause:
   Exclude:
     - 'lib/generators/blacklight_oai_provider/install_generator.rb'
 
-# Offense count: 1
+# Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: MinSize, SupportedStyles.
 # SupportedStyles: percent, brackets

data/README.md

@@ -16,7 +16,7 @@ A few maintenance branches have been left in place in case there is interest to
 ## Requirements
 A Rails app running Rails 4.x and Blacklight 4.x.
 
-OAI-PMH requires a timestamp field for all records. The Solr index should include an appropriate field. This field should be able to support date range queries. By default, the name of this field is `timestamp` (more on how to configure this below).
+OAI-PMH requires a timestamp field for all records. The Solr index should include an appropriate field. This field should be able to support date range queries. By default, the name of this field is `timestamp` (more on how to configure this [below](#solrdocument-configuration)).
 
 A properly configured documentHandler in the blacklight/solr configuration.
 
@@ -25,24 +25,24 @@ A properly configured documentHandler in the blacklight/solr configuration.
 Add
 
 ```ruby
-    gem 'blacklight_oai_provider', git: 'https://github.com/projectblacklight/blacklight_oai_provider'
+    gem 'blacklight_oai_provider'
 ```
 
 to your Gemfile and run `bundle install`.
 
 Then run
 ```ruby
-    rails generate blacklight_oai_provider:install
+rails generate blacklight_oai_provider:install
 ```
 to install the appropriate extensions into your `CatalogController` and `SolrDocument` classes. If you want to do customize the way this installs, instead you may:
 
 - add this to your Solr Document model:
 ```ruby
-    include BlacklightOaiProvider::SolrDocument
+include BlacklightOaiProvider::SolrDocument
 ```
 - add this to your Controller:
 ```ruby
-    include BlacklightOaiProvider::Controller
+include BlacklightOaiProvider::Controller
 ```
 
 ## Configuration
@@ -53,36 +53,41 @@ While the plugin provides some sensible (albeit generic) defaults out of the box
 You can provide OAI-PMH provider parameters by placing the following in your blacklight configuration (most likely in `app/controllers/catalog_controller.rb`)
 
 ```ruby
-  configure_blacklight do |config|
-
-    # ...
-
-    config.oai = {
-      :provider => {
-        :repository_name => 'Test',
-        :repository_url => 'http://localhost',
-        :record_prefix => '',
-        :admin_email => 'root@localhost'
-      },
-      :document => {
-        :model => SolrDocument, # SolrDocument class you are using.
-        :limit => 25
-      }
+configure_blacklight do |config|
+
+  # ...
+
+  config.oai = {
+    provider: {
+      repository_name: 'Test',
+      repository_url: 'http://localhost/catalog/oai',
+      record_prefix: 'oai:test',
+      admin_email: 'root@localhost',
+      sample_id: '109660'
+    },
+    document: {
+      model: SolrDocument, # SolrDocument class being used, default: SolrDocument
+      limit: 25            # number of records returned with each request, default: 15
+      set_fields: [        # ability to define ListSets, optional, default: nil
+        { label: 'language', solr_field: 'language_facet' }
+      ]
     }
+  }
 
-    # ...
-
-  end
+  # ...
+end
 ```
 
 The "provider" configuration is documented as part of the ruby-oai gem at http://oai.rubyforge.org/
 
+A basic set model is included that maps Solr fields to OAI sets. Provide `set_fields` with an array of hashes defining the solr_field, and optionally a label and description. The configuration above will cause the `ListSets` verb to query Solr for unique values of the `language_facet` field and present each value as a set using a spec format of `language:value`. When the `set` parameter is supplied to the `ListRecords` verb, it will append a filter to the Solr query of the form `fq=language_facet:value`. If no label is provided, the set will use the `solr_field` name. To customize the ListSet implementation, see [customizing listsets](#customizing-listsets).
+
 _Note:_ The document handler in your blacklight controller must be configured properly for this plugin to correctly look up records.
 
 ### SolrDocument configuration
 To change the name of the timestamp solr field in your `SolrDocument` model change the following attribute:
 ```ruby
-    self.timestamp_key = 'record_creation_date' # Default: 'timestamp'
+self.timestamp_key = 'record_creation_date' # Default: 'timestamp'
 ```
 
 The metadata displayed in the xml serialization of each record is based off the `field_semantics` hash in the `SolrDocument` model. To update/change these fields add something like the following to your model:
@@ -97,12 +102,39 @@ The metadata displayed in the xml serialization of each record is based off the
     format: "format"
   )
 ```
-
 The fields used by the dublin core serialization are:
 ```ruby
-  [:contributor, :coverage, :creator, :date, :description, :format, :identifier, :language, :publisher, :relation, :rights, :source, :subject, :title, :type]
+[:contributor, :coverage, :creator, :date, :description, :format, :identifier, :language, :publisher, :relation, :rights, :source, :subject, :title, :type]
+```
+
+### Customizing ListSets
+In order to customize the default ListSets implementation, first create your own `Sets` class that subclasses `BlacklightOaiProvider::Set` or `BlacklightOaiProvider::SolrSet` and implement all required methods. Ex:
+```ruby
+class NewListSet < BlacklightOaiProvider::SolrSet
+  def description
+    "This is a #{label} set containing records with the value of #{value}."
+  end
+end
+```
+
+Next, your `SolrDocument` model must override, `sets`, an instance method that returns an array of sets for each document. Ex:
+```ruby
+def sets
+  NewListSet.sets_for(self)
+end
 ```
 
+Finally, you can substitute you own Set model using the `set_model` option.
+```ruby
+config.oai = {
+  document: {
+    set_model: NewListSet,
+    set_fields: [
+      { label: 'language', solr_field: 'language_facet' }
+    ]
+  }
+}
+```
 ## Injection
 This plugin assumes it is in a Blacklight Rails app, uses Blacklight methods, Rails methods, and standard ruby module includes to inject it's behaviors into the app.
 
@@ -110,22 +142,22 @@ You can turn off this injection if you like, although it will make the plugin le
 
 In any initializer, you can set:
 ```ruby
-  BlacklightOaiProvider.omit_inject = true
+BlacklightOaiProvider.omit_inject = true
 ```
 to turn off all injection. The plugin will be completely non-functional if you do this, of course. But perhaps you could try to re-use some of it's classes in a non-Blacklight, highly hacked Blacklight, or even non-Rails application this way.
 
 You can also turn off injection of individual components, which could be more useful:
 ```ruby
-  BlacklightOaiProvider.omit_inject = {
-    :routes => false,
-  }
+BlacklightOaiProvider.omit_inject = {
+  routes: false,
+}
 ```
 ## Tests
 We use `engine_cart` and `solr_wrapper` to run tests on a dummy instance of an app using this plugin.
 
 To run the entire test suite:
 ```ruby
-  rake ci
+rake ci
 ```
 
 You can test OAI-PMH conformance against http://www.openarchives.org/data/registerasprovider.html#Protocol_Conformance_Testing or browse the data at http://re.cs.uct.ac.za/

data/VERSION

@@ -1 +1 @@
-4.1.0
+5.0.0.pre1

data/app/assets/stylesheets/blacklight_oai_provider/oai2.xsl

@@ -8,8 +8,8 @@
 
 -->
 
-<!-- 
-  
+<!--
+
 Copyright (c) 2000-2004 University of Southampton, UK. SO17 1BJ.
 
 EPrints 2 is free software; you can redistribute it and/or modify
@@ -28,9 +28,9 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 -->
 
-   
+
 <!--
-  
+
   All the elements really needed for EPrints are done but if
   you want to use this XSL for other OAI archive you may want
   to make some minor changes or additions.
@@ -46,7 +46,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 -->
 <xsl:stylesheet
     version="1.0"
-    xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 
+    xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
     xmlns:oai="http://www.openarchives.org/OAI/2.0/"
 >
 
@@ -72,7 +72,7 @@ td.key {
 .dcdata td.key {
 	background-color: #ffffe0;
 }
-body { 
+body {
 	margin: 1em 2em 1em 2em;
 }
 h1, h2, h3 {
@@ -150,7 +150,8 @@ p.intro {
 <xsl:call-template name='xmlstyle' />
 </xsl:template>
 
-<xsl:variable name='identifier' select="substring-before(concat(substring-after(/oai:OAI-PMH/oai:request,'identifier='),'&amp;'),'&amp;')" />
+<xsl:variable name="identifier" select="/oai:OAI-PMH/oai:request/@identifier" />
+<xsl:variable name="verb" select="/oai:OAI-PMH/oai:request/@verb" />
 
 <xsl:template match="/">
 <html>
@@ -165,15 +166,15 @@ p.intro {
     <xsl:apply-templates select="/oai:OAI-PMH" />
     <xsl:call-template name="quicklinks"/>
     <h2><a name="moreinfo">About the XSLT</a></h2>
-    <p>An XSLT file has converted the <a href="http://www.openarchives.org">OAI-PMH 2.0</a> responses into XHTML which looks nice in a browser which supports XSLT such as Mozilla, Firebird and Internet Explorer. The XSLT file was created by <a href="http://www.ecs.soton.ac.uk/people/cjg">Christopher Gutteridge</a> at the University of Southampton as part of the <a href="http://software.eprints.org">GNU EPrints system</a>, and is freely redistributable under the <a href="http://www.gnu.org">GPL</a>.</p><p>If you want to use the XSL file on your own OAI interface you may but due to the way XSLT works you must install the XSL file on the same server as the OAI script, you can't just link to this copy.</p><p>For more information or to download the XSL file please see the <a href="http://software.eprints.org/xslt.php">OAI to XHTML XSLT homepage</a>.</p>
-
+    <p>An XSLT file has converted the <a href="http://www.openarchives.org">OAI-PMH 2.0</a> responses into XHTML which looks nice in a browser which supports XSLT such as Firefox, Chrome, Safari, and Internet Explorer. The XSLT file was created by <a href="http://www.ecs.soton.ac.uk/people/cjg">Christopher Gutteridge</a> at the University of Southampton as part of the <a href="http://www.eprints.org/uk/index.php/eprints-software/">GNU EPrints system</a>, and is freely redistributable under the <a href="http://www.gnu.org">GPL</a>.</p>
+    <p>For more information or to download the XSL file please see the <a href="http://wiki.eprints.org/w/EPrints_OAI_Stylesheet">OAI to XHTML XSLT homepage</a>.</p>
   </body>
 </html>
 </xsl:template>
 
 <xsl:template name="quicklinks">
     <ul class="quicklinks">
-      <li><a href="?verb=Identify">Identify</a> | </li> 
+      <li><a href="?verb=Identify">Identify</a> | </li>
       <li><a href="?verb=ListRecords&amp;metadataPrefix=oai_dc">ListRecords</a> | </li>
       <li><a href="?verb=ListSets">ListSets</a> | </li>
       <li><a href="?verb=ListMetadataFormats">ListMetadataFormats</a> | </li>
@@ -199,7 +200,7 @@ p.intro {
       </div>
     </xsl:when>
     <xsl:otherwise>
-      <p>Request was of type <xsl:value-of select="oai:request/@verb"/>.</p>
+      <p>Request was of type <xsl:value-of select="$verb"/>.</p>
       <div class="results">
         <xsl:apply-templates select="oai:Identify" />
         <xsl:apply-templates select="oai:GetRecord"/>
@@ -332,7 +333,7 @@ p.intro {
 </xsl:template>
 
 <xsl:template match="fr:baseURL" xmlns:fr="http://www.openarchives.org/OAI/2.0/friends/">
-  <li><xsl:value-of select="."/> 
+  <li><xsl:value-of select="."/>
 <xsl:text> </xsl:text>
 <a class="link" href="{.}?verb=Identify">Identify</a></li>
 </xsl:template>
@@ -433,9 +434,13 @@ p.intro {
 <xsl:template match="oai:set">
   <h2>Set</h2>
   <table class="values">
+    <xsl:apply-templates select="oai:setSpec" />
     <tr><td class="key">setName</td>
     <td class="value"><xsl:value-of select="oai:setName"/></td></tr>
-    <xsl:apply-templates select="oai:setSpec" />
+    <xsl:if test="oai:setDescription">
+      <tr><td class="key">setDescription</td>
+      <td class="value"><xsl:value-of select="oai:setDescription"/></td></tr>
+    </xsl:if>
   </table>
 </xsl:template>
 
@@ -535,7 +540,7 @@ p.intro {
         <tr><td class="key">resumptionToken:</td>
         <td class="value"><xsl:value-of select="."/>
 <xsl:text> </xsl:text>
-<a class="link" href="?verb={/oai:OAI-PMH/oai:request/@verb}&amp;resumptionToken={.}">Resume</a></td></tr>
+<a class="link" href="?verb={$verb}&amp;resumptionToken={.}">Resume</a></td></tr>
       </table>
     </xsl:when>
     <xsl:otherwise>
@@ -663,4 +668,3 @@ p.intro {
 </xsl:template>
 
 </xsl:stylesheet>
-

data/app/models/concerns/blacklight_oai_provider/solr_document.rb

@@ -12,6 +12,10 @@ module BlacklightOaiProvider
       export_as('oai_dc_xml')
     end
 
+    def sets
+      BlacklightOaiProvider::SolrSet.sets_for(self)
+    end
+
     module ClassMethods
       attr_writer :timestamp_key
 

data/blacklight_oai_provider.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.summary = "Blacklight Oai Provider plugin"
 
   s.post_install_message = %q{
-BlacklightOaiProvider v4.1 implements configuration changes. Please visit README for more information.
+BlacklightOaiProvider v5.x implements configuration changes. Please visit README for more information.
 
 }
 
@@ -22,7 +22,7 @@ BlacklightOaiProvider v4.1 implements configuration changes. Please visit README
   s.require_paths = ["lib"]
 
   s.add_dependency "rails", "~> 4.0"
-  s.add_dependency "blacklight", "~> 4.0"
+  s.add_dependency "blacklight", "~> 5.0"
   s.add_dependency "oai"
   s.add_development_dependency 'rspec-rails', "~> 3.0"
   s.add_development_dependency 'capybara'

data/lib/blacklight_oai_provider.rb

@@ -4,6 +4,9 @@ module BlacklightOaiProvider
   autoload :SolrDocumentWrapper, 'blacklight_oai_provider/solr_document_wrapper'
   autoload :ResumptionToken, 'blacklight_oai_provider/resumption_token'
   autoload :Routes, 'blacklight_oai_provider/routes'
+  autoload :Set, 'blacklight_oai_provider/set'
+  autoload :Response, 'blacklight_oai_provider/response/list_sets'
+  autoload :SolrSet, 'blacklight_oai_provider/solr_set'
 
   require 'oai'
   require 'blacklight_oai_provider/version'

data/lib/blacklight_oai_provider/response/list_sets.rb

@@ -0,0 +1,34 @@
+module BlacklightOaiProvider
+  module Response
+    class ListSets < OAI::Provider::Response::Base
+      def to_xml
+        raise OAI::SetException unless provider.model.sets
+
+        response do |r|
+          r.ListSets do
+            provider.model.sets.each do |set|
+              r.set do
+                r.setSpec set.spec
+                r.setName set.name
+
+                if set.respond_to?(:description) && set.description
+                  r.setDescription do
+                    r.tag!("#{oai_dc.prefix}:#{oai_dc.element_namespace}", oai_dc.header_specification) do
+                      r.dc :description, set.description
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+
+      private
+
+      def oai_dc
+        OAI::Provider::Metadata::DublinCore.instance
+      end
+    end
+  end
+end

data/lib/blacklight_oai_provider/routes.rb

@@ -3,12 +3,12 @@ module BlacklightOaiProvider
     extend ActiveSupport::Concern
 
     included do |klass|
-      klass.default_route_sets.insert(klass.default_route_sets.index(:catalog), :oai_routing)
+      klass.default_route_sets.insert(klass.default_route_sets.index(:export), :oai_routing)
     end
 
-    def oai_routing
+    def oai_routing(primary_resource)
       add_routes do
-        get "catalog/oai", to: "catalog#oai", as: 'oai_provider'
+        get "#{primary_resource}/oai", to: "#{primary_resource}#oai", as: 'oai_provider'
       end
     end
   end

data/lib/blacklight_oai_provider/set.rb

@@ -0,0 +1,49 @@
+module BlacklightOaiProvider
+  class Set
+    class << self
+      # The controller, used to construct solr queries
+      attr_accessor :controller
+
+      # Solr field configuration for each set
+      # Fields must be indexed
+      attr_accessor :fields
+
+      # Return an array of all SetSpecs, or nil if sets are not supported.
+      # Objects returned must be of a class that inherits from
+      # BlacklightOaiProvider::SetSpecs.
+      def all
+        raise NotImplementedError
+      end
+
+      # Return a Solr filter query given a set spec. Spec will be a string in
+      # label:value format.
+      def from_spec(spec)
+        raise NotImplementedError
+      end
+
+      # Returns array of sets for a record, or empty array if none are available.
+      # Objects returned must be of a class that inherits from
+      # BlacklightOaiProvider::SetSpecs.
+      def sets_for(record)
+        raise NotImplementedError
+      end
+    end
+
+    # OAI Set properties
+    attr_accessor :label, :value, :description
+
+    # Build a set object with, at minimum, a set spec string
+    def initialize(spec)
+      @label, @value = spec.split(':', 2)
+      raise OAI::ArgumentException if [@label, @value].any?(&:blank?)
+    end
+
+    def name
+      raise NotImplementedError
+    end
+
+    def spec
+      raise NotImplementedError
+    end
+  end
+end

data/lib/blacklight_oai_provider/solr_document_provider.rb

@@ -15,5 +15,9 @@ module BlacklightOaiProvider
         self.class.send k, v
       end
     end
+
+    def list_sets(options = {})
+      Response::ListSets.new(self.class, options).to_xml
+    end
   end
 end

data/lib/blacklight_oai_provider/solr_document_wrapper.rb

@@ -8,9 +8,15 @@ module BlacklightOaiProvider
       @solr_timestamp  = document_model.timestamp_key
       @timestamp_field = 'timestamp' # method name used by ruby-oai
       @limit           = options[:limit] || 15
+      @set             = options[:set_model] || BlacklightOaiProvider::SolrSet
+
+      @set.controller = @controller
+      @set.fields = options[:set_fields]
     end
 
-    def sets; end
+    def sets
+      @set.all
+    end
 
     def earliest
       _response, records = @controller.get_search_results(@controller.params, { fl: solr_timestamp, sort: "#{solr_timestamp} asc", rows: 1 })
@@ -63,13 +69,14 @@ module BlacklightOaiProvider
     end
 
     def conditions(options) # conditions/query derived from options
-      if !(options[:from].blank? && options[:until].blank?)
-        base_conditions.merge(
-          fq: "#{solr_timestamp}:[#{solr_date(options[:from])} TO #{solr_date(options[:until]).gsub('Z', '.999Z')}]"
-        )
-      else
-        base_conditions
+      filters = []
+      if options[:from].present? || options[:until].present?
+        filters << "#{solr_timestamp}:[#{solr_date(options[:from])} TO #{solr_date(options[:until]).gsub('Z', '.999Z')}]"
       end
+
+      filters << @set.from_spec(options[:set]) if options[:set].present?
+
+      base_conditions.merge(fq: filters)
     end
 
     def solr_date(time)

data/lib/blacklight_oai_provider/solr_set.rb

@@ -0,0 +1,85 @@
+module BlacklightOaiProvider
+  class SolrSet < BlacklightOaiProvider::Set
+    class << self
+      # Return an array of all sets, or nil if sets are not supported
+      def all
+        return if @fields.nil?
+
+        params = { rows: 0, facet: true, 'facet.field' => solr_fields }
+        solr_fields.each { |field| params["f.#{field}.facet.limit"] = -1 } # override any potential blacklight limits
+        response, _records = @controller.get_search_results(@controller.params, params)
+        sets_from_facets(response.facet_fields) if response.facet_fields
+      end
+
+      # Return a Solr filter query given a set spec
+      def from_spec(spec)
+        new(spec).solr_filter
+      end
+
+      # Returns array of sets for a solr document, or empty array if none are available.
+      def sets_for(record)
+        Array.wrap(@fields).map do |field|
+          values = record.get(field[:solr_field], sep: nil)
+          Array.wrap(values).map do |value|
+            new("#{field[:label]}:#{value}")
+          end
+        end.flatten
+      end
+
+      def fields=(value) # The Solr fields to map to OAI sets. Must be indexed
+        if value.respond_to?(:each)
+          value.each do |config|
+            raise ArgumentException, 'OAI sets must define a solr_field' if config[:solr_field].blank?
+            config[:label] ||= config[:solr_field]
+          end
+        end
+
+        super(value)
+      end
+
+      def field_config_for(label)
+        Array.wrap(@fields).find { |f| f[:label] == label } || {}
+      end
+
+      private
+
+      def solr_fields
+        @fields.map { |f| f[:solr_field] }
+      end
+
+      def sets_from_facets(facet_results)
+        sets = Array.wrap(@fields).map do |f|
+          facet_results.fetch(f[:solr_field], [])
+                       .each_slice(2)
+                       .map { |t| new("#{f[:label]}:#{t.first}") }
+        end.flatten
+
+        sets.empty? ? nil : sets
+      end
+    end
+
+    # OAI Set properties
+    attr_accessor :solr_field
+
+    # Build a set object with, at minimum, a set spec string
+    def initialize(spec)
+      super(spec)
+      config = self.class.field_config_for(label)
+      @solr_field = config[:solr_field]
+      @description = config[:description]
+      raise OAI::ArgumentException if @solr_field.blank?
+    end
+
+    def name
+      spec.titleize.gsub(':', ': ')
+    end
+
+    def spec
+      "#{@label}:#{@value}"
+    end
+
+    def solr_filter
+      "#{@solr_field}:\"#{@value}\""
+    end
+  end
+end

data/spec/controllers/catalog_controller_spec.rb

@@ -16,19 +16,23 @@ describe CatalogController do
   end
 
   describe '#oai_config' do
-    it 'returns correct configuration' do
-      expect(controller.oai_config).to match(
+    it 'returns correct provider configuration' do
+      expect(controller.oai_config).to include(
         provider: {
           repository_name: "Test Repository",
-          repository_url: "http://localhost",
+          repository_url: "http://localhost/catalog/oai",
           record_prefix: "oai:test",
           admin_email: "root@localhost",
           deletion_support: "persistent",
           sample_id: "109660"
-        },
-        document: { model: SolrDocument, limit: 25 }
+        }
       )
     end
+
+    it 'return corrext document configuration' do
+      expect(controller.oai_config[:document][:limit]).to be 25
+      expect(controller.oai_config[:document][:model]).to be_a Class
+    end
   end
 
   describe '#oai_provider' do

data/spec/features/html_rendering_spec.rb

@@ -18,7 +18,17 @@ describe 'HTML page rendering', js: true do
   end
 
   it "document page" do
-    visit '/catalog/oai?verb=GetRecord&identifier=00282214&metadataPrefix=oai_dc'
+    visit '/catalog/oai?verb=GetRecord&identifier=oai:test:00282214&metadataPrefix=oai_dc'
     expect(page).to have_xpath('//td[text()="Title"]/parent::*/td[@class="value"]', text: 'Fikr-i Ayāz')
   end
+
+  it "lists verb on page" do
+    visit '/catalog/oai?verb=Identify'
+    expect(page).to have_content('Request was of type Identify.')
+  end
+
+  it "lists metadata formats for record" do
+    visit '/catalog/oai?verb=ListMetadataFormats&identifier=oai:test:00282214'
+    expect(page).to have_content('This is a list of metadata formats available for the record "oai:test:00282214"')
+  end
 end

data/spec/lib/blacklight_oai_provider/solr_document_wrapper_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+RSpec.describe BlacklightOaiProvider::SolrDocumentWrapper do
+  subject(:wrapper) { described_class.new(controller, options) }
+
+  let(:options) { {} }
+  let(:controller) { CatalogController.new }
+
+  before do
+    allow(controller).to receive(:params).and_return({})
+  end
+
+  describe '#initialize' do
+    context 'with a set class provided' do
+      before do
+        stub_const 'CustomSet', Class.new(BlacklightOaiProvider::Set)
+      end
+
+      let(:options) { { set_model: CustomSet, set_fields: [{ solr_field: 'language_facet' }] } }
+
+      it 'uses the Set class' do
+        expect(wrapper.instance_eval { @set }).to be CustomSet
+      end
+    end
+  end
+
+  describe '#sets' do
+    it 'returns nil to indicate sets are not supported' do
+      expect(wrapper.sets).to be_nil
+    end
+  end
+
+  describe '#earliest' do
+    it 'returns the earliest timestamp of all the records' do
+      expect(wrapper.earliest).to eq Time.parse('2014-02-03 18:42:53.056000000 +0000').utc
+    end
+  end
+
+  describe '#latest' do
+    it 'returns the latest timestamp of all the records' do
+      expect(wrapper.latest).to eq Time.parse('2014-03-03 18:42:53.056000000 +0000').utc
+    end
+  end
+
+  describe '#find' do
+    context 'when selector is :all' do
+      it 'returns a limited list of all records' do
+        expect(wrapper.find(:all)).to be_a OAI::Provider::PartialResult
+        expect(wrapper.find(:all).records.size).to be 15
+      end
+    end
+
+    context 'when selector is an individual record' do
+      it 'returns a single record' do
+        expect(wrapper.find('2005553155')).to be_a SolrDocument
+      end
+    end
+  end
+end

data/spec/lib/blacklight_oai_provider/solr_set_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+RSpec.describe BlacklightOaiProvider::SolrSet do
+  let(:controller) { CatalogController.new }
+  let(:fields) do
+    [{ label: 'language', solr_field: 'language_facet' }]
+  end
+
+  before do
+    described_class.controller = controller
+    described_class.fields = fields
+    allow(controller).to receive(:params).and_return({})
+  end
+
+  describe '.all' do
+    subject(:all_sets) { described_class.all }
+
+    it 'returns a Set object representing each set' do
+      expect(all_sets.count).to be 12
+      expect(all_sets.first).to be_a described_class
+    end
+
+    context 'with multiple fields' do
+      let(:fields) do
+        [
+          { label: 'language', solr_field: 'language_facet' },
+          { solr_field: 'format' }
+        ]
+      end
+
+      it 'returns Sets for values in each field' do
+        expect(all_sets.count).to be 13
+      end
+    end
+
+    context 'for a field with no values' do
+      let(:fields) do
+        [{ label: 'author', solr_field: 'author_display' }]
+      end
+
+      it 'returns nil' do
+        expect(all_sets).to be_nil
+      end
+    end
+
+    context 'for a field with facet config limit' do
+      let(:fields) do
+        [{ label: 'lc_alpha', solr_field: 'lc_alpha_facet' }]
+      end
+
+      before do
+        CatalogController.configure_blacklight do |config|
+          config.add_facet_field 'lc_alpha_facet', label: 'lc_alpha', limit: 2
+        end
+      end
+
+      it 'returns all sets' do
+        expect(all_sets.count).to be 14
+      end
+    end
+  end
+
+  describe '.from_spec' do
+    context 'with a valid spec' do
+      let(:spec) { 'language:Hebrew' }
+
+      it 'returns the filter query' do
+        expect(described_class.from_spec(spec)).to eq 'language_facet:"Hebrew"'
+      end
+    end
+
+    context 'with an invalid field' do
+      let(:spec) { 'foo:Hebrew' }
+
+      it 'raises an argument exception' do
+        expect { described_class.from_spec(spec) }.to raise_error(::OAI::ArgumentException)
+      end
+    end
+
+    context 'with an invalid spec' do
+      let(:spec) { 'invalid' }
+
+      it 'raises an argument exception' do
+        expect { described_class.from_spec(spec) }.to raise_error(::OAI::ArgumentException)
+      end
+    end
+  end
+
+  describe '#initialize' do
+    let(:set) { described_class.new('language:Hebrew') }
+
+    it 'creates a friendly set name if none is provided' do
+      expect(set.name).to eq 'Language: Hebrew'
+    end
+
+    it 'gets solr field' do
+      expect(set.solr_field).to eql 'language_facet'
+    end
+  end
+end

data/spec/requests/get_record_spec.rb

@@ -11,14 +11,21 @@ describe 'OIA-PMH GetRecord Request' do
   end
 
   before do
-    get '/catalog/oai?verb=GetRecord&identifier=2007020969&metadataPrefix=oai_dc'
+    get '/catalog/oai?verb=GetRecord&identifier=oai:test:2007020969&metadataPrefix=oai_dc'
   end
 
-  it 'contains header information' do
+  it 'contains identifier' do
     expect(xml.at_xpath('//xmlns:GetRecord/xmlns:record/xmlns:header/xmlns:identifier').text).to eql 'oai:test:2007020969'
+  end
+
+  it 'contains datestamp' do
     expect(xml.at_xpath('//xmlns:GetRecord/xmlns:record/xmlns:header/xmlns:datestamp').text).to eql '2014-02-03T18:42:53Z'
   end
 
+  it 'contains sets' do
+    expect(xml.at_xpath('//xmlns:GetRecord/xmlns:record/xmlns:header/xmlns:setSpec').text).to eql 'language:English'
+  end
+
   it 'contains creator' do
     expect(xml.at_xpath('//xmlns:metadata/oai_dc:dc/dc:creator', namespaces).text).to eql 'Hearth, Amy Hill, 1958-'
   end

data/spec/requests/identify_spec.rb

@@ -16,7 +16,7 @@ describe 'OIA-PMH Identify Request' do
   end
 
   it "contains base url" do
-    expect(xml.at_xpath('//xmlns:baseURL').text).to eql 'http://localhost'
+    expect(xml.at_xpath('//xmlns:baseURL').text).to eql 'http://localhost/catalog/oai'
   end
 
   it "contains protocol version" do

data/spec/requests/list_metadata_formats_spec.rb

@@ -24,7 +24,7 @@ describe 'OIA-PMH ListMetadataFormats Request' do
 
   context 'with identifier parameter' do
     before do
-      get '/catalog/oai?verb=ListMetadataFormats&identifier=2007020969'
+      get '/catalog/oai?verb=ListMetadataFormats&identifier=oai:test:2007020969'
     end
 
     it 'contains oai_dc schema' do

data/spec/requests/list_records_spec.rb

@@ -95,6 +95,17 @@ describe 'OIA-PMH ListRecords Request' do
     end
   end
 
+  context 'for all documents within a set' do
+    let(:document_config) { { set_fields: 'language_facet' } }
+
+    it 'only records from the set are returned' do
+      params = { verb: 'ListRecords', metadataPrefix: 'oai_dc', set: 'language:Japanese' }
+
+      get oai_provider_path(params)
+      expect(xml.xpath('//xmlns:record').count).to be 2
+    end
+  end
+
   context 'throws noRecordsMatch error' do
     before do
       get '/catalog/oai?verb=ListRecords&metadataPrefix=oai_dc&from=2015-01-01'

data/spec/requests/list_sets_spec.rb

@@ -0,0 +1,101 @@
+require "spec_helper"
+
+RSpec.describe 'OAI-PMH ListSets Request' do
+  let(:xml) { Nokogiri::XML(response.body) }
+  let(:namespaces) do
+    {
+      dc: 'http://purl.org/dc/elements/1.1/',
+      xmlns: 'http://www.openarchives.org/OAI/2.0/',
+      oai_dc: 'http://www.openarchives.org/OAI/2.0/oai_dc/'
+    }
+  end
+  let(:test_oai_config) { {} }
+  let(:old_config) { CatalogController.new.oai_config }
+
+  before do
+    old_config
+    CatalogController.configure_blacklight do |config|
+      config.oai = test_oai_config
+    end
+  end
+
+  after do
+    CatalogController.configure_blacklight do |config|
+      config.oai = old_config
+    end
+  end
+
+  context 'without set configuration' do
+    it 'shows that no sets exist' do
+      get oai_provider_path(verb: 'ListSets')
+      expect(xml.xpath('//xmlns:error').text).to eql 'This repository does not support sets.'
+    end
+  end
+
+  context 'with set configuration' do
+    let(:test_oai_config) { old_config }
+
+    it 'shows all sets' do
+      get oai_provider_path(verb: 'ListSets')
+      expect(xml.xpath('//xmlns:set').count).to be 12
+    end
+
+    it 'contains english set' do
+      get oai_provider_path(verb: 'ListSets')
+      expect(xml.xpath('//xmlns:set//xmlns:setSpec').map(&:text)).to include 'language:English'
+      expect(xml.xpath('//xmlns:set//xmlns:setName').map(&:text)).to include 'Language: English'
+    end
+
+    it 'shows the correct verb' do
+      get oai_provider_path(verb: 'ListSets')
+      expect(xml.at_xpath('//xmlns:request').attribute('verb').value).to eql 'ListSets'
+    end
+  end
+
+  context 'when set configuration contains description' do
+    let(:test_oai_config) do
+      {
+        document: {
+          set_fields: [
+            { label: 'subject', solr_field: 'subject_topic_facet',
+              description: "Subject topic set using FAST subjects" }
+          ]
+        }
+      }
+    end
+
+    it 'shows set description' do
+      get oai_provider_path(verb: 'ListSets')
+      expect(
+        xml.at_xpath('//xmlns:set/xmlns:setDescription/oai_dc:dc/dc:description', namespaces).text
+      ).to eql 'Subject topic set using FAST subjects'
+    end
+  end
+
+  context 'when custom set model is provided' do
+    let(:test_oai_config) do
+      stub_const 'ChangeDescriptionSet', custom_set_model
+
+      {
+        document: {
+          set_model: ChangeDescriptionSet,
+          set_fields: [{ solr_field: 'format' }]
+        }
+      }
+    end
+    let(:custom_set_model) do
+      Class.new(BlacklightOaiProvider::SolrSet) do
+        def description
+          "This is a #{label} set containing records with the value of #{value}."
+        end
+      end
+    end
+
+    it "shows correct description" do
+      get oai_provider_path(verb: 'ListSets')
+      expect(
+        xml.at_xpath('//xmlns:set/xmlns:setDescription/oai_dc:dc/dc:description', namespaces).text
+      ).to eql 'This is a format set containing records with the value of Book.'
+    end
+  end
+end

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -10,7 +10,7 @@ class TestAppGenerator < Rails::Generators::Base
   def run_blacklight_generator
     say_status("warning", "GENERATING BL", :yellow)
 
-    generate 'blacklight', '--devise'
+    generate 'blacklight:install', '--devise'
   end
 
   # Add favicon.ico to asset path
@@ -26,10 +26,12 @@ class TestAppGenerator < Rails::Generators::Base
 
   # Override solr.yml to match settings needed for solr_wrapper.
   def update_solr_config
-    say_status("warning", "COPYING SOLR.YML", :yellow)
+    [:solr, :blacklight].each do |key|
+      say_status("warning", "COPYING #{key}.YML".upcase, :yellow)
 
-    remove_file "config/solr.yml"
-    copy_file "config/solr.yml", "config/solr.yml"
+      remove_file "config/#{key}.yml"
+      copy_file "config/solr.yml", "config/#{key}.yml"
+    end
   end
 
   def install_engine
@@ -61,7 +63,7 @@ class TestAppGenerator < Rails::Generators::Base
     config.oai = {
       :provider => {
         :repository_name => 'Test Repository',
-        :repository_url => 'http://localhost',
+        :repository_url => 'http://localhost/catalog/oai',
         :record_prefix => 'oai:test',
         :admin_email => 'root@localhost',
         :deletion_support => 'persistent',
@@ -69,17 +71,25 @@ class TestAppGenerator < Rails::Generators::Base
       },
       :document => {
         :model => SolrDocument,
+        :set_fields => [
+          { label: 'language', solr_field: 'language_facet' }
+        ],
         :limit => 25
       }
     }
       CONFIG
     end
 
-    insert_into_file "app/models/solr_document.rb", after: "  field_semantics.merge!(    \n" do
+    insert_into_file "app/models/solr_document.rb", after: "include BlacklightOaiProvider::SolrDocument\n" do
       <<-CONFIG
-    :creator => "author_display",
-    :date => "pub_date",
-    :subject => "subject_topic_facet",
+  field_semantics.merge!(
+    title: "title_display",
+    creator: "author_display",
+    date: "pub_date",
+    subject: "subject_topic_facet",
+    format: "format",
+    language: "language_facet"
+  )
       CONFIG
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_oai_provider
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.0.pre1
 platform: ruby
 authors:
 - Chris Beer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-04 00:00:00.000000000 Z
+date: 2017-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: oai
   requirement: !ruby/object:Gem::Requirement
@@ -205,10 +205,13 @@ files:
 - lib/blacklight_oai_provider.rb
 - lib/blacklight_oai_provider/engine.rb
 - lib/blacklight_oai_provider/exceptions.rb
+- lib/blacklight_oai_provider/response/list_sets.rb
 - lib/blacklight_oai_provider/resumption_token.rb
 - lib/blacklight_oai_provider/routes.rb
+- lib/blacklight_oai_provider/set.rb
 - lib/blacklight_oai_provider/solr_document_provider.rb
 - lib/blacklight_oai_provider/solr_document_wrapper.rb
+- lib/blacklight_oai_provider/solr_set.rb
 - lib/blacklight_oai_provider/version.rb
 - lib/generators/blacklight_oai_provider/install_generator.rb
 - lib/railties/blacklight_oai_provider.rake
@@ -231,12 +234,15 @@ files:
 - solr/sample_solr_documents.yml
 - spec/controllers/catalog_controller_spec.rb
 - spec/features/html_rendering_spec.rb
+- spec/lib/blacklight_oai_provider/solr_document_wrapper_spec.rb
+- spec/lib/blacklight_oai_provider/solr_set_spec.rb
 - spec/models/solr_document_spec.rb
 - spec/requests/get_record_spec.rb
 - spec/requests/identify_spec.rb
 - spec/requests/list_identifiers_spec.rb
 - spec/requests/list_metadata_formats_spec.rb
 - spec/requests/list_records_spec.rb
+- spec/requests/list_sets_spec.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/config/solr.yml
 - spec/test_app_templates/lib/generators/test_app_generator.rb
@@ -245,7 +251,7 @@ licenses: []
 metadata: {}
 post_install_message: |2+
 
-  BlacklightOaiProvider v4.1 implements configuration changes. Please visit README for more information.
+  BlacklightOaiProvider v5.x implements configuration changes. Please visit README for more information.
 
 rdoc_options: []
 require_paths:
@@ -257,9 +263,9 @@ 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: blacklight
 rubygems_version: 2.5.2
@@ -269,12 +275,15 @@ summary: Blacklight Oai Provider plugin
 test_files:
 - spec/controllers/catalog_controller_spec.rb
 - spec/features/html_rendering_spec.rb
+- spec/lib/blacklight_oai_provider/solr_document_wrapper_spec.rb
+- spec/lib/blacklight_oai_provider/solr_set_spec.rb
 - spec/models/solr_document_spec.rb
 - spec/requests/get_record_spec.rb
 - spec/requests/identify_spec.rb
 - spec/requests/list_identifiers_spec.rb
 - spec/requests/list_metadata_formats_spec.rb
 - spec/requests/list_records_spec.rb
+- spec/requests/list_sets_spec.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/config/solr.yml
 - spec/test_app_templates/lib/generators/test_app_generator.rb