gds-api-adapters 4.0.0 → 4.1.0

data/lib/gds_api/test_helpers/content_api.rb

@@ -1,5 +1,6 @@
 require 'gds_api/test_helpers/json_client_helper'
 require 'cgi'
+require_relative 'content_api/artefact_stub'
 
 module GdsApi
   module TestHelpers
@@ -78,18 +79,21 @@ module GdsApi
       end
 
       def content_api_has_an_artefact(slug, body = artefact_for_slug(slug))
-        url = "#{CONTENT_API_ENDPOINT}/#{slug}.json"
-        stub_request(:get, url).to_return(status: 200, body: body.to_json, headers: {})
+        ArtefactStub.new(slug).with_response_body(body).stub
       end
 
       def content_api_has_unpublished_artefact(slug, edition, body = artefact_for_slug(slug))
-        url = "#{CONTENT_API_ENDPOINT}/#{slug}.json?edition=#{edition}"
-        stub_request(:get, url).to_return(status: 200, body: body.to_json, headers: {})
+        ArtefactStub.new(slug)
+            .with_response_body(body)
+            .with_query_parameters(edition: edition)
+            .stub
       end
 
       def content_api_has_an_artefact_with_snac_code(slug, snac, body = artefact_for_slug(slug))
-        url = "#{CONTENT_API_ENDPOINT}/#{slug}.json?snac=#{snac}"
-        stub_request(:get, url).to_return(status: 200, body: body.to_json, headers: {})
+        ArtefactStub.new(slug)
+            .with_response_body(body)
+            .with_query_parameters(snac: snac)
+            .stub
       end
 
       def content_api_does_not_have_an_artefact(slug)
@@ -98,8 +102,10 @@ module GdsApi
             "status" => "not found"
           }
         }
-        url = "#{CONTENT_API_ENDPOINT}/#{slug}.json"
-        stub_request(:get, url).to_return(status: 404, body: body.to_json, headers: {})
+        ArtefactStub.new(slug)
+            .with_response_body(body)
+            .with_response_status(404)
+            .stub
       end
 
       def content_api_has_an_archived_artefact(slug)
@@ -109,10 +115,13 @@ module GdsApi
             "status_message" => "This item is no longer available"
           }
         }
-        url = "#{CONTENT_API_ENDPOINT}/#{slug}.json"
-        stub_request(:get, url).to_return(status: 410, body: body.to_json, headers: {})
+        ArtefactStub.new(slug)
+            .with_response_body(body)
+            .with_response_status(410)
+            .stub
       end
 
+      # Stub requests, and then dynamically generate a response based on the slug in the request
       def stub_content_api_default_artefact
         stub_request(:get, %r{\A#{CONTENT_API_ENDPOINT}/[a-z0-9-]+\.json}).to_return { |request|
           slug = request.uri.path.split('/').last.chomp('.json')

data/lib/gds_api/test_helpers/content_api/artefact_stub.rb

@@ -0,0 +1,55 @@
+module GdsApi
+  module TestHelpers
+    module ContentApi
+      class ArtefactStub
+        include WebMock::API
+        # This is ugly, but the nicest way we found to get access to artefact_for_slug
+        include GdsApi::TestHelpers::ContentApi
+
+        attr_accessor :slug, :query_parameters, :response_body, :response_status
+
+        def initialize(slug)
+          @slug = slug
+          @query_parameters = {}
+          @response_body = artefact_for_slug(slug)
+          @response_status = 200
+        end
+        
+        def with_query_parameters(hash)
+          @query_parameters = hash
+          self
+        end
+
+        def with_response_body(response_body)
+          @response_body = response_body
+          self
+        end
+
+        def with_response_status(response_status)
+          @response_status = response_status
+          self
+        end
+
+        # Nothing is stubbed until this is called
+        def stub
+          stub_request(:get, url_without_query)
+              .with(query: hash_including(comparable_query_params))
+              .to_return(status: @response_status, body: @response_body.to_json)
+        end
+        
+        private
+          def url_without_query
+            "#{CONTENT_API_ENDPOINT}/#{slug}.json"
+          end
+
+          # Ensure that all keys and values are strings 
+          # because Webmock doesn't handle symbols
+          def comparable_query_params
+            @query_parameters.each_with_object({}) do |(k,v),hash| 
+              hash[k.to_s] = v.nil? ? v : v.to_s
+            end
+          end
+      end
+    end
+  end
+end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '4.0.0'
+  VERSION = '4.1.0'
 end

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors: 
 - James Stewart
@@ -166,40 +166,41 @@ extra_rdoc_files: []
 
 files: 
 - lib/gds_api/version.rb
-- lib/gds_api/typhoeus_client.rb
-- lib/gds_api/base.rb
-- lib/gds_api/licence_application.rb
+- lib/gds_api/publisher.rb
 - lib/gds_api/panopticon/registerer.rb
-- lib/gds_api/needotron.rb
-- lib/gds_api/imminence.rb
-- lib/gds_api/rummager.rb
+- lib/gds_api/typhoeus_client.rb
 - lib/gds_api/content_api.rb
-- lib/gds_api/exceptions.rb
-- lib/gds_api/json_client.rb
-- lib/gds_api/core-ext/openstruct.rb
-- lib/gds_api/response.rb
-- lib/gds_api/publisher.rb
-- lib/gds_api/test_helpers/licence_application.rb
-- lib/gds_api/test_helpers/imminence.rb
-- lib/gds_api/test_helpers/content_api.rb
+- lib/gds_api/imminence.rb
 - lib/gds_api/test_helpers/publisher.rb
+- lib/gds_api/test_helpers/content_api.rb
+- lib/gds_api/test_helpers/imminence.rb
+- lib/gds_api/test_helpers/licence_application.rb
+- lib/gds_api/test_helpers/content_api/artefact_stub.rb
 - lib/gds_api/test_helpers/panopticon.rb
 - lib/gds_api/test_helpers/json_client_helper.rb
-- lib/gds_api/part_methods.rb
+- lib/gds_api/licence_application.rb
+- lib/gds_api/base.rb
+- lib/gds_api/json_client.rb
+- lib/gds_api/response.rb
+- lib/gds_api/rummager.rb
 - lib/gds_api/panopticon.rb
+- lib/gds_api/core-ext/openstruct.rb
+- lib/gds_api/part_methods.rb
+- lib/gds_api/needotron.rb
+- lib/gds_api/exceptions.rb
 - lib/gds_api/helpers.rb
 - README.md
 - Rakefile
-- test/rummager_test.rb
-- test/publisher_api_test.rb
-- test/licence_application_api_test.rb
 - test/panopticon_api_test.rb
+- test/publisher_api_test.rb
+- test/rummager_test.rb
 - test/imminence_api_test.rb
+- test/panopticon_registerer_test.rb
+- test/content_api_test.rb
 - test/json_client_test.rb
-- test/test_helper.rb
 - test/gds_api_base_test.rb
-- test/content_api_test.rb
-- test/panopticon_registerer_test.rb
+- test/licence_application_api_test.rb
+- test/test_helper.rb
 homepage: http://github.com/alphagov/gds-api-adapters
 licenses: []
 
@@ -213,7 +214,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3063781964090340583
+      hash: -316804673231244671
       segments: 
       - 0
       version: "0"
@@ -222,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3063781964090340583
+      hash: -316804673231244671
       segments: 
       - 0
       version: "0"
@@ -234,13 +235,13 @@ signing_key:
 specification_version: 3
 summary: Adapters to work with GDS APIs
 test_files: 
-- test/rummager_test.rb
-- test/publisher_api_test.rb
-- test/licence_application_api_test.rb
 - test/panopticon_api_test.rb
+- test/publisher_api_test.rb
+- test/rummager_test.rb
 - test/imminence_api_test.rb
+- test/panopticon_registerer_test.rb
+- test/content_api_test.rb
 - test/json_client_test.rb
-- test/test_helper.rb
 - test/gds_api_base_test.rb
-- test/content_api_test.rb
-- test/panopticon_registerer_test.rb
+- test/licence_application_api_test.rb
+- test/test_helper.rb