From 732b1b98c2cf6eedfcaf75548736206c622f3f31 Mon Sep 17 00:00:00 2001
From: dsantosmerino <dsantosmerino@gmail.com>
Date: Mon, 27 Jan 2020 17:59:11 +0100
Subject: [PATCH] Add town as preferred city fallback for OpenCage

---
 .../opencage_reverse_cerdanyola.yml           | 47 +++++++++++++++++++
 lib/geokit/geocoders/opencage.rb              |  1 +
 test/test_opencage_geocoder.rb                | 24 ++++++++++
 3 files changed, 72 insertions(+)
 create mode 100644 fixtures/vcr_cassettes/opencage_reverse_cerdanyola.yml

diff --git a/fixtures/vcr_cassettes/opencage_reverse_cerdanyola.yml b/fixtures/vcr_cassettes/opencage_reverse_cerdanyola.yml
new file mode 100644
index 00000000..f80d24d8
--- /dev/null
+++ b/fixtures/vcr_cassettes/opencage_reverse_cerdanyola.yml
@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.opencagedata.com/geocode/v1/json?key=someopencageapikey&no_annotations=1&query=41.493588,2.141879
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 27 Jan 2020 16:52:19 GMT
+      Server:
+      - Apache
+      Access-Control-Allow-Origin:
+      - "*"
+      Vary:
+      - Accept-Encoding
+      Content-Length:
+      - '597'
+      Content-Type:
+      - application/json; charset=utf-8
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+    body:
+      encoding: UTF-8
+      string: '{"documentation":"https://opencagedata.com/api","licenses":[{"name":"see
+        attribution guide","url":"https://opencagedata.com/credits"}],"results":[{"bounds":{"northeast":{"lat":41.4950264,"lng":2.1415936},"southwest":{"lat":41.4925907,"lng":2.1411986}},"components":{"ISO_3166-1_alpha-2":"ES","ISO_3166-1_alpha-3":"ESP","_category":"road","_type":"road","continent":"Europe","country":"Spain","country_code":"es","county":"Vall\u00e8s
+        Occidental","neighbourhood":"Sant Mart\u00ed","political_union":"European
+        Union","postcode":"08290","road":"Passeig de la Riera","road_type":"residential","state":"Catalonia","suburb":"Can
+        Costa","town":"Cerdanyola del Vall\u00e8s"},"confidence":9,"formatted":"Passeig
+        de la Riera, 08290 Cerdanyola del Vall\u00e8s, Spain","geometry":{"lat":41.4936783,"lng":2.1413932}}],"status":{"code":200,"message":"OK"},"stay_informed":{"blog":"https://blog.opencagedata.com","twitter":"https://twitter.com/opencagedata"},"thanks":"For
+        using an OpenCage API","timestamp":{"created_http":"Mon, 27 Jan 2020 16:52:19
+        GMT","created_unix":1580143939},"total_results":1}'
+    http_version: 
+  recorded_at: Mon, 27 Jan 2020 16:52:19 GMT
+recorded_with: VCR 5.0.0
diff --git a/lib/geokit/geocoders/opencage.rb b/lib/geokit/geocoders/opencage.rb
index c271f256..e896fa8c 100644
--- a/lib/geokit/geocoders/opencage.rb
+++ b/lib/geokit/geocoders/opencage.rb
@@ -76,6 +76,7 @@ def self.set_address_components(address_data, loc)
         loc.state_name     = address_data['state']
         loc.county         = address_data['county']
         loc.city           = address_data['city']
+        loc.city           = address_data['town'] if loc.city.nil? && address_data['town']
         loc.city           = address_data['county'] if loc.city.nil? && address_data['county']
         loc.zip            = address_data['postcode']
         loc.district       = address_data['city_district']
diff --git a/test/test_opencage_geocoder.rb b/test/test_opencage_geocoder.rb
index 0ff3b611..39053de6 100644
--- a/test/test_opencage_geocoder.rb
+++ b/test/test_opencage_geocoder.rb
@@ -93,6 +93,30 @@ def test_opencage_reverse2
     assert_equal 'Прилепски Бранители', res.street_address
   end
 
+  def test_opencage_cerdanyola
+    location = Geokit::GeoLoc.new
+    location.lat, location.lng = '41.493588', '2.141879'
+
+    url = "#{@base_url}?key=someopencageapikey&query=41.493588%2C2.141879&no_annotations=1"
+    TestHelper.expects(:last_url).with(url)
+    res = geocode(location.ll, :opencage_reverse_cerdanyola)
+
+    assert_equal 'ES', res.country_code
+    assert_equal 'opencage', res.provider
+
+    assert_equal 'Sant Martí', res.neighborhood
+    assert_equal 'Catalonia', res.state
+    assert_equal 'Vallès Occidental', res.county
+    assert_equal 'Cerdanyola Del Vallès', res.city
+
+    assert_equal 'Spain', res.country
+    assert_equal 9, res.precision
+    assert_equal true, res.success
+
+    assert_equal 'Passeig De La Riera, Cerdanyola Del Vallès, Catalonia, 08290, ES', res.full_address
+    assert_equal 'Passeig De La Riera', res.street_address
+  end
+
   # check if the results are in Spanish if &language=es
   def test_language_response
     url = "#{@base_url}?key=someopencageapikey&language=es&query=London&no_annotations=1"