blacklight_oai_provider 0.1.0 → 4.1.0

metadata

@@ -1,221 +1,280 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_oai_provider
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 4.1.0
 platform: ruby
 authors:
 - Chris Beer
+- Carla Galarza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-16 00:00:00.000000000 Z
+date: 2017-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: oai
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: solr_wrapper
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: capybara
+  name: engine_cart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chromedriver-helper
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fakeweb
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.18.0
 description: 
 email:
 - chris@cbeer.info
+- cmg2228@columbia.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".solr_wrapper"
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
-- app/assets/xsl/oai2.xsl
+- app/assets/stylesheets/blacklight_oai_provider/oai2.xsl
+- app/controllers/concerns/blacklight_oai_provider/controller.rb
+- app/models/concerns/blacklight_oai_provider/solr_document.rb
 - blacklight_oai_provider.gemspec
-- config/routes.rb
+- config/initializers/oai_patches.rb
 - lib/blacklight_oai_provider.rb
-- lib/blacklight_oai_provider/README.rdoc
-- lib/blacklight_oai_provider/controller_extension.rb
 - lib/blacklight_oai_provider/engine.rb
-- lib/blacklight_oai_provider/route_sets.rb
-- lib/blacklight_oai_provider/solr_document_extension.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/blacklight_oai_provider_generator.rb
-- spec/acceptance/blacklight_oai_provider_spec.rb
-- spec/integration/blacklight_stub_spec.rb
-- spec/internal/app/controllers/application_controller.rb
-- spec/internal/app/models/solr_document.rb
-- spec/internal/config/database.yml
-- spec/internal/config/routes.rb
-- spec/internal/config/solr.yml
-- spec/internal/db/combustion_test.sqlite
-- spec/internal/db/schema.rb
-- spec/internal/log/.gitignore
-- spec/internal/public/favicon.ico
-- spec/lib/solr_document_extension_spec.rb
+- lib/generators/blacklight_oai_provider/install_generator.rb
+- lib/railties/blacklight_oai_provider.rake
+- solr/conf/_rest_managed.json
+- solr/conf/admin-extra.html
+- solr/conf/elevate.xml
+- solr/conf/mapping-ISOLatin1Accent.txt
+- solr/conf/protwords.txt
+- solr/conf/schema.xml
+- solr/conf/scripts.conf
+- solr/conf/solrconfig.xml
+- solr/conf/spellings.txt
+- solr/conf/stopwords.txt
+- solr/conf/stopwords_en.txt
+- solr/conf/synonyms.txt
+- solr/conf/xslt/example.xsl
+- solr/conf/xslt/example_atom.xsl
+- solr/conf/xslt/example_rss.xsl
+- solr/conf/xslt/luke.xsl
+- solr/sample_solr_documents.yml
+- spec/controllers/catalog_controller_spec.rb
+- spec/features/html_rendering_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/spec_helper.rb
-- spec/vcr_cassettes/solr.yml
+- spec/test_app_templates/config/solr.yml
+- spec/test_app_templates/lib/generators/test_app_generator.rb
 homepage: http://projectblacklight.org/
 licenses: []
-post_install_message: 
+metadata: {}
+post_install_message: |2+
+
+  BlacklightOaiProvider v4.1 implements configuration changes. Please visit README for more information.
+
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: blacklight
-rubygems_version: 1.8.23
+rubygems_version: 2.5.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Blacklight Oai Provider plugin
 test_files:
-- spec/acceptance/blacklight_oai_provider_spec.rb
-- spec/integration/blacklight_stub_spec.rb
-- spec/internal/app/controllers/application_controller.rb
-- spec/internal/app/models/solr_document.rb
-- spec/internal/config/database.yml
-- spec/internal/config/routes.rb
-- spec/internal/config/solr.yml
-- spec/internal/db/combustion_test.sqlite
-- spec/internal/db/schema.rb
-- spec/internal/log/.gitignore
-- spec/internal/public/favicon.ico
-- spec/lib/solr_document_extension_spec.rb
+- spec/controllers/catalog_controller_spec.rb
+- spec/features/html_rendering_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/spec_helper.rb
-- spec/vcr_cassettes/solr.yml
-has_rdoc: 
+- spec/test_app_templates/config/solr.yml
+- spec/test_app_templates/lib/generators/test_app_generator.rb

data/Gemfile.lock

@@ -1,187 +0,0 @@
-PATH
-  remote: .
-  specs:
-    blacklight_oai_provider (0.0.2)
-      blacklight
-      oai
-      rails (~> 3.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    actionmailer (3.2.8)
-      actionpack (= 3.2.8)
-      mail (~> 2.4.4)
-    actionpack (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.4)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.3)
-    activemodel (3.2.8)
-      activesupport (= 3.2.8)
-      builder (~> 3.0.0)
-    activerecord (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-    activesupport (3.2.8)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    addressable (2.3.2)
-    arel (3.0.2)
-    blacklight (3.5.0)
-      compass-rails (~> 1.0.0)
-      compass-susy-plugin (>= 0.9.0)
-      kaminari
-      marc (>= 0.4.3, < 1.1)
-      nokogiri (~> 1.5)
-      rails (~> 3.1)
-      rsolr (~> 1.0.6)
-      rsolr-ext (~> 1.0.3)
-      sass-rails
-      unicode
-    builder (3.0.0)
-    capybara (1.1.2)
-      mime-types (>= 1.16)
-      nokogiri (>= 1.3.3)
-      rack (>= 1.0.0)
-      rack-test (>= 0.5.4)
-      selenium-webdriver (~> 2.0)
-      xpath (~> 0.1.4)
-    childprocess (0.3.5)
-      ffi (~> 1.0, >= 1.0.6)
-    chunky_png (1.2.6)
-    combustion (0.3.2)
-      rails (>= 3.0.0)
-      thor (>= 0.14.6)
-    compass (0.12.2)
-      chunky_png (~> 1.2)
-      fssm (>= 0.2.7)
-      sass (~> 3.1)
-    compass-rails (1.0.3)
-      compass (>= 0.12.2, < 0.14)
-    compass-susy-plugin (0.9)
-      compass (>= 0.11.1)
-    diff-lcs (1.1.3)
-    erubis (2.7.0)
-    fakeweb (1.3.0)
-    faraday (0.8.4)
-      multipart-post (~> 1.1)
-    faraday_middleware (0.8.8)
-      faraday (>= 0.7.4, < 0.9)
-    ffi (1.1.5)
-    fssm (0.2.9)
-    hike (1.2.1)
-    i18n (0.6.0)
-    journey (1.0.4)
-    json (1.7.4)
-    kaminari (0.13.0)
-      actionpack (>= 3.0.0)
-      activesupport (>= 3.0.0)
-      railties (>= 3.0.0)
-    libwebsocket (0.1.5)
-      addressable
-    mail (2.4.4)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    marc (0.5.0)
-    mime-types (1.19)
-    multi_json (1.3.6)
-    multipart-post (1.1.5)
-    nokogiri (1.5.5)
-    oai (0.2.1)
-      builder (>= 2.0.0)
-      faraday
-      faraday_middleware
-    polyglot (0.3.3)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    rails (3.2.8)
-      actionmailer (= 3.2.8)
-      actionpack (= 3.2.8)
-      activerecord (= 3.2.8)
-      activeresource (= 3.2.8)
-      activesupport (= 3.2.8)
-      bundler (~> 1.0)
-      railties (= 3.2.8)
-    railties (3.2.8)
-      actionpack (= 3.2.8)
-      activesupport (= 3.2.8)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    rsolr (1.0.8)
-      builder (>= 2.1.2)
-    rsolr-ext (1.0.3)
-      rsolr (>= 1.0.2)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.2)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.2)
-    rspec-rails (2.11.0)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec (~> 2.11.0)
-    rubyzip (0.9.9)
-    sass (3.2.1)
-    sass-rails (3.2.5)
-      railties (~> 3.2.0)
-      sass (>= 3.1.10)
-      tilt (~> 1.3)
-    selenium-webdriver (2.25.0)
-      childprocess (>= 0.2.5)
-      libwebsocket (~> 0.1.3)
-      multi_json (~> 1.0)
-      rubyzip
-    sprockets (2.1.3)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.6)
-    thor (0.16.0)
-    tilt (1.3.3)
-    treetop (1.4.10)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.33)
-    unicode (0.4.3)
-    vcr (2.2.4)
-    xpath (0.1.4)
-      nokogiri (~> 1.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  blacklight_oai_provider!
-  capybara
-  combustion
-  fakeweb
-  rspec
-  rspec-rails
-  sqlite3
-  vcr

data/README.rdoc

@@ -1,74 +0,0 @@
-BlacklightOaiProvider: OAI-PMH service endpoint for Blacklight applications
-
-= Description
-
-The BlacklightOaiProvider plugin provides an Open Archives Initiative Protocolo for Metadata Harvesting (OAI-PMH) <http://www.openarchives.org/pmh/> data provider endpoint, using the ruby-oai gem, that let serice providers harvest that metadata.
-
-= Requirements
-
-A Rails app using Blacklight 3.x.
-
-OAI-PMH requires a timestamp field for all records, so your Solr index should include an appropriate field. By default, the name of this field is simply 'timestamp'.
-
-= Installation
-
-Add
-
-    gem "blacklight_oai_provider"
-
-to your Gemfile and  run "bundle install".
-
-Then run "rails generate blacklight_oai_provider" to install the appropriate extensions into your CatalogController and SolrDocument classes. In you want to do customize the way this installs, instead you may:
-
-- add this to your Solr Document model:
-    
-    use_extension(BlacklightOaiProvider::SolrDocumentExtension)
-
-- add this to your Controller:
-
-    include BlacklightOaiProvider::ControllerExtension
-
-
-= Configuration
-
-While the plugin provides some sensible (albeit generic) defaults out of the box, you probably will want to customize the OAI provider configuration. You can provide OAI-PMH provider parameters by placing the following in your blacklight configuration (in ./config/initializers/blacklight_config.rb), e.g.:
-
-config[:oai] = {
-    :provider => {
-      :repository_name => 'Test',
-      :repository_url => 'http://localhost',
-      :record_prefix => '',
-      :admin_email => 'root@localhost'
-    },
-    :document => {
-      :timestamp => 'timestamp',
-      :limit => 25
-    }
-  }
-
-The "provider" configuration is documented as part of the ruby-oai gem at http://oai.rubyforge.org/
-
-
-== 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:
-
-  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:
-   
-  BlacklightOaiProvider.omit_inject = {
-    :routes => false,
-  }
-
-= Tests
-
-There are none. This is bad I know, sorry. 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/config/routes.rb

@@ -1,5 +0,0 @@
-# We want to add a new collection action to Catalog, without over-writing
-# what's already there. This SEEMS to do it. 
-Rails.application.routes.draw do
-end
-

data/lib/blacklight_oai_provider/controller_extension.rb

@@ -1,29 +0,0 @@
-# Meant to be applied on top of a controller that implements
-# Blacklight::SolrHelper. Will inject range limiting behaviors
-# to solr parameters creation. 
-module BlacklightOaiProvider::ControllerExtension
-  def self.included(some_class)
-    some_class.helper_method :oai_config
-  end
-
-  # Action method of our own!
-  # Delivers a _partial_ that's a display of a single fields range facets.
-  # 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,v| %w{controller action}.include?(k) }
-    render :text => oai_provider.process_request(options).gsub('<?xml version="1.0" encoding="UTF-8"?>', "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<?xml-stylesheet type=\"text/xsl\" href=\"#{ ActionController::Base.helpers.asset_path('oai2.xsl')}\" ?>"), :content_type => 'text/xml'
-  end
-
-  # Uses Blacklight.config, needs to be modified when
-  # that changes to be controller-based. This is the only method
-  # in this plugin that accesses Blacklight.config, single point
-  # of contact.
-  def oai_config
-    blacklight_config.oai || {}
-  end
-
-  def oai_provider
-    @oai_provider ||= BlacklightOaiProvider::SolrDocumentProvider.new(self, oai_config)
-  end
-end

data/lib/blacklight_oai_provider/route_sets.rb

@@ -1,13 +0,0 @@
-module BlacklightOaiProvider
-  module RouteSets
-    protected
-    def catalog
-      add_routes do |options|
-        match 'catalog/oai' => 'catalog#oai', :as => 'oai_provider'
-      end
-
-      super
-    end
-  end
-end
-

data/lib/blacklight_oai_provider/solr_document_extension.rb

@@ -1,10 +0,0 @@
-# Meant to be applied on top of SolrDocument to implement
-# methods required by the ruby-oai provider
-module BlacklightOaiProvider::SolrDocumentExtension
-  def timestamp
-    Time.parse get('timestamp')
-  end
-  def to_oai_dc
-    export_as('oai_dc_xml')
-  end
-end