gds-api-adapters 29.3.1 → 29.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47a5ea938b00f84981bf99e6cd2f0e3d6fb94b3f
-  data.tar.gz: a35284df3295fd23b5fc59771649acebf7f64cd7
+  metadata.gz: b562297ce51a222600b08f5f03e0bd8760a7b38a
+  data.tar.gz: 454376b9f09ffae61d33051e3cd0945c72eda27e
 SHA512:
-  metadata.gz: ac5a10f123ecbf570a1ec183968d5e5d76faeb2bdc2423eace86dfea7ef56250fbe8f964b0295fd26d6c3fe281b183230a6b114e44e45ce98e27a15d22384426
-  data.tar.gz: 2f25ce61b3eead78a1579882485efbc9bdfbda4cf3a227c835c42500fabdcf9024d3e15b6aabb8c63393d2af14f9b0a4efaa8d37fe6427ad1f2fe774bd600537
+  metadata.gz: 8071ee9a6fb45ea027ee5450a76f6682d6d2a04734f59a21b480c1f2f2b15ff8482dd0de9f0ebba6a4ab23398fa210ddda07d70315e61d4e07a24801ba85835f
+  data.tar.gz: 4ba2242191eb8cbc922f8a157dc322dcf32931e8ea7f165ccd6594a991738425d2668a00e1bb1b5348743e8e136c3c961c517b9c03c9b990ae517abab7a4eec4

data/lib/gds_api/email_alert_api.rb

@@ -4,7 +4,21 @@ require_relative 'exceptions'
 class GdsApi::EmailAlertApi < GdsApi::Base
 
   def find_or_create_subscriber_list(attributes)
-    search_subscriber_list_by_tags(attributes.fetch("tags"))
+    tags = attributes["tags"]
+    links = attributes["links"]
+    document_type = attributes["document_type"]
+
+    if tags && 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
+
+    search_subscriber_list(params)
   rescue GdsApi::HTTPNotFound
     create_subscriber_list(attributes)
   end
@@ -15,8 +29,9 @@ class GdsApi::EmailAlertApi < GdsApi::Base
 
 private
 
-  def search_subscriber_list_by_tags(tags)
-    get_json!("#{endpoint}/subscriber-lists?" + nested_query_string(tags: tags))
+  def search_subscriber_list(params)
+    query_string = nested_query_string(params)
+    get_json!("#{endpoint}/subscriber-lists?" + query_string)
   end
 
   def create_subscriber_list(attributes)

data/lib/gds_api/test_helpers/email_alert_api.rb

@@ -7,12 +7,7 @@ module GdsApi
       EMAIL_ALERT_API_ENDPOINT = Plek.find("email-alert-api")
 
       def email_alert_api_has_subscriber_list(attributes)
-        title = attributes.fetch("title")
-        tags = attributes.fetch("tags")
-
-        query = Rack::Utils.build_nested_query(tags: tags)
-
-        stub_request(:get, subscriber_lists_url(query))
+        stub_request(:get, subscriber_lists_url(attributes))
           .to_return(
             :status => 200,
             :body => get_subscriber_list_response(attributes).to_json,
@@ -20,9 +15,7 @@ module GdsApi
       end
 
       def email_alert_api_does_not_have_subscriber_list(attributes)
-        query = Rack::Utils.build_nested_query(tags: attributes.fetch("tags"))
-
-        stub_request(:get, subscriber_lists_url(query))
+        stub_request(:get, subscriber_lists_url(attributes))
           .to_return(status: 404)
       end
 
@@ -48,9 +41,6 @@ module GdsApi
             "subscription_url" => "https://stage-public.govdelivery.com/accounts/UKGOVUK/subscriber/new?topic_id=UKGOVUK_1234",
             "gov_delivery_id" => "UKGOVUK_1234",
             "title" => "Some title",
-            "tags" => {
-              "format" => ["some-format"],
-            }
           }.merge(attributes)
         }
       end
@@ -86,7 +76,20 @@ module GdsApi
 
     private
 
-      def subscriber_lists_url(query = nil)
+      def subscriber_lists_url(attributes = nil)
+        if attributes
+          tags = attributes["tags"]
+          links = attributes["links"]
+          document_type = attributes["document_type"]
+
+          params = {}
+          params[:tags] = tags if tags
+          params[:links] = links if links
+          params[:document_type] = document_type if document_type
+
+          query = Rack::Utils.build_nested_query(params)
+        end
+
         url = EMAIL_ALERT_API_ENDPOINT + "/subscriber-lists"
         query ? "#{url}?#{query}" : url
       end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '29.3.1'
+  VERSION = '29.4.0'
 end

data/test/email_alert_api_test.rb

@@ -96,6 +96,67 @@ describe GdsApi::EmailAlertApi do
           )
         end
       end
+
+      describe "when the optional 'document_type' is provided" do
+        let(:params) {
+          {
+            "title" => title,
+            "tags" => tags,
+            "document_type" => "travel_advice",
+          }
+        }
+
+        before do
+          email_alert_api_has_subscriber_list(
+            "title" => "Some Title",
+            "tags" => tags,
+            "document_type" => "travel_advice",
+            "subscription_url" => expected_subscription_url,
+          )
+        end
+
+        it "returns the subscriber list attributes" do
+          subscriber_list_attrs = api_client.find_or_create_subscriber_list(params)
+            .to_hash
+            .fetch("subscriber_list")
+
+          assert_equal(
+            "travel_advice",
+            subscriber_list_attrs.fetch("document_type")
+          )
+        end
+      end
+
+      describe "when both tags and links are provided" do
+        let(:links) {
+          {
+            "format" => ["some-document-format"]
+          }
+        }
+
+        let(:params) {
+          {
+            "title" => title,
+            "tags" => tags,
+            "links" => links,
+          }
+        }
+
+        before do
+          email_alert_api_has_subscriber_list(
+            "title" => "Some Title",
+            "tags" => tags,
+            "links" => links,
+            "subscription_url" => expected_subscription_url,
+          )
+        end
+
+        it "excludes that attribute from the query string" do
+          assert_raises do
+            api_client.find_or_create_subscriber_list(params)
+          end
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 29.3.1
+  version: 29.4.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-04 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek