gds-api-adapters 61.1.0 → 62.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5f65962436358074fac776cc44bb46b9eb6f6468d5535cee98f3d74eb6d023f
-  data.tar.gz: d1db9044e8d30b6f9663c538c3899f6e91f89784976944a47fc1eedff628a864
+  metadata.gz: 92eba8c68e225ff418851d17f752e878114c846406a537081ebe34e0ae2e34c4
+  data.tar.gz: 7f42445ceb3ab057ded3a60a1dc8689fcec344398c1b735dbafb43e01c51653d
 SHA512:
-  metadata.gz: 8e13eabfbe27a41b911d00c2d8e3476ef76785a1879e0356aec501d397343a7c25fe7c2b76f9806a12060d0279b76b0bc6dc39b286aef216975edae592a90af5
-  data.tar.gz: c79eda01413dab578ab7eed8edaf2f468fc7702ef8ae280407431d1d6026373c078a4b98114ba80b8448b77f13e6c64a58bde11a024a1e2bbd3db688db550eac
+  metadata.gz: e9d9b95df9631d8b54ac61ae808be26cc8f47d48fb8a9a13489aa1bb04457d76a044eae8732b7abd0a774304be484c5c29f0fa7a4430a06e2f9daf1cad698008
+  data.tar.gz: 326e54ff7b2f4fb098ce3d39f50fd96897cedd25d9a73c86f1eba71b7b70a188ab4952bddc59cd8059abc4caf01b2c80d1326cde50bc4a7dcd464283e6ed61a3

data/lib/gds_api/email_alert_api.rb

@@ -220,15 +220,15 @@ class GdsApi::EmailAlertApi < GdsApi::Base
     )
   end
 
-  # Create an authentication token for a subscriber
+  # Verify a subscriber has control of a provided email
   #
-  # @param [string]       address       Email address of subscriber to create token for
+  # @param [string]       address       Address to send verification email to
   # @param [string]       destination   Path on GOV.UK that subscriber will be emailed
   # @param [string, nil]  redirect      Path on GOV.UK to be encoded into the token for redirecting
   #
   # @return [Hash]  subscriber
   #
-  def create_auth_token(address:, destination:, redirect: nil)
+  def send_subscriber_verification_email(address:, destination:, redirect: nil)
     post_json(
       "#{endpoint}/subscribers/auth-token",
       address: address,
@@ -237,6 +237,23 @@ class GdsApi::EmailAlertApi < GdsApi::Base
     )
   end
 
+  # Verify a subscriber intends to be added to a subscription
+  #
+  # @param [string]       address       Address to send verification email to
+  # @param [string]       frequency     How often the subscriber wishes to be notified of new items
+  # @param [string]       topic_id      The slugs/ID for the topic being subscribed to
+  #
+  # return [Hash]  subscription
+  #
+  def send_subscription_verification_email(address:, frequency:, topic_id:)
+    post_json(
+      "#{endpoint}/subscriptions/auth-token",
+      address: address,
+      frequency: frequency,
+      topic_id: topic_id,
+    )
+  end
+
 private
 
   def nested_query_string(params)

data/lib/gds_api/test_helpers/email_alert_api.rb

@@ -239,7 +239,21 @@ module GdsApi
         ).to_return(status: 422)
       end
 
-      def stub_email_alert_api_creates_an_auth_token(subscriber_id, address)
+      def stub_email_alert_api_sends_subscription_verification_email(address, frequency, topic_id)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions/auth-token")
+          .with(
+            body: { address: address, frequency: frequency, topic_id: topic_id }.to_json,
+          ).to_return(status: 200)
+      end
+
+      def stub_email_alert_api_subscription_verification_email_invalid(address, frequency, topic_id)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions/auth-token")
+          .with(
+            body: { address: address, frequency: frequency, topic_id: topic_id }.to_json,
+          ).to_return(status: 422)
+      end
+
+      def stub_email_alert_api_sends_subscriber_verification_email(subscriber_id, address)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/auth-token")
           .to_return(
             status: 201,
@@ -247,12 +261,12 @@ module GdsApi
           )
       end
 
-      def stub_email_alert_api_invalid_auth_token
+      def stub_email_alert_api_subscriber_verification_email_invalid
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/auth-token")
           .to_return(status: 422)
       end
 
-      def stub_email_alert_api_auth_token_no_subscriber
+      def stub_email_alert_api_subscriber_verification_email_no_subscriber
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/auth-token")
           .to_return(status: 404)
       end
@@ -307,7 +321,6 @@ module GdsApi
       alias_method :email_alert_api_creates_a_subscription, :stub_email_alert_api_creates_a_subscription
       alias_method :email_alert_api_creates_an_existing_subscription, :stub_email_alert_api_creates_an_existing_subscription
       alias_method :email_alert_api_refuses_to_create_subscription, :stub_email_alert_api_refuses_to_create_subscription
-      alias_method :email_alert_api_creates_an_auth_token, :stub_email_alert_api_creates_an_auth_token
       alias_method :email_alert_api_has_subscriber_list_by_slug, :stub_email_alert_api_has_subscriber_list_by_slug
       alias_method :email_alert_api_does_not_have_subscriber_list_by_slug, :stub_email_alert_api_does_not_have_subscriber_list_by_slug
 

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "61.1.0".freeze
+  VERSION = "62.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 61.1.0
+  version: 62.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-03 00:00:00.000000000 Z
+date: 2019-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable