open_street_map 1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0245145c2c7910156d7e9104e20a8473fd68c121b03adfd362d11a6fb72de5ff
-  data.tar.gz: 5e22a03e1249dc6ba2461c190e15d155b85c3d69a93e66f170b3de94c74263e7
+  metadata.gz: f61b519813aa4291018e672ee071d49f8ad671075c6b1b2b4a9839edafe7a9bf
+  data.tar.gz: 86c49fd6b466b9591bba96dd41772ae6a7bdab3b4878a2a63dcd773227f16d63
 SHA512:
-  metadata.gz: e06ec27a0c5f8540a09cc107967c16ae70ec0dd700e767889806795e8aeed893d716155a93f60363ae3107e7f529206fb727a329fa625acc6696c81be9cb1d71
-  data.tar.gz: f28a7bcf80fb0375b56502bad6aef3c7727396b1906997d2a520ab0cbfe111977c67f91477e82dcb30426d37e121c7ee2d511ede5a5168afbd989aaf4d77a6c2
+  metadata.gz: 18bb37b6621fdd145f4233d9dd3f6e77c857e3472816626ffeeab8abfb6832f6a905df9f2b1d663604e0d5c480921197911ff8ca87af7c3efe0e887b4b9efd77
+  data.tar.gz: 663e12e827c02e9290d16b852a8dac4fedd9e5ff35390316df2cba915cc345354c0697af777220eed276122e2df1f1e3c66278c38f00b00b20b1a90cba806fdd

data/.rubocop.yml

@@ -54,4 +54,3 @@ Style/FrozenStringLiteralComment:
 
 Style/RescueStandardError:
   Enabled: false
-

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 kortirso
+Copyright (c) 2018-2020 kortirso
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,13 @@
 # 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)
+
+## Prerequisites
+
+This project requires:
+
+* Ruby >= 2.3.1, but can work with earlier versions
+* HTTParty >= 0.16
 
 ## Installation
 
@@ -31,10 +38,10 @@ 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]
+    format - one of the [xml|json|jsonv2], default - xml
     viewbox - The preferred area to find search results like <x1>,<y1>,<x2>,<y2>
     bounded - Restrict the results to only items contained with the viewbox, one of the [0|1]
     addressdetails - Include a breakdown of the address into elements, one of the [0|1]
@@ -42,8 +49,12 @@ 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
+#### Responses
 
 ```ruby
   [
@@ -80,17 +91,21 @@ 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]
+    format - one of the [xml|json|jsonv2], default - xml
     zoom - Level of detail required where 0 is country and 18 is house/building, one of the [0-18]
     addressdetails - Include a breakdown of the address into elements, one of the [0|1]
     lat - Latitude, required
     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
+#### Responses
 
 ```ruby
   {
@@ -124,3 +139,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

@@ -1,16 +1,23 @@
-require 'rest-client'
-require 'json'
-require_relative 'client/reverse'
-require_relative 'client/search'
+require 'httparty'
+require_relative 'client/request'
 
 module OpenStreetMap
   # Client requests
   class Client
-    include OpenStreetMap::Client::Reverse
-    include OpenStreetMap::Client::Search
+    include HTTParty
+    include OpenStreetMap::Client::Request
 
     BASE_URI = 'https://nominatim.openstreetmap.org/'.freeze
+    DEFAULT_USER_AGENT = "webgents/open_street_map_gem_#{SecureRandom.urlsafe_base64}".freeze
 
-    def initialize(args = {}); end
+    # Search objects by query
+    def search(args = {})
+      call('search', args)
+    end
+
+    # Reverse geocoding generates an address from a latitude and longitude
+    def reverse(args = {})
+      call('reverse', args)
+    end
   end
 end

data/lib/open_street_map/client/request.rb

@@ -0,0 +1,40 @@
+module OpenStreetMap
+  class Client
+    # methods for request
+    module Request
+      private
+
+      # make request to API
+      def call(type, args)
+        url = hostname(args[:hostname]) + type
+        headers = { 'User-Agent' => user_agent(args[:user_agent]) }
+        self.class.get(url, query: generate_body(type, args), headers: headers).parsed_response
+      end
+
+      # generate body from args
+      def generate_body(type, args)
+        args['accept-language'.to_sym] = args[:accept_language] if args.key?(:accept_language)
+        args.select { |key, _| valid_args(type).include?(key) }
+      end
+
+      # get list of permitted args
+      def valid_args(type)
+        case type
+          when 'search' then %i[q format addressdetails extratags namedetails viewbox bounded exclude_place_ids limit accept-language email]
+          when 'reverse' then %i[format lat lon zoom addressdetails extratags namedetails accept-language email]
+          else []
+        end
+      end
+
+      # select hostname for request
+      def hostname(value)
+        value || BASE_URI
+      end
+
+      # select user_agent for request
+      def user_agent(value)
+        value || DEFAULT_USER_AGENT
+      end
+    end
+  end
+end

data/lib/open_street_map/version.rb

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

data/open_street_map.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email = ['kortirso@gmail.com']
 
   spec.summary = 'OpenStrretMap API'
-  spec.description = 'Integration with OpenStrretMap API'
+  spec.description = 'Integration with OpenStreetMap API'
   spec.homepage = 'https://github.com/WebGents/open_street_map'
   spec.license = 'MIT'
 
@@ -20,11 +20,11 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.required_ruby_version = '>= 2.5.1'
 
   spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.57.2'
-  spec.add_dependency 'rest-client', '2.0.2'
+  spec.add_dependency 'httparty', '~> 0.17'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open_street_map
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.2.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: 2020-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -68,20 +68,20 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.57.2
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
-description: Integration with OpenStrretMap API
+        version: '0.17'
+description: Integration with OpenStreetMap API
 email:
 - kortirso@gmail.com
 executables: []
@@ -91,6 +91,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -101,8 +102,7 @@ files:
 - bin/setup
 - lib/open_street_map.rb
 - lib/open_street_map/client.rb
-- lib/open_street_map/client/reverse.rb
-- lib/open_street_map/client/search.rb
+- lib/open_street_map/client/request.rb
 - lib/open_street_map/version.rb
 - open_street_map.gemspec
 homepage: https://github.com/WebGents/open_street_map
@@ -117,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.5.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/open_street_map/client/reverse.rb

@@ -1,26 +0,0 @@
-module OpenStreetMap
-  class Client
-    # 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)}")
-        args[:format] == 'xml' ? response.body : JSON.parse(response.body)
-      rescue
-        { 'errors' => 'Bad request' }
-      end
-
-      private
-
-      def reverse_args_to_url(args, result = [])
-        valid_reverse_args(args).each do |key, value|
-          result << "#{key}=#{value}"
-        end
-        result.join('&')
-      end
-
-      def valid_reverse_args(args)
-        args.slice(:format, :lat, :lon, :zoom, :addressdetails, :extratags, :namedetails)
-      end
-    end
-  end
-end

data/lib/open_street_map/client/search.rb

@@ -1,30 +0,0 @@
-module OpenStreetMap
-  class Client
-    # Search objects by query
-    module Search
-      def search(args = {})
-        response = RestClient.get("#{BASE_URI}search?#{search_arg(args[:q])}&#{search_args_to_url(args)}")
-        args[:format] == 'xml' ? response.body : JSON.parse(response.body)
-      rescue
-        { 'errors' => 'Bad request' }
-      end
-
-      private
-
-      def search_arg(arg)
-        "q=#{arg.gsub(/\s+/, '+')}"
-      end
-
-      def search_args_to_url(args, result = [])
-        valid_search_args(args).each do |key, value|
-          result << "#{key}=#{value}"
-        end
-        result.join('&')
-      end
-
-      def valid_search_args(args)
-        args.slice(:format, :addressdetails, :extratags, :namedetails, :viewbox, :bounded, :exclude_place_ids, :limit)
-      end
-    end
-  end
-end