address-matcher 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1831908f206efe59220256895312e2ce97de4129
+  data.tar.gz: 32f4b6abc67ad11c50a996c57540c0fb8c4923c9
+SHA512:
+  metadata.gz: d4276c12dc3d9e21d3664d334aac9a1562d85414d6a6fc59bdcf5618aad6fe08a149256103a22c00c065f70664eda00d953a1cc6e49097f053d05f4c77458398
+  data.tar.gz: 0745c45623cf69e85ff962332ed1b5fa2f3cf0e6a2b663a5e1f3918cb064ff0ff41c1aad9e4de37e78cc8f33fbe146e769c860a3b0add63d0297c7dfe87f4a75

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+ruby '2.1.5'
+
+# Specify your gem's dependencies in synxis.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    address-matcher (0.0.1)
+      geocoder (~> 1.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    geocoder (1.2.8)
+    method_source (0.8.2)
+    multi_json (1.11.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.2)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  address-matcher!
+  pry (~> 0.10)
+  rake (~> 10.4)
+  rspec (~> 3.2)
+  simplecov (~> 0.9)

data/README.md

@@ -0,0 +1,59 @@
+# Address Matcher
+
+## What's in an address?
+
+Are `123 Main St., Smalltown, RI` and `123 Main Street, Smalltown, RI` the same
+address? `==` says `false`, but `human intuition` says yes. This gem leverages
+the excellent [geocoder gem](https://github.com/alexreisner/geocoder) to make a
+more educated guess by comparing lat/long of two addresses and returning `true`
+if they are close enough.
+
+## Usage
+
+`$ gem install address_matcher`
+
+`require address_matcher`
+
+Create an `AddressLibrary` with all of the "known" address strings that you want
+to match against:
+
+```ruby
+addresses = ['30 Lincoln Center Plaza, New York, NY 10023',
+            '1000 5th Ave, New York, NY 10028',
+            '1001 5th Avenue, New York, NY 10028',
+            '1002 5th Avenue, New York, NY 10028'
+            ]
+
+library = AddressLibrary.build(addresses)
+```
+
+Then simply call `match` to find the closest matching address:
+
+```ruby
+library.match('1000 5th Avenue, New York, NY 10028')
+#=> 1000 5th Ave, New York, NY 10028
+```
+
+## License
+### MIT
+
+```
+Copyright (c) 2015 Stuart Terrett
+
+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/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Generate code coverage'
+RSpec::Core::RakeTask.new(:coverage)

data/address_matcher.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name        = 'address-matcher'
+  s.version     = '0.0.1'
+  s.date        = '2015-04-07'
+  s.summary     = "Matches addresses by geocoding"
+  s.description = "Uses geocoding to perform fuzzy match on address strings"
+  s.authors     = ["Stuart Terrett"]
+  s.email       = 'shterrett@gmail.com'
+  s.files       = ["lib/address_matcher.rb"]
+  s.homepage    = 'http://github.com/shterrett/address_matcher'
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency('geocoder', '~> 1.2')
+
+  s.add_development_dependency('rake', '~> 10.4')
+  s.add_development_dependency('rspec', '~> 3.2')
+  s.add_development_dependency('simplecov', '~> 0.9')
+  s.add_development_dependency('pry', '~> 0.10')
+end

data/lib/address_matcher.rb

@@ -0,0 +1,5 @@
+require 'bigdecimal'
+require 'geocoder'
+
+require_relative 'address_matcher/address_group'
+require_relative 'address_matcher/address_library'

data/lib/address_matcher/address_group.rb

@@ -0,0 +1,36 @@
+class AddressGroup
+  def initialize
+    @store = {}
+  end
+
+  def []=(lat_long, address)
+    store[lat_long] = address
+  end
+
+  def [](lat_long)
+    store[lat_long]
+  end
+
+  def match(lat_long)
+    if exact = store[lat_long]
+      exact
+    else
+      closest_match(lat_long)
+    end
+  end
+
+  private
+  attr_reader :store
+
+  def closest_match(lat_long)
+    closest = store.keys.min do |a, b|
+      distance_between(lat_long, a) <=> distance_between(lat_long, b)
+    end
+
+    store[closest]
+  end
+
+  def distance_between(p1, p2)
+    Geocoder::Calculations.distance_between(p1, p2)
+  end
+end

data/lib/address_matcher/address_library.rb

@@ -0,0 +1,48 @@
+class AddressLibrary
+  def self.build(address_list)
+    new.tap do |library|
+      address_list.each { |address| library.add_address(address) }
+    end
+  end
+
+  def initialize
+    @store = Hash.new do |outer, o_key|
+      outer[o_key] = Hash.new do |inner, i_key|
+        inner[i_key] = AddressGroup.new
+      end
+    end
+  end
+
+  def add_address(address_string)
+    coords = geocode(address_string)
+    store[latitude_index(coords)][longitude_index(coords)][coords] = address_string
+    self
+  end
+
+  def near(coords)
+    store[latitude_index(coords)][longitude_index(coords)]
+  end
+
+  def match(address_string)
+    coords = geocode(address_string)
+    group = store[latitude_index(coords)][longitude_index(coords)]
+    group.match(coords)
+  end
+
+  private
+  attr_reader :store
+
+  def geocode(address_string)
+    Geocoder.search(address_string)
+            .first
+            .coordinates
+  end
+
+  def latitude_index(coords)
+    coords.first.round(3)
+  end
+
+  def longitude_index(coords)
+    coords.last.round(3)
+  end
+end

data/spec/address_group_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe AddressGroup do
+  let(:symphony_hall) do
+    { lat_long: [42.3426, -71.0858],
+      address: '301 Massachusetts Ave, Boston, MA 02115'
+    }
+  end
+
+  let(:nec) do
+    { lat_long: [42.3406, -71.0869],
+      address: '290 Huntington Ave, Boston, MA 02115'
+    }
+  end
+
+  let(:boco) do
+    { lat_long: [42.3462, -71.0901],
+      address: '8 Fenway, Boston, MA 02215'
+    }
+  end
+
+
+  it 'stores addresses keyed by lat/long' do
+    address_group = AddressGroup.new
+    address_group[symphony_hall[:lat_long]] = symphony_hall[:address]
+
+    expect(address_group[symphony_hall[:lat_long]]).to eq symphony_hall[:address]
+  end
+
+  it 'returns the address of an exact lat/long match' do
+    address_group = AddressGroup.new
+    address_group[symphony_hall[:lat_long]] = symphony_hall[:address]
+    address_group[nec[:lat_long]] = nec[:address]
+
+    match = address_group.match(symphony_hall[:lat_long])
+
+    expect(match).to eq symphony_hall[:address]
+  end
+
+  it 'returns the address of the closest lat/long if there is not an exact match' do
+    address_group = AddressGroup.new
+    address_group[boco[:lat_long]] = boco[:address]
+    address_group[nec[:lat_long]] = nec[:address]
+
+    match = address_group.match(symphony_hall[:lat_long])
+
+    expect(match).to eq nec[:address]
+  end
+end

data/spec/address_library_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe AddressLibrary do
+  it 'geocodes an address' do
+    allow(Geocoder).to receive(:search).and_call_original
+
+    AddressLibrary.new.add_address('30 Lincoln Center Plaza, New York, NY 10023')
+
+    expect(Geocoder).to(
+      have_received(:search).with('30 Lincoln Center Plaza, New York, NY 10023')
+    )
+  end
+
+  it 'adds address to an AddressGroup indexed by lat-long to 3 digit precision' do
+    lib = AddressLibrary.new.add_address('30 Lincoln Center Plaza, New York, NY 10023')
+
+    group = lib.near([40.773, -73.984])
+
+    expect(group).to be_an_instance_of AddressGroup
+    expect(group[[40.772748, -73.98384759999]]).to(
+      eq '30 Lincoln Center Plaza, New York, NY 10023'
+    )
+  end
+
+  it 'adds multiple nearby addresses to the same AddressGroup' do
+    lib = AddressLibrary.new
+                        .add_address('1000 5th Avenue, New York, NY 10028')
+                        .add_address('1002 5th Avenue, New York, NY 10028')
+
+    group = lib.near([40.779, -73.963])
+
+    expect(group[[40.7791655, -73.9629278]]).to(
+      eq '1000 5th Avenue, New York, NY 10028'
+    )
+    expect(group[[40.7785016, -73.9625847]]).to(
+      eq '1002 5th Avenue, New York, NY 10028'
+    )
+  end
+
+  it 'adds multiple far-apart addresses to different AddressGroups' do
+    lib = AddressLibrary.new
+                        .add_address('1000 5th Avenue, New York, NY 10028')
+                        .add_address('30 Lincoln Center Plaza, New York, NY 10023')
+
+    group_1 = lib.near([40.779, -73.963])
+    group_2 = lib.near([40.773, -73.984])
+
+    expect(group_1[[40.7791655, -73.9629278]]).to(
+      eq '1000 5th Avenue, New York, NY 10028'
+    )
+    expect(group_2[[40.7791655, -73.9629278]]).to be_nil
+    expect(group_1[[40.772748, -73.98384759999]]).to be_nil
+    expect(group_2[[40.772748, -73.98384759999]]).to(
+      eq '30 Lincoln Center Plaza, New York, NY 10023'
+    )
+  end
+
+  it 'adds an array of addresses' do
+    addresses = ['30 Lincoln Center Plaza, New York, NY 10023',
+                 '1000 5th Ave, New York, NY 10028',
+                 '1001 5th Avenue, New York, NY 10028',
+                 '1002 5th Avenue, New York, NY 10028'
+                ]
+
+    lib = AddressLibrary.build(addresses)
+
+    group_1 = lib.near([40.779, -73.963])
+    group_2 = lib.near([40.773, -73.984])
+    group_3 = lib.near([40.779, -73.962])
+
+    expect(group_1[[40.77916555, -73.9629278]]).to(
+      eq '1000 5th Ave, New York, NY 10028'
+    )
+    expect(group_1[[40.7785016, -73.9625847]]).to(
+      eq '1002 5th Avenue, New York, NY 10028'
+    )
+    expect(group_2[[40.772748, -73.98384759999]]).to(
+      eq '30 Lincoln Center Plaza, New York, NY 10023'
+    )
+    expect(group_3[[40.7785889, -73.9621559]]).to(
+      eq '1001 5th Avenue, New York, NY 10028'
+    )
+  end
+
+  describe '#near' do
+    it 'returns the address group indexed at the 3-digit precision for a given set of coordinates' do
+    lib = AddressLibrary.new
+                        .add_address('1000 5th Avenue, New York, NY 10028')
+                        .add_address('30 Lincoln Center Plaza, New York, NY 10023')
+
+    group_1 = lib.near([40.7791655, -73.9629278])
+    group_2 = lib.near([40.772748, -73.98384759999])
+
+    expect(group_1[[40.7791655, -73.9629278]]).to(
+      eq '1000 5th Avenue, New York, NY 10028'
+    )
+    expect(group_2[[40.7791655, -73.9629278]]).to be_nil
+    expect(group_1[[40.772748, -73.98384759999]]).to be_nil
+    expect(group_2[[40.772748, -73.98384759999]]).to(
+      eq '30 Lincoln Center Plaza, New York, NY 10023'
+    )
+    end
+  end
+
+  describe '#match' do
+    it 'returns the address which most nearly matches the given address' do
+      addresses = ['30 Lincoln Center Plaza, New York, NY 10023',
+                  '1000 5th Ave, New York, NY 10028',
+                  '1001 5th Avenue, New York, NY 10028',
+                  '1002 5th Avenue, New York, NY 10028'
+                  ]
+
+      lib = AddressLibrary.build(addresses)
+
+      match = lib.match('1000 5th Avenue, New York, NY 10028')
+
+      expect(match).to eq '1000 5th Ave, New York, NY 10028'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'simplecov'
+require 'pry'
+
+SimpleCov.start do
+  add_filter 'spec/'
+end
+
+# encoding: utf-8
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'geocoder'
+require_relative 'support/geocoder'
+
+Dir['./spec/shared/**/*.rb'].sort.each { |f| require f }
+require_relative '../lib/address_matcher'
+
+require 'rspec'
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

data/spec/support/geocoder.rb

@@ -0,0 +1,77 @@
+Geocoder.configure(lookup: :test)
+
+Geocoder::Lookup::Test.add_stub(
+  'Lincoln Center for the Performing Arts, 30 Lincoln Center Plaza, New York, NY 10023', [
+    { 'latitude'     => 40.772748,
+      'longitude'    => -73.98384759999,
+      'address'      => '30 Lincoln Center Plaza, New York, NY 10023',
+      'state'        => 'New York',
+      'state_code'   => 'NY',
+      'country'      => 'United States',
+      'country_code' => 'US'
+    }
+  ]
+)
+Geocoder::Lookup::Test.add_stub(
+  '30 Lincoln Center Plaza, New York, NY 10023', [
+    { 'latitude'     => 40.772748,
+      'longitude'    => -73.98384759999,
+      'address'      => '30 Lincoln Center Plaza, New York, NY 10023',
+      'state'        => 'New York',
+      'state_code'   => 'NY',
+      'country'      => 'United States',
+      'country_code' => 'US'
+    }
+  ]
+)
+
+Geocoder::Lookup::Test.add_stub(
+  '1000 5th Ave, New York, NY 10028', [
+    { 'latitude'     => 40.77916555,
+      'longitude'    => -73.9629278,
+      'address'      => '1000 5th Ave, New York, NY 10028',
+      'state'        => 'New York',
+      'state_code'   => 'NY',
+      'country'      => 'United States',
+      'country_code' => 'US'
+    }
+  ]
+)
+Geocoder::Lookup::Test.add_stub(
+  '1000 5th Avenue, New York, NY 10028', [
+    { 'latitude'     => 40.7791655,
+      'longitude'    => -73.9629278,
+      'address'      => '1000 5th Ave, New York, NY 10028',
+      'state'        => 'New York',
+      'state_code'   => 'NY',
+      'country'      => 'United States',
+      'country_code' => 'US'
+    }
+  ]
+)
+
+Geocoder::Lookup::Test.add_stub(
+  '1001 5th Avenue, New York, NY 10028', [
+    { 'latitude'     => 40.7785889,
+      'longitude'    => -73.9621559,
+      'address'      => '1000 5th Ave, New York, NY 10028',
+      'state'        => 'New York',
+      'state_code'   => 'NY',
+      'country'      => 'United States',
+      'country_code' => 'US'
+    }
+  ]
+)
+
+Geocoder::Lookup::Test.add_stub(
+  '1002 5th Avenue, New York, NY 10028', [
+    { 'latitude'     => 40.7785016,
+      'longitude'    => -73.9625847,
+      'address'      => '1002 5th Ave, New York, NY 10028',
+      'state'        => 'New York',
+      'state_code'   => 'NY',
+      'country'      => 'United States',
+      'country_code' => 'US'
+    }
+  ]
+)

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: address-matcher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stuart Terrett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: geocoder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Uses geocoding to perform fuzzy match on address strings
+email: shterrett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
+- address_matcher.gemspec
+- lib/address_matcher.rb
+- lib/address_matcher/address_group.rb
+- lib/address_matcher/address_library.rb
+- spec/address_group_spec.rb
+- spec/address_library_spec.rb
+- spec/spec_helper.rb
+- spec/support/geocoder.rb
+homepage: http://github.com/shterrett/address_matcher
+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: Matches addresses by geocoding
+test_files:
+- spec/address_group_spec.rb
+- spec/address_library_spec.rb
+- spec/spec_helper.rb
+- spec/support/geocoder.rb