gds-api-adapters 1.0.0 → 1.1.0

data/lib/gds_api/imminence.rb

@@ -8,18 +8,42 @@ class GdsApi::Imminence < GdsApi::Base
 
   def places(type, lat, lon, limit=5)
     places = get_json(api_url(type, lat, lon, limit)) || []
-    places.map { |o|
-      o['latitude']  = o['location'][0]
-      o['longitude'] = o['location'][1]
-      o['address']   = [
-        o['address1'],
-        o['address2']
-      ].reject { |a| a.nil? or a == '' }.map(&:strip).join(', ')
-      o
-    }
+    places.map { |p| self.class.parse_place_hash(p) }
+  end
+
+  def self.parse_place_hash(place_hash)
+    location = self.extract_location_hash(place_hash["location"])
+    address = self.extract_address_hash(place_hash)
+
+    place_hash.merge(location).merge(address)
   end
 
   def places_kml(type)
     get_raw("#{@endpoint}/places/#{type}.kml")
   end
+
+private
+  def self.extract_location_hash(location)
+    # Deal with all known location formats:
+    #   Old style: [latitude, longitude]; empty array for no location
+    #   New style: hash with keys "longitude", "latitude"; nil for no location
+    case location
+    when Array
+      {"latitude" => location[0], "longitude" => location[1]}
+    when Hash
+      location
+    when nil
+      {"latitude" => nil, "longitude" => nil}
+    end
+  end
+
+  def self.extract_address_hash(place_hash)
+    address_fields = [
+      place_hash["address1"],
+      place_hash["address2"]
+    ].reject { |a| a.nil? or a == "" }
+    {"address" => address_fields.map(&:strip).join(", ")}
+  end
+
+
 end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/test/imminence_api_test.rb

@@ -0,0 +1,100 @@
+require "test_helper"
+require "gds_api/imminence"
+
+class ImminenceApiTest < MiniTest::Unit::TestCase
+
+  ROOT = "https://imminence.test.alphagov.co.uk"
+  LATITUDE = 52.1327584352089
+  LONGITUDE = -0.4702813074674147
+
+  def api_client
+    GdsApi::Imminence.new('test')
+  end
+
+  def dummy_place
+    {
+      "access_notes" => nil,
+      "address1" => "Cauldwell Street",
+      "address2" => "Bedford",
+      "fax" => nil,
+      "general_notes" => nil,
+      "geocode_error" => nil,
+      "location" => [LATITUDE, LONGITUDE],
+      "name" => "Town Hall",
+      "phone" => nil,
+      "postcode" => "MK42 9AP",
+      "source_address" => "Town Hall, Cauldwell Street, Bedford",
+      "text_phone" => nil,
+      "town" => nil,
+      "url" => "http://www.bedford.gov.uk/advice_and_benefits/registration_service.aspx"
+    }
+  end
+
+  def test_no_second_address_line
+    c = api_client
+    url = "#{ROOT}/places/wibble.json?limit=5&lat=52&lng=0"
+    place_info = dummy_place.merge "address2" => nil
+    c.expects(:get_json).with(url).returns([place_info])
+    places = c.places("wibble", 52, 0)
+
+    assert_equal 1, places.size
+    assert_equal "Cauldwell Street", places[0]["address"]
+  end
+
+  def test_search_for_places
+    c = api_client
+    url = "#{ROOT}/places/wibble.json?limit=5&lat=52&lng=0"
+    c.expects(:get_json).with(url).returns([dummy_place])
+    places = c.places("wibble", 52, 0)
+
+    assert_equal 1, places.size
+    place = places[0]
+    assert_equal LATITUDE, place["latitude"]
+    assert_equal LONGITUDE, place["longitude"]
+    assert_equal "Cauldwell Street, Bedford", place["address"]
+  end
+
+  def test_empty_location
+    # Test behaviour when the location field is an empty array
+    c = api_client
+    url = "#{ROOT}/places/wibble.json?limit=5&lat=52&lng=0"
+    place_info = dummy_place.merge("location" => [])
+    c.expects(:get_json).with(url).returns([place_info])
+    places = c.places("wibble", 52, 0)
+
+    assert_equal 1, places.size
+    place = places[0]
+    assert_nil place["latitude"]
+    assert_nil place["longitude"]
+  end
+
+  def test_nil_location
+    # Test behaviour when the location field is nil
+    c = api_client
+    url = "#{ROOT}/places/wibble.json?limit=5&lat=52&lng=0"
+    place_info = dummy_place.merge("location" => nil)
+    c.expects(:get_json).with(url).returns([place_info])
+    places = c.places("wibble", 52, 0)
+
+    assert_equal 1, places.size
+    place = places[0]
+    assert_nil place["latitude"]
+    assert_nil place["longitude"]
+  end
+
+  def test_hash_location
+    # Test behaviour when the location field is a longitude/latitude hash
+    c = api_client
+    url = "#{ROOT}/places/wibble.json?limit=5&lat=52&lng=0"
+    place_info = dummy_place.merge(
+      "location" => {"longitude" => LONGITUDE, "latitude" => LATITUDE}
+    )
+    c.expects(:get_json).with(url).returns([place_info])
+    places = c.places("wibble", 52, 0)
+
+    assert_equal 1, places.size
+    place = places[0]
+    assert_equal LATITUDE, place["latitude"]
+    assert_equal LONGITUDE, place["longitude"]
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - James Stewart
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-15 00:00:00 Z
+date: 2012-08-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plek
@@ -170,6 +170,7 @@ files:
 - test/contactotron_api_test.rb
 - test/panopticon_api_test.rb
 - test/publisher_api_test.rb
+- test/imminence_api_test.rb
 - test/json_client_test.rb
 - test/gds_api_base_test.rb
 - test/licence_application_api_test.rb
@@ -187,7 +188,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2151341373007717106
+      hash: -4250669656012288164
       segments: 
       - 0
       version: "0"
@@ -196,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2151341373007717106
+      hash: -4250669656012288164
       segments: 
       - 0
       version: "0"
@@ -211,6 +212,7 @@ test_files:
 - test/contactotron_api_test.rb
 - test/panopticon_api_test.rb
 - test/publisher_api_test.rb
+- test/imminence_api_test.rb
 - test/json_client_test.rb
 - test/gds_api_base_test.rb
 - test/licence_application_api_test.rb