foederati 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3103d55ec719c63f670ee42ac313112660d19a79
+  data.tar.gz: 3ccb00693242f608b312f20235788170136ea203
+SHA512:
+  metadata.gz: c272cff39bea08cadf79e0f2ef76e805af218ff3497ca36be087dcd6912985ff8add1a5da04a8de44a460be89036299afa78c938f9587e53b763e65c37fe4bc1
+  data.tar.gz: 0dc042b82753b553db3b3cad95e6fb7ebe94b46ebc031eda1113ee28cf04dbb93c00acf50e995ce320063c2b3ef32430679a708322e3a308344473c2a31278fc

data/LICENSE.md

@@ -0,0 +1,119 @@
+# European Union Public Licence v. 1.1
+EUPL © the European Community 2007
+
+This European Union Public Licence (the “EUPL”) applies to the Work or Software (as defined below) which is provided under the terms of this Licence. Any use of the Work, other than as authorised under this Licence is prohibited (to the extent such use is covered by a right of the copyright holder of the Work).
+The Original Work is provided under the terms of this Licence when the Licensor (as defined below) has placed the following notice immediately following the copyright notice for the Original Work:
+
+Licensed under the EUPL v.1.1
+
+or has expressed by any other mean his willingness to license under the EUPL.
+
+## 1. Definitions
+In this Licence, the following terms have the following meaning:
+- *The Licence*: this Licence.
+- *The Original Work or the Software*: the software distributed and/or communicated by the Licensor under this Licence, available as Source Code and also as Executable Code as the case may be.
+- *Derivative Works*: the works or software that could be created by the Licensee, based upon the Original Work or modifications thereof. This Licence does not define the extent of modification or dependence on the Original Work required in order to classify a work as a Derivative Work; this extent is determined by copyright law applicable in the country mentioned in Article 15.
+- *The Work*: the Original Work and/or its Derivative Works.
+- *The Source Code*: the human-readable form of the Work which is the most convenient for people to study and modify.
+- *The Executable Code*: any code which has generally been compiled and which is meant to be interpreted by a computer as a program.
+- *The Licensor*: the natural or legal person that distributes and/or communicates the Work under the Licence.
+- *Contributor(s)*: any natural or legal person who modifies the Work under the Licence, or otherwise contributes to the creation of a Derivative Work.
+- *The Licensee* or “*You*”: any natural or legal person who makes any usage of the Software under the terms of the Licence.
+- *Distribution and/or Communication*: any act of selling, giving, lending, renting, distributing, communicating, transmitting, or otherwise making available, on-line or off-line, copies of the Work or providing access to its essential functionalities at the disposal of any other natural or legal person.
+
+## 2. Scope of the rights granted by the Licence
+The Licensor hereby grants You a world-wide, royalty-free, non-exclusive, sub- licensable licence to do the following, for the duration of copyright vested in the Original Work:
+- use the Work in any circumstance and for all usage,
+- reproduce the Work,
+- modify the Original Work, and make Derivative Works based upon the Work,
+- communicate to the public, including the right to make available or display the Work or copies thereof to the public and perform publicly, as the case may be, the Work,
+- distribute the Work or copies thereof,
+- lend and rent the Work or copies thereof,
+- sub-license rights in the Work or copies thereof.
+
+Those rights can be exercised on any media, supports and formats, whether now known or later invented, as far as the applicable law permits so.
+
+In the countries where moral rights apply, the Licensor waives his right to exercise his moral right to the extent allowed by law in order to make effective the licence of the economic rights here above listed.
+
+The Licensor grants to the Licensee royalty-free, non exclusive usage rights to any patents held by the Licensor, to the extent necessary to make use of the rights granted on the Work under this Licence.
+
+## 3. Communication of the Source Code
+The Licensor may provide the Work either in its Source Code form, or as Executable Code. If the Work is provided as Executable Code, the Licensor provides in addition a machine-readable copy of the Source Code of the Work along with each copy of the Work that the Licensor distributes or indicates, in a notice following the copyright notice attached to the Work, a repository where the Source Code is easily and freely accessible for as long as the Licensor continues to distribute and/or communicate the Work.
+
+## 4. Limitations on copyright
+Nothing in this Licence is intended to deprive the Licensee of the benefits from any exception or limitation to the exclusive rights of the rights owners in the Original Work or Software, of the exhaustion of those rights or of other applicable limitations thereto.
+
+## 5. Obligations of the Licensee
+The grant of the rights mentioned above is subject to some restrictions and obligations imposed on the Licensee. Those obligations are the following:
+
+**Attribution right**: the Licensee shall keep intact all copyright, patent or trademarks notices and all notices that refer to the Licence and to the disclaimer of warranties. The Licensee must include a copy of such notices and a copy of the Licence with every copy of the Work he/she distributes and/or communicates. The Licensee must cause any Derivative Work to carry prominent notices stating that the Work has been modified and the date of modification.
+
+**Copyleft clause**: If the Licensee distributes and/or communicates copies of the Original Works or Derivative Works based upon the Original Work, this Distribution and/or Communication will be done under the terms of this Licence or of a later version of this Licence unless the Original Work is expressly distributed only under this version of the Licence. The Licensee (becoming Licensor) cannot offer or impose any additional terms or conditions on the Work or Derivative Work that alter or restrict the terms of the Licence.
+
+**Compatibility clause**: If the Licensee Distributes and/or Communicates Derivative Works or copies thereof based upon both the Original Work and another work licensed under a Compatible Licence, this Distribution and/or Communication can be done under the terms of this Compatible Licence. For the sake of this clause, “Compatible Licence” refers to the licences listed in the appendix attached to this Licence. Should the Licensee’s obligations under the Compatible Licence conflict with his/her obligations under this Licence, the obligations of the Compatible Licence shall prevail.
+
+**Provision of Source Code**: When distributing and/or communicating copies of the Work, the Licensee will provide a machine-readable copy of the Source Code or indicate a repository where this Source will be easily and freely available for as long as the Licensee continues to distribute and/or communicate the Work.
+
+**Legal Protection**: This Licence does not grant permission to use the trade names, trademarks, service marks, or names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the copyright notice.
+
+## 6. Chain of Authorship
+The original Licensor warrants that the copyright in the Original Work granted hereunder is owned by him/her or licensed to him/her and that he/she has the power and authority to grant the Licence.
+
+Each Contributor warrants that the copyright in the modifications he/she brings to the Work are owned by him/her or licensed to him/her and that he/she has the power and authority to grant the Licence.
+
+Each time You accept the Licence, the original Licensor and subsequent Contributors grant You a licence to their contributions to the Work, under the terms of this Licence.
+
+## 7. Disclaimer of Warranty
+The Work is a work in progress, which is continuously improved by numerous contributors. It is not a finished work and may therefore contain defects or “bugs” inherent to this type of software development.
+
+For the above reason, the Work is provided under the Licence on an “as is” basis and without warranties of any kind concerning the Work, including without limitation merchantability, fitness for a particular purpose, absence of defects or errors, accuracy, non-infringement of intellectual property rights other than copyright as stated in Article 6 of this Licence.
+
+This disclaimer of warranty is an essential part of the Licence and a condition for the grant of any rights to the Work.
+
+## 8. Disclaimer of Liability
+Except in the cases of wilful misconduct or damages directly caused to natural persons, the Licensor will in no event be liable for any direct or indirect, material or moral, damages of any kind, arising out of the Licence or of the use of the Work, including without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, loss of data or any commercial damage, even if the Licensor has been advised of the possibility of such damage. However, the Licensor will be liable under statutory product liability laws as far such laws apply to the Work.
+
+## 9. Additional agreements
+While distributing the Original Work or Derivative Works, You may choose to conclude an additional agreement to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or services consistent with this Licence. However, in accepting such obligations, You may act only on your own behalf and on your sole responsibility, not on behalf of the original Licensor or any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against such Contributor by the fact You have accepted any such warranty or additional liability.
+
+## 10. Acceptance of the Licence
+The provisions of this Licence can be accepted by clicking on an icon “I agree” placed under the bottom of a window displaying the text of this Licence or by affirming consent in any other similar way, in accordance with the rules of applicable law. Clicking on that icon indicates your clear and irrevocable acceptance of this Licence and all of its terms and conditions.
+
+Similarly, you irrevocably accept this Licence and all of its terms and conditions by exercising any rights granted to You by Article 2 of this Licence, such as the use of the Work, the creation by You of a Derivative Work or the Distribution and/or Communication by You of the Work or copies thereof.
+
+## 11. Information to the public
+In case of any Distribution and/or Communication of the Work by means of electronic communication by You (for example, by offering to download the Work from a remote location) the distribution channel or media (for example, a website) must at least provide to the public the information requested by the applicable law regarding the Licensor, the Licence and the way it may be accessible, concluded, stored and reproduced by the Licensee.
+
+## 12. Termination of the Licence
+The Licence and the rights granted hereunder will terminate automatically upon any breach by the Licensee of the terms of the Licence.
+
+Such a termination will not terminate the licences of any person who has received the Work from the Licensee under the Licence, provided such persons remain in full compliance with the Licence.
+
+## 13. Miscellaneous
+Without prejudice of Article 9 above, the Licence represents the complete agreement between the Parties as to the Work licensed hereunder.
+
+If any provision of the Licence is invalid or unenforceable under applicable law, this will not affect the validity or enforceability of the Licence as a whole. Such provision will be construed and/or reformed so as necessary to make it valid and enforceable.
+
+The European Commission may publish other linguistic versions and/or new versions of this Licence, so far this is required and reasonable, without reducing the scope of the rights granted by the Licence. New versions of the Licence will be published with a unique version number.
+
+All linguistic versions of this Licence, approved by the European Commission, have identical value. Parties can take advantage of the linguistic version of their choice.
+
+## 14. Jurisdiction
+Any litigation resulting from the interpretation of this License, arising between the European Commission, as a Licensor, and any Licensee, will be subject to the jurisdiction of the Court of Justice of the European Communities, as laid down in article 238 of the Treaty establishing the European Community.
+
+Any litigation arising between Parties, other than the European Commission, and resulting from the interpretation of this License, will be subject to the exclusive jurisdiction of the competent court where the Licensor resides or conducts its primary business.
+
+## 15. Applicable Law
+This Licence shall be governed by the law of the European Union country where the Licensor resides or has his registered office.
+
+This licence shall be governed by the Belgian law if:
+
+- a litigation arises between the European Commission, as a Licensor, and any Licensee;
+- the Licensor, other than the European Commission, has no residence or registered office inside a European Union country.
+
+## Appendix
+“Compatible Licences” according to article 5 EUPL are:
+- *GNU General Public License (GNU GPL) v. 2 - Open Software License (OSL) v. 2.1, v. 3.0*
+- *Common Public License v. 1.0*
+- *Eclipse Public License v. 1.0*
+- *Cecill v. 2.0*

data/README.md

@@ -0,0 +1,78 @@
+# Foederati
+
+[![Build Status](https://travis-ci.org/europeana/foederati.svg?branch=develop)](https://travis-ci.org/europeana/foederati) [![Coverage Status](https://coveralls.io/repos/github/europeana/foederati/badge.svg?branch=develop)](https://coveralls.io/github/europeana/foederati?branch=develop) [![security](https://hakiri.io/github/europeana/foederati/develop.svg)](https://hakiri.io/github/europeana/foederati/develop) [![Dependency Status](https://gemnasium.com/europeana/foederati.svg)](https://gemnasium.com/europeana/foederati) [![Code Climate](https://codeclimate.com/github/europeana/foederati/badges/gpa.svg)](https://codeclimate.com/github/codeclimate/codeclimate)
+
+Federated API search library for Ruby.
+
+## Usage
+
+### With Rails
+
+#### Configure Foederati in an initializer
+```ruby
+# config/initializers/foederati.rb
+Foederati.configure do
+  api_keys.dpla = 'dpla_api_key'
+  api_keys.digitalnz = 'digitalnz_api_key'
+  api_keys.europeana = 'europeana_api_key'
+  api_keys.trove = 'trove_api_key'
+
+  defaults.limit = 4
+end
+```
+
+#### Mount the engine
+```ruby
+# config/routes.rb
+mount Foederati::Engine
+```
+
+#### Search
+
+The Rails engine provides a single controller which searches one or more of the
+available providers' JSON APIs and returns normalised and simplified search
+results.
+
+Routes:
+* To search one provider, visit e.g. http://www.example.com/foederati/europeana?q=music
+* To search multiple providers, visit e.g. http://www.example.com/foederati?p=dpla,trove&q=music
+
+Parameters:
+* `l`: number of results to request from each provider
+* `p`: comma-separated list of the providers to search
+* `q`: search query, passed as-is to provider APIs (so keep it simple if
+  searching more than one!)
+
+
+### Without Rails
+
+TODO: instruct how to use Foederati outside of Rails.
+
+### Registering custom providers
+
+TODO: instruct how to register custom providers.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'foederati'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install foederati
+```
+
+## Contributing
+TODO: Contribution directions go here.
+
+## License
+Licensed under the EUPL V.1.1.
+
+For full details, see [LICENSE.md](LICENSE.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/foederati.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/object/blank'
+require 'active_support/hash_with_indifferent_access'
+require 'faraday'
+require 'faraday_middleware'
+require 'foederati/faraday_middleware'
+require 'ostruct'
+require 'typhoeus/adapters/faraday'
+
+require 'foederati/engine' if defined?(Rails)
+
+# TODO add logger
+module Foederati
+  autoload :FaradayMiddleware, 'foederati/faraday_middleware'
+  autoload :Provider, 'foederati/provider'
+  autoload :Providers, 'foederati/providers'
+
+  Defaults = Struct.new(:limit)
+
+  class << self
+    def configure(&block)
+      instance_eval(&block)
+      self
+    end
+
+    def api_keys
+      @api_keys ||= OpenStruct.new
+    end
+
+    def defaults
+      @defaults ||= Defaults.new
+    end
+
+    ##
+    # Search registered providers
+    #
+    # @param ids [Symbol] ID(s) of one or more provider to search
+    # @param params [Hash] search query parameters
+    # @return [Hash] combined results of all providers
+    # TODO run multiple searches in parallel
+    def search(*ids, **params)
+      ids.map do |id|
+        Providers.get(id).search(params)
+      end.reduce(&:merge)
+    end
+
+    ##
+    # `Faraday` connection for executing HTTP requests
+    #
+    # @return [Faraday::Connection]
+    def connection
+      @connection ||= begin
+        Faraday.new do |conn|
+          # TODO are max: 5 and interval: 3 sensible values? should they be
+          #   made configurable?
+          conn.request :retry, max: 5, interval: 3,
+                               exceptions: [Errno::ECONNREFUSED, Errno::ETIMEDOUT, 'Timeout::Error',
+                                            Faraday::Error::TimeoutError, EOFError]
+
+          conn.response :unsupported #, content_type: /\bjson$/
+          conn.response :json, content_type: /\bjson$/
+
+          conn.adapter :typhoeus
+        end
+      end
+    end
+  end
+end
+
+# TODO something nicer than this
+Dir.glob(File.expand_path('../foederati/providers/*.rb', __FILE__)).each do |file|
+  require file
+end

data/lib/foederati/engine.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Foederati
+  class Engine < ::Rails::Engine
+    isolate_namespace Foederati
+  end
+end

data/lib/foederati/faraday_middleware.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'faraday_middleware/response_middleware'
+
+module Foederati
+  module FaradayMiddleware
+    ##
+    # Response handler for unspported content types returned by provider APIs
+    #
+    # For instance, if upstream APIs break and start returning HTML or text from
+    # load balancers.
+    class ParseUnsupportedContentTypes < ::FaradayMiddleware::ResponseMiddleware
+      def process_response(env)
+        super
+        content_type = env.response_headers['Content-Type']
+        fail Faraday::ParsingError,
+             %(API responded with Content-Type "#{content_type}" and status #{env[:status]})
+      end
+    end
+
+    Faraday::Response.register_middleware unsupported: -> { ParseUnsupportedContentTypes }
+  end
+end

data/lib/foederati/provider.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+module Foederati
+  ##
+  # A Foederati provider is one JSON API provider capable of being searched by
+  # the Foederati.
+  #
+  # TODO allow specification of a wildcard to search all the provider's records
+  class Provider
+    autoload :Request, 'foederati/provider/request'
+    autoload :Response, 'foederati/provider/response'
+
+    # TODO validate the type of values added to these
+    Urls = Struct.new(:api, :site)
+    Results = Struct.new(:items, :total)
+    Fields = Struct.new(:title, :thumbnail, :url)
+
+    attr_reader :id, :urls, :results, :fields
+
+    def initialize(id, &block)
+      @id = id
+      @urls = Urls.new
+      @results = Results.new
+      @fields = Fields.new
+
+      instance_eval(&block) if block_given?
+
+      self
+    end
+
+    # TODO sanity check things like presence of API URL
+    def search(**params)
+      request.execute(params).normalise
+    end
+
+    protected
+
+    def request
+      Request.new(self)
+    end
+  end
+end

data/lib/foederati/provider/request.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+module Foederati
+  class Provider
+    ##
+    # Makes HTTP requests to provider APIs.
+    #
+    # Used by `Foederati::Provider#search`.
+    class Request
+      attr_reader :provider
+
+      delegate :id, :urls, to: :provider
+      delegate :connection, to: Foederati
+
+      # @param provider [Foederati::Provider] the provider to make an API request for
+      def initialize(provider)
+        @provider = provider
+      end
+
+      ##
+      # Executes a query against the provider's API
+      #
+      # @param params [Hash] query-specific URL parameters
+      # @return [Foederati::Response] response from the API
+      def execute(**params)
+        faraday_response = connection.get(api_url(params))
+        Response.new(provider, faraday_response)
+      end
+
+      ##
+      # Default parameters to add to query-specific ones when querying the
+      # provider's API.
+      #
+      # For instance, API key and limit.
+      #
+      # @return [Hash]
+      def default_params
+        { api_key: Foederati.api_keys.send(id) }.merge(Foederati.defaults.to_h)
+      end
+
+      ##
+      # Construct the URL for making an API request
+      #
+      # @param params [Hash] query-specific URL parameters
+      # @return [String] the provider's API URL with all necessary params
+      def api_url(**params)
+        format(urls.api, default_params.merge(params))
+      end
+    end
+  end
+end

data/lib/foederati/provider/response.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+module Foederati
+  class Provider
+    ##
+    # Contains a response from a request to a provider's API
+    #
+    # Returned by `Foederati::Provider::Request#execute`.
+    class Response
+      attr_reader :provider, :faraday_response
+
+      delegate :body, to: :faraday_response
+      delegate :results, :fields, :id, to: :provider
+
+      # @param provider [Foederati::Provider] provider the API response is for
+      # @param faraday_response [Faraday::Response] Faraday response object
+      def initialize(provider, faraday_response)
+        @provider = provider
+        @faraday_response = faraday_response
+      end
+
+      ##
+      # Normalises response from provider's API
+      #
+      # @return [Hash]
+      def normalise
+        {
+          id => {
+            total: fetch_from_response(results.total, body) || 0,
+            results: items_from_response.map do |item|
+              {
+                title: fetch_from_response(fields.title, item),
+                thumbnail: fetch_from_response(fields.thumbnail, item),
+                url: fetch_from_response(fields.url, item)
+              }
+            end
+          }
+        }
+      end
+      alias_method :to_h, :normalise
+
+      protected
+
+      ##
+      # Gets the set of items from the response body
+      #
+      # @return [Array]
+      def items_from_response
+        fetch_from_response(results.items, body) || []
+      end
+
+      ##
+      # Fetch a field from part of the provider's JSON response
+      #
+      # @param field `Proc` to call with `hash`, else keys to pass to `#fetch_deep`
+      # @param hash [Hash] (part of) the JSON response hash
+      def fetch_from_response(field, hash)
+        if field.blank?
+          nil
+        elsif field.respond_to?(:call)
+          field.call(hash)
+        else
+          fetch_deep(field, hash)
+        end
+      end
+
+      ##
+      # Digs down into a nested hash to get the value beneath multiple keys
+      #
+      # @example
+      #   fetch_deep(%i(a b), { a: { b: 'c' } }) #=> 'c'
+      #
+      # @param keys one or more keys to fetch from the hash
+      # @param hash [Hash] the hash to fetch deep from
+      def fetch_deep(keys, hash)
+        return hash unless hash.is_a?(Hash)
+
+        local_keys = [keys.dup].flatten
+        return hash if local_keys.blank?
+
+        key = local_keys.shift
+        fetch_deep(local_keys, hash[key])
+      end
+    end
+  end
+end

data/lib/foederati/providers.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+module Foederati
+  ##
+  # All providers known to Foederati
+  class Providers
+    @registry = HashWithIndifferentAccess.new
+
+    class << self
+      attr_reader :registry
+
+      ##
+      # Register a provider
+      #
+      # @param id_or_provider [Symbol,Foederati::Provider] identifier of a new
+      #   provider, or an instantiated provider
+      def register(id_or_provider, &block)
+        case id_or_provider
+        when Foederati::Provider
+          registry[id_or_provider.id] = id_or_provider
+        when Symbol
+          registry[id_or_provider] = Provider.new(id_or_provider, &block)
+        else
+          fail ArgumentError, "Expected Symbol or Foederati::Provider, got #{id_or_provider.class}"
+        end
+      end
+
+      ##
+      # Unregisters a provider
+      #
+      # @param id [Symbol] unique identifier of the provider
+      # @param provider [Foederati::Provider] provider removed from the registry
+      def unregister(id)
+        registry.delete(id)
+      end
+
+      ##
+      # Get a provider from the registry
+      #
+      # @param id [Symbol] identifier of the provider to get
+      # @return [Foederati::Provider]
+      def get(id)
+        registry[id]
+      end
+    end
+  end
+end

data/lib/foederati/providers/digitalnz.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# DigitalNZ
+Foederati::Providers.register :digitalnz do
+  urls.api = 'https://api.digitalnz.org/v3/records.json?api_key=%{api_key}&text=%{query}&per_page=%{limit}'
+  urls.site = 'https://digitalnz.org/records?text=%{query}'
+
+  results.items = %w(search results)
+  results.total = %w(search result_count)
+
+  fields.title = 'title'
+  fields.thumbnail = 'thumbnail_url'
+  fields.url = 'source_url'
+end

data/lib/foederati/providers/dpla.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# DPLA
+Foederati::Providers.register :dpla do
+  urls.api = 'https://api.dp.la/v2/items?api_key=%{api_key}&q=%{query}&page_size=%{limit}'
+  urls.site = 'https://dp.la/search?q=%{query}'
+
+  results.items = 'docs'
+  results.total = 'count'
+
+  fields.title = %w(sourceResource title)
+  fields.thumbnail = 'object'
+  fields.url = 'isShownAt'
+end

data/lib/foederati/providers/europeana.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Europeana
+Foederati::Providers.register :europeana do
+  urls.api = 'https://www.europeana.eu/api/v2/search.json?wskey=%{api_key}&query=%{query}&rows=%{limit}&profile=minimal'
+  urls.site = 'http://www.europeana.eu/portal/search?q=%{query}'
+
+  results.items = 'items'
+  results.total = 'totalResults'
+
+  fields.title = 'title'
+  fields.thumbnail = 'edmPreview'
+  fields.url = 'guid'
+end

data/lib/foederati/providers/trove.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Trove
+Foederati::Providers.register :trove do
+  urls.api = 'http://api.trove.nla.gov.au/result?key=%{api_key}&q=%{query}&n=%{limit}&zone=picture&encoding=json'
+  urls.site = 'http://trove.nla.gov.au/result?q=%{query}'
+
+  results.items = ->(response) { response['response']['zone'].detect { |zone| zone['name'] == 'picture' }['records']['work'] }
+  results.total = ->(response) { response['response']['zone'].detect { |zone| zone['name'] == 'picture' }['records']['total'].to_i }
+
+  fields.title = 'title'
+  fields.thumbnail = ->(item) { item['identifier'].detect { |identifier| identifier['linktype'] == 'thumbnail' }['value'] }
+  fields.url = 'troveUrl'
+end

data/lib/foederati/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Foederati
+  VERSION = '0.1.0'
+end

data/spec/lib/foederati/provider/request_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+RSpec.describe Foederati::Provider::Request do
+  subject { described_class.new(provider) }
+
+  let(:provider) do
+    Foederati::Provider.new(:good_provider).tap do |p|
+      p.urls.api = "#{api_url}?q=%{query}&k=%{api_key}&l=%{limit}"
+    end
+  end
+  let(:api_url) { 'http://api.example.com/' }
+  let(:query) { 'whale' }
+  let(:api_key) { 'moby' }
+  let(:result_limit) { 10 }
+
+  before do
+    Foederati.api_keys.good_provider = api_key
+    Foederati.defaults.limit = result_limit
+    Foederati::Providers.register(provider)
+  end
+
+  after do
+    Foederati::Providers.unregister(provider.id)
+  end
+
+  describe '#execute' do
+    context 'when API responds with JSON' do
+      before do
+        stub_request(:get, api_url).with(query: hash_including(q: query)).
+          to_return(status: 200,
+                    body: '{}',
+                    headers: { 'Content-Type' => 'application/json;charset=UTF-8' })
+      end
+
+      it "sends a request to the provider's API" do
+        subject.execute(query: query)
+        expect(a_request(:get, api_url).with(query: hash_including(q: query))).to have_been_made
+      end
+
+      it 'returns a response object with Faraday response stored' do
+        response = subject.execute(query: query)
+        expect(response).to be_a Foederati::Provider::Response
+        expect(response.faraday_response).to be_a Faraday::Response
+      end
+    end
+
+    context 'when API responds with non-JSON' do
+      before do
+        stub_request(:get, api_url).with(query: hash_including(q: query)).
+          to_return(status: 200,
+                    body: '<html></html>',
+                    headers: { 'Content-Type' => 'text/html;charset=UTF-8' })
+      end
+
+      it 'fails with Faraday::ParsingError' do
+        expect { described_class.new(provider).execute(query: query) }.
+          to raise_error(Faraday::ParsingError)
+      end
+    end
+  end
+
+  describe '#default_params' do
+    it 'adds limit from Foederati defaults' do
+      expect(subject.default_params[:limit]).to eq(result_limit)
+    end
+    it 'adds API key for provider' do
+      expect(subject.default_params[:api_key]).to eq(api_key)
+    end
+  end
+
+  describe '#api_url' do
+    it 'replaces placeholders in API URL with params' do
+      expect(subject.api_url(query: query)).to \
+        eq("http://api.example.com/?q=#{query}&k=#{api_key}&l=#{result_limit}")
+    end
+
+    it 'overrides defaults with args' do
+      expect(subject.api_url(query: query, limit: 5)).to \
+        eq("http://api.example.com/?q=#{query}&k=#{api_key}&l=5")
+    end
+  end
+end

data/spec/lib/foederati/provider/response_spec.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+require 'faraday'
+
+RSpec.describe Foederati::Provider::Response do
+  describe '#normalise' do
+    let(:provider) do
+      Foederati::Provider.new(:friendly_provider) do
+        results.total = 'totalItems'
+        results.items = 'searchResults'
+        fields.title = 'dcTitle'
+        fields.thumbnail = 'edmIsShownBy'
+        fields.url = 'guid'
+      end
+    end
+
+    let(:faraday_response) do
+      double(Faraday::Response).tap do |faraday_response|
+        allow(faraday_response).to receive(:body).and_return(faraday_response_body)
+      end
+    end
+
+    let(:faraday_response_body) do
+      {
+        'totalItems' => 123,
+        'searchResults' => [
+          {
+            'dcTitle' => 'One result',
+            'edmIsShownBy' => 'http://www.example.com/one.jpg',
+            'guid' => 'http://www.example.com/one.html'
+          }
+        ]
+      }
+    end
+
+    subject { described_class.new(provider, faraday_response).normalise }
+
+    it { is_expected.to be_a Hash }
+
+    it 'is keyed by provider ID' do
+      expect(subject).to have_key(provider.id)
+    end
+
+    describe 'provider ID keyed hash' do
+      subject { described_class.new(provider, faraday_response).normalise[provider.id] }
+
+      describe 'total' do
+        context 'when in API response' do
+          it 'is mapped' do
+            expect(subject).to have_key(:total)
+            expect(subject[:total]).to eq(faraday_response_body['totalItems'])
+          end
+        end
+
+        context 'when not in API response' do
+          before do
+            faraday_response_body.delete('totalItems')
+          end
+
+          it 'defaults to 0' do
+            expect(subject[:total]).to be_zero
+          end
+        end
+      end
+
+      it { is_expected.to have_key :results }
+
+      describe 'results' do
+        subject { described_class.new(provider, faraday_response).normalise[provider.id][:results] }
+
+        it { is_expected.to be_a Array }
+
+        it 'has one element for each result' do
+          expect(subject.count).to eq(faraday_response_body['searchResults'].count)
+        end
+
+        describe 'each result' do
+          subject { described_class.new(provider, faraday_response).normalise[provider.id][:results].first }
+          let(:provider_result) { faraday_response_body['searchResults'].first }
+
+          it 'includes title' do
+            expect(subject[:title]).to eq(provider_result['dcTitle'])
+          end
+
+          it 'includes thumbnail' do
+            expect(subject[:thumbnail]).to eq(provider_result['edmIsShownBy'])
+          end
+
+          it 'includes URL' do
+            expect(subject[:url]).to eq(provider_result['guid'])
+          end
+        end
+      end
+
+      describe 'response traversal' do
+        it 'handles arrays of keys' do
+          provider.results.items = %w(results search)
+          faraday_response_body['results'] = {
+            'search' => faraday_response_body.delete('searchResults')
+          }
+          expect(described_class.new(provider, faraday_response).normalise[provider.id][:results].count).to eq(faraday_response_body['results']['search'].count)
+        end
+
+        it 'handles procs' do
+          provider.results.items = ->(response) { response['searchResults'] }
+          expect(described_class.new(provider, faraday_response).normalise[provider.id][:results].count).to eq(faraday_response_body['searchResults'].count)
+        end
+      end
+    end
+  end
+end

data/spec/lib/foederati/provider_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+RSpec.describe Foederati::Provider do
+  describe '#urls' do
+    subject { described_class.new(:new_provider).urls }
+    it { is_expected.to respond_to :api }
+    it { is_expected.to respond_to :site }
+  end
+
+  describe '#results' do
+    subject { described_class.new(:new_provider).results }
+    it { is_expected.to respond_to :items }
+    it { is_expected.to respond_to :total }
+  end
+
+  describe '#fields' do
+    subject { described_class.new(:new_provider).fields }
+    it { is_expected.to respond_to :title }
+    it { is_expected.to respond_to :thumbnail }
+    it { is_expected.to respond_to :url }
+  end
+
+  describe '#initialize' do
+    it 'evaluates a given block' do
+      provider = described_class.new(:new_provider) do
+        urls.api = 'http://api.example.com/'
+      end
+      expect(provider.urls.api).to eq('http://api.example.com/')
+    end
+  end
+
+  describe '#search' do
+    let(:search_params) { { query: 'fish' } }
+
+    it 'creates and executes a request' do
+      provider = described_class.new(:new_provider)
+
+      mock_request = double(Foederati::Provider::Request)
+      mock_response = double(Foederati::Provider::Response)
+
+      allow(provider).to receive(:request).and_return(mock_request)
+
+      expect(mock_request).to receive(:execute).with(search_params).and_return(mock_response)
+      expect(mock_response).to receive(:normalise)
+
+      provider.search(search_params)
+    end
+  end
+end

data/spec/lib/foederati/providers/europeana_spec.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+RSpec.describe Foederati::Providers do
+  it 'has registered Europeana' do
+    expect(described_class.registry).to have_key(:europeana)
+  end
+end

data/spec/lib/foederati/providers_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+RSpec.describe Foederati::Providers do
+  subject { described_class }
+
+  describe '.registry' do
+    subject { described_class.registry }
+
+    it 'has indifferent access' do
+      expect(subject).to be_a(HashWithIndifferentAccess)
+    end
+
+    it 'supports some providers by default' do
+      expect(subject.keys.sort).to eq(%w(europeana dpla digitalnz trove).sort)
+    end
+  end
+
+  describe '.get' do
+    let(:registered_provider) { double(Foederati::Provider) }
+    it 'returns the registered provider' do
+      allow(described_class).to receive(:registry) { { registered_provider: registered_provider } }
+      expect(described_class.get(:registered_provider)).to eq(registered_provider)
+    end
+  end
+
+  describe '.register' do
+    it 'adds a provider to the registry' do
+      subject.register(:new_provider)
+      expect(subject.registry).to have_key(:new_provider)
+    end
+
+    it 'accepts a provider instance' do
+      provider = Foederati::Provider.new(:new_provider)
+      subject.register(provider)
+      expect(subject.registry[:new_provider]).to eq(provider)
+    end
+
+    it 'accepts a Symbol as ID' do
+      subject.register(:fish_provider)
+      expect(subject.registry[:fish_provider]).to be_a(Foederati::Provider)
+    end
+
+    it 'fails with other arg types' do
+      expect { subject.register('fish_provider') }.to raise_error(ArgumentError)
+    end
+
+    it 'evaluates a given block' do
+      subject.register(:new_provider) do
+        urls.api = 'http://api.example.com/'
+      end
+      expect(subject.get(:new_provider).urls.api).to eq('http://api.example.com/')
+    end
+  end
+
+  describe '.unregister' do
+    let(:provider) { Foederati::Provider.new(:cunning_provider) }
+
+    before do
+      Foederati::Providers.register(provider)
+    end
+
+    it 'removes the provider from the registry' do
+      expect(subject.registry.values).to include(provider)
+      subject.unregister(provider.id)
+      expect(subject.registry.values).not_to include(provider)
+    end
+  end
+end

data/spec/lib/foederati_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+RSpec.describe Foederati do
+  describe '.defaults' do
+    subject { described_class.defaults }
+    it { is_expected.to respond_to :limit }
+  end
+
+  describe '.api_keys' do
+    subject { described_class.api_keys }
+    it 'accepts arbitrary attr assignment' do
+      expect { subject.not_a_known_api }.not_to raise_error
+    end
+  end
+
+  describe '.configure' do
+    it 'configures Foederati in a block' do
+      Foederati::Providers.register(:my_provider)
+      described_class.configure do
+        api_keys.my_provider = 'secret'
+      end
+      expect(described_class.api_keys.my_provider).to eq('secret')
+    end
+  end
+
+  describe '.connection' do
+    subject { described_class.connection }
+    it { is_expected.to be_a Faraday::Connection }
+  end
+
+  describe '.search' do
+    context 'with one provider specified' do
+      it 'searches that provider' do
+        best_provider = double(Foederati::Provider)
+        allow(Foederati::Providers).to receive(:get).with(:best_provider) { best_provider }
+        expect(best_provider).to receive(:search).with(query: 'river', api_key: 'secret')
+        described_class.search(:best_provider, query: 'river', api_key: 'secret')
+      end
+    end
+
+    context 'with multiple providers specified' do
+      let(:first_provider) { double(Foederati::Provider) }
+      let(:second_provider) { double(Foederati::Provider) }
+      let(:params) { { query: 'jelly' } }
+
+      before do
+        allow(Foederati::Providers).to receive(:get).with(:first_provider) { first_provider }
+        allow(Foederati::Providers).to receive(:get).with(:second_provider) { second_provider }
+        allow(first_provider).to receive(:search) { { first_provider: {} } }
+        allow(second_provider).to receive(:search) { { second_provider: {} } }
+      end
+
+      it 'searches each of those providers' do
+        expect(first_provider).to receive(:search).with(params)
+        expect(second_provider).to receive(:search).with(params)
+        described_class.search(:first_provider, :second_provider, params)
+      end
+
+      it 'merges results' do
+        response = described_class.search(:first_provider, :second_provider, params)
+        expect(response).to have_key(:first_provider)
+        expect(response).to have_key(:second_provider)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+require 'coveralls'
+require 'foederati'
+require 'webmock/rspec'
+
+Coveralls.wear! unless Coveralls.will_run?.nil?
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = 'doc'
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: foederati
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Doe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: 
+email:
+- richard.doe@rwdit.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/foederati.rb
+- lib/foederati/engine.rb
+- lib/foederati/faraday_middleware.rb
+- lib/foederati/provider.rb
+- lib/foederati/provider/request.rb
+- lib/foederati/provider/response.rb
+- lib/foederati/providers.rb
+- lib/foederati/providers/digitalnz.rb
+- lib/foederati/providers/dpla.rb
+- lib/foederati/providers/europeana.rb
+- lib/foederati/providers/trove.rb
+- lib/foederati/version.rb
+- spec/lib/foederati/provider/request_spec.rb
+- spec/lib/foederati/provider/response_spec.rb
+- spec/lib/foederati/provider_spec.rb
+- spec/lib/foederati/providers/europeana_spec.rb
+- spec/lib/foederati/providers_spec.rb
+- spec/lib/foederati_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/europeana/foederati
+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: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Federated search
+test_files: []