phl_geocode 0.1.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.3"
+script: rake

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gem "json"
+
+group :development do
+  gem "rake", "10.0.1"
+  gem "rspec", "2.12.0"
+  gem "mocha"
+  gem "bundler", "1.2.2"
+  gem "rdoc", "~> 3.12"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov"
+end

data/Gemfile.lock

@@ -0,0 +1,43 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    metaclass (0.0.1)
+    mocha (0.13.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.7)
+    rake (10.0.1)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (= 1.2.2)
+  jeweler (~> 1.8.4)
+  json
+  mocha
+  rake (= 10.0.1)
+  rdoc (~> 3.12)
+  rspec (= 2.12.0)
+  simplecov

data/README.md

@@ -0,0 +1,50 @@
+[![Build Status](https://secure.travis-ci.org/mdb/phl_geocode.rb.png?branch=master)](https://travis-ci.org/mdb/phl_geocode.rb)
+
+# phl_geocode
+
+A Ruby gem for getting latitude and longitude coordinates for a Philadelphia address.
+
+This is the Ruby version of the Node.js [phl-geocoder](http://github.com/mdb/phl-geocoder).
+
+The gem uses Philadelphia's [311 Mobile Data Service API](http://services.phila.gov/ULRS311).
+
+## Get lat/long coordinates for a Philadelphia Address:
+
+    require "phl_geocode"
+    phl = PHLGeocode.new
+    phl.get_coordinates "1500 Market Street"
+
+Example response:
+    
+    [{
+      :address => "1500 MARKET ST",
+      :similarity => 100,
+      :latitude => 39.9521740263203,
+      :longitude => -75.1661518986459
+    }, {
+      :address => "1500S MARKET ST",
+      :similarity => 99,
+      :latitude => 39.9521740263203,
+      :longitude => -75.1661518986459
+    }]
+
+## Get the address key for a Philadelphia Address:
+
+    require "phl_geocode"
+    phl = PHLGeocode.new
+    phl.get_address_key "1500 Market Street"
+
+Example response:
+
+    {
+      :agency_id => "26",
+      :topic_name => "AddressKeys",
+      :topic_id => "410526",
+      :address_ref => "01500 MARKET ST"
+    }
+
+## Override default settings:
+
+    require "phl_geocode"
+    phl = PHLGeocode.new :min_confidence => 100
+    phl.get_coordinates "1500 Market Street"

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "phl_geocode"
+  gem.homepage = "http://github.com/mdb/phl_geocode.rb"
+  gem.license = "MIT"
+  gem.summary = %Q{A Ruby gem that gets latitude and longitude coordinates for a Philadelphia address.}
+  gem.description = %Q{Get latitude and longitude coordinates for a Philadelphia address.}
+  gem.email = "mikedball@gmail.com"
+  gem.authors = ["Mike Ball"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "phl_geocode #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/phl_geocode.rb

@@ -0,0 +1,82 @@
+require "json"
+require "open-uri"
+require "net/http"
+
+class PHLGeocode
+  attr_accessor :address_key_response
+  attr_accessor :coordinates_response
+  attr_accessor :last_queried_address_key_addr
+  attr_accessor :last_queried_coordinates_addr
+  attr_accessor :settings
+
+  def initialize(options={})
+    @settings = {
+      :min_confidence => 85,
+      :api_base => "http://services.phila.gov",
+      :location_path => "/ULRS311/Data/Location/",
+      :address_key_path => "/ULRS311/Data/LIAddressKey/"
+    }.merge(options)
+  end
+
+  def get_coordinates(address=nil)
+    raise ArgumentError("Argument must be a string") unless address.is_a? String
+
+    if address == @last_queried_coordinates_addr
+      @coordinates_response ||= call_api('coordinates', address)
+    else
+      @coordinates_response = call_api('coordinates', address)
+      @last_queried_coordinates_addr = address
+    end
+
+    parse_locations @coordinates_response
+  end
+
+  def get_address_key(address=nil)
+    raise ArgumentError("Argument must be a string") unless address.is_a? String
+
+    if address == @last_queried_address_key_addr
+      @address_key_response ||= call_api('address_key', address)
+    else
+      @address_key_response = call_api('address_key', address)
+      @last_queried_address_key_addr = address
+    end
+
+    parse_address_key @address_key_response
+  end
+
+  private
+  def parse_address_key(response)
+    key_json = JSON.parse(response.body)
+    
+    {
+      :agency_id => key_json["AgencyID"],
+      :topic_name => key_json["TopicName"],
+      :topic_id => key_json["TopicID"],
+      :address_ref => key_json["AddressRef"]
+    }
+  end
+
+  def parse_locations(response)
+    locations_json = JSON.parse(response.body)["Locations"]
+
+    locations_json.find_all { |loc|
+      loc["Address"]["Similarity"] >= @settings[:min_confidence]
+    }.map { |item|
+      {
+      :address => item["Address"]["StandardizedAddress"],
+      :similarity => item["Address"]["Similarity"],
+      :latitude => item["YCoord"],
+      :longitude => item["XCoord"]
+      }
+    }
+  end
+
+  def call_api(type, address)
+    addr = URI::encode(address)
+    type_path_map = {
+      :coordinates => @settings[:location_path],
+      :address_key => @settings[:address_key_path]
+    }
+    Net::HTTP.get_response(URI.parse("#{@settings[:api_base]}#{type_path_map[type.to_sym]}#{addr}"))
+  end
+end

data/phl_geocode.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "phl_geocode"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mike Ball"]
+  s.date = "2012-12-17"
+  s.description = "Get latitude and longitude coordinates for a Philadelphia address."
+  s.email = "mikedball@gmail.com"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/phl_geocode.rb",
+    "phl_geocode.gemspec",
+    "spec/fixtures/fake_http_response_body.json",
+    "spec/lib/phl_geocode_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/mdb/phl_geocode.rb"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "A Ruby gem that gets latitude and longitude coordinates for a Philadelphia address."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<rake>, ["= 10.0.1"])
+      s.add_development_dependency(%q<rspec>, ["= 2.12.0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["= 1.2.2"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<rake>, ["= 10.0.1"])
+      s.add_dependency(%q<rspec>, ["= 2.12.0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["= 1.2.2"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<rake>, ["= 10.0.1"])
+    s.add_dependency(%q<rspec>, ["= 2.12.0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["= 1.2.2"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/spec/fixtures/fake_http_response_body.json

@@ -0,0 +1 @@
+{"OriginalAddress":"1500 market street","Locations":[{"Address":{"StandardizedAddress":"FAKE ADDRESS","AliasMatch":null,"Similarity":100,"StreetNumber":1500,"StreetNumberSuffix":null,"Unit":"","StreetCode":53560,"StreetFullName":"MARKET ST","StreetPrefix":null,"StreetName":"MARKET","StreetType":"ST","StreetSuffix":null,"StreetCode2":0,"StreetFullName2":null,"StreetPrefix2":null,"StreetName2":null,"StreetType2":null,"StreetSuffix2":null},"XCoord":-75.1661518986459,"YCoord":39.9521740263203,"MatchType":1,"SegmentID":421333,"SegmentID2":-1},{"Address":{"StandardizedAddress":"1500S MARKET ST","AliasMatch":null,"Similarity":99,"StreetNumber":1500,"StreetNumberSuffix":"S","Unit":"","StreetCode":53560,"StreetFullName":"MARKET ST","StreetPrefix":null,"StreetName":"MARKET","StreetType":"ST","StreetSuffix":null,"StreetCode2":0,"StreetFullName2":null,"StreetPrefix2":null,"StreetName2":null,"StreetType2":null,"StreetSuffix2":null},"XCoord":-75.1661518986459,"YCoord":39.9521740263203,"MatchType":2,"SegmentID":421333,"SegmentID2":-1}]}

data/spec/lib/phl_geocode_spec.rb

@@ -0,0 +1,127 @@
+require "spec_helper"
+
+describe PHLGeocode do
+  before :each do
+    phl_geocode_root = File.expand_path(File.dirname(File.dirname(File.dirname(__FILE__))))
+    fake_resp_body_file = File.join(phl_geocode_root, "spec", "fixtures", "fake_http_response_body.json")
+    @fake_http_response_body = File.open(fake_resp_body_file).read
+  end
+
+  describe "#new" do
+    before :each do
+      @phl = PHLGeocode.new
+    end
+
+    it "creates a new PHLGeocode instance" do 
+      @phl.class.should == PHLGeocode
+    end
+
+    context "it is not passed any options" do
+      it "creates a :settings hash with some default settings" do
+        @phl.settings[:min_confidence].should eq 85
+        @phl.settings[:api_base].should eq "http://services.phila.gov"
+        @phl.settings[:location_path].should eq "/ULRS311/Data/Location/"
+        @phl.settings[:address_key_path].should eq "/ULRS311/Data/LIAddressKey/"
+      end
+    end
+
+    context "it is passed options on instantiation" do
+      it "has a settings hash set to the value of the options its passed" do
+        phl = PHLGeocode.new :min_confidence => 100
+        phl.settings[:min_confidence].should == 100
+      end
+
+      it "preserves default settings if no overriding values are passed in the options" do
+        phl = PHLGeocode.new :foo => "bar"
+        phl.settings[:min_confidence].should == 85
+        phl.settings[:foo].should == "bar"
+      end
+    end
+  end
+
+  describe "#get_coordinates" do
+    before :each do
+      @phl = PHLGeocode.new
+      @http_mock = mock("Net::HTTP")
+      @http_mock.stubs(
+        :code => 200,
+        :message => "OK",
+        :content_type => "application/json",
+        :body => @fake_http_response_body
+      )
+      Net::HTTP.stub(:get_response).and_return @http_mock 
+    end
+
+    it "exists as a method on a PHLGeocode" do
+      @phl.respond_to?(:get_coordinates).should == true
+    end
+
+    it "raises an error if it is not passed a valid string argument" do
+      lambda { @phl.get_coordinates }.should raise_error
+      lambda { @phl.get_coordinates(3) }.should raise_error
+      lambda { @phl.get_coordinates(nil) }.should raise_error
+      lambda { @phl.get_coordinates({}) }.should raise_error
+    end
+
+    it "makes a properly formatted API call to the proper endpoint" do
+      Net::HTTP.should_receive(:get_response).with(URI.parse("http://services.phila.gov/ULRS311/Data/Location/some%20address"))
+      @phl.get_coordinates "some address"
+    end
+
+    it "sets :coordinates_response to the value of the API call response" do
+      @phl.get_coordinates "some address"
+      @phl.coordinates_response.should == @http_mock
+    end
+
+    it "returns an array of locations whose :similarity is greater than or equal to :settings.min_confidence" do
+      @phl.get_coordinates("some address")[0][:similarity].should == 100
+    end
+
+    it "returns an array of locations, each of which reports a :latitude" do
+      @phl.get_coordinates("some address")[0][:latitude].should == 39.9521740263203
+    end
+
+    it "returns an array of locations, each of which reports a :longitude" do
+      @phl.get_coordinates("some address")[0][:longitude].should == -75.1661518986459
+    end
+
+    it "returns an array of locations, each of which reports a standardized address as :address" do
+      @phl.get_coordinates("some address")[0][:address].should == "FAKE ADDRESS"
+    end
+  end
+
+  describe "#get_address_key" do
+    before :each do
+      @phl = PHLGeocode.new
+      @http_mock = mock("Net::HTTP")
+      @http_mock.stubs(
+        :code => 200,
+        :message => "OK",
+        :content_type => "application/json",
+        :body => {foo: "bar"}.to_json
+      )
+      Net::HTTP.stub(:get_response).and_return @http_mock 
+    end
+
+    it "exists as a method on a PHLGeocode" do
+      @phl.respond_to?(:get_address_key).should eq true
+    end
+
+    it "raises an error if it is not passed a valid string argument" do
+      lambda { @phl.get_address_key }.should raise_error
+      lambda { @phl.get_address_key(3) }.should raise_error
+      lambda { @phl.get_address_key(nil) }.should raise_error
+      lambda { @phl.get_address_key({}) }.should raise_error
+    end
+
+    it "makes a properly formatted API call to the proper endpoint" do
+      Net::HTTP.should_receive(:get_response).with(URI.parse("http://services.phila.gov/ULRS311/Data/LIAddressKey/some%20address"))
+      @phl.get_address_key "some address"
+    end
+
+    it "sets :address_key_response to the value of the API call response" do
+      @phl.get_address_key "some address"
+      @phl.address_key_response.should == @http_mock
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rspec'
+require 'bundler/setup'
+require 'simplecov'
+require 'mocha/api'
+SimpleCov.start
+
+require_relative '../lib/phl_geocode'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: phl_geocode
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Mike Ball
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Get latitude and longitude coordinates for a Philadelphia address.
+email: mikedball@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
+- lib/phl_geocode.rb
+- phl_geocode.gemspec
+- spec/fixtures/fake_http_response_body.json
+- spec/lib/phl_geocode_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/mdb/phl_geocode.rb
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2260791247020255392
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Ruby gem that gets latitude and longitude coordinates for a Philadelphia
+  address.
+test_files: []