parallel588_nominatim 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c87c3a865bd29b87e5167aa9e96a723c2c18f34
+  data.tar.gz: 7dea46b5fba7824df8734cf43cbe455ab99728e8
+SHA512:
+  metadata.gz: ecd2cb433ba0c71ad3a7cb94c5a0fdbd7a3bf57ea8763327c246101ea4379c8fb7a8715c07d593d11118e229bde63f22765d63f32d048db03c6eb145920a2c8a
+  data.tar.gz: 4e72f15402d6ca7d71cda3c25fc9d864319b3853154b6008b2fbb098a026b3ee29b91910fb8dc8fef8edc2a239194c545faeb8c6fd0959bb5610406b07871e8c

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+coverage
+*.swp
+*.swo
+*.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - rbx-19mode
+script: "bundle exec rake"

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+## v0.0.3
+
+* Added Polygon class.
+
+* Fixed few typos.
+
+* Added documentation to Place class.
+
+* Added Point class.
+
+* Returning ids as integers instead of strings.
+
+## v0.0.1
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nominatim.gemspec
+gemspec
+
+gem 'guard'
+gem 'guard-rspec'
+gem 'guard-bundler'

data/Guardfile

@@ -0,0 +1,13 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jakub Svehla
+
+MIT 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/README.md

@@ -0,0 +1,90 @@
+# Nominatim
+
+A Ruby wrapper for the Nominatim API. [![Build Status](https://secure.travis-ci.org/jakubsvehla/nominatim.png?branch=master)](http://travis-ci.org/jakubsvehla/nominatim)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nominatim'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nominatim
+
+## Documentation
+
+[http://rdoc.info/gems/nominatim][documentation]
+
+[documentation]: http://rdoc.info/gems/nominatim
+
+## Usage
+
+```ruby
+places = Nominatim.search('San Francisco').limit(10).address_details(true)
+
+for place in places
+  puts "#{place.display_name} (#{place.type})"
+end
+
+puts "Found #{places.count} places."
+```
+
+## Configuration
+
+```ruby
+Nominatim.configure do |config|
+  config.email = 'your-email-address@example.com'
+  config.endpoint = 'http://open.mapquestapi.com/nominatim/v1'
+end
+```
+
+## Contributing
+
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake spec`. If your specs fail, return to step 5.
+7. Run `open coverage/index.html`. If your changes are not completely covered
+   by your tests, return to step 3.
+8. Add, commit, and push your changes.
+9. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/
+
+## Supported Ruby Versions
+
+Nominatim is tested under 1.9.2 and 1.9.3.
+
+## Copyright
+
+Copyright (c) 2012 Jakub Svehla
+
+MIT 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,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

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,41 @@
+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
+        }
+      }
+
+      options[:proxy] = Nominatim.config.proxy if Nominatim.config.proxy
+
+      @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.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,49 @@
+module Nominatim
+  class Configuration
+
+    DEFAULT_ENDPOINT = 'http://nominatim.openstreetmap.org'
+
+    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,
+      :user_agent,
+      :email,
+      :accept_language,
+      :timeout,
+      :search_url,
+      :reverse_url,
+      :proxy
+    ]
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def initialize
+      reset!
+    end
+
+    def configure
+      yield self
+      self
+    end
+
+    def reset!
+      self.endpoint         = DEFAULT_ENDPOINT
+      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