geokit_smarty_streets_geocoder 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 287afaaf7b3e5f713f3d8a8cf7ec01b0f29a9188
+  data.tar.gz: 76714b200faf580921c821ce3c552bf73b0eccee
+SHA512:
+  metadata.gz: 9524648b93ac0bcd0a1008def3e5c225772ccf9bb809e2d000101c8ddf2e082f036b719dcb21381740b230741e0e60bc26124adcdd02cba7b446376e0ed26c31
+  data.tar.gz: 4cd5e2c2e42fbf78ac0d906e16c018542da8bf73db7b6c8ceb210f01866401d87f63066a7e912aa8cb85c4fccc8f7504a8910e1a266ebfb11b0a74f02bd0d523

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-version
+.ruby-gemset
+.env

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 EasyPost
+
+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,52 @@
+[![Gem Version](https://badge.fury.io/rb/geokit_smarty_streets_geocoder.svg)](https://badge.fury.io/rb/geokit_smarty_streets_geocoder)
+[![CircleCI](https://circleci.com/gh/EasyPost/geokit_smarty_streets_geocoder.svg?style=svg)](https://circleci.com/gh/EasyPost/geokit_smarty_streets_geocoder)
+
+# SmartyStreetsGeocoder
+
+Custom [geokit](https://github.com/geokit/geokit) geocoder for [SmartyStreets](https://smartystreets.com) address verification service.
+
+This geocoder works for US addressed only.
+
+[API Documentation](https://smartystreets.com/docs/us-zipcode-api)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'geokit_smarty_streets_geocoder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install geokit_smarty_streets_geocoder
+
+## Configuration
+
+
+```ruby
+    # This is your SmartyStreets application key for the SmartyStreets Geocoder.
+    # See https://smartystreets.com/docs/authentication#keypairs
+    Geokit::Geocoders::SmartyStreetsGeocoder.auth_id = 'REPLACE_WITH_YOUR_KEY'
+    Geokit::Geocoders::SmartyStreetsGeocoder.auth_token = 'REPLACE_WITH_YOUR_CODE'
+```
+
+
+## Usage
+
+Because US Zipcode API requires zip and/or city and state it's better to pass an instance of GeoLoc rather than address string.
+
+```ruby
+    # use :smarty_streets to specify this geocoder in your list of geocoders.
+    Geokit::Geocoders::SmartyStreetsGeocoder.geocode( Geokit::GeoLoc.new(city: "Sunnyvale", state: "CA", country_code: "US") )
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/geokit_smarty_streets_geocoder/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/circle.yml

@@ -0,0 +1,9 @@
+machine:
+  ruby:
+    version: 2.3.1
+  environment:
+    RAKE_ENV: test
+
+dependencies:
+  pre:
+    - gem install bundler -v '~> 1.10'

data/geokit_smarty_streets_geocoder.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "geokit_smarty_streets_geocoder"
+  spec.version       = "0.0.3"
+  spec.authors       = ["Serhiy Rozum"]
+  spec.email         = ["contact@easypost.com"]
+  spec.summary       = %q{Geokit custom geocoder for SmartyStreets address verification service}
+  spec.description   = %q{Geokit custom geocoder for SmartyStreets address verification service}
+  spec.homepage      = "https://github.com/easypost/smarty_streets_geocoder.git"
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "geokit"
+  spec.add_dependency "Indirizzo"
+  spec.add_dependency "countries"
+
+end

data/lib/geokit_smarty_streets_geocoder.rb

@@ -0,0 +1,90 @@
+require "uri"
+require "geokit"
+require "indirizzo"
+require "countries"
+
+module Geokit
+  module Geocoders
+    class SmartyStreetsGeocoder < Geocoder
+
+      API_ENDPOINT = "https://us-zipcode.api.smartystreets.com/lookup".freeze
+
+      config :auth_id, :auth_token
+
+      private
+
+      def self.do_geocode(address, options = {})
+
+        if (auth_id.nil? || auth_id.empty?) || (auth_token.nil? || auth_token.empty?)
+          raise(Geokit::Geocoders::GeocodeError, "SmartyStreets requires auth id and token to use their service.")
+        end
+
+        address = address.is_a?(GeoLoc) ? address : parse_address(address)
+
+        return GeoLoc.new unless address.is_us?
+
+        process :json, submit_url(address), address
+      end
+
+      def self.submit_url(address)
+        args = []
+        args << ["auth-id", auth_id]
+        args << ["auth-token", auth_token]
+
+        args << ["city", address.city]
+        args << ["state", address.state]
+        args << ["zipcode", address.zip]
+
+        [API_ENDPOINT, '?', URI.encode_www_form(args)].join('')
+      end
+
+
+      def self.parse_json(json, address)
+        json = json.first
+
+        return GeoLoc.new if json.has_key?('status') # means error
+
+        address.provider = Geokit::Inflector.underscore(provider_name)
+
+        if city_state = json["city_states"].first
+          address.city           = city_state["city"]
+          address.state_code     = city_state["state_abbreviation"]
+          address.state_name     = city_state["state"]
+        end
+
+        if zipcode = detect_zipcode(json, address.city)
+          address.zip = zipcode["zipcode"]
+          address.lat = zipcode["latitude"]
+          address.lng = zipcode["longitude"]
+        end
+
+        address.success = true
+
+        address
+      end
+
+      def self.detect_zipcode(json, city)
+        json["zipcodes"].detect { |zc| zc["default_city"] == city } || json["zipcodes"].first
+      end
+
+      def self.parse_address(address_string)
+        address = Indirizzo::Address.new(address_string, expand_streets: false)
+
+        loc = GeoLoc.new
+        loc.street_number = address.street.join(' ')
+        loc.street_name = address.number
+        loc.city = address.city
+        loc.state = address.state
+        loc.zip = address.zip
+
+        if country = ::ISO3166::Country.find_country_by_alpha2(address.country) || ::ISO3166::Country.find_country_by_name(address.country)
+          loc.country_code = country.try(:alpha2)
+          loc.country = country.try(:name) || address.country
+        end
+
+        loc
+      end
+
+    end
+  end
+end

data/spec/cassettes/arizona_location.yml

@@ -0,0 +1,34 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://us-zipcode.api.smartystreets.com/lookup?auth-id=<SMARTYSTREETS_AUTH_ID>&auth-token=<SMARTYSTREETS_AUTH_TOKEN>&city=%5B%22Gilbert%22%5D&state=AZ&zipcode=85297
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Fri, 09 Sep 2016 18:17:29 GMT
+      Content-Length:
+      - '349'
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains
+    body:
+      encoding: UTF-8
+      string: '[{"input_index":0,"city_states":[{"city":"Gilbert","state_abbreviation":"AZ","state":"Arizona","mailable_city":true}],"zipcodes":[{"zipcode":"85297","zipcode_type":"S","default_city":"Gilbert","county_fips":"04013","county_name":"Maricopa","state_abbreviation":"AZ","state":"Arizona","latitude":33.27696,"longitude":-111.71752,"precision":"Zip5"}]}]'
+    http_version: 
+  recorded_at: Fri, 09 Sep 2016 18:17:29 GMT
+recorded_with: VCR 3.0.3

data/spec/cassettes/permission_denied.yml

@@ -0,0 +1,37 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://us-zipcode.api.smartystreets.com/lookup?auth-id=test&auth-token=fake&city=Sunnyvale&state=CA&zipcode
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      Content-Type:
+      - text/plain; charset=utf-8
+      X-Content-Type-Options:
+      - nosniff
+      Date:
+      - Fri, 09 Sep 2016 18:17:14 GMT
+      Content-Length:
+      - '13'
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains
+    body:
+      encoding: UTF-8
+      string: |
+        Unauthorized
+    http_version: 
+  recorded_at: Fri, 09 Sep 2016 18:17:15 GMT
+recorded_with: VCR 3.0.3

data/spec/cassettes/sunnyvale_location.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://us-zipcode.api.smartystreets.com/lookup?auth-id=<SMARTYSTREETS_AUTH_ID>&auth-token=<SMARTYSTREETS_AUTH_TOKEN>&city=Sunnyvale&state=CA&zipcode
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Fri, 09 Sep 2016 18:17:29 GMT
+      Content-Length:
+      - '1262'
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains
+    body:
+      encoding: UTF-8
+      string: '[{"input_index":0,"city_states":[{"city":"Sunnyvale","state_abbreviation":"CA","state":"California","mailable_city":true}],"zipcodes":[{"zipcode":"94085","zipcode_type":"S","default_city":"Sunnyvale","county_fips":"06085","county_name":"Santa
+        Clara","state_abbreviation":"CA","state":"California","latitude":37.38943,"longitude":-122.01811,"precision":"Zip5"},{"zipcode":"94086","zipcode_type":"S","default_city":"Sunnyvale","county_fips":"06085","county_name":"Santa
+        Clara","state_abbreviation":"CA","state":"California","latitude":37.37142,"longitude":-122.02794,"precision":"Zip5"},{"zipcode":"94087","zipcode_type":"S","default_city":"Sunnyvale","county_fips":"06085","county_name":"Santa
+        Clara","state_abbreviation":"CA","state":"California","latitude":37.35121,"longitude":-122.03564,"precision":"Zip5"},{"zipcode":"94088","zipcode_type":"P","default_city":"Sunnyvale","county_fips":"06085","county_name":"Santa
+        Clara","state_abbreviation":"CA","state":"California","latitude":37.41039,"longitude":-122.01898,"precision":"Zip5"},{"zipcode":"94089","zipcode_type":"S","default_city":"Sunnyvale","county_fips":"06085","county_name":"Santa
+        Clara","state_abbreviation":"CA","state":"California","latitude":37.40243,"longitude":-122.00355,"precision":"Zip5"}]}]'
+    http_version: 
+  recorded_at: Fri, 09 Sep 2016 18:17:29 GMT
+recorded_with: VCR 3.0.3

data/spec/smarty_streets_geocoder_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Geokit::Geocoders::SmartyStreetsGeocoder do
+
+  let(:address) { Geokit::GeoLoc.new(city: "Sunnyvale", state: "CA", country_code: "US") }
+
+  subject { described_class.geocode(address) }
+
+  context "when missing credentials" do
+
+    it 'raises an error' do
+      expect { subject }.to raise_error Geokit::Geocoders::GeocodeError
+    end
+  end
+
+  context "with invalid credentials" do
+
+    before do
+      Geokit::Geocoders::SmartyStreetsGeocoder.auth_id = "test"
+      Geokit::Geocoders::SmartyStreetsGeocoder.auth_token = "fake"
+    end
+
+    it 'returns invalid location' do
+      VCR.use_cassette("permission_denied") do
+        expect( subject.success? ).to be false
+      end
+    end
+  end
+
+  context "with correct credentials" do
+
+    before do
+      Geokit::Geocoders::SmartyStreetsGeocoder.auth_id = ENV['SMARTYSTREETS_AUTH_ID']
+      Geokit::Geocoders::SmartyStreetsGeocoder.auth_token = ENV['SMARTYSTREETS_AUTH_TOKEN']
+    end
+
+    it 'not raises an error' do
+      VCR.use_cassette("sunnyvale_location") do
+        expect { subject }.not_to raise_error
+      end
+    end
+
+    it 'returns valid location' do
+      VCR.use_cassette("sunnyvale_location") do
+        expect( subject.success?     ).to be true
+        expect( subject.city         ).to eq "Sunnyvale"
+        expect( subject.state_name   ).to eq "California"
+        expect( subject.state_code   ).to eq "CA"
+        expect( subject.state        ).to eq "CA"
+        expect( subject.zip          ).to eq "94085"
+        expect( subject.country_code ).to eq "US"
+        expect( subject.lat          ).to eq 37.38943
+        expect( subject.lng          ).to eq -122.01811
+      end
+    end
+
+    context "string address" do
+
+      let(:address) { "Gilbert, AZ 85297 US" }
+
+      it 'returns valid location' do
+        VCR.use_cassette("arizona_location") do
+          expect( subject.success?     ).to be true
+          expect( subject.city         ).to eq "Gilbert"
+          expect( subject.state_name   ).to eq "Arizona"
+          expect( subject.state_code   ).to eq "AZ"
+          expect( subject.state        ).to eq "AZ"
+          expect( subject.zip          ).to eq "85297"
+          expect( subject.country_code ).to eq "US"
+          expect( subject.lat          ).to eq 33.27696
+          expect( subject.lng          ).to eq -111.71752
+        end
+      end
+
+    end
+
+    context "not US location" do
+
+      let(:address) { Geokit::GeoLoc.new(city: "Vancouver", state: "BC", country_code: "CA") }
+
+      it 'returns invalid location' do
+        expect( subject.success? ).to be false
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+ENV['RAKE_ENV'] = 'test'
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'geokit_smarty_streets_geocoder'
+
+require "vcr"
+
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/cassettes"
+  config.hook_into :webmock
+
+  config.filter_sensitive_data('<SMARTYSTREETS_AUTH_ID>') { ENV['SMARTYSTREETS_AUTH_ID'] }
+  config.filter_sensitive_data('<SMARTYSTREETS_AUTH_TOKEN>') { ENV['SMARTYSTREETS_AUTH_TOKEN'] }
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: geokit_smarty_streets_geocoder
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Serhiy Rozum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: geokit
+  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: Indirizzo
+  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: countries
+  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'
+description: Geokit custom geocoder for SmartyStreets address verification service
+email:
+- contact@easypost.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- circle.yml
+- geokit_smarty_streets_geocoder.gemspec
+- lib/geokit_smarty_streets_geocoder.rb
+- spec/cassettes/arizona_location.yml
+- spec/cassettes/permission_denied.yml
+- spec/cassettes/sunnyvale_location.yml
+- spec/smarty_streets_geocoder_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/easypost/smarty_streets_geocoder.git
+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: Geokit custom geocoder for SmartyStreets address verification service
+test_files:
+- spec/cassettes/arizona_location.yml
+- spec/cassettes/permission_denied.yml
+- spec/cassettes/sunnyvale_location.yml
+- spec/smarty_streets_geocoder_spec.rb
+- spec/spec_helper.rb