gds-api-adapters 97.2.0 → 97.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28d51629867498d4a82ac5e2ea9a1062a016144545e905060d4dadf6a8116b1a
-  data.tar.gz: 5c376df981bae6c3197e3c3a98e45375d168256a3d5b6bd3700704e64ca4ee39
+  metadata.gz: 65cb765ee9c7ec5ecc14786031a300445ebe47913fd1725dc45029544ca4bbae
+  data.tar.gz: e4a1d38fc0d071fb94a8c23f3ca9835a39782ff494c6ac169ff5f4a54d1aa74a
 SHA512:
-  metadata.gz: fb03d3158c4e924abd93cbef80c524e65b2efd190056d0fa63a296ba7a58ea5af80e98bf53d45ebef59903d02121bc1d826901c2cedc8028521ed5ede199a605
-  data.tar.gz: '0334915fa9576323f28f07d4bc9aa5d904ad3573078a63b9b62f6dd5fb3c63bd96f2e6f22ffab5981639bac730231719959686034f91614d111ac4de4d3e0d4a'
+  metadata.gz: 1789520088667eed07cff11b73c47b8b88f0f44a9dcfddb3ac18c876f502011d88e545bd0a3bf687f48991a64aaa39afd49e82905be68e10043964f4e5caa65a
+  data.tar.gz: 130e302e05e3337dc9a2a536cba8cde370c809c9efab27e9ba394ab97ed494c313cf30cf88a6206e0be29cda8855706a6300471d2f86565e337fe26b3bf73719

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/search_api_v2.rb

@@ -4,5 +4,11 @@ module GdsApi
       request_url = "#{endpoint}/search.json?#{Rack::Utils.build_nested_query(args)}"
       get_json(request_url, additional_headers)
     end
+
+    def autocomplete(query)
+      args = { q: query }
+      request_url = "#{endpoint}/autocomplete.json?#{Rack::Utils.build_nested_query(args)}"
+      get_json(request_url)
+    end
   end
 end

data/lib/gds_api/test_helpers/publishing_api.rb

@@ -376,14 +376,16 @@ module GdsApi
       # @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: [])
-        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
+      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"
+
+        query = {
+          "page" => page_number,
+          "order" => order,
+        }.compact
 
         stub_request(:get, url)
+          .with(query:)
           .to_return(body: {
             "content_id" => content_id,
             "total" => total,
@@ -392,6 +394,24 @@ module GdsApi
           }.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}
+
+        query = {
+          "page" => page_number,
+          "order" => order,
+        }.compact
+
+        stub_request(:get, url)
+          .with { |request| WebMock::Util::QueryMapper.query_to_values(request.uri.query) == query }
+          .to_return(body: {
+            "content_id" => SecureRandom.uuid,
+            "total" => total,
+            "total_pages" => total_pages,
+            "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 = "97.2.0".freeze
+  VERSION = "97.4.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 97.2.0
+  version: 97.4.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-13 00:00:00.000000000 Z
+date: 2024-11-26 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