europeana-api 0.5.2 → 1.0.0

data/spec/europeana/api/errors_spec.rb

@@ -1,23 +0,0 @@
-require 'spec_helper'
-
-module Europeana
-  module API
-    module Errors
-      describe MissingAPIKeyError do
-        subject { described_class.new }
-        
-        it 'has an informative message' do
-          expect(subject.message).to match('Missing API key.')
-        end
-      end
-
-      describe RequestError do
-        it 'has an informative message'
-      end
-
-      describe ResponseError do
-        it 'has an informative message'
-      end
-    end
-  end
-end

data/spec/europeana/api/record/hierarchy_spec.rb

@@ -1,15 +0,0 @@
-RSpec.describe Europeana::API::Record::Hierarchy do
-  let(:record_id) { '/abc/1234' }
-  let(:params) { { callback: 'doSomething();' } }
-
-  subject { described_class.new(record_id) }
-
-  %w(self parent children).each do |relation|
-    describe "##{relation}" do
-      it "should retrieve #{relation} hierarchy data from the API" do
-        subject.send(relation)
-        expect(a_request(:get, %r{www.europeana.eu/api/v2/record#{record_id}/#{relation}.json})).to have_been_made.once
-      end
-    end
-  end
-end

data/spec/europeana/api/search_spec.rb

@@ -1,97 +0,0 @@
-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("https://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
-
-      describe '.escape' do
-        %w<\\ + - & | ! ( ) { } [ ] ^ " ~ * ? : />.map do |char|
-          it "escapes lucene special character #{char}" do
-            expect(described_class.escape(char)).to eq("\\#{char}")
-          end
-        end
-      end
-    end
-  end
-end

data/spec/support/shared_examples/api_request.rb

@@ -1,65 +0,0 @@
-shared_examples "API request" do
-  context "without API key" do
-    before(:each) do
-      Europeana::API.api_key = nil
-    end
-
-    it "sends no HTTP request" do
-      begin
-        subject
-      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.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::API.retry_delay = 0
-      end
-
-      it "waits then retries" do
-        stub_request(:get, /www.europeana.eu\/api\/v2/).
-          to_timeout.times(1).then.
-          to_return(:body => '{"success":true}')
-        subject
-        expect(a_request(:get, /www.europeana.eu\/api\/v2/)).to have_been_made.times(2)
-      end
-    end
-
-    context "when API response is unsuccessful" do
-      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::API::Errors::ResponseError)
-      end
-    end
-  end
-end
-
-

data/spec/support/shared_examples/record_request.rb

@@ -1,26 +0,0 @@
-shared_examples 'record request' do
-  let(:api_record_endpoint) { %r{www.europeana.eu/api/v2/record#{record_id}\.json} }
-  let(:api_key) { 'xyz' }
-  let(:record_id) { '/abc/1234' }
-  let(:params) { { callback: 'doSomething();' } }
-
-  before(:each) do
-    stub_request(:get, api_record_endpoint).to_return(body: '{"success":true}')
-    Europeana::API.api_key = api_key
-  end
-
-  it_behaves_like 'API request'
-
-  it 'sends a Record request to the API' do
-    subject
-    expect(a_request(:get, api_record_endpoint)).to have_been_made.once
-  end
-
-  context 'when record ID is invalid' do
-    it 'raises RequestError from HTML 404 response' do
-      stub_request(:get, api_record_endpoint).
-        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,42 +0,0 @@
-shared_examples 'search request' do
-  before(:each) do
-    stub_request(:get, %r{https://www.europeana.eu/api/v2/search.json}).
-      to_return(body: '{"success":true}')
-  end
-
-  it_behaves_like 'API request'
-
-  context 'with API key' do
-    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, %r{https://www.europeana.eu/api/v2/search.json})).
-        to have_been_made.once
-    end
-
-    context 'without query' do
-      it 'sends without query' do
-        subject
-        expect(a_request(:get, %r{https://www.europeana.eu/api/v2/search.json})).
-          to have_been_made.once
-      end
-    end
-
-    context 'with query' do
-      let(:params) { { query: 'test' } }
-
-      it 'sends query' do
-        subject
-        expect(a_request(:get, 'https://www.europeana.eu/api/v2/search.json').
-          with(query: hash_including({'query' => params[:query]}))).
-          to have_been_made.once
-      end
-    end
-  end
-end

data/spec/support/webmock.rb

@@ -1,14 +0,0 @@
-RSpec.configure do |config|
-  config.before do
-    Europeana::API.api_key = 'xyz'
-
-    stub_request(:get, %r{www.europeana.eu/api/v2/record/[^/]+/[^/]+/self\.json}).
-      to_return(body: lambda { |_| '{"success":true, "self":{"id":"' + record_id + '", "childrenCount":0, "hasChildren":false}}' })
-
-    stub_request(:get, %r{www.europeana.eu/api/v2/record/[^/]+/[^/]+/parent\.json}).
-      to_return(body: lambda { |_| '{"success":true, "self":{"id":"' + record_id + '", "childrenCount":5, "hasChildren":false}, "parent":{}}' })
-
-    stub_request(:get, %r{www.europeana.eu/api/v2/record/[^/]+/[^/]+/children\.json}).
-      to_return(body: lambda { |_| '{"success":true, "self":{"id":"' + record_id + '", "childrenCount":5, "hasChildren":false}, "children":[]}' })
-  end
-end