gds-api-adapters 79.2.0 → 81.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 314781375647d75f9d65da9f5cdc7eaeadefb909c9e300645f50add8a66fac77
-  data.tar.gz: b8c6e5a17e7c0dc2d549cc0330655fbc9e03471cbbd4a217afc508977d9a531a
+  metadata.gz: b05bc427e1871e4a8b4d0abbd4a0f33bede6a2e2abd1dc9538d734d19bcd7715
+  data.tar.gz: 3a824dc05509ad151471dcec3e5d536b4036af83d64ce93d614b6a6ff22deda7
 SHA512:
-  metadata.gz: 595735b215edde32f93d78ce0137e1dc9e34a87e8da3a3e9c92536c54149b39f1cfa879d872bd209ee1851e45f4ae8052bf5e83e603a96976fd1f0fc73de944c
-  data.tar.gz: cfedf9155d36cc2e55068722b5a01d54469f4ce8177d3147a51a308e25eb820e552d57b64cb312dab120b7ed32b29ff793ef5a3f498dde5d74d2a95a19b4435b
+  metadata.gz: a289fa007a4da3cb78bb31f8647aa43bf3e49fd43c1a2bb6e63f00fd60b03448b1fbf4e5ee7e1881cce8bbc9011db5d75478dc0c6833d42813aa7a010e60f52d
+  data.tar.gz: d1680c586b6443e1a1a95d4ea1195664de2f9ca971d8d3b764d5767813b41cd82f91704ff6c4d63a4a71de2a2ff13292d5ba09ea0d3954f6c3061576b1714451

data/README.md

@@ -82,6 +82,34 @@ There are also test helpers for stubbing various requests in other apps.
 
 See [all the test helpers in lib/gds_api/test_helpers](/lib/gds_api/test_helpers).
 
+
+## Pact Verification During CI
+
+During the CI test suite, Jenkins downloads and runs the pact:verify tasks for
+each provider app. It's run directly on the Jenkins machine rather than in
+docker containers for each app. For this reason the email-alert-api app
+requires a specific setup on the CI machine - on db creation it copies the
+database from the template1 db (this is the usual PG behaviour, but for some
+reason rails needs to be told to do this explicitly). This template1 db has
+to have the uuid-ossp extension installed by superuser, because the jenkins
+user that CI runs under cannot create this extension. If this test stops
+working with errors like:
+
+```
+Caused by:
+PG::InsufficientPrivilege: ERROR:  permission denied to create extension "uuid-ossp"
+HINT:  Must be superuser to create this extension.
+```
+
+...the template may have been deleted or changed. Log in to the relevant CI
+agent and run:
+
+`> sudo -u postgres psql -d template1`
+
+Then at the PSQL command line:
+
+`template1=# CREATE EXTENSION IF NOT EXISTS "uuid-ossp";`
+
 ## Licence
 
 Released under the MIT Licence, a copy of which can be found in the file

data/lib/gds_api/email_alert_api.rb

@@ -252,7 +252,7 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   # optionally send a notification email explaining the reason
   #
   # @param [string]               slug                  Identifier for the subscription list
-  # @param [string] (optional)    govuk_request_id      An ID allowing us to trace requests across our infra. Required if you want to send an email.
+  # @param [string] (optional)    govuk_request_id      An ID allowing us to trace requests across our infra. Required if you want to send an email by running out-of-band processes via asynchronous workers.
   # @param [string] (optional)    body                  Optional email body to send to alert users they are being unsubscribed. Required if you want to send an email
   # @param [string] (optional)    sender_message_id     A UUID to prevent multiple emails for the same event. Required if you want to send an email.
   def bulk_unsubscribe(slug:, govuk_request_id: nil, body: nil, sender_message_id: nil)

data/lib/gds_api/local_links_manager.rb

@@ -6,8 +6,18 @@ class GdsApi::LocalLinksManager < GdsApi::Base
     get_json(url)
   end
 
+  def local_link_by_custodian_code(local_custodian_code, lgsl, lgil)
+    url = "#{endpoint}/api/link?local_custodian_code=#{local_custodian_code}&lgsl=#{lgsl}&lgil=#{lgil}"
+    get_json(url)
+  end
+
   def local_authority(authority_slug)
     url = "#{endpoint}/api/local-authority?authority_slug=#{authority_slug}"
     get_json(url)
   end
+
+  def local_authority_by_custodian_code(local_custodian_code)
+    url = "#{endpoint}/api/local-authority?local_custodian_code=#{local_custodian_code}"
+    get_json(url)
+  end
 end

data/lib/gds_api/publishing_api.rb

@@ -150,23 +150,6 @@ class GdsApi::PublishingApi < GdsApi::Base
     post_json(republish_url(content_id), params)
   end
 
-  # Import content into the publishing API
-  #
-  # The publishing-api will delete any content which has the content
-  # id provided, and then import the data given.
-  #
-  # @param content_id [UUID]
-  # @param content_items [Array]
-  #
-  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#post-v2contentcontent_idimport
-  def import(content_id, locale, content_items)
-    params = {
-      history: content_items,
-    }
-
-    post_json("#{endpoint}/v2/content/#{content_id}/import?locale=#{locale}", params)
-  end
-
   # Unpublish a content item
   #
   # The publishing API will "unpublish" a live item, to remove it from the public

data/lib/gds_api/test_helpers/email_alert_api.rb

@@ -413,15 +413,15 @@ module GdsApi
           .to_return(status: 202)
       end
 
-      def stub_email_alert_api_bulk_unsubscribe_with_message(slug:, govuk_request_id:, body:, sender_message_id:)
+      def stub_email_alert_api_bulk_unsubscribe_with_message(slug:, body:, sender_message_id:, govuk_request_id: nil)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}/bulk-unsubscribe")
-        .with(
+        .with({
           body: {
             body: body,
             sender_message_id: sender_message_id,
           }.to_json,
-          headers: { "Govuk-Request-Id" => govuk_request_id },
-        ).to_return(status: 202)
+        }.tap { |attr| attr[:headers] = { "Govuk-Request-Id" => govuk_request_id } if govuk_request_id })
+        .to_return(status: 202)
       end
 
       def stub_email_alert_api_bulk_unsubscribe_not_found(slug:)
@@ -429,15 +429,15 @@ module GdsApi
           .to_return(status: 404)
       end
 
-      def stub_email_alert_api_bulk_unsubscribe_not_found_with_message(slug:, govuk_request_id:, body:, sender_message_id:)
+      def stub_email_alert_api_bulk_unsubscribe_not_found_with_message(slug:, body:, sender_message_id:, govuk_request_id: nil)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}/bulk-unsubscribe")
-        .with(
+        .with({
           body: {
             body: body,
             sender_message_id: sender_message_id,
           }.to_json,
-          headers: { "Govuk-Request-Id" => govuk_request_id },
-        ).to_return(status: 404)
+        }.tap { |attr| attr[:headers] = { "Govuk-Request-Id" => govuk_request_id } if govuk_request_id })
+        .to_return(status: 404)
       end
 
       def stub_email_alert_api_bulk_unsubscribe_conflict(slug:)
@@ -445,15 +445,15 @@ module GdsApi
           .to_return(status: 409)
       end
 
-      def stub_email_alert_api_bulk_unsubscribe_conflict_with_message(slug:, govuk_request_id:, body:, sender_message_id:)
+      def stub_email_alert_api_bulk_unsubscribe_conflict_with_message(slug:, body:, sender_message_id:, govuk_request_id: nil)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}/bulk-unsubscribe")
-        .with(
+        .with({
           body: {
             body: body,
             sender_message_id: sender_message_id,
           }.to_json,
-          headers: { "Govuk-Request-Id" => govuk_request_id },
-        ).to_return(status: 409)
+        }.tap { |attr| attr[:headers] = { "Govuk-Request-Id" => govuk_request_id } if govuk_request_id })
+        .to_return(status: 409)
       end
 
       def stub_email_alert_api_bulk_unsubscribe_bad_request(slug:)
@@ -461,15 +461,15 @@ module GdsApi
           .to_return(status: 422)
       end
 
-      def stub_email_alert_api_bulk_unsubscribe_bad_request_with_message(slug:, govuk_request_id:, body:, sender_message_id:)
+      def stub_email_alert_api_bulk_unsubscribe_bad_request_with_message(slug:, body:, sender_message_id:, govuk_request_id: nil)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}/bulk-unsubscribe")
-        .with(
+        .with({
           body: {
             body: body,
             sender_message_id: sender_message_id,
           }.to_json,
-          headers: { "Govuk-Request-Id" => govuk_request_id },
-        ).to_return(status: 422)
+        }.tap { |attr| attr[:headers] = { "Govuk-Request-Id" => govuk_request_id } if govuk_request_id })
+        .to_return(status: 422)
       end
 
       def stub_update_subscriber_list_details(slug:, params:)

data/lib/gds_api/test_helpers/local_links_manager.rb

@@ -5,7 +5,7 @@ module GdsApi
     module LocalLinksManager
       LOCAL_LINKS_MANAGER_ENDPOINT = Plek.current.find("local-links-manager")
 
-      def stub_local_links_manager_has_a_link(authority_slug:, lgsl:, lgil:, url:, country_name: "England", status: "ok")
+      def stub_local_links_manager_has_a_link(authority_slug:, lgsl:, lgil:, url:, country_name: "England", status: "ok", local_custodian_code: nil)
         response = {
           "local_authority" => {
             "name" => authority_slug.capitalize,
@@ -13,6 +13,7 @@ module GdsApi
             "tier" => "unitary",
             "homepage_url" => "http://#{authority_slug}.example.com",
             "country_name" => country_name,
+            "slug" => authority_slug,
           },
           "local_interaction" => {
             "lgsl_code" => lgsl,
@@ -25,9 +26,15 @@ module GdsApi
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
           .with(query: { authority_slug: authority_slug, lgsl: lgsl, lgil: lgil })
           .to_return(body: response.to_json, status: 200)
+
+        unless local_custodian_code.nil?
+          stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
+            .with(query: { local_custodian_code: local_custodian_code, lgsl: lgsl, lgil: lgil })
+            .to_return(body: response.to_json, status: 200)
+        end
       end
 
-      def stub_local_links_manager_has_no_link(authority_slug:, lgsl:, lgil:, country_name: "England")
+      def stub_local_links_manager_has_no_link(authority_slug:, lgsl:, lgil:, country_name: "England", local_custodian_code: nil)
         response = {
           "local_authority" => {
             "name" => authority_slug.capitalize,
@@ -35,15 +42,22 @@ module GdsApi
             "tier" => "unitary",
             "homepage_url" => "http://#{authority_slug}.example.com",
             "country_name" => country_name,
+            "slug" => authority_slug,
           },
         }
 
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
           .with(query: { authority_slug: authority_slug, lgsl: lgsl, lgil: lgil })
           .to_return(body: response.to_json, status: 200)
+
+        unless local_custodian_code.nil?
+          stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
+            .with(query: { local_custodian_code: local_custodian_code, lgsl: lgsl, lgil: lgil })
+            .to_return(body: response.to_json, status: 200)
+        end
       end
 
-      def stub_local_links_manager_has_no_link_and_no_homepage_url(authority_slug:, lgsl:, lgil:, country_name: "England")
+      def stub_local_links_manager_has_no_link_and_no_homepage_url(authority_slug:, lgsl:, lgil:, country_name: "England", local_custodian_code: nil)
         response = {
           "local_authority" => {
             "name" => authority_slug.capitalize,
@@ -51,36 +65,40 @@ module GdsApi
             "tier" => "unitary",
             "homepage_url" => nil,
             "country_name" => country_name,
+            "slug" => authority_slug,
           },
         }
 
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
           .with(query: { authority_slug: authority_slug, lgsl: lgsl, lgil: lgil })
           .to_return(body: response.to_json, status: 200)
-      end
 
-      def stub_local_links_manager_request_with_missing_parameters(authority_slug, lgsl, lgil)
-        # convert nil to an empty string, otherwise query param is not expressed correctly
-        params = {
-          authority_slug: authority_slug || "",
-          lgsl: lgsl || "",
-          lgil: lgil || "",
-        }
+        unless local_custodian_code.nil?
+          stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
+            .with(query: { local_custodian_code: local_custodian_code, lgsl: lgsl, lgil: lgil })
+            .to_return(body: response.to_json, status: 200)
+        end
+      end
 
+      def stub_local_links_manager_request_with_missing_parameters(**parameters)
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
-          .with(query: params)
+          .with(query: convert_to_query_string_params(parameters))
           .to_return(body: {}.to_json, status: 400)
       end
 
-      def stub_local_links_manager_does_not_have_required_objects(authority_slug, lgsl, lgil)
-        params = { authority_slug: authority_slug, lgsl: lgsl, lgil: lgil }
-
+      def stub_local_links_manager_request_with_invalid_parameters(**parameters)
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
-          .with(query: params)
+          .with(query: convert_to_query_string_params(parameters))
           .to_return(body: {}.to_json, status: 404)
       end
 
-      def stub_local_links_manager_has_a_local_authority(authority_slug)
+      def convert_to_query_string_params(parameters)
+        # convert nil to an empty string, otherwise query param is not expressed correctly
+        parameters.each { |key, _value| parameters[key] = "" if parameters[key].nil? }
+        parameters
+      end
+
+      def stub_local_links_manager_has_a_local_authority(authority_slug, local_custodian_code: nil)
         response = {
           "local_authorities" => [
             {
@@ -88,6 +106,7 @@ module GdsApi
               "homepage_url" => "http://#{authority_slug}.example.com",
               "country_name" => "England",
               "tier" => "unitary",
+              "slug" => authority_slug,
             },
           ],
         }
@@ -95,9 +114,15 @@ module GdsApi
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
           .with(query: { authority_slug: authority_slug })
           .to_return(body: response.to_json, status: 200)
+
+        unless local_custodian_code.nil?
+          stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
+            .with(query: { local_custodian_code: local_custodian_code })
+            .to_return(body: response.to_json, status: 200)
+        end
       end
 
-      def stub_local_links_manager_has_a_district_and_county_local_authority(district_slug, county_slug)
+      def stub_local_links_manager_has_a_district_and_county_local_authority(district_slug, county_slug, local_custodian_code: nil)
         response = {
           "local_authorities" => [
             {
@@ -105,12 +130,14 @@ module GdsApi
               "homepage_url" => "http://#{district_slug}.example.com",
               "country_name" => "England",
               "tier" => "district",
+              "slug" => district_slug,
             },
             {
               "name" => county_slug.capitalize,
               "homepage_url" => "http://#{county_slug}.example.com",
               "country_name" => "England",
               "tier" => "county",
+              "slug" => county_slug,
             },
           ],
         }
@@ -118,6 +145,12 @@ module GdsApi
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
           .with(query: { authority_slug: district_slug })
           .to_return(body: response.to_json, status: 200)
+
+        unless local_custodian_code.nil?
+          stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
+            .with(query: { local_custodian_code: local_custodian_code })
+            .to_return(body: response.to_json, status: 200)
+        end
       end
 
       def stub_local_links_manager_request_without_local_authority_slug
@@ -126,12 +159,24 @@ module GdsApi
           .to_return(body: {}.to_json, status: 400)
       end
 
+      def stub_local_links_manager_request_without_local_custodian_code
+        stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
+          .with(query: { local_custodian_code: "" })
+          .to_return(body: {}.to_json, status: 400)
+      end
+
       def stub_local_links_manager_does_not_have_an_authority(authority_slug)
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
           .with(query: { authority_slug: authority_slug })
           .to_return(body: {}.to_json, status: 404)
       end
 
+      def stub_local_links_manager_does_not_have_a_custodian_code(local_custodian_code)
+        stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
+          .with(query: { local_custodian_code: local_custodian_code })
+          .to_return(body: {}.to_json, status: 404)
+      end
+
       def stub_local_links_manager_has_a_local_authority_without_homepage(authority_slug)
         response = {
           "local_authorities" => [
@@ -140,6 +185,7 @@ module GdsApi
               "homepage_url" => "",
               "country_name" => "England",
               "tier" => "unitary",
+              "slug" => authority_slug,
             },
           ],
         }

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "79.2.0".freeze
+  VERSION = "81.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 79.2.0
+  version: 81.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-24 00:00:00.000000000 Z
+date: 2022-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -440,14 +440,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Adapters to work with GDS APIs