From 7ec0d3f67766764967a8bb92099c582f8bd6aaf5 Mon Sep 17 00:00:00 2001
From: Dave Arter <davea@mysociety.org>
Date: Wed, 24 Jan 2018 18:01:56 +0000
Subject: Cobrands can pass `components` to Google Geocoder.

This allows more fine grained control over the geocoder search, e.g. to
specify the administrative area or town. See the geocoder api docs:
https://developers.google.com/maps/documentation/geocoding/intro#ComponentFiltering
---
 CHANGELOG.md                          |  2 ++
 perllib/FixMyStreet/Geocode/Google.pm | 16 ++++++++++++----
 t/Mock/GoogleGeocoder.pm              | 36 +++++++++++++++++++++++++++++++++++
 t/geocode/google.t                    | 22 +++++++++++++++++++++
 4 files changed, 72 insertions(+), 4 deletions(-)
 create mode 100644 t/Mock/GoogleGeocoder.pm
 create mode 100644 t/geocode/google.t

diff --git a/CHANGELOG.md b/CHANGELOG.md
index fa87a2fdf..628bac41b 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -27,6 +27,8 @@
         - Admin can log a user out. #1975
         - Admin can remove a user's account details. #1944
         - Superusers can have optional two-factor authentication. #1973
+    - Development improvements:
+        - 'components' parameter can be passed to Google geocoder. #1994
     - UK:
         - Lazy load images in the footer.
 
diff --git a/perllib/FixMyStreet/Geocode/Google.pm b/perllib/FixMyStreet/Geocode/Google.pm
index e64d02c4c..162101953 100644
--- a/perllib/FixMyStreet/Geocode/Google.pm
+++ b/perllib/FixMyStreet/Geocode/Google.pm
@@ -8,6 +8,7 @@ package FixMyStreet::Geocode::Google;
 
 use strict;
 use Utils;
+use URI::Escape;
 
 # string STRING CONTEXT
 # Looks up on Google Maps API, and caches, a user-inputted location.
@@ -19,11 +20,13 @@ sub string {
 
     my $params = $c->cobrand->disambiguate_location($s);
 
+    my $components = "";
+
     # For some reason adding gl=uk is no longer sufficient to make google
-    # think we are in the UK for some locations so we explictly add UK to
-    # the address.
-    if ($c->cobrand->country eq 'GB' && $s !~ /, *UK/ && $s !~ /united *kingdom$/) {
-        $s .= ', UK';
+    # think we are in the UK for some locations so we explicitly tell Google
+    # the country.
+    if ($c->cobrand->country eq 'GB') {
+        $components = "country:GB";
     }
 
     $s = FixMyStreet::Geocode::escape($s);
@@ -37,8 +40,13 @@ sub string {
     } elsif ($params->{country}) {
         $url .=  '&region=' . $params->{country};
     }
+    if ($params->{components}) {
+        $components .= ($components ? '|' : '') . URI::Escape::uri_escape_utf8($params->{components});
+    }
     $url .=  '&language=' . $params->{lang} if $params->{lang};
 
+    $url .= '&components=' . $components if $components;
+
     my $args = 'key=' . FixMyStreet->config('GOOGLE_MAPS_API_KEY');
     my $js = FixMyStreet::Geocode::cache('google', $url, $args, qr/"status"\s*:\s*"(OVER_QUERY_LIMIT|REQUEST_DENIED|INVALID_REQUEST|UNKNOWN_ERROR)"/);
     if (!$js) {
diff --git a/t/Mock/GoogleGeocoder.pm b/t/Mock/GoogleGeocoder.pm
new file mode 100644
index 000000000..fd741c00e
--- /dev/null
+++ b/t/Mock/GoogleGeocoder.pm
@@ -0,0 +1,36 @@
+package t::Mock::GoogleGeocoder;
+
+use JSON::MaybeXS;
+use Web::Simple;
+use LWP::Protocol::PSGI;
+
+has json => (
+    is => 'lazy',
+    default => sub {
+        JSON->new->utf8->pretty->allow_blessed->convert_blessed;
+    },
+);
+
+sub dispatch_request {
+    my $self = shift;
+
+    sub (GET + /maps/api/geocode/json + ?*) {
+        my ($self, $args) = @_;
+        my $response = {};
+        if ($args->{address} =~ /result/) {
+            $response->{status} = 'OK';
+            push @{$response->{results}}, { formatted_address => 'High Street, Old Town, City of Edinburgh, Scotland', geometry => { location => { lng => -3.1858425, lat => 55.9504009 } } };
+        }
+        if ($args->{address} eq 'two results') {
+            push @{$response->{results}}, { geometry => { location => { lat => "55.8596449", "lng" => "-4.240377" } }, formatted_address => "High Street, Collegelands, Merchant City, Glasgow, Scotland" };
+        }
+        my $json = mySociety::Locale::in_gb_locale {
+            $self->json->encode($response);
+        };
+        return [ 200, [ 'Content-Type' => 'application/json' ], [ $json ] ];
+    },
+}
+
+LWP::Protocol::PSGI->register(t::Mock::GoogleGeocoder->to_psgi_app, host => 'maps.googleapis.com');
+
+__PACKAGE__->run_if_script;
diff --git a/t/geocode/google.t b/t/geocode/google.t
new file mode 100644
index 000000000..ee3c15ea8
--- /dev/null
+++ b/t/geocode/google.t
@@ -0,0 +1,22 @@
+package FixMyStreet::Cobrand::Tester;
+use parent 'FixMyStreet::Cobrand::Default';
+sub country { 'GB' }
+sub disambiguate_location { { components => 'country:IE' } }
+
+package main;
+
+use FixMyStreet::Test;
+use FixMyStreet::Geocode::Google;
+use Catalyst::Test 'FixMyStreet::App';
+use t::Mock::GoogleGeocoder;
+
+my $c = ctx_request('/');
+my $r = FixMyStreet::Geocode::Google::string("one result", $c);
+ok $r->{latitude};
+ok $r->{longitude};
+
+$c->stash->{cobrand} = FixMyStreet::Cobrand::Tester->new;
+$r = FixMyStreet::Geocode::Google::string("two results", $c);
+is scalar @{$r->{error}}, 2;
+
+done_testing;
-- 
cgit v1.2.3