europeana-api 0.5.2 → 1.0.0

data/spec/europeana/api/request_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+RSpec.describe Europeana::API::Request do
+end

data/spec/europeana/api/resource_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+RSpec.describe Europeana::API::Resource do
+  let(:resource_class) do
+    Class.new do
+      include Europeana::API::Resource
+    end
+  end
+
+  it 'adds #has_api_endpoint class method' do
+    expect(resource_class).to respond_to(:has_api_endpoint)
+  end
+
+  it 'adds #api_request_for_endpoint class method' do
+    expect(resource_class).to respond_to(:api_request_for_endpoint)
+  end
+
+  it 'adds @api_endpoints class attribute accessor' do
+    expect(resource_class).to respond_to(:api_endpoints)
+  end
+
+  describe '#has_api_endpoint' do
+    it 'registers API endpoint method on class' do
+      resource_class.has_api_endpoint(:fish, path: '/go/fish')
+      expect(resource_class.api_endpoints).to have_key(:fish)
+      expect(resource_class.api_endpoints[:fish]).to eq(path: '/go/fish')
+      expect(resource_class).to respond_to(:fish)
+    end
+
+    it 'provides a means to make a request to the API' do
+      resource_class.has_api_endpoint(:fish, path: '/go/fish')
+      stub_request(:get, %r{://www.europeana.eu/api/go/fish}).
+        to_return(status: 200, body: '{"catch":[]}', headers: { 'Content-Type' => 'application/json' })
+      resource_class.fish(with: 'rod', 'without' => 'net')
+      expect(a_request(:get, %r{www.europeana.eu/api/go/fish})).to have_been_made.once
+    end
+  end
+
+  describe '#api_request_for_endpoint' do
+    it 'builds a request for the endpoint' do
+      resource_class.has_api_endpoint(:fish, path: '/go/fish')
+      request = resource_class.api_request_for_endpoint(:fish, with: 'rod')
+      expect(request).to be_a(Europeana::API::Request)
+      expect(request.params).to eq(with: 'rod')
+      expect(request.endpoint).to eq(resource_class.api_endpoints[:fish])
+    end
+  end
+end

data/spec/europeana/api/response_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+RSpec.describe Europeana::API::Response do
+  it 'handles blank responses' do
+    request = instance_double('Europeana::API::Request', endpoint: {})
+    faraday_response = instance_double('Faraday::Response', status: 204, body: '')
+    response = described_class.new(request, faraday_response)
+    expect { response.validate! }.not_to raise_error
+    expect(response.body).to eq('')
+  end
+end

data/spec/europeana/api_spec.rb

@@ -1,97 +1,47 @@
-require 'spec_helper'
+# frozen_string_literal: true
+describe Europeana::API do
+  let(:api_key) { 'xyz' }
 
-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('https://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
+  describe '.url' do
+    it 'defaults to the production API URL' do
+      expect(described_class.url).to eq('https://www.europeana.eu/api')
     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
+  describe '.url=' do
+    let(:url) { 'http://www.example.com/api' }
+    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 ".retry_delay" do
-      it "defaults to 10" do
-        expect(described_class.retry_delay).to eq(10)
-      end
+  describe '.key=' do
+    it 'sets the API key' do
+      described_class.key = api_key
+      expect(described_class.instance_variable_get(:@key)).to eq(api_key)
     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
+  describe '.key' do
+    it 'gets the API key' do
+      described_class.instance_variable_set(:@key, api_key)
+      expect(described_class.key).to eq(api_key)
     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('https://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 '.record' do
+    subject { described_class.record }
+    it { is_expected.to eq(Europeana::API::Record) }
+  end
 
-    describe ".search" do
-      subject { described_class.search(params) }
-      it_behaves_like "search request"
-    end
+  describe '.annotation' do
+    subject { described_class.annotation }
+    it { is_expected.to eq(Europeana::API::Annotation) }
+  end
 
-    describe ".record" do
-      subject { described_class.record(record_id, params) }
-      it_behaves_like "record request"
-    end
+  describe '.entity' do
+    subject { described_class.entity }
+    it { is_expected.to eq(Europeana::API::Entity) }
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
 require 'coveralls'
 require 'europeana/api'
+require 'shoulda/matchers'
 require 'webmock/rspec'
 
 Dir['./spec/support/**/*.rb'].each { |f| require f }
@@ -13,3 +15,9 @@ RSpec.configure do |config|
     c.syntax = :expect
   end
 end
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+  end
+end

data/spec/support/shared_examples/resource_endpoint.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+RSpec.shared_examples 'a resource with API endpoint' do |endpoint, method|
+  subject { described_class }
+
+  it { is_expected.to respond_to(endpoint) }
+
+  it "has #{endpoint} endpoint registered" do
+    expect(subject.api_endpoints).to have_key(endpoint)
+    expect(subject.api_endpoints[endpoint][:method]).to eq(method)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: europeana-api
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Richard Doe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-27 00:00:00.000000000 Z
+date: 2017-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,20 +16,54 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.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.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: 0.12.2
+- !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: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -44,6 +78,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +120,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: dotenv
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +176,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.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: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -103,7 +221,8 @@ dependencies:
 description: Search and retrieve records from the Europeana REST API
 email:
 - richard.doe@rwdit.net
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
 files:
@@ -117,33 +236,37 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- bin/console
 - europeana-api.gemspec
 - lib/europeana/api.rb
+- lib/europeana/api/annotation.rb
+- lib/europeana/api/client.rb
+- lib/europeana/api/entity.rb
 - lib/europeana/api/errors.rb
+- lib/europeana/api/faraday_middleware.rb
+- lib/europeana/api/faraday_middleware/request/authenticated_request.rb
+- lib/europeana/api/faraday_middleware/request/parameter_repetition.rb
+- lib/europeana/api/faraday_middleware/response/handle_text.rb
+- lib/europeana/api/faraday_middleware/response/parse_json_to_various.rb
+- lib/europeana/api/logger.rb
+- lib/europeana/api/queue.rb
 - lib/europeana/api/record.rb
-- lib/europeana/api/record/hierarchy.rb
-- lib/europeana/api/record/hierarchy/ancestor_self_siblings.rb
-- lib/europeana/api/record/hierarchy/base.rb
-- lib/europeana/api/record/hierarchy/children.rb
-- lib/europeana/api/record/hierarchy/following_siblings.rb
-- lib/europeana/api/record/hierarchy/parent.rb
-- lib/europeana/api/record/hierarchy/preceding_siblings.rb
-- lib/europeana/api/record/hierarchy/self.rb
 - lib/europeana/api/request.rb
-- lib/europeana/api/requestable.rb
-- lib/europeana/api/search.rb
-- lib/europeana/api/search/fields.rb
+- lib/europeana/api/resource.rb
+- lib/europeana/api/response.rb
 - lib/europeana/api/version.rb
-- spec/europeana/api/errors_spec.rb
-- spec/europeana/api/record/hierarchy_spec.rb
+- spec/europeana/api/annotation_spec.rb
+- spec/europeana/api/client_spec.rb
+- spec/europeana/api/entity_spec.rb
+- spec/europeana/api/faraday_middleware/request/authenticated_request_spec.rb
+- spec/europeana/api/queue_spec.rb
 - spec/europeana/api/record_spec.rb
-- spec/europeana/api/search_spec.rb
+- spec/europeana/api/request_spec.rb
+- spec/europeana/api/resource_spec.rb
+- spec/europeana/api/response_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
-- spec/support/webmock.rb
+- spec/support/shared_examples/resource_endpoint.rb
 homepage: https://github.com/europeana/europeana-api-client-ruby
 licenses:
 - EUPL V.1.1
@@ -164,19 +287,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Ruby client library for the Europeana API
 test_files:
-- spec/europeana/api/errors_spec.rb
-- spec/europeana/api/record/hierarchy_spec.rb
+- spec/europeana/api/annotation_spec.rb
+- spec/europeana/api/client_spec.rb
+- spec/europeana/api/entity_spec.rb
+- spec/europeana/api/faraday_middleware/request/authenticated_request_spec.rb
+- spec/europeana/api/queue_spec.rb
 - spec/europeana/api/record_spec.rb
-- spec/europeana/api/search_spec.rb
+- spec/europeana/api/request_spec.rb
+- spec/europeana/api/resource_spec.rb
+- spec/europeana/api/response_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
-- spec/support/webmock.rb
-has_rdoc: 
+- spec/support/shared_examples/resource_endpoint.rb