gds-api-adapters 96.0.2 → 97.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc4d5293f2005f19ecf4e118705f8dada987a1dcc7d6a100ee750402d5d3ca2f
-  data.tar.gz: 90b47aa245e497c7d652fc1b2885af98438b69b704b8f7cb229b9960492426e2
+  metadata.gz: 6c352a48f1552b0934b7bdd88e8783b8c598b727353559ca6ca30a27877833a6
+  data.tar.gz: aaba187980a1326a859de794faca1e7e836c5385a32f7d12ea3c9c13a7d5a9ec
 SHA512:
-  metadata.gz: f2bfe2f375887428b7f29dd888bce619900f0ff8f0c3d51d37fe7771a5282492ad54f584022ac28d4a2e7901c015cb9968c00b15d611b0915302027a27cc1e96
-  data.tar.gz: 3c5ef5415b155090e5c763d5c9087b8b1f2e7db181d558aba488bdcb35a548113d221a6330245999c3e6ea1d2665ef675e84d9efc9924158bd044ecaf1f659f6
+  metadata.gz: d06232b4511622aa14a0d8169b338d6f12eb320d38c2c16e0796a6b476c3fc2a9fe54b779fc4f43d886b37978864e24f787c6c6c0c4453a37838f5d0545785d2
+  data.tar.gz: f7247d52a2e02f6fca017f3b44f2aee212f63ddb3fd868862deb4b005e703bcf412cd74777b3ec1e94145eec476ff70bef7443e9e9426f4dd6f0d12a5d6beeef

data/README.md

@@ -110,6 +110,30 @@ Then at the PSQL command line:
 
 `template1=# CREATE EXTENSION IF NOT EXISTS "uuid-ossp";`
 
+## Releasing
+
+1. Read the CHANGELOG.md and decide on the new semantic version number
+1. Create a release branch, eg. `release-96.0.3`
+1. Update the CHANGELOG.md
+    - Declare a new version number
+    - Move all unreleased changes beneath it
+1. Update `lib/gds_api/version.rb` to match, eg
+
+    ```ruby
+      module GdsApi
+        VERSION = "96.0.3".freeze
+      end
+    ```
+
+1. Copy the lines from the CHANGELOG.md into the git commit
+1. Propose and merge the pull request into `main`
+
+Nb:
+
+- You do not need to set any git tags
+- After merging, CI will release the new version of the gem and Dependabot will
+  propose the new version of the gem to help distribute the changes to consumers
+
 ## Licence
 
 Released under the MIT Licence, a copy of which can be found in the file

data/lib/gds_api/content_store.rb

@@ -53,7 +53,7 @@ private
               "#{Plek.new.website_root}#{destination_uri}"
             end
 
-      [url, status_code(redirect)]
+      [url, 301]
     end
 
     private_class_method :new
@@ -105,10 +105,6 @@ private
 
       uri.to_s
     end
-
-    def status_code(redirect)
-      redirect["redirect_type"] == "temporary" ? 302 : 301
-    end
   end
 
   class UnresolvedRedirect < GdsApi::BaseError; end

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

@@ -33,7 +33,7 @@ class GdsApi::Router < GdsApi::Base
     )
   end
 
-  def add_redirect_route(path, type, destination, redirect_type = "permanent", options = {})
+  def add_redirect_route(path, type, destination, options = {})
     put_json(
       "#{endpoint}/routes",
       route: {
@@ -41,7 +41,6 @@ class GdsApi::Router < GdsApi::Base
         route_type: type,
         handler: "redirect",
         redirect_to: destination,
-        redirect_type:,
         segments_mode: options[:segments_mode],
       },
     )

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/test_helpers/router.rb

@@ -21,8 +21,8 @@ module GdsApi
         stub_router_has_route(path, handler: "backend", backend_id:, disabled:, route_type:)
       end
 
-      def stub_router_has_redirect_route(path, redirect_to:, redirect_type: "permanent", route_type: "exact", disabled: false)
-        stub_router_has_route(path, handler: "redirect", redirect_to:, redirect_type:, disabled:, route_type:)
+      def stub_router_has_redirect_route(path, redirect_to:, route_type: "exact", disabled: false)
+        stub_router_has_route(path, handler: "redirect", redirect_to:, disabled:, route_type:)
       end
 
       def stub_router_has_gone_route(path, route_type: "exact", disabled: false)
@@ -52,14 +52,13 @@ module GdsApi
         })
       end
 
-      def stub_redirect_registration(path, type, destination, redirect_type, segments_mode = nil)
+      def stub_redirect_registration(path, type, destination, segments_mode = nil)
         stub_route_put({
           route: {
             incoming_path: path,
             route_type: type,
             handler: "redirect",
             redirect_to: destination,
-            redirect_type:,
             segments_mode:,
           },
         })

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "96.0.2".freeze
+  VERSION = "97.0.0".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: 97.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-25 00:00:00.000000000 Z
+date: 2024-10-17 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.22
 signing_key: 
 specification_version: 4
 summary: Adapters to work with GDS APIs