gds-api-adapters 96.0.2 → 96.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc4d5293f2005f19ecf4e118705f8dada987a1dcc7d6a100ee750402d5d3ca2f
-  data.tar.gz: 90b47aa245e497c7d652fc1b2885af98438b69b704b8f7cb229b9960492426e2
+  metadata.gz: 3182c86f70e20b3d92c0cf4f28f63a487e343dff7394d41de0f0953b51fde3fa
+  data.tar.gz: 2e31481af69353c207b13cc4e94c6e59a7f151c94c5eda22d5b2a0d0c4ef86ef
 SHA512:
-  metadata.gz: f2bfe2f375887428b7f29dd888bce619900f0ff8f0c3d51d37fe7771a5282492ad54f584022ac28d4a2e7901c015cb9968c00b15d611b0915302027a27cc1e96
-  data.tar.gz: 3c5ef5415b155090e5c763d5c9087b8b1f2e7db181d558aba488bdcb35a548113d221a6330245999c3e6ea1d2665ef675e84d9efc9924158bd044ecaf1f659f6
+  metadata.gz: 3b4d1743e125d8d1d8928fc7d4bc705fee3dd0eae19342d75d5c07f28dcea2590f8986efc3fd4671885ad610c311cf88deb62bccecd580cef39c3231cbe93834
+  data.tar.gz: a3a01fd52aa66cf83a346c90a025fa7972aee550f19f81de5ff3d033d98415101cf900a2e3e455286e245675a6aaa85ed7a3c1c93a6ac974355cb59eadac4845

data/lib/gds_api/publishing_api.rb

@@ -337,6 +337,22 @@ class GdsApi::PublishingApi < GdsApi::Base
     get_json("#{endpoint}/v2/content#{query}")
   end
 
+  # Get content items which embed a reusable content_id
+  #
+  # No params are currently permitted.
+  #
+  # @example
+  #
+  #   publishing_api.get_content_by_embedded_document("4b148ebc-b2bb-40db-8e48-dd8cff363ff7")
+  #
+  # @return [GdsApi::Response] A response containing a summarised list of the content items which embed the target.
+  # The content items returned will be in either the draft of published state.
+  #
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#get-v2contentcontent_idembedded
+  def get_content_by_embedded_document(content_id)
+    get_json("#{endpoint}/v2/content/#{content_id}/embedded")
+  end
+
   # Returns an Enumerator of content items for the provided
   # query string parameters.
   #

data/lib/gds_api/test_helpers/publishing_api.rb

@@ -340,6 +340,43 @@ module GdsApi
           .to_return(status: 200, body: body.to_json, headers: {})
       end
 
+      # Stub GET /v2/content/:content_id/embedded to return a list of content items that embed the target content_id
+      #
+      # @example
+      #
+      #   stub_publishing_api_has_content_(
+      #     content_id: "9faacf5c-f4e6-4bf9-ba90-413e997c1f22" # this is the content_id for a reusable edition
+      #     total: 1 # the number of results returned
+      #     results: [{
+      #       "title" => "foo",
+      #       "document_type" => "document",
+      #       "base_path" => "/foo",
+      #       "content_id" => "e60fae2a-5490-4e2f-9e80-2093c47608d4",
+      #       "primary_publishing_organisation" => {
+      #         "content_id" => "7662e1e7-79f9-4d0a-b754-6232186851f6",
+      #         "title" => "bar",
+      #         "base_path" => "/organisation/bar",
+      #       },
+      #     }] # an array of content items that embed the target content_id
+      #   )
+      # @param content_id [UUID, Mocha::ParameterMatchers::Anything]
+      # @param total Integer
+      # @param params [Hash]
+      def stub_publishing_api_has_embedded_content(content_id:, total: 0, results: [])
+        url = if content_id.is_a?(Mocha::ParameterMatchers::Anything)
+                %r{\A#{PUBLISHING_API_V2_ENDPOINT}/content/[0-9a-fA-F-]{36}/embedded}
+              else
+                "#{PUBLISHING_API_V2_ENDPOINT}/content/#{content_id}/embedded"
+              end
+
+        stub_request(:get, url)
+          .to_return(body: {
+            "content_id" => content_id,
+            "total" => total,
+            "results" => results,
+          }.to_json)
+      end
+
       # This method has been refactored into publishing_api_has_content (above)
       # publishing_api_has_content allows for flexible passing in of arguments, please use instead
       def stub_publishing_api_has_fields_for_document(document_type, items, fields)

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "96.0.2".freeze
+  VERSION = "96.0.3".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 96.0.2
+  version: 96.0.3
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-25 00:00:00.000000000 Z
+date: 2024-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -268,14 +268,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.18.0
+        version: 5.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.18.0
+        version: 5.0.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -402,7 +402,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.18
 signing_key: 
 specification_version: 4
 summary: Adapters to work with GDS APIs