nominatim 0.0.3 → 0.0.4

data/.gitignore

@@ -16,3 +16,6 @@ test/tmp
 test/version_tmp
 tmp
 coverage
+*.swp
+*.swo
+*.rvmrc

data/lib/nominatim.rb

@@ -7,6 +7,7 @@ require "nominatim/place"
 require "nominatim/response/parse_json"
 require "nominatim/client"
 require "nominatim/search"
+require "nominatim/reverse"
 
 module Nominatim
 
@@ -17,6 +18,13 @@ module Nominatim
     search
   end
 
+  # @return [Nominatim::Reverse]
+  def self.reverse(lat = nil, lon = nil)
+    search = Nominatim::Reverse.new
+    search.lat(lat).lon(lon) if lat && lon
+    search
+  end
+
   # @return [Nominatim::Configuration]
   def self.config
     @config ||= Configuration.new

data/lib/nominatim/address.rb

@@ -71,5 +71,13 @@ module Nominatim
     def place
       @place ||= @attrs[:place]
     end
+
+    def town
+      @town ||= @attrs[:town]
+    end
+
+    def village
+      @village ||= @attrs[:village]
+    end
   end
-end
+end

data/lib/nominatim/client.rb

@@ -25,8 +25,9 @@ module Nominatim
       @connection.params[:email] = Nominatim.config.email if Nominatim.config.email
 
       @connection.headers[:user_agent] = Nominatim.config.user_agent
+      @connection.headers[:"accept-language"] = Nominatim.config.accept_language
 
       @connection
     end
   end
-end
+end

data/lib/nominatim/configuration.rb

@@ -7,10 +7,13 @@ module Nominatim
 
     DEFAULT_EMAIL = nil
 
+    DEFAULT_LANGUAGE = 'en'
+
     VALID_OPTIONS_KEYS = [
       :endpoint,
       :user_agent,
-      :email
+      :email,
+      :accept_language
     ]
 
     attr_accessor *VALID_OPTIONS_KEYS
@@ -25,9 +28,10 @@ module Nominatim
     end
 
     def reset!
-      self.endpoint   = DEFAULT_ENDPOINT
-      self.user_agent = DEFAULT_USER_AGENT
-      self.email      = DEFAULT_EMAIL
+      self.endpoint         = DEFAULT_ENDPOINT
+      self.user_agent       = DEFAULT_USER_AGENT
+      self.email            = DEFAULT_EMAIL
+      self.accept_language  = DEFAULT_LANGUAGE
     end
   end
-end
+end

data/lib/nominatim/reverse.rb

@@ -0,0 +1,42 @@
+module Nominatim
+  class Reverse < Client
+    attr_reader :criteria
+
+    def initialize
+      @criteria = {}
+    end
+
+    # Returns search result.
+    def fetch
+      Nominatim::Place.new(get('/reverse', @criteria).body)
+    end
+
+    # Latitude string to search for.
+    #
+    # @param lat [String] Latitude
+    # @return [Nominatim::Reverse]
+    def lat(lat)
+      @criteria[:lat] = lat
+      self
+    end
+
+    # Longitude string to search for.
+    #
+    # @param lon [String] Longitude
+    # @return [Nominatim::Reverse]
+    def lon(lon)
+      @criteria[:lon] = lon
+      self
+    end
+
+    # Include a breakdown of the address into elements.
+    #
+    # @param bool [true, false]
+    # @return [Nominatim::Reverse]
+    def address_details(bool)
+      @criteria[:addressdetails] = bool ? 1 : 0
+      self
+    end
+
+  end
+end

data/lib/nominatim/version.rb

@@ -1,3 +1,3 @@
 module Nominatim
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/fixtures/reverse.json

@@ -0,0 +1 @@
+{"place_id":"13686660","licence":"Data Copyright OpenStreetMap Contributors, Some Rights Reserved. CC-BY-SA 2.0.","osm_type":"node","osm_id":"1241690521","lat":"37.733976","lon":"-122.3912081","display_name":"4900, 3rd Street, San Francisco, California, 94124, United States of America","address":{"house_number":"4900","road":"3rd Street","city":"San Francisco","county":"San Francisco","state":"California","postcode":"94124","country":"United States of America","country_code":"us"}}

data/spec/nominatim/reverse_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Nominatim::Reverse do
+
+  let(:reverse) { Nominatim::Reverse.new }
+
+  it 'has no criteria set' do
+    reverse.criteria.should be_empty
+  end
+
+  it 'allows chaining of criterions' do
+    reverse.lat('37.733976').lon('-122.3912081').address_details(1)
+    reverse.criteria[:lat].should eq '37.733976'
+    reverse.criteria[:lon].should eq '-122.3912081'
+    reverse.criteria[:addressdetails].should eq 1
+  end
+
+  describe '#each' do
+    let(:reverse) { Nominatim::Reverse.new.lat('37.733976').lon('-122.3912081').address_details(1) }
+
+    before do
+      stub_get('/reverse').
+        with(query: { lat: '37.733976', lon: '-122.3912081', addressdetails: 1 }).
+        to_return(body: fixture('reverse.json'))
+    end
+
+    it 'iterates over the matching places' do
+			reverse.fetch.should be_a Nominatim::Place
+    end
+
+    it 'returns correct places' do
+      reverse.fetch.display_name.should eq '4900, 3rd Street, San Francisco, California, 94124, United States of America'
+      reverse.fetch.address.city.should eq 'San Francisco'
+      reverse.fetch.address.state.should eq 'California'
+    end
+  end
+
+  describe '#lat' do
+    it 'adds a latitude criterion' do
+      reverse.lat('37.733976')
+      reverse.criteria[:lat].should eq '37.733976'
+    end
+  end
+
+  describe '#lon' do
+    it 'adds a longitude criterion' do
+      reverse.lon('-122.3912081')
+      reverse.criteria[:lon].should eq '-122.3912081'
+    end
+  end
+
+  describe '#address_details' do
+    it 'adds an address details criterion' do
+      reverse.address_details(true)
+      reverse.criteria[:addressdetails].should eq 1
+    end
+
+    it 'sets 1 when set with true' do
+      reverse.address_details(true)
+      reverse.criteria[:addressdetails].should eq 1
+    end
+
+    it 'sets 0 when set with false' do
+      reverse.address_details(false)
+      reverse.criteria[:addressdetails].should eq 0
+    end
+  end
+end

data/spec/nominatim_spec.rb

@@ -12,6 +12,18 @@ describe Nominatim do
     end
   end
 
+  describe '.reverse' do
+    it 'returns a Nominatim::Reverse' do
+      Nominatim.reverse.should be_a Nominatim::Reverse
+    end
+
+    it 'adds a reverse query criteria if given as a parameters' do
+      reverse = Nominatim.reverse('37.733976', '-122.3912081')
+      reverse.criteria[:lat].should eq '37.733976'
+      reverse.criteria[:lon].should eq '-122.3912081'
+    end
+  end
+
   describe '.configure' do
 
     before do
@@ -51,4 +63,4 @@ describe Nominatim do
       Nominatim.config.email.should eq "foo@bar.com"
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nominatim
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-02 00:00:00.000000000 Z
+date: 2012-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -147,15 +147,18 @@ files:
 - lib/nominatim/point.rb
 - lib/nominatim/polygon.rb
 - lib/nominatim/response/parse_json.rb
+- lib/nominatim/reverse.rb
 - lib/nominatim/search.rb
 - lib/nominatim/version.rb
 - nominatim.gemspec
+- spec/fixtures/reverse.json
 - spec/fixtures/search.json
 - spec/nominatim/address_spec.rb
 - spec/nominatim/client_spec.rb
 - spec/nominatim/place_spec.rb
 - spec/nominatim/point_spec.rb
 - spec/nominatim/polygon_spec.rb
+- spec/nominatim/reverse_spec.rb
 - spec/nominatim/search_spec.rb
 - spec/nominatim_spec.rb
 - spec/spec_helper.rb
@@ -171,12 +174,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1511415446284472130
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1511415446284472130
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -184,12 +193,14 @@ signing_key:
 specification_version: 3
 summary: A Ruby wrapper for the Nominatim API.
 test_files:
+- spec/fixtures/reverse.json
 - spec/fixtures/search.json
 - spec/nominatim/address_spec.rb
 - spec/nominatim/client_spec.rb
 - spec/nominatim/place_spec.rb
 - spec/nominatim/point_spec.rb
 - spec/nominatim/polygon_spec.rb
+- spec/nominatim/reverse_spec.rb
 - spec/nominatim/search_spec.rb
 - spec/nominatim_spec.rb
 - spec/spec_helper.rb