foederati 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3103d55ec719c63f670ee42ac313112660d19a79
-  data.tar.gz: 3ccb00693242f608b312f20235788170136ea203
+  metadata.gz: 6c5cfad12d15dcb7be6a6736da964e625af651a9
+  data.tar.gz: ec34ace9f9ee56f4d311c78bf2d7e893302b0184
 SHA512:
-  metadata.gz: c272cff39bea08cadf79e0f2ef76e805af218ff3497ca36be087dcd6912985ff8add1a5da04a8de44a460be89036299afa78c938f9587e53b763e65c37fe4bc1
-  data.tar.gz: 0dc042b82753b553db3b3cad95e6fb7ebe94b46ebc031eda1113ee28cf04dbb93c00acf50e995ce320063c2b3ef32430679a708322e3a308344473c2a31278fc
+  metadata.gz: 253ef90d2ee8609678e6109ffab70609cc5c311a97c0feb80d4e249507cc0ffefc872bb08c2b8363dd4810831c770ceab259f6db82756be98196aac25118ed8d
+  data.tar.gz: 901aa884c5d56172e0d3f3586eb6187fc1ae748390d9d05fab15dab97824b8d0f27c16084bc666766c675b59dea5939b25caf4f9cbb6d185386938bb09db4743

data/lib/foederati.rb

@@ -2,6 +2,7 @@
 require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/object/blank'
 require 'active_support/hash_with_indifferent_access'
+require 'active_support/inflector'
 require 'faraday'
 require 'faraday_middleware'
 require 'foederati/faraday_middleware'

data/lib/foederati/provider.rb

@@ -11,14 +11,17 @@ module Foederati
 
     # TODO validate the type of values added to these
     Urls = Struct.new(:api, :site)
+    DefaultParams = Struct.new(:query)
     Results = Struct.new(:items, :total)
     Fields = Struct.new(:title, :thumbnail, :url)
 
-    attr_reader :id, :urls, :results, :fields
+    attr_reader :id, :urls, :default_params, :results, :fields
+    attr_writer :name
 
     def initialize(id, &block)
       @id = id
       @urls = Urls.new
+      @default_params = DefaultParams.new
       @results = Results.new
       @fields = Fields.new
 
@@ -27,6 +30,10 @@ module Foederati
       self
     end
 
+    def name
+      @name || id.to_s.titleize
+    end
+
     # TODO sanity check things like presence of API URL
     def search(**params)
       request.execute(params).normalise

data/lib/foederati/provider/request.rb

@@ -34,7 +34,9 @@ module Foederati
       #
       # @return [Hash]
       def default_params
-        { api_key: Foederati.api_keys.send(id) }.merge(Foederati.defaults.to_h)
+        { api_key: Foederati.api_keys.send(id) }.
+          merge(Foederati.defaults.to_h).
+          merge(provider.default_params.to_h)
       end
 
       ##
@@ -43,7 +45,9 @@ module Foederati
       # @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))
+        local_params = params.dup
+        local_params.delete(:query) if local_params[:query].blank? && provider.default_params.query.present?
+        format(urls.api, default_params.merge(local_params))
       end
     end
   end

data/lib/foederati/provider/response.rb

@@ -27,9 +27,11 @@ module Foederati
           id => {
             total: fetch_from_response(results.total, body) || 0,
             results: items_from_response.map do |item|
+              thumbnail = fetch_from_response(fields.thumbnail, item)
+              thumbnail = thumbnail.is_a?(Array) ? thumbnail.first : thumbnail
               {
                 title: fetch_from_response(fields.title, item),
-                thumbnail: fetch_from_response(fields.thumbnail, item),
+                thumbnail: thumbnail,
                 url: fetch_from_response(fields.url, item)
               }
             end

data/lib/foederati/providers/digitalnz.rb

@@ -2,6 +2,8 @@
 
 # DigitalNZ
 Foederati::Providers.register :digitalnz do
+  self.name = 'DigitalNZ'
+
   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}'
 

data/lib/foederati/providers/dpla.rb

@@ -2,6 +2,8 @@
 
 # DPLA
 Foederati::Providers.register :dpla do
+  self.name = 'DPLA'
+
   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}'
 

data/lib/foederati/providers/trove.rb

@@ -5,10 +5,21 @@ 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 }
+  default_params.query = '%20'
+
+  results.items = lambda do |response|
+    response['response']['zone'] ? response['response']['zone'].detect { |zone| zone['name'] == 'picture' }['records']['work'] : []
+  end
+  results.total = lambda do |response|
+    response['response']['zone'] ? response['response']['zone'].detect { |zone| zone['name'] == 'picture' }['records']['total'].to_i : 0
+  end
 
   fields.title = 'title'
-  fields.thumbnail = ->(item) { item['identifier'].detect { |identifier| identifier['linktype'] == 'thumbnail' }['value'] }
+  fields.thumbnail = lambda do |item|
+    if item['identifier']
+      thumb_identifier = item['identifier'].detect { |identifier| identifier['linktype'] == 'thumbnail' }
+      thumb_identifier ? thumb_identifier['value'] : nil
+    end
+  end
   fields.url = 'troveUrl'
 end

data/lib/foederati/version.rb

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

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

@@ -5,10 +5,12 @@ RSpec.describe Foederati::Provider::Request do
   let(:provider) do
     Foederati::Provider.new(:good_provider).tap do |p|
       p.urls.api = "#{api_url}?q=%{query}&k=%{api_key}&l=%{limit}"
+      p.default_params.query = empty_query
     end
   end
   let(:api_url) { 'http://api.example.com/' }
   let(:query) { 'whale' }
+  let(:empty_query) { 'EMPTY' }
   let(:api_key) { 'moby' }
   let(:result_limit) { 10 }
 
@@ -68,14 +70,22 @@ RSpec.describe Foederati::Provider::Request do
   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
+    context 'when the query is set' 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")
+      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
+    context 'when the query is empty' do
+      it 'replaces the query with the default empty query' do
+        expect(subject.api_url(query: '')).to \
+        eq("http://api.example.com/?q=#{empty_query}&k=#{api_key}&l=#{result_limit}")
+      end
     end
   end
 end

data/spec/lib/foederati/provider_spec.rb

@@ -6,6 +6,11 @@ RSpec.describe Foederati::Provider do
     it { is_expected.to respond_to :site }
   end
 
+  describe '#default_params' do
+    subject { described_class.new(:new_provider).default_params }
+    it { is_expected.to respond_to :query }
+  end
+
   describe '#results' do
     subject { described_class.new(:new_provider).results }
     it { is_expected.to respond_to :items }
@@ -19,6 +24,23 @@ RSpec.describe Foederati::Provider do
     it { is_expected.to respond_to :url }
   end
 
+  describe '#name' do
+    subject { described_class.new(:new_provider) }
+
+    context 'when not set' do
+      it 'is derived from ID' do
+        expect(subject.name).to eq('New Provider')
+      end
+    end
+
+    context 'when set' do
+      it 'is returned as set' do
+        subject.name = 'Nice name'
+        expect(subject.name).to eq('Nice name')
+      end
+    end
+  end
+
   describe '#initialize' do
     it 'evaluates a given block' do
       provider = described_class.new(:new_provider) do

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+RSpec.describe Foederati::Providers do
+  it 'has registered DigitalNZ' do
+    expect(described_class.registry).to have_key(:digitalnz)
+  end
+
+  describe 'DigitalNZ provider' do
+    let(:provider) { described_class.get(:digitalnz) }
+
+    describe '#name' do
+      subject { provider.name }
+      it { is_expected.to eq('DigitalNZ') }
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+RSpec.describe Foederati::Providers do
+  it 'has registered DPLA' do
+    expect(described_class.registry).to have_key(:dpla)
+  end
+
+  describe 'DPLA provider' do
+    let(:provider) { described_class.get(:dpla) }
+
+    describe '#name' do
+      subject { provider.name }
+      it { is_expected.to eq('DPLA') }
+    end
+  end
+end

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

@@ -3,4 +3,13 @@ RSpec.describe Foederati::Providers do
   it 'has registered Europeana' do
     expect(described_class.registry).to have_key(:europeana)
   end
+
+  describe 'Europeana provider' do
+    let(:provider) { described_class.get(:europeana) }
+
+    describe '#name' do
+      subject { provider.name }
+      it { is_expected.to eq('Europeana') }
+    end
+  end
 end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+RSpec.describe Foederati::Providers do
+  it 'has registered Trove' do
+    expect(described_class.registry).to have_key(:trove)
+  end
+
+  describe 'Trove provider' do
+    let(:provider) { described_class.get(:trove) }
+
+    describe '#name' do
+      subject { provider.name }
+      it { is_expected.to eq('Trove') }
+    end
+
+    describe '#default_params' do
+      describe '#query' do
+        subject { provider.default_params.query }
+        it { is_expected.to eq('%20') }
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foederati
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Richard Doe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-18 00:00:00.000000000 Z
+date: 2017-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -153,7 +153,10 @@ files:
 - spec/lib/foederati/provider/request_spec.rb
 - spec/lib/foederati/provider/response_spec.rb
 - spec/lib/foederati/provider_spec.rb
+- spec/lib/foederati/providers/digitalnz_spec.rb
+- spec/lib/foederati/providers/dpla_spec.rb
 - spec/lib/foederati/providers/europeana_spec.rb
+- spec/lib/foederati/providers/trove_spec.rb
 - spec/lib/foederati/providers_spec.rb
 - spec/lib/foederati_spec.rb
 - spec/spec_helper.rb
@@ -177,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Federated search