blacklight_oai_provider 0.1.0 → 4.1.0

data/spec/controllers/catalog_controller_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe CatalogController do
+  it "has a Blacklight module" do
+    expect(Blacklight).to be_a_kind_of Module
+  end
+
+  it 'has blacklight configuration' do
+    expect(described_class.blacklight_config).to be_a_kind_of Blacklight::Configuration
+  end
+
+  describe '#oai' do
+    it 'responds to oai' do
+      expect(controller).to respond_to :oai
+    end
+  end
+
+  describe '#oai_config' do
+    it 'returns correct configuration' do
+      expect(controller.oai_config).to match(
+        provider: {
+          repository_name: "Test Repository",
+          repository_url: "http://localhost",
+          record_prefix: "oai:test",
+          admin_email: "root@localhost",
+          deletion_support: "persistent",
+          sample_id: "109660"
+        },
+        document: { model: SolrDocument, limit: 25 }
+      )
+    end
+  end
+
+  describe '#oai_provider' do
+    it 'returns BlacklightOaiProvider::SolrDocumentProvider' do
+      expect(controller.oai_provider).to be_a BlacklightOaiProvider::SolrDocumentProvider
+    end
+  end
+end

data/spec/features/html_rendering_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+# Spot checking a few pages to ensure that the stylesheet is rendered correctly in browser.
+describe 'HTML page rendering', js: true do
+  it "root page" do
+    visit '/catalog/oai'
+    expect(page).to have_content 'not a legal OAI-PMH verb'
+  end
+
+  it "identify page" do
+    visit '/catalog/oai?verb=Identify'
+    expect(page).to have_xpath('//td[text()="Earliest Datestamp"]/parent::*/td[@class="value"]', text: '2014-02-03T18:42:53Z')
+  end
+
+  it "lists records" do
+    visit '/catalog/oai?verb=ListRecords&metadataPrefix=oai_dc'
+    expect(page).to have_content('OAI Record: oai:test:00282214')
+  end
+
+  it "document page" do
+    visit '/catalog/oai?verb=GetRecord&identifier=00282214&metadataPrefix=oai_dc'
+    expect(page).to have_xpath('//td[text()="Title"]/parent::*/td[@class="value"]', text: 'Fikr-i Ayāz')
+  end
+end

data/spec/models/solr_document_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+RSpec.describe SolrDocument do
+  it 'includes BlacklightOaiProvider::SolrDocument' do
+    expect(described_class.ancestors.include?(BlacklightOaiProvider::SolrDocument)).to be true
+  end
+
+  subject(:document) { described_class.new }
+
+  describe '#timestamp' do
+    it 'responds to timestamp' do
+      expect(document).to respond_to :timestamp
+    end
+
+    it 'throws error if timestamp field not available' do
+      expect {
+        document.timestamp
+      }.to raise_error BlacklightOaiProvider::Exceptions::MissingTimestamp
+    end
+
+    it 'returns timestamp' do
+      doc = described_class.new({ timestamp: '2017-10-16T19:20:14Z' })
+      expect(doc.timestamp).to be_a Time
+      expect(doc.timestamp.xmlschema).to eql '2017-10-16T19:20:14Z'
+    end
+  end
+
+  describe '#to_oai_dc' do
+    let(:valid_xml) do
+      '<oai_dc:dc xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/" xmlns:dc="http://purl.org/dc/elements/1.1/" '\
+      'xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai_dc/ '\
+      'http://www.openarchives.org/OAI/2.0/oai_dc.xsd"></oai_dc:dc>'
+    end
+
+    it 'responds to to_oai_dc' do
+      expect(document).to respond_to :to_oai_dc
+    end
+
+    it "returns xml document" do
+      expect(document.to_oai_dc).to eql valid_xml
+    end
+  end
+end

data/spec/requests/get_record_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe 'OIA-PMH GetRecord 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
+
+  before do
+    get '/catalog/oai?verb=GetRecord&identifier=2007020969&metadataPrefix=oai_dc'
+  end
+
+  it 'contains header information' do
+    expect(xml.at_xpath('//xmlns:GetRecord/xmlns:record/xmlns:header/xmlns:identifier').text).to eql 'oai:test:2007020969'
+    expect(xml.at_xpath('//xmlns:GetRecord/xmlns:record/xmlns:header/xmlns:datestamp').text).to eql '2014-02-03T18:42:53Z'
+  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
+
+  it 'contains date' do
+    expect(xml.at_xpath('//xmlns:metadata/oai_dc:dc/dc:date', namespaces).text).to eql '2008'
+  end
+
+  it 'contains subjects' do
+    nodes = xml.xpath('//xmlns:metadata/oai_dc:dc/dc:subject', namespaces)
+    expect(nodes.count).to be 4
+    expect(nodes.map(&:text)).to match_array ['Strong Medicine, 1922-', 'Delaware women', 'Indian women shamans', 'Delaware Indians']
+  end
+
+  it 'contains title' do
+    expect(xml.at_xpath('//xmlns:metadata/oai_dc:dc/dc:title', namespaces).text).to eql '"Strong Medicine speaks"'
+  end
+
+  it 'contains language' do
+    expect(xml.at_xpath('//xmlns:metadata/oai_dc:dc/dc:language', namespaces).text).to eql 'English'
+  end
+
+  it 'contains format' do
+    expect(xml.at_xpath('//xmlns:metadata/oai_dc:dc/dc:format', namespaces).text).to eql 'Book'
+  end
+end

data/spec/requests/identify_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe 'OIA-PMH Identify Request' do
+  let(:xml) { Nokogiri::XML(response.body) }
+
+  before do
+    get '/catalog/oai?verb=Identify'
+  end
+
+  it "contains response date" do
+    expect(Time.parse(xml.at_xpath('//xmlns:responseDate').text)).to be_within(5.seconds).of(Time.now)
+  end
+
+  it "contains repository name" do
+    expect(xml.at_xpath('//xmlns:repositoryName').text).to eql 'Test Repository'
+  end
+
+  it "contains base url" do
+    expect(xml.at_xpath('//xmlns:baseURL').text).to eql 'http://localhost'
+  end
+
+  it "contains protocol version" do
+    expect(xml.at_xpath('//xmlns:protocolVersion').text).to eql '2.0'
+  end
+
+  it "contains earliest datestamp" do
+    expect(xml.at_xpath('//xmlns:earliestDatestamp').text).to eql '2014-02-03T18:42:53Z'
+  end
+
+  it "contains delete records" do
+    expect(xml.at_xpath('//xmlns:deletedRecord').text).to eql 'persistent'
+  end
+
+  it "contains granularity" do
+    expect(xml.at_xpath('//xmlns:granularity').text).to eql 'YYYY-MM-DDThh:mm:ssZ'
+  end
+
+  it "contains admin email" do
+    expect(xml.at_xpath('//xmlns:adminEmail').text).to eql 'root@localhost'
+  end
+
+  it "contains repository prefix/identifier" do
+    expect(
+      xml.at_xpath('//oai-identifier:repositoryIdentifier', 'oai-identifier' => "http://www.openarchives.org/OAI/2.0/oai-identifier").text
+    ).to eql 'test'
+  end
+
+  it "contains sample identifier" do
+    expect(
+      xml.at_xpath('//oai-identifier:sampleIdentifier', 'oai-identifier' => "http://www.openarchives.org/OAI/2.0/oai-identifier").text
+    ).to eql 'oai:test:109660'
+  end
+end

data/spec/requests/list_identifiers_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe 'OIA-PMH ListIdentifiers Request' do
+  let(:xml) { Nokogiri::XML(response.body) }
+
+  context 'for all documents' do
+    before do
+      get '/catalog/oai?verb=ListIdentifiers&metadataPrefix=oai_dc'
+    end
+
+    it 'returns 25 records' do
+      expect(xml.xpath('//xmlns:ListIdentifiers/xmlns:header').count).to be 25
+    end
+
+    it 'first record has identifier and timestamp' do
+      expect(xml.at_xpath('//xmlns:ListIdentifiers/xmlns:header/xmlns:identifier').text).not_to eql ''
+      expect(xml.at_xpath('//xmlns:ListIdentifiers/xmlns:header/xmlns:datestamp').text).not_to eql ''
+    end
+
+    it 'contains resumptionToken' do
+      expect(xml.at_xpath('//xmlns:resumptionToken').text).to eql 'oai_dc.f(2014-02-03T18:42:53Z).u(2014-03-03T18:42:53Z).t(30):25'
+    end
+  end
+
+  context 'with resumption_token' do
+    before do
+      get '/catalog/oai?verb=ListIdentifiers&resumptionToken=oai_dc.f(2014-02-03T18:42:53Z).u(2014-03-03T18:42:53Z).t(30):25'
+    end
+
+    it 'returns 5 records' do
+      expect(xml.xpath('//xmlns:ListIdentifiers/xmlns:header').count).to be 5
+    end
+
+    it 'first record has identifier and timestamp' do
+      expect(xml.at_xpath('//xmlns:ListIdentifiers/xmlns:header/xmlns:identifier').text).not_to eql ''
+      expect(xml.at_xpath('//xmlns:ListIdentifiers/xmlns:header/xmlns:datestamp').text).not_to eql ''
+    end
+
+    it 'does not contain a resumptionToken' do
+      expect(xml.at_xpath('//xmlns:resumptionToken').text).to eql ''
+    end
+  end
+
+  context 'for all documents within a time range' do
+    before do
+      get '/catalog/oai?verb=ListIdentifiers&metadataPrefix=oai_dc&from=2014-03-03&until=2014-04-03'
+    end
+
+    it 'returns 1 record' do
+      expect(xml.xpath('//xmlns:ListIdentifiers/xmlns:header').count).to be 1
+    end
+
+    it 'does not contain a resumptionToken' do
+      expect(xml.at_xpath('//xmlns:resumptionToken')).to be_nil
+    end
+  end
+
+  context 'with different timestamp_field' do
+    before :all do
+      SolrDocument.timestamp_key = "record_creation_dt"
+    end
+
+    before do
+      get '/catalog/oai?verb=ListIdentifiers&metadataPrefix=oai_dc&from=2015-01-01'
+    end
+
+    after :all do
+      SolrDocument.timestamp_key = "timestamp"
+    end
+
+    it 'returns correct document' do
+      expect(xml.xpath('//xmlns:ListIdentifiers/xmlns:header').count).to be 1
+      expect(xml.at_xpath('//xmlns:ListIdentifiers/xmlns:header/xmlns:identifier').text).to eql 'oai:test:78908283'
+    end
+
+    it 'document displays correct timestamp' do
+      expect(xml.at_xpath('//xmlns:ListIdentifiers/xmlns:header/xmlns:datestamp').text).to eql '2015-02-03T18:42:53Z'
+    end
+  end
+end

data/spec/requests/list_metadata_formats_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe 'OIA-PMH ListMetadataFormats Request' do
+  let(:xml) { Nokogiri::XML(response.body) }
+
+  context 'without identifier parameter' do
+    before do
+      get '/catalog/oai?verb=ListMetadataFormats'
+    end
+
+    it 'contains oai_dc schema' do
+      expect(xml.at_xpath('//xmlns:ListMetadataFormats/xmlns:metadataFormat/xmlns:schema').text).to eql 'http://www.openarchives.org/OAI/2.0/oai_dc.xsd'
+    end
+
+    it 'contains oai_dc metadataPrefix' do
+      expect(xml.at_xpath('//xmlns:ListMetadataFormats/xmlns:metadataFormat/xmlns:metadataPrefix').text).to eql 'oai_dc'
+
+    end
+
+    it 'contains oai_dc metadataNamespace' do
+      expect(xml.at_xpath('//xmlns:ListMetadataFormats/xmlns:metadataFormat/xmlns:metadataNamespace').text).to eql 'http://www.openarchives.org/OAI/2.0/oai_dc/'
+    end
+  end
+
+  context 'with identifier parameter' do
+    before do
+      get '/catalog/oai?verb=ListMetadataFormats&identifier=2007020969'
+    end
+
+    it 'contains oai_dc schema' do
+      expect(xml.at_xpath('//xmlns:ListMetadataFormats/xmlns:metadataFormat/xmlns:schema').text).to eql 'http://www.openarchives.org/OAI/2.0/oai_dc.xsd'
+    end
+
+    it 'contains oai_dc metadataPrefix' do
+      expect(xml.at_xpath('//xmlns:ListMetadataFormats/xmlns:metadataFormat/xmlns:metadataPrefix').text).to eql 'oai_dc'
+
+    end
+
+    it 'contains oai_dc metadataNamespace' do
+      expect(xml.at_xpath('//xmlns:ListMetadataFormats/xmlns:metadataFormat/xmlns:metadataNamespace').text).to eql 'http://www.openarchives.org/OAI/2.0/oai_dc/'
+    end
+  end
+end

data/spec/requests/list_records_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+describe 'OIA-PMH ListRecords 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
+
+  context 'for all documents' do
+    before do
+      get '/catalog/oai?verb=ListRecords&metadataPrefix=oai_dc'
+    end
+
+    it 'returns 25 records' do
+      expect(xml.xpath('//xmlns:ListRecords/xmlns:record/xmlns:header').count).to be 25
+    end
+
+    it 'first record has oai_dc metadata element' do
+      expect(xml.at_xpath('//xmlns:ListRecords/xmlns:record/xmlns:metadata/oai_dc:dc', namespaces)).not_to be_nil
+    end
+
+    it 'contains resumptionToken' do
+      expect(xml.at_xpath('//xmlns:resumptionToken').text).to eql 'oai_dc.f(2014-02-03T18:42:53Z).u(2014-03-03T18:42:53Z).t(30):25'
+    end
+
+    context 'metadata element' do
+      let(:metadata_node) do
+        xml.xpath(
+          '//xmlns:ListRecords/xmlns:record/xmlns:header/xmlns:identifier[text()="oai:test:2007020969"]/parent::*/parent::*/xmlns:metadata/oai_dc:dc',
+          namespaces
+        )
+      end
+
+      it 'contains title' do
+        expect(metadata_node.at_xpath('dc:title', namespaces).text).to eql '"Strong Medicine speaks"'
+      end
+
+      it 'contains creator' do
+        expect(metadata_node.at_xpath('dc:creator', namespaces).text).to eql 'Hearth, Amy Hill, 1958-'
+      end
+
+      it 'contains type' do
+        expect(metadata_node.at_xpath('dc:date', namespaces).text).to eql '2008'
+      end
+
+      it 'contains language' do
+        expect(metadata_node.at_xpath('dc:language', namespaces).text).to eql 'English'
+      end
+
+      it 'contains format' do
+        expect(metadata_node.at_xpath('dc:format', namespaces).text).to eql 'Book'
+      end
+    end
+  end
+
+  context 'with resumption_token with date filter' do
+    before do
+      get '/catalog/oai?verb=ListRecords&resumptionToken=oai_dc.f(2014-02-03T18:42:53Z).u(2014-02-03T18:42:53Z).t(29):25'
+    end
+
+    it 'returns 4 records' do
+      expect(xml.xpath('//xmlns:ListRecords/xmlns:record/xmlns:header').count).to be 4
+    end
+
+    it 'first record has oai_dc metadata element' do
+      expect(xml.at_xpath('//xmlns:ListRecords/xmlns:record/xmlns:metadata/oai_dc:dc', namespaces)).not_to be_nil
+    end
+
+    it 'does not contain a resumptionToken' do
+      expect(xml.at_xpath('//xmlns:resumptionToken').text).to eql ''
+    end
+  end
+
+  context 'for all documents within a time range' do
+    before do
+      get '/catalog/oai?verb=ListRecords&metadataPrefix=oai_dc&from=2014-03-03&until=2014-04-03'
+    end
+
+    it 'returns 1 record' do
+      expect(xml.xpath('//xmlns:ListRecords/xmlns:record/xmlns:header').count).to be 1
+    end
+
+    it 'does not contain a resumptionToken' do
+      expect(xml.at_xpath('//xmlns:resumptionToken')).to be_nil
+    end
+  end
+
+  context 'for all document until a specified time' do
+    before do
+      get '/catalog/oai?verb=ListRecords&metadataPrefix=oai_dc&until=2014-02-03T18:42:53Z'
+    end
+  end
+
+  context 'throws noRecordsMatch error' do
+    before do
+      get '/catalog/oai?verb=ListRecords&metadataPrefix=oai_dc&from=2015-01-01'
+    end
+
+    it 'returns no records error' do
+      expect(xml.at_xpath('//xmlns:error').attribute('code').text).to eql 'noRecordsMatch'
+    end
+  end
+
+  context 'throws badArgument error' do
+    it 'when metadataPrefix argument missing' do
+      get '/catalog/oai?verb=ListRecords'
+      expect(xml.at_xpath('//xmlns:error[@code]').attribute('code').text).to eql 'badArgument'
+    end
+
+    it "when date is invalid" do
+      get '/catalog/oai?verb=ListRecords&metadataPrefix=oai_dc&from=2012-01-f01'
+      expect(xml.at_xpath('//xmlns:error[@code]').attribute('code').text).to eql 'badArgument'
+    end
+  end
+
+  context 'throws badResumptionToken error' do
+    it 'when resumptionToken is invalid' do
+      get '/catalog/oai?verb=ListRecords&resumptionToken=blahblahblah'
+      expect(xml.at_xpath('//xmlns:error').attribute('code').text).to eql 'badResumptionToken'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,47 +1,24 @@
-require 'rubygems'
-require 'bundler'
-
-Bundler.require :default, :development
-
-require 'blacklight/engine'
-require 'blacklight_oai_provider/engine'
+ENV["RAILS_ENV"] ||= 'test'
 require 'rsolr'
-require 'rsolr-ext'
-require 'rsolr-ext/response'
+require 'engine_cart'
+EngineCart.load_application!
+
+require 'rspec/rails'
 require 'capybara/rspec'
-Combustion.initialize!
+require 'selenium-webdriver'
 
+Capybara.javascript_driver = :headless_chrome
 
-# Setup blacklight environment
-Blacklight.solr_config = { :url => 'http://127.0.0.1:8983/solr' }
-CatalogController.send(:include, BlacklightOaiProvider::ControllerExtension)
+Capybara.register_driver :headless_chrome do |app|
+  capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(
+    chromeOptions: { args: %w[headless disable-gpu] }
+  )
 
-class SolrDocument
-  include Blacklight::Solr::Document
-  include BlacklightOaiProvider::SolrDocumentExtension
-use_extension( Blacklight::Solr::Document::DublinCore)    
-  field_semantics.merge!(    
-                         :title => "title_display",
-                         :author => "author_display",
-                         :language => "language_facet",
-                         :format => "format"
-                         )
-  
+  Capybara::Selenium::Driver.new(app,
+                                 browser: :chrome,
+                                 desired_capabilities: capabilities)
 end
 
-require 'vcr'
-
-VCR.configure do |config|
-  config.hook_into :fakeweb
-  config.cassette_library_dir = 'spec/vcr_cassettes'
-  config.default_cassette_options = { :serialize_with => :syck }
-end
-
-require 'rspec/rails'
-require 'capybara/rails'
-
 RSpec.configure do |config|
-  config.extend VCR::RSpec::Macros
-
+  config.infer_spec_type_from_file_location!
 end
-

data/spec/test_app_templates/config/solr.yml

@@ -0,0 +1,9 @@
+development:
+  adapter: solr
+  url: <%= ENV['SOLR_URL'] || "http://127.0.0.1:8983/solr/blacklight-core" %>
+test: &test
+  adapter: solr
+  url: <%= ENV['SOLR_URL'] || "http://127.0.0.1:#{ENV['TEST_JETTY_PORT'] || 8983}/solr/blacklight-core" %>
+production:
+  adapter: solr
+  url: <%= ENV['SOLR_URL'] || "http://127.0.0.1:8983/solr/blacklight-core" %>

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

@@ -0,0 +1,86 @@
+require 'rails/generators'
+
+class TestAppGenerator < Rails::Generators::Base
+  source_root File.expand_path("../../../../spec/test_app_templates", __FILE__)
+
+  # if you need to generate any additional configuration
+  # into the test app, this generator will be run immediately
+  # after setting up the application
+
+  def run_blacklight_generator
+    say_status("warning", "GENERATING BL", :yellow)
+
+    generate 'blacklight', '--devise'
+  end
+
+  # Add favicon.ico to asset path
+  # ADD THIS LINE Rails.application.config.assets.precompile += %w( favicon.ico )
+  # TO config/assets.rb
+  def add_favicon_to_asset_path
+    say_status("warning", "ADDING FAVICON TO ASSET PATH", :yellow)
+
+    append_to_file 'config/initializers/assets.rb' do
+      'Rails.application.config.assets.precompile += %w( favicon.ico )'
+    end
+  end
+
+  # Override solr.yml to match settings needed for solr_wrapper.
+  def update_solr_config
+    say_status("warning", "COPYING SOLR.YML", :yellow)
+
+    remove_file "config/solr.yml"
+    copy_file "config/solr.yml", "config/solr.yml"
+  end
+
+  def install_engine
+    say_status("warning", "GENERATING BL OAI PLUGIN", :yellow)
+
+    generate 'blacklight_oai_provider:install'
+  end
+
+  def add_test_blacklight_oai_config
+    say_status("warning", "ADDING BL OIA-PMH CONFIG")
+
+    insert_into_file "app/controllers/catalog_controller.rb", after: "    config.default_solr_params = { \n" do
+      "      :fl => '*',\n"
+    end
+
+    insert_into_file "app/controllers/catalog_controller.rb", after: "  configure_blacklight do |config|\n" do
+      <<-CONFIG
+    config.default_document_solr_params = {
+      :qt => 'search',
+      :fl => '*',
+      :rows => 1,
+      :q => '{!raw f=id v=$id}'
+    }
+      CONFIG
+    end
+
+    insert_into_file "app/controllers/catalog_controller.rb", after: "configure_blacklight do |config|\n" do
+      <<-CONFIG
+    config.oai = {
+      :provider => {
+        :repository_name => 'Test Repository',
+        :repository_url => 'http://localhost',
+        :record_prefix => 'oai:test',
+        :admin_email => 'root@localhost',
+        :deletion_support => 'persistent',
+        :sample_id => '109660'
+      },
+      :document => {
+        :model => SolrDocument,
+        :limit => 25
+      }
+    }
+      CONFIG
+    end
+
+    insert_into_file "app/models/solr_document.rb", after: "  field_semantics.merge!(    \n" do
+      <<-CONFIG
+    :creator => "author_display",
+    :date => "pub_date",
+    :subject => "subject_topic_facet",
+      CONFIG
+    end
+  end
+end