open_street_map 1.1.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf89cc2a9860608487a2e39ae028912a15209f675d10ad70e4d09a5d1ca7903f
-  data.tar.gz: b08b3864ed1cb9e843a98faab1f07aefecbfea78eaa609148c78350e8364d126
+  metadata.gz: 3a1e278a717dae481c5901268fcee1bfd6cd17c44050b4824cbdd66924a86e16
+  data.tar.gz: 345103fee4f35f4faf91f0143cd291753bcdff202330eb1e8591f0921499c395
 SHA512:
-  metadata.gz: e0747f589ef8b0870da627b6706c788d0fa74f5b63b1dcddcf4962b326a19f275c01871d3a1f08033426568273c231d4244bc135aded5bbe136fd1242a537781
-  data.tar.gz: c511bf49cd166de25a90c194618447c04a002a3930a86578a621c4b4e18a8ffaa16beb37d368fa9088dc9a959fb4200f5d7d387d72d9769c805bb535713018da
+  metadata.gz: b7790f5a3607598f33db9946c73e2a60b7e91a57026f41e51d49312643f9cbe09b35ea3ecf0c1ad233696b2e16a82cef1fcdb703cc93f044845512c10f73e5b1
+  data.tar.gz: 4217e529692d22ba661cc5cc97e5fec57c0304738d6c0cfad6aff0360b8484c52008b7dd5587b60c485daa259bf9340725a778e55bd717aeb287a3752817c4dd

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   Exclude:
     - bin/*
+  NewCops: enable
   TargetRubyVersion: 2.5.0
 
 Metrics/AbcSize:
@@ -12,7 +13,7 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Enabled: false
 
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
 
 Metrics/MethodLength:
@@ -34,8 +35,9 @@ Layout/CaseIndentation:
     - end
   IndentOneStep: true
 
-Layout/AlignHash:
-  Enabled: false
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
 
 Style/GuardClause:
   Enabled: false
@@ -55,3 +57,5 @@ Style/FrozenStringLiteralComment:
 Style/RescueStandardError:
   Enabled: false
 
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.0.2

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

@@ -2,6 +2,13 @@
 
 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
 
 Add this line to your application's Gemfile:
@@ -47,7 +54,7 @@ Request for search objects is #search.
     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
   [
@@ -98,7 +105,7 @@ Request for objects by coordinates is #reverse.
     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
   {

data/lib/open_street_map/client/request.rb

@@ -1,74 +1,32 @@
+# frozen_string_literal: true
+
 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]))
+      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
 
-      # parse response
-      def parse(response, format)
-        if json_parse_valid?(format)
-          JSON.parse(response.body)
-        else
-          response.body
-        end
+      # generate body from args
+      def generate_body(type, args)
+        args[:'accept-language'] = 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]
+          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
@@ -78,11 +36,6 @@ module OpenStreetMap
       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,15 +1,15 @@
-require 'rest-client'
-require 'json'
+# frozen_string_literal: true
+
+require 'httparty'
 require_relative 'client/request'
 
 module OpenStreetMap
-  # Client requests
   class Client
+    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
-    REQUEST_TIMEOUT = 1
+    BASE_URI = 'https://nominatim.openstreetmap.org/'
+    DEFAULT_USER_AGENT = "webgents/open_street_map_gem_#{SecureRandom.urlsafe_base64}"
 
     # Search objects by query
     def search(args = {})

data/lib/open_street_map/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OpenStreetMap
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.2.2'
 end

data/lib/open_street_map.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 require_relative 'open_street_map/version'
 require_relative 'open_street_map/client'
 
-# Main declaration
 module OpenStreetMap
 end

data/open_street_map.gemspec

@@ -7,9 +7,10 @@ Gem::Specification.new do |spec|
   spec.version = OpenStreetMap::VERSION
   spec.authors = ['JungleCoders', 'Anton Bogdanov']
   spec.email = ['kortirso@gmail.com']
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   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 +21,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 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.57.2'
-  spec.add_dependency 'rest-client', '2.0.2'
+  spec.add_development_dependency 'bundler', '>= 2.2.33'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.23'
+  spec.add_dependency 'httparty', '~> 0.17'
 end

metadata

@@ -1,87 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: open_street_map
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.2
 platform: ruby
 authors:
 - JungleCoders
 - Anton Bogdanov
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-10-31 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 2.2.33
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 2.2.33
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.2
+        version: '1.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.2
+        version: '1.23'
 - !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
@@ -107,8 +108,9 @@ files:
 homepage: https://github.com/WebGents/open_street_map
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -116,16 +118,15 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: OpenStrretMap API
 test_files: []