gds-api-adapters 57.5.0 → 58.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d790bf7e187109ce1f31d1ca428cd65493698bc72bbb5ebbf33eb60f38f0b66f
-  data.tar.gz: ff50c34b2405d4f1286df944e243857da924ef91a541b514810a2f7b41f38b33
+  metadata.gz: c7d9ecf3ac65ca6371589de670a63f3fae3f0dbc691ca2b6d3cc4672e2ae4f39
+  data.tar.gz: 6461edf825df98fe824566d3c514d861989e3b5dd326348c98f5a51c5c2f0abf
 SHA512:
-  metadata.gz: 11ecc5a522a057ecb122889c5a7e88ecef23b4242784bc08e6ef7be94d7f1ce6611b238ace87b0e2449b9c6847377358f1bed66474e3d2cb010f6b3ec0cc55c2
-  data.tar.gz: 7f98a8869d10d02c99b20d1cc867285b82fbcd3320ef1ddfd46883a0d5b2736e26f2bf2a38445b569af635d19049213f4728364ec2d1a804cf7d07b015858eef
+  metadata.gz: 9c256cab86245efd9c1daf1903f289c08b436fb859fee3725eeb32f48d4583e39a34e9f5ea8af48d3bc7e941ddf3850ade0dbd8c43e23eed2d0a3f3dac2b9085
+  data.tar.gz: a6d1ca1c4f05a2b763ea614bf9dac6b77aebd005e401d6b6cae60a42ab47d4a65db89663709827318889c613d66dfef29065ff3c4fdc78e1b461fc3b7a9c1040

data/lib/gds_api/email_alert_api.rb

@@ -102,18 +102,18 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   # Subscribe
   #
   # @return [Hash] subscription_id
-  def subscribe(subscribable_id:, address:, frequency: "immediately")
+  def subscribe(subscriber_list_id:, address:, frequency: "immediately")
     post_json(
       "#{endpoint}/subscriptions",
-      subscribable_id: subscribable_id,
+      subscriber_list_id: subscriber_list_id,
       address: address,
       frequency: frequency,
     )
   end
 
-  # Get a Subscribable
+  # Get a Subscriber List
   #
-  # @return [Hash] subscribable: {
+  # @return [Hash] subscriber_list: {
   #  id
   #  title
   #  gov_delivery_id
@@ -126,8 +126,8 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   #  government_document_supertype
   #  subscriber_count
   # }
-  def get_subscribable(reference:)
-    get_json("#{endpoint}/subscribables/#{reference}")
+  def get_subscriber_list(slug:)
+    get_json("#{endpoint}/subscriber-lists/#{slug}")
   end
 
   # Get a Subscription

data/lib/gds_api/publishing_api.rb

@@ -2,10 +2,31 @@ require_relative 'base'
 require_relative 'exceptions'
 
 class GdsApi::PublishingApi < GdsApi::Base
+  # Create a publishing intent for a base_path.
+  #
+  # @param base_path [String]
+  # @param payload [Hash]
+  # @example
+  #
+  # publishing_api.put_intent(
+  #   '/some/base_path',
+  #   {
+  #     publish_time: '2024-03-15T09:00:00.000+00:00',
+  #     publishing_app: 'content-publisher',
+  #     rendering_app: 'government-frontend',
+  #   }
+  #)
+  #
+  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#put-publish-intentbase_path
   def put_intent(base_path, payload)
     put_json(intent_url(base_path), payload)
   end
 
+  # Delete a publishing intent for a base_path.
+  #
+  # @param base_path [String]
+  #
+  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#delete-publish-intentbase_path
   def destroy_intent(base_path)
     delete_json(intent_url(base_path))
   rescue GdsApi::HTTPNotFound => e

data/lib/gds_api/test_helpers/email_alert_api.rb

@@ -161,24 +161,24 @@ module GdsApi
           .to_return(status: 404)
       end
 
-      def stub_email_alert_api_creates_a_subscription(subscribable_id, address, frequency, returned_subscription_id)
+      def stub_email_alert_api_creates_a_subscription(subscriber_list_id, address, frequency, returned_subscription_id)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions")
           .with(
-            body: { subscribable_id: subscribable_id, address: address, frequency: frequency }.to_json
+            body: { subscriber_list_id: subscriber_list_id, address: address, frequency: frequency }.to_json
         ).to_return(status: 201, body: { subscription_id: returned_subscription_id }.to_json)
       end
 
-      def stub_email_alert_api_creates_an_existing_subscription(subscribable_id, address, frequency, returned_subscription_id)
+      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: { subscribable_id: subscribable_id, address: address, frequency: frequency }.to_json
+            body: { subscriber_list_id: subscriber_list_id, address: address, frequency: frequency }.to_json
         ).to_return(status: 200, body: { subscription_id: returned_subscription_id }.to_json)
       end
 
-      def stub_email_alert_api_refuses_to_create_subscription(subscribable_id, address, frequency)
+      def stub_email_alert_api_refuses_to_create_subscription(subscriber_list_id, address, frequency)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions")
           .with(
-            body: { subscribable_id: subscribable_id, address: address, frequency: frequency }.to_json
+            body: { subscriber_list_id: subscriber_list_id, address: address, frequency: frequency }.to_json
         ).to_return(status: 422)
       end
 
@@ -194,28 +194,28 @@ module GdsApi
         assert_requested(:post, "#{EMAIL_ALERT_API_ENDPOINT}/unsubscribe/#{uuid}", times: 1)
       end
 
-      def assert_subscribed(subscribable_id, address, frequency = "immediately")
+      def assert_subscribed(subscriber_list_id, address, frequency = "immediately")
         assert_requested(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions") do |req|
           JSON.parse(req.body).symbolize_keys == {
-            subscribable_id: subscribable_id,
+            subscriber_list_id: subscriber_list_id,
             address: address,
             frequency: frequency
           }
         end
       end
 
-      def stub_email_alert_api_has_subscribable(reference:, returned_attributes:)
-        stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscribables/#{reference}")
+      def stub_email_alert_api_has_subscriber_list_by_slug(slug:, returned_attributes:)
+        stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}")
           .to_return(
             status: 200,
             body: {
-              subscribable: returned_attributes
+              subscriber_list: returned_attributes
             }.to_json
         )
       end
 
-      def stub_email_alert_api_does_not_have_subscribable(reference:)
-        stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscribables/#{reference}")
+      def stub_email_alert_api_does_not_have_subscriber_list_by_slug(slug:)
+        stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}")
           .to_return(status: 404)
       end
 
@@ -243,8 +243,8 @@ module GdsApi
       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_subscribable, :stub_email_alert_api_has_subscribable
-      alias_method :email_alert_api_does_not_have_subscribable, :stub_email_alert_api_does_not_have_subscribable
+      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
 
     private
 

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '57.5.0'.freeze
+  VERSION = '58.0.0'.freeze
 end

metadata

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