nominatim 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0343ac093361647592d5b1580921badaa62a035
-  data.tar.gz: d7bd4ca820651eab6da353e1cd1c863b60b2e264
+  metadata.gz: 2182f83ea77dc36300f6c808dae389e7c82c9ffe
+  data.tar.gz: 997ca5a9abad9eac2bce987ff9df7b2934f3767d
 SHA512:
-  metadata.gz: 7d8c3339f2d237cb38be3751a83403a8f1e55b04ba751633ad5dbbf58a7e8b2f3fac326da0ec621f7d083c0bdaabc4bc0ae7aec6813edd84ae3027284869924f
-  data.tar.gz: 3b24fb54932e0f89e355c382e1410465c4b29226a0607a9e84bb293480336bb4ccd6b36056e0bae513c189864de3c194608142e5f945d8023aae16c7888e44a1
+  metadata.gz: d6ab7f80d3c9d04cc68b33ff1b2ddf57462dd966f4f84ade8d2d1098b6bd3d26bd916ef7f56be31e32217dc6353d99337fd18765d0e9e8565e4b11badf0750bf
+  data.tar.gz: 597eccdbdaf8a020716043d5e7142d25e788b4109b684c8f77c653736b6676cb0c474ff7151d6b0b1a41f7f548dafc8020b0c7cd2e8614b59f194cb781b2a682

data/README.md

@@ -34,6 +34,29 @@ end
 puts "Found #{places.count} places."
 ```
 
+### Structured requests
+
+```ruby
+places = Nominatim.search.city('San Antonio').country('Mexico').limit(10).address_details(true)
+
+for place in places
+  puts "#{place.display_name} (#{place.type})"
+end
+
+puts "Found #{places.count} places."
+```
+
+Nominatim::Search has the following methods to craft structures requests:
+
+- street: accepts house number and street name as parameters
+- city
+- county
+- state
+- country
+- postalcode
+
+See http://wiki.openstreetmap.org/wiki/Nominatim#Parameters
+
 ## Configuration
 
 ```ruby

data/lib/nominatim/client.rb

@@ -16,13 +16,20 @@ module Nominatim
     def connection
       return @connection if defined? @connection
 
-      @connection = Faraday.new Nominatim.config.endpoint do |builder|
+      options = {
+        request: {
+          timeout: Nominatim.config.timeout
+        }
+      }
+
+      @connection = Faraday.new Nominatim.config.endpoint, options do |builder|
         builder.use Nominatim::Response::ParseJson
         builder.adapter Faraday.default_adapter
       end
 
       @connection.params[:format] = 'json'
       @connection.params[:email] = Nominatim.config.email if Nominatim.config.email
+      @connection.params[:key] = Nominatim.config.key if Nominatim.config.key
 
       @connection.headers[:user_agent] = Nominatim.config.user_agent
       @connection.headers[:"accept-language"] = Nominatim.config.accept_language

data/lib/nominatim/configuration.rb

@@ -3,20 +3,26 @@ module Nominatim
 
     DEFAULT_ENDPOINT = 'http://nominatim.openstreetmap.org'
 
+    DEFAULT_KEY = nil
+
     DEFAULT_USER_AGENT = "Nominatim Ruby Gem #{Nominatim::VERSION}"
 
     DEFAULT_EMAIL = nil
 
     DEFAULT_LANGUAGE = 'en'
 
+    DEFAULT_TIMEOUT = nil
+
     DEFAULT_SEARCH_URL = 'search'
     DEFAULT_REVERSE_URL = 'reverse'
 
     VALID_OPTIONS_KEYS = [
       :endpoint,
+      :key,
       :user_agent,
       :email,
       :accept_language,
+      :timeout,
       :search_url,
       :reverse_url
     ]
@@ -34,9 +40,11 @@ module Nominatim
 
     def reset!
       self.endpoint         = DEFAULT_ENDPOINT
+      self.key              = DEFAULT_KEY
       self.user_agent       = DEFAULT_USER_AGENT
       self.email            = DEFAULT_EMAIL
       self.accept_language  = DEFAULT_LANGUAGE
+      self.timeout          = DEFAULT_TIMEOUT
       self.search_url       = DEFAULT_SEARCH_URL
       self.reverse_url      = DEFAULT_REVERSE_URL
     end

data/lib/nominatim/search.rb

@@ -9,7 +9,26 @@ module Nominatim
 
     # Iterates over the search results.
     def each(&block)
-      get(Nominatim.config.search_url, @criteria).body.map! { |attrs| Nominatim::Place.new(attrs) }.each(&block)
+      @criteria.delete(:q) if (@criteria.keys & [:street, :city, :county, :state, :country, :postalcode]).count > 0
+      @results ||= get(Nominatim.config.search_url, @criteria).body.map! { |attrs| Nominatim::Place.new(attrs) }
+      @results.each(&block)
+    end
+
+    # Structured search requests
+    # @see https://wiki.openstreetmap.org/wiki/Nominatim
+    %w(city county state country postalcode).to_a.each do |criterion|
+      define_method(criterion) do |param|
+        @criteria[criterion.to_sym] = param
+        self
+      end
+    end
+
+    # Structured street search request
+    #
+    # @see https://wiki.openstreetmap.org/wiki/Nominatim
+    def street housenumber, streetname
+      @criteria[:street] = "#{housenumber} #{streetname}"
+      self
     end
 
     # Query string to search for.

data/lib/nominatim/version.rb

@@ -1,3 +1,3 @@
 module Nominatim
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/nominatim/search_spec.rb

@@ -18,10 +18,15 @@ describe Nominatim::Search do
 
     let(:search) { Nominatim::Search.new.query('Los Angeles').limit(1) }
 
+    let(:structured_search){ Nominatim::Search.new.query('Text').city('Los Angeles').country('us').limit(1) }
+
     before do
       stub_get('/search').
         with(query: { q: 'Los Angeles', limit: 1 }).
         to_return(body: fixture('search.json'))
+      stub_get('/search').
+        with(query: { city: 'Los Angeles', country: 'us', limit: 1 }).
+        to_return(body: fixture('search.json'))
     end
 
     it 'iterates over the matching places' do
@@ -39,6 +44,12 @@ describe Nominatim::Search do
       search.first.lat.should eq 34.0966764
       search.first.lon.should eq -117.7196785
     end
+
+    it 'omits q parameter from structured search' do
+      structured_search.first.display_name.should eq 'Los Angeles, California, United States of America'
+      structured_search.first.lat.should eq 34.0966764
+      structured_search.first.lon.should eq -117.7196785
+    end
   end
 
   describe '#query' do
@@ -67,6 +78,40 @@ describe Nominatim::Search do
     end
   end
 
+  describe '#street' do
+    it 'adds a street criterion' do
+      search.street('1000', 'street name')
+      search.criteria[:street].should eq "1000 street name"
+    end
+  end
+  describe '#city' do
+    it 'adds a city criterion' do
+      search.city('City name')
+      search.criteria[:city].should eq "City name"
+    end
+  end
+  describe '#county' do
+    it 'adds a county criterion' do
+      search.county('County name')
+      search.criteria[:county].should eq "County name"
+    end
+  end
+
+  describe '#state' do
+    it 'adds a state criterion' do
+      search.state('State name')
+      search.criteria[:state].should eq "State name"
+    end
+  end
+
+  describe '#country' do
+    it 'adds a country criterion' do
+      search.country('Country name')
+      search.criteria[:country].should eq "Country name"
+    end
+  end
+
+
   describe '#bounded' do
     it 'adds a bounded criterion' do
       search.bounded(true)

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: nominatim
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Jakub Svehla
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-07 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   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: multi_json
   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: 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: '2.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.10'
 - !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: simplecov
   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: yard
   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: A Ruby wrapper for the Nominatim API.
@@ -115,9 +115,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -156,17 +156,17 @@ 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.0.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper for the Nominatim API.