blacklight_oai_provider 6.1.1 → 7.0.2

data/spec/requests/identify_spec.rb

@@ -12,7 +12,7 @@ describe 'OIA-PMH Identify Request' do
   end
 
   it "contains repository name" do
-    expect(xml.at_xpath('//xmlns:repositoryName').text).to eql 'Test Repository'
+    expect(xml.at_xpath('//xmlns:repositoryName').text).to eql 'Catalog Repository'
   end
 
   it "contains base url" do

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

@@ -11,6 +11,7 @@ class TestAppGenerator < Rails::Generators::Base
     say_status("warning", "GENERATING BL", :yellow)
 
     generate 'blacklight:install', '--devise'
+    generate 'blacklight:test_support'
   end
 
   def change_migrations_if_rails_4_2
@@ -45,24 +46,41 @@ class TestAppGenerator < Rails::Generators::Base
     end
   end
 
-  def overwrite_catalog_controller
-    copy_file "templates/catalog_controller.rb", "app/controllers/catalog_controller.rb", force: true
-  end
-
   def install_engine
     say_status("warning", "GENERATING BL OAI PLUGIN", :yellow)
 
     generate 'blacklight_oai_provider:install'
   end
 
-  def add_test_blacklight_oai_config
+  def add_test_blacklight_oai_controller_config
+    %w[catalog alternate].each { |cn| add_test_config_for(cn) }
+  end
+
+  def add_test_blacklight_oai_model_config
+    insert_into_file "app/models/solr_document.rb", after: "include BlacklightOaiProvider::SolrDocument\n" do
+      <<-CONFIG
+  field_semantics.merge!(
+    title: "title_tsim",
+    date: "pub_date_ssim",
+    subject: "subject_ssim",
+    creator: "author_tsim",
+    format: "format",
+    language: "language_ssim",
+  )
+      CONFIG
+    end
+  end
+
+  private
+
+  def add_test_config_for(controller_basename)
     say_status("warning", "ADDING BL OIA-PMH CONFIG")
 
-    insert_into_file "app/controllers/catalog_controller.rb", after: "config.default_solr_params = {" do
+    insert_into_file "app/controllers/#{controller_basename}_controller.rb", after: "config.default_solr_params = {" do
       "\n      fl: '*',\n"
     end
 
-    insert_into_file "app/controllers/catalog_controller.rb", after: "  configure_blacklight do |config|\n" do
+    insert_into_file "app/controllers/#{controller_basename}_controller.rb", after: "  configure_blacklight do |config|\n" do
       <<-CONFIG
     config.default_document_solr_params = {
       qt: 'search',
@@ -73,12 +91,12 @@ class TestAppGenerator < Rails::Generators::Base
       CONFIG
     end
 
-    insert_into_file "app/controllers/catalog_controller.rb", after: "configure_blacklight do |config|\n" do
+    insert_into_file "app/controllers/#{controller_basename}_controller.rb", after: "configure_blacklight do |config|\n" do
       <<-CONFIG
     config.oai = {
       provider: {
-        repository_name: 'Test Repository',
-        repository_url: 'http://localhost/catalog/oai',
+        repository_name: '#{controller_basename.titleize} Repository',
+        repository_url: 'http://localhost/#{controller_basename}/oai',
         record_prefix: 'oai:test',
         admin_email: 'root@localhost',
         deletion_support: 'persistent',
@@ -93,18 +111,5 @@ class TestAppGenerator < Rails::Generators::Base
     }
       CONFIG
     end
-
-    insert_into_file "app/models/solr_document.rb", after: "include BlacklightOaiProvider::SolrDocument\n" do
-      <<-CONFIG
-  field_semantics.merge!(
-    title: "title_tsim",
-    date: "pub_date_ssim",
-    subject: "subject_ssim",
-    creator: "author_tsim",
-    format: "format",
-    language: "language_ssim",
-  )
-      CONFIG
-    end
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_oai_provider
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 7.0.2
 platform: ruby
 authors:
 - Chris Beer
 - Carla Galarza
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-04 00:00:00.000000000 Z
+date: 2022-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -17,28 +17,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: oai
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -143,29 +157,29 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.64.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.64.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
-description: 
+        version: '1.8'
+description:
 email:
 - chris@cbeer.info
 - cmg2228@columbia.edu
@@ -220,6 +234,7 @@ files:
 - solr/sample_solr_documents.yml
 - spec/controllers/catalog_controller_spec.rb
 - spec/features/html_rendering_spec.rb
+- spec/integration/blacklight_oai_provider/solr_document_wrapper_spec.rb
 - spec/lib/blacklight_oai_provider/solr_document_provider_spec.rb
 - spec/lib/blacklight_oai_provider/solr_document_wrapper_spec.rb
 - spec/lib/blacklight_oai_provider/solr_set_spec.rb
@@ -233,11 +248,10 @@ files:
 - spec/spec_helper.rb
 - spec/test_app_templates/config/solr.yml
 - spec/test_app_templates/lib/generators/test_app_generator.rb
-- spec/test_app_templates/templates/catalog_controller.rb
 homepage: http://projectblacklight.org/
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -252,8 +266,24 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Blacklight Oai Provider plugin
-test_files: []
+test_files:
+- spec/controllers/catalog_controller_spec.rb
+- spec/features/html_rendering_spec.rb
+- spec/integration/blacklight_oai_provider/solr_document_wrapper_spec.rb
+- spec/lib/blacklight_oai_provider/solr_document_provider_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

data/spec/test_app_templates/templates/catalog_controller.rb

@@ -1,196 +0,0 @@
-# frozen_string_literal: true
-
-class CatalogController < ApplicationController
-  include Blacklight::Catalog
-  include BlacklightOaiProvider::Controller
-
-  configure_blacklight do |config|
-    ## Class for sending and receiving requests from a search index
-    # config.repository_class = Blacklight::Solr::Repository
-    #
-    ## Class for converting Blacklight's url parameters to into request parameters for the search index
-    # config.search_builder_class = ::SearchBuilder
-    #
-    ## Model that maps search index responses to the blacklight response model
-    # config.response_model = Blacklight::Solr::Response
-
-    ## Default parameters to send to solr for all search-like requests. See also SearchBuilder#processed_parameters
-    config.default_solr_params = {
-      rows: 10
-    }
-
-    # solr path which will be added to solr base url before the other solr params.
-    # config.solr_path = 'select'
-
-    # items to show per page, each number in the array represent another option to choose from.
-    # config.per_page = [10,20,50,100]
-
-    ## Default parameters to send on single-document requests to Solr. These settings are the Blackligt defaults (see SearchHelper#solr_doc_params) or
-    ## parameters included in the Blacklight-jetty document requestHandler.
-    #
-    # config.default_document_solr_params = {
-    #  qt: 'document',
-    #  ## These are hard-coded in the blacklight 'document' requestHandler
-    #  # fl: '*',
-    #  # rows: 1,
-    #  # q: '{!term f=id v=$id}'
-    # }
-
-    # solr field configuration for search results/index views
-    config.index.title_field = 'title_tsim'
-    config.index.display_type_field = 'format'
-    # config.index.thumbnail_field = 'thumbnail_path_ss'
-
-    # solr field configuration for document/show views
-    # config.show.title_field = 'title_ssim'
-    # config.show.display_type_field = 'format'
-    # config.show.thumbnail_field = 'thumbnail_path_ss'
-
-    # solr fields that will be treated as facets by the blacklight application
-    #   The ordering of the field names is the order of the display
-    #
-    # Setting a limit will trigger Blacklight's 'more' facet values link.
-    # * If left unset, then all facet values returned by solr will be displayed.
-    # * If set to an integer, then "f.somefield.facet.limit" will be added to
-    # solr request, with actual solr request being +1 your configured limit --
-    # you configure the number of items you actually want _ssimed_ in a page.
-    # * If set to 'true', then no additional parameters will be sent to solr,
-    # but any 'sniffed' request limit parameters will be used for paging, with
-    # paging at requested limit -1. Can sniff from facet.limit or
-    # f.specific_field.facet.limit solr request params. This 'true' config
-    # can be used if you set limits in :default_solr_params, or as defaults
-    # on the solr side in the request handler itself. Request handler defaults
-    # sniffing requires solr requests to be made with "echoParams=all", for
-    # app code to actually have it echo'd back to see it.
-    #
-    # :show may be set to false if you don't want the facet to be drawn in the
-    # facet bar
-    #
-    # set :index_range to true if you want the facet pagination view to have facet prefix-based navigation
-    #  (useful when user clicks "more" on a large facet and wants to navigate alphabetically across a large set of results)
-    # :index_range can be an array or range of prefixes that will be used to create the navigation (note: It is case sensitive when searching values)
-
-    config.add_facet_field 'format', label: 'Format'
-    config.add_facet_field 'pub_date_ssim', label: 'Publication Year', single: true
-    config.add_facet_field 'subject_tsim', label: 'Topic', limit: 20, index_range: 'A'..'Z'
-    config.add_facet_field 'language_ssim', label: 'Language', limit: true
-    config.add_facet_field 'lc_1letter_ssim', label: 'Call Number'
-    config.add_facet_field 'subject_geo_ssim', label: 'Region'
-    config.add_facet_field 'subject_era_ssim', label: 'Era'
-
-    config.add_facet_field 'example_pivot_field', label: 'Pivot Field', pivot: %w[format language_ssim]
-
-    config.add_facet_field 'example_query_facet_field', label: 'Publish Date', query: {
-      years_5: { label: 'within 5 Years', fq: "pub_date_ssim:[#{Time.zone.now.year - 5} TO *]" },
-      years_10: { label: 'within 10 Years', fq: "pub_date_ssim:[#{Time.zone.now.year - 10} TO *]" },
-      years_25: { label: 'within 25 Years', fq: "pub_date_ssim:[#{Time.zone.now.year - 25} TO *]" }
-    }
-
-    # Have BL send all facet field names to Solr, which has been the default
-    # previously. Simply remove these lines if you'd rather use Solr request
-    # handler defaults, or have no facets.
-    config.add_facet_fields_to_solr_request!
-
-    # solr fields to be displayed in the index (search results) view
-    #   The ordering of the field names is the order of the display
-    config.add_index_field 'title_tsim', label: 'Title'
-    config.add_index_field 'title_vern_tsim', label: 'Title'
-    config.add_index_field 'author_tsim', label: 'Author'
-    config.add_index_field 'author_vern_tsim', label: 'Author'
-    config.add_index_field 'format', label: 'Format'
-    config.add_index_field 'language_ssim', label: 'Language'
-    config.add_index_field 'published_ssim', label: 'Published'
-    config.add_index_field 'published_vern_ssim', label: 'Published'
-    config.add_index_field 'lc_callnum_ssim', label: 'Call number'
-
-    # solr fields to be displayed in the show (single result) view
-    #   The ordering of the field names is the order of the display
-    config.add_show_field 'title_ssim', label: 'Title'
-    config.add_show_field 'title_vern_ssim', label: 'Title'
-    config.add_show_field 'subtitle_tsim', label: 'Subtitle'
-    config.add_show_field 'subtitle_vern_tsim', label: 'Subtitle'
-    config.add_show_field 'author_tsim', label: 'Author'
-    config.add_show_field 'author_vern_tsim', label: 'Author'
-    config.add_show_field 'format', label: 'Format'
-    config.add_show_field 'url_fulltext_ssim', label: 'URL'
-    config.add_show_field 'url_suppl_ssim', label: 'More Information'
-    config.add_show_field 'language_ssim', label: 'Language'
-    config.add_show_field 'published_ssim', label: 'Published'
-    config.add_show_field 'published_vern_ssim', label: 'Published'
-    config.add_show_field 'lc_callnum_ssim', label: 'Call number'
-    config.add_show_field 'isbn_ssim', label: 'ISBN'
-
-    # "fielded" search configuration. Used by pulldown among other places.
-    # For supported keys in hash, see rdoc for Blacklight::SearchFields
-    #
-    # Search fields will inherit the :qt solr request handler from
-    # config[:default_solr_parameters], OR can specify a different one
-    # with a :qt key/value. Below examples inherit, except for subject
-    # that specifies the same :qt as default for our own internal
-    # testing purposes.
-    #
-    # The :key is what will be used to identify this BL search field internally,
-    # as well as in URLs -- so changing it after deployment may break bookmarked
-    # urls.  A display label will be automatically calculated from the :key,
-    # or can be specified manually to be different.
-
-    # This one uses all the defaults set by the solr request handler. Which
-    # solr request handler? The one set in config[:default_solr_parameters][:qt],
-    # since we aren't specifying it otherwise.
-
-    config.add_search_field 'all_fields', label: 'All Fields'
-
-    # Now we see how to over-ride Solr request handler defaults, in this
-    # case for a BL "search field", which is really a dismax aggregate
-    # of Solr search fields.
-
-    config.add_search_field('title') do |field|
-      # solr_parameters hash are sent to Solr as ordinary url query params.
-      field.solr_parameters = {
-        'spellcheck.dictionary': 'title',
-        qf: '${title_qf}',
-        pf: '${title_pf}'
-      }
-    end
-
-    config.add_search_field('author') do |field|
-      field.solr_parameters = {
-        'spellcheck.dictionary': 'author',
-        qf: '${author_qf}',
-        pf: '${author_pf}'
-      }
-    end
-
-    # Specifying a :qt only to show it's possible, and so our internal automated
-    # tests can test it. In this case it's the same as
-    # config[:default_solr_parameters][:qt], so isn't actually neccesary.
-    config.add_search_field('subject') do |field|
-      field.qt = 'search'
-      field.solr_parameters = {
-        'spellcheck.dictionary': 'subject',
-        qf: '${subject_qf}',
-        pf: '${subject_pf}'
-      }
-    end
-
-    # "sort results by" select (pulldown)
-    # label in pulldown is followed by the name of the SOLR field to sort by and
-    # whether the sort is ascending or descending (it must be asc or desc
-    # except in the relevancy case).
-    config.add_sort_field 'score desc, pub_date_ssim desc, title_si asc', label: 'relevance'
-    config.add_sort_field 'pub_date_ssim desc, title_si asc', label: 'year'
-    config.add_sort_field 'author_si asc, title_si asc', label: 'author'
-    config.add_sort_field 'title_si asc, pub_date_ssim desc', label: 'title'
-
-    # If there are more than this many search results, no spelling ("did you
-    # mean") suggestion is offered.
-    config.spell_max = 5
-
-    # Configuration for autocomplete suggestor
-    config.autocomplete_enabled = true
-    config.autocomplete_path = 'suggest'
-    # if the name of the solr.SuggestComponent provided in your solrcongig.xml is not the
-    # default 'mySuggester', uncomment and provide it below
-    # config.autocomplete_suggester = 'mySuggester'
-  end
-end