gds-api-adapters 67.2.1 → 69.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f4e9476c570389a75e06b65715133d92402d748e4b15fd0b30782a7eca32847
-  data.tar.gz: e1e5d3284178b1f22f29dc63d1cf0fde389c82224f56146d6db40304fa211ca0
+  metadata.gz: 30536128d763109b2965438ade68ca08a7bc60782f3ad29f4f874ee051d687ef
+  data.tar.gz: 18db0bcda095594ec145e1ab54a6d80b68aa62df2d4348789931b2298d80b9ed
 SHA512:
-  metadata.gz: 392d0964f21b56895aab0fb54a0a566b4c7186f69dbbefa85a31001a255d6cd3a296e982c72df36cc538f93c7beda156430945b86c626a66a50aa35cef29f7b3
-  data.tar.gz: 9a41486139d341afcd11559b40407c6bf58836e4aad2f15dce2380297da40e9edb2ef29176410708d067ed692672c54de5cee1b4e455176d4b455682398f30eb
+  metadata.gz: f488b6b0512fd5a2ae41bad2116c225b2f39446f3d01fe4e493a1d4f0e4673176561dc0a1a79a68f349fc68f92c3b4d14e3cf8a506ffd81a014f22e3a6ad5480
+  data.tar.gz: 8cb30f4f8c075c4674a792a9647112268be2a52a77c14c7d20c2ee65f5f2fbcf082e4c6211a6603984426e887a240b0910d4d894575a0f267ba156600e1ed2b5

data/lib/gds_api/email_alert_api.rb

@@ -10,46 +10,20 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   #
   # @param attributes [Hash] document_type, links, tags used to search existing subscriber lists
   def find_or_create_subscriber_list(attributes)
-    find_subscriber_list(attributes)
-  rescue GdsApi::HTTPNotFound
-    create_subscriber_list(attributes)
-  end
-
-  # Get a subscriber list
-  #
-  # @param attributes [Hash] document_type, links, tags used to search existing subscriber lists
-  def find_subscriber_list(attributes)
-    tags = attributes["tags"]
-    links = attributes["links"]
-    document_type = attributes["document_type"]
-    email_document_supertype = attributes["email_document_supertype"]
-    government_document_supertype = attributes["government_document_supertype"]
-    gov_delivery_id = attributes["gov_delivery_id"]
-    combine_mode = attributes["combine_mode"]
-
-    if tags && links
+    if attributes["tags"] && attributes["links"]
       message = "please provide either tags or links (or neither), but not both"
       raise ArgumentError, message
     end
 
-    params = {}
-    params[:tags] = tags if tags
-    params[:links] = links if links
-    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
-    params[:gov_delivery_id] = gov_delivery_id if gov_delivery_id
-    params[:combine_mode] = combine_mode if combine_mode
-
-    query_string = nested_query_string(params)
-    get_json("#{endpoint}/subscriber-lists?" + query_string)
+    post_json("#{endpoint}/subscriber-lists", attributes)
   end
 
-  # Post a subscriber list
+  # Get a subscriber list
   #
   # @param attributes [Hash] document_type, links, tags used to search existing subscriber lists
-  def create_subscriber_list(attributes)
-    post_json("#{endpoint}/subscriber-lists", attributes)
+  def find_subscriber_list(attributes)
+    query_string = nested_query_string(attributes)
+    get_json("#{endpoint}/subscriber-lists?" + query_string)
   end
 
   # Post a content change
@@ -66,13 +40,6 @@ class GdsApi::EmailAlertApi < GdsApi::Base
     post_json("#{endpoint}/messages", message, headers)
   end
 
-  # Send email
-  #
-  # @param email_params [Hash] address, subject, body
-  def create_email(email_params)
-    post_json("#{endpoint}/emails", email_params)
-  end
-
   # Unpublishing alert
   #
   # @param message [Hash] content_id
@@ -131,7 +98,6 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   # @return [Hash] subscriber_list: {
   #  id
   #  title
-  #  gov_delivery_id
   #  created_at
   #  updated_at
   #  document_type

data/lib/gds_api/exceptions.rb

@@ -40,6 +40,7 @@ module GdsApi
   class HTTPForbidden < HTTPClientError; end
   class HTTPConflict < HTTPClientError; end
   class HTTPUnprocessableEntity < HTTPClientError; end
+  class HTTPBadRequest < HTTPClientError; end
   class HTTPTooManyRequests < HTTPIntermittentClientError; end
 
   # Superclass & fallback for all 5XX errors
@@ -60,6 +61,8 @@ module GdsApi
 
     def error_class_for_code(code)
       case code
+      when 400
+        GdsApi::HTTPBadRequest
       when 401
         GdsApi::HTTPUnauthorized
       when 403

data/lib/gds_api/mapit.rb

@@ -37,6 +37,10 @@ class GdsApi::Mapit < GdsApi::Base
     def postcode
       @response["postcode"]
     end
+
+    def country_name
+      @response["country_name"]
+    end
   end
 
 private

data/lib/gds_api/test_helpers/email_alert_api.rb

@@ -124,6 +124,14 @@ module GdsApi
         matching.last
       end
 
+      def stub_email_alert_api_creates_subscriber_list(attributes)
+        stub_request(:post, build_subscriber_lists_url)
+          .to_return(
+            status: 201,
+            body: get_subscriber_list_response(attributes).to_json,
+          )
+      end
+
       def stub_email_alert_api_has_subscriber_list(attributes)
         stub_request(:get, build_subscriber_lists_url(attributes))
           .to_return(
@@ -137,14 +145,6 @@ module GdsApi
           .to_return(status: 404)
       end
 
-      def stub_email_alert_api_creates_subscriber_list(attributes)
-        stub_request(:post, build_subscriber_lists_url)
-          .to_return(
-            status: 201,
-            body: get_subscriber_list_response(attributes).to_json,
-          )
-      end
-
       def stub_email_alert_api_refuses_to_create_subscriber_list
         stub_request(:post, build_subscriber_lists_url)
           .to_return(status: 422)
@@ -218,27 +218,31 @@ module GdsApi
           .to_return(status: 404)
       end
 
-      def stub_email_alert_api_creates_a_subscription(subscriber_list_id, address, frequency, returned_subscription_id, skip_confirmation_email: false)
-        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions")
-          .with(
-            body: {
-              subscriber_list_id: subscriber_list_id,
-              address: address,
-              frequency: frequency,
-              skip_confirmation_email: skip_confirmation_email,
-            }.to_json,
-          ).to_return(status: 201, body: { id: returned_subscription_id }.to_json)
-      end
+      def stub_email_alert_api_creates_a_subscription(
+        subscriber_list_id: nil,
+        address: nil,
+        frequency: nil,
+        returned_subscription_id: nil,
+        skip_confirmation_email: false,
+        subscriber_id: nil
+      )
+        response = get_subscription_response(
+          returned_subscription_id,
+          frequency: frequency,
+          subscriber_list_id: subscriber_list_id,
+          subscriber_id: subscriber_id,
+        )
+
+        request_params = {
+          subscriber_list_id: subscriber_list_id,
+          address: address,
+          frequency: frequency,
+          skip_confirmation_email: skip_confirmation_email,
+        }
 
-      def stub_email_alert_api_creates_an_existing_subscription(subscriber_list_id, address, frequency, returned_subscription_id)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions")
-          .with(
-            body: hash_including(
-              subscriber_list_id: subscriber_list_id,
-              address: address,
-              frequency: frequency,
-            ),
-          ).to_return(status: 200, body: { id: returned_subscription_id }.to_json)
+          .with(body: hash_including(request_params.compact))
+          .to_return(status: 200, body: response.to_json)
       end
 
       def stub_email_alert_api_refuses_to_create_subscription(subscriber_list_id, address, frequency)
@@ -394,7 +398,6 @@ module GdsApi
           document_type = attributes["document_type"]
           email_document_supertype = attributes["email_document_supertype"]
           government_document_supertype = attributes["government_document_supertype"]
-          gov_delivery_id = attributes["gov_delivery_id"]
           content_purpose_supergroup = attributes["content_purpose_supergroup"]
           combine_mode = attributes["combine_mode"]
 
@@ -404,7 +407,6 @@ module GdsApi
           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
-          params[:gov_delivery_id] = gov_delivery_id if gov_delivery_id
           params[:content_purpose_supergroup] = content_purpose_supergroup if content_purpose_supergroup
           params[:combine_mode] = combine_mode if combine_mode
 

data/lib/gds_api/test_helpers/local_links_manager.rb

@@ -5,13 +5,14 @@ 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:)
+      def stub_local_links_manager_has_a_link(authority_slug:, lgsl:, lgil:, url:, country_name: "England")
         response = {
           "local_authority" => {
             "name" => authority_slug.capitalize,
             "snac" => "00AG",
             "tier" => "unitary",
             "homepage_url" => "http://#{authority_slug}.example.com",
+            "country_name" => country_name,
           },
           "local_interaction" => {
             "lgsl_code" => lgsl,
@@ -25,13 +26,14 @@ module GdsApi
           .to_return(body: response.to_json, status: 200)
       end
 
-      def stub_local_links_manager_has_no_link(authority_slug:, lgsl:, lgil:)
+      def stub_local_links_manager_has_no_link(authority_slug:, lgsl:, lgil:, country_name: "England")
         response = {
           "local_authority" => {
             "name" => authority_slug.capitalize,
             "snac" => "00AG",
             "tier" => "unitary",
             "homepage_url" => "http://#{authority_slug}.example.com",
+            "country_name" => country_name,
           },
         }
 
@@ -40,13 +42,14 @@ module GdsApi
           .to_return(body: response.to_json, status: 200)
       end
 
-      def stub_local_links_manager_has_no_link_and_no_homepage_url(authority_slug:, lgsl:, lgil:)
+      def stub_local_links_manager_has_no_link_and_no_homepage_url(authority_slug:, lgsl:, lgil:, country_name: "England")
         response = {
           "local_authority" => {
             "name" => authority_slug.capitalize,
             "snac" => "00AG",
             "tier" => "unitary",
             "homepage_url" => nil,
+            "country_name" => country_name,
           },
         }
 
@@ -82,6 +85,7 @@ module GdsApi
             {
               "name" => authority_slug.capitalize,
               "homepage_url" => "http://#{authority_slug}.example.com",
+              "country_name" => "England",
               "tier" => "unitary",
             },
           ],
@@ -98,11 +102,13 @@ module GdsApi
             {
               "name" => district_slug.capitalize,
               "homepage_url" => "http://#{district_slug}.example.com",
+              "country_name" => "England",
               "tier" => "district",
             },
             {
               "name" => county_slug.capitalize,
               "homepage_url" => "http://#{county_slug}.example.com",
+              "country_name" => "England",
               "tier" => "county",
             },
           ],
@@ -131,6 +137,7 @@ module GdsApi
             {
               "name" => authority_slug.capitalize,
               "homepage_url" => "",
+              "country_name" => "England",
               "tier" => "unitary",
             },
           ],

data/lib/gds_api/test_helpers/mapit.rb

@@ -43,6 +43,20 @@ module GdsApi
           .to_return(body: response.to_json, status: 200)
       end
 
+      def stub_mapit_has_a_postcode_and_country_name(postcode, coords, country_name)
+        response = {
+          "wgs84_lat" => coords.first,
+          "wgs84_lon" => coords.last,
+          "postcode" => postcode,
+          "country_name" => country_name,
+        }
+
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.tr(" ", "+") + ".json")
+          .to_return(body: response.to_json, status: 200)
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/partial/" + postcode.split(" ").first + ".json")
+          .to_return(body: response.to_json, status: 200)
+      end
+
       def stub_mapit_does_not_have_a_postcode(postcode)
         stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.tr(" ", "+") + ".json")
           .to_return(body: { "code" => 404, "error" => "No Postcode matches the given query." }.to_json, status: 404)

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "67.2.1".freeze
+  VERSION = "69.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 67.2.1
+  version: 69.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-10 00:00:00.000000000 Z
+date: 2021-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable