posty 1.0.0

data/.gitignore

@@ -0,0 +1,3 @@
+lib/posty/codepointopen.sqlite3
+pkg/
+posty.gemspec

data/LICENCE

@@ -0,0 +1,5 @@
+Copyright © 2010, The Dextrous Web
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.rdoc

@@ -0,0 +1,52 @@
+= Posty
+
+Simple geolocation gem that stores the database locally.
+
+= Getting started
+
+  gem install posty
+
+To download mySociety's mirror of the Code-Point Open in WGS84 format, and create a database from it, and store that inside the gem (you may not need the sudo):
+
+  sudo posty-init -g
+
+This takes about 8 minutes for me, and leaves me with a database of approximately 157M.
+
+If you don't want the database being stored in your gem, run something like this instead:
+
+  posty-init -d database.sqlite3
+
+Then, in Ruby:
+
+  require 'posty'
+  posty = Posty.new
+  postcode = posty.postcode('SE1 1EN') # space is optional, as is capitalisation
+  
+  p postcode.postcode
+  p [postcode.latitude, postcode.longitude]
+  p postcode.county
+
+If the database isn't in the gem, you'll need to tell it where to find it:
+
+  posty = Posty.new('database.sqlite3')
+
+To make things even easier, there's a class method too (which accepts the database as the second parameter):
+
+  Posty.postcode('SE1 1EN')
+
+= Notes
+
+The table contains the following columns, extracted from the WGS84 edition of Code-Point Open:
+
+* postcode
+* quality
+* latitude
+* longitude
+* country
+* nhs_region
+* nhs_health_authority
+* county
+* district
+* ward
+
+It does not contain eastings and northings.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'posty'
+    gem.summary = %Q{Simple geolocation gem that stores the database locally}
+    gem.description = %Q{}
+    gem.email = 'tom@thedextrousweb.com'
+    gem.homepage = 'http://github.com/dxw/posty'
+    gem.authors = ['Tom Adams']
+    gem.add_dependency 'sqlite3-ruby'
+    gem.add_dependency 'choice'
+    gem.add_dependency 'fastercsv'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/posty-init

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+
+require 'posty'
+require 'sqlite3'
+require 'tmpdir'
+require 'choice'
+require 'fastercsv'
+require 'fileutils'
+
+codepoint_wgs = 'http://parlvid.mysociety.org:81/os/codepo_gb_wgs84.zip'
+
+Choice.options do
+  option :database do
+    short '-d'
+    long '--database=SQLITE'
+    desc 'The database to create and put data into.'
+  end
+  option :gem do
+    short '-g'
+    long '--gem'
+    desc 'Install the database into the gem (may require sudo).'
+  end
+  option :codepoint do
+    short '-c'
+    long '--codepoint=ZIPFILE'
+    desc 'Existing (WGS84-formatted) codepoint zip file.'
+    default nil
+  end
+end
+
+database = Choice.choices[:database]
+if Choice.choices[:gem]
+  FileUtils.mkdir_p File.dirname(Posty.gem_database)
+  database = Posty.gem_database
+elsif database.nil?
+  STDERR.puts 'Requires either -d or -g option.'
+  exit 2
+end
+codepoint = Choice.choices[:codepoint]
+
+# Die if db already exists
+if File.exist? database
+  STDERR.puts 'Database already exists. Not overwriting.'
+  exit 1
+end
+
+Dir.mktmpdir do |dir|
+  # Download wgs84 dump from mySociety
+  unless codepoint and File.exist? codepoint
+    `wget '#{codepoint_wgs}' -O '#{dir}/codepo_gb_wgs84.zip'`
+    codepoint = "#{dir}/codepo_gb_wgs84.zip"
+  end
+
+  # Unzip
+  `unzip -d '#{dir}' '#{codepoint}'`
+
+  # Create database
+  STDERR.puts "Writing database to #{database}"
+  db = SQLite3::Database.new(database)
+  db.execute <<END
+    CREATE TABLE codepoint (postcode PRIMARY KEY, quality, latitude, longitude, country, nhs_region, nhs_health_authority, county, district, ward)
+END
+
+  # Slurp CSV into SQLite
+  Dir.glob("#{dir}/data/CSV/*.csv").sort.each do |csv|
+    csv.match(/(\w+)\.csv$/)
+    STDERR.puts "Reading #{$1.upcase}"
+
+    db.transaction do |db|
+
+      FasterCSV.foreach(csv) do |row|
+        # Normalise postcode (strip the space)
+        norm_postcode = row[0].gsub(/[^\w\d]/,'').upcase
+        data = [norm_postcode]+row[1..-1]
+
+        db.execute <<END, *data
+          INSERT INTO codepoint VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
+END
+      end
+    end
+  end
+
+  db.close
+end
+
+STDERR.puts 'Finished.'

data/lib/posty.rb

@@ -0,0 +1,49 @@
+require 'sqlite3'
+
+class PostCode
+  attr_reader :data
+  def initialize data
+    @data = {}
+    data.each_pair do |a,b|
+      @data[a] = b if a.is_a? String
+    end
+
+    @data['latitude'] = @data['latitude'].to_f
+    @data['longitude'] = @data['longitude'].to_f
+  end
+
+  %w[postcode quality latitude longitude country nhs_region nhs_health_authority county district ward].each do |m|
+    define_method(m) {@data[m]}
+  end
+end
+
+class Posty
+  def initialize database = nil
+    if database.nil?
+      database = Posty.gem_database
+      unless File.exist? database
+        raise IOError, "No database found in gem. Have you run posty-init -g (possibly with sudo)?"
+      end
+    end
+
+    unless File.exist? database
+      raise IOError, "No database found at #{database}. Have you run posty-init -d '#{database}'?"
+    end
+
+    @db = SQLite3::Database.new(database)
+    @db.results_as_hash = true
+  end
+
+  def postcode code
+    code = code.gsub(/[^\w\d]/,'').upcase
+    PostCode.new(@db.get_first_row('SELECT * FROM codepoint WHERE postcode = ?', code))
+  end
+
+  def self.gem_database
+    "#{File.dirname(__FILE__)}/posty/codepointopen.sqlite3"
+  end
+
+  def self.postcode code, database = nil
+    Posty.new(database).postcode(code)
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: posty
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Tom Adams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-13 00:00:00 +01:00
+default_executable: posty-init
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: choice
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: ""
+email: tom@thedextrousweb.com
+executables: 
+- posty-init
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- LICENCE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/posty-init
+- lib/posty.rb
+has_rdoc: true
+homepage: http://github.com/dxw/posty
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Simple geolocation gem that stores the database locally
+test_files: []
+