gds-api-adapters 2.1.0 → 2.2.0

data/lib/gds_api/licence_application.rb

@@ -1,23 +1,22 @@
 require_relative "base"
 
 class GdsApi::LicenceApplication < GdsApi::Base
+  def all_licences
+    get_json!("#{@endpoint}/api/licences")
+  end
+
   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
+    get_json(build_licence_url(id, snac_code))
   end
 
   private
 
-  def build_url(id, snac_code)
+  def build_licence_url(id, snac_code)
     if snac_code
-      "#{@endpoint}/api/#{id}/#{snac_code}"
+      "#{@endpoint}/api/licence/#{id}/#{snac_code}"
     else
-      "#{@endpoint}/api/#{id}"
+      "#{@endpoint}/api/licence/#{id}"
     end
   end
 end

data/lib/gds_api/test_helpers/licence_application.rb

@@ -0,0 +1,24 @@
+require 'gds_api/test_helpers/json_client_helper'
+
+module GdsApi
+  module TestHelpers
+    module LicenceApplication
+      LICENCE_APPLICATION_ENDPOINT = "https://licenceapplication.test.alphagov.co.uk"
+
+      def licence_exists(identifier, licence)
+        licence = licence.to_json unless licence.is_a?(String)
+        stub_request(:get, "#{LICENCE_APPLICATION_ENDPOINT}/api/licence/#{identifier}").
+          with(headers: GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
+          to_return(status: 200,
+            body: licence)
+      end
+
+      def licence_does_not_exist(identifier)
+        stub_request(:get, "#{LICENCE_APPLICATION_ENDPOINT}/api/licence/#{identifier}").
+          with(headers: GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
+          to_return(status: 404,
+            body: "{\"error\": [\"Unrecognised Licence Id: #{identifier}\"]}")
+      end
+    end
+  end
+end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 end

data/test/gds_api_base_test.rb

@@ -11,9 +11,14 @@ class GdsApiBaseTest < MiniTest::Unit::TestCase
   end
 
   def setup
+    @orig_cache = GdsApi::JsonClient.cache
     @api = ConcreteApi.new('test')
   end
 
+  def teardown
+    GdsApi::JsonClient.cache = @orig_cache
+  end
+
   def test_should_construct_escaped_query_string
     api = ConcreteApi.new('test')
     url = api.url_for_slug("slug", "a" => " ", "b" => "/")

data/test/licence_application_api_test.rb

@@ -1,7 +1,13 @@
 require "test_helper"
 require "gds_api/licence_application"
+require "gds_api/test_helpers/licence_application"
 
 class LicenceApplicationApiTest < MiniTest::Unit::TestCase
+  include GdsApi::TestHelpers::LicenceApplication
+
+  def setup
+    @core_url = LICENCE_APPLICATION_ENDPOINT
+  end
 
   def api
     GdsApi::LicenceApplication.new "test"
@@ -11,67 +17,158 @@ class LicenceApplicationApiTest < MiniTest::Unit::TestCase
     assert_equal false, api.nil?
   end
 
-  def test_should_return_nil_if_id_nil
-    assert_equal nil, api.details_for_licence(nil)
+  def test_should_return_list_of_licences
+    stub_request(:get, "#{@core_url}/api/licences").
+      with(headers: GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
+      to_return(:status => 200,
+                :body => <<-EOS
+[
+   {
+      "code":"1324-5-1",
+      "name":"Land drainage consents",
+      "legislation":[
+         "Land Drainage Act 1991"
+      ]
+   },
+   {
+      "code":"695-5-1",
+      "name":"Skip operator licence",
+      "legislation":[
+         "Highways Act 1980, Section 139"
+      ]
+   },
+   {
+      "code":"1251-4-1",
+      "name":"Residential care homes",
+      "legislation":[
+         "Health and Personal Social Services (Quality, Improvement and Regulation) (Northern Ireland) Order 2003"
+      ]
+   }
+]
+EOS
+)
+
+    land_drainage = {
+      "code" => "1324-5-1",
+      "name" => "Land drainage consents",
+      "legislation" => ["Land Drainage Act 1991"],
+    }
+
+    assert_includes api.all_licences, land_drainage
   end
 
-  def test_should_return_an_error_message_if_licence_is_unrecognised
-    stub_request(:get, "https://licenceapplication.test.alphagov.co.uk/api/bloop").
+  def test_should_return_error_message_if_licences_collection_not_found
+    stub_request(:get, "#{@core_url}/api/licences").
       with(headers: GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
-      to_return(status: 404, body: "{\"error\": [\"Unrecognised Licence Id: bloop\"]}")
+      to_return(status: 404,
+        body: "{\"error\": \"Error\"}")
 
-    assert_equal nil, api.details_for_licence("bloop")
+    assert_raises GdsApi::HTTPNotFound do
+      api.all_licences
+    end
+  end
+
+  def test_should_return_nil_if_id_nil
+    assert_nil api.details_for_licence(nil)
+  end
+
+  def test_should_return_nil_if_licence_is_unrecognised
+    licence_does_not_exist('bloop')
+
+    assert_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::DEFAULT_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}}}]}")
+    licence_exists('590001', {"isLocationSpecific" => true, "geographicalAvailability" => ["England","Wales"], "issuingAuthorities" => []})
 
     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}
-                                 }
-                               }]
+      "isLocationSpecific" => true,
+      "geographicalAvailability" => ["England", "Wales"],
+      "issuingAuthorities" => []
     }
 
-    assert_equal expected, api.details_for_licence("590001")
+    assert_equal expected, api.details_for_licence("590001").to_hash
   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::DEFAULT_REQUEST_HEADERS).
-      to_return(status: 404, body: "{\"error\": [\"Unrecognised SNAC: bleep\"]}")
+  def test_should_return_nil_for_bad_snac_code_entry
+    licence_does_not_exist('590001/bleep')
 
-    assert_equal nil, api.details_for_licence("590001", "bleep")
+    assert_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::DEFAULT_REQUEST_HEADERS).
-      to_return(status: 404, body: "{\"error\": [\"Unrecognised Licence Id: bloop\", \"Unrecognised SNAC: bleep\"]}")
+  def test_should_return_nil_for_bad_licence_id_and_snac_code
+    licence_does_not_exist('bloop/bleep')
 
-    assert_equal nil, api.details_for_licence("bloop", "bleep")
+    assert_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").
+    stub_request(:get, "#{@core_url}/api/licence/590001/sw10").
       with(headers: GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
-      to_return(status: 200, body: "{\"error\": [\"Licence not available in the provided snac area\"], \"geographicalAvailability\": [\"Scotland\", \"NI\"]}")
+      to_return(status: 404,
+                body: "{\"error\": \"No authorities found for the licence 590001 and for the snacCode sw10\"}")
 
-    expected = {
-      "error" => ["Licence not available in the provided snac area"],
-      "geographicalAvailability" => ["Scotland", "NI"]
-    }
+    assert_nil api.details_for_licence("590001", "sw10")
+  end
 
-    assert_equal expected, api.details_for_licence("590001", "sw10")
+  def test_should_return_full_licence_details_with_location_specific_information
+    licence_exists('866-5-1/00AA', <<-EOS
+{
+   "isLocationSpecific":true,
+   "geographicalAvailability":[
+      "England",
+      "Wales"
+   ],
+   "issuingAuthorities":[
+      {
+         "authorityName":"City of London",
+         "authorityInteractions":{
+            "apply":[
+               {
+                  "url":"https://www.gov.uk/motor-salvage-operator-registration/city-of-london/apply-1",
+                  "usesLicensify":true,
+                  "description":"Application to register as a motor salvage operator",
+                  "payment":"none"
+               }
+            ],
+            "renew":[
+               {
+                  "url":"https://www.gov.uk/motor-salvage-operator-registration/city-of-london/renew-1",
+                  "usesLicensify":true,
+                  "description":"Application to renew a registration as motor salvage operator",
+                  "payment":"none"
+               }
+            ],
+            "change":[
+               {
+                  "url":"https://www.gov.uk/motor-salvage-operator-registration/city-of-london/change-1",
+                  "usesLicensify":true,
+                  "description":"Application to change a registration as motor salvage operator",
+                  "payment":"none"
+               },
+               {
+                  "url":"https://www.gov.uk/motor-salvage-operator-registration/city-of-london/change-2",
+                  "usesLicensify":true,
+                  "description":"Application to surrender a registration as motor salvage operator",
+                  "payment":"none"
+               }
+            ]
+         }
+      }
+   ]
+}
+EOS
+)
+
+    response = api.details_for_licence("866-5-1", "00AA")
+
+    assert_equal true, response["isLocationSpecific"]
+
+    assert_includes response["issuingAuthorities"][0]["authorityInteractions"]["apply"], {
+      "url" => "https://www.gov.uk/motor-salvage-operator-registration/city-of-london/apply-1",
+      "usesLicensify" => true,
+      "description" => "Application to register as a motor salvage operator",
+      "payment" => "none"
+    }
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors: 
 - James Stewart
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-17 00:00:00 Z
+date: 2012-09-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plek
@@ -157,6 +157,7 @@ files:
 - lib/gds_api/content_api.rb
 - lib/gds_api/licence_application.rb
 - lib/gds_api/test_helpers/content_api.rb
+- lib/gds_api/test_helpers/licence_application.rb
 - lib/gds_api/test_helpers/contactotron.rb
 - lib/gds_api/test_helpers/json_client_helper.rb
 - lib/gds_api/test_helpers/publisher.rb
@@ -202,7 +203,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2247885112967886087
+      hash: -4439184631815807956
       segments: 
       - 0
       version: "0"
@@ -211,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2247885112967886087
+      hash: -4439184631815807956
       segments: 
       - 0
       version: "0"