publishing_platform_api_adapters 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dee0e8a1a5e3c9bf401cb8e96ee9e96b4bce2f4776ce2e37af9ac8ac767e0c1a
-  data.tar.gz: c9834f96d8c100cf903e524e41944fec14c3ef42ca02372b11fdbae31ad4194b
+  metadata.gz: 12a639bdc05f05fbcb78557b20924d4d95286b09af685f76f5e2b6989d998bd7
+  data.tar.gz: '0674539db2157aac06598a56fe898cbcb1ce4baa847f2bef637d62dbe4947501'
 SHA512:
-  metadata.gz: bf30d7ce4c640a5c681b6128f902a257d9ffd5b46a4e4b81602fddb0385537a4aaf5f410856322f4f558e75928771cc2cc9db334794058b1cd8fe56c859ed396
-  data.tar.gz: 103d05a4628054a263f32644c74f95f7525ec60308c1c37dcfd0c51d4f4165bbf4710ad2f11b547d0bf16946ac85692f52b879df124e21491aa73fb4a75e9ff2
+  metadata.gz: 19667cbc60807f1d7c3fe54eb1ab0a8bd5437fe328f011cd5fc8e1bfa13085218c84bd80a146c645a18cc65af8ddef2dceec9b14a46f689508be7abe737b16c3
+  data.tar.gz: e77e8a1bd9b420c84dfdbf09bcbee8d672eab10f27422a14d6a0568572f0f8286e4a8b11cc25969a70d3e95c67bcde71c46cc55851bdb6c57070c47550e8c6f7

data/lib/publishing_platform_api/test_helpers/content_item_helpers.rb

@@ -0,0 +1,41 @@
+module PublishingPlatformApi
+  module TestHelpers
+    module ContentItemHelpers
+      def content_item_for_base_path(base_path)
+        {
+          "title" => titleize_base_path(base_path),
+          "description" => "Description for #{base_path}",
+          "schema_name" => "answer",
+          "document_type" => "answer",
+          "public_updated_at" => "2014-05-06T12:01:00+00:00",
+          # base_path is added in as necessary (ie for content-store GET responses)
+          # "base_path" => base_path,
+          "details" => {
+            "body" => "Some content for #{base_path}",
+          },
+        }
+      end
+
+      def gone_content_item_for_base_path(base_path)
+        {
+          "title" => nil,
+          "description" => nil,
+          "document_type" => "gone",
+          "schema_name" => "gone",
+          "public_updated_at" => nil,
+          "base_path" => base_path,
+          "withdrawn_notice" => {},
+          "details" => {},
+        }
+      end
+
+      def titleize_base_path(base_path, options = {})
+        if options[:title_case]
+          base_path.tr("-", " ").gsub(/\b./, &:upcase)
+        else
+          base_path.gsub(%r{[-/]}, " ").strip.capitalize
+        end
+      end
+    end
+  end
+end

data/lib/publishing_platform_api/test_helpers/content_store.rb

@@ -0,0 +1,84 @@
+require "publishing_platform_api/test_helpers/content_item_helpers"
+require "json"
+
+module PublishingPlatformApi
+  module TestHelpers
+    module ContentStore
+      include ContentItemHelpers
+
+      def content_store_endpoint(draft: false)
+        draft ? PublishingPlatformLocation.find("draft-content-store") : PublishingPlatformLocation.find("content-store")
+      end
+
+      # Stubs a content item in the content store.
+      # 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"
+      #   :draft    will point to the draft content store if set to true
+      def stub_content_store_has_item(base_path, body = content_item_for_base_path(base_path), options = {})
+        max_age = options.fetch(:max_age, 900)
+        visibility = options[:private] ? "private" : "public"
+        body = body.to_json unless body.is_a?(String)
+
+        endpoint = content_store_endpoint(draft: options[:draft])
+        stub_request(:get, "#{endpoint}/content#{base_path}").to_return(
+          status: 200,
+          body:,
+          headers: {
+            cache_control: "#{visibility}, max-age=#{max_age}",
+            date: Time.now.httpdate,
+          },
+        )
+      end
+
+      def stub_content_store_does_not_have_item(base_path, options = {})
+        endpoint = content_store_endpoint(draft: options[:draft])
+        stub_request(:get, "#{endpoint}/content#{base_path}").to_return(status: 404, headers: {})
+      end
+
+      # Content store has gone item
+      #
+      # Stubs a content item in the content store to respond with 410 HTTP Status Code and response body with 'format' set to 'gone'.
+      #
+      # @param base_path [String]
+      # @param body [Hash]
+      # @param options [Hash]
+      # @option options [String] draft Will point to the draft content store if set to true
+      #
+      # @example
+      #
+      #   stub_content_store.stub_content_store_has_gone_item('/sample-slug')
+      #
+      #   # Will return HTTP Status Code 410 and the following response body:
+      #   {
+      #     "title" => nil,
+      #     "description" => nil,
+      #     "format" => "gone",
+      #     "schema_name" => "gone",
+      #     "public_updated_at" => nil,
+      #     "base_path" => "/sample-slug",
+      #     "withdrawn_notice" => {},
+      #     "details" => {}
+      #   }
+      def stub_content_store_has_gone_item(base_path, body = gone_content_item_for_base_path(base_path), options = {})
+        body = body.to_json unless body.is_a?(String)
+        endpoint = content_store_endpoint(draft: options[:draft])
+        stub_request(:get, "#{endpoint}/content#{base_path}").to_return(
+          status: 410,
+          body:,
+          headers: {},
+        )
+      end
+
+      def stub_content_store_isnt_available
+        stub_request(:any, /#{content_store_endpoint}\/.*/).to_return(status: 503)
+      end
+
+      def content_item_for_base_path(base_path)
+        super.merge("base_path" => base_path)
+      end
+    end
+  end
+end

data/lib/publishing_platform_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PublishingPlatformApi
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: publishing_platform_api_adapters
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Publishing Platform
@@ -114,6 +114,8 @@ files:
 - lib/publishing_platform_api/railtie.rb
 - lib/publishing_platform_api/response.rb
 - lib/publishing_platform_api/router.rb
+- lib/publishing_platform_api/test_helpers/content_item_helpers.rb
+- lib/publishing_platform_api/test_helpers/content_store.rb
 - lib/publishing_platform_api/version.rb
 - lib/publishing_platform_api_adapters.rb
 licenses: