publishing_platform_api_adapters 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dee0e8a1a5e3c9bf401cb8e96ee9e96b4bce2f4776ce2e37af9ac8ac767e0c1a
-  data.tar.gz: c9834f96d8c100cf903e524e41944fec14c3ef42ca02372b11fdbae31ad4194b
+  metadata.gz: f71db8ee0d906b1e92fd7592d4c7938d338da0f901adc11c44e96db86f0ea955
+  data.tar.gz: 0e1f95953370551c78a5496ad7abbd7fab542c5dcf10ebf4c608901218381c16
 SHA512:
-  metadata.gz: bf30d7ce4c640a5c681b6128f902a257d9ffd5b46a4e4b81602fddb0385537a4aaf5f410856322f4f558e75928771cc2cc9db334794058b1cd8fe56c859ed396
-  data.tar.gz: 103d05a4628054a263f32644c74f95f7525ec60308c1c37dcfd0c51d4f4165bbf4710ad2f11b547d0bf16946ac85692f52b879df124e21491aa73fb4a75e9ff2
+  metadata.gz: 2f369bad7e927df6175e3b444fae7a35a78dd65edd5a0c3f045ea001dcce007af12ce7745bc2b24249b1f5cf8b8b56bf764a39f3b8f443f8de4f1f659c5a3e54
+  data.tar.gz: '04836b8766c6d12c8ec2280827cc2eb5c4da0be1302353d9d89f4e029a633f6263601219f62c06a62668a4dfcbad9434a1207b67bebd68b2e732f1e247c79358'

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/test_helpers/router.rb

@@ -0,0 +1,86 @@
+require "publishing_platform_api/test_helpers/json_client_helper"
+
+module PublishingPlatformApi
+  module TestHelpers
+    module Router
+      ROUTER_API_ENDPOINT = PublishingPlatformLocation.find("router-api")
+
+      def stub_router_has_route(path, route, bearer_token = ENV["ROUTER_API_BEARER_TOKEN"])
+        stub_get_route(path, bearer_token).to_return(
+          status: 200,
+          body: route.to_json,
+          headers: { "Content-Type" => "application/json" },
+        )
+      end
+
+      def stub_router_doesnt_have_route(path, bearer_token = ENV["ROUTER_API_BEARER_TOKEN"])
+        stub_get_route(path, bearer_token).to_return(status: 404)
+      end
+
+      def stub_router_has_backend_route(path, backend_id:, route_type: "exact", disabled: false)
+        stub_router_has_route(path, handler: "backend", backend_id:, disabled:, route_type:)
+      end
+
+      def stub_router_has_redirect_route(path, redirect_to:, route_type: "exact", disabled: false)
+        stub_router_has_route(path, handler: "redirect", redirect_to:, disabled:, route_type:)
+      end
+
+      def stub_router_has_gone_route(path, route_type: "exact", disabled: false)
+        stub_router_has_route(path, handler: "gone", route_type:, disabled:)
+      end
+
+      def stub_all_router_registration
+        stub_request(:put, "#{ROUTER_API_ENDPOINT}/routes")
+      end
+
+      def stub_route_registration(path, type, backend_id)
+        stub_route_put({
+          route: {
+            incoming_path: path,
+            route_type: type,
+            handler: "backend",
+            backend_id:,
+          },
+        })
+      end
+
+      def stub_redirect_registration(path, type, destination, segments_mode = nil)
+        stub_route_put({
+          route: {
+            incoming_path: path,
+            route_type: type,
+            handler: "redirect",
+            redirect_to: destination,
+            segments_mode:,
+          },
+        })
+      end
+
+      def stub_gone_route_registration(path, type)
+        stub_route_put({
+          route: {
+            incoming_path: path,
+            route_type: type,
+            handler: "gone",
+          },
+        })
+      end
+
+    private
+
+      def stub_get_route(path, bearer_token)
+        stub_http_request(:get, "#{ROUTER_API_ENDPOINT}/routes")
+          .with(
+            query: { "incoming_path" => path },
+            headers: { "Authorization" => "Bearer #{bearer_token}" },
+          )
+      end
+
+      def stub_route_put(route)
+        stub_http_request(:put, "#{ROUTER_API_ENDPOINT}/routes")
+            .with(body: route.to_json)
+            .to_return(status: 201)
+      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.2"
 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.2
 platform: ruby
 authors:
 - Publishing Platform
@@ -114,6 +114,9 @@ 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/test_helpers/router.rb
 - lib/publishing_platform_api/version.rb
 - lib/publishing_platform_api_adapters.rb
 licenses:
@@ -133,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Adapters to work with Publishing Platform APIs
 test_files: []