govuk_content_item_loader 1.1.2 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 208a339dd9691090128a655acbe22bc1c403ce172fd1555318bf15fb67cd533e
-  data.tar.gz: d32050cfdbaf157b5da48878fdb3e5c52c1a0510653d9deae36899da7adbbf0f
+  metadata.gz: 2706641da9c4079e8da612e4bf3cb35a18a1d3957995022e54a8051ecce635ec
+  data.tar.gz: b9fb4b83c2cd9a0927f9b998156f3cca9bc390b4a486d7af5d5b96395e567c78
 SHA512:
-  metadata.gz: 5ed40d8b8dbf4e265ead813865c8b462e22134f4a2e74b55e9df2b4ae506c23622c9d9d085dffd03f4c7c083d74869756356d30ed96f5cff9d56e6dfe9bfaa72
-  data.tar.gz: 65cc4a6631a46bc07d2ab8dc80daf212d1c953e8e4c300329c3b54fa4c75de5aae2da06af57a2accbca7d074988fb1a0c78bacfe56ccc2cab6599666e37ce199
+  metadata.gz: 6ac3b1f7f1d5bad18afe1b0716bc238d2bc7abe3e2c976208cbb0dc9178ecb2dab8549780d4565d1d9e94940ecde2d0af3098f0a04dee32d6de30f1e3985be4a
+  data.tar.gz: da3e422b44b8c86f5bfda89d3f43a2b43992bc2cdf50786477923e338cf29d9daf5a54d7f84cfdb18a354ce572a3fc929af68c8b7e59aece6b94d5d82a6abf9d

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.2.1
+
+* Stub the requests in test helpers and add Plek as dependency 
+
+## 1.2.0
+
+* Add test helpers which provide stubs
+
 ## 1.1.2
 
 * Update dependencies

data/README.md

@@ -86,6 +86,10 @@ loader = GovukGraphql::ConditionalContentItemLoader.new(
 
 The decision logic is also exposed via `can_load_from_graphql?`, allowing applications to make the routing decision themselves and implement custom fallback or error-handling behaviour if needed.
 
+## Test helpers
+
+There are also test helpers for stubbing responses in other apps. See [lib/test_helpers.rb](/lib/test_helpers.rb).
+
 ## Licence
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/govuk_content_item_loader.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib]
 
   spec.add_dependency "gds-api-adapters", ">= 99.3"
+  spec.add_dependency "plek", ">= 1.9.0"
   spec.add_dependency "railties", ">= 7.2"
 
   spec.add_development_dependency "climate_control"

data/lib/govuk_content_item_loader/test_helpers.rb

@@ -0,0 +1,58 @@
+require "json"
+
+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)
+  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)
+
+    loader = instance_double(GovukConditionalContentItemLoader)
+
+    allow(GovukConditionalContentItemLoader).to receive(:new).with(request: anything)
+      .and_return(loader)
+    allow(loader).to receive(:load).and_raise(error)
+
+    error
+  end
+end

data/lib/govuk_content_item_loader/version.rb

@@ -1,3 +1,3 @@
 module GovukContentItemLoader
-  VERSION = "1.1.2".freeze
+  VERSION = "1.2.1".freeze
 end

data/lib/govuk_content_item_loader.rb

@@ -1,3 +1,4 @@
 require "govuk_content_item_loader/govuk_graphql_traffic_rates"
 require "govuk_content_item_loader/govuk_conditional_content_item_loader"
 require "govuk_content_item_loader/version"
+require "govuk_content_item_loader/test_helpers"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_item_loader
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.1
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '99.3'
+- !ruby/object:Gem::Dependency
+  name: plek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -162,6 +176,7 @@ files:
 - lib/govuk_content_item_loader.rb
 - lib/govuk_content_item_loader/govuk_conditional_content_item_loader.rb
 - lib/govuk_content_item_loader/govuk_graphql_traffic_rates.rb
+- lib/govuk_content_item_loader/test_helpers.rb
 - lib/govuk_content_item_loader/version.rb
 homepage: https://github.com/alphagov/govuk_content_item_loader
 licenses: