underpass 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a173c933d640a68a1ed75c88ee6dcb770cb17a953d9ae56769b55629b3d06b04
-  data.tar.gz: 031f1237a8d944f693e16c694699e6abf0ace92249257329c80083739b6c959d
+  metadata.gz: 499389ab42025a727e89c1bfbee99f0444fb7db0593c06ad2959eda87d794d65
+  data.tar.gz: c8d700d784d837474e6fa5dd5f8d35339b8bf17cf08de41cdfa32807f87cf889
 SHA512:
-  metadata.gz: f5b7bbd768748cdda65a8b1160035086460a6cc80a56044e84812c97a0e7be8edb83a9d2dd2bce6c5573a9322e48100e7f1ece4b8cb56b711eb7341e5a1464db
-  data.tar.gz: 893374e2c0eef334aaf9d0573b2d17b8a49854e5f639249b1c5f40492b56b513dae6fe7f4c2e1a17c9280f058f6b668f92191958032071bf0dee26a9a0f9d2ed
+  metadata.gz: 321f52730a7c02f9828cf5451e4a92507fb32b219114a3d1b20c93956e19e710218594a5afee47370e4cafc7e37f5226c21db8f43806ff9fc2fe7becb2ac6e5f
+  data.tar.gz: aeeda5fbdf1f1a355a4ee4e9d5484aaf1d71994ba3c6f08d236fc4e4473363c94fabe219a3205a8d8220f74f2ad0cc5ae45198b532e4c0f8516e5ae8f9a69e7b

data/lib/underpass.rb

@@ -5,8 +5,8 @@ require 'json'
 
 require 'underpass/ql/ql'
 
-# The Underpass library
-# Offers various helpers to work with the Overpass API and RGeo objects
+# Underpass is a library that makes it easy to query the Overpass API
+# and translate its responses into RGeo objects
 module Underpass
 end
 

data/lib/underpass/ql/bounding_box.rb

@@ -4,7 +4,7 @@ module Underpass
   module QL
     # Bounding box related utilities.
     class BoundingBox
-      # returns the Overpass query language bounding box string
+      # Returns the Overpass query language bounding box string
       # when provided with an RGeo geometry
       def self.from_geometry(geometry)
         r_bb = RGeo::Cartesian::BoundingBox.create_from_geometry(geometry)

data/lib/underpass/ql/parser.rb

@@ -2,8 +2,8 @@
 
 module Underpass
   module QL
-    # Parses the API request response into easily digestable objects
-    # which are then returned as matches.
+    # Deals with parsing the API request response into easily digestable objects
+    # which are then returned as matches
     class Parser
       def initialize(response)
         @response = response

data/lib/underpass/ql/ql.rb

@@ -9,7 +9,7 @@ require 'underpass/ql/query'
 module Underpass
   # Provides the means to work with Overpass by using the
   # Overpass Query Language (QL). Overpass also provides an XML based
-  # query language but we're not interested in that.
+  # query language but we're not interested in that
   module QL
   end
 end

data/lib/underpass/ql/query.rb

@@ -2,8 +2,11 @@
 
 module Underpass
   module QL
-    # Convenience class, provides the perform static method.
+    # Provides a shortcut method that makes it easy to work with the library
     class Query
+      # Shortcut method that glues together the whole library.
+      # * +bounding_box+ an RGeo polygon
+      # * +query+ is the Overpass QL query
       def self.perform(bounding_box, query)
         op_bbox = Underpass::QL::BoundingBox.from_geometry(bounding_box)
         response = Underpass::QL::Request.new(query, op_bbox).run

data/lib/underpass/ql/request.rb

@@ -2,7 +2,7 @@
 
 module Underpass
   module QL
-    # Deals with performing the Overpass API request.
+    # Deals with performing the Overpass API request
     class Request
       API_URI = 'https://overpass-api.de/api/interpreter'.freeze
       QUERY_TEMPLATE = <<-TEMPLATE.freeze
@@ -20,6 +20,7 @@ module Underpass
         @global_bbox ||= "[#{bbox}]"
       end
 
+      # Performs the API request
       def run
         query = QUERY_TEMPLATE.sub('BBOX', @global_bbox)
                               .sub('QUERY', @overpass_query)

data/lib/underpass/ql/shape.rb

@@ -2,7 +2,8 @@
 
 module Underpass
   module QL
-    # Contains factories for various shapes from ways and nodes.
+    # Contains factories for various RGeo shapes from ways and nodes parsed
+    # with the Parser class
     class Shape
       def self.polygon_from_way(way, nodes)
         f = RGeo::Geographic.spherical_factory(srid: 4326)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: underpass
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Janos Rusiczki
@@ -80,7 +80,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="