gds-api-adapters 38.1.0 → 39.0.0

data/test/licence_application_api_test.rb

@@ -1,196 +0,0 @@
-require "test_helper"
-require "gds_api/licence_application"
-require "gds_api/test_helpers/licence_application"
-
-class LicenceApplicationApiTest < Minitest::Test
-  include GdsApi::TestHelpers::LicenceApplication
-
-  def setup
-    @core_url = LICENCE_APPLICATION_ENDPOINT
-  end
-
-  def api
-    GdsApi::LicenceApplication.new LICENCE_APPLICATION_ENDPOINT
-  end
-
-  def test_should_not_be_nil
-    assert_equal false, api.nil?
-  end
-
-  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_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\": \"Error\"}")
-
-    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_raise_if_licence_is_unrecognised
-    licence_does_not_exist('bloop')
-
-    assert_raises(GdsApi::HTTPNotFound) do
-      api.details_for_licence("bloop")
-    end
-  end
-
-  def test_should_provide_full_licence_details_for_canonical_id
-    licence_exists('590001', "isLocationSpecific" => true, "geographicalAvailability" => %w(England Wales), "issuingAuthorities" => [])
-
-    expected = {
-      "isLocationSpecific" => true,
-      "geographicalAvailability" => %w(England Wales),
-      "issuingAuthorities" => []
-    }
-
-    assert_equal expected, api.details_for_licence("590001").to_hash
-  end
-
-  def test_should_raise_for_bad_snac_code_entry
-    licence_does_not_exist('590001/bleep')
-
-    assert_raises(GdsApi::HTTPNotFound) do
-      api.details_for_licence("590001", "bleep")
-    end
-  end
-
-  def test_should_raise_for_bad_licence_id_and_snac_code
-    licence_does_not_exist('bloop/bleep')
-
-    assert_raises(GdsApi::HTTPNotFound) do
-      api.details_for_licence("bloop", "bleep")
-    end
-  end
-
-  def test_should_return_error_message_to_pick_a_relevant_snac_code_for_the_provided_licence_id
-    stub_request(:get, "#{@core_url}/api/licence/590001/sw10").
-      with(headers: GdsApi::JsonClient.default_request_headers).
-      to_return(status: 404,
-                body: "{\"error\": \"No authorities found for the licence 590001 and for the snacCode sw10\"}")
-
-    assert_raises(GdsApi::HTTPNotFound) do
-      api.details_for_licence("590001", "sw10")
-    end
-  end
-
-  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
-
-  def test_should_raise_exception_on_timeout
-    licence_times_out("866-5-1")
-
-    assert_raises GdsApi::TimedOutException do
-      api.details_for_licence("866-5-1")
-    end
-  end
-
-  def test_should_raise_exception_on_api_error
-    licence_returns_error("866-5-1")
-
-    assert_raises GdsApi::HTTPServerError do
-      api.details_for_licence("866-5-1")
-    end
-  end
-end

data/test/list_response_test.rb

@@ -1,189 +0,0 @@
-require_relative 'test_helper'
-require 'gds_api/list_response'
-
-describe GdsApi::ListResponse do
-  describe "accessing results" do
-    before :each do
-    end
-
-    it "should allow Enumerable access to the results array" do
-      data = {
-        "results" => %w(foo bar baz),
-        "total" => 3,
-        "_response_info" => {
-          "status" => "ok",
-        }
-      }
-      response = GdsApi::ListResponse.new(stub(body: data.to_json), nil)
-
-      assert_equal "foo", response.first
-      assert_equal %w(foo bar baz), response.to_a
-      assert response.any?
-    end
-
-    it "should handle an empty result set" do
-      data = {
-        "results" => [],
-        "total" => 0,
-        "_response_info" => {
-          "status" => "ok",
-        }
-      }
-      response = GdsApi::ListResponse.new(stub(body: data.to_json), nil)
-
-      assert_equal [], response.to_a
-      assert ! response.any?
-    end
-  end
-
-  describe "handling pagination" do
-    before :each do
-      page_1 = {
-        "results" => %w(foo1 bar1),
-        "total" => 6,
-        "current_page" => 1, "pages" => 3, "page_size" => 2,
-        "_response_info" => {
-          "status" => "ok",
-          "links" => [
-            { "href" => "http://www.example.com/2", "rel" => "next" },
-            { "href" => "http://www.example.com/1", "rel" => "self" },
-          ]
-        }
-      }
-      page_2 = {
-        "results" => %w(foo2 bar2),
-        "total" => 6,
-        "current_page" => 2, "pages" => 3, "page_size" => 2,
-        "_response_info" => {
-          "status" => "ok",
-          "links" => [
-            { "href" => "http://www.example.com/1", "rel" => "previous" },
-            { "href" => "http://www.example.com/3", "rel" => "next" },
-            { "href" => "http://www.example.com/2", "rel" => "self" },
-          ]
-        }
-      }
-      page_3 = {
-        "results" => %w(foo3 bar3),
-        "total" => 6,
-        "current_page" => 3, "pages" => 3, "page_size" => 2,
-        "_response_info" => {
-          "status" => "ok",
-          "links" => [
-            { "href" => "http://www.example.com/2", "rel" => "previous" },
-            { "href" => "http://www.example.com/3", "rel" => "self" },
-          ]
-        }
-      }
-      @p1_response = stub(
-        body: page_1.to_json,
-        status: 200,
-        headers: {
-          link: '<http://www.example.com/1>; rel="self", <http://www.example.com/2>; rel="next"'
-        }
-      )
-      @p2_response = stub(
-        body: page_2.to_json,
-        status: 200,
-        headers: {
-          link: '<http://www.example.com/2>; rel="self", <http://www.example.com/3>; rel="next", <http://www.example.com/1>; rel="previous"'
-        }
-      )
-      @p3_response = stub(
-        body: page_3.to_json,
-        status: 200,
-        headers: {
-          link: '<http://www.example.com/3>; rel="self", <http://www.example.com/1>; rel="previous"'
-        }
-      )
-
-      @client = stub
-      @client.stubs(:get_list).with("http://www.example.com/1").returns(GdsApi::ListResponse.new(@p1_response, @client))
-      @client.stubs(:get_list).with("http://www.example.com/2").returns(GdsApi::ListResponse.new(@p2_response, @client))
-      @client.stubs(:get_list).with("http://www.example.com/3").returns(GdsApi::ListResponse.new(@p3_response, @client))
-    end
-
-    describe "accessing next page" do
-      it "should allow accessing the next page" do
-        resp = GdsApi::ListResponse.new(@p1_response, @client)
-        assert resp.has_next_page?
-        assert_equal %w(foo2 bar2), resp.next_page['results']
-      end
-
-      it "should return nil with no next page" do
-        resp = GdsApi::ListResponse.new(@p3_response, @client)
-        assert ! resp.has_next_page?
-        assert_equal nil, resp.next_page
-      end
-
-      it "should memoize the next_page" do
-        resp = GdsApi::ListResponse.new(@p1_response, @client)
-        first_call = resp.next_page
-
-        @client.unstub(:get_list) # Necessary because of https://github.com/freerange/mocha/issues/44
-        @client.expects(:get_list).never
-        second_call = resp.next_page
-        assert_equal first_call, second_call
-      end
-    end
-
-    describe "accessing previous page" do
-      it "should allow accessing the previous page" do
-        resp = GdsApi::ListResponse.new(@p2_response, @client)
-        assert resp.has_previous_page?
-        assert_equal %w(foo1 bar1), resp.previous_page['results']
-      end
-
-      it "should return nil with no previous page" do
-        resp = GdsApi::ListResponse.new(@p1_response, @client)
-        assert ! resp.has_previous_page?
-        assert_equal nil, resp.previous_page
-      end
-
-      it "should memoize the previous_page" do
-        resp = GdsApi::ListResponse.new(@p3_response, @client)
-        first_call = resp.previous_page
-
-        @client.unstub(:get_list) # Necessary because of https://github.com/freerange/mocha/issues/44
-        @client.expects(:get_list).never
-        second_call = resp.previous_page
-        assert_equal first_call, second_call
-      end
-    end
-
-    describe "accessing content across all pages" do
-      before :each do
-        @response = GdsApi::ListResponse.new(@p1_response, @client)
-      end
-
-      it "should allow iteration across multiple pages" do
-        assert_equal 6, @response.with_subsequent_pages.count
-        assert_equal %w(foo1 bar1 foo2 bar2 foo3 bar3), @response.with_subsequent_pages.to_a
-        assert_equal %w(foo1 foo2 foo3), @response.with_subsequent_pages.select { |s| s =~ /foo/ }
-      end
-
-      it "should not load a page multiple times" do
-        @client.unstub(:get_list) # Necessary because of https://github.com/freerange/mocha/issues/44
-        @client.expects(:get_list).with("http://www.example.com/2").once.returns(GdsApi::ListResponse.new(@p2_response, @client))
-        @client.expects(:get_list).with("http://www.example.com/3").once.returns(GdsApi::ListResponse.new(@p3_response, @client))
-
-        3.times do
-          @response.with_subsequent_pages.to_a
-        end
-      end
-
-      it "should work with a non-paginated response" do
-        data = {
-          "results" => %w(foo1 bar1),
-          "total" => 2,
-          "_response_info" => {
-            "status" => "ok",
-          }
-        }
-        response = GdsApi::ListResponse.new(stub(body: data.to_json, status: 200, headers: {}), nil)
-
-        assert_equal %w(foo1 bar1), response.with_subsequent_pages.to_a
-      end
-    end
-  end
-end

data/test/local_links_manager_api_test.rb

@@ -1,236 +0,0 @@
-require "test_helper"
-require "gds_api/local_links_manager"
-require "gds_api/test_helpers/local_links_manager"
-
-describe GdsApi::LocalLinksManager do
-  include GdsApi::TestHelpers::LocalLinksManager
-
-  before do
-    @base_api_url = Plek.current.find("local-links-manager")
-    @api = GdsApi::LocalLinksManager.new(@base_api_url)
-  end
-
-  describe "#link" do
-    describe "when making request for specific LGIL" do
-      it "returns the local authority and local interaction details if link present" do
-        local_links_manager_has_a_link(
-          authority_slug: "blackburn",
-          lgsl: 2,
-          lgil: 4,
-          url: "http://blackburn.example.com/abandoned-shopping-trolleys/report"
-        )
-
-        expected_response = {
-          "local_authority" => {
-            "name" => "Blackburn",
-              "snac" => "00AG",
-              "tier" => "unitary",
-              "homepage_url" => "http://blackburn.example.com",
-          },
-          "local_interaction" => {
-            "lgsl_code" => 2,
-            "lgil_code" => 4,
-            "url" => "http://blackburn.example.com/abandoned-shopping-trolleys/report",
-          }
-        }
-
-        response = @api.local_link("blackburn", 2, 4)
-        assert_equal expected_response, response.to_hash
-      end
-
-      it "returns the local authority details only if no link present" do
-        local_links_manager_has_no_link(
-          authority_slug: "blackburn",
-          lgsl: 2,
-          lgil: 4,
-        )
-
-        expected_response = {
-          "local_authority" => {
-            "name" => "Blackburn",
-              "snac" => "00AG",
-              "tier" => "unitary",
-              "homepage_url" => "http://blackburn.example.com",
-          },
-        }
-
-        response = @api.local_link("blackburn", 2, 4)
-        assert_equal expected_response, response.to_hash
-      end
-
-      it 'returns the local authority without a homepage url if no homepage link present' do
-        local_links_manager_has_no_link_and_no_homepage_url(
-          authority_slug: "blackburn",
-          lgsl: 2,
-          lgil: 4,
-        )
-
-        expected_response = {
-          "local_authority" => {
-            "name" => "Blackburn",
-              "snac" => "00AG",
-              "tier" => "unitary",
-              "homepage_url" => nil,
-          },
-        }
-
-        response = @api.local_link("blackburn", 2, 4)
-        assert_equal expected_response, response.to_hash
-      end
-    end
-
-    describe "when making request without LGIL" do
-      it "returns the local authority and local interaction details if link present" do
-        local_links_manager_has_a_fallback_link(
-          authority_slug: "blackburn",
-          lgsl: 2,
-          lgil: 3,
-          url: "http://blackburn.example.com/abandoned-shopping-trolleys/report"
-        )
-
-        expected_response = {
-          "local_authority" => {
-            "name" => "Blackburn",
-              "snac" => "00AG",
-              "tier" => "unitary",
-              "homepage_url" => "http://blackburn.example.com",
-          },
-          "local_interaction" => {
-            "lgsl_code" => 2,
-            "lgil_code" => 3,
-            "url" => "http://blackburn.example.com/abandoned-shopping-trolleys/report",
-          }
-        }
-
-        response = @api.local_link("blackburn", 2)
-        assert_equal expected_response, response.to_hash
-      end
-
-      it "returns the local authority and local interaction details if no link present" do
-        local_links_manager_has_no_fallback_link(
-          authority_slug: "blackburn",
-          lgsl: 2
-        )
-
-        expected_response = {
-          "local_authority" => {
-            "name" => "Blackburn",
-              "snac" => "00AG",
-              "tier" => "unitary",
-              "homepage_url" => "http://blackburn.example.com",
-          },
-        }
-
-        response = @api.local_link("blackburn", 2)
-        assert_equal expected_response, response.to_hash
-      end
-    end
-
-    describe "when making request with missing required parameters" do
-      it "raises HTTPClientError when authority_slug is missing" do
-        local_links_manager_request_with_missing_parameters(nil, 2)
-
-        assert_raises GdsApi::HTTPClientError do
-          @api.local_link(nil, 2)
-        end
-      end
-
-      it "raises HTTPClientError when LGSL is missing" do
-        local_links_manager_request_with_missing_parameters('blackburn', nil)
-
-        assert_raises GdsApi::HTTPClientError do
-          @api.local_link('blackburn', nil)
-        end
-      end
-    end
-
-    describe "when making request with invalid required parameters" do
-      it "raises when authority_slug is invalid" do
-        local_links_manager_does_not_have_required_objects("hogwarts", 2)
-
-        assert_raises(GdsApi::HTTPNotFound) do
-          @api.local_link("hogwarts", 2)
-        end
-      end
-
-      it "raises when LGSL is invalid" do
-        local_links_manager_does_not_have_required_objects("blackburn", 999)
-
-        assert_raises(GdsApi::HTTPNotFound) do
-          @api.local_link("blackburn", 999)
-        end
-      end
-
-      it "raises when the LGSL and LGIL combination is invalid" do
-        local_links_manager_does_not_have_required_objects("blackburn", 2, 9)
-
-        assert_raises(GdsApi::HTTPNotFound) do
-          @api.local_link("blackburn", 2, 9)
-        end
-      end
-    end
-  end
-
-  describe '#local_authority' do
-    describe 'when making a request for a local authority with a parent' do
-      it 'should return the local authority and its parent' do
-        local_links_manager_has_a_district_and_county_local_authority('blackburn', 'rochester')
-
-        expected_response = {
-          "local_authorities" => [
-            {
-              "name" => 'Blackburn',
-              "homepage_url" => "http://blackburn.example.com",
-              "tier" => "district"
-            },
-            {
-              "name" => 'Rochester',
-              "homepage_url" => "http://rochester.example.com",
-              "tier" => "county"
-            }
-          ]
-        }
-
-        response = @api.local_authority('blackburn')
-        assert_equal expected_response, response.to_hash
-      end
-    end
-
-    describe 'when making a request for a local authority without a parent' do
-      it 'should return the local authority' do
-        local_links_manager_has_a_local_authority('blackburn')
-
-        expected_response = {
-          "local_authorities" => [
-            {
-              "name" => 'Blackburn',
-              "homepage_url" => "http://blackburn.example.com",
-              "tier" => "unitary"
-            }
-          ]
-        }
-
-        response = @api.local_authority('blackburn')
-        assert_equal expected_response, response.to_hash
-      end
-    end
-
-    describe 'when making a request without the required parameters' do
-      it "raises HTTPClientError when authority_slug is missing" do
-        local_links_manager_request_without_local_authority_slug
-
-        assert_raises GdsApi::HTTPClientError do
-          @api.local_authority(nil)
-        end
-      end
-    end
-
-    describe 'when making a request with invalid required parameters' do
-      it "raises when authority_slug is invalid" do
-        local_links_manager_does_not_have_an_authority("hogwarts")
-
-        assert_raises(GdsApi::HTTPNotFound) { @api.local_authority("hogwarts") }
-      end
-    end
-  end
-end