gds-api-adapters 78.0.0 → 79.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a423ee043ccb33b30d2d1a0f12b0a5f43d14018b774afa6270f24626062f696
-  data.tar.gz: e18aa2ed41343e430781063d9a8e85584213781758a245f8c818849c9d51e30d
+  metadata.gz: be2d6d94c4da753ae82eabe4728e9e21d385c8d7332baa5682eed54ee4d41d37
+  data.tar.gz: c0435733dd835d528ae596002542aa426030b494bcb7c839ba80b8020322e089
 SHA512:
-  metadata.gz: 2113447106f41212696c5daf6e048c1bf0df7feac8b524d63a437f8113d8cb4cf9e2a9910e898c55a6501d7495548ff131142a4cdccf3e4287b327be54320a4d
-  data.tar.gz: 74a1d841906f75f5f9f045f8157e8bf40ace3a4e12e6b30226d07e3e1959267d4b66821e72e2d0812cb1ee951b1a99724e71b60bbf8e057bd8aea7ee60622153
+  metadata.gz: f731412f3b2172d700bae052a934b30051213c28dd8b6217154196193b5c6c246efeac1b682b199cce2f8f1d38974c7864fb3aca682219492da8ccf92f41b2b0
+  data.tar.gz: 4e61e4360f445fa5c37e364303893874eedc3004e8e53d6dc0df3ffffbb08e1f0316882860bf9c389bdc12a425cbd2e93aa6ef7823aaa8ed300ae60dc28446f8

data/lib/gds_api/email_alert_api.rb

@@ -251,15 +251,30 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   # optionally send a notification email explaining the reason
   #
   # @param [string]               slug                  Identifier for the subscription list
-  # @param [string] (optional)    body                  Optional email body to send to alert users they are being unsubscribed
-  # @param [string] (optional)    sender_message_id     A UUID to prevent multiple emails for the same event
-  def bulk_unsubscribe(slug:, body: nil, sender_message_id: nil)
+  # @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)    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)
     post_json(
       "#{endpoint}/subscriber-lists/#{slug}/bulk-unsubscribe",
       {
         body: body,
         sender_message_id: sender_message_id,
       }.compact,
+      {
+        "Govuk-Request-Id" => govuk_request_id,
+      }.compact,
+    )
+  end
+
+  # Update subscriber list details, such as title
+  # @param [Hash]         params        A hash of detail paramaters that can be updated. For example title.
+  #                                     For allowed parameters see:
+  #                                     https://github.com/alphagov/email-alert-api/blob/main/docs/api.md#patch-subscriber-listsxxx
+  def update_subscriber_list_details(slug:, params: {})
+    patch_json(
+      "#{endpoint}/subscriber-lists/#{slug}",
+      params,
     )
   end
 

data/lib/gds_api/locations_api.rb

@@ -0,0 +1,28 @@
+require_relative "base"
+require_relative "exceptions"
+
+class GdsApi::LocationsApi < GdsApi::Base
+  # Get a list of local custodian codes for a postcode
+  #
+  # @param [String, nil] postcode The postcode for which the custodian codes are requested
+  #
+  # @return [Array] All local custodian codes for a specific postcode
+  def local_custodian_code_for_postcode(postcode)
+    response = get_json("#{endpoint}/locations?postcode=#{postcode}.json")
+
+    return [] if response["results"].nil?
+
+    response["results"].map { |r| r["local_custodian_code"] }.uniq
+  end
+
+  # Get the average coordinates for a postcode
+  #
+  # @param [String, nil] postcode The postcode for which the coordinates are requested
+  #
+  # @return [Hash] The average coordinates (two fields, "latitude" and "longitude") for a specific postcode
+  def coordinates_for_postcode(postcode)
+    response = get_json("#{endpoint}/locations?postcode=#{postcode}.json")
+
+    { "latitude" => response["average_latitude"], "longitude" => response["average_longitude"] } unless response["results"].nil?
+  end
+end

data/lib/gds_api/test_helpers/email_alert_api.rb

@@ -413,13 +413,14 @@ module GdsApi
           .to_return(status: 202)
       end
 
-      def stub_email_alert_api_bulk_unsubscribe_with_message(slug:, body:, sender_message_id:)
+      def stub_email_alert_api_bulk_unsubscribe_with_message(slug:, govuk_request_id:, body:, sender_message_id:)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}/bulk-unsubscribe")
         .with(
           body: {
             body: body,
             sender_message_id: sender_message_id,
           }.to_json,
+          headers: { "Govuk-Request-Id" => govuk_request_id },
         ).to_return(status: 202)
       end
 
@@ -428,33 +429,70 @@ module GdsApi
           .to_return(status: 404)
       end
 
-      def stub_email_alert_api_bulk_unsubscribe_not_found_with_message(slug:, body:, sender_message_id:)
+      def stub_email_alert_api_bulk_unsubscribe_not_found_with_message(slug:, govuk_request_id:, body:, sender_message_id:)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}/bulk-unsubscribe")
         .with(
           body: {
             body: body,
             sender_message_id: sender_message_id,
           }.to_json,
+          headers: { "Govuk-Request-Id" => govuk_request_id },
         ).to_return(status: 404)
       end
 
-      def stub_email_alert_api_bulk_unsubscribe_conflict_with_message(slug:, body:, sender_message_id:)
+      def stub_email_alert_api_bulk_unsubscribe_conflict(slug:)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}/bulk-unsubscribe")
+          .to_return(status: 409)
+      end
+
+      def stub_email_alert_api_bulk_unsubscribe_conflict_with_message(slug:, govuk_request_id:, body:, sender_message_id:)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}/bulk-unsubscribe")
         .with(
           body: {
             body: body,
             sender_message_id: sender_message_id,
           }.to_json,
+          headers: { "Govuk-Request-Id" => govuk_request_id },
         ).to_return(status: 409)
       end
 
-      def stub_email_alert_api_bulk_unsubscribe_bad_request(slug:, body:)
+      def stub_email_alert_api_bulk_unsubscribe_bad_request(slug:)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}/bulk-unsubscribe")
+          .to_return(status: 422)
+      end
+
+      def stub_email_alert_api_bulk_unsubscribe_bad_request_with_message(slug:, govuk_request_id:, body:, sender_message_id:)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}/bulk-unsubscribe")
         .with(
-          body: { body: body }.to_json,
+          body: {
+            body: body,
+            sender_message_id: sender_message_id,
+          }.to_json,
+          headers: { "Govuk-Request-Id" => govuk_request_id },
         ).to_return(status: 422)
       end
 
+      def stub_update_subscriber_list_details(slug:, params:)
+        stub_request(:patch, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}")
+        .with(body: params.to_json)
+        .to_return(
+          status: 200,
+          body: get_subscriber_list_response(params).to_json,
+        )
+      end
+
+      def stub_update_subscriber_list_details_not_found(slug:, params:)
+        stub_request(:patch, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}")
+        .with(body: params.to_json)
+        .to_return(status: 404)
+      end
+
+      def stub_update_subscriber_list_details_unprocessible_entity(slug:, params: {})
+        stub_request(:patch, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}")
+        .with(body: params.to_json)
+        .to_return(status: 422)
+      end
+
     private
 
       def get_subscriber_response(id, address, govuk_account_id)
@@ -534,6 +572,7 @@ module GdsApi
         if attributes
           tags = attributes["tags"]
           links = attributes["links"]
+          content_id = attributes["content_id"]
           document_type = attributes["document_type"]
           email_document_supertype = attributes["email_document_supertype"]
           government_document_supertype = attributes["government_document_supertype"]
@@ -543,6 +582,7 @@ module GdsApi
           params = {}
           params[:tags] = tags if tags
           params[:links] = links if links
+          params[:content_id] = content_id if content_id
           params[:document_type] = document_type if document_type
           params[:email_document_supertype] = email_document_supertype if email_document_supertype
           params[:government_document_supertype] = government_document_supertype if government_document_supertype

data/lib/gds_api/test_helpers/locations_api.rb

@@ -0,0 +1,38 @@
+module GdsApi
+  module TestHelpers
+    module LocationsApi
+      LOCATIONS_API_ENDPOINT = Plek.current.find("locations-api")
+
+      def stub_locations_api_has_location(postcode, locations)
+        results = []
+        locations.each do |l|
+          results << {
+            "latitude" => l["latitude"],
+            "longitude" => l["longitude"],
+            "postcode" => postcode,
+            "local_custodian_code" => l["local_custodian_code"],
+          }
+        end
+
+        response = {
+          "average_latitude" => results.sum { |r| r["latitude"] } / results.size.to_f,
+          "average_longitude" => results.sum { |r| r["longitude"] } / results.size.to_f,
+          "results" => results,
+        }
+
+        stub_request(:get, "#{LOCATIONS_API_ENDPOINT}/locations?postcode=#{postcode}.json")
+          .to_return(body: response.to_json, status: 200)
+      end
+
+      def stub_locations_api_has_no_location(postcode)
+        stub_request(:get, "#{LOCATIONS_API_ENDPOINT}/locations?postcode=#{postcode}.json")
+          .to_return(body: { "results" => nil }.to_json, status: 200)
+      end
+
+      def stub_locations_api_does_not_have_a_bad_postcode(postcode)
+        stub_request(:get, "#{LOCATIONS_API_ENDPOINT}/locations?postcode=#{postcode}.json")
+         .to_return(body: { "code" => 400, "error" => "Postcode '#{postcode}' is not valid." }.to_json, status: 400)
+      end
+    end
+  end
+end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "78.0.0".freeze
+  VERSION = "79.1.0".freeze
 end

data/lib/gds_api.rb

@@ -10,6 +10,7 @@ require "gds_api/imminence"
 require "gds_api/licence_application"
 require "gds_api/link_checker_api"
 require "gds_api/local_links_manager"
+require "gds_api/locations_api"
 require "gds_api/mapit"
 require "gds_api/maslow"
 require "gds_api/organisations"
@@ -201,4 +202,11 @@ module GdsApi
   def self.worldwide(options = {})
     GdsApi::Worldwide.new(Plek.new.website_root, options)
   end
+
+  # Creates a GdsApi::LocationsApi adapter
+  #
+  # @return [GdsApi::LocationsApi]
+  def self.locations_api(options = {})
+    GdsApi::LocationsApi.new(Plek.find("locations-api"), options)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 78.0.0
+  version: 79.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-18 00:00:00.000000000 Z
+date: 2022-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -385,6 +385,7 @@ files:
 - lib/gds_api/link_checker_api.rb
 - lib/gds_api/list_response.rb
 - lib/gds_api/local_links_manager.rb
+- lib/gds_api/locations_api.rb
 - lib/gds_api/mapit.rb
 - lib/gds_api/maslow.rb
 - lib/gds_api/middleware/govuk_header_sniffer.rb
@@ -409,6 +410,7 @@ files:
 - lib/gds_api/test_helpers/licence_application.rb
 - lib/gds_api/test_helpers/link_checker_api.rb
 - lib/gds_api/test_helpers/local_links_manager.rb
+- lib/gds_api/test_helpers/locations_api.rb
 - lib/gds_api/test_helpers/mapit.rb
 - lib/gds_api/test_helpers/organisations.rb
 - lib/gds_api/test_helpers/publishing_api.rb