publishing_platform_api_adapters 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54dea58b3d1bcd3fe96e91cb75249bb29a240ba5ab41bba121292b695b8d160b
-  data.tar.gz: f345c52fbb488893dc130248ad994e80df33df0bd80d193cd757f05adaea9493
+  metadata.gz: 7d98513bb44934332a9fe5a7e64933d721d2978aae2244b3f482ce8940ee81fe
+  data.tar.gz: 9472ad4033345b101e7e39291b7658f1d3c9d7abb9e436f99ad94411e4c6c651
 SHA512:
-  metadata.gz: b0e418637bbe6e824c3e31e4334d69862e37c1eaddfaa56fc6e1c9caa4c57d7cf0f464878fbce80901664b9d563300156e1a0e268be14ab75d650046d164a4aa
-  data.tar.gz: 3133b2aa1676a494fe27c5593acdb1b0bc10d1b4933638cbbc4b14262cced73f4651149f1f7bd12151e8618ec7e2f7ffc856f953e663f82c5c64300f95d0f9ff
+  metadata.gz: c0eccb8a41e6b80059a13c772f9943b4a1989df6e36e4e47abfe71db925c8402758dea35db9ce35709b80de34ec29ef2ae30377a3ef2e5ecf080c4b9c36ed7d5
+  data.tar.gz: 98294ca2cf9e577ccd4a3708268d584dbdb20385eb7b8c182a31bf8ee87da7b4f1c24eddb967ce1766da847d362ba258e1ac110aa41eceadab35a3c4361baea5

data/lib/publishing_platform_api/publishing_api.rb

@@ -29,6 +29,52 @@ class PublishingPlatformApi::PublishingApi < PublishingPlatformApi::Base
     get_json(content_url(content_id, params))
   end
 
+  # Find the content_ids for a list of base_paths.
+  #
+  # @param base_paths [Array]
+  # @param exclude_document_types [Array] (optional)
+  # @param exclude_unpublishing_types [Array] (optional)
+  # @param with_drafts [Boolean] (optional)
+  # @return [Hash] a hash, keyed by `base_path` with `content_id` as value
+  # @example
+  #
+  #   publishing_api.lookup_content_ids(base_paths: ['/foo', '/bar'])
+  #   # => { "/foo" => "51ac4247-fd92-470a-a207-6b852a97f2db", "/bar" => "261bd281-f16c-48d5-82d2-9544019ad9ca" }
+  def lookup_content_ids(base_paths:, exclude_document_types: nil, exclude_unpublishing_types: nil, with_drafts: false)
+    options = { base_paths: }
+    options[:exclude_document_types] = exclude_document_types if exclude_document_types
+    options[:exclude_unpublishing_types] = exclude_unpublishing_types if exclude_unpublishing_types
+    options[:with_drafts] = with_drafts if with_drafts
+    response = post_json("#{endpoint}/lookup-by-base-path", options)
+    response.to_hash
+  end
+
+  # Find the content_id for a base_path.
+  #
+  # Convenience method if you only need to look up one content_id for a
+  # base_path. For multiple base_paths, use {PublishingPlatformApi::PublishingApi#lookup_content_ids}.
+  #
+  # @param base_path [String]
+  # @param exclude_document_types [Array] (optional)
+  # @param exclude_unpublishing_types [Array] (optional)
+  # @param with_drafts [Boolean] (optional)
+  #
+  # @return [UUID] the `content_id` for the `base_path`
+  #
+  # @example
+  #
+  #   publishing_api.lookup_content_id(base_path: '/foo')
+  #   # => "51ac4247-fd92-470a-a207-6b852a97f2db"
+  def lookup_content_id(base_path:, exclude_document_types: nil, exclude_unpublishing_types: nil, with_drafts: false)
+    lookups = lookup_content_ids(
+      base_paths: [base_path],
+      exclude_document_types:,
+      exclude_unpublishing_types:,
+      with_drafts:,
+    )
+    lookups[base_path]
+  end
+
   # Publish a content item
   #
   # The publishing-api will "publish" a draft item, so that it will be visible

data/lib/publishing_platform_api/test_helpers/publishing_api.rb

@@ -538,6 +538,22 @@ module PublishingPlatformApi
         stub_request(:get, url).to_return(status: 404, body: resource_not_found(content_id, "link set").to_json, headers: {})
       end
 
+      # Stub calls to the lookups endpoint
+      #
+      # @param lookup_hash [Hash] Hash with base_path as key, content_id as value.
+      #
+      # @example
+      #
+      #   stub_publishing_api_has_lookups({
+      #     "/foo" => "51ac4247-fd92-470a-a207-6b852a97f2db",
+      #     "/bar" => "261bd281-f16c-48d5-82d2-9544019ad9ca"
+      #   })
+      #
+      def stub_publishing_api_has_lookups(lookup_hash)
+        url = "#{PUBLISHING_API_ENDPOINT}/lookup-by-base-path"
+        stub_request(:post, url).to_return(body: lookup_hash.to_json)
+      end
+
       def stub_publishing_api_unreserve_path(base_path, publishing_app = /.*/)
         stub_publishing_api_unreserve_path_with_code(base_path, publishing_app, 200)
       end

data/lib/publishing_platform_api/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: publishing_platform_api_adapters
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Publishing Platform