osmn 0.1.2 → 0.1.3

data/README.md

@@ -1,4 +1,5 @@
-# OSMN
+# OSMN [![Code Climate](https://codeclimate.com/github/kalmbach/osmn.png)](https://codeclimate.com/github/kalmbach/osmn)
+
 A Ruby wrapper for the OpenStreetMap Nominatim API.
 
 > Nominatim is a tool to search osm data by name and address 
@@ -12,7 +13,7 @@ API Details can be found at http://wiki.openstreetmap.org/wiki/Nominatim
     $ gem install osmn
 
 ## Usage
-The easy way:
+### The easy way:
 ```ruby
 # search for a place
 OSMN::search('135 pilkington avenue, birmingham')
@@ -20,22 +21,37 @@ OSMN::search('135 pilkington avenue, birmingham')
 # convert latitude and longitude into a place
 OSMN::reverse_geocode(52.5487429714954, -1.81602098644987)
 ```
-The full control way:
+### The full control way:
+#### Search
 ```ruby
 # search for address
-search = OSMN::Search.new(:addressdetails => 1)
+# required params: q (the query)
+search = OSMN::Search.new(:q => '135 pilkington avenue, birmingham')
 search.params = {:limit => 1}
 
 # you can revise the params used
 search.params
-# >> {:addressdetails => 1, :limit => 1}
+# >> {:q => '135 pilkington avenue, birmingham', :limit => 1}
 
 # and if all is ok, you can execute the query
 search.search
 ```
-
+You can set any parameter defined in the Nominatim wiki page (http://wiki.openstreetmap.org/wiki/Nominatim#Parameters)
+```ruby
+# example parameters
+params = {
+    :q => '135 pilkington avenue, birmingham', 
+    :'accept-language' >= 'en', 
+    :countrycodes => 'gb', 
+    :bounded => 1, 
+    :polygon => 1, 
+    :addressdetails => 1
+}
+```
+#### Reverse Geocode
 ```ruby
 # convert lat and long
+# required params: lat, lon (latitude and longitude)
 search = OSMN::Reverse.new(:lat => 52.5487429714954)
 search.params = {:lon => -1.81602098644987}
 
@@ -46,8 +62,20 @@ search.params
 # run the query
 search.reverse_geocode
 ```
+You can set any parameter defined in the Nominatim wiki page (http://wiki.openstreetmap.org/wiki/Nominatim#Parameters_2)
+```ruby
+# example parameters
+params = {
+    :lat => 52.5487429714954, 
+    :lon => -1.81602098644987, 
+    :'accept-language' => 'en', 
+    :osm_type => 'W', 
+    :zoom => 18, 
+    :addressdetails => 1
+}
+```
 
-Check the available parameters for each query on the Nominatim Wiki page (http://wiki.openstreetmap.org/wiki/Nominatim)
+Check the complete list of parameters for each query on the Nominatim Wiki page (http://wiki.openstreetmap.org/wiki/Nominatim)
 
 ## License
 Copyright (c) 2012, Jorge Kalmbach <kalmbach.at.gmail.com>
@@ -72,4 +100,4 @@ 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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/osmn/structs.rb

@@ -10,6 +10,7 @@ module OSMN
     :display_name, 
     :class,
     :type,
+    :importance,
     :address)
 
   Address = Struct.new(
@@ -22,5 +23,6 @@ module OSMN
     :state, 
     :postcode, 
     :country, 
-    :country_code)
+    :country_code,
+    :continent)
 end

data/lib/osmn/version.rb

@@ -1,3 +1,3 @@
 module OSMN
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/test/test_osmn.rb

@@ -27,7 +27,7 @@ class Tests < Test::Unit::TestCase
     assert_equal('62762024', response.place_id)
   end
 
-  def test_search
+  def test_search_with_no_details
     response = OSMN::search('135 pilkington avenue, birmingham', 0)[0]
 
     assert_respond_to(response, :place_id)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osmn
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-28 00:00:00.000000000 Z
+date: 2013-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A Ruby wrapper for the OpenStreetMap Nominatim API.