govuk_content_item_loader 1.2.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2706641da9c4079e8da612e4bf3cb35a18a1d3957995022e54a8051ecce635ec
-  data.tar.gz: b9fb4b83c2cd9a0927f9b998156f3cca9bc390b4a486d7af5d5b96395e567c78
+  metadata.gz: a00bbc8f14d56f67f1ef763163819d0ca8aa5cadc19657e99ba4138e30d5613c
+  data.tar.gz: 7ad600627ef7be66f62cf980d8e9417b044ee39367792d89dac743382c9724cd
 SHA512:
-  metadata.gz: 6ac3b1f7f1d5bad18afe1b0716bc238d2bc7abe3e2c976208cbb0dc9178ecb2dab8549780d4565d1d9e94940ecde2d0af3098f0a04dee32d6de30f1e3985be4a
-  data.tar.gz: da3e422b44b8c86f5bfda89d3f43a2b43992bc2cdf50786477923e338cf29d9daf5a54d7f84cfdb18a354ce572a3fc929af68c8b7e59aece6b94d5d82a6abf9d
+  metadata.gz: 46c9ebf6a037ca8087c093f2f69f5399dc22e1273468ec0b70a833d58e7762e69332f42ad75e1da12082461eb0c94ced34b311da7166ddbf5dd85502ab971e07
+  data.tar.gz: fbbe5c0102e6e13d14a3a5685cee82973afc6c2e5cf31d565b9f96992a03819be1647571259e953c4e88d410dc832df8e05e79da5c32463696d82ea40df79182

data/.github/workflows/ci.yml

@@ -38,7 +38,7 @@ jobs:
     - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
       with:
         ref: ${{ inputs.ref || github.ref }}
-    - uses: ruby/setup-ruby@319994f95fa847cf3fb3cd3dbe89f6dcde9f178f # v1.295.0
+    - uses: ruby/setup-ruby@3ff19f5e2baf30647122352b96108b1fbe250c64 # v1.299.0
       with:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: true

data/CHANGELOG.md

@@ -1,8 +1,17 @@
 # Changelog
 
+## 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,26 @@
-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")
+  include GdsApi::TestHelpers::ContentStore
+  include GdsApi::TestHelpers::PublishingApi
 
-  # 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)
+  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]
-
-    error = GdsApi::HTTPErrorResponse.new(status, message, error_details, 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
 
-    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.1".freeze
+  VERSION = "2.0.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_item_loader
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 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: []
@@ -196,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.8
+rubygems_version: 4.0.9
 specification_version: 4
 summary: Provides a standardised content item loader for GOV.UK frontend apps with
   configurable GraphQL traffic routing and automatic fallback to the Content Store