ruby-nominatim 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed156fabbe98525ac066b5dd2eec91fa5afc8af4
+  data.tar.gz: 8ccba8b6597d95258c7e28cf3512f86ebd88b9e0
+SHA512:
+  metadata.gz: 63d23fa498b1cf916124e1722108ca63d27015f9fe0ccf08f581a8994c217f333c4a8f52f85dae1ddd02ac27bf063335c392f886ba4b2dc5e81fb74cdf8837ef
+  data.tar.gz: 0503255b459f977cf01a4f19e77ab0685f9c58ce22dd43b8f938c30aa55315e35bc04da3e02427fd81f727e9404893ecb679d544563206c49c6c662cecf723b7

data/lib/nominatim.rb

@@ -0,0 +1,36 @@
+require "nominatim/version"
+require "nominatim/configuration"
+require "nominatim/point"
+require "nominatim/polygon"
+require "nominatim/address"
+require "nominatim/place"
+require "nominatim/response/parse_json"
+require "nominatim/client"
+require "nominatim/search"
+require "nominatim/reverse"
+
+module Nominatim
+
+  # @return [Nominatim::Search]
+  def self.search(q = nil)
+    search = Nominatim::Search.new
+    search.query(q) if q
+    search
+  end
+
+  # @return [Nominatim::Reverse]
+  def self.reverse(lat = nil, lon = nil)
+    search = Nominatim::Reverse.new
+    search.lat(lat).lon(lon) if lat && lon
+    search
+  end
+
+  # @return [Nominatim::Configuration]
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.configure(&block)
+    config.configure &block
+  end
+end

data/lib/nominatim/address.rb

@@ -0,0 +1,83 @@
+module Nominatim
+  class Address
+    def initialize(attrs = {})
+      @attrs = attrs
+    end
+
+    def attraction
+      @attraction ||= @attrs[:attraction]
+    end
+
+    def clothes
+      @clothes ||= @attrs[:clothes]
+    end
+
+    def house_number
+      @house_number ||= @attrs[:house_number]
+    end
+
+    def road
+      @road ||= @attrs[:road]
+    end
+
+    def commercial
+      @commercial ||= @attrs[:commercial]
+    end
+
+    def pedestrian
+      @pedestrian ||= @attrs[:pedestrian]
+    end
+
+    def suburb
+      @suburb ||= @attrs[:suburb]
+    end
+
+    def city_district
+      @city_district ||= @attrs[:city_district]
+    end
+
+    def city
+      @city ||= @attrs[:city]
+    end
+
+    def administrative
+      @administrative ||= @attrs[:administrative]
+    end
+
+    def county
+      @county ||= @attrs[:county]
+    end
+
+    def state_district
+      @state_district ||= @attrs[:state_district]
+    end
+
+    def state
+      @state ||= @attrs[:state]
+    end
+
+    def postcode
+      @postcode ||= @attrs[:postcode]
+    end
+
+    def country
+      @country ||= @attrs[:country]
+    end
+
+    def country_code
+      @country_code ||= @attrs[:country_code]
+    end
+
+    def place
+      @place ||= @attrs[:place]
+    end
+
+    def town
+      @town ||= @attrs[:town]
+    end
+
+    def village
+      @village ||= @attrs[:village]
+    end
+  end
+end

data/lib/nominatim/client.rb

@@ -0,0 +1,40 @@
+require 'faraday'
+
+module Nominatim
+  class Client
+
+    # Performs an HTTP GET request
+    def get(path, params = {})
+      connection.get path, params
+    end
+
+    private
+
+    # Returns a Faraday::Connection object
+    #
+    # @return [Faraday::Connection]
+    def connection
+      return @connection if defined? @connection
+
+      options = {
+        request: {
+          timeout: Nominatim.config.timeout
+        }
+      }
+
+      @connection = Faraday.new Nominatim.config.endpoint, options do |builder|
+        builder.use Nominatim::Response::ParseJson
+        builder.adapter Faraday.default_adapter
+      end
+
+      @connection.params[:format] = 'json'
+      @connection.params[:email] = Nominatim.config.email if Nominatim.config.email
+      @connection.params[:key] = Nominatim.config.key if Nominatim.config.key
+
+      @connection.headers[:user_agent] = Nominatim.config.user_agent
+      @connection.headers[:"accept-language"] = Nominatim.config.accept_language
+
+      @connection
+    end
+  end
+end

data/lib/nominatim/configuration.rb

@@ -0,0 +1,52 @@
+module Nominatim
+  class Configuration
+
+    DEFAULT_ENDPOINT = 'http://nominatim.openstreetmap.org'
+
+    DEFAULT_KEY = nil
+
+    DEFAULT_USER_AGENT = "Nominatim Ruby Gem #{Nominatim::VERSION}"
+
+    DEFAULT_EMAIL = nil
+
+    DEFAULT_LANGUAGE = 'en'
+
+    DEFAULT_TIMEOUT = nil
+
+    DEFAULT_SEARCH_URL = 'search'
+    DEFAULT_REVERSE_URL = 'reverse'
+
+    VALID_OPTIONS_KEYS = [
+      :endpoint,
+      :key,
+      :user_agent,
+      :email,
+      :accept_language,
+      :timeout,
+      :search_url,
+      :reverse_url
+    ]
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def initialize
+      reset!
+    end
+
+    def configure
+      yield self
+      self
+    end
+
+    def reset!
+      self.endpoint         = DEFAULT_ENDPOINT
+      self.key              = DEFAULT_KEY
+      self.user_agent       = DEFAULT_USER_AGENT
+      self.email            = DEFAULT_EMAIL
+      self.accept_language  = DEFAULT_LANGUAGE
+      self.timeout          = DEFAULT_TIMEOUT
+      self.search_url       = DEFAULT_SEARCH_URL
+      self.reverse_url      = DEFAULT_REVERSE_URL
+    end
+  end
+end

data/lib/nominatim/place.rb

@@ -0,0 +1,93 @@
+module Nominatim
+  class Place
+    # attr_reader :attrs
+    # alias to_hash attrs
+
+    def initialize(attrs = {})
+      @attrs = attrs
+    end
+
+    # Return display name
+    #
+    # @return [String]
+    def display_name
+      @display_name ||= @attrs[:display_name]
+    end
+
+    # Return a class
+    #
+    # @return [String]
+    def class
+      @class ||= @attrs[:class]
+    end
+
+    # Return a type
+    #
+    # @return [String]
+    def type
+      @type ||= @attrs[:type]
+    end
+
+    # Return an address
+    #
+    # @return [Nominatim::Address]
+    def address
+      @address ||= Nominatim::Address.new(@attrs[:address]) if @attrs[:address]
+    end
+
+    # Return a latitude
+    #
+    # @return [Float]
+    def lat
+      point.lat
+    end
+    alias latitude lat
+
+    # Return a longitude
+    #
+    # @return [Float]
+    def lon
+      point.lon
+    end
+    alias longitude lon
+
+    def boundingbox
+      @boundingbox ||= @attrs[:boundingbox]
+    end
+    alias bounding_box boundingbox
+
+    # Return a polygon
+    #
+    # @return [Nominatim::Polygon]
+    def polygonpoints
+      @polygonpoints ||= Nominatim::Polygon.new(@attrs[:polygonpoints]) if @attrs[:polygonpoints]
+    end
+
+    # Return a place id
+    #
+    # @return [Integer]
+    def place_id
+      @place_id ||= @attrs[:place_id].to_i if @attrs[:place_id]
+    end
+
+    # Return an OSM id
+    #
+    # @return [Integer]
+    def osm_id
+      @osm_id ||= @attrs[:osm_id].to_i if @attrs[:osm_id]
+    end
+
+    # Return an OSM type
+    #
+    # @return [String]
+    def osm_type
+      @osm_type ||= @attrs[:osm_type]
+    end
+
+    private
+
+    def point
+      @point ||= Nominatim::Point.new(@attrs[:lat], @attrs[:lon])
+    end
+  end
+end

data/lib/nominatim/point.rb

@@ -0,0 +1,30 @@
+module Nominatim
+  class Point
+    attr_reader :lat, :lon
+    alias latitude lat
+    alias longitude lon
+
+    # @param lat [Float]
+    # @param lon [Float]
+    def initialize(lat, lon)
+      @lat, @lon = lat.to_f, lon.to_f if lat && lon
+    end
+
+    # @return [Array]
+    def to_a
+      [lat, lon]
+    end
+
+    # Return a string representation of the point
+    #
+    # @return [String]
+    def to_s
+      to_a.to_s
+    end
+
+    # @return [true, false]
+    def ==(other)
+      self.to_a == other.to_a
+    end
+  end
+end

data/lib/nominatim/polygon.rb

@@ -0,0 +1,13 @@
+module Nominatim
+  class Polygon
+    attr_reader :coordinates
+
+    # @param coordinates [Array<Array<Float, String>>]
+    def initialize(coordinates)
+      @coordinates = []
+      coordinates.each do |c|
+        @coordinates.push(Nominatim::Point.new(c[0], c[1]))
+      end
+    end
+  end
+end

data/lib/nominatim/response/parse_json.rb

@@ -0,0 +1,16 @@
+require 'faraday'
+require 'multi_json'
+
+module Nominatim
+  module Response
+    class ParseJson < Faraday::Response::Middleware
+      def on_complete(env)
+        if env[:body].empty?
+          env[:body] = nil
+        else
+          env[:body] = MultiJson.load(env[:body], symbolize_keys: true)
+        end
+      end
+    end
+  end
+end

data/lib/nominatim/reverse.rb

@@ -0,0 +1,44 @@
+module Nominatim
+  class Reverse < Client
+    attr_reader :criteria
+
+    def initialize
+      @criteria = {}
+    end
+
+    # Returns search result or nil if no results received.
+    def fetch
+      body = get(Nominatim.config.reverse_url, @criteria).body
+      return nil if body.empty?
+      Nominatim::Place.new(body)
+    end
+
+    # Latitude string to search for.
+    #
+    # @param lat [String] Latitude
+    # @return [Nominatim::Reverse]
+    def lat(lat)
+      @criteria[:lat] = lat
+      self
+    end
+
+    # Longitude string to search for.
+    #
+    # @param lon [String] Longitude
+    # @return [Nominatim::Reverse]
+    def lon(lon)
+      @criteria[:lon] = lon
+      self
+    end
+
+    # Include a breakdown of the address into elements.
+    #
+    # @param bool [true, false]
+    # @return [Nominatim::Reverse]
+    def address_details(bool)
+      @criteria[:addressdetails] = bool ? 1 : 0
+      self
+    end
+
+  end
+end

data/lib/nominatim/search.rb

@@ -0,0 +1,171 @@
+module Nominatim
+  class Search < Client
+    include Enumerable
+    attr_reader :criteria
+
+    def initialize
+      @criteria = {}
+    end
+
+    # Iterates over the search results.
+    def each(&block)
+      @results ||= get(Nominatim.config.search_url, @criteria).body.map! { |attrs| Nominatim::Place.new(attrs) }
+      @results.each(&block)
+    end
+
+    # Query string to search for.
+    #
+    # @param q [String] Query string
+    # @return [Nominatim::Search]
+    def query(q)
+      @criteria[:q] = q
+      self
+    end
+
+    # Street string to search for.
+    #
+    # @param street [String] Street string
+    # @return [Nominatim::Search]
+    def street(street)
+      @criteria[:street] = street
+      self
+    end
+
+    # City string to search for.
+    #
+    # @param city [String] city string
+    # @return [Nominatim::Search]
+    def city(city)
+      @criteria[:city] = city
+      self
+    end
+
+    # County string to search for.
+    #
+    # @param county [String] county string
+    # @return [Nominatim::Search]
+    def county(county)
+      @criteria[:county] = county
+      self
+    end
+
+    # State string to search for.
+    #
+    # @param state [String] state string
+    # @return [Nominatim::Search]
+    def state(state)
+      @criteria[:state] = state
+      self
+    end
+
+    # Country string to search for.
+    #
+    # @param country [String] country string
+    # @return [Nominatim::Search]
+    def country(country)
+      @criteria[:country] = country
+      self
+    end
+
+    # Postal code string to search for.
+    #
+    # @param postalcode [String] postalcode string
+    # @return [Nominatim::Search]
+    def postalcode(postalcode)
+      @criteria[:postalcode] = postalcode
+      self
+    end
+
+    # Limit search results to a specific country (or a list of countries).
+    #
+    # @param codes [Array<String>, String]
+    # @see https://wiki.openstreetmap.org/wiki/Nominatim
+    # @return [Nominatim::Search]
+    def country_codes(codes)
+      if codes.instance_of? Array
+        @criteria[:countrycodes] = codes.join(',')
+      else
+        @criteria[:countrycodes] = codes
+      end
+      self
+    end
+
+    # The preferred area to find search results.
+    #
+    # @param viewbox [Array<String>]
+    # @return [Nominatim::Search]
+    def viewbox(viewbox)
+      @criteria[:viewbox] = viewbox.join(',')
+      self
+    end
+
+    # Restrict the results to only items contained with the bounding box.
+    #
+    # @param bool [true, false]
+    # @see https://wiki.openstreetmap.org/wiki/Nominatim
+    # @return [Nominatim::Search]
+    def bounded(bool)
+      @criteria[:bounded] = bool ? 1 : 0
+      self
+    end
+
+    # Output polygon outlines for items found.
+    #
+    # @param bool [true, false]
+    # @return [Nominatim::Search]
+    def polygon(bool)
+      @criteria[:polygon] = bool ? 1 : 0
+      self
+    end
+
+    # Include a breakdown of the address into elements.
+    #
+    # @param bool [true, false]
+    # @return [Nominatim::Search]
+    def address_details(bool)
+      @criteria[:addressdetails] = bool ? 1 : 0
+      self
+    end
+
+    # Exclude given place ids from the search result.
+    #
+    # @param ids [Array<String>, String] Place ids
+    # @return [Nominatim::Search]
+    def exclude_place_ids(ids)
+      if ids.instance_of? Array
+        @criteria[:exclude_place_ids] = ids.join(',')
+      else
+        @criteria[:exclude_place_ids] = ids
+      end
+      self
+    end
+
+    # Limit the number of returned results.
+    #
+    # @param limit [Integer]
+    # @return [Nominatim::Search]
+    def limit(limit)
+      @criteria[:limit] = limit
+      self
+    end
+
+    # Limit results to certain type, instead of trying to match
+    # all possible matches.
+    #
+    # Possible values:
+    # - settlement
+    # - country
+    # - city
+    # - state
+    #
+    # This feature is not in official Nominatim documentation.
+    #
+    # @param type Type to restrict to
+    # @return [Nominatim::Search]
+    def featuretype(type)
+      @criteria[:featuretype] = type
+      self
+    end
+
+  end
+end

data/lib/nominatim/version.rb

@@ -0,0 +1,3 @@
+module Nominatim
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: ruby-nominatim
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Samu Voutilainen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Ruby bindings for Nominatim, providing easy interface with customizable
+  backends.
+email:
+- smar@smar.fi
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/nominatim.rb
+- lib/nominatim/address.rb
+- lib/nominatim/client.rb
+- lib/nominatim/configuration.rb
+- lib/nominatim/place.rb
+- lib/nominatim/point.rb
+- lib/nominatim/polygon.rb
+- lib/nominatim/response/parse_json.rb
+- lib/nominatim/reverse.rb
+- lib/nominatim/search.rb
+- lib/nominatim/version.rb
+homepage: https://github.com/Smarre/ruby-nominatim
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Nominatim API.
+test_files: []
+has_rdoc: