gds-api-adapters 30.2.1 → 30.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 969acb8ae599f5c52ed298ddd20c282defb88372
-  data.tar.gz: 195b6054704e7dd2d48aa363e984e04633914c36
+  metadata.gz: 1ea4fb424e88b660a8ecb6ea9a088abf135983aa
+  data.tar.gz: ff6e5fd6357f9078dbc63762f498e3c47fc4d0d8
 SHA512:
-  metadata.gz: e6850acb92b32f599b93073fff01b73deb2fb857a8d5578dfcc9e5d35c96c4c4fceadbf999295b00c166c21fe6daccbe0031807826b2425677698efe6e3b772e
-  data.tar.gz: 1d16735000c6ab008c52ab4a69f8485b54c25eace4c38b0298f04e6e1982cad0a825e313f74d13d073e8a427e0dbd944aa766fb15e1f5ad837b0d170fac6b4a9
+  metadata.gz: 396bb7e3cddb5f262656439e1ef8c52795fa8b76f54e2339875e9d7d9ecd3e81843af9fdd8b1e050e9ca7293e22ee60b7af0078b7787235005f32fd972965ced
+  data.tar.gz: 173c4784e54d85ffdb1b6411572283a4082a5344cf0bb5b5ea87c6dabf500eef4b19963f6d26dc80109463bc9610d889eef7e5e757062de761f4c5f9810a2330

data/README.md

@@ -12,9 +12,9 @@ results = rummager.unified_search(q: "taxes")
 
 Example adapters for frequently used applications:
 
-- [Publishing API](lib/gds_api/publishing_api_v2.rb) ([docs](http://www.rubydoc.info/gems/gds-api-adapters/GdsApi/PublishingApiV2), [test helper code](https://github.com/alphagov/gds-api-adapters/blob/master/lib/gds_api/test_helpers/publishing_api_v2.rb), [test helper docs](http://www.rubydoc.info/gems/gds-api-adapters/GdsApi/TestHelpers/PublishingApiV2))
-- [Content Store](lib/gds_api/content_store.rb) ([docs](http://www.rubydoc.info/gems/gds-api-adapters/GdsApi/ContentStore), [test helper code](https://github.com/alphagov/gds-api-adapters/blob/master/lib/gds_api/test_helpers/content_store.rb), [test helper docs](http://www.rubydoc.info/gems/gds-api-adapters/GdsApi/TestHelpers/ContentStore))
-- [Rummager](lib/gds_api/publishing_api_v2.rb) ([docs](http://www.rubydoc.info/gems/gds-api-adapters/GdsApi/Rummager), [test helper code](https://github.com/alphagov/gds-api-adapters/blob/master/lib/gds_api/test_helpers/rummager.rb), [test helper docs](http://www.rubydoc.info/gems/gds-api-adapters/GdsApi/TestHelpers/Rummager))
+- [Publishing API](lib/gds_api/publishing_api_v2.rb) ([docs](http://www.rubydoc.info/github/alphagov/gds-api-adapters/master/GdsApi/PublishingApiV2), [test helper code](https://github.com/alphagov/gds-api-adapters/blob/master/lib/gds_api/test_helpers/publishing_api_v2.rb), [test helper docs](http://www.rubydoc.info/github/alphagov/gds-api-adapters/master/GdsApi/TestHelpers/PublishingApiV2))
+- [Content Store](lib/gds_api/content_store.rb) ([docs](http://www.rubydoc.info/github/alphagov/gds-api-adapters/master/GdsApi/ContentStore), [test helper code](https://github.com/alphagov/gds-api-adapters/blob/master/lib/gds_api/test_helpers/content_store.rb), [test helper docs](http://www.rubydoc.info/github/alphagov/gds-api-adapters/master/GdsApi/TestHelpers/ContentStore))
+- [Rummager](lib/gds_api/publishing_api_v2.rb) ([docs](http://www.rubydoc.info/github/alphagov/gds-api-adapters/master/GdsApi/Rummager), [test helper code](https://github.com/alphagov/gds-api-adapters/blob/master/lib/gds_api/test_helpers/rummager.rb), [test helper docs](http://www.rubydoc.info/github/alphagov/gds-api-adapters/master/GdsApi/TestHelpers/Rummager))
 
 ## Logging
 

data/lib/gds_api/email_alert_api.rb

@@ -1,8 +1,14 @@
 require_relative 'base'
 require_relative 'exceptions'
 
+# Adapter for the Email Alert API
+#
+# @see https://github.com/alphagov/email-alert-api
 class GdsApi::EmailAlertApi < GdsApi::Base
 
+  # Get or Post subscriber list
+  #
+  # @param attributes [Hash] document_type, links, tags used to search existing subscriber lists
   def find_or_create_subscriber_list(attributes)
     tags = attributes["tags"]
     links = attributes["links"]
@@ -23,10 +29,33 @@ class GdsApi::EmailAlertApi < GdsApi::Base
     create_subscriber_list(attributes)
   end
 
+  # Post notification
+  #
+  # @param publication [Hash] Valid publication attributes
   def send_alert(publication)
     post_json!("#{endpoint}/notifications", publication)
   end
 
+  # Get notifications
+  #
+  # @option start_at [String] Optional GovDelivery bulletin id to page back through notifications
+  #
+  # @return [Hash] notifications
+  def notifications(start_at=nil)
+    url = "#{endpoint}/notifications"
+    url += "?start_at=#{start_at}" if start_at
+    get_json!(url)
+  end
+
+  # Get notification
+  #
+  # @param id [String] GovDelivery bulletin id
+  #
+  # @return [Hash] notification
+  def notification(id)
+    get_json!("#{endpoint}/notifications/#{id}")
+  end
+
 private
 
   def search_subscriber_list(params)

data/lib/gds_api/test_helpers/email_alert_api.rb

@@ -74,6 +74,27 @@ module GdsApi
         assert_requested(:post, notifications_url, times: 1, &matcher)
       end
 
+      def email_alert_api_has_notifications(notifications, start_at=nil)
+        url = notifications_url
+        url += "?start_at=#{start_at}" if start_at
+        url_regexp = Regexp.new("^#{Regexp.escape(url)}$")
+
+        stub_request(:get, url_regexp)
+          .to_return(
+            status: 200,
+            body: notifications.to_json
+          )
+      end
+
+      def email_alert_api_has_notification(notification)
+        url = "#{notifications_url}/#{notification['web_service_bulletin']['to_param']}"
+
+        stub_request(:get, url).to_return(
+          status: 200,
+          body: notification.to_json
+        )
+      end
+
     private
 
       def subscriber_lists_url(attributes = nil)

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '30.2.1'
+  VERSION = '30.3.0'
 end

data/test/email_alert_api_test.rb

@@ -159,4 +159,33 @@ describe GdsApi::EmailAlertApi do
       end
     end
   end
+  describe "notifications" do
+    it "retrieves notifications" do
+      stubbed_request = email_alert_api_has_notifications([
+        {"subject" => "Foo"}, {"subject" => "Bar"}
+      ])
+      api_client.notifications
+      assert_requested(stubbed_request)
+    end
+
+    it "uses the start_at param if present" do
+      stubbed_request = email_alert_api_has_notifications([
+        {"subject" => "Foo"}, {"subject" => "Bar"}
+      ], "101AA")
+      api_client.notifications("101AA")
+      assert_requested(stubbed_request)
+    end
+  end
+
+  describe "notification" do
+    before do
+      @stubbed_request = email_alert_api_has_notification({
+        "web_service_bulletin" => { "to_param" => "10001001" }
+      })
+    end
+    it "retrieves a notification by id" do
+      api_client.notification("10001001")
+      assert_requested(@stubbed_request)
+    end
+  end
 end

metadata

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