gds-api-adapters 52.4.0 → 52.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f25de033dd0924ac2e17348a1c1a8358aa7deb30c502a1ae6483595e997837ed
-  data.tar.gz: 7f0dee4ad67cd1cbbb7e97cb924b96210f6d31480abf713032cdf604fa9a8f6f
+  metadata.gz: aec33b725938e09035043960dd0f4571f712bc71930eb93bd2684888730529af
+  data.tar.gz: ac1f9bd79d271352d0896f6997bdf5a6609afc33016d422bf0b66993bf31f566
 SHA512:
-  metadata.gz: 44f54f5b8cf0a657ee42e4c876fc067397aba75f8319eef8b43aa48d4d8ba6a095f3e20965d38505ba18a64bbc9f22fc993f45014c990e28b74da933012e37b8
-  data.tar.gz: 82f2662c2972eed87740a126c900f748cf44740443d30040ba05599324caf2b5324f21d9984ea382a01d86b9685aa1ab10de1aa24d2625757d5106d05c190d76
+  metadata.gz: 62ffe96af3f95e88ba37096f5eebef3ccaca181ab86e87cae1319f1eed8eedeee4ee4b4cf7eb65e8df201cc54980d9106a378207bbece98e55bce83503a3e205
+  data.tar.gz: e5acd2473f6c23bdf629f113bdd2cbfa6ef14e3cdd68bab07ef9bfa1895cebedcc3a7b6c79642add884c31cc730f85126a57baf2deebf926305bce45301fa472

data/lib/gds_api/email_alert_api.rb

@@ -69,19 +69,19 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   end
 
   # Unsubscribe subscriber from subscription
-  # #
-  # @param uuid Subscription uuid
   #
-  # @return null
+  # @param [string] Subscription uuid
+  #
+  # @return [nil]
   def unsubscribe(uuid)
     post_json("#{endpoint}/unsubscribe/#{uuid}")
   end
 
   # Unsubscribe subscriber from everything
-  # #
-  # @param integer Subscriber id
   #
-  # @return null
+  # @param [integer] Subscriber id
+  #
+  # @return [nil]
   def unsubscribe_subscriber(id)
     delete_json("#{endpoint}/subscribers/#{id}")
   end
@@ -135,8 +135,8 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   end
 
   # Get Subscriptions for a Subscriber
-  # #
-  # @param integer Subscriber id
+  #
+  # @param [integer] Subscriber id
   #
   # @return [Hash] subscriber, subscriptions
   def get_subscriptions(id:)
@@ -144,9 +144,9 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   end
 
   # Patch a Subscriber
-  # #
-  # @param integer Subscriber id
-  # @param string Subscriber new_address
+  #
+  # @param [integer] Subscriber id
+  # @param [string] Subscriber new_address
   #
   # @return [Hash] subscriber
   def change_subscriber(id:, new_address:)
@@ -157,9 +157,9 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   end
 
   # Patch a Subscription
-  # #
-  # @param string Subscription id
-  # @param string Subscription frequency
+  #
+  # @param [string] Subscription id
+  # @param [string] Subscription frequency
   #
   # @return [Hash] subscription
   def change_subscription(id:, frequency:)
@@ -169,6 +169,23 @@ class GdsApi::EmailAlertApi < GdsApi::Base
     )
   end
 
+  # Create an authentication token for a subscriber
+  #
+  # @param [string]       address       Email address of subscriber to create token for
+  # @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)
+    post_json(
+      "#{endpoint}/subscribers/auth-token",
+      address: address,
+      destination: destination,
+      redirect: redirect,
+    )
+  end
+
 private
 
   def nested_query_string(params)

data/lib/gds_api/test_helpers/email_alert_api.rb

@@ -7,7 +7,7 @@ module GdsApi
       EMAIL_ALERT_API_ENDPOINT = Plek.find("email-alert-api")
 
       def email_alert_api_has_updated_subscriber(id, new_address)
-        stub_request(:patch, subscriber_url(id))
+        stub_request(:patch, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{id}")
           .to_return(
             status: 200,
             body: get_subscriber_response(id, new_address).to_json,
@@ -15,12 +15,12 @@ module GdsApi
       end
 
       def email_alert_api_does_not_have_updated_subscriber(id)
-        stub_request(:patch, subscriber_url(id))
+        stub_request(:patch, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{id}")
           .to_return(status: 404)
       end
 
       def email_alert_api_has_updated_subscription(subscription_id, frequency)
-        stub_request(:patch, subscription_url(subscription_id))
+        stub_request(:patch, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions/#{subscription_id}")
           .to_return(
             status: 200,
             body: get_subscription_response(subscription_id, frequency).to_json,
@@ -28,12 +28,12 @@ module GdsApi
       end
 
       def email_alert_api_does_not_have_updated_subscription(subscription_id)
-        stub_request(:patch, subscription_url(subscription_id))
+        stub_request(:patch, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions/#{subscription_id}")
           .to_return(status: 404)
       end
 
       def email_alert_api_has_subscriber_subscriptions(id, address)
-        stub_request(:get, subscriber_subscriptions_url(id))
+        stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{id}/subscriptions")
           .to_return(
             status: 200,
             body: get_subscriber_subscriptions_response(id, address).to_json,
@@ -41,12 +41,12 @@ module GdsApi
       end
 
       def email_alert_api_does_not_have_subscriber_subscriptions(id)
-        stub_request(:get, subscriber_subscriptions_url(id))
+        stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{id}/subscriptions")
           .to_return(status: 404)
       end
 
       def email_alert_api_has_subscription(id, frequency, title: "Some title")
-        stub_request(:get, subscription_url(id))
+        stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions/#{id}")
           .to_return(
             status: 200,
             body: get_subscription_response(id, frequency, title).to_json,
@@ -54,7 +54,7 @@ module GdsApi
       end
 
       def email_alert_api_has_subscriber_list(attributes)
-        stub_request(:get, subscriber_lists_url(attributes))
+        stub_request(:get, build_subscriber_lists_url(attributes))
           .to_return(
             status: 200,
             body: get_subscriber_list_response(attributes).to_json,
@@ -62,12 +62,12 @@ module GdsApi
       end
 
       def email_alert_api_does_not_have_subscriber_list(attributes)
-        stub_request(:get, subscriber_lists_url(attributes))
+        stub_request(:get, build_subscriber_lists_url(attributes))
           .to_return(status: 404)
       end
 
       def email_alert_api_creates_subscriber_list(attributes)
-        stub_request(:post, subscriber_lists_url)
+        stub_request(:post, build_subscriber_lists_url)
           .to_return(
             status: 201,
             body: get_subscriber_list_response(attributes).to_json,
@@ -75,77 +75,13 @@ module GdsApi
       end
 
       def email_alert_api_refuses_to_create_subscriber_list
-        stub_request(:post, subscriber_lists_url)
-          .to_return(
-            status: 422,
-          )
-      end
-
-      def get_subscriber_response(id, address)
-        {
-          "subscriber" => {
-            "id" => id,
-            "address" => address
-          }
-        }
-      end
-
-      def get_subscription_response(id, frequency, title = "Some title")
-        {
-          "subscription" => {
-            "subscriber_id" => 1,
-            "subscriber_list_id" => 1000,
-            "frequency" => frequency,
-            "id" => id,
-            "subscriber_list" => {
-              "id" => 1000,
-              "slug" => "some-thing",
-              "title" => title,
-            }
-          }
-        }
-      end
-
-      def get_subscriber_subscriptions_response(id, address)
-        {
-          "subscriber" => {
-            "id" => id,
-            "address" => address
-          },
-          "subscriptions" => [
-            {
-              "subscriber_id" => 1,
-              "subscriber_list_id" => 1000,
-              "frequency" => "daily",
-              "id" => "447135c3-07d6-4c3a-8a3b-efa49ef70e52",
-              "subscriber_list" => {
-                "id" => 1000,
-                "slug" => "some-thing"
-              }
-            }
-          ]
-        }
-      end
-
-      def get_subscriber_list_response(attributes)
-        {
-          "subscriber_list" => {
-            "id" => "447135c3-07d6-4c3a-8a3b-efa49ef70e52",
-            "title" => "Some title",
-          }.merge(attributes)
-        }
+        stub_request(:post, build_subscriber_lists_url)
+          .to_return(status: 422)
       end
 
       def email_alert_api_accepts_alert
-        stub_request(:post, notifications_url)
-          .to_return(
-            status: 202,
-            body: {}.to_json,
-          )
-      end
-
-      def post_alert_response
-        {}
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/notifications")
+          .to_return(status: 202, body: {}.to_json)
       end
 
       def stub_any_email_alert_api_call
@@ -160,11 +96,11 @@ module GdsApi
           end
         end
 
-        assert_requested(:post, notifications_url, times: 1, &matcher)
+        assert_requested(:post, "#{EMAIL_ALERT_API_ENDPOINT}/notifications", times: 1, &matcher)
       end
 
       def email_alert_api_has_notifications(notifications, start_at = nil)
-        url = notifications_url
+        url = "#{EMAIL_ALERT_API_ENDPOINT}/notifications"
         url += "?start_at=#{start_at}" if start_at
         url_regexp = Regexp.new("^#{Regexp.escape(url)}$")
 
@@ -176,7 +112,7 @@ module GdsApi
       end
 
       def email_alert_api_has_notification(notification)
-        url = "#{notifications_url}/#{notification['web_service_bulletin']['to_param']}"
+        url = "#{EMAIL_ALERT_API_ENDPOINT}/notifications/#{notification['web_service_bulletin']['to_param']}"
 
         stub_request(:get, url).to_return(
           status: 200,
@@ -185,54 +121,62 @@ module GdsApi
       end
 
       def email_alert_api_unsubscribes_a_subscription(uuid)
-        stub_request(:post, unsubscribe_url(uuid))
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/unsubscribe/#{uuid}")
           .with(body: "{}")
           .to_return(status: 204)
       end
 
       def email_alert_api_has_no_subscription_for_uuid(uuid)
-        stub_request(:post, unsubscribe_url(uuid))
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/unsubscribe/#{uuid}")
           .with(body: "{}")
           .to_return(status: 404)
       end
 
       def email_alert_api_unsubscribes_a_subscriber(subscriber_id)
-        stub_request(:delete, unsubscribe_subscriber_url(subscriber_id))
+        stub_request(:delete, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{subscriber_id}")
           .to_return(status: 204)
       end
 
       def email_alert_api_has_no_subscriber(subscriber_id)
-        stub_request(:delete, unsubscribe_subscriber_url(subscriber_id))
+        stub_request(:delete, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{subscriber_id}")
           .to_return(status: 404)
       end
 
       def email_alert_api_creates_a_subscription(subscribable_id, address, frequency, returned_subscription_id)
-        stub_request(:post, subscribe_url)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions")
           .with(
             body: { subscribable_id: subscribable_id, address: address, frequency: frequency }.to_json
         ).to_return(status: 201, body: { subscription_id: returned_subscription_id }.to_json)
       end
 
       def email_alert_api_creates_an_existing_subscription(subscribable_id, address, frequency, returned_subscription_id)
-        stub_request(:post, subscribe_url)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions")
           .with(
             body: { subscribable_id: subscribable_id, address: address, frequency: frequency }.to_json
         ).to_return(status: 200, body: { subscription_id: returned_subscription_id }.to_json)
       end
 
       def email_alert_api_refuses_to_create_subscription(subscribable_id, address, frequency)
-        stub_request(:post, subscribe_url)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions")
           .with(
             body: { subscribable_id: subscribable_id, address: address, frequency: frequency }.to_json
         ).to_return(status: 422)
       end
 
+      def email_alert_api_creates_an_auth_token(subscriber_id, address)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/auth-token")
+          .to_return(
+            status: 201,
+            body: get_subscriber_response(subscriber_id, address).to_json
+          )
+      end
+
       def assert_unsubscribed(uuid)
-        assert_requested(:post, unsubscribe_url(uuid), times: 1)
+        assert_requested(:post, "#{EMAIL_ALERT_API_ENDPOINT}/unsubscribe/#{uuid}", times: 1)
       end
 
       def assert_subscribed(subscribable_id, address, frequency = "immediately")
-        assert_requested(:post, subscribe_url) do |req|
+        assert_requested(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions") do |req|
           JSON.parse(req.body).symbolize_keys == {
             subscribable_id: subscribable_id,
             address: address,
@@ -242,7 +186,7 @@ module GdsApi
       end
 
       def email_alert_api_has_subscribable(reference:, returned_attributes:)
-        stub_request(:get, subscribable_url(reference))
+        stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscribables/#{reference}")
           .to_return(
             status: 200,
             body: {
@@ -252,13 +196,72 @@ module GdsApi
       end
 
       def email_alert_api_does_not_have_subscribable(reference:)
-        stub_request(:get, subscribable_url(reference))
+        stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscribables/#{reference}")
           .to_return(status: 404)
       end
 
     private
 
-      def subscriber_lists_url(attributes = nil)
+      def get_subscriber_response(id, address)
+        {
+          "subscriber" => {
+            "id" => id,
+            "address" => address
+          }
+        }
+      end
+
+      def get_subscription_response(id, frequency, title = "Some title")
+        {
+          "subscription" => {
+            "subscriber_id" => 1,
+            "subscriber_list_id" => 1000,
+            "frequency" => frequency,
+            "id" => id,
+            "subscriber_list" => {
+              "id" => 1000,
+              "slug" => "some-thing",
+              "title" => title,
+            }
+          }
+        }
+      end
+
+      def get_subscriber_subscriptions_response(id, address)
+        {
+          "subscriber" => {
+            "id" => id,
+            "address" => address
+          },
+          "subscriptions" => [
+            {
+              "subscriber_id" => 1,
+              "subscriber_list_id" => 1000,
+              "frequency" => "daily",
+              "id" => "447135c3-07d6-4c3a-8a3b-efa49ef70e52",
+              "subscriber_list" => {
+                "id" => 1000,
+                "slug" => "some-thing"
+              }
+            }
+          ]
+        }
+      end
+
+      def get_subscriber_list_response(attributes)
+        {
+          "subscriber_list" => {
+            "id" => "447135c3-07d6-4c3a-8a3b-efa49ef70e52",
+            "title" => "Some title",
+          }.merge(attributes)
+        }
+      end
+
+      def post_alert_response
+        {}
+      end
+
+      def build_subscriber_lists_url(attributes = nil)
         if attributes
           tags = attributes["tags"]
           links = attributes["links"]
@@ -278,41 +281,9 @@ module GdsApi
           query = Rack::Utils.build_nested_query(params)
         end
 
-        url = EMAIL_ALERT_API_ENDPOINT + "/subscriber-lists"
+        url = "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists"
         query ? "#{url}?#{query}" : url
       end
-
-      def notifications_url
-        EMAIL_ALERT_API_ENDPOINT + "/notifications"
-      end
-
-      def unsubscribe_url(uuid)
-        EMAIL_ALERT_API_ENDPOINT + "/unsubscribe/#{uuid}"
-      end
-
-      def unsubscribe_subscriber_url(id)
-        EMAIL_ALERT_API_ENDPOINT + "/subscribers/#{id}"
-      end
-
-      def subscribe_url
-        EMAIL_ALERT_API_ENDPOINT + "/subscriptions"
-      end
-
-      def subscription_url(id)
-        EMAIL_ALERT_API_ENDPOINT + "/subscriptions/#{id}"
-      end
-
-      def subscribable_url(reference)
-        EMAIL_ALERT_API_ENDPOINT + "/subscribables/#{reference}"
-      end
-
-      def subscriber_url(id)
-        EMAIL_ALERT_API_ENDPOINT + "/subscribers/#{id}"
-      end
-
-      def subscriber_subscriptions_url(id)
-        EMAIL_ALERT_API_ENDPOINT + "/subscribers/#{id}/subscriptions"
-      end
     end
   end
 end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '52.4.0'.freeze
+  VERSION = '52.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 52.4.0
+  version: 52.5.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek