gds-api-adapters 0.2.3 → 1.0.0

data/lib/gds_api/base.rb

@@ -18,7 +18,8 @@ class GdsApi::Base
   end
 
   def_delegators :client, :get_json, :post_json, :post_json!,
-                          :put_json, :put_json!, :get_raw
+                          :put_json, :put_json!, :delete_json!,
+                          :get_raw
 
   attr_reader :options
 

data/lib/gds_api/json_client.rb

@@ -1,6 +1,7 @@
 require_relative 'response'
 require_relative 'exceptions'
 require_relative 'version'
+require 'net/http'
 require 'lrucache'
 
 module GdsApi
@@ -67,6 +68,10 @@ module GdsApi
       do_json_request(Net::HTTP::Put, url, params)
     end
 
+    def delete_json!(url, params = nil)
+      do_request(Net::HTTP::Delete, url, params)
+    end
+
     private
     def do_raw_request(method_class, url, params = nil)
       response, loggable = do_request(method_class, url, params)

data/lib/gds_api/licence_application.rb

@@ -0,0 +1,23 @@
+require_relative "base"
+
+class GdsApi::LicenceApplication < GdsApi::Base
+  def details_for_licence(id, snac_code = nil)
+    return nil if id.nil?
+
+    if response = get_json(build_url(id, snac_code))
+      response.to_hash
+    else
+      nil
+    end
+  end
+
+  private
+
+  def build_url(id, snac_code)
+    if snac_code
+      "#{@endpoint}/api/#{id}/#{snac_code}"
+    else
+      "#{@endpoint}/api/#{id}"
+    end
+  end
+end

data/lib/gds_api/panopticon/registerer.rb

@@ -12,7 +12,6 @@ module GdsApi
         @kind = options[:kind] || 'custom-application'
         @panopticon = options[:panopticon]
         @platform = options[:platform] || Plek.current.environment
-        @timeout = options[:timeout] || 10
       end
 
       def record_to_artefact(record)
@@ -22,7 +21,7 @@ module GdsApi
           kind: kind,
           name: record.title,
           description: record.description,
-          live: record.live
+          state: record.state
         }
         if rendering_app
           hash[:rendering_app] = rendering_app
@@ -60,7 +59,7 @@ module GdsApi
 
       def panopticon
         options = {
-          timeout: @timeout
+          timeout: 5
         }
         @panopticon ||= GdsApi::Panopticon.new(@platform, options.merge(panopticon_api_credentials))
       end

data/lib/gds_api/panopticon.rb

@@ -45,6 +45,10 @@ class GdsApi::Panopticon < GdsApi::Base
     put_artefact(id_or_slug, artefact)
   end
 
+  def delete_artefact!(id_or_slug)
+    delete_json!("#{base_url}/#{id_or_slug}.json")
+  end
+
   def curated_lists
     get_json("#{@endpoint}/curated_lists.json").to_hash
   end

data/lib/gds_api/test_helpers/imminence.rb

@@ -5,13 +5,12 @@ module GdsApi
     module Imminence
       def imminence_has_places(latitude, longitude, details)
         response = JSON.dump(details['details'])
-        stub_request(:get, "http://imminence.test.alphagov.co.uk/places/#{details['slug']}.json").
-          with(:query => {"lat" => latitude, "lng" => longitude, "limit" => "5"}).
-          to_return(:status => 200, :body => response, :headers => {})
 
-        stub_request(:get, "https://imminence.test.alphagov.co.uk/places/#{details['slug']}.json").
+        ["http", "https"].each do |protocol|
+          stub_request(:get, "#{protocol}://imminence.test.alphagov.co.uk/places/#{details['slug']}.json").
           with(:query => {"lat" => latitude, "lng" => longitude, "limit" => "5"}).
-            to_return(:status => 200, :body => response, :headers => {})
+          to_return(:status => 200, :body => response, :headers => {})
+        end
       end
     end
   end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '0.2.3'
+  VERSION = '1.0.0'
 end

data/test/licence_application_api_test.rb

@@ -0,0 +1,77 @@
+require "test_helper"
+require "gds_api/licence_application"
+
+class LicenceApplicationApiTest < MiniTest::Unit::TestCase
+
+  def api
+    GdsApi::LicenceApplication.new "test"
+  end
+
+  def test_should_not_be_nil
+    assert_equal false, api.nil?
+  end
+
+  def test_should_return_nil_if_id_nil
+    assert_equal nil, api.details_for_licence(nil)
+  end
+
+  def test_should_return_an_error_message_if_licence_is_unrecognised
+    stub_request(:get, "https://licenceapplication.test.alphagov.co.uk/api/bloop").
+      with(headers: GdsApi::JsonClient::REQUEST_HEADERS).
+      to_return(status: 404, body: "{\"error\": [\"Unrecognised Licence Id: bloop\"]}")
+
+    assert_equal nil, api.details_for_licence("bloop")
+  end
+
+  def test_should_provide_full_licence_details_for_canonical_id
+    stub_request(:get, "https://licenceapplication.test.alphagov.co.uk/api/590001").
+      with(headers: GdsApi::JsonClient::REQUEST_HEADERS).
+      to_return(status: 200, body: "{\"issuingAuthorityType\":\"non-geographical\",\"geographicalAvailability\":\"England\",\"issuingAuthorities\":[{\"authorityName\":\"Authority Name\",\"interactions\":{\"apply\":{\"url\":\"www.gov.uk\",\"usesLicensify\":true,\"description\":\"Custom description\",\"payment\":\"none\",\"paymentAmount\":0}}}]}")
+
+    expected = {
+      "issuingAuthorityType" => "non-geographical",
+      "geographicalAvailability" => "England",
+      "issuingAuthorities" => [{"authorityName" => "Authority Name",
+                                 "interactions" => {
+                                   "apply" => {
+                                     "url" => "www.gov.uk",
+                                     "usesLicensify" => true,
+                                     "description" => "Custom description",
+                                     "payment" => "none",
+                                     "paymentAmount" => 0}
+                                 }
+                               }]
+    }
+
+    assert_equal expected, api.details_for_licence("590001")
+  end
+
+  def test_should_return_an_error_message_for_bad_snac_code_entry
+    stub_request(:get, "https://licenceapplication.test.alphagov.co.uk/api/590001/bleep").
+      with(headers: GdsApi::JsonClient::REQUEST_HEADERS).
+      to_return(status: 404, body: "{\"error\": [\"Unrecognised SNAC: bleep\"]}")
+
+    assert_equal nil, api.details_for_licence("590001", "bleep")
+  end
+
+  def test_should_return_error_messages_for_bad_licence_id_and_snac_code
+    stub_request(:get, "https://licenceapplication.test.alphagov.co.uk/api/bloop/bleep").
+      with(headers: GdsApi::JsonClient::REQUEST_HEADERS).
+      to_return(status: 404, body: "{\"error\": [\"Unrecognised Licence Id: bloop\", \"Unrecognised SNAC: bleep\"]}")
+
+    assert_equal nil, api.details_for_licence("bloop", "bleep")
+  end
+
+  def test_should_return_error_message_to_pick_a_relevant_snac_code_for_the_provided_licence_id
+    stub_request(:get, "https://licenceapplication.test.alphagov.co.uk/api/590001/sw10").
+      with(headers: GdsApi::JsonClient::REQUEST_HEADERS).
+      to_return(status: 200, body: "{\"error\": [\"Licence not available in the provided snac area\"], \"geographicalAvailability\": [\"Scotland\", \"NI\"]}")
+
+    expected = {
+      "error" => ["Licence not available in the provided snac area"],
+      "geographicalAvailability" => ["Scotland", "NI"]
+    }
+
+    assert_equal expected, api.details_for_licence("590001", "sw10")
+  end
+end

data/test/panopticon_api_test.rb

@@ -30,7 +30,7 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
       kind: 'custom-application',
       name: 'MyFoo',
       description: 'A custom foo of great customness.',
-      live: true
+      state: 'live'
     }
   end
 
@@ -95,6 +95,15 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
     api.update_artefact(1, basic_artefact)
   end
 
+  def test_can_delete_an_artefact
+    url = "#{PANOPTICON_ENDPOINT}/artefacts/1.json"
+    stub_request(:delete, url)
+      .with(body: "")
+      .to_return(status: 200, body: '{}')
+
+    api.delete_artefact!(1)
+  end
+
   def test_can_use_basic_auth
     credentials = {user: 'fred', password: 'secret'}
     api = GdsApi::Panopticon.new('test', endpoint_url: 'http://some.url', basic_auth: credentials)

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.3
+  version: 1.0.0
 platform: ruby
 authors: 
 - James Stewart
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-31 00:00:00 Z
+date: 2012-08-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plek
@@ -143,36 +143,37 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/gds_api/test_helpers/contactotron.rb
-- lib/gds_api/test_helpers/json_client_helper.rb
+- lib/gds_api/version.rb
+- lib/gds_api/publisher.rb
+- lib/gds_api/panopticon/registerer.rb
+- lib/gds_api/typhoeus_client.rb
+- lib/gds_api/imminence.rb
+- lib/gds_api/contactotron.rb
 - lib/gds_api/test_helpers/publisher.rb
-- lib/gds_api/test_helpers/panopticon.rb
 - lib/gds_api/test_helpers/imminence.rb
-- lib/gds_api/part_methods.rb
-- lib/gds_api/needotron.rb
-- lib/gds_api/typhoeus_client.rb
+- lib/gds_api/test_helpers/contactotron.rb
+- lib/gds_api/test_helpers/panopticon.rb
+- lib/gds_api/test_helpers/json_client_helper.rb
+- lib/gds_api/licence_application.rb
+- lib/gds_api/base.rb
 - lib/gds_api/json_client.rb
-- lib/gds_api/contactotron.rb
-- lib/gds_api/oauth2_client.rb
 - lib/gds_api/response.rb
-- lib/gds_api/panopticon/registerer.rb
-- lib/gds_api/publisher.rb
-- lib/gds_api/exceptions.rb
-- lib/gds_api/version.rb
-- lib/gds_api/helpers.rb
-- lib/gds_api/base.rb
 - lib/gds_api/panopticon.rb
 - lib/gds_api/core-ext/openstruct.rb
-- lib/gds_api/imminence.rb
+- lib/gds_api/oauth2_client.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/contactotron_api_test.rb
-- test/json_client_test.rb
-- test/publisher_api_test.rb
-- test/panopticon_registerer_test.rb
 - test/panopticon_api_test.rb
-- test/test_helper.rb
+- test/publisher_api_test.rb
+- test/json_client_test.rb
 - test/gds_api_base_test.rb
+- test/licence_application_api_test.rb
+- test/test_helper.rb
 homepage: http://github.com/alphagov/gds-api-adapters
 licenses: []
 
@@ -186,7 +187,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 694492284820059124
+      hash: -2151341373007717106
       segments: 
       - 0
       version: "0"
@@ -195,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 694492284820059124
+      hash: -2151341373007717106
       segments: 
       - 0
       version: "0"
@@ -208,9 +209,9 @@ specification_version: 3
 summary: Adapters to work with GDS APIs
 test_files: 
 - test/contactotron_api_test.rb
-- test/json_client_test.rb
-- test/publisher_api_test.rb
-- test/panopticon_registerer_test.rb
 - test/panopticon_api_test.rb
-- test/test_helper.rb
+- test/publisher_api_test.rb
+- test/json_client_test.rb
 - test/gds_api_base_test.rb
+- test/licence_application_api_test.rb
+- test/test_helper.rb

data/test/panopticon_registerer_test.rb

@@ -1,55 +0,0 @@
-require_relative 'test_helper'
-require 'gds_api/panopticon'
-
-describe GdsApi::Panopticon::Registerer do
-
-
-  describe "creating an instance of the panopticon client" do
-    describe "setting the platform" do
-      it "should create an instance using the current Plek environment as the platform by default" do
-        Plek.stubs(:current).returns(stub(environment: "Something"))
-
-        GdsApi::Panopticon.expects(:new).with("Something", anything()).returns(:panopticon_instance)
-        r = GdsApi::Panopticon::Registerer.new({})
-        assert_equal :panopticon_instance, r.send(:panopticon)
-      end
-
-      it "should allow overriding the platform" do
-        Plek.stubs(:current).returns(stub(environment: "Something"))
-
-        GdsApi::Panopticon.expects(:new).with("Something_else", anything()).returns(:panopticon_instance)
-        r = GdsApi::Panopticon::Registerer.new({platform: "Something_else"})
-        assert_equal :panopticon_instance, r.send(:panopticon)
-      end
-    end
-
-    describe "setting other options" do
-      it "should create an instance with a default timeout of 10 seconds" do
-        GdsApi::Panopticon.expects(:new).with(anything(), {timeout: 10}).returns(:panopticon_instance)
-        r = GdsApi::Panopticon::Registerer.new({})
-        assert_equal :panopticon_instance, r.send(:panopticon)
-      end
-
-      it "should allow overriding the timeout" do
-        GdsApi::Panopticon.expects(:new).with(anything(), {timeout: 15}).returns(:panopticon_instance)
-        r = GdsApi::Panopticon::Registerer.new({timeout: 15})
-        assert_equal :panopticon_instance, r.send(:panopticon)
-      end
-
-      it "shoule merge in the api credentials" do
-        GdsApi::Panopticon::Registerer.any_instance.stubs(:panopticon_api_credentials).returns({foo: "Bar", baz: "kablooie"})
-        GdsApi::Panopticon.expects(:new).with(anything(), {timeout: 10, foo: "Bar", baz: "kablooie"}).returns(:panopticon_instance)
-        r = GdsApi::Panopticon::Registerer.new({})
-        assert_equal :panopticon_instance, r.send(:panopticon)
-      end
-    end
-
-    it "should memoize the panopticon instance" do
-      GdsApi::Panopticon.expects(:new).once.returns(:panopticon_instance)
-      r = GdsApi::Panopticon::Registerer.new({})
-
-      assert_equal :panopticon_instance, r.send(:panopticon)
-      assert_equal :panopticon_instance, r.send(:panopticon)
-    end
-  end
-end