gds-api-adapters 79.0.0 → 79.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e10a938b3148397b6c9a4ff3a06a6105f4d07ad02a80b4103440cd065b92d4ba
-  data.tar.gz: e246e963aa42bcb62dc1479a076713ce4fefbcac40ca00e07b7f492a54396517
+  metadata.gz: be2d6d94c4da753ae82eabe4728e9e21d385c8d7332baa5682eed54ee4d41d37
+  data.tar.gz: c0435733dd835d528ae596002542aa426030b494bcb7c839ba80b8020322e089
 SHA512:
-  metadata.gz: b2ee8e777bac9cbefe10b5497c5ec6cd48e4f7566cb07eff82bfa35a800c1fa28c99c3bfcd93c2dfa20fc63205c65142ddc4bc4e649ab1fa312565ea03bb324c
-  data.tar.gz: 5764cc76a32646d8162f37d76098540acfe10e10d2c27f91504cf72c3a9abc3d8802f01c9d4cd64df920a503184e605ce718c1e0229a96aad52c2fda8e29f5cc
+  metadata.gz: f731412f3b2172d700bae052a934b30051213c28dd8b6217154196193b5c6c246efeac1b682b199cce2f8f1d38974c7864fb3aca682219492da8ccf92f41b2b0
+  data.tar.gz: 4e61e4360f445fa5c37e364303893874eedc3004e8e53d6dc0df3ffffbb08e1f0316882860bf9c389bdc12a425cbd2e93aa6ef7823aaa8ed300ae60dc28446f8

data/lib/gds_api/locations_api.rb

@@ -0,0 +1,28 @@
+require_relative "base"
+require_relative "exceptions"
+
+class GdsApi::LocationsApi < GdsApi::Base
+  # Get a list of local custodian codes for a postcode
+  #
+  # @param [String, nil] postcode The postcode for which the custodian codes are requested
+  #
+  # @return [Array] All local custodian codes for a specific postcode
+  def local_custodian_code_for_postcode(postcode)
+    response = get_json("#{endpoint}/locations?postcode=#{postcode}.json")
+
+    return [] if response["results"].nil?
+
+    response["results"].map { |r| r["local_custodian_code"] }.uniq
+  end
+
+  # Get the average coordinates for a postcode
+  #
+  # @param [String, nil] postcode The postcode for which the coordinates are requested
+  #
+  # @return [Hash] The average coordinates (two fields, "latitude" and "longitude") for a specific postcode
+  def coordinates_for_postcode(postcode)
+    response = get_json("#{endpoint}/locations?postcode=#{postcode}.json")
+
+    { "latitude" => response["average_latitude"], "longitude" => response["average_longitude"] } unless response["results"].nil?
+  end
+end

data/lib/gds_api/test_helpers/locations_api.rb

@@ -0,0 +1,38 @@
+module GdsApi
+  module TestHelpers
+    module LocationsApi
+      LOCATIONS_API_ENDPOINT = Plek.current.find("locations-api")
+
+      def stub_locations_api_has_location(postcode, locations)
+        results = []
+        locations.each do |l|
+          results << {
+            "latitude" => l["latitude"],
+            "longitude" => l["longitude"],
+            "postcode" => postcode,
+            "local_custodian_code" => l["local_custodian_code"],
+          }
+        end
+
+        response = {
+          "average_latitude" => results.sum { |r| r["latitude"] } / results.size.to_f,
+          "average_longitude" => results.sum { |r| r["longitude"] } / results.size.to_f,
+          "results" => results,
+        }
+
+        stub_request(:get, "#{LOCATIONS_API_ENDPOINT}/locations?postcode=#{postcode}.json")
+          .to_return(body: response.to_json, status: 200)
+      end
+
+      def stub_locations_api_has_no_location(postcode)
+        stub_request(:get, "#{LOCATIONS_API_ENDPOINT}/locations?postcode=#{postcode}.json")
+          .to_return(body: { "results" => nil }.to_json, status: 200)
+      end
+
+      def stub_locations_api_does_not_have_a_bad_postcode(postcode)
+        stub_request(:get, "#{LOCATIONS_API_ENDPOINT}/locations?postcode=#{postcode}.json")
+         .to_return(body: { "code" => 400, "error" => "Postcode '#{postcode}' is not valid." }.to_json, status: 400)
+      end
+    end
+  end
+end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "79.0.0".freeze
+  VERSION = "79.1.0".freeze
 end

data/lib/gds_api.rb

@@ -10,6 +10,7 @@ require "gds_api/imminence"
 require "gds_api/licence_application"
 require "gds_api/link_checker_api"
 require "gds_api/local_links_manager"
+require "gds_api/locations_api"
 require "gds_api/mapit"
 require "gds_api/maslow"
 require "gds_api/organisations"
@@ -201,4 +202,11 @@ module GdsApi
   def self.worldwide(options = {})
     GdsApi::Worldwide.new(Plek.new.website_root, options)
   end
+
+  # Creates a GdsApi::LocationsApi adapter
+  #
+  # @return [GdsApi::LocationsApi]
+  def self.locations_api(options = {})
+    GdsApi::LocationsApi.new(Plek.find("locations-api"), options)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 79.0.0
+  version: 79.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-25 00:00:00.000000000 Z
+date: 2022-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -385,6 +385,7 @@ files:
 - lib/gds_api/link_checker_api.rb
 - lib/gds_api/list_response.rb
 - lib/gds_api/local_links_manager.rb
+- lib/gds_api/locations_api.rb
 - lib/gds_api/mapit.rb
 - lib/gds_api/maslow.rb
 - lib/gds_api/middleware/govuk_header_sniffer.rb
@@ -409,6 +410,7 @@ files:
 - lib/gds_api/test_helpers/licence_application.rb
 - lib/gds_api/test_helpers/link_checker_api.rb
 - lib/gds_api/test_helpers/local_links_manager.rb
+- lib/gds_api/test_helpers/locations_api.rb
 - lib/gds_api/test_helpers/mapit.rb
 - lib/gds_api/test_helpers/organisations.rb
 - lib/gds_api/test_helpers/publishing_api.rb