gds-api-adapters 84.0.0 → 85.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebd8c9876a6c89de5d0fdae4fcee5466c37e79e64d6841b02bb52ec581876166
-  data.tar.gz: 64702ddd905480c111b7da1da758825d15d79d351dc9c4c14fd62308f16ab374
+  metadata.gz: 2b0dc3a7a3430d48165ca6e1b8720675dc9a1e5a94e8180d881d10f55af0c3a1
+  data.tar.gz: d12927fcfda065d8f8e9a51fbf01bcca3a4a8dd9e8b77550ed7cba34cb3b5145
 SHA512:
-  metadata.gz: 177b9edcbb43ea4b9c5b0bd3df452e69a14458af851cb7339524a10c6f5a6d8439db588a9725350a9424ea336dfd2f464763be036112790be9d15ce48d98bde7
-  data.tar.gz: c0ed5d8e02c058ca2c848ccf0e9235f664e7e263a0df3d5fa242a07b4c47953d28f3651e1f64567d07cfbd8286dc96a27695862fb13a0ed5577305a62874a9a4
+  metadata.gz: 7d3833134e981234ae2b3a9abc1c433b1f7e51c96fbc0b733f0e0ec325b515dea0513ae9fabcb7767c9a4a93117066429061aecd1a25a4d3ff50777655bfdaf7
+  data.tar.gz: d0774cdaa3d94aa927aa54c451434eb6036e2c4973864ee770186943f7fb106bbbf21e98756f11a274147c5e7568f22193781263fa20423876a3fb680ec983bd

data/Rakefile

@@ -12,6 +12,12 @@ Rake::TestTask.new("test") do |t|
   t.warning = false
 end
 
+Rake::TestTask.new("pact_test") do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/pacts/**/*_test.rb"]
+  t.warning = false
+end
+
 task default: %i[lint test]
 
 require "pact_broker/client/tasks"

data/lib/gds_api/email_alert_api.rb

@@ -11,8 +11,8 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   # @param attributes [Hash] document_type, links, tags used to search existing subscriber lists
   def find_or_create_subscriber_list(attributes)
     present_fields = [attributes["content_id"], attributes["links"], attributes["tags"]].compact.count
-    if present_fields > 1
-      message = "please provide content_id, tags, or links (or none), but not more than one of them"
+    if (present_fields > 1) && (attributes["tags"])
+      message = "Invalid attributes provided. Valid attributes are content_id only, tags only, links only, content_id AND links, or none."
       raise ArgumentError, message
     end
 

data/lib/gds_api/locations_api.rb

@@ -25,4 +25,22 @@ class GdsApi::LocationsApi < GdsApi::Base
 
     { "latitude" => response["average_latitude"], "longitude" => response["average_longitude"] } unless response["results"].nil?
   end
+
+  # Get all results for a postcode
+  #
+  # @param [String, nil] postcode The postcode for which results are requested
+  #
+  # @return [Hash] The fulls results as returned from Locations API, with the average latitude
+  # and longitude, and an array of results for individual addresses with lat/long/lcc, eg:
+  #  {
+  #  "average_latitude"=>51.43122412857143,
+  # "average_longitude"=>-0.37395367142857144,
+  # "results"=>
+  #  [{"address"=>"29, DEAN ROAD, HAMPTON, TW12 1AQ",
+  #    "latitude"=>51.4303819,
+  #    "longitude"=>-0.3745976,
+  #    "local_custodian_code"=>5810}, ETC...
+  def results_for_postcode(postcode)
+    get_json("#{endpoint}/v1/locations?postcode=#{postcode}")
+  end
 end

data/lib/gds_api/test_helpers/locations_api.rb

@@ -5,11 +5,11 @@ module GdsApi
 
       def stub_locations_api_has_location(postcode, locations)
         results = []
-        locations.each do |l|
+        locations.each_with_index do |l, i|
           results << {
+            "address" => l["address"] || "Empty Address #{i}",
             "latitude" => l["latitude"] || 0,
             "longitude" => l["longitude"] || 0,
-            "postcode" => postcode,
             "local_custodian_code" => l["local_custodian_code"],
           }
         end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "84.0.0".freeze
+  VERSION = "85.0.1".freeze
 end

data/lib/gds_api.rb

@@ -11,7 +11,6 @@ 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"
 require "gds_api/publishing_api"
@@ -123,13 +122,6 @@ module GdsApi
     GdsApi::LocationsApi.new(Plek.find("locations-api"), options)
   end
 
-  # Creates a GdsApi::Mapit adapter
-  #
-  # @return [GdsApi::Mapit]
-  def self.mapit(options = {})
-    GdsApi::Mapit.new(Plek.find("mapit"), options)
-  end
-
   # Creates a GdsApi::Maslow adapter
   #
   # It's set to use an external url as an endpoint as the Maslow adapter is

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 84.0.0
+  version: 85.0.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-21 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pact
   requirement: !ruby/object:Gem::Requirement
@@ -268,14 +268,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.7.0
+        version: 4.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.7.0
+        version: 4.9.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -358,7 +358,6 @@ files:
 - 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
 - lib/gds_api/organisations.rb
@@ -383,7 +382,6 @@ files:
 - 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
 - lib/gds_api/test_helpers/router.rb
@@ -419,7 +417,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.5
 signing_key: 
 specification_version: 4
 summary: Adapters to work with GDS APIs

data/lib/gds_api/mapit.rb

@@ -1,51 +0,0 @@
-require_relative "base"
-require_relative "exceptions"
-
-class GdsApi::Mapit < GdsApi::Base
-  def location_for_postcode(postcode)
-    response = get_json("#{base_url}/postcode/#{CGI.escape postcode}.json")
-    Location.new(response) unless response.nil?
-  end
-
-  def areas_for_type(type)
-    get_json("#{base_url}/areas/#{type}.json")
-  end
-
-  def area_for_code(code_type, code)
-    get_json("#{base_url}/code/#{code_type}/#{code}.json")
-  end
-
-  class Location
-    attr_reader :response
-
-    def initialize(response)
-      @response = response
-    end
-
-    def lat
-      @response["wgs84_lat"]
-    end
-
-    def lon
-      @response["wgs84_lon"]
-    end
-
-    def areas
-      @response["areas"].map { |_i, area| OpenStruct.new(area) }
-    end
-
-    def postcode
-      @response["postcode"]
-    end
-
-    def country_name
-      @response["country_name"]
-    end
-  end
-
-private
-
-  def base_url
-    endpoint
-  end
-end

data/lib/gds_api/test_helpers/mapit.rb

@@ -1,91 +0,0 @@
-module GdsApi
-  module TestHelpers
-    module Mapit
-      MAPIT_ENDPOINT = Plek.find("mapit")
-
-      def stub_mapit_has_a_postcode(postcode, coords)
-        response = {
-          "wgs84_lat" => coords.first,
-          "wgs84_lon" => coords.last,
-          "postcode" => postcode,
-        }
-
-        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/#{postcode.tr(' ', '+')}.json")
-          .to_return(body: response.to_json, status: 200)
-        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/partial/#{postcode.split(' ').first}.json")
-          .to_return(body: response.to_json, status: 200)
-      end
-
-      def stub_mapit_has_a_postcode_and_areas(postcode, coords, areas)
-        response = {
-          "wgs84_lat" => coords.first,
-          "wgs84_lon" => coords.last,
-          "postcode" => postcode,
-        }
-
-        area_response = Hash[areas.map.with_index do |area, i|
-          [i,
-           {
-             "codes" => {
-               "ons" => area["ons"],
-               "gss" => area["gss"],
-               "govuk_slug" => area["govuk_slug"],
-             },
-             "name" => area["name"],
-             "type" => area["type"],
-             "country_name" => area["country_name"],
-           }]
-        end]
-
-        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/#{postcode.tr(' ', '+')}.json")
-          .to_return(body: response.merge("areas" => area_response).to_json, status: 200)
-        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/partial/#{postcode.split(' ').first}.json")
-          .to_return(body: response.to_json, status: 200)
-      end
-
-      def stub_mapit_has_a_postcode_and_country_name(postcode, coords, country_name)
-        response = {
-          "wgs84_lat" => coords.first,
-          "wgs84_lon" => coords.last,
-          "postcode" => postcode,
-          "country_name" => country_name,
-        }
-
-        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/#{postcode.tr(' ', '+')}.json")
-          .to_return(body: response.to_json, status: 200)
-        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/partial/#{postcode.split(' ').first}.json")
-          .to_return(body: response.to_json, status: 200)
-      end
-
-      def stub_mapit_does_not_have_a_postcode(postcode)
-        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/#{postcode.tr(' ', '+')}.json")
-          .to_return(body: { "code" => 404, "error" => "No Postcode matches the given query." }.to_json, status: 404)
-      end
-
-      def stub_mapit_does_not_have_a_bad_postcode(postcode)
-        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/#{postcode.tr(' ', '+')}.json")
-          .to_return(body: { "code" => 400, "error" => "Postcode '#{postcode}' is not valid." }.to_json, status: 400)
-      end
-
-      def stub_mapit_has_areas(area_type, areas)
-        stub_request(:get, "#{MAPIT_ENDPOINT}/areas/#{area_type}.json")
-          .to_return(body: areas.to_json, status: 200)
-      end
-
-      def stub_mapit_does_not_have_areas(area_type)
-        stub_request(:get, "#{MAPIT_ENDPOINT}/areas/#{area_type}.json")
-          .to_return(body: [].to_json, status: 200)
-      end
-
-      def stub_mapit_has_area_for_code(code_type, code, area)
-        stub_request(:get, "#{MAPIT_ENDPOINT}/code/#{code_type}/#{code}.json")
-          .to_return(body: area.to_json, status: 200)
-      end
-
-      def stub_mapit_does_not_have_area_for_code(code_type, code)
-        stub_request(:get, "#{MAPIT_ENDPOINT}/code/#{code_type}/#{code}.json")
-        .to_return(body: { "code" => 404, "error" => "No areas were found that matched code #{code_type} = #{code}." }.to_json, status: 404)
-      end
-    end
-  end
-end