geokit_here_geocoder 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e234f09eed7dc3c9fff9ce26fb6cf4e13aa3ebbb
+  data.tar.gz: 0935d68f64074385cda3255a740df82fefde59b4
+SHA512:
+  metadata.gz: 18088cbc0785f4cc197a00b750fe7c0412b1d1848a012ca343423cfdacc095ad6f0f335dfd0a592f5df603094679ac1b4a451d2b63866980d0ae9a50b1de5e45
+  data.tar.gz: 7a0e8727218e51d09e433f0c57e552e0bb5da7c8eb824a701a5256ae3629b3d3bdce0a7b3aeed7e451884f6457f450ab6a134b59f8cbd890eb6cf3986e3b82e5

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
+.env
+.ruby-version
+.ruby-gemset

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 here_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,48 @@
+[![Gem Version](https://badge.fury.io/rb/geokit_here_geocoder.svg)](https://badge.fury.io/rb/geokit_here_geocoder)
+
+# HereGeocoder
+
+Custom [geokit](https://github.com/geokit/geokit) geocoder for [Here.com](https://company.here.com/here/) service.
+
+[API Documentation](https://developer.here.com/rest-apis/documentation/geocoder/topics/quick-start.html)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'geokit_here_geocoder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install geokit_here_geocoder
+
+## Configuration
+
+
+```ruby
+    # This is your Here application key for the Here Geocoder.
+    # See https://developer.here.com/develop/rest-apis
+    Geokit::Geocoders::HereGeocoder.app_id = 'REPLACE_WITH_YOUR_KEY'
+    Geokit::Geocoders::HereGeocoder.app_code = 'REPLACE_WITH_YOUR_CODE'
+```
+
+
+## Usage
+
+```ruby
+    # use :here to specify this geocoder in your list of geocoders.
+    Geokit::Geocoders::HereGeocoder.geocode("Sunnyvale, CA")
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/geokit_here_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_here_geocoder.gemspec

@@ -0,0 +1,28 @@
+# 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_here_geocoder"
+  spec.version       = "0.0.3"
+  spec.authors       = ["Serhiy Rozum"]
+  spec.email         = ["serhiy@easypost.com"]
+  spec.summary       = %q{Geokit custom geocoder for Here.com service}
+  spec.description   = %q{Geokit custom geocoder for Here.com service}
+  spec.homepage      = "https://github.com/easypost/geokit_here_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"
+
+end

data/lib/geokit_here_geocoder.rb

@@ -0,0 +1,70 @@
+require "uri"
+require "geokit"
+
+module Geokit
+  module Geocoders
+    class HereGeocoder < Geocoder
+
+      config :app_id, :app_code
+
+      private
+
+      def self.do_geocode(address, options = {})
+
+        if (app_id.nil? || app_id.empty?) || (app_code.nil? || app_code.empty?)
+          raise(Geokit::Geocoders::GeocodeError, "Here geocoder API requires auth id and code to use their service.")
+        end
+
+        process :xml, submit_url(address)
+      end
+
+      def self.submit_url(address)
+        args = []
+        args << ["app_id", app_id]
+        args << ["app_code", app_code]
+        args << ["additionaldata", "Country2,1"]
+        args << ["language", "en-US"]
+        args << ["gen", "9"]
+
+        address_str = address.is_a?(GeoLoc) ? address.to_geocodeable_s : address
+
+        args << ["searchtext", address_str]
+
+        [api_endpoint, '?', URI.encode_www_form(args)].join('')
+      end
+
+      def self.api_endpoint
+        if ENV['RAKE_ENV'] == 'test'
+          "https://geocoder.cit.api.here.com/6.2/geocode.xml"
+        else
+          "https://geocoder.api.here.com/6.2/geocode.xml"
+        end
+      end
+
+      XML_MAPPINGS = {
+        street_number: "Location/Address/HouseNumber",
+        street_name:   "Location/Address/Street",
+        province:      "Location/Address/County",
+        city:          "Location/Address/City",
+        state_name:    "Location/Address/AdditionalData[@key='StateName']",
+        state_code:    "Location/Address/State",
+        zip:           "Location/Address/PostalCode",
+        country_code:  "Location/Address/AdditionalData[@key='Country2']",
+        country:       "Location/Address/AdditionalData[@key='CountryName']",
+        lat:           "Location/DisplayPosition/Latitude",
+        lng:           "Location/DisplayPosition/Longitude",
+      }
+
+      def self.parse_xml(xml)
+        results = xml.elements.to_a("//Result")
+        return GeoLoc.new if results.nil? || results.count == 0
+        loc = new_loc
+        # only take the first result
+        set_mappings(loc, results.first, XML_MAPPINGS)
+        loc.success = true
+        loc
+      end
+
+    end
+  end
+end

data/spec/cassettes/fake_location.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://geocoder.cit.api.here.com/6.2/geocode.xml?additionaldata=Country2,1&app_code=<HERE_APP_CODE>&app_id=<HERE_APP_ID>&gen=9&language=en-US&searchtext=Abcdefg
+    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:
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - public, max-age=86400
+      Content-Type:
+      - application/xml;charset=utf-8
+      Date:
+      - Thu, 08 Sep 2016 22:12:01 GMT
+      Server:
+      - nginx-clojure
+      X-Nlp-Irt:
+      - '5502'
+      X-Nlp-Log:
+      - Z2NfYz0tIGdjX2w9LSBnY19tPWFk
+      X-Nlp-Tid:
+      - 2f747c34-bc45-4e2a-a3a2-31b5f5ccce59
+      X-Served-By:
+      - i-0a61c712.us-west-2a
+      Content-Length:
+      - '185'
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: <?xml version="1.0" encoding="UTF-8" standalone="yes"?><ns2:Search xmlns:ns2="http://www.navteq.com/lbsp/Search-Search/4"><Response><MetaInfo><Timestamp>2016-09-08T22:12:01.564Z</Timestamp></MetaInfo></Response></ns2:Search>
+    http_version: 
+  recorded_at: Thu, 08 Sep 2016 22:12:01 GMT
+recorded_with: VCR 3.0.3

data/spec/cassettes/permission_denied.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://geocoder.cit.api.here.com/6.2/geocode.xml?additionaldata=Country2,1&app_code=fake&app_id=test&gen=9&language=en-US&searchtext=Sunnyvale,%20CA
+    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:
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - application/xml;charset=utf-8
+      Date:
+      - Thu, 08 Sep 2016 22:12:01 GMT
+      Server:
+      - nginx-clojure
+      X-Nlp-Irt:
+      - '955'
+      X-Nlp-Log:
+      - ''
+      X-Nlp-Tid:
+      - 08b8079e-9848-45d2-ba7c-537c48d49e46
+      X-Served-By:
+      - i-0a61c712.us-west-2a
+      Content-Length:
+      - '170'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: <ns2:Error xmlns:ns2="http://www.navteq.com/lbsp/Errors/1" type="PermissionError"
+        subtype="InvalidCredentials"><Details>invalid credentials for test</Details></ns2:Error>
+    http_version: 
+  recorded_at: Thu, 08 Sep 2016 22:12:01 GMT
+recorded_with: VCR 3.0.3

data/spec/cassettes/sunnyvale_location.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://geocoder.cit.api.here.com/6.2/geocode.xml?additionaldata=Country2,1&app_code=<HERE_APP_CODE>&app_id=<HERE_APP_ID>&gen=9&language=en-US&searchtext=Sunnyvale,%20CA
+    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:
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - public, max-age=86400
+      Content-Type:
+      - application/xml;charset=utf-8
+      Date:
+      - Thu, 08 Sep 2016 22:12:01 GMT
+      Server:
+      - nginx-clojure
+      X-Nlp-Irt:
+      - '4414'
+      X-Nlp-Log:
+      - Z2NfYz1VU0EgZ2NfbD1jaXR5IGdjX209YXI=
+      X-Nlp-Tid:
+      - 06eae949-4ffa-4aaa-9bc2-9b018d2f6a63
+      X-Served-By:
+      - i-0a61c712.us-west-2a
+      Content-Length:
+      - '626'
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: <?xml version="1.0" encoding="UTF-8" standalone="yes"?><ns2:Search xmlns:ns2="http://www.navteq.com/lbsp/Search-Search/4"><Response><MetaInfo><Timestamp>2016-09-08T22:12:01.403Z</Timestamp></MetaInfo><View
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:SearchResultsViewType"><ViewId>0</ViewId><Result><Relevance>1.0</Relevance><MatchLevel>city</MatchLevel><MatchQuality><State>1.0</State><City>1.0</City></MatchQuality><Location><LocationId>NT_FE3T7HawlbK76SxDmyKlUA</LocationId><LocationType>area</LocationType><DisplayPosition><Latitude>37.37172</Latitude><Longitude>-122.03801</Longitude></DisplayPosition><NavigationPosition><Latitude>37.37172</Latitude><Longitude>-122.03801</Longitude></NavigationPosition><MapView><TopLeft><Latitude>37.45103</Latitude><Longitude>-122.06566</Longitude></TopLeft><BottomRight><Latitude>37.3323</Latitude><Longitude>-121.98241</Longitude></BottomRight></MapView><Address><Label>Sunnyvale,
+        CA, United States</Label><Country>USA</Country><State>CA</State><County>Santa
+        Clara</County><City>Sunnyvale</City><PostalCode>94086</PostalCode><AdditionalData
+        key="Country2">US</AdditionalData><AdditionalData key="CountryName">United
+        States</AdditionalData><AdditionalData key="StateName">California</AdditionalData><AdditionalData
+        key="CountyName">Santa Clara</AdditionalData><AdditionalData key="PostalCodeType">N</AdditionalData></Address></Location></Result></View></Response></ns2:Search>
+    http_version: 
+  recorded_at: Thu, 08 Sep 2016 22:12:01 GMT
+recorded_with: VCR 3.0.3

data/spec/geokit_here_geocoder_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Geokit::Geocoders::HereGeocoder do
+
+  let(:address) { "Sunnyvale, CA" }
+
+  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::HereGeocoder.app_id = "test"
+      Geokit::Geocoders::HereGeocoder.app_code = "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::HereGeocoder.app_id = ENV['HERE_APP_ID']
+      Geokit::Geocoders::HereGeocoder.app_code = ENV['HERE_APP_CODE']
+    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.province     ).to eq "Santa Clara"
+        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 "94086"
+        expect( subject.country_code ).to eq "US"
+        expect( subject.country      ).to eq "United States"
+        expect( subject.lat          ).to eq 37.37172
+        expect( subject.lng          ).to eq -122.03801
+      end
+    end
+
+    context "fake location" do
+
+      let(:address) { "Abcdefg" }
+
+      it 'returns invalid location' do
+        VCR.use_cassette("fake_location") do
+          expect( subject.success? ).to be false
+        end
+      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_here_geocoder'
+
+require "vcr"
+
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/cassettes"
+  config.hook_into :webmock
+
+  config.filter_sensitive_data('<HERE_APP_ID>') { ENV['HERE_APP_ID'] }
+  config.filter_sensitive_data('<HERE_APP_CODE>') { ENV['HERE_APP_CODE'] }
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: geokit_here_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'
+description: Geokit custom geocoder for Here.com service
+email:
+- serhiy@easypost.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- circle.yml
+- geokit_here_geocoder.gemspec
+- lib/geokit_here_geocoder.rb
+- spec/cassettes/fake_location.yml
+- spec/cassettes/permission_denied.yml
+- spec/cassettes/sunnyvale_location.yml
+- spec/geokit_here_geocoder_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/easypost/geokit_here_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 Here.com service
+test_files:
+- spec/cassettes/fake_location.yml
+- spec/cassettes/permission_denied.yml
+- spec/cassettes/sunnyvale_location.yml
+- spec/geokit_here_geocoder_spec.rb
+- spec/spec_helper.rb