open_street_map 1.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0245145c2c7910156d7e9104e20a8473fd68c121b03adfd362d11a6fb72de5ff
-  data.tar.gz: 5e22a03e1249dc6ba2461c190e15d155b85c3d69a93e66f170b3de94c74263e7
+  metadata.gz: 1ecb1e86901f5a99ee48c747fc4fda5c24e541f45faac9dd20541d112de3b2ab
+  data.tar.gz: b35872595d45d4b7ff9aedb9c157b570ea515d69f7edf00c1d988d89778c4378
 SHA512:
-  metadata.gz: e06ec27a0c5f8540a09cc107967c16ae70ec0dd700e767889806795e8aeed893d716155a93f60363ae3107e7f529206fb727a329fa625acc6696c81be9cb1d71
-  data.tar.gz: f28a7bcf80fb0375b56502bad6aef3c7727396b1906997d2a520ab0cbfe111977c67f91477e82dcb30426d37e121c7ee2d511ede5a5168afbd989aaf4d77a6c2
+  metadata.gz: eae9c8162b19e8e508fedf2528091e13edc0e9701a2d4efc447eea465796ffb0200b9cad4bc7429ae490380b41812fcc0013542fcea4bd3d401d57cf82ec7d91
+  data.tar.gz: 54dff490b60bd0e7414e2319faf8bacccbdb71f8129cbfe1350af78ca40298745c83e07099154371f756361f02cb811e9aaa73a690e59123e1c1cfef90a2624c

data/README.md

@@ -1,6 +1,6 @@
 # OpenStreetMap
 
-Integration of OpenStreetMap api from [Nominatim](https://wiki.openstreetmap.org/wiki/Nominatim) 
+Integration of OpenStreetMap api from [Nominatim](https://wiki.openstreetmap.org/wiki/Nominatim)
 
 ## Installation
 
@@ -31,7 +31,7 @@ Or install it yourself as:
 Request for search objects is #search.
 
 ```ruby
-  client.search(q: '135 pilkington avenue, birmingham', format: 'json', addressdetails: '1')
+  client.search(q: '135 pilkington avenue, birmingham', format: 'json', addressdetails: '1', accept_language: 'ru')
 ```
     q - query
     format - one of the [xml|json|jsonv2]
@@ -42,6 +42,10 @@ Request for search objects is #search.
     limit - Limit the number of returned results, integer
     extratags - Include additional information in the result if available, one of the [0|1]
     namedetails - Include a list of alternative names in the results, one of the [0|1]
+    accept_language - Preferred language order for showing search results, default - en
+    email - If you are making large numbers of request please include a valid email address
+    user_agent - User-Agent identifying the application, default - webgents/open_street_map_gem_random
+    hostname - allow overwriting the host name for users who have their own Nominatim installation, default - https://nominatim.openstreetmap.org/
 
 #### Responces
 
@@ -80,7 +84,7 @@ Request for search objects is #search.
 Request for objects by coordinates is #reverse.
 
 ```ruby
-  client.reverse(format: 'json', lat: '52.594417', lon: '39.493115')
+  client.reverse(format: 'json', lat: '52.594417', lon: '39.493115', accept_language: 'ru')
 ```
     format - one of the [xml|json|jsonv2]
     zoom - Level of detail required where 0 is country and 18 is house/building, one of the [0-18]
@@ -89,6 +93,10 @@ Request for objects by coordinates is #reverse.
     lon - Longitude, required
     extratags - Include additional information in the result if available, one of the [0|1]
     namedetails - Include a list of alternative names in the results, one of the [0|1]
+    accept_language - Preferred language order for showing search results, default - en
+    email - If you are making large numbers of request please include a valid email address
+    user_agent - User-Agent identifying the application, default - webgents/open_street_map_gem_random
+    hostname - allow overwriting the host name for users who have their own Nominatim installation, default - https://nominatim.openstreetmap.org/
 
 #### Responces
 
@@ -124,3 +132,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/WebGen
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Disclaimer
+
+Use this package at your own peril and risk, the author tried to simplify the use of [Nominatim service](https://wiki.openstreetmap.org/wiki/Nominatim) for integration into Ruby on Rails web applications.

data/lib/open_street_map/client.rb

@@ -10,6 +10,8 @@ module OpenStreetMap
     include OpenStreetMap::Client::Search
 
     BASE_URI = 'https://nominatim.openstreetmap.org/'.freeze
+    DEFAULT_USER_AGENT = "webgents/open_street_map_gem_#{SecureRandom.urlsafe_base64}".freeze
+    REQUEST_TIMEOUT = 1
 
     def initialize(args = {}); end
   end

data/lib/open_street_map/client/reverse.rb

@@ -3,7 +3,8 @@ module OpenStreetMap
     # Reverse geocoding generates an address from a latitude and longitude
     module Reverse
       def reverse(args = {})
-        response = RestClient.get("#{BASE_URI}reverse?#{reverse_args_to_url(args)}")
+        response = RestClient.get("#{args[:hostname] || BASE_URI}reverse?#{reverse_args_to_url(args)}", user_agent: args[:user_agent] || DEFAULT_USER_AGENT)
+        sleep(REQUEST_TIMEOUT)
         args[:format] == 'xml' ? response.body : JSON.parse(response.body)
       rescue
         { 'errors' => 'Bad request' }
@@ -13,13 +14,14 @@ module OpenStreetMap
 
       def reverse_args_to_url(args, result = [])
         valid_reverse_args(args).each do |key, value|
+          key = 'accept-language' if key == :accept_language
           result << "#{key}=#{value}"
         end
         result.join('&')
       end
 
       def valid_reverse_args(args)
-        args.slice(:format, :lat, :lon, :zoom, :addressdetails, :extratags, :namedetails)
+        args.slice(:format, :lat, :lon, :zoom, :addressdetails, :extratags, :namedetails, :accept_language, :email)
       end
     end
   end

data/lib/open_street_map/client/search.rb

@@ -3,7 +3,8 @@ module OpenStreetMap
     # Search objects by query
     module Search
       def search(args = {})
-        response = RestClient.get("#{BASE_URI}search?#{search_arg(args[:q])}&#{search_args_to_url(args)}")
+        response = RestClient.get("#{args[:hostname] || BASE_URI}search?#{search_arg(args[:q])}&#{search_args_to_url(args)}", user_agent: args[:user_agent] || DEFAULT_USER_AGENT)
+        sleep(REQUEST_TIMEOUT)
         args[:format] == 'xml' ? response.body : JSON.parse(response.body)
       rescue
         { 'errors' => 'Bad request' }
@@ -17,13 +18,14 @@ module OpenStreetMap
 
       def search_args_to_url(args, result = [])
         valid_search_args(args).each do |key, value|
+          key = 'accept-language' if key == :accept_language
           result << "#{key}=#{value}"
         end
         result.join('&')
       end
 
       def valid_search_args(args)
-        args.slice(:format, :addressdetails, :extratags, :namedetails, :viewbox, :bounded, :exclude_place_ids, :limit)
+        args.slice(:format, :addressdetails, :extratags, :namedetails, :viewbox, :bounded, :exclude_place_ids, :limit, :accept_language, :email)
       end
     end
   end

data/lib/open_street_map/version.rb

@@ -1,3 +1,3 @@
 module OpenStreetMap
-  VERSION = '1.0'.freeze
+  VERSION = '1.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open_street_map
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.1'
 platform: ruby
 authors:
 - JungleCoders
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-08 00:00:00.000000000 Z
+date: 2018-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler