govuk_content_item_loader 1.2.2 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 704a8afd75af58674109ebefcb22e9855c481d7b5280330e6f1d25eac2fcbec2
-  data.tar.gz: 7415244c1e4abd90dfd25e1499bb083839e1dc0bc37d6ae6c9937c9c256a9c26
+  metadata.gz: 7bb947b61c830b418c2941913dc207c17b6f175e3d6ba2a0ed13051ba60a0fc4
+  data.tar.gz: '024586893b7ad6492cec7ca9f7c52dbf0f6eab6fd480b0f1910727d9bd4becf9'
 SHA512:
-  metadata.gz: 20823b0e5c2a93ede2bb195995393aa692dbb07e4b5d0cafe02b6d241ecac06c072bb8f009419dd66424b44a91237e813d6e226a282c300a46eb12fc7c52a13a
-  data.tar.gz: b9a349fb86b3232ae009d77c60672c0c8cdea9c5850f2d639e17ca09ea3d6724999314cfdbc540d933353aa4d333abc18716eb17607b1272b2f1a73a29430037
+  metadata.gz: 6561e782d74861fc4b641f37924d55b92a5337c2cff0bd90d7331bbaaae6eaa91ea6320d4e3f4b6f0d9f337ca06a2caaa79dc9362692ac43134d579e634db82f
+  data.tar.gz: 2afa336300d20386fa0525edd2e97105e8d1291a70467cfb91fe629a81e268c799f1c49e6832ea045342c0b67ca2e5e5ed4f63561e21823a7d00878cefc70917

data/CHANGELOG.md

@@ -1,12 +1,22 @@
 # Changelog
 
+## 2.0.1
+
+* Add `stub_conditional_content_loader_isnt_available` test helper.
+* Add `stub_conditional_content_loader_has_gone_item` test helper.
+
+## 2.0.0
+
+* BREAKING: replaces `stub_conditional_loader_returns_content_item` test helper with `stub_conditional_loader_returns_content_item_for_path` to match requests to a specific request path, for testing in frontend applications.
+* BREAKING: replaces `stub_conditional_loader_does_not_return_content_item` test helper with `stub_conditional_loader_does_not_return_content_item_for_path` to match requests to a specific request path, for testing in frontend applications.
+
 ## 1.2.2
 
 * Update dependencies
 
 ## 1.2.1
 
-* Stub the requests in test helpers and add Plek as dependency 
+* Stub the requests in test helpers and add Plek as dependency
 
 ## 1.2.0
 

data/govuk_content_item_loader.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop-govuk", "~> 5.2"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webmock"
 end

data/lib/govuk_content_item_loader/test_helpers.rb

@@ -1,58 +1,36 @@
-require "json"
+require "gds_api/test_helpers/content_item_helpers"
+require "gds_api/test_helpers/content_store"
+require "gds_api/test_helpers/publishing_api"
 
 module GovukConditionalContentItemLoaderTestHelpers
-  CONTENT_STORE_ENDPOINT = Plek.find("content-store")
-  PUBLISHING_API_ENDPOINT = Plek.find("publishing-api")
-
-  # Stubs the loader returns a content item
-  # The following options can be passed in:
-  #
-  #   :max_age  will set the max-age of the Cache-Control header in the response. Defaults to 900
-  #   :private  if true, the Cache-Control header will include the "private" directive. By default it
-  #             will include "public"
-  def stub_conditional_loader_returns_content_item(body, options = {})
-    body = body.is_a?(String) ? body : body.to_json
-    max_age = options.fetch(:max_age, 900)
-    visibility = options[:private] ? "private" : "public"
-
-    [CONTENT_STORE_ENDPOINT, PUBLISHING_API_ENDPOINT].each do |endpoint|
-      stub_request(:get, %r{#{Regexp.escape(endpoint)}}).to_return(
-        status: 200,
-        body: body,
-        headers: {
-          "Cache-Control" => "#{visibility}, max-age=#{max_age}",
-          "Date" => Time.now.httpdate,
-        },
-      )
-    end
-
-    loader = instance_double(GovukConditionalContentItemLoader, load: JSON.parse(body))
-
-    allow(GovukConditionalContentItemLoader).to receive(:new).with(request: anything)
-      .and_return(loader)
+  include GdsApi::TestHelpers::ContentStore
+  include GdsApi::TestHelpers::PublishingApi
+
+  def stub_conditional_loader_returns_content_item_for_path(base_path, body = content_item_for_base_path(base_path), options = {})
+    stub_content_store_has_item(base_path, body, options)
+    stub_publishing_api_graphql_has_item(base_path, body, options)
   end
 
-  # Stubs the loader returns a error response
-  # The following options can be passed in:
-  #
-  #   :status         the HTTP status code for the error. Defaults to 404
-  #   :message        the error message. Defaults to "Not Found"
-  #   :error_details  optional additional error details to attach to the exception
-  #   :http_body      optional raw response body to attach to the exception
-  def stub_conditional_loader_does_not_return_content_item(options = {})
-    status = options.fetch(:status, 404)
-    message = options.fetch(:message, "Not Found")
-    error_details = options[:error_details]
-    http_body = options[:http_body]
+  def stub_conditional_loader_does_not_return_content_item_for_path(base_path, options = {})
+    stub_content_store_does_not_have_item(base_path, options)
+    stub_publishing_api_graphql_does_not_have_item(base_path)
+  end
 
-    error = GdsApi::HTTPErrorResponse.new(status, message, error_details, http_body)
+  def stub_conditional_content_loader_isnt_available
+    stub_content_store_isnt_available
+    stub_publishing_api_isnt_available
+  end
+
+  def stub_conditional_content_loader_has_gone_item(base_path)
+    stub_content_store_has_gone_item(base_path)
+    stub_publishing_api_graphql_has_gone_item(base_path)
+  end
 
-    loader = instance_double(GovukConditionalContentItemLoader)
+private
 
-    allow(GovukConditionalContentItemLoader).to receive(:new).with(request: anything)
-      .and_return(loader)
-    allow(loader).to receive(:load).and_raise(error)
+  def content_item_for_base_path(base_path)
+    include GdsApi::TestHelpers::ContentItemHelpers
 
-    error
+    super.merge("base_path" => base_path)
   end
 end

data/lib/govuk_content_item_loader/version.rb

@@ -1,3 +1,3 @@
 module GovukContentItemLoader
-  VERSION = "1.2.2".freeze
+  VERSION = "2.0.1".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_item_loader
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 2.0.1
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -149,6 +149,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
 executables: []