europeana-blacklight 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d75b280e4194a85ffb379a19407b6de1084ce7b0
-  data.tar.gz: d571e1f7bb56cadeaad835963913ae5321c0d63e
+  metadata.gz: 78442f9dbd68b04249c1bb5d6e0820ef4f75d925
+  data.tar.gz: bfcb4792d1cc6412a5551b76f67706f4b8aa7a6f
 SHA512:
-  metadata.gz: f6e5d347b85b1252a3770eac11503c291a3ab574d363901581db896bef5706320bfafa8a38856ecd812beea8b5f592854c3d8a049d0015877ec998450d444c71
-  data.tar.gz: 55929793d0f7f863744bf1a115d9bf29929ffc64cc7a15da2ef597bff619681462996add301bd0af9c3b5a70d2e80881f3c790f1a9b274365e073a56c974b4b9
+  metadata.gz: 0e0cde651009ecd7b881c0f34edc745d2b431a9f4664cf168c9f436521f664b4f08e127d1e5d4efcfa3721bac065a36ea05dd313ad31dd58fd6d0079b9aca9e8
+  data.tar.gz: c88b697f78b65c586ac09b377e4b166b9c028de0284fc8c22ca7600c202434a069890b70e3cedcbdb57b5a9373285641beb06812860a32d7dea649febc07ab5c

data/.ruby-style.yml

@@ -6,6 +6,7 @@ AllCops:
   Exclude:
   - "vendor/**/*"
   - "db/**/*"
+  - "lib/generators/europeana/blacklight/templates/**/*"
   RunRailsCops: true
   DisplayCopNames: false
   StyleGuideCopsOnly: false
@@ -497,7 +498,7 @@ Metrics/LineLength:
   Description: Limit lines to 80 characters.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#80-character-limits
   Enabled: true
-  Max: 80
+  Max: 140
   AllowURI: true
   URISchemes:
   - http

data/QUICKSTART.md

@@ -0,0 +1,42 @@
+# Europeana Blacklight Quick Start Guide
+
+## Install Rails 4
+```
+gem install rails
+rails -v
+# Rails 4.2.4
+```
+
+## Create a new Rails application
+```
+rails new culture_vulture
+cd culture_vulture
+```
+
+## Bundle europeana-blacklight
+Add to the Gemfile:
+```ruby
+gem 'europeana-blacklight',
+  github: 'europeana/europeana-blacklight',
+  require: 'europeana/blacklight'
+```
+
+## Get a Europeana API key 
+From http://labs.europeana.eu/api/
+
+## Install Blacklight with the Europeana API adapter
+```
+bundle install
+bundle exec rails generate blacklight:install --devise
+bundle exec rails generate europeana:blacklight:install YOUR_API_KEY
+bundle exec rake db:migrate
+```
+
+## Customise the config
+Review the generated `CatalogController` and adjust the default configuration
+to your preferences.
+
+## Start the application
+```
+bundle exec rails server
+```

data/README.md

@@ -1,62 +1,40 @@
 # Europeana::Blacklight
 
-[![Build Status](https://travis-ci.org/europeana/europeana-blacklight.svg?branch=master)](https://travis-ci.org/europeana/europeana-blacklight) [![Coverage Status](https://coveralls.io/repos/europeana/europeana-blacklight/badge.svg?branch=master&service=github)](https://coveralls.io/github/europeana/europeana-blacklight?branch=master) [![security](https://hakiri.io/github/europeana/europeana-blacklight/master.svg)](https://hakiri.io/github/europeana/europeana-blacklight/master)
+[![Build Status](https://travis-ci.org/europeana/europeana-blacklight.svg?branch=master)](https://travis-ci.org/europeana/europeana-blacklight) [![Coverage Status](https://coveralls.io/repos/europeana/europeana-blacklight/badge.svg?branch=master&service=github)](https://coveralls.io/github/europeana/europeana-blacklight?branch=master) [![security](https://hakiri.io/github/europeana/europeana-blacklight/master.svg)](https://hakiri.io/github/europeana/europeana-blacklight/master) [![Dependency Status](https://gemnasium.com/europeana/europeana-blacklight.svg)](https://gemnasium.com/europeana/europeana-blacklight)
 
 Ruby gem providing an adapter to use the
 [Europeana REST API](http://labs.europeana.eu/api/introduction/) as a data
 source for [Blacklight](http://projectblacklight.org/).
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+See the [Quick Start Guide](QUICKSTART.md).
 
-```ruby
-gem 'europeana-blacklight',
-  github: 'europeana/europeana-blacklight',
-  require: 'europeana/blacklight'
-```
+## Features
 
-And then execute:
+### Supported Blacklight features
 
-    $ bundle
+* Search
+* View record
+* Pagination of search results
+* Field facets
+* [Query facets](#query-facets)
+* Facet limits
+* Fielded search
+* Bookmarks
+* Range queries
 
-## Usage
+### Unsupported Blacklight features
 
-1. Get a Europeana API key from http://labs.europeana.eu/api/
-2. Set the API key in `config/blacklight.yml`:
-    
-    ```yml
-    production:
-      europeana_api_key: YOUR_API_KEY
-    ```
-    
-3. Configure Blacklight to use the Europeana API adapter:
-    
-    ```ruby
-    class CatalogController < ApplicationController
-      self.search_params_logic = Europeana::Blacklight::SearchBuilder.default_processor_chain
-
-      configure_blacklight do |config|
-        config.repository_class = Europeana::Blacklight::ApiRepository
-        config.search_builder_class = Europeana::Blacklight::SearchBuilder
-        config.response_model = Europeana::Blacklight::Response
-        config.document_model = Europeana::Blacklight::Document
-        config.document_presenter_class = Europeana::Blacklight::DocumentPresenter
-        config.facet_paginator_class = Europeana::Blacklight::FacetPaginator
-      end
-    end
-    ```
-
-4. Caching (optional)
-
-   To enable caching of API responses:
-
-   ```ruby
-   configure_blacklight do |config|
-     config.europeana_api_cache = Rails.cache # or any {ActiveSupport::Cache} instance
-     config.europeana_api_cache_expires_in = 60.minutes # defaults to 24.hours
-   end
-   ```
+* Result sorting :(
+* "Did you mean" spellcheck
+* MLT Solr-style (but see custom features)
+
+### Custom features
+
+* Nested EDM field names
+* MLT by record ID in :mlt URL parameter
+* Query facets with arbitrary API parameters
 
 ## Query facets
 
@@ -65,13 +43,14 @@ permit specification of multiple parameters to be passed to the API:
 
 ```ruby
 configure_blacklight do |config|
-  config.add_facet_field 'Cities (reusable content)', query: [
-    { label: 'Paris', fq: { qf: 'paris', reusability: 'open' } },
-    { label: 'Berlin', fq: { qf: 'berlin', reusability: 'open' } }
-  ]
+  config.add_facet_field 'Cities (reusable content)', query: {
+    paris: { label: 'Paris', fq: { qf: 'paris', reusability: 'open' } },
+    berlin: { label: 'Berlin', fq: { qf: 'berlin', reusability: 'open' } }
+  }
 end
 ```
 
 *Warning:* query facets are achieved by sending additional queries to the
-API. If you configure 10 query facets, this will result in an additional
-10 queries being sent to the API.
+API. If you configure 2 query facets each with 10 facet values, this will result
+in an additional 20 queries being sent to the API.
+

data/app/controllers/concerns/europeana/blacklight/catalog.rb

@@ -0,0 +1,73 @@
+module Europeana
+  module Blacklight
+    module Catalog
+      extend ActiveSupport::Concern
+
+      include ::Blacklight::Catalog
+      include Europeana::Blacklight::SearchHelper
+
+      included do
+        self.search_params_logic = Europeana::Blacklight::SearchBuilder.default_processor_chain
+
+        configure_blacklight do |config|
+          # Adapter classes
+          config.repository_class = Europeana::Blacklight::ApiRepository
+          config.search_builder_class = Europeana::Blacklight::SearchBuilder
+          config.response_model = Europeana::Blacklight::Response
+          config.document_model = Europeana::Blacklight::Document
+          config.document_presenter_class = Europeana::Blacklight::DocumentPresenter
+          # config.facet_paginator_class = Europeana::Blacklight::FacetPaginator
+
+          # Prevent BL's "did you mean" spellcheck feature kicking in
+          config.spell_max = -1
+        end
+      end
+
+      # Empty search returns all records
+      def has_search_parameters?
+        super || params.key?(:q) || params.key?(:mlt)
+      end
+
+      def search_results(user_params, _search_params_logic)
+        super.tap do |results|
+          if has_search_parameters?
+            results.first[:facet_queries] = europeana_api_query_facet_counts(user_params)
+          end
+        end
+      end
+
+      protected
+
+      def blacklight_query_facets
+        blacklight_config.facet_fields.select do |_, facet|
+          facet.query &&
+            (facet.include_in_request ||
+            (facet.include_in_request.nil? &&
+            blacklight_config.add_facet_fields_to_solr_request))
+        end
+      end
+
+      def europeana_api_query_facet_counts(user_params)
+        qf_counts = []
+
+        blacklight_query_facets.each_pair do |_facet_name, query_facet|
+          query_facet.query.each_pair do |_field_name, query_field|
+            count = europeana_api_query_facet_count(query_field[:fq], user_params)
+            qf_counts.push([query_field[:fq], count])
+          end
+        end
+
+        qf_counts.sort_by(&:last).reverse.each_with_object({}) do |qf, hash|
+          hash[qf.first] = qf.last
+        end
+      end
+
+      def europeana_api_query_facet_count(query_field_fq, user_params)
+        query = search_builder_class.new(search_params_logic, self).
+          with(user_params).with_overlay_params(query_field_fq || {}).query.
+          merge(rows: 0, start: 1, profile: 'minimal')
+        repository.search(query).total
+      end
+    end
+  end
+end

data/europeana-blacklight.gemspec

@@ -20,12 +20,15 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
+  spec.add_dependency 'activesupport', '>= 4.0', '< 5.0'
   spec.add_dependency 'blacklight', '>= 5.12.0', '< 6.0.0'
-  spec.add_dependency 'europeana-api', '~> 0.3.4'
+  spec.add_dependency 'europeana-api', '~> 0.4.0'
   spec.add_dependency 'iso-639', '~> 0.2.5'
   spec.add_dependency 'kaminari', '~> 0.16'
 
   spec.add_development_dependency 'bundler', '~> 1.8'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'shoulda-matchers', '~> 2.8'
+  spec.add_development_dependency 'webmock', '~> 1.21'
 end

data/lib/europeana/blacklight.rb

@@ -1,6 +1,9 @@
-require 'europeana/blacklight/version'
-require 'europeana/api'
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/module/delegation'
 require 'blacklight'
+require 'europeana/api'
+require 'europeana/blacklight/engine' if defined?(Rails)
+require 'europeana/blacklight/version'
 
 module Europeana
   ##
@@ -9,7 +12,10 @@ module Europeana
     autoload :ApiRepository, 'europeana/blacklight/api_repository'
     autoload :Document, 'europeana/blacklight/document'
     autoload :DocumentPresenter, 'europeana/blacklight/document_presenter'
+    # autoload :FacetPaginator, 'europeana/blacklight/facet_paginator'
     autoload :Response, 'europeana/blacklight/response'
+    autoload :Routes, 'europeana/blacklight/routes'
     autoload :SearchBuilder, 'europeana/blacklight/search_builder'
+    autoload :SearchHelper, 'europeana/blacklight/search_helper'
   end
 end

data/lib/europeana/blacklight/api_repository.rb

@@ -13,11 +13,7 @@ module Europeana
       # @return (see blacklight_config.response_model)
       def find(id, params = {})
         id = "/#{id}" unless id[0] == '/'
-        cache_key = "Europeana:API:Record:#{id}"
-        cache_key << ':' + params.to_query unless params.blank?
-        res = cached(cache_key) do
-          connection.record(id, auth_params(params))
-        end
+        res = connection.record(id, params)
 
         blacklight_config.response_model.new(
           res, params, document_model: blacklight_config.document_model,
@@ -26,10 +22,7 @@ module Europeana
       end
 
       def search(params = {})
-        cache_key = "Europeana:API:Search:" + params.to_query
-        res = cached(cache_key) do
-          connection.search(auth_params(params))
-        end
+        res = connection.search(params)
 
         blacklight_config.response_model.new(
           res, params, document_model: blacklight_config.document_model,
@@ -37,46 +30,6 @@ module Europeana
         )
       end
 
-      ##
-      # Fetches the hierarchy data for a Europeana record
-      #
-      # If the hierarchy data for the requested record is cached, that will be
-      # returned, otherwise it will be obtained from the Europeana REST API.
-      #
-      # @param id [String] Europeana record ID, with leading slash
-      # @return [Hash] Record's hierarchy data, or false if it has none
-      def fetch_document_hierarchy(id)
-        cached("Europeana:API:Record:hierarchy:#{id}") do
-          begin
-            europeana_api_document_hierarchy(id)
-          rescue Europeana::API::Errors::RequestError => error
-            unless error.message == 'This record has no hierarchical structure!'
-              raise
-            end
-            false
-          end
-        end
-      end
-
-      ##
-      # Requests hierarchy data for a Europeana record from the REST API
-      #
-      # The return value will contain a combination of the responses from the
-      # ancestor-self-siblings and children API endpoints.
-      #
-      # @param id [String] Europeana record ID, with leading slash
-      # @return [Hash] Record's hierarchy data
-      def europeana_api_document_hierarchy(id)
-        record = Europeana::API::Record.new(id, auth_params)
-        hierarchy = record.hierarchy('ancestor-self-siblings')
-
-        if hierarchy['self']['hasChildren']
-          hierarchy = record.hierarchy('ancestor-self-siblings', :children)
-        end
-
-        hierarchy
-      end
-
       ##
       # Queries the API for items similar to a given document
       def more_like_this(doc, field = nil, params = {})
@@ -88,19 +41,17 @@ module Europeana
       end
 
       def build_connection
-        Europeana::API
+        Europeana::API.tap do |api|
+          api.api_key = blacklight_config.connection_config[:europeana_api_key]
+          api.cache_store = cache_store
+          api.cache_expires_in = cache_expires_in
+        end
       end
 
       protected
 
-      def auth_params(params = {})
-        {
-          wskey: blacklight_config.connection_config[:europeana_api_key]
-        }.merge(params)
-      end
-
-      def cache
-        @cache ||= begin
+      def cache_store
+        @cache_store ||= begin
           blacklight_config.europeana_api_cache || ActiveSupport::Cache::NullStore.new
         end
       end
@@ -110,12 +61,6 @@ module Europeana
           blacklight_config.europeana_api_cache_expires_in || 24.hours
         end
       end
-
-      def cached(key)
-        cache.fetch(key, expires_in: cache_expires_in) do
-          yield
-        end
-      end
     end
   end
 end

data/lib/europeana/blacklight/document.rb

@@ -12,11 +12,11 @@ module Europeana
 
       include ActiveModel::Conversion
       include ::Blacklight::Document
+      include ::Blacklight::Document::ActiveModelShim
       include MoreLikeThis
       include Relations
 
       attr_writer :provider_id, :record_id
-      attr_accessor :hierarchy
 
       class << self
         # @todo Are three-letter language codes valid in EDM?
@@ -24,7 +24,12 @@ module Europeana
         #   output; remove when fixed at source
         def lang_map?(obj)
           return false unless obj.is_a?(Hash)
-          obj.keys.all? { |k| (k == 'def') || (k == '') || (!ISO_639.find(k.split('-').first).nil?) }
+          obj.keys.map(&:to_s).all? { |key| known_lang_map_key?(key) }
+        end
+
+        def known_lang_map_key?(key)
+          key = key.dup.downcase
+          ['def', '', 'sh'].include?(key) || (!ISO_639.find(key.split('-').first).nil?)
         end
 
         def localize_lang_map(lang_map)
@@ -49,6 +54,8 @@ module Europeana
         end
       end
 
+      delegate :lang_map?, :localize_lang_map, to: :class
+
       def initialize(source_doc = {}, response = nil)
         fields, @relations = extract_relations(source_doc)
         super(fields, response)
@@ -86,11 +93,11 @@ module Europeana
         true
       end
 
-      def private?(exhibit)
-        !public?(exhibit)
+      def private?(_exhibit)
+        false
       end
 
-      def public?(exhibit)
+      def public?(_exhibit)
         true
       end
 
@@ -102,25 +109,13 @@ module Europeana
         @record_id ||= id.to_s.split('/')[2]
       end
 
-      def as_json(options = nil)
-        json = super
-        unless @hierarchy.nil?
-          json.merge!('hierarchy' => @hierarchy.as_json(options))
-        end
-        json.tap do |j|
+      def as_json(options = {})
+        super.tap do |json|
           relations.each do |k, v|
-            j[k] = v.as_json
+            json[k] = v.as_json
           end
         end
       end
-
-      def lang_map?(obj)
-        self.class.lang_map?(obj)
-      end
-
-      def localize_lang_map(lang_map)
-        self.class.localize_lang_map(lang_map)
-      end
     end
   end
 end

data/lib/europeana/blacklight/document/relations.rb

@@ -68,6 +68,31 @@ module Europeana
           end
         end
 
+        def has?(k, *values)
+          if !key?(k)
+            false
+          elsif values.empty?
+            fetch(k, nil).present?
+          else
+            Array(values).any? do |expected|
+              Array(fetch(k, nil)).any? do |actual|
+                case expected
+                when Regexp
+                  actual =~ expected
+                else
+                  actual == expected
+                end
+              end
+            end
+          end
+        end
+
+        def key?(k)
+          [nested_field_container(k)].flatten.any? do |container|
+            container._source.key?(nested_field_key(k))
+          end
+        end
+
         def has_relation?(name)
           relations.key?(name.to_s)
         end

data/lib/europeana/blacklight/document_presenter.rb

@@ -3,7 +3,7 @@ module Europeana
     ##
     # Blacklight document presenter for Europeana documents
     class DocumentPresenter < ::Blacklight::DocumentPresenter
-      include ActionView::Helpers::AssetTagHelper
+      include ActionView::Helpers::AssetTagHelper # ?
 
       def render_document_show_field_value(field, options = {})
         render_nested_field_value(field, :show, options)

data/lib/europeana/blacklight/engine.rb

@@ -0,0 +1,11 @@
+module Europeana
+  module Blacklight
+    class Engine < Rails::Engine
+      engine_name 'europeana_blacklight'
+
+      initializer 'europeana_blacklight.routes' do |_app|
+        ::Blacklight::Routes.send(:include, Europeana::Blacklight::Routes)
+      end
+    end
+  end
+end

data/lib/europeana/blacklight/facet_paginator.rb

@@ -2,7 +2,7 @@ module Europeana
   module Blacklight
     ##
     # Facet paginator for Europeana API
-    class FacetPaginator < Blacklight::FacetPaginator
+    class FacetPaginator < ::Blacklight::FacetPaginator
     end
   end
 end

data/lib/europeana/blacklight/response/pagination.rb

@@ -10,6 +10,7 @@ module Europeana
       module Pagination
         include Kaminari::PageScopeMethods
         include Kaminari::ConfigurationMethods::ClassMethods
+        extend ActiveSupport::Concern
 
         def limit_value
           rows
@@ -28,6 +29,15 @@ module Europeana
           docs.first.model_name
         end
 
+        def max_pages
+          (defined?(@_max_pages) && @_max_pages) || (1000 / limit_value)
+        end
+
+        def total_pages
+          total = super
+          total > max_pages ? max_pages : total
+        end
+
         def next_page
           current_page + 1 unless last_page?
         end

data/lib/europeana/blacklight/routes.rb

@@ -0,0 +1,26 @@
+module Europeana
+  module Blacklight
+    ##
+    # URL routing for Blacklight
+    module Routes
+      extend ActiveSupport::Concern
+
+      included do |klass|
+        klass.default_route_sets -= [:solr_document]
+        unless klass.default_route_sets.include?(:europeana_document)
+          klass.default_route_sets += [:europeana_document]
+        end
+      end
+
+      def europeana_document(primary_resource)
+        add_routes do |options|
+          args = { only: [:show] }
+          args[:constraints] = options[:constraints] if options[:constraints]
+
+          post 'record/*id/track', args.merge(to: "#{primary_resource}#track", as: 'track_document')
+          get 'record/*id', args.merge(to: "#{primary_resource}#show", as: 'document')
+        end
+      end
+    end
+  end
+end

data/lib/europeana/blacklight/search_builder.rb

@@ -5,21 +5,26 @@ module Europeana
     class SearchBuilder < ::Blacklight::SearchBuilder
       require 'europeana/blacklight/search_builder/facet_pagination'
       require 'europeana/blacklight/search_builder/more_like_this'
+      require 'europeana/blacklight/search_builder/overlay_params'
       require 'europeana/blacklight/search_builder/ranges'
 
+      attr_accessor :default_processor_chain
       self.default_processor_chain = [
         :default_api_parameters, :add_profile_to_api,
-        :add_query_to_api, :add_qf_to_api, :add_facet_qf_to_api,
-        :add_reusability_to_api, :add_facetting_to_api, :add_paging_to_api,
+        :add_query_to_api, :add_qf_to_api, :add_facet_qf_to_api, :add_query_facet_to_api,
+        :add_standalone_facets_to_api, :add_facetting_to_api, :add_paging_to_api,
         :add_sorting_to_api
       ]
 
       include FacetPagination
       include MoreLikeThis
       include Ranges
+      include OverlayParams
 
       delegate :to_query, to: :to_hash
 
+      STANDALONE_FACETS = %w(COLOURPALETTE MEDIA REUSABILITY)
+
       ##
       # Start with general defaults from BL config. Need to use custom
       # merge to dup values, to avoid later mutating the original by mistake.
@@ -87,23 +92,47 @@ module Europeana
       def add_facet_qf_to_api(api_parameters)
         return unless blacklight_params[:f]
 
-        salient_facets = blacklight_params[:f].reject do |k, _v|
-          k == 'REUSABILITY'
+        salient_facets = blacklight_params[:f].select do |k, _v|
+          !STANDALONE_FACETS.include?(k) && api_request_facet_fields.keys.include?(k)
         end
 
         salient_facets.each_pair do |facet_field, value_list|
           Array(value_list).reject(&:blank?).each do |value|
             api_parameters[:qf] ||= []
-            api_parameters[:qf] << "#{facet_field}:\"#{value}\""
+            if Europeana::API::Search::Fields::MEDIA.include?(facet_field)
+              api_parameters[:qf] << "#{facet_field}:#{value}"
+            else
+              api_parameters[:qf] << "#{facet_field}:\"#{value}\""
+            end
+          end
+        end
+      end
+
+      ##
+      # Filter results by a query facet
+      def add_query_facet_to_api(_api_parameters)
+        return unless blacklight_params[:f]
+
+        salient_facets = blacklight_params[:f].select do |k, _v|
+          facet = blacklight_config.facet_fields[k]
+          facet.query && (facet.include_in_request || (facet.include_in_request.nil? && blacklight_config.add_facet_fields_to_solr_request))
+        end
+
+        salient_facets.each_pair do |facet_field, value_list|
+          Array(value_list).reject(&:blank?).each do |value|
+            with_overlay_params(blacklight_config.facet_fields[facet_field].query[value][:fq])
           end
         end
       end
 
-      # bizarrely, reusability is a distinct API param, even though it
-      # is returned with the facets in a search response
-      def add_reusability_to_api(api_parameters)
-        if blacklight_params[:f] && blacklight_params[:f]['REUSABILITY']
-          api_parameters[:reusability] = blacklight_params[:f]['REUSABILITY'].join(',')
+      ##
+      # Some facets need to be filtered as distinct API params, even though
+      # they are returned with the facets in a search response
+      def add_standalone_facets_to_api(api_parameters)
+        STANDALONE_FACETS.each do |field|
+          if blacklight_params[:f] && blacklight_params[:f][field]
+            api_parameters[field.downcase.to_sym] = blacklight_params[:f][field].join(',')
+          end
         end
       end
 
@@ -115,7 +144,9 @@ module Europeana
       # @see http://labs.europeana.eu/api/search/#individual-facets
       # @see http://labs.europeana.eu/api/search/#offset-and-limit-of-facets
       def add_facetting_to_api(api_parameters)
-        api_parameters[:facet] = api_request_facet_fields.keys.join(',')
+        api_parameters[:facet] = api_request_facet_fields.keys.map do |field|
+          Europeana::API::Search::Fields::MEDIA.include?(field) ? 'DEFAULT' : field
+        end.uniq.join(',')
 
         api_request_facet_fields.each do |field_name, facet|
           api_parameters[:"f.#{facet.field}.facet.limit"] = (facet_limit_for(field_name) + 1) if facet_limit_for(field_name)

data/lib/europeana/blacklight/search_builder/overlay_params.rb

@@ -0,0 +1,39 @@
+module Europeana
+  module Blacklight
+    class SearchBuilder
+      ##
+      # "Overlay" params do not replace others, but are combined with them, into
+      # multiple values for those param keys
+      module OverlayParams
+        extend ActiveSupport::Concern
+
+        included do
+          default_processor_chain << :add_overlay_params_to_api
+        end
+
+        def with_overlay_params(overlay_params = {})
+          @overlay_params ||= []
+          @overlay_params << overlay_params
+          self
+        end
+
+        def add_overlay_params_to_api(api_parameters)
+          return unless @overlay_params
+
+          @overlay_params.each do |param_set|
+            param_set.each_pair do |k, v|
+              k = k.to_sym
+              if api_parameters.key?(k)
+                api_parameters[k] = [api_parameters[k]].flatten # in case it's not an Array
+              else
+                api_parameters[k] = []
+              end
+              api_parameters[k] += [v]
+              api_parameters[k] = api_parameters[k].flatten.uniq
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/europeana/blacklight/search_builder/ranges.rb

@@ -2,7 +2,7 @@ module Europeana
   module Blacklight
     class SearchBuilder
       ##
-      # Search builder with content channel qf
+      # Search builder methods for ranges
       module Ranges
         extend ActiveSupport::Concern
 

data/lib/europeana/blacklight/search_helper.rb

@@ -0,0 +1,41 @@
+module Europeana
+  module Blacklight
+    ##
+    # Local overrides for {Blacklight::SearchHelper}
+    module SearchHelper
+      def previous_and_next_document_params(index, window = 1)
+        api_params = {}
+
+        if index > 1
+          api_params[:start] = index - window # get one before
+          api_params[:rows] = 2 * window + 1 # and one after
+        else
+          api_params[:start] = 1 # there is no previous doc
+          api_params[:rows] = 2 * window # but there should be one after
+        end
+
+        api_params
+      end
+
+      private
+
+      def fetch_many(ids = [], *args)
+        if args.length == 1
+          user_params = params
+          extra_controller_params = args.first || {}
+        else
+          user_params, extra_controller_params = args
+          user_params ||= params
+          extra_controller_params ||= {}
+        end
+
+        id_query = ids.map { |id| "europeana_id:\"/#{id}\"" }.join(' OR ')
+
+        query = search_builder.with(user_params).where(id_query)
+        api_response = repository.search(query.merge(extra_controller_params))
+
+        [api_response, api_response.documents]
+      end
+    end
+  end
+end

data/lib/europeana/blacklight/version.rb

@@ -1,5 +1,5 @@
 module Europeana
   module Blacklight
-    VERSION = '0.2.7'
+    VERSION = '0.3.0'
   end
 end

data/lib/generators/europeana/blacklight/install_generator.rb

@@ -0,0 +1,28 @@
+module Europeana
+  module Blacklight
+    class Install < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :europeana_api_key, type: :string
+      argument :controller_name, type: :string, default: 'catalog'
+
+      def disable_rsolr_gem
+        comment_lines('Gemfile', /gem 'rsolr'/)
+      end
+
+      def bundle_install
+        Bundler.with_clean_env do
+          run 'bundle install'
+        end
+      end
+
+      def create_configuration_files
+        template 'config/blacklight.yml', 'config/blacklight.yml'
+      end
+
+      def generate_controller
+        template 'catalog_controller.rb', "app/controllers/#{controller_name}_controller.rb"
+      end
+    end
+  end
+end

data/lib/generators/europeana/blacklight/templates/catalog_controller.rb

@@ -0,0 +1,81 @@
+# -*- encoding : utf-8 -*-
+class <%= controller_name.classify %>Controller < ApplicationController
+  include Europeana::Blacklight::Catalog
+
+  configure_blacklight do |config|
+    # Europeana API caching
+    config.europeana_api_cache = Rails.cache
+    config.europeana_api_cache_expires_in = 24.hours
+
+    # Default parameters to send to Europeana for all search-like requests.
+    # @see SolrHelper#solr_search_params
+    config.default_solr_params = {
+      rows: 24
+    }
+
+    # items to show per page, each number in the array represents another
+    # option to choose from.
+    config.per_page = [12, 24, 48, 96]
+
+    # Field configuration for search results/index views
+    config.index.title_field = 'title'
+    config.index.display_type_field = 'type'
+    config.index.timestamp_field = nil # Europeana's is in microseconds
+    config.index.thumbnail_field = 'edmPreview'
+
+    # Fields to be displayed in the index (search results) view
+    # The ordering of the field names is the order of the display 
+    # @see http://labs.europeana.eu/api/data-fields
+    config.add_index_field 'edmAgentLabelLangAware', label: 'Creator'
+    config.add_index_field 'dcDescription', label: 'Description'
+    config.add_index_field 'edmConceptPrefLabelLangAware',
+      separator: '; ', limit: 4, label: 'Subject'
+    config.add_index_field 'year', label: 'Year'
+    config.add_index_field 'dataProvider', label: 'Data provider'
+
+    # Facet fields in the order they should be displayed.
+    # @see http://labs.europeana.eu/api/search#individual-facets
+    config.add_facet_field 'TYPE'
+    config.add_facet_field 'REUSABILITY'
+    config.add_facet_field 'COUNTRY'
+    config.add_facet_field 'LANGUAGE'
+    config.add_facet_field 'PROVIDER'
+    config.add_facet_field 'DATA_PROVIDER'
+    config.add_facet_field 'YEAR'
+    config.add_facet_field 'RIGHTS'
+
+    # Send all facet field names to the API.
+    config.add_facet_fields_to_solr_request!
+
+    # Fields to be displayed in the object view, in the order of display.
+    config.add_show_field 'agents.prefLabel', label: 'Agents'
+    config.add_show_field 'agents.begin', label: 'Start date'
+    config.add_show_field 'agents.end', label: 'End date'
+    config.add_show_field 'proxies.dcType', label: 'Type'
+    config.add_show_field 'proxies.dcCreator', label: 'Creator'
+    config.add_show_field 'proxies.dcFormat', label: 'Format'
+    config.add_show_field 'proxies.dcIdentifier', label: 'Identifier'
+    config.add_show_field 'proxies.dctermsCreated', label: 'Created'
+    config.add_show_field 'aggregations.webResources.dctermsCreated', label: 'Created'
+    config.add_show_field 'proxies.dctermsExtent', label: 'Extent'
+    config.add_show_field 'europeanaAggregation.edmCountry', label: 'Country'
+    config.add_show_field 'edmDatasetName', label: 'Dataset name'
+    config.add_show_field 'aggregations.edmIsShownAt', label: 'Is shown at'
+    config.add_show_field 'aggregations.edmIsShownBy', label: 'Is shown by'
+    config.add_show_field 'europeanaAggregation.edmLanguage', label: 'Language'
+    config.add_show_field 'europeanaAggregation.edmPreview', label: 'Preview'
+    config.add_show_field 'aggregations.edmProvider', label: 'Provider'
+    config.add_show_field 'aggregations.edmDataProvider', label: 'Data provider'
+    config.add_show_field 'aggregations.edmRights', label: 'Rights'
+    config.add_show_field 'places.latitude', label: 'Latitude'
+    config.add_show_field 'places.longitude', label: 'Longitude'
+    config.add_show_field 'type', label: 'Type'
+    config.add_show_field 'year', label: 'Year'
+
+    # "fielded" search configuration.
+    config.add_search_field('', label: 'All Fields')
+    %w(title who what when where subject).each do |field_name|
+      config.add_search_field(field_name)
+    end
+  end
+end

data/lib/generators/europeana/blacklight/templates/config/blacklight.yml

@@ -0,0 +1,8 @@
+default: &default
+  europeana_api_key: <%= europeana_api_key %>
+development:
+  <<: *default
+test:
+  <<: *default
+production:
+  <<: *default

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: europeana-blacklight
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Richard Doe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-28 00:00:00.000000000 Z
+date: 2015-11-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
@@ -36,14 +56,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: iso-639
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +134,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
 description: 
 email:
 - richard.doe@rwdit.net
@@ -129,8 +177,10 @@ files:
 - ".travis.yml"
 - Gemfile
 - LICENSE.md
+- QUICKSTART.md
 - README.md
 - Rakefile
+- app/controllers/concerns/europeana/blacklight/catalog.rb
 - bin/console
 - bin/setup
 - europeana-blacklight.gemspec
@@ -140,16 +190,23 @@ files:
 - lib/europeana/blacklight/document/more_like_this.rb
 - lib/europeana/blacklight/document/relations.rb
 - lib/europeana/blacklight/document_presenter.rb
+- lib/europeana/blacklight/engine.rb
 - lib/europeana/blacklight/facet_paginator.rb
 - lib/europeana/blacklight/response.rb
 - lib/europeana/blacklight/response/facets.rb
 - lib/europeana/blacklight/response/more_like_this.rb
 - lib/europeana/blacklight/response/pagination.rb
+- lib/europeana/blacklight/routes.rb
 - lib/europeana/blacklight/search_builder.rb
 - lib/europeana/blacklight/search_builder/facet_pagination.rb
 - lib/europeana/blacklight/search_builder/more_like_this.rb
+- lib/europeana/blacklight/search_builder/overlay_params.rb
 - lib/europeana/blacklight/search_builder/ranges.rb
+- lib/europeana/blacklight/search_helper.rb
 - lib/europeana/blacklight/version.rb
+- lib/generators/europeana/blacklight/install_generator.rb
+- lib/generators/europeana/blacklight/templates/catalog_controller.rb
+- lib/generators/europeana/blacklight/templates/config/blacklight.yml
 homepage: https://github.com/europeana/europeana-blacklight
 licenses:
 - EUPL 1.1