blacklight_oai_provider 5.1.0 → 6.0.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a928d521835ccd466eb70eaed91ac54a0680c60b
-  data.tar.gz: 923dbe6d7ec7c741fe4b63418a3b3ca51e8ed000
+  metadata.gz: 925f8e505c2c065988441a313a3cfd0788d08870
+  data.tar.gz: f0deb637627d94e7972d5061d66e4cdb80cbca62
 SHA512:
-  metadata.gz: 36e1822ae96de49092998f5e02bba8ed43f3811e905f324be337b398af8d758b9bc9cc56183c0fcdb1884c37b4cc34c07c12504be62a13ef16a6e66074e82a51
-  data.tar.gz: 56fbfd912c0a969f35609f61e997151bb5f7b96d41d254c785e9397d4603b628fb0a9f2d0c7a86bcfaf0e0a08f623c8c26962ddc16bb1756061944ff935f409f
+  metadata.gz: 45d6d9ef23dacabb77acc630c5f9d2d08ce61a2c336b1b74a48d6c80a76733837be8ff5507625b5e06d00641487611b1c5b200411af150b5854d7297b3a69971
+  data.tar.gz: ae5ea77c99bafe7a34bfcb7ee672e9b3016876071c325b98073ab4ac15de70fad59750c1dffe54687fba794eb94058322c16c62bb356501c36cab6d1b2214ba5

data/.travis.yml

@@ -3,14 +3,16 @@ notifications:
 
 language: ruby
 sudo: false
+addons:
+  chrome: stable
 rvm:
+  - 2.4
   - 2.3.3
-  - 2.2
-  - 2.1
 
 env:
  - "RAILS_VERSION=4.2.9"
- - "RAILS_VERSION=4.1.16"
+ - "RAILS_VERSION=5.0.6"
+ - "RAILS_VERSION=5.1.4"
 
 before_install:
   - gem install bundler

data/README.md

@@ -34,16 +34,25 @@ Then run
 ```ruby
 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:
+to install the appropriate extensions into your `CatalogController` class, `SolrDocument` class, and routes file. If you want to do customize the way this installs, instead you may:
 
-- add this to your Solr Document model:
+- add this to the SolrDocument model:
 ```ruby
 include BlacklightOaiProvider::SolrDocument
 ```
-- add this to your Controller:
+- add this to the Controller:
 ```ruby
 include BlacklightOaiProvider::Controller
 ```
+- add this to `config/routes.rb`
+```ruby
+  concern :oai_provider, BlacklightOaiProvider::Routes.new
+
+  resource :catalog, only: [:index], as: 'catalog', path: '/catalog', controller: 'catalog' do
+    concerns :oai_provider
+    ...
+  end
+```
 
 ## Configuration
 
@@ -134,23 +143,7 @@ config.oai = {
   }
 }
 ```
-## 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.
-
-You can turn off this injection if you like, although it will make the plugin less (or non-) functional unless you manually do similar injection. See `lib/blacklight_oai_provider.rb#inject!` to see exactly what's going on.
 
-In any initializer, you can set:
-```ruby
-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,
-}
-```
 ## Tests
 We use `engine_cart` and `solr_wrapper` to run tests on a dummy instance of an app using this plugin.
 

data/VERSION

@@ -1 +1 @@
-5.1.0
+6.0.0.pre1

data/app/controllers/concerns/blacklight_oai_provider/controller.rb

@@ -14,13 +14,12 @@ module BlacklightOaiProvider
     # Used when we need a second Solr query to get range facets, after the
     # first found min/max from result set.
     def oai
-      options = params.delete_if { |k, _| %w[controller action].include?(k) }
       body = oai_provider
-             .process_request(options)
+             .process_request(oai_params.to_h)
              .gsub('<?xml version="1.0" encoding="UTF-8"?>') do |m|
                "#{m}\n<?xml-stylesheet type=\"text/xsl\" href=\"#{ActionController::Base.helpers.asset_path('blacklight_oai_provider/oai2.xsl')}\"?>\n"
              end
-      render text: body, content_type: 'text/xml'
+      render xml: body, content_type: 'text/xml'
     end
 
     # Uses Blacklight.config, needs to be modified when
@@ -34,5 +33,11 @@ module BlacklightOaiProvider
     def oai_provider
       @oai_provider ||= BlacklightOaiProvider::SolrDocumentProvider.new(self, oai_config)
     end
+
+    private
+
+    def oai_params
+      params.permit(:verb, :identifier, :metadataPrefix, :set, :from, :until, :resumptionToken)
+    end
   end
 end

data/blacklight_oai_provider.gemspec

@@ -9,11 +9,6 @@ Gem::Specification.new do |s|
   s.homepage    = "http://projectblacklight.org/"
   s.summary = "Blacklight Oai Provider plugin"
 
-  s.post_install_message = %q{
-BlacklightOaiProvider v5.x implements configuration changes. Please visit README for more information.
-
-}
-
   s.rubyforge_project = "blacklight"
 
   s.files         = `git ls-files`.split("\n")
@@ -21,8 +16,8 @@ BlacklightOaiProvider v5.x implements configuration changes. Please visit README
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "rails", "~> 4.0"
-  s.add_dependency "blacklight", "~> 5.13"
+  s.add_dependency "rails", '>= 4.2', '< 6'
+  s.add_dependency "blacklight", '~> 6.0'
   s.add_dependency "oai", "~> 0.4"
   s.add_development_dependency 'rspec-rails', "~> 3.0"
   s.add_development_dependency 'capybara'

data/lib/blacklight_oai_provider.rb

@@ -12,20 +12,6 @@ module BlacklightOaiProvider
   require 'blacklight_oai_provider/version'
   require 'blacklight_oai_provider/engine'
 
-  @omit_inject = {}
-  def self.omit_inject=(value)
-    value = Hash.new(true) if value == true
-    @omit_inject = value
-  end
-
-  def self.omit_inject
-    @omit_inject
-  end
-
-  def self.inject!
-    Blacklight::Routes.send(:include, BlacklightOaiProvider::Routes) unless BlacklightOaiProvider.omit_inject[:routes]
-  end
-
   # Add element to array only if it's not already there
   def self.safe_arr_add(array, element)
     array << element unless array.include?(element)

data/lib/blacklight_oai_provider/engine.rb

@@ -4,15 +4,6 @@ require 'rails'
 
 module BlacklightOaiProvider
   class Engine < Rails::Engine
-    # Do these things in a to_prepare block, to try and make them work
-    # in development mode with class-reloading. The trick is we can't
-    # be sure if the controllers we're modifying are being reloaded in
-    # dev mode, if they are in the BL plugin and haven't been copied to
-    # local, they won't be. But we do our best.
-    config.to_prepare do
-      BlacklightOaiProvider.inject!
-    end
-
     # Add XSL Stylesheet to list of assets to be precompiled.
     initializer "blacklight_oai_provider.assets.precompile" do |app|
       app.config.assets.precompile += %w[blacklight_oai_provider/oai2.xsl]

data/lib/blacklight_oai_provider/routes.rb

@@ -1,15 +1,11 @@
 module BlacklightOaiProvider
-  module Routes
-    extend ActiveSupport::Concern
-
-    included do |klass|
-      klass.default_route_sets.insert(klass.default_route_sets.index(:export), :oai_routing)
+  class Routes
+    def initialize(defaults = {})
+      @defaults = defaults
     end
 
-    def oai_routing(primary_resource)
-      add_routes do
-        get "#{primary_resource}/oai", to: "#{primary_resource}#oai", as: 'oai_provider'
-      end
+    def call(mapper, _options = {})
+      mapper.match 'oai', action: 'oai', via: [:get, :post]
     end
   end
 end

data/lib/blacklight_oai_provider/solr_document_provider.rb

@@ -9,7 +9,7 @@ module BlacklightOaiProvider
       self.class.model = SolrDocumentWrapper.new(controller, options[:document])
 
       options[:repository_name] ||= controller.view_context.send(:application_name)
-      options[:repository_url] ||= controller.view_context.send(:oai_provider_url)
+      options[:repository_url] ||= controller.view_context.send(:oai_catalog_url)
 
       options[:provider].each do |k, v|
         self.class.send k, v

data/lib/generators/blacklight_oai_provider/install_generator.rb

@@ -23,5 +23,17 @@ module BlacklightOaiProvider
         end
       end
     end
+
+    def inject_blacklight_oai_routes
+      file_path = File.join('config', 'routes.rb')
+
+      inject_into_file file_path, after: 'Rails.application.routes.draw do' do
+        "\n  concern :oai_provider, BlacklightOaiProvider::Routes.new\n"
+      end
+
+      inject_into_file file_path, after: /resource :catalog,+(.*)do$/ do
+        "\n    concerns :oai_provider\n"
+      end
+    end
   end
 end

data/lib/railties/blacklight_oai_provider.rake

@@ -6,7 +6,7 @@ namespace :blacklight_oai_provider do
       require 'yaml'
 
       docs = YAML.safe_load(File.open(File.join(BlacklightOaiProvider.root, 'solr', 'sample_solr_documents.yml')))
-      conn = RSolr.connect(Blacklight.connection_config)
+      conn = Blacklight.default_index.connection
       conn.add docs
       conn.commit
     end

data/spec/requests/list_records_spec.rb

@@ -112,7 +112,7 @@ describe 'OIA-PMH ListRecords Request' do
     it 'only records from the set are returned' do
       params = { verb: 'ListRecords', metadataPrefix: 'oai_dc', set: 'language:Japanese' }
 
-      get oai_provider_path(params)
+      get oai_catalog_path(params)
       expect(xml.xpath('//xmlns:record').count).to be 2
     end
   end

data/spec/requests/list_sets_spec.rb

@@ -27,7 +27,7 @@ RSpec.describe 'OAI-PMH ListSets Request' do
 
   context 'without set configuration' do
     it 'shows that no sets exist' do
-      get oai_provider_path(verb: 'ListSets')
+      get oai_catalog_path(verb: 'ListSets')
       expect(xml.xpath('//xmlns:error').text).to eql 'This repository does not support sets.'
     end
   end
@@ -36,18 +36,18 @@ RSpec.describe 'OAI-PMH ListSets Request' do
     let(:test_oai_config) { old_config }
 
     it 'shows all sets' do
-      get oai_provider_path(verb: 'ListSets')
+      get oai_catalog_path(verb: 'ListSets')
       expect(xml.xpath('//xmlns:set').count).to be 12
     end
 
     it 'contains english set' do
-      get oai_provider_path(verb: 'ListSets')
+      get oai_catalog_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')
+      get oai_catalog_path(verb: 'ListSets')
       expect(xml.at_xpath('//xmlns:request').attribute('verb').value).to eql 'ListSets'
     end
   end
@@ -65,7 +65,7 @@ RSpec.describe 'OAI-PMH ListSets Request' do
     end
 
     it 'shows set description' do
-      get oai_provider_path(verb: 'ListSets')
+      get oai_catalog_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'
@@ -92,7 +92,7 @@ RSpec.describe 'OAI-PMH ListSets Request' do
     end
 
     it "shows correct description" do
-      get oai_provider_path(verb: 'ListSets')
+      get oai_catalog_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.'

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

@@ -13,6 +13,17 @@ class TestAppGenerator < Rails::Generators::Base
     generate 'blacklight:install', '--devise'
   end
 
+  def change_migrations_if_rails_4_2
+    return unless Rails.version =~ /^4.2.*/
+
+    say_status('warning', 'OVERRIDING BLACKLIGHT MIGRATION FOR RAILS 4.2', :yellow)
+    migrations = Rails.root.join('db', 'migrate', '*.rb')
+    Dir.glob(migrations).each do |m|
+      text = File.read(m).gsub(/ActiveRecord::Migration\[[\d\.]+\]/, 'ActiveRecord::Migration')
+      File.open(m, 'w').write(text)
+    end
+  end
+
   # Add favicon.ico to asset path
   # ADD THIS LINE Rails.application.config.assets.precompile += %w( favicon.ico )
   # TO config/assets.rb
@@ -43,8 +54,8 @@ class TestAppGenerator < Rails::Generators::Base
   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"
+    insert_into_file "app/controllers/catalog_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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_oai_provider
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 6.0.0.pre1
 platform: ruby
 authors:
 - Chris Beer
@@ -15,30 +15,36 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.13'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.13'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: oai
   requirement: !ruby/object:Gem::Requirement
@@ -249,10 +255,7 @@ files:
 homepage: http://projectblacklight.org/
 licenses: []
 metadata: {}
-post_install_message: |2+
-
-  BlacklightOaiProvider v5.x implements configuration changes. Please visit README for more information.
-
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -263,9 +266,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