open_street_map 1.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ecb1e86901f5a99ee48c747fc4fda5c24e541f45faac9dd20541d112de3b2ab
-  data.tar.gz: b35872595d45d4b7ff9aedb9c157b570ea515d69f7edf00c1d988d89778c4378
+  metadata.gz: cf89cc2a9860608487a2e39ae028912a15209f675d10ad70e4d09a5d1ca7903f
+  data.tar.gz: b08b3864ed1cb9e843a98faab1f07aefecbfea78eaa609148c78350e8364d126
 SHA512:
-  metadata.gz: eae9c8162b19e8e508fedf2528091e13edc0e9701a2d4efc447eea465796ffb0200b9cad4bc7429ae490380b41812fcc0013542fcea4bd3d401d57cf82ec7d91
-  data.tar.gz: 54dff490b60bd0e7414e2319faf8bacccbdb71f8129cbfe1350af78ca40298745c83e07099154371f756361f02cb811e9aaa73a690e59123e1c1cfef90a2624c
+  metadata.gz: e0747f589ef8b0870da627b6706c788d0fa74f5b63b1dcddcf4962b326a19f275c01871d3a1f08033426568273c231d4244bc135aded5bbe136fd1242a537781
+  data.tar.gz: c511bf49cd166de25a90c194618447c04a002a3930a86578a621c4b4e18a8ffaa16beb37d368fa9088dc9a959fb4200f5d7d387d72d9769c805bb535713018da

data/README.md

@@ -34,7 +34,7 @@ Request for search objects is #search.
   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]
@@ -86,7 +86,7 @@ Request for objects by coordinates is #reverse.
 ```ruby
   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

data/lib/open_street_map/client/request.rb

@@ -0,0 +1,88 @@
+module OpenStreetMap
+  class Client
+    # methods for request
+    module Request
+      private
+
+      def call(type, args)
+        url = generate_url(type, args)
+        response = fetch(url, args)
+        sleep(REQUEST_TIMEOUT)
+        parse(response, args[:format])
+      rescue
+        { 'errors' => 'Bad request' }
+      end
+
+      # generate url from args
+      def generate_url(type, args)
+        valid_args_list = valid_args(type)
+        args = args.select { |key, _value| valid_args_list.include?(key) }
+        url = args.inject('') { |acc, (key, value)| acc + add_to_options(key, value, acc) }
+        type + url
+      end
+
+      # make request to API
+      def fetch(url, args)
+        url = hostname(args[:hostname]) + url
+        RestClient.get(url, user_agent: user_agent(args[:user_agent]))
+      end
+
+      # parse response
+      def parse(response, format)
+        if json_parse_valid?(format)
+          JSON.parse(response.body)
+        else
+          response.body
+        end
+      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
+
+      # make combination of special symbol and param with value
+      def add_to_options(key, value, acc)
+        symbol_for_param(acc) + key_value_param(key, remove_spaces(value))
+      end
+
+      # select special symbol
+      def symbol_for_param(acc)
+        acc == '' ? '?' : '&'
+      end
+
+      # make combination of param with value
+      def key_value_param(key, value)
+        if key == :accept_language
+          "accept-language=#{value}"
+        else
+          "#{key}=#{value}"
+        end
+      end
+
+      # replace spaces with + for values
+      def remove_spaces(value)
+        value.gsub(/\s+/, '+')
+      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
+
+      # if format equal json then allow parsing
+      def json_parse_valid?(format)
+        format == 'json' || format == 'jsonv2'
+      end
+    end
+  end
+end

data/lib/open_street_map/client.rb

@@ -1,18 +1,24 @@
 require 'rest-client'
 require 'json'
-require_relative 'client/reverse'
-require_relative 'client/search'
+require_relative 'client/request'
 
 module OpenStreetMap
   # Client requests
   class Client
-    include OpenStreetMap::Client::Reverse
-    include OpenStreetMap::Client::Search
+    include OpenStreetMap::Client::Request
 
     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
+    # 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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open_street_map
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: 1.1.1
 platform: ruby
 authors:
 - JungleCoders
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-10 00:00:00.000000000 Z
+date: 2018-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,8 +101,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

data/lib/open_street_map/client/reverse.rb

@@ -1,28 +0,0 @@
-module OpenStreetMap
-  class Client
-    # Reverse geocoding generates an address from a latitude and longitude
-    module Reverse
-      def reverse(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' }
-      end
-
-      private
-
-      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, :accept_language, :email)
-      end
-    end
-  end
-end

data/lib/open_street_map/client/search.rb

@@ -1,32 +0,0 @@
-module OpenStreetMap
-  class Client
-    # Search objects by query
-    module Search
-      def search(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' }
-      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|
-          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, :accept_language, :email)
-      end
-    end
-  end
-end