geocoder-sensis 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ee86bd708259c0c624d03ebd1623a4de4a65b16
+  data.tar.gz: e4746d5443ffe168b4dc680f70f5aef401c11f2c
+SHA512:
+  metadata.gz: b4319a758539ec3aef97e2475266f25cb132e8b06b649989929d61aa83b88e9c2eb1077849b2b6bc6b3e776de04ad138b658e1eaf64572b8b7e1e4a5d39695a4
+  data.tar.gz: 42f229bda8568a4f737a754987e942be1fc3cad05365f6fa0de1808109e482e5fbacb961ab0ab744f307bfb2ccd10ed04c99824ca3180d64567d71829ebbf757

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+secrets

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Daniel Heath
+
+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,32 @@
+# Geocoder::Sensis
+
+Implements a Sensis Geocoder backend for the geocoder gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'geocoder-sensis'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install geocoder-sensis
+
+## Usage
+
+Geocoder.configure(
+  :lookup => :sensis,
+  :api_key => "..."
+)
+
+## Contributing
+
+1. Fork it ( http://github.com/DanielHeath/geocoder-sensis/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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/geocoder-sensis.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'geocoder/sensis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "geocoder-sensis"
+  spec.version       = Geocoder::Sensis::VERSION
+  spec.authors       = ["Daniel Heath"]
+  spec.email         = ["daniel@heath.cc"]
+  spec.summary       = %q{Implements a Sensis Geocoder backend for the geocoder gem.}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "geocoder"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-debugger"
+end

data/lib/geocoder/sensis.rb

@@ -0,0 +1,131 @@
+require "geocoder"
+require "geocoder/sensis/version"
+
+module Geocoder
+
+  module Lookup
+
+    # Yuck. Geocoder gem doesn't offer a straightforward way
+    # to register new implementations. This module patches
+    # the 'sensis' lookup method into the known geocoders array
+    module AddSensisToStreetServices
+      def street_services
+        super + [:sensis_unstructured, :sensis_structured]
+      end
+    end
+    extend AddSensisToStreetServices
+
+    # Actual implementation
+    class SensisBase < Base
+
+      def required_api_key_parts
+        ["auth token", "auth password"]
+      end
+
+      def query_url(query)
+        "https://#{sensis_host}/v2/service/geocode/#{request_type}" + url_query_string(query)
+      end
+
+      def protocol
+        "https"
+      end
+
+      def results(query)
+        doc = fetch_data(query)
+        return [] unless doc
+        raise Exception.new('Incorrect API key') if doc["code"] == 401
+        doc["results"]
+      end
+
+      ##
+      # Override the base method because it's hard-coded to use Get.
+      # TODO: Raise PR upstream to allow other request methods.
+      #
+      def make_api_request(query)
+        timeout(configuration.timeout) do
+          uri = URI.parse(query_url(query))
+          http_client.start(uri.host, uri.port, :use_ssl => true) do |client|
+            req = Net::HTTP::Post.new(uri.request_uri, configuration.http_headers)
+            req.basic_auth(uri.user, uri.password) if uri.user and uri.password
+            req.body = sensis_query_json(query)
+            req.content_type = 'application/json'
+            req['X-Auth-Token'] = configuration.api_key[0]
+            req['X-Auth-Password'] = configuration.api_key[1]
+            client.request(req)
+          end
+        end
+      end
+
+      def result_class
+        ::Geocoder::Result::Sensis
+      end
+
+    private
+
+      def sensis_host
+        ENV["SENSIS_GEOCODE_HOST"] || "api-ems-cstage.ext.sensis.com.au"
+      end
+
+      # Structured or unstructured
+      def request_type
+        fail
+      end
+
+      # A json hash
+      def sensis_query_json(query)
+        fail
+      end
+
+    end
+
+    class SensisUnstructured < SensisBase
+      def name
+        :sensis_unstructured
+      end
+
+      def request_type
+        :unstructured
+      end
+
+      def sensis_query_json(query)
+        {"query" => query.text}.to_json
+      end
+
+    end
+
+    class SensisStructured < SensisBase
+      def name
+        :sensis_structured
+      end
+
+      def request_type
+        :structured
+      end
+
+      def sensis_query_json(query)
+        {"address" => query.text}.to_json
+      end
+
+    end
+
+  end
+
+  module Result
+
+    class Sensis < Base
+
+      def coordinates
+        ['lat', 'lon'].map{ |i| @data['geometry']['centre'][i] }
+      end
+
+      def precision
+        granularity
+      end
+
+      def granularity
+        @data["granularity"]
+      end
+    end
+
+  end
+end

data/lib/geocoder/sensis/version.rb

@@ -0,0 +1,5 @@
+module Geocoder
+  module Sensis
+    VERSION = "0.0.1"
+  end
+end

data/spec/lib/geocoder/sensis_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+require 'geocoder/sensis'
+
+describe Geocoder::Sensis do
+
+  describe "Geocoding an address via unstructured api" do
+    before do
+      Geocoder.configure(
+        :lookup => :sensis_unstructured,
+        :api_key => [sensis_api_token, sensis_api_password],
+        :use_https => true,
+        :timeout => 30000
+      )
+    end
+
+    it "patches the known geocoders array to include sensis" do
+      expect(Geocoder::Lookup.street_services).to include(:sensis_unstructured)
+      expect(Geocoder::Lookup.street_services).to include(:sensis_structured)
+    end
+
+    it "connects to sensis" do
+      api = mock_sensis_api :request_type => :unstructured
+      Geocoder.coordinates('12 Powlett Street, East Melbourne')
+      api.should have_been_requested
+    end
+
+    it "returns the geocode from sensis" do
+      mock_sensis_api :request_type => :unstructured,
+        :latitude => 44.66,
+        :longitude => 55.66
+      coords = Geocoder.coordinates('12 Powlett Street, East Melbourne')
+      expect(coords).to eq [44.66, 55.66]
+    end
+
+  end
+
+  describe "Geocoding an address via structured api" do
+    before do
+      Geocoder.configure(
+        :lookup => :sensis_structured,
+        :api_key => [sensis_api_token, sensis_api_password],
+        :use_https => true,
+        :timeout => 30000
+      )
+      mock_sensis_api :request_type => :structured,
+        :address => '12 Powlett Street, East Melbourne',
+        :latitude => 44.66,
+        :longitude => 55.66
+    end
+
+    it "returns the geocode from sensis" do
+      coords = Geocoder.coordinates(
+        "state" => "Vic",
+        "suburb" => "Richmond",
+        "postcode" => "3121",
+        "number" => "9",
+        "street" => {
+          "name" => "Victoria",
+          "type" => "Street",
+          "suffix" => ""
+      })
+
+      expect(coords).to eq [44.66, 55.66]
+    end
+
+  end
+
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'bundler'
+Bundler.require
+
+require 'webmock/rspec'
+require 'support/mock_sensis'
+
+TEST_AGAINST_REAL_SENSIS = ENV["TEST_REMOTE_API"]
+
+if TEST_AGAINST_REAL_SENSIS
+  WebMock.allow_net_connect!
+else
+  WebMock.disable_net_connect!
+end

data/spec/support/mock_sensis.rb

@@ -0,0 +1,93 @@
+require 'json'
+
+def sensis_api_token
+  if TEST_AGAINST_REAL_SENSIS
+    File.read("secrets/token").strip
+  else
+    "SAMPLE_API_TOKEN"
+  end
+end
+
+def sensis_api_password
+  if TEST_AGAINST_REAL_SENSIS
+    File.read("secrets/password").strip
+  else
+    "SAMPLE_API_PASSWORD"
+  end
+end
+
+def mock_sensis_api(options = {})
+  sensis_response = SensisResponse.new(options)
+
+  stub_request(:post, sensis_response.uri).
+    with(
+      :headers => {
+        'X-Auth-Token' => sensis_api_token,
+        'X-Auth-Password' => sensis_api_password
+    }).
+    to_return(:status => sensis_response.code, :body => sensis_response.raw, :headers => {})
+end
+
+
+class SensisResponse
+  attr_reader :request_address, :request_type, :latitude, :longitude, :street_lat, :street_lon, :granularity, :code, :state, :suburb
+
+  def initialize(options = {})
+    defaults.merge(options).each do |k, v|
+      self.instance_variable_set("@#{k}", v)
+    end
+  end
+
+  def defaults
+    {
+      suburb: "RICHMOND",
+      state: "VIC",
+      response_code: 200,
+      granularity: "PROPERTY",
+      address: "678 Victoria street, Richmond, Vic",
+      latitude: -37.812571,
+      longitude: 145.014029,
+      street_lat: -37.1234343,
+      street_lon: 145.069672934
+    }
+  end
+
+  def host
+    ENV["SENSIS_GEOCODE_HOST"] || "api-ems-cstage.ext.sensis.com.au"
+  end
+
+  def uri
+    "https://#{host}/v2/service/geocode/#{request_type}"
+  end
+
+  def address
+    request_address.to_s.upcase
+  end
+
+  def raw
+    raw_hash.to_json
+  end
+
+  def raw_hash
+    {results: [{
+      approximated: false,
+      granularity: granularity,
+      address: {
+        display: address,
+        state: state,
+        suburb: suburb
+      },
+      geometry: {
+        centre: {
+            lon: longitude,
+            lat: latitude
+        },
+        street: {
+            lon: street_lon,
+            lat: street_lat
+        }
+      }
+    }]}
+  end
+
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: geocoder-sensis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Heath
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: geocoder
+  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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: 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: pry
+  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: pry-debugger
+  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: ''
+email:
+- daniel@heath.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- geocoder-sensis.gemspec
+- lib/geocoder/sensis.rb
+- lib/geocoder/sensis/version.rb
+- spec/lib/geocoder/sensis_spec.rb
+- spec/spec_helper.rb
+- spec/support/mock_sensis.rb
+homepage: ''
+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.0
+signing_key: 
+specification_version: 4
+summary: Implements a Sensis Geocoder backend for the geocoder gem.
+test_files:
+- spec/lib/geocoder/sensis_spec.rb
+- spec/spec_helper.rb
+- spec/support/mock_sensis.rb