govuk_content_item_loader 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 208a339dd9691090128a655acbe22bc1c403ce172fd1555318bf15fb67cd533e
-  data.tar.gz: d32050cfdbaf157b5da48878fdb3e5c52c1a0510653d9deae36899da7adbbf0f
+  metadata.gz: d9f2c50ebc136f3c6f3303d1bff102d8f8cb603a2df8fa0d4fa23710ed4c0b6d
+  data.tar.gz: 5d86e91dded77543c5b30d6310245d230ed60cca32a3367406147952427640c4
 SHA512:
-  metadata.gz: 5ed40d8b8dbf4e265ead813865c8b462e22134f4a2e74b55e9df2b4ae506c23622c9d9d085dffd03f4c7c083d74869756356d30ed96f5cff9d56e6dfe9bfaa72
-  data.tar.gz: 65cc4a6631a46bc07d2ab8dc80daf212d1c953e8e4c300329c3b54fa4c75de5aae2da06af57a2accbca7d074988fb1a0c78bacfe56ccc2cab6599666e37ce199
+  metadata.gz: be560a01f12d317253875eeb418a1c3f4962bd31d3c0a63ca2cacb8e74505a3860a1c64080d48374fe8ecf70e66eeb514c88613a3bc1c3cf23921677d8be0188
+  data.tar.gz: 9173b6bf38e6eb65341ec4b7b77c96c65be812d4548a8795822a015ae6cae24bcd2be1656ce4ccabc1e9a82ddfbdf182318dc00e46c5f276b3d51b4c86941528

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 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/lib/govuk_content_item_loader/test_helpers.rb

@@ -0,0 +1,58 @@
+require "json"
+
+module GovukConditionalContentItemLoaderTestHelpers
+  Response = Struct.new(:status, :body, :headers) do
+    def to_h
+      JSON.parse(body)
+    end
+  end
+
+  # 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.to_json unless body.is_a?(String)
+    max_age = options.fetch(:max_age, 900)
+    visibility = options[:private] ? "private" : "public"
+
+    response = Response.new(200, body, {
+      cache_control: "#{visibility}, max-age=#{max_age}",
+      date: Time.now.httpdate,
+    })
+
+    loader = instance_double(GovukConditionalContentItemLoader, load: response)
+
+    allow(GovukConditionalContentItemLoader).to receive(:new).with(request: anything)
+      .and_return(loader)
+    allow(loader).to receive(:load).and_return(body)
+
+    response
+  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.0".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.0
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -162,6 +162,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: