overpass-api-ruby 0.1.3 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c355abcbae641e6d2cc0e3294c805c356f8457fe
-  data.tar.gz: a544c96a81dd680fdc95e686f791e866aee603ec
+  metadata.gz: 8ef9346aa556dd932264aaa04f016c2d86553a93
+  data.tar.gz: f6366d26fa31b74b910400e11f92376996dd0204
 SHA512:
-  metadata.gz: 6a700aca42928b8c93c53925bc4f4388631842ebb3a36e18b73b4dc521b1c808c228b2d221bc30524fb39e62d13f7e3c540160d8ec39683b5c3892b1bbcadf60
-  data.tar.gz: 9876dbd16aeebcd5eda9fed794ced6effd0f3e5266e2641f6fd2ae17051d94b8e2b1a059bc6a1a65207bd8da8599205c2600f194d18539adc7d3bb7861e64dbf
+  metadata.gz: 013cc225d04ad2f4fe501f2beb430ad837831ddc134e4630ac962d7f47518d34b9c9f796418d103862a2aca2a762f10be631a7db8a0b4abf252c9c16e5542f7a
+  data.tar.gz: 05eb5f15ed2b487300124889ca2ce7ecf5fedaa86cd3ec1c281af66c226083ca80bde55831b76ea525ecf66cf553053f20d98e25645ebca149b796bca1d37e35

data/.gitignore

@@ -1 +1,2 @@
 .idea
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+CHANGELOG
+=========
+
+v 0.2
+-----
+BREAKING CHANGES
+The addition of XML and QL classes breaks the compatibility with previous versions. Also, the `element_limit` option was deprecated, so now it's named `maxsize`. Check the examples.

data/Gemfile.lock

@@ -1,43 +1,39 @@
 PATH
   remote: .
   specs:
-    overpass-api-ruby (0.1.3)
-      diskcached
+    overpass-api-ruby (0.2)
       httpi (~> 2.4.0)
-      nokogiri
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.0)
-    diff-lcs (1.2.5)
-    diskcached (1.1.2)
-    httpi (2.4.1)
+    coderay (1.1.1)
+    diff-lcs (1.3)
+    httpi (2.4.2)
       rack
+      socksify
     method_source (0.8.2)
-    mini_portile (0.6.2)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
-    pry (0.10.1)
+    pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rack (1.6.4)
-    rake (10.4.2)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.2)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.1)
+    rack (2.0.3)
+    rake (12.0.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-mocks (3.3.2)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
     slop (3.6.0)
+    socksify (1.7.1)
 
 PLATFORMS
   ruby
@@ -50,4 +46,4 @@ DEPENDENCIES
   rspec (>= 3)
 
 BUNDLED WITH
-   1.10.6
+   1.13.6

data/README.md

@@ -1,7 +1,9 @@
 Overpass API Ruby
 =================
 
-A Ruby wrapper for OpenStreetMap Overpass API. Returns a Hash from a query.
+A Ruby wrapper for OpenStreetMap Overpass API. Supports both QL and XML.
+
+Note: Version 0.2 introduces breaking changes. Check the file CHANGELOG.md.
 
 Install
 -------
@@ -13,47 +15,65 @@ or add `gem 'overpass-api-ruby'` to your Gemfile
 Usage
 -----
 
+Using XML:
+
 ```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,
+         :maxsize => 1073741824}
+
+overpass = OverpassAPI::XML.new(options)
+
+query = "<union><query type='relation'><has-kv k='route' v='subway'/></query>" <<
+        "</union><union><item/><recurse type='down'/></union>"
+
+response = overpass.query(query)
+```
+
+Using QL:
+
+```ruby
+require 'overpass_api_ruby'
 
 options={:bbox => {:s => -34.705448, :n => -34.526562,
                    :w => -58.531471, :e => -58.335159},
          :timeout => 900,
-         :element_limit => 1073741824,
-         :json => true}
+         :maxsize => 1073741824}
 
-overpass = OverpassAPI.new(options)
-result_hash = overpass.query(ba_query)
+overpass = OverpassAPI::QL.new(options)
+
+query = "rel['route'='subway'];(._;>;);out body;"
+
+response = overpass.query(query)
 ```
 
 Options on instantiation
 ------------------------
 ```
 bbox                    Hash. Global bounding box.
-endpoint                String. 
+endpoint                String.
                         Defaults to http://overpass-api.de/api/interpreter
 timeout                 Integer.
-element_limit           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.
-dont_use_cache          Boolean. Default: false.
+maxsize                 Integer.
 ```
 See [Overpass API](http://wiki.openstreetmap.org/wiki/Overpass_API/Language_Guide)
 
 Public methods
 --------------
 
+Both `QL` and `XML` classes have the same public methods:
+
 ```ruby
-query (<String query>)      Intended to pass only children tags of <osm-script>.
+query (<String query>)      Performs the query passed using the global values set on instantiation.
 
 raw_query (<String query>)  The whole query must be passed.
 
-bbox (s,n,w,e)              Defines global bounding box.
+buid_query (<String query>) Returns a String containing the whole query.
+
+bounding_box (s,n,w,e)      Defines the global bounding box.
 ```
 
 

data/lib/base.rb

@@ -0,0 +1,40 @@
+require 'httpi'
+require 'open-uri'
+require 'json'
+
+module OverpassAPI
+  VERSION='0.2'
+
+  class Base
+    DEFAULT_ENDPOINT='http://overpass-api.de/api/interpreter?data='
+
+    def initialize(args={})
+      bbox = args[:bbox]
+      bounding_box(bbox[:s],bbox[:n],bbox[:w],bbox[:e]) if bbox
+
+      @endpoint = args[:endpoint] || DEFAULT_ENDPOINT
+      @timeout = args[:timeout]
+      @maxsize = args[:maxsize]
+    end
+
+    def bounding_box(s,n,w,e)
+      @bbox = "#{s},#{w},#{n},#{e}"
+    end
+
+    def query(q)
+      perform build_query(q)
+    end
+
+    def raw_query(q)
+      perform q
+    end
+
+    private
+
+    def perform(q)
+      url = URI::encode("#{@endpoint}#{q}")
+      r = HTTPI::Request.new(url)
+      JSON.parse(HTTPI.get(r).body, symbolize_names: true)
+    end
+  end
+end

data/lib/overpass_api_ruby.rb

@@ -1,92 +1,2 @@
-require 'httpi'
-require 'diskcached'
-require 'open-uri'
-require 'json'
-require 'nokogiri'
-
-class OverpassAPI
-  VERSION='0.1.3'
-  DEFAULT_ENDPOINT='http://overpass-api.de/api/interpreter?data='
-
-  def initialize(args={})
-    bbox = args[:bbox]
-    bbox(bbox[:s],bbox[:n],bbox[:w],bbox[:e]) if bbox
-
-    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]}'" : ''
-    @dont_use_cache = args[:dont_use_cache]
-  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 request(url)
-    r = HTTPI::Request.new(url)
-    HTTPI.get(r).body
-  end
-
-  def perform(query)
-    url = URI::encode("#{@endpoint}#{query}")
-    data = if @dont_use_cache
-                request url
-           else
-                @cache.cache("overpass_api_ruby_#{query}") do
-                    request url
-                end
-           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
+require_relative "xml"
+require_relative "ql"

data/lib/ql.rb

@@ -0,0 +1,16 @@
+require_relative "base"
+
+module OverpassAPI
+  class QL < Base
+    def build_query(q)
+      header = ""
+      header << "[bbox:#{@bbox}]" if @bbox
+      header << "[timeout:#{@timeout}]" if @timeout
+      header << "[maxsize:#{@maxsize}]" if @maxsize
+
+      header << "[out:json]"
+
+      "#{header};#{q}"
+    end
+  end
+end

data/lib/xml.rb

@@ -0,0 +1,12 @@
+require_relative 'base'
+
+module OverpassAPI
+  class XML < Base
+    def build_query(q)
+      bbox = @bbox ? "bbox='#{@bbox}'" : ''
+      timeout = @timeout ? "timeout='#{@timeout}'" : ''
+      maxsize = @maxsize ? "maxsize='#{@maxsize}'" : ''
+      "<osm-script #{bbox} #{timeout} #{maxsize} output='json'>#{q}<print/></osm-script>"
+    end
+  end
+end

data/overpass-api-ruby.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   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.summary       = %q{This gem will allow you to perform queries to OSM Overpass API using QL or XML}
   spec.homepage      = "https://github.com/BrunoSalerno/overpass-api-ruby"
   spec.license       = "MIT"
 
@@ -19,8 +19,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "httpi", "~> 2.4.0"
-  spec.add_runtime_dependency "diskcached"
-  spec.add_runtime_dependency "nokogiri"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/spec/overpass_api_ruby_spec.rb

@@ -2,18 +2,33 @@ require 'spec_helper'
 require 'overpass_api_ruby'
 
 describe OverpassAPI do
-  it "'s example works" do
+  describe OverpassAPI::XML do
+    it "'s example works" do
+      options={:bbox => {:s => -34.705448, :n => -34.526562,
+                         :w => -58.531471, :e => -58.335159},
+               :timeout => 900}
 
-    ba_query = "<union><query type='relation'><has-kv k='route' v='subway'/></query>" <<
-      "</union><union><item/><recurse type='down'/></union>"
+      overpass = OverpassAPI::XML.new(options)
 
-    options={:bbox => {:s => -34.705448, :n => -34.526562,
-                       :w => -58.531471, :e => -58.335159},
-             :timeout => 900,
-             :element_limit => 1,
-             :json => true}
+      ba_query = "<union><query type='relation'><has-kv k='route' v='subway'/></query>" <<
+        "</union><union><item/><recurse type='down'/></union>"
 
-    overpass = OverpassAPI.new(options)
-    expect(overpass.query(ba_query)).to be_a(Array)
+
+      expect(overpass.query(ba_query)[:elements]).to be_a(Array)
+    end
+  end
+
+  describe OverpassAPI::QL do
+    it "'s example works" do
+      options={:bbox => {:s => -34.705448, :n => -34.526562,
+                         :w => -58.531471, :e => -58.335159},
+               :timeout => 900}
+
+      overpass = OverpassAPI::QL.new(options)
+
+      ba_query = "rel['route'='subway'];(._;>;);out body;"
+
+      expect(overpass.query(ba_query)[:elements]).to be_a(Array)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: overpass-api-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: '0.2'
 platform: ruby
 authors:
 - Bruno Salerno
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-30 00:00:00.000000000 Z
+date: 2017-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpi
@@ -24,34 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.4.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
@@ -117,12 +89,16 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- lib/base.rb
 - lib/overpass_api_ruby.rb
+- lib/ql.rb
+- lib/xml.rb
 - overpass-api-ruby.gemspec
 - spec/overpass_api_ruby_spec.rb
 - spec/spec_helper.rb
@@ -146,10 +122,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Returns a Hash from a query
+summary: This gem will allow you to perform queries to OSM Overpass API using QL or
+  XML
 test_files:
 - spec/overpass_api_ruby_spec.rb
 - spec/spec_helper.rb