geogov 0.0.3 → 0.0.4

data/lib/geogov.rb

@@ -12,15 +12,18 @@ require 'geogov/providers/dracos_gazetteer'
 
 module Geogov
 
+  class UnrecognizedLocationError < RuntimeError
+  end
+
   def self.provider_for(method, instance)
     unless instance.respond_to?(method)
       raise ArgumentError.new("#{instance.class} doesn't respond to #{method}")
     end
-    
+
     caching_instance = SimpleCache.new(instance)
     @@methods ||= {}
     @@methods[method] = caching_instance
-    
+
     unless self.methods().include?(method)
       dispatcher = <<-EOS
         def #{method}(*args, &block)               
@@ -28,30 +31,39 @@ module Geogov
         end 
       EOS
       module_eval(dispatcher)
-    end  
+    end
   end
 
   def self.configure
     yield self
   end
 
-  provider_for :nearest_place_name,            DracosGazetteer.new()
-  
-  provider_for :lat_lon_to_country,            Geonames.new()
-  provider_for :centre_of_country,             Geonames.new()
+  def lat_lon_from_postcode(postcode)
+    result = Mapit.new().lat_lon_from_postcode(postcode)
+
+    if result.nil?
+      raise UnrecognizedLocationError
+    end
+
+    result
+  end
+
+  provider_for :nearest_place_name, DracosGazetteer.new()
+
+  provider_for :lat_lon_to_country, Geonames.new()
+  provider_for :centre_of_country, Geonames.new()
 
-  provider_for :centre_of_district,            Mapit.new()
+  provider_for :centre_of_district, Mapit.new()
   provider_for :areas_for_stack_from_postcode, Mapit.new()
-  provider_for :areas_for_stack_from_coords,   Mapit.new()
-  provider_for :lat_lon_from_postcode,         Mapit.new()
+  provider_for :areas_for_stack_from_coords, Mapit.new()
 
-  provider_for :remote_location,               Hostip.new()  
+  provider_for :remote_location, Hostip.new()
 
-  provider_for :map_img,                       Google.new()
-  provider_for :map_href,                      Google.new()
+  provider_for :map_img, Google.new()
+  provider_for :map_href, Google.new()
 
   extend self
-    
+
 end
 
  

data/lib/geogov/providers/mapit.rb

@@ -4,17 +4,17 @@ require 'uri'
 module Geogov
 
   class Mapit
-    
+
     class Method
-      def initialize(url,params = [])
+      def initialize(url, params = [])
         @url = url
         @params = params
       end
 
       def to_url(base_url)
         url = "/#{@url}" unless /^\//.match(@url)
-        params = @params.map {|p| 
-          p = p.join(",") if p.is_a?(Array) 
+        params = @params.map { |p|
+          p = p.join(",") if p.is_a?(Array)
           # Messy, but MapIt gets upset if you escape commas
           CGI::escape(p).gsub('%2C', ',')
         }
@@ -34,24 +34,26 @@ module Geogov
     end
 
     def valid_mapit_methods
-      [:postcode,:areas,:area,:point,:generations]
+      [:postcode, :areas, :area, :point, :generations]
     end
 
     def respond_to?(sym)
       valid_mapit_methods.include?(sym) || super(sym)
     end
-    
+
     def lat_lon_from_postcode(postcode)
       areas = areas_for_stack_from_postcode(postcode)
       areas[:point]
     end
-   
+
     # Borrowed heavily from mapit's pylib/postcodes/views.py with some amendments based on
     # pylib/mapit/areas/models.py
     def translate_area_type_to_shortcut(area_type)
-      if ['COP','LBW','LGE','MTW','UTE','UTW','DIW'].include?(area_type)
+      if ['COP', 'LBW', 'LGE', 'MTW', 'UTE', 'UTW', 'DIW'].include?(area_type)
         return 'ward'
       elsif ['CTY', 'CED'].include?(area_type)
+
+        git
         return 'council' # county
       elsif ['DIS', 'LBO'].include?(area_type)
         return 'council' # district
@@ -61,14 +63,14 @@ module Geogov
     end
 
     def areas_for_stack_from_coords(lat, lon)
-      query = self.point("4326", [lon,lat])
+      query = self.point("4326", [lon, lat])
       results = {:point => {'lat' => lat, 'lon' => lon}}
-      query.each do |id,area_info|
+      query.each do |id, area_info|
         level = translate_area_type_to_shortcut(area_info['type'])
         if level
           level = level.downcase.to_sym
           results[level] = [] unless results[level]
-          level_info = area_info.select { |k,v| ["name","id","type"].include?(k) }
+          level_info = area_info.select { |k, v| ["name", "id", "type"].include?(k) }
           level_info['ons'] = area_info['codes']['ons'] if area_info['codes'] && area_info['codes']['ons']
           results[level] << level_info
           results[:nation] = area_info['country_name'] if results[:nation].nil?
@@ -80,40 +82,41 @@ module Geogov
     def areas_for_stack_from_postcode(postcode)
       query = self.postcode(postcode)
       results = {}
+
       if query && query['shortcuts'] && query['areas']
-        query['shortcuts'].each do |typ,i|
+        query['shortcuts'].each do |typ, i|
           if i.is_a? Hash
             ids = i.values()
           else
             ids = [i]
           end
           ids.each do |id|
-            area_info =  query['areas'][id.to_s]
+            area_info = query['areas'][id.to_s]
             level = typ.downcase.to_sym
             results[level] = [] unless results[level]
-            level_info = area_info.select { |k,v| ["name","id","type"].include?(k) }
+            level_info = area_info.select { |k, v| ["name", "id", "type"].include?(k) }
             level_info['ons'] = area_info['codes']['ons'] if area_info['codes'] && area_info['codes']['ons']
             results[level] << level_info
             results[:nation] = area_info['country_name'] if results[:nation].nil?
           end
         end
-        lat,lon = query['wgs84_lat'],query['wgs84_lon']
+        lat, lon = query['wgs84_lat'], query['wgs84_lon']
         results[:point] = {'lat' => lat, 'lon' => lon}
       end
       return results
     end
-    
+
     def centre_of_district(district_postcode)
-      query = self.postcode("partial",district_postcode)
+      query = self.postcode("partial", district_postcode)
       if query
-        lat,lon = query['wgs84_lat'],query['wgs84_lon']
+        lat, lon = query['wgs84_lat'], query['wgs84_lon']
         return {'lat' => lat, 'lon' => lon}
       end
     end
 
     def method_missing(method, *args, &block)
       if valid_mapit_methods.include?(method)
-        Mapit::Method.new(method.to_s,args).call(@base)
+        Mapit::Method.new(method.to_s, args).call(@base)
       else
         super(method, *args, &block)
       end

data/test/geogov_test.rb

@@ -1,72 +1,77 @@
 require 'test_helper'
 
 class GovspeakTest < Test::Unit::TestCase
-  
+
   test "IP-located stack should have country" do
 
     Geogov.configure do |g|
-      g.provider_for :centre_of_country, stub(:centre_of_country => {"lat"=>37,"lon"=>-96})
-      g.provider_for :remote_location,  stub(:remote_location => {'country' => 'US'})
+      g.provider_for :centre_of_country, stub(:centre_of_country => {"lat"=>37, "lon"=>-96})
+      g.provider_for :remote_location, stub(:remote_location => {'country' => 'US'})
     end
 
     stack = Geogov::GeoStack.new_from_ip('173.203.129.90')
-    assert_equal    "US", stack.country
+    assert_equal "US", stack.country
     assert_in_delta stack.fuzzy_point.lon, -96, 0.5
     assert_in_delta stack.fuzzy_point.lat, 37, 0.5
-    assert_equal    :country, stack.fuzzy_point.accuracy
+    assert_equal :country, stack.fuzzy_point.accuracy
   end
-  
-   test "should be specific if no country available" do
-      
-      Geogov.configure do |g|
-        g.provider_for :remote_location,  stub(:remote_location => nil)
-      end
-      
-      stack = Geogov::GeoStack.new_from_ip('127.0.0.1')
-      assert_nil stack.country
-      assert_equal 0, stack.fuzzy_point.lon
-      assert_equal 0, stack.fuzzy_point.lat
-      assert_equal :planet, stack.fuzzy_point.accuracy
+
+  test "should be specific if no country available" do
+    Geogov.configure do |g|
+      g.provider_for :remote_location, stub(:remote_location => nil)
     end
 
+    stack = Geogov::GeoStack.new_from_ip('127.0.0.1')
+    assert_nil stack.country
+    assert_equal 0, stack.fuzzy_point.lon
+    assert_equal 0, stack.fuzzy_point.lat
+    assert_equal :planet, stack.fuzzy_point.accuracy
+  end
+
   test "raises an exception if provider doesn't support required method" do
-    assert_raises(ArgumentError) { 
+    assert_raises(ArgumentError) {
       Geogov.configure do |g|
         g.provider_for :lat_lon_from_postcode, stub
-      end      
+      end
     }
   end
-  
+
+  test "raises an error if the supplied postcode is invalid" do
+    assert_raises(Geogov::UnrecognizedLocationError) {
+      Geogov.lat_lon_from_postcode("nowhere")
+    }
+  end
+
   test "reconstructed stack rejects unknown params" do
-      assert_raises(ArgumentError) { 
-        Geogov::GeoStack.new_from_hash("galaxy" => "Andromeda") 
-      }
+    assert_raises(ArgumentError) {
+      Geogov::GeoStack.new_from_hash("galaxy" => "Andromeda")
+    }
   end
 
   test "reconstructed stack should refuse creation if no fuzzy point" do
-      assert_raises(ArgumentError) { 
-        Geogov::GeoStack.new_from_hash("country" => "US") 
-      }
+    assert_raises(ArgumentError) {
+      Geogov::GeoStack.new_from_hash("country" => "US")
+    }
   end
 
   test "reconstructed stack should always truncate postcode" do
-      stack = Geogov::GeoStack.new_from_hash("postcode"=>"SE10 8UG","country" => "UK","fuzzy_point" => {"lat"=>"37","lon"=>"-96","accuracy"=>"postcode"})
-      assert_equal "SE10 8", stack.postcode
+    stack = Geogov::GeoStack.new_from_hash("postcode"=>"SE10 8UG", "country" => "UK", "fuzzy_point" => {"lat"=>"37", "lon"=>"-96", "accuracy"=>"postcode"})
+    assert_equal "SE10 8", stack.postcode
   end
-    
+
   test "stack should not consider a postcode with trailing whitespace invalid" do
-      stack = Geogov::GeoStack.new_from_hash("postcode"=>"SE10 8UG ","country" => "UK","fuzzy_point" => {"lat"=>"37","lon"=>"-96","accuracy"=>"postcode"})
-      assert_equal "SE10 8", stack.postcode
+    stack = Geogov::GeoStack.new_from_hash("postcode"=>"SE10 8UG ", "country" => "UK", "fuzzy_point" => {"lat"=>"37", "lon"=>"-96", "accuracy"=>"postcode"})
+    assert_equal "SE10 8", stack.postcode
   end
 
   test "stack should ignore invalid postcodes" do
-      stack = Geogov::GeoStack.new_from_hash("postcode"=>"NOTAPOSTCODE","country" => "UK","fuzzy_point" => {"lat"=>"37","lon"=>"-96","accuracy"=>"postcode"})
-      assert_nil stack.postcode
+    stack = Geogov::GeoStack.new_from_hash("postcode"=>"NOTAPOSTCODE", "country" => "UK", "fuzzy_point" => {"lat"=>"37", "lon"=>"-96", "accuracy"=>"postcode"})
+    assert_nil stack.postcode
   end
-  
+
   test "stack with country should have country accuracy" do
-    stack = Geogov::GeoStack.new_from_hash("country" => "US","fuzzy_point" => {"lat"=>"37","lon"=>"-96","accuracy"=>"country"})
+    stack = Geogov::GeoStack.new_from_hash("country" => "US", "fuzzy_point" => {"lat"=>"37", "lon"=>"-96", "accuracy"=>"country"})
     assert_equal :country, stack.fuzzy_point.accuracy
   end
- 
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geogov
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-08 00:00:00.000000000Z
+date: 2011-12-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70342818099700 !ruby/object:Gem::Requirement
+  requirement: &70306547782860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *70342818099700
+  version_requirements: *70306547782860
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70342818099000 !ruby/object:Gem::Requirement
+  requirement: &70306547781900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,7 +33,7 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *70342818099000
+  version_requirements: *70306547781900
 description: Geolocation and utilities for UK Government single domain
 email:
 - ben@alphagov.co.uk
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.12
 signing_key: 
 specification_version: 3
 summary: Geolocation and utilities for UK Government single domain