overpass-api-ruby 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea5cecdd3df6b4d7e87716955266e3f80ef6ffa5
+  data.tar.gz: a0e5a5050fc4325c9d80f6754a33f71071bc9798
+SHA512:
+  metadata.gz: 62cf9544008ced451ac288797b26e2eafda76957b25ddb450cef6266cc8fcffcb19b34c19f63045553280870071005e2e450fc19a4c2fcc537f158c31830671c
+  data.tar.gz: 1f2708c93d10cb57ffb7683903fe3016bef70ef3e2949487da43c556b5c94eaf90c19ebc9ed53dbb0a2cc048f45f0774a6c1ec4bcc9f640fdf20f372e1af9cf6

data/.gitignore

@@ -0,0 +1 @@
+.idea

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org/"
+
+gem 'httpi', "~> 1.1.0"
+gem 'pry-debugger'
+gem 'diskcached'
+gem 'nokogiri'

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    columnize (0.9.0)
+    debugger (1.6.8)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.3.5)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.3.7)
+    diskcached (1.1.0)
+    httpi (1.1.1)
+      rack
+    method_source (0.8.2)
+    mini_portile (0.6.2)
+    nokogiri (1.6.5)
+      mini_portile (~> 0.6.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-debugger (0.2.3)
+      debugger (~> 1.3)
+      pry (>= 0.9.10, < 0.11.0)
+    rack (1.6.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  diskcached
+  httpi (~> 1.1.0)
+  nokogiri
+  pry-debugger

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Bruno Salerno
+
+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,58 @@
+Overpass API Ruby
+=================
+
+A Ruby wrapper for OpenStreetMap Overpass API. Returns a Hash from a query.
+
+Install
+-------
+
+`gem install overpass-api-ruby`
+
+or add `gem 'overpass-api-ruby'` to your Gemfile
+
+Usage
+-----
+
+```ruby
+require 'overpass_api_ruby'
+
+ba_query = "<union><query type='relation'><has-kv k='route' v='subway'/></query>" <<
+    "</union><union><item/><recurse type='down'/></union>"
+
+options={:bbox => {:s => -34.705448,:n => -34.526562,:w => -58.531471,:e => -58.335159},
+         :timeout => 900,
+         :element_limit => 1073741824,
+         :json => true}
+
+overpass = OverpassAPI.new(options)
+result_hash = overpass.query(ba_query)
+```
+
+Options on instantiation
+------------------------
+```
+bbox                    Hash. Global bounding box.
+endpoint                String. Defaults to http://overpass-api.de/api/interpreter?data= .
+timeout                 Integer.
+element_init            Integer.
+json                    Boolean. API response is in JSON format, so parse to hash doesn't use the private 
+                        parse_nokogiri method. Default: false.
+cache_expiration_time   Integer. Default: 7200.
+```
+See [Overpass API](http://wiki.openstreetmap.org/wiki/Overpass_API/Language_Guide)
+
+Public methods
+--------------
+
+```ruby
+query (<String query>)      Intended to pass only children tags of <osm-script>.
+
+raw_query (<String query>)  The whole query must be passed.
+
+bbox (s,n,w,e)              Defines global bounding box.
+```
+
+
+License
+-------
+MIT.

data/lib/overpass_api_ruby.rb

@@ -0,0 +1,83 @@
+require 'httpi'
+require 'diskcached'
+require 'open-uri'
+require 'json'
+require 'nokogiri'
+
+class OverpassAPI
+  VERSION=0.1
+  DEFAULT_ENDPOINT='http://overpass-api.de/api/interpreter?data='
+
+  def initialize(args={})
+    bbox = args[:bbox]
+    bbox(bbox[:s],bbox[:n],bbox[:w],bbox[:e])
+
+    cache_expiration_time = args[:cache_expiration_time] || 7200
+    @cache = Diskcached.new('/tmp/cache',cache_expiration_time,true)
+
+    @endpoint = args[:endpoint] || DEFAULT_ENDPOINT
+    @json = args[:json] ? "output='json'" : ''
+    @timeout = args[:timeout] ? "timeout='#{args[:timeout]}'" : ''
+    @element_limit = args[:element_limit] ? "element-limit='#{args[:element_limit]}'" : ''
+  end
+
+  def bbox(s,n,w,e)
+    @bbox = "bbox='#{s},#{w},#{n},#{e}'"
+  end
+
+  def query(query)
+    return unless query
+    perform "<osm-script #{@bbox} #{@timeout} #{@element_limit} #{@json}>" <<
+            "#{query}<print/></osm-script>"
+  end
+
+  def raw_query(query)
+    return unless query
+    perform query
+  end
+
+  private
+  def perform(query)
+    url = URI::encode("#{@endpoint}#{query}")
+    data = @cache.cache("overpass_api_ruby_#{query}") do
+      request = HTTPI::Request.new(url)
+      HTTPI.get(request).body
+    end
+
+    return JSON.parse(data, :symbolize_names=> true)[:elements] unless @json.empty?
+
+    doc = Nokogiri::XML(data) do |config|
+      config.options = Nokogiri::XML::ParseOptions::NOBLANKS
+    end
+
+    raw = doc.children.first.children.select{|e| e.name != 'note' and e.name != 'meta'}
+    parse_nokogiri raw
+  end
+
+  def parse_nokogiri(xml)
+    xml.map {|e|
+      element = {:type => e.name}
+
+      e.attributes.each {|a|
+        element[a[1].name.to_sym] = a[1].value
+      }
+
+      members = e.children.select{|n| n.name != 'tag'}.map {|child|
+        key_values={:type => child.name }
+        child.attributes.each {|a|
+          key_values[a[1].name.to_sym] = a[1].value
+        }
+        key_values
+      }
+      element[:members] = members unless members.empty?
+
+      tags={}
+      e.children.select{|n| n.name == 'tag'}.each {|child|
+        tags[child.values.first] = child.values[1]
+      }
+      element[:tags] = tags unless tags.empty?
+
+      element
+    }
+  end
+end

data/overpass-api-ruby.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'overpass_api_ruby'
+
+Gem::Specification.new do |spec|
+  spec.name          = "overpass-api-ruby"
+  spec.version       = OverpassAPI::VERSION
+  spec.authors       = ["Bruno Salerno"]
+  spec.email         = ["br.salerno@gmail.com"]
+  spec.description   = %q{A Ruby wrapper for OpenStreetMap Overpass API}
+  spec.summary       = %q{Returns a Hash from a query}
+  spec.homepage      = "https://github.com/BrunoSalerno/overpass-api-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "httpi", "~> 1.1.0"
+  spec.add_runtime_dependency "diskcached"
+  spec.add_runtime_dependency "nokogiri"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry-debugger"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: overpass-api-ruby
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Bruno Salerno
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: diskcached
+  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: nokogiri
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: pry-debugger
+  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'
+description: A Ruby wrapper for OpenStreetMap Overpass API
+email:
+- br.salerno@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/overpass_api_ruby.rb
+- overpass-api-ruby.gemspec
+homepage: https://github.com/BrunoSalerno/overpass-api-ruby
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Returns a Hash from a query
+test_files: []