underpass 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6eb4a19e646598efaf21f69ec0d0e3bc4d398efc4fcc9dd3cc4bc906c970e60
+  data.tar.gz: 7f1b2578cc5d3abaeeb99ceb91bcf20a5c64097ed6c3b90f39554001ccbf7ffc
+SHA512:
+  metadata.gz: a67e96bf3764f6235251f08c464a9597bea694d8578647affbbe6fe3cd37045c743b05d385f40d0406a146f7f750284296c6021445b772cd13f62667463ea356
+  data.tar.gz: 20e28a130ceb311dabb78104087fe5a25e59bfb6127d55c944a8697f175be03dd916a61dc52c0edcfe5a397676021bffdb3153d3113f1774c3708690d671adce

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Janos Rusiczki
+
+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,36 @@
+# underpass
+
+A library that makes it easy to translate [Overpass API](https://wiki.openstreetmap.org/wiki/Overpass_API) responses into RGeo objects.
+
+## Installation
+
+Install globally:
+
+    gem install underpass
+
+Or put it in your Gemfile:
+
+    gem 'underpass'
+
+## Usage
+
+    # create a bounding box
+    f = RGeo::Geographic.spherical_factory
+    bbox = f.parse_wkt('POLYGON ((23.669 47.65, 23.725 47.65, 23.725 47.674, 23.669 47.674, 23.669 47.65))')
+    # provide the query part
+    op_query = 'way["heritage:operator"="lmi"]["ref:ro:lmi"="MM-II-m-B-04508"];'
+    # perform the query and get results
+    result = Underpass::QL::Query.perform(bbox, op_query)
+
+## Contributing
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet;
+* Check out the issue tracker to make sure someone already hasn't requested it and / or contributed it;
+* Fork the project;
+* Start a feature / bugfix branch;
+* Commit and push until you are happy with your contribution;
+* Make sure to add specs for it. This is important so your contribution won't be broken in a future version unintentionally.
+
+## License
+
+underpass is released under the MIT License. See the [LICENSE file](LICENSE) for further details.

data/lib/underpass/ql/bounding_box.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Underpass
+  module QL
+    # Bounding box related utilities.
+    class BoundingBox
+      # 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)
+        "bbox:#{r_bb.min_y},#{r_bb.min_x},#{r_bb.max_y},#{r_bb.max_x}"
+      end
+    end
+  end
+end

data/lib/underpass/ql/parser.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Underpass
+  module QL
+    # Parses the API request response into easily digestable objects
+    # which are then returned as matches.
+    class Parser
+      def initialize(response)
+        @response = response
+        @matches = []
+      end
+
+      def parse
+        parsed_json = JSON.parse(@response.body, symbolize_names: true)
+        elements = parsed_json[:elements]
+
+        @nodes = extract_indexed_nodes(elements)
+        @ways = extract_indexed_ways(elements)
+
+        self
+      end
+
+      def matches
+        @ways.each_value do |way|
+          @matches << Underpass::QL::Shape.polygon_from_way(way, @nodes)
+        end
+
+        @matches
+      end
+
+      private
+
+      def extract_indexed_nodes(elements)
+        nodes = elements.select { |e| e[:type] == 'node' }
+        nodes.map { |e| [e[:id], e] }.to_h
+      end
+
+      def extract_indexed_ways(elements)
+        ways = elements.select { |e| e[:type] == 'way' }
+        ways.map { |e| [e[:id], e] }.to_h
+      end
+    end
+  end
+end

data/lib/underpass/ql/ql.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'underpass/ql/bounding_box'
+require 'underpass/ql/shape'
+require 'underpass/ql/request'
+require 'underpass/ql/parser'
+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.
+  module QL
+  end
+end

data/lib/underpass/ql/query.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Underpass
+  module QL
+    # Convenience class, provides the perform static method.
+    class 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
+        Underpass::QL::Parser.new(response).parse.matches
+      end
+    end
+  end
+end

data/lib/underpass/ql/request.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Underpass
+  module QL
+    # Deals with performing the Overpass API request.
+    class Request
+      API_URI = 'https://overpass-api.de/api/interpreter'.freeze
+      QUERY_TEMPLATE = <<-TEMPLATE.freeze
+        [out:json][timeout:25]BBOX;
+        (
+          QUERY
+        );
+        out body;
+        >;
+        out skel qt;
+      TEMPLATE
+
+      def initialize(query, bbox)
+        @overpass_query = query
+        @global_bbox ||= "[#{bbox}]"
+      end
+
+      def run
+        query = QUERY_TEMPLATE.sub('BBOX', @global_bbox)
+                              .sub('QUERY', @overpass_query)
+        Net::HTTP.post_form(URI(API_URI), data: query)
+      end
+    end
+  end
+end

data/lib/underpass/ql/shape.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Underpass
+  module QL
+    # Contains factories for various shapes from ways and nodes.
+    class Shape
+      def self.polygon_from_way(way, nodes)
+        f = RGeo::Geographic.spherical_factory(srid: 4326)
+        f.polygon(line_string_from_way(way, nodes))
+      end
+
+      def self.line_string_from_way(way, nodes)
+        f = RGeo::Geographic.spherical_factory(srid: 4326)
+        f.line_string(
+          way[:nodes].map do |n|
+            f.point(nodes[n][:lon], nodes[n][:lat])
+          end
+        )
+      end
+
+      # There should be some sort of 'decorator' to return an object
+      # with the shape and a copy of the tags as
+      # {
+      #   tags: way[:tags],
+      #   shape: shape
+      # }
+    end
+  end
+end

data/lib/underpass.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rgeo'
+require 'json'
+
+require 'underpass/ql/ql'
+
+# The Underpass library
+# Offers various helpers to work with the Overpass API and RGeo objects
+module Underpass
+end
+
+# Example usage
+#
+# require 'underpass'
+# f = RGeo::Geographic.spherical_factory
+# bbox = f.parse_wkt('POLYGON ((23.669 47.65, 23.725 47.65, 23.725 47.674, 23.669 47.674, 23.669 47.65))')
+# op_query = 'way["heritage:operator"="lmi"]["ref:ro:lmi"="MM-II-m-B-04508"];'
+# Underpass::QL::Query.perform(bbox, op_query)

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: underpass
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Janos Rusiczki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rgeo
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+description: underpass makes it easy to translate Overpass API responses into RGeo
+  objects
+email: janos.rusiczki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/underpass.rb
+- lib/underpass/ql/bounding_box.rb
+- lib/underpass/ql/parser.rb
+- lib/underpass/ql/ql.rb
+- lib/underpass/ql/query.rb
+- lib/underpass/ql/request.rb
+- lib/underpass/ql/shape.rb
+homepage: http://github.com/haiafara/underpass
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: A library that translates Overpass API responses into RGeo objects
+test_files: []