europeana-blacklight 0.1.0

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

@@ -0,0 +1,41 @@
+require 'kaminari'
+
+module Europeana
+  module Blacklight
+    class Response
+      ##
+      # Pagination for{Europeana::Blacklight::Response}
+      #
+      # Based on {Blacklight::SolrResponse::Pagination} v5.10.2
+      module Pagination
+        include Kaminari::PageScopeMethods
+        include Kaminari::ConfigurationMethods::ClassMethods
+
+        def limit_value
+          rows
+        end
+
+        def offset_value
+          start
+        end
+
+        def total_count
+          total
+        end
+
+        def model_name
+          return unless docs.present? && docs.first.respond_to?(:model_name)
+          docs.first.model_name
+        end
+
+        def next_page
+          current_page + 1 unless last_page?
+        end
+
+        def prev_page
+          current_page - 1 unless first_page?
+        end
+      end
+    end
+  end
+end

data/lib/europeana/blacklight/search_builder.rb

@@ -0,0 +1,195 @@
+module Europeana
+  module Blacklight
+    ##
+    # Core search builder for {Europeana::Blacklight::ApiRepository}
+    class SearchBuilder < ::Blacklight::SearchBuilder
+      require 'europeana/blacklight/search_builder/channels'
+      require 'europeana/blacklight/search_builder/facet_pagination'
+      require 'europeana/blacklight/search_builder/more_like_this'
+      require 'europeana/blacklight/search_builder/ranges'
+
+      self.default_processor_chain = [
+        :default_api_parameters, :add_profile_to_api,
+        :add_wskey_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_sorting_to_api
+      ]
+
+      include Channels
+      include FacetPagination
+      include MoreLikeThis
+      include Ranges
+
+      delegate :to_query, to: :to_hash
+
+      ##
+      # Start with general defaults from BL config. Need to use custom
+      # merge to dup values, to avoid later mutating the original by mistake.
+      #
+      # @todo Rename default_solr_params to default_params upstream
+      def default_api_parameters(api_parameters)
+        blacklight_config.default_solr_params.each do |key, value|
+          if value.respond_to?(:deep_dup)
+            api_parameters[key] = value.deep_dup
+          elsif value.respond_to?(:dup) && value.duplicable?
+            api_parameters[key] = value.dup
+          else
+            api_parameters[key] = value
+          end
+        end
+      end
+
+      ##
+      # Set the profile type
+      #
+      # @see http://labs.europeana.eu/api/search/#profile-parameter
+      def add_profile_to_api(api_parameters)
+        if blacklight_config.facet_fields
+          api_parameters[:profile] = 'params facets rich'
+        else
+          api_parameters[:profile] = 'params rich'
+        end
+      end
+
+      ##
+      # Add the Europeana REST API key
+      #
+      # @see http://labs.europeana.eu/api/authentication/#basic-authentication
+      def add_wskey_to_api(api_parameters)
+        api_parameters[:wskey] = blacklight_config.connection_config[:europeana_api_key]
+      end
+
+      ##
+      # Take the user-entered query, and put it in the API params,
+      # including config's "search field" params for current search field.
+      #
+      # @see http://labs.europeana.eu/api/query/
+      def add_query_to_api(api_parameters)
+        if [blacklight_params[:q]].flatten.reject(&:blank?).blank?
+          query = '*:*'
+        elsif search_field && search_field.field.present?
+          query = "#{search_field.field}:#{blacklight_params[:q]}"
+        elsif blacklight_params[:q].is_a?(Hash)
+          # @todo when would it be a Hash?
+          query = nil
+        elsif blacklight_params[:q]
+          query = blacklight_params[:q]
+        end
+        append_to_query_param(api_parameters, query)
+      end
+
+      ##
+      # Add the user's query filter terms
+      def add_qf_to_api(api_parameters)
+        return unless blacklight_params[:qf]
+        api_parameters[:qf] ||= []
+        api_parameters[:qf] = api_parameters[:qf] + blacklight_params[:qf]
+      end
+
+      ##
+      # Facet *filtering* of results
+      #
+      # Maps Blacklight's :f param to API's :qf param.
+      #
+      # @see http://labs.europeana.eu/api/query/#faceted-search
+      # @todo Handle different types of value, like
+      #   {Blacklight::Solr::SearchBuilder#facet_value_to_fq_string} does
+      def add_facet_qf_to_api(api_parameters)
+        return unless blacklight_params[:f]
+
+        salient_facets = blacklight_params[:f].reject do |k, _v|
+          k == 'REUSABILITY'
+        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}\""
+          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(',')
+        end
+      end
+
+      ##
+      # Request facet data in results, respecting configured limits
+      #
+      # @todo Handle facet settings like query, sort, pivot, etc, like
+      #  {Blacklight::Solr::SearchBuilder#add_facetting_to_solr} does
+      # @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_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)
+        end
+      end
+
+      ##
+      # copy paging params from BL app over to API, changing
+      # app level per_page and page to API rows and start.
+      def add_paging_to_api(api_parameters)
+        rows(api_parameters[:rows] || 10) if rows.nil?
+        api_parameters[:rows] = rows
+
+        api_parameters[:start] = start unless start == 0
+      end
+
+      ##
+      # @todo Implement when the API supports sorting
+      def add_sorting_to_api(_api_parameters)
+        return if sort.blank?
+        Europeana::API.logger.warn('Europeana REST API does not support sorting')
+      end
+
+      ##
+      # Europeana API start param counts from 1
+      def start(start = nil)
+        super_start = super
+        super_start == self ? super_start : super_start + 1
+      end
+
+      protected
+
+      # Look up facet limit for given facet_field. Will look at config, and
+      # if config is 'true' will look up from Solr @response if available. If
+      # no limit is avaialble, returns nil. Used from #add_facetting_to_solr
+      # to supply f.fieldname.facet.limit values in solr request (no @response
+      # available), and used in display (with @response available) to create
+      # a facet paginator with the right limit.
+      def facet_limit_for(facet_field)
+        facet = blacklight_config.facet_fields[facet_field]
+        return if facet.blank? || !facet.limit
+
+        if facet.limit == true
+          blacklight_config.default_facet_limit
+        else
+          facet.limit
+        end
+      end
+
+      def api_request_facet_fields
+        @api_request_facet_fields ||= blacklight_config.facet_fields.select do |field_name, facet|
+          !facet.query &&
+          (facet.include_in_request || (facet.include_in_request.nil? && blacklight_config.add_facet_fields_to_solr_request)) &&
+          (field_name == 'REUSABILITY' || Europeana::API::Search::Fields.include?(field_name))
+        end
+      end
+
+      def append_to_query_param(api_parameters, query)
+        return if query.blank?
+        return if query == '*:*' && api_parameters[:query].present?
+        api_parameters[:query] ||= ''
+        api_parameters[:query] << ' ' unless api_parameters[:query].blank?
+        api_parameters[:query] << query
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Europeana
+  module Blacklight
+    class SearchBuilder
+      ##
+      # Search builder with content channel qf
+      module Channels
+        # @todo remove hard-coded controller check
+        def add_channel_qf_to_api(api_parameters)
+          return unless blacklight_params[:controller] == 'channels' && blacklight_params[:id].present?
+          channel_qf = scope.channels_search_query
+          return if channel_qf.blank?
+          api_parameters[:qf] ||= []
+          api_parameters[:qf] << channel_qf
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Europeana
+  module Blacklight
+    class SearchBuilder
+      ##
+      # Search builder methods for facet pagination
+      module FacetPagination
+        extend ActiveSupport::Concern
+
+        included do
+          default_processor_chain << :add_facet_paging_to_api
+        end
+        
+        def add_facet_paging_to_api(api_parameters)
+          return unless facet.present?
+
+          facet_config = blacklight_config.facet_fields[facet]
+
+          limit = if scope.respond_to?(:facet_list_limit)
+              scope.facet_list_limit.to_s.to_i
+            elsif api_parameters['facet.limit']
+              api_parameters['facet.limit'].to_i
+            else
+              20
+            end
+
+          offset = (blacklight_params.fetch(blacklight_config.facet_paginator_class.request_keys[:page], 1).to_i - 1) * (limit)
+
+          # Need to set as f.facet_field.facet.* to make sure we
+          # override any field-specific default in the solr request handler.
+          api_parameters[:"f.#{facet}.facet.limit"] = limit + 1
+          api_parameters[:"f.#{facet}.facet.offset"] = offset
+          api_parameters[:rows] = 0
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,23 @@
+module Europeana
+  module Blacklight
+    class SearchBuilder
+      ##
+      # Search builder methods for more like this queries
+      module MoreLikeThis
+        extend ActiveSupport::Concern
+
+        included do
+          default_processor_chain.unshift :add_mlt_to_api
+        end
+        
+        def add_mlt_to_api(api_parameters)
+          return unless blacklight_params[:mlt]
+          repository = blacklight_config.repository_class.new(blacklight_config)
+          doc_response = repository.find(blacklight_params[:mlt])
+          query = doc_response.documents.first.more_like_this_query(blacklight_params[:mltf])
+          append_to_query_param(api_parameters, query)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Europeana
+  module Blacklight
+    class SearchBuilder
+      ##
+      # Search builder with content channel qf
+      module Ranges
+        extend ActiveSupport::Concern
+
+        included do
+          default_processor_chain << :add_range_qf_to_api
+        end
+
+        def add_range_qf_to_api(api_parameters)
+          return unless blacklight_params.key?(:range) && blacklight_params[:range].is_a?(Hash)
+          blacklight_params[:range].each_pair do |range_field, range_values|
+            api_parameters[:qf] ||= []
+            api_parameters[:qf] << "#{range_field}:[#{range_values[:begin]} TO #{range_values[:end]}]"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/europeana/blacklight/version.rb

@@ -0,0 +1,6 @@
+module Europeana
+  #:nodoc:
+  module Blacklight
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: europeana-blacklight
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Doe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: blacklight
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.12.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.12.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: europeana-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: 
+email:
+- richard.doe@rwdit.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-style.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- europeana-blacklight.gemspec
+- lib/europeana/blacklight.rb
+- lib/europeana/blacklight/api_repository.rb
+- lib/europeana/blacklight/document.rb
+- lib/europeana/blacklight/document/more_like_this.rb
+- lib/europeana/blacklight/document/relations.rb
+- lib/europeana/blacklight/document_presenter.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/search_builder.rb
+- lib/europeana/blacklight/search_builder/channels.rb
+- lib/europeana/blacklight/search_builder/facet_pagination.rb
+- lib/europeana/blacklight/search_builder/more_like_this.rb
+- lib/europeana/blacklight/search_builder/ranges.rb
+- lib/europeana/blacklight/version.rb
+homepage: https://github.com/europeana/europeana-blacklight
+licenses:
+- EUPL 1.1
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Europeana REST API adapter for Blacklight
+test_files: []