geocode_records 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: edc2c231e4b2b56695ce060e5712a20f5af64b53
+  data.tar.gz: 1aa1438ca13d54c8fcf042ada691e7d5c3c53175
+SHA512:
+  metadata.gz: 71e2a3a9fe9d42bd815c02844c6d14cdde9599f7e6480459a2d217290b06fddeb13faf3027402e5bc222aa74de568bb09ccf56bc734f4aec4991f88b29b2101c
+  data.tar.gz: 629c638c72442db0d31409066e9ba09917463b588c8a1117256475dcee54fd5886b1420e69342f9092ca751175b82f33570f43172e960befe3cc55d466e6d2a3

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/node_modules/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/CHANGELOG

@@ -0,0 +1,17 @@
+0.0.3 / 2015-03-27
+
+* Enhancements
+
+  * Respect ENV['DATABASE_URL'] instead of expecting `psql DBNAME` to always work
+  * Require a good version of https://www.npmjs.com/package/smartystreets to be installed
+  * More resistant to postcodes like 5753 (aka 05753), 53703.0, and even 5753.0
+
+0.0.2 / 2015-01-23
+
+* Enhancements
+
+  * bin/geocode_records table_name - extremely basic CLI
+
+0.0.1 / 2015-01-23
+
+initial release!

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in geocode_records.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Seamus Abshere
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# GeocodeRecords
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'geocode_records'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install geocode_records
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/geocode_records/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/bin/geocode_records

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require 'logger'
+
+require 'geocode_records'
+
+ActiveRecord::Base.establish_connection ENV.fetch('DATABASE_URL')
+
+# http://gray.fm/2013/09/17/unknown-oid-with-rails-and-postgresql/
+require 'active_record/connection_adapters/postgresql/oid'
+ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.tap do |klass|
+  klass::OID.register_type('geometry', klass::OID::Identity.new)
+end
+
+logger = Logger.new($stderr)
+logger.level = Logger::WARN
+ActiveRecord::Base.logger = logger
+Upsert.logger = logger
+
+class Whatever < ActiveRecord::Base
+  self.table_name = ARGV[0]
+end
+
+GeocodeRecords.new(Whatever.all).perform

data/geocode_records.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'geocode_records/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "geocode_records"
+  spec.version       = GeocodeRecords::VERSION
+  spec.authors       = ["Seamus Abshere"]
+  spec.email         = ["seamus@abshere.net"]
+  spec.summary       = %q{Geocode an ActiveRecord::Relation with node_smartystreets}
+  spec.description   = %q{A quick way to re-geocode a table}
+  spec.homepage      = "https://github.com/seamusabshere/geocode_records"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'activerecord', '~>4.1.9'
+  spec.add_runtime_dependency 'pg'
+  spec.add_runtime_dependency 'attr_extras'
+  spec.add_runtime_dependency 'zaru'
+  spec.add_runtime_dependency 'upsert'
+  spec.add_runtime_dependency 'pasqual'
+  
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/geocode_records/dump_sql_to_csv.rb

@@ -0,0 +1,18 @@
+class DumpSqlToCsv
+  attr_private :sql
+  attr_private :pasqual
+
+  def initialize(pasqual, sql, ignored_options = {})
+    @pasqual = pasqual
+    @sql = sql
+  end
+
+  def path
+    @path = Dir::Tmpname.create(sql[0,64].delete('"').gsub(/\W/,'_').squeeze) {}
+
+    pasqual.command "\\copy (#{sql}) TO '#{@path}' DELIMITER ',' CSV HEADER"
+
+    @path
+  end
+
+end

data/lib/geocode_records/geocode_csv.rb

@@ -0,0 +1,112 @@
+require 'tmpdir'
+require 'fileutils'
+require 'csv'
+require 'shellwords'
+require 'zaru'
+
+# copied from hotdog/app/services/file_geocoder.rb with seamus variations
+class GeocodeRecords
+  class GeocodeCsv
+    attr_reader :glob
+
+    def initialize(input_path, options = {})
+      @input_path = input_path
+      options ||= {}
+      @glob = options[:glob]
+      @mutex = Mutex.new
+    end
+
+    def path
+      return if @path
+      @mutex.synchronize do
+        return if @path
+        geocode
+        recode
+        @path = @recoded_path
+      end
+    end
+
+    private
+
+    attr_private :input_path
+    attr_private :geocoded_path
+    attr_private :recoded_path
+
+    def input_map
+      @input_map ||= if glob
+        { 'street' => 'glob' }
+      else
+        {
+          'street' => 'house_number_and_street',
+          'zipcode' => 'postcode',
+        }
+      end
+    end
+
+    def geocode
+      @geocoded_path = Dir::Tmpname.create(Zaru.sanitize!(input_path + '.geocode')) {}
+      args = [
+        smartystreets_bin_path,
+        '-i', input_path,
+        '-o', geocoded_path,
+        '--auth-id', ENV.fetch('SMARTY_STREETS_AUTH_ID'),
+        '--auth-token', ENV.fetch('SMARTY_STREETS_AUTH_TOKEN')
+      ]
+      input_map.each do |ss, local|
+        args += [ "--#{ss}-col", local.to_s ]
+      end
+      puts Shellwords.join(args)
+      system(*args)
+      raise "Geocoding failed on #{input_path.inspect} with args #{Shellwords.join(args)}" unless $?.success?
+    end
+
+    def recode
+      @recoded_path = Dir::Tmpname.create(Zaru.sanitize!(input_path + '.recode')) {}
+      File.open(@recoded_path, 'w') do |f|
+        f.write output_columns.to_csv
+        CSV.foreach(@geocoded_path, headers: true) do |geocoded_row|
+          f.write recode_columns.map { |k| geocoded_row[k] }.to_csv
+        end
+      end
+      File.unlink @geocoded_path
+    end
+
+    def output_columns
+      @output_columns ||= (File.open(input_path) { |f| CSV.parse_line(f.gets) } + RECODE_MAP.keys).uniq
+    end
+
+    # no street yet - street_name, street_suffix
+    RECODE_MAP = {
+      'house_number_and_street' => 'ss_delivery_line_1',
+      'house_number' => 'ss_primary_number',
+      'unit_number' => 'ss_secondary_number',
+      'city' => 'ss_city_name',
+      'state' => 'ss_state_abbreviation',
+      'postcode' => 'ss_zipcode',
+      'latitude' => 'ss_latitude',
+      'longitude' => 'ss_longitude',
+    }.freeze
+
+    def recode_columns
+      @recode_columns ||= output_columns.map do |output_k|
+        RECODE_MAP[output_k] || output_k
+      end
+    end
+
+    def smartystreets_bin_path
+      @smartystreets_bin_path ||= begin
+        memo = if File.exist?('node_modules/.bin/smartystreets')
+          'node_modules/.bin/smartystreets'
+        else
+          'smartystreets'
+        end
+        `#{memo} -V` =~ /\A(\d+)\.(\d+)\.(\d+)/
+        major, minor, patch = [$1, $2, $3].map(&:to_i)
+        unless major >= 1 and minor >= 3 and patch >= 2
+          raise "smartystreets >= 1.3.2 required, got #{major}.#{minor}.#{patch}"
+        end
+        memo
+      end
+    end
+  end
+end

data/lib/geocode_records/update_table_from_csv.rb

@@ -0,0 +1,31 @@
+require 'csv'
+require 'upsert'
+
+class GeocodeRecords
+  class UpdateTableFromCsv
+    attr_private :connection
+    attr_private :table_name
+    attr_private :csv_path
+    attr_private :upsert
+    def initialize(connection, table_name, csv_path, ignored_options = {})
+      @upsert = Upsert.new connection, table_name
+      @csv_path = csv_path
+    end
+    def perform
+      count = 0
+      CSV.foreach(csv_path, headers: true) do |row|
+        next unless row['postcode']
+        row = row.to_hash
+        if hn = row['house_number']
+          row['house_number'] = hn.to_i
+        end
+        selector = { id: row.delete('id') }
+        setter = row
+        upsert.row selector, setter
+        # $stderr.write "U#{count}..." if count % 1000 == 0
+        count += 1
+      end
+      count
+    end
+  end
+end

data/lib/geocode_records/version.rb

@@ -0,0 +1,3 @@
+class GeocodeRecords
+  VERSION = '0.0.3'
+end

data/lib/geocode_records.rb

@@ -0,0 +1,67 @@
+require 'active_record'
+require 'attr_extras'
+require 'pasqual'
+
+require_relative 'geocode_records/version'
+require_relative 'geocode_records/dump_sql_to_csv'
+require_relative 'geocode_records/geocode_csv'
+require_relative 'geocode_records/update_table_from_csv'
+
+class GeocodeRecords
+
+  attr_reader :records
+  attr_reader :options
+  def initialize(records, options = {})
+    records.is_a?(ActiveRecord::Relation) or raise(ArgumentError, "expected AR::Relation, got #{records.class}")
+    @options = options || {}
+    @records = records
+  end
+  
+  def perform
+    if records.count > 0
+      # $stderr.puts "GeocodeRecords: #{records.count} to go!"
+      ungeocoded_path = DumpSqlToCsv.new(pasqual, to_sql, options).path
+      geocoded_path = GeocodeCsv.new(ungeocoded_path, options).path
+      UpdateTableFromCsv.new(connection, table_name, geocoded_path, options).perform
+      set_the_geom
+      File.unlink geocoded_path
+      File.unlink ungeocoded_path
+    end
+  end
+
+  private
+
+  def glob
+    !!options[:glob]
+  end
+
+  def set_the_geom
+    records.update_all <<-SQL
+      the_geom              = ST_SetSRID(ST_MakePoint(longitude, latitude), 4326),
+      the_geom_webmercator  = ST_Transform(ST_SetSRID(ST_MakePoint(longitude, latitude), 4326), 3857)
+    SQL
+  end
+
+  def to_sql
+    c = connection
+    c.unprepared_statement do
+      if glob
+        c.to_sql records.select('id', 'glob').arel, records.bind_values
+      else
+        c.to_sql records.select('id', 'house_number_and_street', 'house_number', 'unit_number', 'city', 'state', "left(regexp_replace(postcode, '.0$', ''), 5) AS postcode").arel, records.bind_values
+      end
+    end
+  end
+
+  def connection
+    records.connection
+  end
+
+  def table_name
+    options[:table_name] || records.engine.table_name
+  end
+
+  def pasqual
+    @pasqual ||= Pasqual.for ENV.fetch('DATABASE_URL')
+  end
+end

data/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "rolodeck",
+  "private": true,
+  "dependencies": {
+    "smartystreets": "^1.3.2"
+  }
+}

data/spec/geocode_records_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+dbname = 'geocode_records_test'
+ENV['DATABASE_URL'] = "postgresql://127.0.0.1/#{dbname}"
+
+unless ENV['FAST'] == 'true'
+  system 'dropdb', '--if-exists', dbname
+  system 'createdb', dbname
+  system 'psql', dbname, '--command', 'CREATE EXTENSION postgis'
+  system 'psql', dbname, '--command', 'CREATE TABLE homes (id serial primary key, the_geom geometry(Geometry,4326), the_geom_webmercator geometry(Geometry,3857), house_number_and_street text, house_number int, unit_number text, city text, state text, postcode text, latitude float, longitude float)'
+end
+
+require 'active_record'
+ActiveRecord::Base.establish_connection
+# http://gray.fm/2013/09/17/unknown-oid-with-rails-and-postgresql/
+require 'active_record/connection_adapters/postgresql/oid'
+ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.tap do |klass|
+  klass::OID.register_type('geometry', klass::OID::Identity.new)
+end
+
+class Home < ActiveRecord::Base
+end
+
+describe GeocodeRecords do
+  it 'has a version number' do
+    expect(GeocodeRecords::VERSION).not_to be nil
+  end
+
+  it "geocodes an AR::Relation" do
+    home = Home.create! house_number_and_street: '1038 e deyton st', postcode: '53703'
+    GeocodeRecords.new(Home.all).perform
+    home.reload
+    expect(home.house_number_and_street).to eq('1038 E Dayton St')
+  end
+
+  it "doesn't break on float-format postcode" do
+    home = Home.create! house_number_and_street: '1038 e deyton st', postcode: '53703.0'
+    GeocodeRecords.new(Home.all).perform
+    home.reload
+    expect(home.house_number_and_street).to eq('1038 E Dayton St')
+  end
+
+  it "doesn't break on unzeropadded postcode" do
+    home = Home.create! house_number_and_street: '36 main st', postcode: '5753'
+    GeocodeRecords.new(Home.all).perform
+    home.reload
+    expect(home.house_number_and_street).to eq('36 Main St')
+  end
+
+  it "doesn't break on unzeropadded float-format postcode" do
+    home = Home.create! house_number_and_street: '36 main st', postcode: '5753.0'
+    GeocodeRecords.new(Home.all).perform
+    home.reload
+    expect(home.house_number_and_street).to eq('36 Main St')
+  end
+
+  describe 'known issues' do
+    it "doesn't fix float-format postcode on records that it can't geocode" do
+      home = Home.create! house_number_and_street: 'gibberish', postcode: '53703.0'
+      GeocodeRecords.new(Home.all).perform
+      home.reload
+      expect(home.house_number_and_street).to eq('gibberish')
+      expect(home.postcode).to eq('53703.0')
+    end
+
+    it "doesn't fix unzeropadded postcode on records that it can't geocode" do
+      home = Home.create! house_number_and_street: 'gibberish', postcode: '5753'
+      GeocodeRecords.new(Home.all).perform
+      home.reload
+      expect(home.house_number_and_street).to eq('gibberish')
+      expect(home.postcode).to eq('5753')
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'geocode_records'

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: geocode_records
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Seamus Abshere
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.9
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: attr_extras
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zaru
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: upsert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pasqual
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A quick way to re-geocode a table
+email:
+- seamus@abshere.net
+executables:
+- geocode_records
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/geocode_records
+- geocode_records.gemspec
+- lib/geocode_records.rb
+- lib/geocode_records/dump_sql_to_csv.rb
+- lib/geocode_records/geocode_csv.rb
+- lib/geocode_records/update_table_from_csv.rb
+- lib/geocode_records/version.rb
+- package.json
+- spec/geocode_records_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/seamusabshere/geocode_records
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Geocode an ActiveRecord::Relation with node_smartystreets
+test_files:
+- spec/geocode_records_spec.rb
+- spec/spec_helper.rb