europeana-api 0.3.2 → 0.3.3

data/spec/europeana/api/search_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+require 'active_support/core_ext/hash'
+
+module Europeana
+  module API
+    describe Search do
+      let(:api_key) { 'xyz' }
+      let(:params) {
+        HashWithIndifferentAccess.new({
+          query: 'test', profile: 'standard', qf: "where:London", rows: 100, start: 1, callback: ''
+        })
+      }
+
+      before do
+        Europeana::API.api_key = api_key
+      end
+
+      describe "#new" do
+        context "with no API request params" do
+          subject { lambda { described_class.new } }
+          it { should_not raise_error }
+        end
+
+        context "with API request params" do
+          subject { described_class.new(params) }
+          it "should not raise error" do
+            expect { subject }.not_to raise_error
+          end
+          it "stores the request params" do
+            expect(subject.instance_variable_get(:@params)).to eq(params)
+          end
+        end
+      end
+
+      describe "#params" do
+        subject { described_class.new(params) }
+        it "gets params attribute" do
+          expect(subject.params).to eq(params)
+        end
+      end
+
+      describe "#params=" do
+        subject { described_class.new }
+
+        context "valid params" do
+          it "sets params attribute" do
+            subject.params = params
+            expect(subject.instance_variable_get(:@params)).to eq(params)
+          end
+        end
+      end
+
+      describe "#request_uri" do
+        it "returns a URI" do
+          expect(subject.request_uri).to be_a(URI)
+        end
+
+        it "includes request params" do
+          subject.params[:query] = 'paris'
+          expect(subject.request_uri.to_s).to eq("http://www.europeana.eu/api/v2/search.json?query=paris&wskey=#{api_key}")
+        end
+      end
+
+      describe "#params_with_authentication" do
+        subject { described_class.new }
+
+        context "with API key" do
+          it "adds API key to params" do
+            subject.params = params
+            expect(subject.params_with_authentication).to eq(params.merge(:wskey => api_key))
+          end
+        end
+
+        context "without API key" do
+          it "raises an error" do
+            subject.params = params
+            Europeana::API.api_key = nil
+            expect { subject.params_with_authentication }.to raise_error(Europeana::API::Errors::MissingAPIKeyError)
+          end
+        end
+      end
+
+      describe "#execute" do
+        subject { described_class.new(params).execute }
+        it_behaves_like "search request"
+      end
+    end
+  end
+end

data/spec/europeana/api_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+module Europeana
+  describe API do
+    let(:api_key) { 'xyz' }
+    let(:record_id) { '/abc/1234' }
+    let(:params) { { callback: 'doSomething();' } }
+
+    before(:each) do
+      described_class.defaults!
+    end
+
+    describe '.url' do
+      it 'defaults to the live API URL' do
+        expect(subject.url).to eq('http://www.europeana.eu/api/v2')
+      end
+    end
+
+    describe '.url=' do
+      let(:url) { 'http://www.example.com/v2' }
+      it 'accepts override of the API URL' do
+        described_class.url = url
+        expect(described_class.instance_variable_get(:@url)).to eq(url)
+      end
+    end
+
+    describe ".api_key=" do
+      it "sets the API key" do
+        described_class.api_key = api_key
+        expect(described_class.instance_variable_get(:@api_key)).to eq(api_key)
+      end
+    end
+
+    describe ".api_key" do
+      it "gets the API key" do
+        described_class.instance_variable_set(:@api_key, api_key)
+        expect(described_class.api_key).to eq(api_key)
+      end
+    end
+
+    describe ".max_retries" do
+      it "defaults to 5" do
+        expect(described_class.max_retries).to eq(5)
+      end
+    end
+
+    describe ".max_retries=" do
+      it "sets the maximum number of retries" do
+        described_class.max_retries = 2
+        expect(described_class.max_retries).to eq(2)
+      end
+    end
+
+    describe ".retry_delay" do
+      it "defaults to 10" do
+        expect(described_class.retry_delay).to eq(10)
+      end
+    end
+
+    describe ".retry_delay=" do
+      it "sets the retry delay" do
+        described_class.retry_delay = 3
+        expect(described_class.retry_delay).to eq(3)
+      end
+    end
+
+    describe ".defaults!" do
+      it "sets the API URL to its default" do
+        described_class.url = 'http://www.example.com/v2'
+        expect { described_class.defaults! }.
+          to change { described_class.url }.
+          from('http://www.example.com/v2').
+          to('http://www.europeana.eu/api/v2')
+      end
+
+      it "sets retry delay to its default" do
+        described_class.retry_delay = 3
+        expect { described_class.defaults! }.to change { described_class.retry_delay }.from(3).to(10)
+      end
+
+      it "sets max retries to its default" do
+        described_class.max_retries = 3
+        expect { described_class.defaults! }.to change { described_class.max_retries }.from(3).to(5)
+      end
+    end
+
+    describe ".search" do
+      subject { described_class.search(params) }
+      it_behaves_like "search request"
+    end
+
+    describe ".record" do
+      subject { described_class.record(record_id, params) }
+      it_behaves_like "record request"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require 'europeana'
+require 'europeana/api'
 require 'webmock/rspec'
 
 Dir["./spec/support/**/*.rb"].each { |f| require f }

data/spec/support/shared_examples/api_request.rb

@@ -1,33 +1,33 @@
 shared_examples "API request" do
   context "without API key" do
     before(:each) do
-      Europeana.api_key = nil
+      Europeana::API.api_key = nil
     end
-    
+
     it "sends no HTTP request" do
       begin
         subject
-      rescue Europeana::Errors::MissingAPIKeyError
+      rescue Europeana::API::Errors::MissingAPIKeyError
       end
       expect(a_request(:get, /www.europeana.eu\/api\/v2/)).not_to have_been_made
     end
   end
-  
+
   context "with API key" do
     before(:all) do
-      Europeana.api_key = "xyz"
+      Europeana::API.api_key = "xyz"
     end
-    
+
     it "returns the response as a Hash" do
       response = subject
       expect(response).to be_a(Hash)
     end
-    
+
     context "when the API is unavailable" do
       before(:each) do
-        Europeana.retry_delay = 0
+        Europeana::API.retry_delay = 0
       end
-      
+
       it "waits then retries" do
         stub_request(:get, /www.europeana.eu\/api\/v2/).
           to_timeout.times(1).then.
@@ -36,18 +36,27 @@ shared_examples "API request" do
         expect(a_request(:get, /www.europeana.eu\/api\/v2/)).to have_been_made.times(2)
       end
     end
-    
+
     context "when API response is unsuccessful" do
-      it "raises a RequestError" do
-        stub_request(:get, /www.europeana.eu\/api\/v2/).to_return(:body => '{"success":false,"error":"Something went wrong"}')
-        expect { subject }.to raise_error(Europeana::Errors::RequestError, "Something went wrong")
+      context "with error msg" do
+        it "raises a RequestError with error msg" do
+          stub_request(:get, /www.europeana.eu\/api\/v2/).to_return(body: '{"success":false,"error":"Something went wrong"}')
+          expect { subject }.to raise_error(Europeana::API::Errors::RequestError, "Something went wrong")
+        end
+      end
+
+      context "without error msg" do
+        it "raises a RequestError with status code" do
+          stub_request(:get, /www.europeana.eu\/api\/v2/).to_return(status: 400, body: '{"success":false}')
+          expect { subject }.to raise_error(Europeana::API::Errors::RequestError, "400")
+        end
       end
     end
-    
+
     context "when API response is invalid JSON" do
       it "raises a ResponseError" do
         stub_request(:get, /www.europeana.eu\/api\/v2/).to_return(:body => 'invalid JSON')
-        expect { subject }.to raise_error(Europeana::Errors::ResponseError)
+        expect { subject }.to raise_error(Europeana::API::Errors::ResponseError)
       end
     end
   end

data/spec/support/shared_examples/record_request.rb

@@ -1,31 +1,30 @@
 shared_examples "record request" do
-  before(:all) do
-    @api_key = "xyz"
-    @record_id = "/abc/1234"
-    @params = { :callback => "doSomething();" }
-  end
-  
   before(:each) do
-    stub_request(:get, /www.europeana.eu\/api\/v2\/record#{@record_id}\.json/).to_return(:body => '{"success":true}')
+    stub_request(:get, /www.europeana.eu\/api\/v2\/record#{record_id}\.json/).
+      to_return(body: '{"success":true}')
   end
-  
+
   it_behaves_like "API request"
-  
+
   context "with API key" do
-    before(:all) do
-      Europeana.api_key = @api_key
+    before(:each) do
+      Europeana::API.api_key = api_key
     end
-    
+
+    let(:api_key) { 'xyz' }
+    let(:record_id) { '/abc/1234' }
+    let(:params) { { callback: 'doSomething();' } }
+
     it "sends a Record request to the API" do
       subject
-      expect(a_request(:get, /www.europeana.eu\/api\/v2\/record#{@record_id}\.json/)).to have_been_made.once
+      expect(a_request(:get, /www.europeana.eu\/api\/v2\/record#{record_id}\.json/)).to have_been_made.once
     end
-    
+
     context "when record ID is invalid" do
       it "raises RequestError from HTML 404 response" do
-        stub_request(:get, /www.europeana.eu\/api\/v2\/record#{@record_id}\.json/).
-          to_return(:body => '<html></html>', :headers => { 'Content-Type' => 'text/html' }, :status => 404)
-        expect { subject }.to raise_error(Europeana::Errors::RequestError, "Invalid record identifier: #{@record_id}")
+        stub_request(:get, /www.europeana.eu\/api\/v2\/record#{record_id}\.json/).
+          to_return(body: '<html></html>', headers: { 'Content-Type' => 'text/html' }, status: 404)
+        expect { subject }.to raise_error(Europeana::API::Errors::RequestError, "Invalid record identifier: #{record_id}")
       end
     end
   end

data/spec/support/shared_examples/search_request.rb

@@ -1,39 +1,40 @@
 shared_examples "search request" do
-  before(:all) do
-    @api_key = "xyz"
-    @params = {}
-  end
-  
   before(:each) do
-    stub_request(:get, /www.europeana.eu\/api\/v2\/search\.json/).to_return(:body => '{"success":true}')
+    stub_request(:get, %r{www.europeana.eu/api/v2/search.json}).
+      to_return(body: '{"success":true}')
   end
-  
+
   it_behaves_like "API request"
-  
+
   context "with API key" do
-    before(:all) do
-      Europeana.api_key = @api_key
+    let(:api_key) { 'xyz' }
+    let(:params) { {} }
+
+    before do
+      Europeana::API.api_key = api_key
     end
-    
+
     it "sends a Search request to the API" do
       subject
-      expect(a_request(:get, /www.europeana.eu\/api\/v2\/search\.json/)).to have_been_made.once
+      expect(a_request(:get, %r{www.europeana.eu/api/v2/search.json})).
+        to have_been_made.once
     end
-    
+
     context "without query" do
       it "sets an empty query" do
         subject
-        expect(a_request(:get, /www.europeana.eu\/api\/v2\/search\.json\?query=/)).to have_been_made.once
+        expect(a_request(:get, %r{www.europeana.eu/api/v2/search.json?query=})).
+          to have_been_made.once
       end
     end
-    
+
     context "with query" do
-      before(:all) do
-        @params = { :query => "test" }
-      end
+      let(:params) { { query: 'test' } }
+
       it "sends query" do
         subject
-        expect(a_request(:get, /www.europeana.eu\/api\/v2\/search\.json\?query=test/)).to have_been_made.once
+        expect(a_request(:get, %r{www.europeana.eu/api/v2/search.json?query=test})).
+          to have_been_made.once
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: europeana-api
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Richard Doe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-19 00:00:00.000000000 Z
+date: 2015-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -102,8 +102,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-style.yml"
+- ".travis.yml"
 - Gemfile
-- LICENSE.pdf
+- LICENSE.md
 - README.md
 - Rakefile
 - europeana-api.gemspec
@@ -114,17 +119,17 @@ files:
 - lib/europeana/api/search.rb
 - lib/europeana/api/search/fields.rb
 - lib/europeana/api/version.rb
-- spec/europeana/errors_spec.rb
-- spec/europeana/record_spec.rb
-- spec/europeana/search_spec.rb
-- spec/europeana_spec.rb
+- spec/europeana/api/errors_spec.rb
+- spec/europeana/api/record_spec.rb
+- spec/europeana/api/search_spec.rb
+- spec/europeana/api_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples/api_request.rb
 - spec/support/shared_examples/record_request.rb
 - spec/support/shared_examples/search_request.rb
 homepage: https://github.com/rwd/europeana-api-client-ruby
 licenses:
-- EUPL 1.1
+- EUPL V.1.1
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -142,15 +147,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Ruby client library for the Europeana API
 test_files:
-- spec/europeana/errors_spec.rb
-- spec/europeana/record_spec.rb
-- spec/europeana/search_spec.rb
-- spec/europeana_spec.rb
+- spec/europeana/api/errors_spec.rb
+- spec/europeana/api/record_spec.rb
+- spec/europeana/api/search_spec.rb
+- spec/europeana/api_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples/api_request.rb
 - spec/support/shared_examples/record_request.rb