geogov 0.0.8 → 0.0.9

data/lib/geogov.rb

@@ -20,9 +20,9 @@ module Geogov
       raise ArgumentError.new("#{instance.class} doesn't respond to #{method}")
     end
 
-    caching_instance = SimpleCache.new(instance)
+    # caching_instance = SimpleCache.new(instance)
     @@methods ||= {}
-    @@methods[method] = caching_instance
+    @@methods[method] = instance
 
     unless self.methods().include?(method)
       dispatcher = <<-EOS
@@ -43,6 +43,7 @@ module Geogov
   provider_for :lat_lon_to_country, Geonames.new()
   provider_for :centre_of_country, Geonames.new()
 
+  provider_for :lat_lon_from_postcode, 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()

data/lib/geogov/geo_stack.rb

@@ -1,8 +1,8 @@
 module Geogov
   class GeoStack
 
-    attr_accessor :ward, :council, :nation, :country, :wmc, :lat, :lon, :friendly_name
-    attr_reader :postcode, :fuzzy_point
+    attr_accessor :ward, :council, :nation, :country, :region, :lat, :lon, :authorities, :fuzzy_point
+    attr_reader :postcode
 
     def initialize(&block)
       if block_given?
@@ -58,13 +58,10 @@ module Geogov
       {
         :fuzzy_point => self.fuzzy_point.to_hash,
         :postcode => self.postcode,
-        :ward => self.ward,
         :council => self.council,
-        :nation => self.nation,
-        :country => self.country,
-        :wmc => self.wmc,
+        :ward => self.ward,
         :friendly_name => self.friendly_name
-      }.select {|k,v| !(v.nil?) }
+      }#.select {|k,v| !(v.nil?) }
     end
 
     def update(hash)
@@ -79,6 +76,52 @@ module Geogov
         empty.fuzzy_point = empty.calculate_fuzzy_point
       end
     end
+    
+    def friendly_name
+      @friendly_name ||= build_locality
+    end
+
+    def has_authority?( type )
+      get_authority(type) ? true : false
+    end
+
+    def get_authority( type )
+      return false if self.authorities[type.upcase.to_sym] == true
+      self.authorities.nil? or self.authorities[type.upcase.to_sym].nil? ? false : self.authorities[type.upcase.to_sym]
+    end
+
+    def formatted_authority_name( type ) 
+      return false unless has_authority?(type)
+      name = get_authority(type)['name'].dup
+
+      name.sub!(/ *((District Council|Borough Council|Community|County Council|City Council|Council) ?)+/,'')
+      name.sub!(/ (North|East|South|West|Central)$/,'')
+      name.sub!(/Mid /,'')
+
+      name
+    end
+
+    def build_locality
+      return false unless self.authorities
+
+      case
+        when has_authority?('DIS') && has_authority?('CTY')
+          locality = ['DIS','CTY']
+        when has_authority?('LBO')
+          locality = ['LBO','London']
+        when has_authority?('UTA') && has_authority?('CPC') # for cornwall civil parishes
+          locality = ['CPC','UTA']
+        when has_authority?('UTA') && has_authority?('UTE')
+          locality = ['UTE','UTA']
+        when has_authority?('UTA') && has_authority?('UTW')
+          locality = ['UTW','UTA']       
+        when has_authority?('MTW') && has_authority?('MTD')
+          locality = ['MTW','MTD']
+        else
+          return false
+      end
+      locality.map {|t| formatted_authority_name(t) || t }.uniq.join(', ') 
+    end
 
     def has_valid_lat_lon(hash)
       return (hash['lon'] and hash['lat'] and hash['lon'] != "" and hash['lat'] != "")
@@ -90,16 +133,12 @@ module Geogov
         fields = Geogov.areas_for_stack_from_postcode(postcode)
         if fields
           lat_lon = fields[:point]
-          if lat_lon
-            self.friendly_name = Geogov.nearest_place_name(lat_lon['lat'],lat_lon['lon'])
-          end
           set_fields(fields.select {|k,v| k != :point})
         end
       end
     end
    
     def fetch_missing_fields_for_coords(lat, lon)
-      self.friendly_name = Geogov.nearest_place_name(lat, lon)
       fields = Geogov.areas_for_stack_from_coords(lat, lon)
       if ['England', 'Scotland', 'Northern Ireland', 'Wales'].include?(fields[:nation])
         self.country = 'UK'
@@ -115,7 +154,9 @@ module Geogov
             self.send(setter,value)
           end
         else
-          raise ArgumentError, "geo type '#{geo}' is not a valid geo type"
+          self.authorities ||= { }
+          self.authorities[geo] = value
+          # raise ArgumentError, "geo type '#{geo}' is not a valid geo type"
         end
       end
       self

data/lib/geogov/providers/mapit.rb

@@ -43,7 +43,7 @@ module Geogov
 
     def lat_lon_from_postcode(postcode)
       areas = areas_for_stack_from_postcode(postcode)
-      areas[:point]
+      areas[:point] or raise UnrecognizedLocationError
     end
 
     # Borrowed heavily from mapit's pylib/postcodes/views.py with some amendments based on
@@ -51,12 +51,10 @@ module Geogov
     def translate_area_type_to_shortcut(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
+      elsif ['CTY', 'CED', 'MTD', 'UTA', 'DIS', 'LBO', 'LGD'].include?(area_type)
+        return 'council'
+      elsif area_type == 'EUR'
+        return 'region'
       elsif area_type == 'WMC' # XXX Also maybe 'EUR', 'NIE', 'SPC', 'SPE', 'WAC', 'WAE', 'OLF', 'OLG', 'OMF', 'OMG')
         return 'WMC'
       end
@@ -65,8 +63,12 @@ module Geogov
     def areas_for_stack_from_coords(lat, lon)
       query = self.point("4326", [lon, lat])
       results = {:point => {'lat' => lat, 'lon' => lon}}
+      councils = { }
+      
       query.each do |id, area_info|
+        type = area_info['type'].upcase.to_sym
         level = translate_area_type_to_shortcut(area_info['type'])
+        
         if level
           level = level.downcase.to_sym
           results[level] = [] unless results[level]
@@ -75,15 +77,24 @@ module Geogov
           results[level] << level_info
           results[:nation] = area_info['country_name'] if results[:nation].nil?
         end
+        
+        councils[type] = { 'name' => area_info['name'], 'type' => area_info['type'], 'id' => area_info['id'] }
       end
-      return results
+
+      return councils.merge results 
     end
 
     def areas_for_stack_from_postcode(postcode)
       query = self.postcode(postcode)
       results = {}
 
-      if query && query['shortcuts'] && query['areas']
+      if query && query['areas']
+
+        query['areas'].each do |i, area|
+          type = area['type'].to_sym
+          results[type] = area
+        end 
+
         query['shortcuts'].each do |typ, i|
           if i.is_a? Hash
             ids = i.values()

data/test/geogov_test.rb

@@ -3,7 +3,6 @@ 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'})
@@ -74,4 +73,52 @@ class GovspeakTest < Test::Unit::TestCase
     assert_equal :country, stack.fuzzy_point.accuracy
   end
 
+  test "stack with postcode returns correct locality" do
+    stack = Geogov::GeoStack.new
+    stack = stack.update( 'postcode' => "SW1A 1AA" )
+
+    assert_equal "Westminster, London", stack.friendly_name
+  end
+  
+  test "stack with coordinates returns correct locality" do
+    stack = Geogov::GeoStack.new
+    stack = stack.update( 'lat' => "51.501009", "lon" => "-0.1415870" )
+
+    assert_equal "Westminster, London", stack.friendly_name
+  end
+
+  test "stack with postcode returns authorities" do
+    stack = Geogov::GeoStack.new
+    stack = stack.update( 'postcode' => "SW1A 1AA" )
+
+    assert stack.authorities.any?
+  end
+
+  test "stack with coordinates returns authorities" do
+    stack = Geogov::GeoStack.new
+    stack = stack.update( 'lat' => "51.501009", "lon" => "-0.1415870" )
+
+    assert stack.authorities.any?
+  end
+
+  test "stack with postcode returns correct locality, ward and council" do
+    stack = Geogov::GeoStack.new
+    stack = stack.update( 'postcode' => "SW1A 1AA" )
+
+    assert_equal "Westminster, London", stack.friendly_name
+    assert stack.ward and stack.ward.any?
+    assert stack.council and stack.council.any?
+    assert_equal "Westminster City Council", stack.council.first['name']
+  end
+
+  test "stack with coordinates returns correct locality, ward and council" do
+    stack = Geogov::GeoStack.new
+    stack = stack.update( 'lat' => "51.501009", "lon" => "-0.1415870" )
+
+    assert_equal "Westminster, London", stack.friendly_name
+    assert stack.ward and stack.ward.any?
+    assert stack.council and stack.council.any?
+    assert_equal "Westminster City Council", stack.council.first['name']
+  end
+
 end

metadata

@@ -1,47 +1,51 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: geogov
-version: !ruby/object:Gem::Version
-  version: 0.0.8
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 0.0.9
 platform: ruby
-authors:
+authors: 
 - Ben Griffiths
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-30 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-01-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: &70356750291540 !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *70356750291540
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: mocha
-  requirement: &70356750291060 !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *70356750291060
+  version_requirements: *id002
 description: Geolocation and utilities for UK Government single domain
-email:
+email: 
 - ben@alphagov.co.uk
 - jystewart@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - lib/geogov/fuzzy_point.rb
 - lib/geogov/geo_stack.rb
 - lib/geogov/providers/dracos_gazetteer.rb
@@ -58,28 +62,37 @@ files:
 - test/test_helper.rb
 homepage: http://github.com/alphagov/geogov
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 2911658137343146548
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 2911658137343146548
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.13
 signing_key: 
 specification_version: 3
 summary: Geolocation and utilities for UK Government single domain
-test_files:
+test_files: 
 - test/geogov_test.rb
 - test/test_helper.rb