publishing_platform_api_adapters 0.7.1 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc390ba19e31be9e7e3457b2f4f3534e3da0023a41854b22b0db5fa11e364588
-  data.tar.gz: 06c5faed53a2faf13ee59a5f0a304343204c890ece1ddfbdae69da7a8135bfe5
+  metadata.gz: 12a639bdc05f05fbcb78557b20924d4d95286b09af685f76f5e2b6989d998bd7
+  data.tar.gz: '0674539db2157aac06598a56fe898cbcb1ce4baa847f2bef637d62dbe4947501'
 SHA512:
-  metadata.gz: 929d2167c3e4f3342f21f25923218ca718cdeb00679ac58c652a69baf69b6dbee815266191946f3fad3b52e94b2323de02d7b33d2a71de915d8b9b35a6eb2138
-  data.tar.gz: e982309742921c2ecbafba1d6a7844d8e4f0371ea77ac2ec99cbf31dc202029013db71b0b454357ecfcb07dc4b031fe100fb3420f2d36d9dc39221ffa15b1183
+  metadata.gz: 19667cbc60807f1d7c3fe54eb1ab0a8bd5437fe328f011cd5fc8e1bfa13085218c84bd80a146c645a18cc65af8ddef2dceec9b14a46f689508be7abe737b16c3
+  data.tar.gz: e77e8a1bd9b420c84dfdbf09bcbee8d672eab10f27422a14d6a0568572f0f8286e4a8b11cc25969a70d3e95c67bcde71c46cc55851bdb6c57070c47550e8c6f7

data/lib/publishing_platform_api/content_store.rb

@@ -16,9 +16,96 @@ class PublishingPlatformApi::ContentStore < PublishingPlatformApi::Base
     raise ItemNotFound.build_from(e)
   end
 
+  # Returns an array tuple of destination url with status code e.g
+  # ["https://www.publishing-platform.co.uk/destination", 301]
+  def self.redirect_for_path(content_item, request_path, request_query = "")
+    RedirectResolver.call(content_item, request_path, request_query)
+  end
+
 private
 
   def content_item_url(base_path)
     "#{endpoint}/content#{base_path}"
   end
+
+  class RedirectResolver
+    def initialize(content_item, request_path, request_query = "")
+      @content_item = content_item
+      @request_path = request_path
+      @request_query = request_query.to_s
+    end
+
+    def self.call(*args)
+      new(*args).call
+    end
+
+    def call
+      redirect = redirect_for_path(request_path)
+      raise UnresolvedRedirect, "Could not find a matching redirect" unless redirect
+
+      destination_uri = URI.parse(
+        resolve_destination(redirect, request_path, request_query),
+      )
+
+      url = if destination_uri.absolute?
+              destination_uri.to_s
+            else
+              "#{PublishingPlatformLocation.new.website_root}#{destination_uri}"
+            end
+
+      [url, 301]
+    end
+
+    private_class_method :new
+
+  private
+
+    attr_reader :content_item, :request_path, :request_query
+
+    def redirect_for_path(path)
+      redirects_by_segments.find do |r|
+        next true if r["path"] == path
+
+        route_prefix_match?(r["path"], path) if r["type"] == "prefix"
+      end
+    end
+
+    def redirects_by_segments
+      redirects = content_item["redirects"] || []
+      redirects.sort_by { |r| r["path"].split("/").count * -1 }
+    end
+
+    def route_prefix_match?(prefix_path, path_to_match)
+      prefix_regex = %r{^#{Regexp.escape(prefix_path)}/}
+      path_to_match.match prefix_regex
+    end
+
+    def resolve_destination(redirect, path, query)
+      return redirect["destination"] unless redirect["segments_mode"] == "preserve"
+
+      if redirect["type"] == "prefix"
+        prefix_destination(redirect, path, query)
+      else
+        redirect["destination"] + (query.empty? ? "" : "?#{query}")
+      end
+    end
+
+    def prefix_destination(redirect, path, query)
+      uri = URI.parse(redirect["destination"])
+      start_char = redirect["path"].length
+      suffix = path[start_char..]
+
+      if uri.path == "" && suffix[0] != "/"
+        uri.path = "/#{suffix}"
+      else
+        uri.path += suffix
+      end
+
+      uri.query = query if uri.query.nil? && !query.empty?
+
+      uri.to_s
+    end
+  end
+
+  class UnresolvedRedirect < PublishingPlatformApi::BaseError; end
 end

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.7.1"
+  VERSION = "0.8.1"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: publishing_platform_api_adapters
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.1
 platform: ruby
 authors:
 - Publishing Platform
 bindir: bin
 cert_chain: []
-date: 2025-02-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -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:
@@ -133,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Adapters to work with Publishing Platform APIs
 test_files: []