open_street_map 0.1.0 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8590c3c8a1547bd9e558e8aca7a9173e5a47aa8c0efcc2dbca0b3b92a79ca6f5
-  data.tar.gz: 1e0068a04ca2da16c7dbf0d7033aca125775650c2ee553fe6bf864aa2d233b44
+  metadata.gz: 0245145c2c7910156d7e9104e20a8473fd68c121b03adfd362d11a6fb72de5ff
+  data.tar.gz: 5e22a03e1249dc6ba2461c190e15d155b85c3d69a93e66f170b3de94c74263e7
 SHA512:
-  metadata.gz: a9e91b075933e006f7d7f299b3b16e3bbd8e3e873d3f57cb97646b23c1eb12b0e6bc4a097e5fcfde8f5d264123b8e579faf7dd46eebfadc32cf92752602eef82
-  data.tar.gz: 19772c38fe7dd7945ac226053715581cf561fe40eaafeda7249718f338e399a93e9dec871ee303e1f2e59e4b867119aee185deae8064ee7e108f6a7558218758
+  metadata.gz: e06ec27a0c5f8540a09cc107967c16ae70ec0dd700e767889806795e8aeed893d716155a93f60363ae3107e7f529206fb727a329fa625acc6696c81be9cb1d71
+  data.tar.gz: f28a7bcf80fb0375b56502bad6aef3c7727396b1906997d2a520ab0cbfe111977c67f91477e82dcb30426d37e121c7ee2d511ede5a5168afbd989aaf4d77a6c2

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   Exclude:
     - bin/*
+  TargetRubyVersion: 2.5.0
 
 Metrics/AbcSize:
   Enabled: false
@@ -39,11 +40,18 @@ Layout/AlignHash:
 Style/GuardClause:
   Enabled: false
 
-Style/FileName:
+Naming:
   Enabled: false
 
 Style/FormatStringToken:
   EnforcedStyle: template
 
 Style/ExpandPathArguments:
-  Enabled: false
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/RescueStandardError:
+  Enabled: false
+

data/README.md

@@ -1,8 +1,6 @@
 # OpenStreetMap
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/open_street_map`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Integration of OpenStreetMap api from [Nominatim](https://wiki.openstreetmap.org/wiki/Nominatim) 
 
 ## Installation
 
@@ -22,22 +20,107 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Create OpenStreetMap client object
+
+```ruby
+  client = OpenStreetMap::Client.new
+```
+
+### Search
+
+Request for search objects is #search.
+
+```ruby
+  client.search(q: '135 pilkington avenue, birmingham', format: 'json', addressdetails: '1')
+```
+    q - query
+    format - one of the [xml|json|jsonv2]
+    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]
+    exclude_place_ids - If you do not want certain openstreetmap objects to appear in the search result, give a comma separated list of the place_id's you want to skip
+    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]
+
+#### Responces
+
+```ruby
+  [
+    {
+      "place_id":"91015286",
+      "licence":"Data © OpenStreetMap contributors, ODbL 1.0. https:\/\/osm.org\/copyright",
+      "osm_type":"way",
+      "osm_id":"90394480",
+      "boundingbox":["52.5487473","52.5488481","-1.816513","-1.8163464"],
+      "lat":"52.5487921",
+      "lon":"-1.8164308339635",
+      "display_name":"135, Pilkington Avenue, Sutton Coldfield, Бирмингем, West Midlands Combined Authority, Западный Мидленд, Англия, B72 1LH, Великобритания",
+      "class":"building",
+      "type":"yes",
+      "importance":0.31025,
+      "address": {
+        "house_number":"135",
+        "road":"Pilkington Avenue",
+        "town":"Sutton Coldfield",
+        "city":"Бирмингем",
+        "county":"West Midlands Combined Authority",
+        "state_district":"Западный Мидленд",
+        "state":"Англия",
+        "postcode":"B72 1LH",
+        "country":"Великобритания",
+        "country_code":"gb"
+      }
+    }
+  ]
+```
+
+### Reverse
 
-## Development
+Request for objects by coordinates is #reverse.
+
+```ruby
+  client.reverse(format: 'json', lat: '52.594417', lon: '39.493115')
+```
+    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]
+    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]
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+#### Responces
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+  {
+    "place_id":"150727169",
+    "licence":"Data © OpenStreetMap contributors, ODbL 1.0. https:\/\/osm.org\/copyright",
+    "osm_type":"way",
+    "osm_id":"367091730",
+    "lat":"52.5944624",
+    "lon":"39.4931348495468",
+    "display_name":"4, улица Хренникова, микрорайон Елецкий, Сырский рудник, Советский округ, Липецк, городской округ Липецк, Липецкая область, Центральный федеральный округ, 398000, РФ",
+    "address":{
+      "house_number":"4",
+      "road":"улица Хренникова",
+      "residential":"микрорайон Елецкий",
+      "suburb":"городской округ Липецк",
+      "city_district":"Советский округ",
+      "city":"Липецк",
+      "state":"Липецкая область",
+      "postcode":"398000",
+      "country":"РФ",
+      "country_code":"ru"
+    },
+    "boundingbox":["52.5943024","52.5946223","39.4929211","39.4933486"]
+  }
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/WebGents/open_street_map. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/WebGents/open_street_map.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the OpenStreetMap project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/open_street_map/blob/master/CODE_OF_CONDUCT.md).

data/lib/open_street_map/client/reverse.rb

@@ -0,0 +1,26 @@
+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

@@ -0,0 +1,30 @@
+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

data/lib/open_street_map/client.rb

@@ -0,0 +1,16 @@
+require 'rest-client'
+require 'json'
+require_relative 'client/reverse'
+require_relative 'client/search'
+
+module OpenStreetMap
+  # Client requests
+  class Client
+    include OpenStreetMap::Client::Reverse
+    include OpenStreetMap::Client::Search
+
+    BASE_URI = 'https://nominatim.openstreetmap.org/'.freeze
+
+    def initialize(args = {}); end
+  end
+end

data/lib/open_street_map/version.rb

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

data/lib/open_street_map.rb

@@ -1,5 +1,6 @@
-require 'open_street_map/version'
+require_relative 'open_street_map/version'
+require_relative 'open_street_map/client'
 
-# Mail declaration
+# Main declaration
 module OpenStreetMap
 end

data/open_street_map.gemspec

@@ -20,6 +20,8 @@ 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.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open_street_map
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: '1.0'
 platform: ruby
 authors:
 - JungleCoders
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-02 00:00:00.000000000 Z
+date: 2018-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,6 +100,9 @@ files:
 - bin/console
 - 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/version.rb
 - open_street_map.gemspec
 homepage: https://github.com/WebGents/open_street_map
@@ -114,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="