geokit-nominatim 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'json_pure'
+gem 'geokit'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec" #, "~> 2.3.0"
+  gem "bundler" #, "~> 1.0.0"
+  gem "jeweler" #, "~> 1.6.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Andrew Williams
+
+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.rdoc

@@ -0,0 +1,40 @@
+= geokit-nominatim
+
+Nominatim geocoding provider for geokit.
+
+- GeoKit: http://geokit.rubyforge.org/
+- Nominatim: http://wiki.openstreetmap.org/wiki/Nominatim
+- MapQuest service: http://developer.mapquest.com/web/products/open/nominatim
+
+== Synopsis
+
+Set up nominatim as a geocoder provider
+
+   Geokit::Geocoders::provider_order = [:nominatim]
+
+Set the address of the Nominatim server to use.
+see http://developer.mapquest.com/web/products/open/nominatim for usage policy.
+
+   Geokit::Geocoders::NominatimGeocoder.server = "open.mapquestapi.com/nominatim/v1/search"
+
+geocode an address
+
+   include Geokit::Geocoders
+   res = MultiGeocoder.geocode('100 Spear st, San Francisco, CA')
+   puts res.ll # ll=latitude,longitude
+
+== Contributing to geokit-nominatim
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Andrew Williams.
+See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# 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 = "geokit-nominatim"
+  gem.homepage = "http://github.com/sobakasu/geokit-nominatim"
+  gem.license = "MIT"
+  gem.summary = %Q{Nominatim geocoding provider for geokit}
+  gem.description = %Q{Nominatim geocoding provider for geokit}
+  gem.email = "sobakasu@gmail.com"
+  gem.authors = ["Andrew Williams"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "geokit-nominatim #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/geokit-nominatim.gemspec

@@ -0,0 +1,66 @@
+# 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 = %q{geokit-nominatim}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andrew Williams"]
+  s.date = %q{2011-06-25}
+  s.description = %q{Nominatim geocoding provider for geokit}
+  s.email = %q{sobakasu@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "geokit-nominatim.gemspec",
+    "lib/geokit-nominatim.rb",
+    "lib/geokit/geocoders/nominatim_geocoder.rb",
+    "spec/nominatim_geocoder_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/sobakasu/geokit-nominatim}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Nominatim geocoding provider for geokit}
+
+  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_pure>, [">= 0"])
+      s.add_runtime_dependency(%q<geokit>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<json_pure>, [">= 0"])
+      s.add_dependency(%q<geokit>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<json_pure>, [">= 0"])
+    s.add_dependency(%q<geokit>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/geokit/geocoders/nominatim_geocoder.rb

@@ -0,0 +1,69 @@
+class Geokit::Geocoders::NominatimGeocoder < Geokit::Geocoders::Geocoder
+
+  PLACE_KEYS = %W{city state postcode country country_code house_number house
+                  hamlet}
+  PROVIDER = 'nominatim'
+
+  class << self
+    attr_accessor :server
+  end
+
+  def self.do_geocode(address, options = {})
+    # get server address
+    server = options[:server] || self.server
+    raise "server required" unless server
+    server = "http://#{server}" unless server.match(/^http:/)
+
+    # construct response
+    res = Geokit::GeoLoc.new
+    res.provider = PROVIDER
+
+    # create query string
+    address_str = address.is_a?(Geokit::GeoLoc) ? address.to_geocodeable_s : address
+    opts = options.merge(:q => address_str, :limit => 1,
+                         :format => :xml, :addressdetails => 1)
+    opts.delete(:server)
+    params = opts.collect { |k,v| "#{k}=#{escape(v)}" }.join("&")
+
+    # send query
+    url = "#{server}?#{params}"
+    server_res = self.call_geocoder_service(url)
+    return res if !server_res.is_a?(Net::HTTPSuccess)
+
+    # parse response
+    xml = server_res.body
+    logger.debug "nominatim geocoding. Address: #{address}. Result: #{xml}"
+    self.parse_response(xml, res)
+    res
+  end
+
+  private
+
+  def self.parse_response(xml, res)
+    doc = REXML::Document.new(xml)
+
+    place = doc.elements['//searchresults/place']
+    attrs = place.attributes
+    res.lat = attrs['lat']
+    res.lng = attrs['lon']
+
+    elements = {}
+    PLACE_KEYS.each do |key|
+      elements[key] = place.elements[key] ? place.elements[key].text : nil
+    end
+
+    res.full_address = attrs['display_name']
+    res.street_address = elements['road']
+    res.zip = elements['postcode']
+    res.country = elements['country']
+    res.city = elements['city'] || elements['hamlet']
+    res.state = elements['state']
+    res.street_number = elements['house_number'] || elements['house']
+    res.success = true
+  end
+
+  def self.escape(string)
+    Geokit::Inflector::url_escape(string.to_s)
+  end
+
+end

data/lib/geokit-nominatim.rb

@@ -0,0 +1,6 @@
+
+path = File.expand_path(File.dirname(__FILE__))
+$:.unshift path unless $:.include?(path)
+
+require 'geokit'
+require 'geokit/geocoders/nominatim_geocoder'

data/spec/nominatim_geocoder_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class NominatimTests
+
+  def self.geocode_tests
+    [ ["Adelaide", {
+         :lat => -34.927, :lng => 138.600,
+         :zip => "5000", :country => "Australia", :city => "Adelaide",
+         :state => "South Australia"
+       }],
+      ["359 Columbus Avenue, New York", {
+         :lat => 40.717, :lng => -73.338,
+         :zip => '11704', :street_number => '359',
+         :country => "United States of America", :city => "West Babylon",
+         :state => "New York"
+       }]
+    ]
+  end
+
+end
+
+describe Geokit::Geocoders::NominatimGeocoder do
+
+  before(:all) do
+    @klass = Geokit::Geocoders::NominatimGeocoder
+    @server = ENV['NOMINATIM_SERVER']
+  end
+
+  it "should respond to do_geocode()" do
+    @klass.should respond_to(:do_geocode)
+  end
+
+  it "should be usable from MultiGeocoder" do
+    @klass.should_receive(:geocode).and_return(Geokit::GeoLoc.new)
+
+    Geokit::Geocoders::provider_order = [:nominatim]
+    Geokit::Geocoders::MultiGeocoder.geocode('test address')
+  end
+
+  NominatimTests.geocode_tests.each do |addr, expected|
+    it "should geocode #{addr}" do
+      @klass.server = @server
+      res = @klass.geocode(addr)
+      res.should_not be_nil
+      res.success.should be_true
+      res.lat.should be_within(0.1).of(expected[:lat])
+      res.lng.should be_within(0.1).of(expected[:lng])
+
+      expected.each do |k,v|
+        next if [:lat, :lng].include?(k)
+        res.send(k).should == v
+      end
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'geokit-nominatim'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end
+
+unless ENV['NOMINATIM_SERVER']
+  puts "NOMINATIM_SERVER environment setting required"
+  exit 1
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: geokit-nominatim
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-25 00:00:00.000000000 +09:30
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  requirement: &2152833080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152833080
+- !ruby/object:Gem::Dependency
+  name: geokit
+  requirement: &2152832100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152832100
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152831220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152831220
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2152830320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152830320
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2152829580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152829580
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2152828720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152828720
+description: Nominatim geocoding provider for geokit
+email: sobakasu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- geokit-nominatim.gemspec
+- lib/geokit-nominatim.rb
+- lib/geokit/geocoders/nominatim_geocoder.rb
+- spec/nominatim_geocoder_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/sobakasu/geokit-nominatim
+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: 2076618883302095355
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Nominatim geocoding provider for geokit
+test_files: []