overpass-api-ruby 0.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ef9346aa556dd932264aaa04f016c2d86553a93
-  data.tar.gz: f6366d26fa31b74b910400e11f92376996dd0204
+  metadata.gz: 869f0f15d223e2dba7f50b5aee38f229afecff1f
+  data.tar.gz: a51e2aa6cfc9c4cd9eb9ace840d9c48eabbbacb1
 SHA512:
-  metadata.gz: 013cc225d04ad2f4fe501f2beb430ad837831ddc134e4630ac962d7f47518d34b9c9f796418d103862a2aca2a762f10be631a7db8a0b4abf252c9c16e5542f7a
-  data.tar.gz: 05eb5f15ed2b487300124889ca2ce7ecf5fedaa86cd3ec1c281af66c226083ca80bde55831b76ea525ecf66cf553053f20d98e25645ebca149b796bca1d37e35
+  metadata.gz: dd3a55ea3765c2c07b842a420eae89edbcd3111338e4ad9b878a2f42b39a6de0cebb92bc4d3749d1303ffd96e351a6c9571e7ff0bf53781a60c7d733400acacb
+  data.tar.gz: 63ea5915cbd930c273759d3da28bd87a868b57af31e6aa5af2f9ecf23fe0fa5734b43391f1cd20836b06bb30af762a069748df96d0ab10211ea8010bb0565e94

data/README.md

@@ -1,4 +1,4 @@
-Overpass API Ruby
+Overpass API Ruby [![CircleCI](https://circleci.com/gh/BrunoSalerno/overpass-api-ruby.svg?style=svg)](https://circleci.com/gh/BrunoSalerno/overpass-api-ruby)
 =================
 
 A Ruby wrapper for OpenStreetMap Overpass API. Supports both QL and XML.
@@ -76,6 +76,10 @@ buid_query (<String query>) Returns a String containing the whole query.
 bounding_box (s,n,w,e)      Defines the global bounding box.
 ```
 
+Test
+----
+
+Run `rake spec`
 
 License
 -------

data/Rakefile

@@ -4,9 +4,10 @@ require 'bundler/gem_tasks'
 require 'rake'
 require 'rspec/core/rake_task'
 
-desc 'Run all examples'
+desc 'Run all tests'
 RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "spec/**/*_spec.rb"
   t.rspec_opts = %w(--color --warnings)
 end
 
-task default: [:spec]
+task default: [:spec]

data/lib/base.rb

@@ -3,8 +3,6 @@ require 'open-uri'
 require 'json'
 
 module OverpassAPI
-  VERSION='0.2'
-
   class Base
     DEFAULT_ENDPOINT='http://overpass-api.de/api/interpreter?data='
 

data/lib/version.rb

@@ -0,0 +1,3 @@
+module OverpassAPI
+  VERSION='0.2.1'
+end

data/overpass-api-ruby.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'overpass_api_ruby'
+require 'version'
 
 Gem::Specification.new do |spec|
   spec.name          = "overpass-api-ruby"

data/spec/integration/ql_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'overpass_api_ruby'
+
+describe OverpassAPI::QL do
+  it "should return the right elements" 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

data/spec/integration/xml_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'overpass_api_ruby'
+
+describe OverpassAPI::XML do
+  it "should return the requested elements" do
+    options={:bbox => {:s => -34.705448, :n => -34.526562,
+                       :w => -58.531471, :e => -58.335159},
+                       :timeout => 900}
+
+    overpass = OverpassAPI::XML.new(options)
+
+    ba_query = "<union><query type='relation'><has-kv k='route' v='subway'/></query>" <<
+    "</union><union><item/><recurse type='down'/></union>"
+
+
+    expect(overpass.query(ba_query)[:elements]).to be_a(Array)
+  end
+end

data/spec/spec_helper.rb

@@ -37,7 +37,7 @@ RSpec.configure do |config|
     # Prevents you from mocking or stubbing a method that does not exist on
     # a real object. This is generally recommended, and will default to
     # `true` in RSpec 4.
-    mocks.verify_partial_doubles = true
+    mocks.verify_partial_doubles = false
   end
 
 # The settings below are suggested to provide a good initial experience

data/spec/unit/base_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+require 'overpass_api_ruby'
+require 'httpi'
+
+describe OverpassAPI::Base do
+  it "should return the default endpoint" do
+    expect(OverpassAPI::Base::DEFAULT_ENDPOINT).to eq "http://overpass-api.de/api/interpreter?data="
+    base = OverpassAPI::Base.new
+    expect(base.instance_variable_get("@endpoint")).to eq OverpassAPI::Base::DEFAULT_ENDPOINT
+  end
+
+  it "should set the right args" do
+    opts = {bbox: {s: 1, n: 2, w: 3, e: 4},
+            endpoint: "a.endpoint.com",
+            timeout: 1000,
+            maxsize: 333}
+
+    base = OverpassAPI::Base.new(opts)
+
+    expect(base.instance_variable_get("@bbox")).to eq "1,3,2,4"
+    expect(base.instance_variable_get("@endpoint")).to eq "a.endpoint.com"
+    expect(base.instance_variable_get("@timeout")).to eq 1000
+    expect(base.instance_variable_get("@maxsize")).to eq 333
+  end
+
+  it "should set the bounding box" do
+    base = OverpassAPI::Base.new
+    base.bounding_box(10,20,30,40)
+
+    expect(base.instance_variable_get("@bbox")).to eq "10,30,20,40"
+  end
+
+  it "should try to perform the query" do
+    base = OverpassAPI::Base.new
+
+    query = "a query"
+    built_query = "built_query"
+    expected_response = "a response"
+
+    allow(base).to receive(:perform).and_return(expected_response)
+    allow(base).to receive(:build_query).and_return(built_query)
+
+    expect(base).to receive(:build_query).with(query)
+    expect(base).to receive(:perform).with(built_query)
+
+    response = base.query(query)
+
+    expect(response).to eq expected_response
+  end
+
+  it "should try to perform a raw query" do
+    base = OverpassAPI::Base.new
+
+    query = "as query"
+    expected_response = "a response"
+
+    allow(base).to receive(:perform).and_return(expected_response)
+    expect(base).to receive(:perform).with(query)
+
+    response = base.raw_query(query)
+
+    expect(response).to eq expected_response
+  end
+
+  it "should try to perform an http request" do
+    base = OverpassAPI::Base.new
+
+    query = "a query"
+    request = "a request"
+    body = {key: "value"}
+
+    url = URI::encode("#{OverpassAPI::Base::DEFAULT_ENDPOINT}#{query}")
+
+    allow(HTTPI::Request).to receive(:new).and_return(request)
+    expect(HTTPI::Request).to receive(:new).with(url)
+
+    allow(HTTPI).to receive(:get).and_return(OpenStruct.new(body: body.to_json))
+    expect(HTTPI).to receive(:get).with(request)
+
+    response = base.raw_query(query)
+    expect(response).to eq body
+  end
+end

data/spec/unit/ql_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'overpass_api_ruby'
+
+describe OverpassAPI::QL do
+  it "should return the right built query when no opts are passed" do
+    overpass = OverpassAPI::QL.new
+    built_query = overpass.build_query("a query")
+
+    expect(built_query).to eq "[out:json];a query"
+  end
+
+  it "should set the right opts" do
+    opts = {bbox: {s: 1, n: 2, w: 3, e: 4},
+            timeout: 1000,
+            maxsize: 333}
+
+    overpass = OverpassAPI::QL.new(opts)
+    built_query = overpass.build_query("a query")
+
+    expected_built_query = "[bbox:1,3,2,4][timeout:1000][maxsize:333][out:json];a query"
+    expect(built_query).to eq expected_built_query
+  end
+end

data/spec/unit/xml_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'overpass_api_ruby'
+
+describe OverpassAPI::XML do
+  it "should return the right built query when no opts are passed" do
+    overpass = OverpassAPI::XML.new
+    built_query = overpass.build_query("a query")
+
+    expect(built_query).to eq "<osm-script    output='json'>a query<print/></osm-script>"
+  end
+
+  it "should set the right opts" do
+    opts = {bbox: {s: 1, n: 2, w: 3, e: 4},
+            timeout: 1000,
+            maxsize: 333}
+
+    overpass = OverpassAPI::XML.new(opts)
+    built_query = overpass.build_query("a query")
+
+    expected_built_query = "<osm-script bbox='1,3,2,4' timeout='1000' maxsize='333' output='json'>" <<
+                           "a query<print/></osm-script>"
+    expect(built_query).to eq expected_built_query
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: overpass-api-ruby
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.2.1
 platform: ruby
 authors:
 - Bruno Salerno
@@ -98,10 +98,15 @@ files:
 - lib/base.rb
 - lib/overpass_api_ruby.rb
 - lib/ql.rb
+- lib/version.rb
 - lib/xml.rb
 - overpass-api-ruby.gemspec
-- spec/overpass_api_ruby_spec.rb
+- spec/integration/ql_spec.rb
+- spec/integration/xml_spec.rb
 - spec/spec_helper.rb
+- spec/unit/base_spec.rb
+- spec/unit/ql_spec.rb
+- spec/unit/xml_spec.rb
 homepage: https://github.com/BrunoSalerno/overpass-api-ruby
 licenses:
 - MIT
@@ -128,5 +133,9 @@ specification_version: 4
 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/integration/ql_spec.rb
+- spec/integration/xml_spec.rb
 - spec/spec_helper.rb
+- spec/unit/base_spec.rb
+- spec/unit/ql_spec.rb
+- spec/unit/xml_spec.rb

data/spec/overpass_api_ruby_spec.rb

@@ -1,34 +0,0 @@
-require 'spec_helper'
-require 'overpass_api_ruby'
-
-describe OverpassAPI 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}
-
-      overpass = OverpassAPI::XML.new(options)
-
-      ba_query = "<union><query type='relation'><has-kv k='route' v='subway'/></query>" <<
-        "</union><union><item/><recurse type='down'/></union>"
-
-
-      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