power-osmn 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 138bcd59b2015968ebdd16a4c60ffdd93a0d09284b86586e745a0d1cac20801c
+  data.tar.gz: 4e92d1bd816b6100ac4d2d4cb0a6bde97d5dacb72639df275a7d051847fe19a7
+SHA512:
+  metadata.gz: ca45c5e1fcaa93b6a82714350bfda7a6ab3eec561eff0a31f0752857da5ecb9414674c5f75eb28ebe1f5f54f2483f03ee09309edde2eae7509cc914e8e7c625f
+  data.tar.gz: 8444dc220df168a03b1f2a640736127bf53573cb889d6e7aaf3bebe730a37dc0355e0b59b3d7fddbd3cd969ce4b06929d4d98187927557afd0c5d840187487d6

data/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,16 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=cd374ecebbc117b8a6055a17a56200ae87f61844d2c34893eaa0be55e3abf628
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.4.2
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rake test
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+  

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in attributes.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    osmn (0.3.0)
+      ostruct
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.25.4)
+    ostruct (0.6.1)
+    rake (13.2.1)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  minitest
+  osmn!
+  rake
+
+BUNDLED WITH
+   2.6.2

data/README.md

@@ -0,0 +1,76 @@
+# OSMN [![Maintainability](https://api.codeclimate.com/v1/badges/dd21f82be412394ac8ea/maintainability)](https://codeclimate.com/github/max-power/osmn/maintainability)
+
+A Ruby wrapper for the OpenStreetMap Nominatim API.
+
+> Nominatim is a tool to search osm data by name and address 
+and to generate synthetic addresses of osm points (reverse geocoding). 
+
+Service can be found at http://nominatim.openstreetmap.org  
+API Details can be found at https://nominatim.org/release-docs/develop/api/Overview/
+
+## Installation
+
+    $ gem install power-osmn
+
+## Usage
+### The easy way:
+```ruby
+# search for a place
+OSMN.search('135 pilkington avenue, birmingham')
+
+# convert latitude and longitude into a place
+OSMN.reverse_geocode(52.5487429714954, -1.81602098644987)
+
+# lookup osm id
+lookup = OSMN.lookup("R146656","W50637691","N240109189")
+lookup.map(&:name) # => ["Manchester", "Brandenburger Tor", "Berlin"]
+
+
+# OSMN status
+OSMN.status
+```
+
+### Search with parameters:
+You can set any parameter defined in the Nominatim documentation page (https://nominatim.org/release-docs/develop/api/Search/)
+
+```ruby
+OSMN.search('10117 Berlin', country: "DE", format: :geojson, polygon_geojson: true)
+OSMN.search('Paris', featureType: 'city')
+OSMN.reverse_geocode(52.5487429714954, -1.81602098644987, addressdetails: true)
+
+params = {
+    lat: 52.5487429714954, 
+    lon: -1.81602098644987, 
+    'accept-language': 'en', 
+    osm_type: 'W', 
+    zoom: 18, 
+    addressdetails: 1
+}
+OSMN.search(params)
+```
+
+
+Check the complete list of parameters for each query on the Nominatim documentation page (https://nominatim.org/release-docs/develop/api/Search/)
+
+## License
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the
+Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions of
+the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
+OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+end
+
+desc 'Run tests'
+task default: :test
+
+desc 'Open an irb session preloaded with this library'
+task :console do
+  exec 'irb -rubygems -I lib -r osmn'
+end

data/lib/osmn/request.rb

@@ -0,0 +1,23 @@
+module OSMN
+  class Request
+    def initialize(host, path, **params)
+      @host   = host
+      @path   = path
+      @params = params
+    end
+
+    def fetch
+      Net::HTTP.get uri
+    end
+
+    private
+
+    def uri
+      URI::HTTPS.build host: @host, path: @path, query: query
+    end
+
+    def query
+      URI.encode_www_form @params
+    end
+  end
+end

data/lib/osmn/search.rb

@@ -0,0 +1,28 @@
+module OSMN
+  class Search
+    attr_accessor :params
+
+    def initialize(path='/search', **params)
+      @path   = path
+      @params = default_params.merge(params)
+    end
+
+    def call
+      parse response
+    end
+
+    private
+
+    def default_params
+      { format: :json }
+    end
+
+    def response
+      Request.new(HOST, @path, **params).fetch
+    end
+
+    def parse(response)
+      JSON.parse response, object_class: OpenStruct
+    end
+  end
+end

data/lib/osmn/version.rb

@@ -0,0 +1,3 @@
+module OSMN
+  VERSION = '0.3.0'.freeze
+end

data/lib/osmn.rb

@@ -0,0 +1,33 @@
+require 'json'
+require 'net/http'
+require 'ostruct'
+require 'osmn/request'
+require 'osmn/search'
+require 'osmn/version'
+
+module OSMN
+  HOST = 'nominatim.openstreetmap.org'.freeze
+  
+  module_function
+
+  def search(query = nil, **params)
+    params.merge!(q: query) unless query.to_s.empty?
+    request '/search', **params
+  end
+
+  def reverse_geocode(lat, lon, **params)
+    request '/reverse', **params.merge(lat: lat, lon: lon)
+  end
+  
+  def lookup(*osm_ids, **params)
+    request '/lookup', **params.merge(osm_ids: osm_ids.join(','))
+  end
+  
+  def status
+    request '/status'
+  end
+  
+  def request(path, **params)
+    Search.new(path, **params).call
+  end
+end

data/osmn.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/osmn/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'power-osmn'
+  gem.version     = OSMN::VERSION
+  gem.authors     = ['Kevin Melchert']
+  gem.email       = 'kevin.melchert@gmail.com'
+  gem.summary     = 'A Ruby wrapper for the OpenStreetMap Nominatim API.'
+  gem.homepage    = 'http://github.com/max-power/osmn'
+
+  gem.files       = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  gem.test_files    = ['test/search_test.rb', 'test/reverse_test.rb']
+  gem.require_paths = ['lib']
+  
+  gem.required_ruby_version = '>= 3.0'
+
+  gem.add_dependency 'ostruct'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest'
+end

data/test/reverse_test.rb

@@ -0,0 +1,55 @@
+require "test_helper"
+
+class SearchTests < Minitest::Test
+  def test_nil_reverse
+    assert_raises ArgumentError do
+      OSMN.reverse_geocode
+    end
+  end
+  
+  def test_reverse
+    response = OSMN.reverse_geocode(52.5487921, -1.8164307339635)
+
+    assert_equal '91015286', response.place_id
+  end
+
+  def test_reverse_geocode
+    response = OSMN.reverse_geocode(52.5487429714954, -1.81602098644987, addressdetails: 0)
+
+    assert_equal "91015268", response.place_id
+    assert_equal "Data © OpenStreetMap contributors, ODbL 1.0. http://www.openstreetmap.org/copyright", response.licence
+    assert_equal "way", response.osm_type
+    assert_equal "90394420", response.osm_id
+    assert_equal "52.54877605", response.lat
+    assert_equal "-1.81627033283164", response.lon
+    assert_equal "137, Pilkington Avenue, Sutton Coldfield, Birmingham, West Midlands Combined Authority, West Midlands, England, B72 1LH, UK", response.display_name
+
+    assert_raises NoMethodError do
+      response.address.house_number
+    end
+  end
+
+  def test_reverse_geocode_with_address_details
+    response = OSMN.reverse_geocode(52.5487429714954, -1.81602098644987, addressdetails: 1)
+
+    assert_respond_to(response, :place_id)
+    assert_respond_to(response, :licence)
+    assert_respond_to(response, :osm_type)
+    assert_respond_to(response, :osm_id)
+    assert_respond_to(response, :lat)
+    assert_respond_to(response, :lon)
+    assert_respond_to(response, :display_name)
+    assert_respond_to(response, :address)
+
+    assert_respond_to(response.address, :house_number)
+    assert_respond_to(response.address, :road)
+    assert_respond_to(response.address, :suburb)
+    assert_respond_to(response.address, :city)
+    assert_respond_to(response.address, :county)
+    assert_respond_to(response.address, :state_district)
+    assert_respond_to(response.address, :state)
+    assert_respond_to(response.address, :postcode)
+    assert_respond_to(response.address, :country)
+    assert_respond_to(response.address, :country_code)
+  end
+end

data/test/search_test.rb

@@ -0,0 +1,63 @@
+require "test_helper"
+
+class SearchTests < Minitest::Test
+
+  def test_nil_search
+    assert_raises ArgumentError do
+      OSMN.search
+    end
+  end
+
+  def test_search
+    response = OSMN.search('135 pilkington avenue, birmingham')[0]
+
+    assert_equal('91015286', response.place_id)
+  end
+
+  def test_search_with_no_details
+    response = OSMN.search('135 pilkington avenue, birmingham', addressdetails: 0)[0]
+
+    assert_respond_to(response, :place_id)
+    assert_respond_to(response, :licence)
+    assert_respond_to(response, :osm_type)
+    assert_respond_to(response, :osm_id)
+    assert_respond_to(response, :boundingbox)
+    assert_respond_to(response, :lat)
+    assert_respond_to(response, :lon)
+    assert_respond_to(response, :display_name)
+    assert_respond_to(response, :class)
+    assert_respond_to(response, :type)
+
+    assert_raises NoMethodError do
+      response.address.house_number
+    end
+  end
+
+  def test_search_with_details
+    response = OSMN.search('135 pilkington avenue, birmingham', addressdetails: 1)[0]
+
+    assert_respond_to(response, :place_id)
+    assert_respond_to(response, :licence)
+    assert_respond_to(response, :osm_type)
+    assert_respond_to(response, :osm_id)
+    assert_respond_to(response, :boundingbox)
+    assert_respond_to(response, :lat)
+    assert_respond_to(response, :lon)
+    assert_respond_to(response, :display_name)
+    assert_respond_to(response, :class)
+    assert_respond_to(response, :type)
+    assert_respond_to(response, :address)
+#    assert_respond_to(response, :icon)
+
+    assert_respond_to(response.address, :house_number)
+    assert_respond_to(response.address, :road)
+    assert_respond_to(response.address, :suburb)
+    assert_respond_to(response.address, :city)
+    assert_respond_to(response.address, :county)
+    assert_respond_to(response.address, :state_district)
+    assert_respond_to(response.address, :state)
+    assert_respond_to(response.address, :postcode)
+    assert_respond_to(response.address, :country)
+    assert_respond_to(response.address, :country_code)
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: power-osmn
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Kevin Melchert
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+email: kevin.melchert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/osmn.rb
+- lib/osmn/request.rb
+- lib/osmn/search.rb
+- lib/osmn/version.rb
+- osmn.gemspec
+- test/reverse_test.rb
+- test/search_test.rb
+homepage: http://github.com/max-power/osmn
+licenses: []
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A Ruby wrapper for the OpenStreetMap Nominatim API.
+test_files:
+- test/reverse_test.rb
+- test/search_test.rb