gds-api-adapters 32.1.0 → 32.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f7f3f751f921cd3894b47614d1717441d5d28fc
-  data.tar.gz: c54260b9c268b61eacfb800615f0f81d9127dcde
+  metadata.gz: 24f9c7e9942f51ffbe4ceffdfb89fd546c6ad3e2
+  data.tar.gz: d35330309418eca8f623f00f0f8083fc492bde2c
 SHA512:
-  metadata.gz: b4f42f6c9c57dcc553217982501382a32da1afdf69ddbcd98c28e3ea937741805a7825c6ca1cf5ba1d22c5474f2e542ef2928234cbf167bc75a6cd0b9e0b08d0
-  data.tar.gz: 1d061e662f69c3e92e45446f595e3c912acf5a467eec10605d481d3a04c77385d1018f2864e719dfad09d5dbe9eeb9182d0b62b708b1f0982c8e06803b26dbde
+  metadata.gz: 502332ac6755ce764c1ebf3b742f9e8ac6b5f142e36cd236ffc02beee143f76900670547b84ab1ec95d048faa9205765d8f86c72c205b9f94067e1a0f3057952
+  data.tar.gz: cf6f010f3a4e6d945b75083e8a63fe6cf70b7b808ec90d357551bb9e42e5dd972d3652d7a435f9c7907e0cdd7f56328edb21e50ba3fe0e69a09d9634b0f5d007

data/lib/gds_api/local_links_manager.rb

@@ -0,0 +1,9 @@
+require_relative 'base'
+
+class GdsApi::LocalLinksManager < GdsApi::Base
+  def local_link(authority_slug, lgsl, lgil=nil)
+    url = "#{endpoint}/api/link?authority_slug=#{authority_slug}&lgsl=#{lgsl}"
+    url += "&lgil=#{lgil}" if lgil
+    get_json(url)
+  end
+end

data/lib/gds_api/test_helpers/local_links_manager.rb

@@ -0,0 +1,113 @@
+require 'gds_api/test_helpers/json_client_helper'
+
+module GdsApi
+  module TestHelpers
+    module LocalLinksManager
+
+      LOCAL_LINKS_MANAGER_ENDPOINT = Plek.current.find('local_links_manager')
+
+      def local_links_manager_has_a_link(authority_slug:, lgsl:, lgil:, url:)
+        response = {
+          "local_authority" => {
+            "name" => authority_slug.capitalize,
+            "snac" => "00AG",
+            "tier" => "unitary",
+            "homepage_url" => "http://#{authority_slug}.example.com",
+          },
+          "local_interaction" => {
+            "lgsl_code" => lgsl,
+            "lgil_code" => lgil,
+            "url" => url,
+          }
+        }
+
+        stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
+          .with(query: {authority_slug: authority_slug, lgsl: lgsl, lgil: lgil})
+          .to_return(body: response.to_json, status: 200)
+      end
+
+      def local_links_manager_has_no_link(authority_slug:, lgsl:, lgil:)
+        response = {
+          "local_authority" => {
+            "name" => authority_slug.capitalize,
+            "snac" => "00AG",
+            "tier" => "unitary",
+            "homepage_url" => "http://#{authority_slug}.example.com",
+          },
+        }
+
+        stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
+          .with(query: {authority_slug: authority_slug, lgsl: lgsl, lgil: lgil})
+          .to_return(body: response.to_json, status: 200)
+      end
+
+      def local_links_manager_has_no_link_and_no_homepage_url(authority_slug:, lgsl:, lgil:)
+        response = {
+          "local_authority" => {
+            "name" => authority_slug.capitalize,
+            "snac" => "00AG",
+            "tier" => "unitary",
+            "homepage_url" => nil,
+          },
+        }
+
+        stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
+          .with(query: {authority_slug: authority_slug, lgsl: lgsl, lgil: lgil})
+          .to_return(body: response.to_json, status: 200)
+      end
+
+      def local_links_manager_has_a_fallback_link(authority_slug:, lgsl:, lgil:, url:)
+        response = {
+          "local_authority" => {
+            "name" => authority_slug.capitalize,
+            "snac" => "00AG",
+            "tier" => "unitary",
+            "homepage_url" => "http://#{authority_slug}.example.com",
+          },
+          "local_interaction" => {
+            "lgsl_code" => lgsl,
+            "lgil_code" => lgil,
+            "url" => url,
+          }
+        }
+
+        stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
+          .with(query: {authority_slug: authority_slug, lgsl: lgsl})
+          .to_return(body: response.to_json, status: 200)
+      end
+
+      def local_links_manager_has_no_fallback_link(authority_slug:, lgsl:)
+        response = {
+          "local_authority" => {
+            "name" => authority_slug.capitalize,
+            "snac" => "00AG",
+            "tier" => "unitary",
+            "homepage_url" => "http://#{authority_slug}.example.com",
+          },
+        }
+
+        stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
+          .with(query: {authority_slug: authority_slug, lgsl: lgsl})
+          .to_return(body: response.to_json, status: 200)
+      end
+
+      def local_links_manager_request_with_missing_parameters(authority_slug, lgsl)
+        # convert nil to an empty string, otherwise query param is not expressed correctly
+        params = { authority_slug: authority_slug || "", lgsl: lgsl || "" }
+
+        stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
+          .with(query: params)
+          .to_return(body: {}.to_json, status: 400)
+      end
+
+      def local_links_manager_does_not_have_required_objects(authority_slug, lgsl, lgil=nil)
+        params = { authority_slug: authority_slug, lgsl: lgsl }
+        params.merge!(lgil: lgil) if lgil
+
+        stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
+          .with(query: params)
+          .to_return(body: {}.to_json, status: 404)
+      end
+    end
+  end
+end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '32.1.0'
+  VERSION = '32.2.0'
 end

data/test/local_links_manager_api_test.rb

@@ -0,0 +1,171 @@
+require "test_helper"
+require "gds_api/local_links_manager"
+require "gds_api/test_helpers/local_links_manager"
+require 'pry'
+
+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 "returns nil when authority_slug is invalid" do
+        local_links_manager_does_not_have_required_objects("hogwarts", 2)
+
+        response = @api.local_link("hogwarts", 2)
+        assert_equal nil, response
+      end
+
+      it "returns nil when LGSL is invalid" do
+        local_links_manager_does_not_have_required_objects("blackburn", 999)
+
+        response = @api.local_link("blackburn", 999)
+        assert_equal nil, response
+      end
+
+      it "returns nil when the LGSL and LGIL combination is invalid" do
+        local_links_manager_does_not_have_required_objects("blackburn", 2, 9)
+
+        response = @api.local_link("blackburn", 2, 9)
+        assert_equal nil, response
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 32.1.0
+  version: 32.2.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-27 00:00:00.000000000 Z
+date: 2016-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -344,6 +344,7 @@ files:
 - lib/gds_api/json_client.rb
 - lib/gds_api/licence_application.rb
 - lib/gds_api/list_response.rb
+- lib/gds_api/local_links_manager.rb
 - lib/gds_api/mapit.rb
 - lib/gds_api/maslow.rb
 - lib/gds_api/middleware/govuk_header_sniffer.rb
@@ -379,6 +380,7 @@ files:
 - lib/gds_api/test_helpers/intent_helpers.rb
 - lib/gds_api/test_helpers/json_client_helper.rb
 - lib/gds_api/test_helpers/licence_application.rb
+- lib/gds_api/test_helpers/local_links_manager.rb
 - lib/gds_api/test_helpers/mapit.rb
 - lib/gds_api/test_helpers/need_api.rb
 - lib/gds_api/test_helpers/organisations.rb
@@ -418,6 +420,7 @@ files:
 - test/json_client_test.rb
 - test/licence_application_api_test.rb
 - test/list_response_test.rb
+- test/local_links_manager_api_test.rb
 - test/mapit_test.rb
 - test/maslow_test.rb
 - test/middleware/govuk_header_sniffer_test.rb
@@ -479,6 +482,7 @@ test_files:
 - test/publishing_api_v2/get_expanded_links_test.rb
 - test/whitehall_admin_api_test.rb
 - test/pp_data_in_test.rb
+- test/local_links_manager_api_test.rb
 - test/publishing_api/special_route_publisher_test.rb
 - test/need_api_test.rb
 - test/publisher_api_test.rb