gds-api-adapters 97.3.0 → 97.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff4790d228201b1c229e1e2b884a2eae62465642cfe426581b5b3c32726536b2
-  data.tar.gz: d25f58e557df2982e70e1e373ee4665b0984aa1068944f0f33381cf0a931cc53
+  metadata.gz: a3d86ff9c8bece588fe1eae2ec8ec8c71ca5ef5108c7b900f19f8444fb2d016b
+  data.tar.gz: 4d83794af16a9af548c3a1f803afb2e05f619728e3623305b6af667a9315b635
 SHA512:
-  metadata.gz: 1fde2097672b343ebad3e5f55d7a15a2b1e42415611d6a49e6d39239dd0dd31941c73000043e264cfc7292e410454bc28910fe638715b6090d34cbd3b6829871
-  data.tar.gz: 7dc3ec03939c0cf2e0f92174c9a4588fd2b378aa0af457a2f876b6a743b19f2903a82a63b6e5f000a51295dd80e1e6e6577daeeaa4fd117d2158a4d2c11cec3e
+  metadata.gz: bc5856e22afbf5d6484a1b31074e14ed3a1d40dbdb902cb6ed7fb8f62c01c28ea238dbbe0d370373a9d08180057fbf69207916dc72a3706eee9174eacfc62129
+  data.tar.gz: 18e2a2894684c34f4ee5fe549bb88dae6cdc712e885996d597239e6ae8b9b780314c68ad3c2e7fc13b7af898eedb222541597272b1552400a83353fba08d246c

data/lib/gds_api/publishing_api.rb

@@ -342,7 +342,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   # @param content_id [UUID]
   # @param params [Hash]
   #
-  #   publishing_api.get_content_by_embedded_document(
+  #   publishing_api.get_host_content_for_content_id(
   #     "4b148ebc-b2bb-40db-8e48-dd8cff363ff7",
   #     { page: 1, order: '-last_edited_at' }
   #   )
@@ -350,10 +350,15 @@ class GdsApi::PublishingApi < GdsApi::Base
   # @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, params = {})
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#get-v2contentcontent_idhost-content
+  def get_host_content_for_content_id(content_id, params = {})
     query = query_string(params)
-    get_json("#{endpoint}/v2/content/#{content_id}/embedded#{query}")
+    get_json("#{endpoint}/v2/content/#{content_id}/host-content#{query}")
+  end
+
+  def get_content_by_embedded_document(content_id, params = {})
+    warn "GdsAPI::PublishingApi: #get_content_by_embedded_document deprecated (please use #get_host_content_for_content_id)"
+    get_host_content_for_content_id(content_id, params)
   end
 
   # Returns an Enumerator of content items for the provided

data/lib/gds_api/test_helpers/publishing_api.rb

@@ -371,13 +371,28 @@ module GdsApi
       #         "base_path" => "/organisation/bar",
       #       },
       #     }] # an array of content items that embed the target content_id
+      #     rollup: {
+      #       "views" => 1
+      #       "locations" => 1
+      #       "instances" => 1
+      #       "organisations" => 1
+      #     } # metadata with the total counts across all pages
       #   )
-      # @param content_id [UUID, Mocha::ParameterMatchers::Anything]
+      # @param content_id [UUID]
       # @param total Integer
       # @param total_pages Integer
-      # @param results [Hash]
-      def stub_publishing_api_has_embedded_content(content_id:, total: 0, total_pages: 0, results: [], page_number: nil, order: nil)
-        url = "#{PUBLISHING_API_V2_ENDPOINT}/content/#{content_id}/embedded"
+      # @param results [Array]
+      # @param rollup [Hash]
+      def stub_publishing_api_has_embedded_content(
+        content_id:,
+        total: 0,
+        total_pages: 0,
+        results: [],
+        page_number: nil,
+        order: nil,
+        rollup: {}
+      )
+        url = "#{PUBLISHING_API_V2_ENDPOINT}/content/#{content_id}/host-content"
 
         query = {
           "page" => page_number,
@@ -390,12 +405,20 @@ module GdsApi
             "content_id" => content_id,
             "total" => total,
             "total_pages" => total_pages,
+            "rollup" => rollup,
             "results" => results,
           }.to_json)
       end
 
-      def stub_publishing_api_has_embedded_content_for_any_content_id(total: 0, total_pages: 0, results: [], page_number: nil, order: nil)
-        url = %r{\A#{PUBLISHING_API_V2_ENDPOINT}/content/[0-9a-fA-F-]{36}/embedded}
+      def stub_publishing_api_has_embedded_content_for_any_content_id(
+        total: 0,
+        total_pages: 0,
+        results: [],
+        page_number: nil,
+        order: nil,
+        rollup: {}
+      )
+        url = %r{\A#{PUBLISHING_API_V2_ENDPOINT}/content/[0-9a-fA-F-]{36}/host-content}
 
         query = {
           "page" => page_number,
@@ -408,6 +431,7 @@ module GdsApi
             "content_id" => SecureRandom.uuid,
             "total" => total,
             "total_pages" => total_pages,
+            "rollup" => rollup,
             "results" => results,
           }.to_json)
       end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "97.3.0".freeze
+  VERSION = "97.4.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 97.3.0
+  version: 97.4.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-14 00:00:00.000000000 Z
+date: 2024-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -268,14 +268,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: 5.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: 5.0.3
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement