gds-api-adapters 5.3.0 → 5.4.0

data/lib/gds_api/gov_uk_delivery.rb

@@ -0,0 +1,42 @@
+require_relative 'base'
+require_relative 'exceptions'
+require 'json'
+
+class GdsApi::GovUkDelivery < GdsApi::Base
+  include GdsApi::ExceptionHandling
+
+  def initialize(endpoint_url, options={})
+    super(endpoint_url, options.merge({timeout: 10}))
+  end
+
+  def subscribe(email, feed_urls)
+    data = {email: email, feed_urls: feed_urls}
+    url = "#{base_url}/subscriptions"
+    post_url(url, data)
+  end
+
+  def topic(feed_url, title, description=nil)
+    data = {feed_url: feed_url, title: title, description: description}
+    url = "#{base_url}/lists"
+    post_url(url, data)
+  end
+
+  def notify(feed_urls, subject, body)
+    data = {feed_urls: feed_urls, subject: subject, body: body}
+    url = "#{base_url}/notifications"
+    post_url(url, data)
+  end
+
+private
+  def base_url
+    endpoint
+  end
+
+  def post_url(url, data)
+    if ! @options[:noop]
+      post_json(url, data)
+    elsif @options[:noop] && @options[:stdout]
+      puts "Would POST #{data.to_json} to #{url}"
+    end
+  end
+end

data/lib/gds_api/test_helpers/gov_uk_delivery.rb

@@ -0,0 +1,14 @@
+require 'json'
+
+module GdsApi
+  module TestHelpers
+    module GovUkDelivery
+
+      GOVUK_DELIVERY_ENDPOINT = Plek.current.find('govuk-delivery')
+
+      def stub_gov_uk_delivery_post_request(method, params_hash)
+        stub_request(:post, "#{GOVUK_DELIVERY_ENDPOINT}/#{method}").with(body: params_hash.to_json)
+      end
+    end
+  end
+end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '5.3.0'
+  VERSION = '5.4.0'
 end

data/test/content_api_test.rb

@@ -494,10 +494,6 @@ describe GdsApi::ContentApi do
       end
     end
 
-    it "should do the request in batches if the request path would otherwise exceed 2000 chars" do
-
-    end
-
     describe "test helpers" do
       it "should have representative test helpers" do
         setup_content_api_business_support_schemes_stubs

data/test/gov_uk_delivery_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+require 'gds_api/gov_uk_delivery'
+require 'gds_api/test_helpers/gov_uk_delivery'
+
+describe GdsApi::GovUkDelivery do
+
+  include GdsApi::TestHelpers::GovUkDelivery
+
+  before do
+    @base_api_url = Plek.current.find("govuk-delivery")
+    @api = GdsApi::GovUkDelivery.new(@base_api_url)
+  end
+
+  it "can create a topic" do
+    expected_payload = { feed_url: 'http://example.com/feed', title: 'Title', description: nil }
+    stub = stub_gov_uk_delivery_post_request('lists', expected_payload).to_return(created_response_hash)
+
+    assert @api.topic("http://example.com/feed", "Title")
+    assert_requested stub
+  end
+
+  it "can subscribe a new email" do
+    expected_payload = { email: 'me@example.com', feed_urls: ['http://example.com/feed'] }
+    stub = stub_gov_uk_delivery_post_request('subscriptions', expected_payload).to_return(created_response_hash)
+
+    assert @api.subscribe('me@example.com', ['http://example.com/feed'])
+    assert_requested stub
+  end
+
+  it "can post a notification" do
+    expected_payload = { feed_urls: ['http://example.com/feed'], subject: 'Test', body: '<p>Something</p>'}
+    stub = stub_gov_uk_delivery_post_request('notifications', expected_payload).to_return(created_response_hash)
+
+    assert @api.notify(['http://example.com/feed'], 'Test', '<p>Something</p>')
+    assert_requested stub
+  end
+
+  private
+
+  def created_response_hash
+    { body: '', status: 201 }
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 5.3.0
+  version: 5.4.0
 platform: ruby
 authors: 
 - James Stewart
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-27 00:00:00 Z
+date: 2013-04-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plek
@@ -187,51 +187,54 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/gds_api/gov_uk_delivery.rb
 - lib/gds_api/version.rb
-- lib/gds_api/base.rb
-- lib/gds_api/licence_application.rb
+- lib/gds_api/publisher.rb
 - lib/gds_api/panopticon/registerer.rb
-- lib/gds_api/needotron.rb
-- lib/gds_api/imminence.rb
-- lib/gds_api/rummager.rb
+- lib/gds_api/asset_manager.rb
 - lib/gds_api/content_api.rb
-- lib/gds_api/mapit.rb
-- lib/gds_api/exceptions.rb
-- lib/gds_api/json_client.rb
-- lib/gds_api/core-ext/openstruct.rb
-- lib/gds_api/response.rb
-- lib/gds_api/content_api/list_response.rb
-- lib/gds_api/content_api/response.rb
-- lib/gds_api/publisher.rb
-- lib/gds_api/test_helpers/licence_application.rb
-- lib/gds_api/test_helpers/imminence.rb
+- lib/gds_api/imminence.rb
+- lib/gds_api/test_helpers/gov_uk_delivery.rb
+- lib/gds_api/test_helpers/publisher.rb
+- lib/gds_api/test_helpers/asset_manager.rb
 - lib/gds_api/test_helpers/content_api.rb
+- lib/gds_api/test_helpers/imminence.rb
+- lib/gds_api/test_helpers/licence_application.rb
 - lib/gds_api/test_helpers/mapit.rb
 - lib/gds_api/test_helpers/content_api/artefact_stub.rb
-- lib/gds_api/test_helpers/publisher.rb
-- lib/gds_api/test_helpers/asset_manager.rb
 - lib/gds_api/test_helpers/panopticon.rb
 - lib/gds_api/test_helpers/json_client_helper.rb
-- lib/gds_api/part_methods.rb
-- lib/gds_api/asset_manager.rb
+- lib/gds_api/licence_application.rb
+- lib/gds_api/base.rb
+- lib/gds_api/mapit.rb
+- lib/gds_api/json_client.rb
+- lib/gds_api/response.rb
+- lib/gds_api/content_api/list_response.rb
+- lib/gds_api/content_api/response.rb
+- lib/gds_api/rummager.rb
 - lib/gds_api/panopticon.rb
+- lib/gds_api/core-ext/openstruct.rb
+- lib/gds_api/part_methods.rb
+- lib/gds_api/needotron.rb
+- lib/gds_api/exceptions.rb
 - lib/gds_api/helpers.rb
 - README.md
 - Rakefile
-- test/rummager_test.rb
+- test/panopticon_api_test.rb
 - test/publisher_api_test.rb
-- test/content_api_response_test.rb
-- test/licence_application_api_test.rb
 - test/mapit_test.rb
-- test/panopticon_api_test.rb
+- test/gov_uk_delivery_test.rb
+- test/rummager_test.rb
 - test/imminence_api_test.rb
-- test/json_client_test.rb
-- test/test_helper.rb
-- test/fixtures/hello.txt
+- test/panopticon_registerer_test.rb
+- test/content_api_test.rb
 - test/asset_manager_test.rb
+- test/content_api_response_test.rb
+- test/json_client_test.rb
 - test/gds_api_base_test.rb
-- test/content_api_test.rb
-- test/panopticon_registerer_test.rb
+- test/licence_application_api_test.rb
+- test/fixtures/hello.txt
+- test/test_helper.rb
 homepage: http://github.com/alphagov/gds-api-adapters
 licenses: []
 
@@ -245,7 +248,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3192296895891701275
+      hash: -1093811920964553750
       segments: 
       - 0
       version: "0"
@@ -254,7 +257,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3192296895891701275
+      hash: -1093811920964553750
       segments: 
       - 0
       version: "0"
@@ -266,17 +269,18 @@ signing_key:
 specification_version: 3
 summary: Adapters to work with GDS APIs
 test_files: 
-- test/rummager_test.rb
+- test/panopticon_api_test.rb
 - test/publisher_api_test.rb
-- test/content_api_response_test.rb
-- test/licence_application_api_test.rb
 - test/mapit_test.rb
-- test/panopticon_api_test.rb
+- test/gov_uk_delivery_test.rb
+- test/rummager_test.rb
 - test/imminence_api_test.rb
-- test/json_client_test.rb
-- test/test_helper.rb
-- test/fixtures/hello.txt
+- test/panopticon_registerer_test.rb
+- test/content_api_test.rb
 - test/asset_manager_test.rb
+- test/content_api_response_test.rb
+- test/json_client_test.rb
 - test/gds_api_base_test.rb
-- test/content_api_test.rb
-- test/panopticon_registerer_test.rb
+- test/licence_application_api_test.rb
+- test/fixtures/hello.txt
+- test/test_helper.rb