gds-api-adapters 80.0.1 → 81.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d176cb409b66bc4df5c376c244660cd23fe992e70fa982b3d3403638a97855e4
-  data.tar.gz: 507564fc5d9cde9f3bcb9d20ef056a273dd1ff6f7f79a7e4631141cd46ed92bb
+  metadata.gz: a24005bab2921edb7aa53883b108f6e41d924fad73427f83a36e8533e7812d04
+  data.tar.gz: f31d0c3901757454cc2cb2bc9a25f37bf75478d49f1897df0f49d7b9618d0100
 SHA512:
-  metadata.gz: 18f2478cee5688ec61a3c55b4f010b6bc1dd663929b8313b17affbc4056f78825e008a448242c30668a4acd0cd6fbbc118df4eb691bfa913f5aba76461cbe017
-  data.tar.gz: 3ecfd09796febbb411404015894024df599b2edb733a0658d730057f5c90e9a60926fa1bfd73a9c258db0a6e24282c41e9d548ba7a04b161f1d39550f827b10b
+  metadata.gz: dab28218b95c40c9220630b17aef48d0a97d9c6d20a436a2006114e23269cf3932f152becd2735f539a812cfa698b39b54da9ba707ccb475014164a12a16f6e7
+  data.tar.gz: 5df20ac4342d9ba55ef43c8e83731d78f24205a96c48f05803d84cc8ea7d04c33886c67547d5f8dd06804f4c55665f3192cb30be367063d9af77c851c2898e54

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

@@ -595,6 +595,12 @@ module GdsApi
         url = "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists"
         query ? "#{url}?#{query}" : url
       end
+
+      # Find and return the subscriber list for a topic if one exists.
+      def email_alert_api_has_subscriber_list_for_topic(content_id:, list: {})
+        url = "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists?links%5Btopics%5D%5B0%5D=#{content_id}"
+        stub_request(:get, url).to_return(status: 200, body: { "subscriber_list" => list }.to_json)
+      end
     end
   end
 end

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,43 +65,48 @@ 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, country_name: "England", local_custodian_code: nil)
         response = {
           "local_authorities" => [
             {
               "name" => authority_slug.capitalize,
               "homepage_url" => "http://#{authority_slug}.example.com",
-              "country_name" => "England",
+              "country_name" => country_name,
               "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,20 +159,33 @@ 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_has_a_local_authority_without_homepage(authority_slug)
+      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, country_name: "England", local_custodian_code: nil)
         response = {
           "local_authorities" => [
             {
               "name" => authority_slug.capitalize,
               "homepage_url" => "",
-              "country_name" => "England",
+              "country_name" => country_name,
               "tier" => "unitary",
+              "slug" => authority_slug,
             },
           ],
         }
@@ -147,6 +193,12 @@ 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
     end
   end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "80.0.1".freeze
+  VERSION = "81.0.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 80.0.1
+  version: 81.0.2
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-29 00:00:00.000000000 Z
+date: 2022-07-26 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