blacklight_oai_provider 0.1.0 → 4.1.0

data/lib/blacklight_oai_provider/routes.rb

@@ -0,0 +1,15 @@
+module BlacklightOaiProvider
+  module Routes
+    extend ActiveSupport::Concern
+
+    included do |klass|
+      klass.default_route_sets.insert(klass.default_route_sets.index(:catalog), :oai_routing)
+    end
+
+    def oai_routing
+      add_routes do
+        get "catalog/oai", to: "catalog#oai", as: 'oai_provider'
+      end
+    end
+  end
+end

data/lib/blacklight_oai_provider/solr_document_provider.rb

@@ -1,8 +1,8 @@
 module BlacklightOaiProvider
   class SolrDocumentProvider < ::OAI::Provider::Base
     attr_accessor :options
-    def initialize controller, options = {}
 
+    def initialize(controller, options = {})
       options[:provider] ||= {}
       options[:document] ||= {}
 
@@ -11,7 +11,7 @@ module BlacklightOaiProvider
       options[:repository_name] ||= controller.view_context.send(:application_name)
       options[:repository_url] ||= controller.view_context.send(:oai_provider_url)
 
-      options[:provider].each do |k,v|
+      options[:provider].each do |k, v|
         self.class.send k, v
       end
     end

data/lib/blacklight_oai_provider/solr_document_wrapper.rb

@@ -1,57 +1,85 @@
 module BlacklightOaiProvider
   class SolrDocumentWrapper < ::OAI::Provider::Model
-    attr_reader :model, :timestamp_field
-    attr_accessor :options
-    def initialize(controller, options = {})
-      @controller = controller
-
-      defaults = { :timestamp => 'timestamp', :limit => 15} 
-      @options = defaults.merge options
+    attr_reader :document_model, :timestamp_field, :solr_timestamp, :limit
 
-      @timestamp_field = @options[:timestamp]
-      @limit = @options[:limit]
+    def initialize(controller, options = {})
+      @controller      = controller
+      @document_model  = options[:model] || ::SolrDocument
+      @solr_timestamp  = document_model.timestamp_key
+      @timestamp_field = 'timestamp' # method name used by ruby-oai
+      @limit           = options[:limit] || 15
     end
 
-    def sets
-    end
+    def sets; end
 
     def earliest
-      Time.parse @controller.get_search_results(@controller.params, {:fl => @timestamp_field, :sort => @timestamp_field +' asc', :rows => 1}).last.first.get(@timestamp_field)
+      _response, records = @controller.get_search_results(@controller.params, { fl: solr_timestamp, sort: "#{solr_timestamp} asc", rows: 1 })
+      records.first.timestamp
     end
 
     def latest
-      Time.parse @controller.get_search_results(@controller.params, {:fl => @timestamp_field, :sort => @timestamp_field +' desc', :rows => 1}).last.first.get(@timestamp_field)
+      _response, records = @controller.get_search_results(@controller.params, { fl: solr_timestamp, sort: "#{solr_timestamp} desc", rows: 1 })
+      records.first.timestamp
     end
 
-    def find(selector, options={})
+    def find(selector, options = {})
       return next_set(options[:resumption_token]) if options[:resumption_token]
 
-      if :all == selector
-        response, records = @controller.get_search_results(@controller.params, {:sort => @timestamp_field + ' asc', :rows => @limit})
+      if selector == :all
+        response, records = @controller.get_search_results(@controller.params, conditions(options))
 
-        if @limit && response.total >= @limit
-          return select_partial(OAI::Provider::ResumptionToken.new(options.merge({:last => 0})))
+        if limit && response.total > limit
+          return select_partial(BlacklightOaiProvider::ResumptionToken.new(options.merge(last: 0), nil, response.total))
         end
-      else                                                    
-        records = @controller.get_search_results(@controller.params, {:phrase_filters => {:id => selector.split('/', 2).last}}).last.first
+      else
+        _response, records = @controller.get_solr_response_for_doc_id selector.split('/', 2).last
       end
       records
     end
 
-    def select_partial token
-      records = @controller.get_search_results(@controller.params, {:sort => @timestamp_field + ' asc', :rows => @limit, :start => token.last}).last
+    def select_partial(token)
+      _response, records = @controller.get_search_results(@controller.params, token_conditions(token))
 
-      raise ::OAI::ResumptionTokenException.new unless records
+      raise ::OAI::ResumptionTokenException unless records
 
-      OAI::Provider::PartialResult.new(records, token.next(token.last+@limit))
+      OAI::Provider::PartialResult.new(records, token.next(token.last + limit))
     end
 
     def next_set(token_string)
-      raise ::OAI::ResumptionTokenException.new unless @limit
+      raise ::OAI::ResumptionTokenException unless limit
 
-      token = OAI::Provider::ResumptionToken.parse(token_string)
+      token = BlacklightOaiProvider::ResumptionToken.parse(token_string)
       select_partial(token)
     end
+
+    private
+
+    def base_conditions
+      { sort: "#{solr_timestamp} asc", rows: limit }
+    end
+
+    def token_conditions(token)
+      conditions(token.to_conditions_hash).merge(start: token.last)
+    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
+      end
+    end
+
+    def solr_date(time)
+      if time.respond_to?(:xmlschema)
+        time.utc.xmlschema # Force UTC.
+      elsif time.blank?
+        '*'
+      else
+        time.to_s
+      end
+    end
   end
 end
-

data/lib/blacklight_oai_provider/version.rb

@@ -4,7 +4,6 @@ module BlacklightOaiProvider
       @version ||= File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).chomp
     end
 
-    VERSION = self.version
+    VERSION = version
   end
 end
-

data/lib/blacklight_oai_provider.rb

@@ -1,33 +1,35 @@
-# BlacklightOaiProvider
-
 module BlacklightOaiProvider
-
-  autoload :ControllerExtension, 'blacklight_oai_provider/controller_extension'
-  autoload :SolrDocumentExtension, 'blacklight_oai_provider/solr_document_extension'
+  autoload :Exceptions, 'blacklight_oai_provider/exceptions'
   autoload :SolrDocumentProvider, 'blacklight_oai_provider/solr_document_provider'
   autoload :SolrDocumentWrapper, 'blacklight_oai_provider/solr_document_wrapper'
-  autoload :RouteSets, 'blacklight_oai_provider/route_sets'
+  autoload :ResumptionToken, 'blacklight_oai_provider/resumption_token'
+  autoload :Routes, 'blacklight_oai_provider/routes'
 
   require 'oai'
   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      
+    @omit_inject = value
+  end
+
+  def self.omit_inject
+    @omit_inject
   end
-  def self.omit_inject ; @omit_inject ; end
-  
+
   def self.inject!
-    unless BlacklightOaiProvider.omit_inject[:routes]
-      Blacklight::Routes.send(:include, BlacklightOaiProvider::RouteSets)
-    end
+    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)
   end
-  
+
+  # returns the full path the the blacklight plugin installation
+  def self.root
+    @root ||= File.expand_path(File.dirname(File.dirname(__FILE__)))
+  end
 end

data/lib/generators/blacklight_oai_provider/install_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators'
+
+module BlacklightOaiProvider
+  class InstallGenerator < Rails::Generators::Base
+    argument :model_name, type: :string, default: "SolrDocument"
+    argument :controller_name, type: :string, default: "CatalogController"
+
+    def inject_solr_document_concern
+      file_path = "app/models/#{model_name.underscore}.rb"
+
+      if File.exist? file_path
+        inject_into_file file_path, after: "include Blacklight::Solr::Document" do
+          "\n  include BlacklightOaiProvider::SolrDocument\n"
+        end
+      end
+    end
+
+    def inject_catalog_controller_concern
+      file_path = "app/controllers/#{controller_name.underscore}.rb"
+      if File.exist? file_path
+        inject_into_file file_path, after: "include Blacklight::Catalog" do
+          "\n  include BlacklightOaiProvider::Controller\n"
+        end
+      end
+    end
+  end
+end

data/lib/railties/blacklight_oai_provider.rake

@@ -0,0 +1,14 @@
+namespace :blacklight_oai_provider do
+  # Copied index seeding task from newer versions of Blacklight
+  namespace :index do
+    desc "Put sample data into solr"
+    task seed: [:environment] do
+      require 'yaml'
+
+      docs = YAML.safe_load(File.open(File.join(BlacklightOaiProvider.root, 'solr', 'sample_solr_documents.yml')))
+      conn = RSolr.connect(Blacklight.solr_config)
+      conn.add docs
+      conn.commit
+    end
+  end
+end

data/solr/conf/_rest_managed.json

@@ -0,0 +1,3 @@
+{
+  "initArgs":{},
+  "managedList":[]}

data/solr/conf/admin-extra.html

@@ -0,0 +1,31 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!-- The content of this page will be statically included into the top
+of the admin page.  Uncomment this as an example to see there the content
+will show up.
+
+<hr>
+<i>This line will appear before the first table</i>
+<tr>
+<td colspan="2">
+This row will be appended to the end of the first table
+</td>
+</tr>
+<hr>
+
+-->

data/solr/conf/elevate.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!-- If this file is found in the config directory, it will only be
+     loaded once at startup.  If it is found in Solr's data
+     directory, it will be re-loaded every commit.
+-->
+
+<elevate>
+ <query text="foo bar">
+  <doc id="1" />
+  <doc id="2" />
+  <doc id="3" />
+ </query>
+ 
+ <query text="ipod">
+   <doc id="MA147LL/A" />  <!-- put the actual ipod at the top -->
+   <doc id="IW-02" exclude="true" /> <!-- exclude this cable -->
+ </query>
+ 
+</elevate>

data/solr/conf/mapping-ISOLatin1Accent.txt

@@ -0,0 +1,246 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Syntax:
+#   "source" => "target"
+#     "source".length() > 0 (source cannot be empty.)
+#     "target".length() >= 0 (target can be empty.)
+
+# example:
+#   "??" => "A"
+#   "\u00C0" => "A"
+#   "\u00C0" => "\u0041"
+#   "??" => "ss"
+#   "\t" => " "
+#   "\n" => ""
+
+# ?? => A
+"\u00C0" => "A"
+
+# ?? => A
+"\u00C1" => "A"
+
+# ?? => A
+"\u00C2" => "A"
+
+# ?? => A
+"\u00C3" => "A"
+
+# ?? => A
+"\u00C4" => "A"
+
+# ?? => A
+"\u00C5" => "A"
+
+# ?? => AE
+"\u00C6" => "AE"
+
+# ?? => C
+"\u00C7" => "C"
+
+# ?? => E
+"\u00C8" => "E"
+
+# ?? => E
+"\u00C9" => "E"
+
+# ?? => E
+"\u00CA" => "E"
+
+# ?? => E
+"\u00CB" => "E"
+
+# ?? => I
+"\u00CC" => "I"
+
+# ?? => I
+"\u00CD" => "I"
+
+# ?? => I
+"\u00CE" => "I"
+
+# ?? => I
+"\u00CF" => "I"
+
+# ?? => IJ
+"\u0132" => "IJ"
+
+# ?? => D
+"\u00D0" => "D"
+
+# ?? => N
+"\u00D1" => "N"
+
+# ?? => O
+"\u00D2" => "O"
+
+# ?? => O
+"\u00D3" => "O"
+
+# ?? => O
+"\u00D4" => "O"
+
+# ?? => O
+"\u00D5" => "O"
+
+# ?? => O
+"\u00D6" => "O"
+
+# ?? => O
+"\u00D8" => "O"
+
+# ?? => OE
+"\u0152" => "OE"
+
+# ??
+"\u00DE" => "TH"
+
+# ?? => U
+"\u00D9" => "U"
+
+# ?? => U
+"\u00DA" => "U"
+
+# ?? => U
+"\u00DB" => "U"
+
+# ?? => U
+"\u00DC" => "U"
+
+# ?? => Y
+"\u00DD" => "Y"
+
+# ?? => Y
+"\u0178" => "Y"
+
+# ?? => a
+"\u00E0" => "a"
+
+# ?? => a
+"\u00E1" => "a"
+
+# ?? => a
+"\u00E2" => "a"
+
+# ?? => a
+"\u00E3" => "a"
+
+# ?? => a
+"\u00E4" => "a"
+
+# ?? => a
+"\u00E5" => "a"
+
+# ?? => ae
+"\u00E6" => "ae"
+
+# ?? => c
+"\u00E7" => "c"
+
+# ?? => e
+"\u00E8" => "e"
+
+# ?? => e
+"\u00E9" => "e"
+
+# ?? => e
+"\u00EA" => "e"
+
+# ?? => e
+"\u00EB" => "e"
+
+# ?? => i
+"\u00EC" => "i"
+
+# ?? => i
+"\u00ED" => "i"
+
+# ?? => i
+"\u00EE" => "i"
+
+# ?? => i
+"\u00EF" => "i"
+
+# ?? => ij
+"\u0133" => "ij"
+
+# ?? => d
+"\u00F0" => "d"
+
+# ?? => n
+"\u00F1" => "n"
+
+# ?? => o
+"\u00F2" => "o"
+
+# ?? => o
+"\u00F3" => "o"
+
+# ?? => o
+"\u00F4" => "o"
+
+# ?? => o
+"\u00F5" => "o"
+
+# ?? => o
+"\u00F6" => "o"
+
+# ?? => o
+"\u00F8" => "o"
+
+# ?? => oe
+"\u0153" => "oe"
+
+# ?? => ss
+"\u00DF" => "ss"
+
+# ?? => th
+"\u00FE" => "th"
+
+# ?? => u
+"\u00F9" => "u"
+
+# ?? => u
+"\u00FA" => "u"
+
+# ?? => u
+"\u00FB" => "u"
+
+# ?? => u
+"\u00FC" => "u"
+
+# ?? => y
+"\u00FD" => "y"
+
+# ?? => y
+"\u00FF" => "y"
+
+# ??? => ff
+"\uFB00" => "ff"
+
+# ??? => fi
+"\uFB01" => "fi"
+
+# ??? => fl
+"\uFB02" => "fl"
+
+# ??? => ffi
+"\uFB03" => "ffi"
+
+# ??? => ffl
+"\uFB04" => "ffl"
+
+# ??? => ft
+"\uFB05" => "ft"
+
+# ??? => st
+"\uFB06" => "st"

data/solr/conf/protwords.txt

@@ -0,0 +1,21 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#-----------------------------------------------------------------------
+# Use a protected word file to protect against the stemmer reducing two
+# unrelated words to the same base word.
+
+# Some non-words that normally won't be encountered,
+# just to test that they won't be stemmed.
+dontstems
+zwhacky
+