gds-api-adapters 52.1.0 → 52.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40085ff1cfbfc2f1b252dae911e46de0b8abedd0ad89baa379a4e9547e37c756
-  data.tar.gz: c5b4deb265a8398b9f5c02ac73fb054536c63ef4a5334831040365a6628181f0
+  metadata.gz: 6336130268f19fee00d05ba2a6332da8a534f4b94fbc5eb52d774a117305b9f9
+  data.tar.gz: 7e6596cb403f449a386f9e08b80b4ccc253c0efb4d7e465d13de5ec955711406
 SHA512:
-  metadata.gz: df132d9e73f0456a45086a0774e56272df554714ae25754d4f40a83a51d9ad2eca2b69cf2de37e981c9e87b130ff96267eae1b87584c7388e454e455cca685f8
-  data.tar.gz: 29bfdb1f8457561a9f3008be3b6dfaaa320a34d0aa581ee07ab46b6708c7e00ba0ac2d2ff1aced212a03bb4da449301760c6ccf5f0f0155148c054d2653686ae
+  metadata.gz: e8c4700994a3894fe6c3a2e6d97902c084afad6302e12cc211d3cf12febd27248ff7718f33a1e54a3fdc1c7bb640807804fcf8bdff55aa8bb7644833cb92dde2
+  data.tar.gz: 99396abbb0adc97095c80ccbceaea467be35b59df0ddd8ec260ceae32fcb4e06a0640c6b87d76229246a0d53dcaff06a19342120d3ca6958ebd95b3b76f31124

data/lib/gds_api/base.rb

@@ -41,7 +41,7 @@ class GdsApi::Base
 
   def initialize(endpoint_url, options = {})
     options[:endpoint_url] = endpoint_url
-    raise InvalidAPIURL unless endpoint_url =~ URI::regexp
+    raise InvalidAPIURL unless endpoint_url =~ URI::RFC3986_Parser::RFC3986_URI
     base_options = { logger: self.class.logger }
     default_options = base_options.merge(GdsApi::Base.default_options || {})
     @options = default_options.merge(options)

data/lib/gds_api/email_alert_api.rb

@@ -105,8 +105,58 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   #  subscriber_count
   # }
   def get_subscribable(reference:)
-    get_json(
-      "#{endpoint}/subscribables/#{reference}"
+    get_json("#{endpoint}/subscribables/#{reference}")
+  end
+
+  # Get a Subscription
+  #
+  # @return [Hash] subscription: {
+  #  id
+  #  subscriber_list
+  #  subscriber
+  #  created_at
+  #  updated_at
+  #  ended_at
+  #  ended_reason
+  #  frequency
+  #  source
+  # }
+  def get_subscription(id)
+    get_json("#{endpoint}/subscriptions/#{id}")
+  end
+
+  # Get Subscriptions for a Subscriber
+  # #
+  # @param string Subscriber address
+  #
+  # @return [Hash] subscriber, subscriptions
+  def get_subscriptions(address:)
+    get_json("#{endpoint}/subscribers/#{address}/subscriptions")
+  end
+
+  # Patch a Subscriber
+  # #
+  # @param string Subscriber address
+  # @param string Subscriber new_address
+  #
+  # @return [Hash] subscriber
+  def change_subscriber(address:, new_address:)
+    patch_json(
+      "#{endpoint}/subscribers/#{address}",
+      new_address: new_address
+    )
+  end
+
+  # Patch a Subscription
+  # #
+  # @param string Subscription id
+  # @param string Subscription frequency
+  #
+  # @return [Hash] subscription
+  def change_subscription(id:, frequency:)
+    patch_json(
+      "#{endpoint}/subscriptions/#{id}",
+      frequency: frequency
     )
   end
 

data/lib/gds_api/imminence.rb

@@ -31,7 +31,7 @@ class GdsApi::Imminence < GdsApi::Base
   end
 
   def areas_for_postcode(postcode)
-    url = "#{@endpoint}/areas/#{URI.encode(postcode)}.json"
+    url = "#{@endpoint}/areas/#{ERB::Util.url_encode(postcode)}.json"
     get_json(url)
   end
 

data/lib/gds_api/test_helpers/email_alert_api.rb

@@ -6,6 +6,53 @@ module GdsApi
     module EmailAlertApi
       EMAIL_ALERT_API_ENDPOINT = Plek.find("email-alert-api")
 
+      def email_alert_api_has_updated_subscriber(old_address, new_address)
+        stub_request(:patch, subscriber_url(old_address))
+          .to_return(
+            status: 200,
+            body: get_subscriber_response(new_address).to_json,
+          )
+      end
+
+      def email_alert_api_does_not_have_updated_subscriber(address)
+        stub_request(:patch, subscriber_url(address))
+          .to_return(status: 404)
+      end
+
+      def email_alert_api_has_updated_subscription(subscription_id, frequency)
+        stub_request(:patch, subscription_url(subscription_id))
+          .to_return(
+            status: 200,
+            body: get_subscription_response(subscription_id, frequency).to_json,
+          )
+      end
+
+      def email_alert_api_does_not_have_updated_subscription(subscription_id)
+        stub_request(:patch, subscription_url(subscription_id))
+          .to_return(status: 404)
+      end
+
+      def email_alert_api_has_subscriber_subscriptions(address)
+        stub_request(:get, subscriber_subscriptions_url(address))
+          .to_return(
+            status: 200,
+            body: get_subscriber_subscriptions_response(address).to_json,
+          )
+      end
+
+      def email_alert_api_does_not_have_subscriber_subscriptions(address)
+        stub_request(:get, subscriber_subscriptions_url(address))
+          .to_return(status: 404)
+      end
+
+      def email_alert_api_has_subscription(id, frequency)
+        stub_request(:get, subscription_url(id))
+          .to_return(
+            status: 200,
+            body: get_subscription_response(id, frequency).to_json,
+          )
+      end
+
       def email_alert_api_has_subscriber_list(attributes)
         stub_request(:get, subscriber_lists_url(attributes))
           .to_return(
@@ -34,12 +81,55 @@ module GdsApi
           )
       end
 
+      def get_subscriber_response(address)
+        {
+          "subscriber" => {
+            "id" => 1,
+            "address" => address
+          }
+        }
+      end
+
+      def get_subscription_response(subscription_id, frequency)
+        {
+          "subscription" => {
+            "subscriber_id" => 1,
+            "subscriber_list_id" => 1000,
+            "frequency" => frequency,
+            "id" => subscription_id,
+            "subscriber_list" => {
+              "id" => 1000,
+              "slug" => "some-thing"
+            }
+          }
+        }
+      end
+
+      def get_subscriber_subscriptions_response(address)
+        {
+          "subscriber" => {
+            "id" => 1,
+            "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",
-            "subscription_url" => "https://stage-public.govdelivery.com/accounts/UKGOVUK/subscriber/new?topic_id=UKGOVUK_1234",
-            "gov_delivery_id" => "UKGOVUK_1234",
             "title" => "Some title",
           }.merge(attributes)
         }
@@ -193,9 +283,21 @@ module GdsApi
         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(address)
+        EMAIL_ALERT_API_ENDPOINT + "/subscribers/#{address}"
+      end
+
+      def subscriber_subscriptions_url(address)
+        EMAIL_ALERT_API_ENDPOINT + "/subscribers/#{address}/subscriptions"
+      end
     end
   end
 end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '52.1.0'.freeze
+  VERSION = '52.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 52.1.0
+  version: 52.2.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2018-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -114,42 +114,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: govuk-lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.11'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '1.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '1.20'
 - !ruby/object:Gem::Dependency
   name: pact-consumer-minitest
   requirement: !ruby/object:Gem::Requirement
@@ -212,14 +212,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -282,14 +282,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: simplecov-rcov
   requirement: !ruby/object:Gem::Requirement
@@ -310,56 +310,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.11
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.11
+        version: '0.9'
 description: A set of adapters providing easy access to the GDS GOV.UK APIs
 email:
 - govuk-dev@digital.cabinet-office.gov.uk