osmn 0.1.0

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/osmn/base.rb

@@ -0,0 +1,35 @@
+require 'open-uri'
+require 'net/http'
+require 'json'
+
+module OSMN
+  class Base
+
+  private
+    def build_query(params)
+      query = params.map do |key, value|
+        "#{key.to_s}=#{URI.escape(value.to_s)}" if value
+      end.compact.join('&')
+    end
+
+    def build_results(response)
+      parsed = JSON.parse(response)
+
+      return case parsed
+             when Hash then build_place(parsed)
+             when Array then parsed.map{ |place| build_place(place) }
+             end
+    end
+
+    def build_place(place)
+      if place.is_a? Hash
+        result = place.to_struct('Result')
+        if result.respond_to?('address')
+          result.address = result.address.to_struct('Address')
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/osmn/hash.rb

@@ -0,0 +1,5 @@
+class Hash
+  def to_struct(name)
+    Struct.new(name, *keys).new(*values)
+  end
+end

data/lib/osmn/reverse.rb

@@ -0,0 +1,36 @@
+module OSMN
+  class Reverse < OSMN::Base
+
+    def initialize(params)
+      @params = {}
+      self.params = params
+    end
+
+    def reverse_geocode
+      if @params[:lat] && @params[:lon]
+        query = build_query(@params)
+
+        uri = URI("http://nominatim.openstreetmap.org/reverse?#{query}")
+        request = Net::HTTP::Get.new(uri.request_uri, initheader = {'Content-Type' => 'application/json'})
+        response = Net::HTTP.start(uri.host, uri.port) {|http| http.request(request)}
+
+        results = build_results(response.body) if response.code == '200'
+      end
+    end
+
+    def params=(value)
+      if value.is_a? Hash
+        value.each do |k,v|
+          @params[k.to_sym] = v unless v.nil?
+        end
+      end
+
+      # We override the format because we expect a JSON response
+      @params[:format] = :json
+    end
+
+    def params
+      @params
+    end
+  end
+end

data/lib/osmn/search.rb

@@ -0,0 +1,36 @@
+module OSMN
+  class Search < OSMN::Base
+
+    def initialize(params)
+      @params = {}
+      self.params = params
+    end
+
+    def search
+      if @params[:q]
+        query = build_query(@params)
+
+        uri = URI("http://nominatim.openstreetmap.org/search?#{query}")
+        request = Net::HTTP::Get.new(uri.request_uri, initheader = {'Content-Type' => 'application/json'})
+        response = Net::HTTP.start(uri.host, uri.port) {|http| http.request(request)}
+
+        results = build_results(response.body) if response.code == '200'
+      end
+    end
+
+    def params=(value)
+      if value.is_a? Hash
+        value.each do |k,v|
+          @params[k.to_sym] = v unless v.nil?
+        end
+      end
+
+      # We override the format because we expect a JSON response
+      @params[:format] = :json
+    end
+
+    def params
+      @params
+    end
+  end
+end

data/lib/osmn/version.rb

@@ -0,0 +1,3 @@
+module OSMN
+  VERSION = '0.1.0'
+end

data/lib/osmn.rb

@@ -0,0 +1,19 @@
+require 'osmn/base'
+require 'osmn/search'
+require 'osmn/reverse'
+require 'osmn/version'
+require 'osmn/hash'
+
+module OSMN
+
+  def self.search(q = nil, details = 0)
+    search = Search.new(:q => q, :addressdetails => details)
+    search.search
+  end
+
+  def self.reverse_geocode(lat = nil, lon = nil, details = 0)
+    search = Reverse.new(:lat => lat, :lon => lon, :addressdetails => details)
+    search.reverse_geocode
+  end
+
+end

data/test/test_osmn.rb

@@ -0,0 +1,116 @@
+require 'test/unit'
+require 'osmn'
+
+class Tests < Test::Unit::TestCase
+
+  def test_nil_search
+    response = OSMN::search
+
+    assert_equal(nil, response)
+  end
+
+  def test_nil_reverse
+    response = OSMN::reverse_geocode
+
+    assert_equal(nil, response)
+  end
+
+  def test_search
+    response = OSMN::search('135 pilkington avenue, birmingham')[0]
+
+    assert_equal('62311100', response.place_id)
+  end
+
+  def test_reverse
+    response = OSMN::reverse_geocode(52.5487429714954, -1.81602098644987)
+
+    assert_equal('62762024', response.place_id)
+  end
+
+  def test_search
+    response = OSMN::search('135 pilkington avenue, birmingham', 0)[0]
+
+    assert_respond_to(response, :place_id)
+    assert_respond_to(response, :licence)
+    assert_respond_to(response, :osm_type)
+    assert_respond_to(response, :osm_id)
+    assert_respond_to(response, :boundingbox)
+    assert_respond_to(response, :lat)
+    assert_respond_to(response, :lon)
+    assert_respond_to(response, :display_name)
+    assert_respond_to(response, :class)
+    assert_respond_to(response, :type)
+
+    assert_raise NoMethodError do
+      response.address
+    end
+  end
+
+
+  def test_search_with_details
+    response = OSMN::search('135 pilkington avenue, birmingham', 1)[0]
+
+    assert_respond_to(response, :place_id)
+    assert_respond_to(response, :licence)
+    assert_respond_to(response, :osm_type)
+    assert_respond_to(response, :osm_id)
+    assert_respond_to(response, :boundingbox)
+    assert_respond_to(response, :lat)
+    assert_respond_to(response, :lon)
+    assert_respond_to(response, :display_name)
+    assert_respond_to(response, :class)
+    assert_respond_to(response, :type)
+    assert_respond_to(response, :address)
+
+    assert_respond_to(response.address, :house_number)
+    assert_respond_to(response.address, :road)
+    assert_respond_to(response.address, :suburb)
+    assert_respond_to(response.address, :city)
+    assert_respond_to(response.address, :county)
+    assert_respond_to(response.address, :state_district)
+    assert_respond_to(response.address, :state)
+    assert_respond_to(response.address, :postcode)
+    assert_respond_to(response.address, :country)
+    assert_respond_to(response.address, :country_code)
+  end
+
+  def test_reverse_geocode
+    response = OSMN::reverse_geocode(52.5487429714954, -1.81602098644987, 0)
+
+    assert_respond_to(response, :place_id)
+    assert_respond_to(response, :licence)
+    assert_respond_to(response, :osm_type)
+    assert_respond_to(response, :osm_id)
+    assert_respond_to(response, :lat)
+    assert_respond_to(response, :lon)
+    assert_respond_to(response, :display_name)
+
+    assert_raise NoMethodError do
+      response.address
+    end
+  end
+
+  def test_reverse_geocode_with_address_details
+    response = OSMN::reverse_geocode(52.5487429714954, -1.81602098644987, 1)
+
+    assert_respond_to(response, :place_id)
+    assert_respond_to(response, :licence)
+    assert_respond_to(response, :osm_type)
+    assert_respond_to(response, :osm_id)
+    assert_respond_to(response, :lat)
+    assert_respond_to(response, :lon)
+    assert_respond_to(response, :display_name)
+    assert_respond_to(response, :address)
+
+    assert_respond_to(response.address, :house_number)
+    assert_respond_to(response.address, :road)
+    assert_respond_to(response.address, :suburb)
+    assert_respond_to(response.address, :city)
+    assert_respond_to(response.address, :county)
+    assert_respond_to(response.address, :state_district)
+    assert_respond_to(response.address, :state)
+    assert_respond_to(response.address, :postcode)
+    assert_respond_to(response.address, :country)
+    assert_respond_to(response.address, :country_code)
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: osmn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jorge Kalmbach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-07 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby wrapper for the OpenStreetMap Nominatim API.
+email: kalmbach@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- Rakefile
+- lib/osmn.rb
+- lib/osmn/base.rb
+- lib/osmn/search.rb
+- lib/osmn/reverse.rb
+- lib/osmn/hash.rb
+- lib/osmn/version.rb
+- test/test_osmn.rb
+homepage: http://github.com/kalmbach/osmn
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+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 wrapper for the OpenStreetMap Nominatim API.
+test_files:
+- test/test_osmn.rb