neo4jrb_spatial 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9a8fabd817cc1db5b5d5f6f7466a1c0850f7359
+  data.tar.gz: 39f2e8a65c7a8a3f4baf988423be0916b6a9c282
+SHA512:
+  metadata.gz: 3fd46e9a2b1605f8539f97c68fb9fecfd39f9a4949a20a18a811ce0ac697c015e0d181b6882c45d2b1f9bdaf7e5d895e0252a6b7c7ee4b483c07c0c962e10fca
+  data.tar.gz: 0d2eedf8a8df07564138fd9e2be26c0fad14b2f424169fbae7fbd7c4f8a8289f563e57af8ae3b2546a7e9e74889f5a1cbdd685d0c7464b266b85410869a68a9f

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This file should follow the standards specified on [http://keepachangelog.com/]
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased][unreleased]
+
+## [1.0.0] - 2015-06-TBD
+
+### Added
+- Everything. It's all new.

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+# gem 'neo4j', github: 'neo4jrb/neo4j', branch: 'master'
+gem 'neo4j-core', github: 'neo4jrb/neo4j-core', branch: 'master'
+
+# Specify your gem's dependencies in neo4jrb_spatial.gemspec
+gemspec

data/README.md

@@ -0,0 +1,107 @@
+# Neo4jrbSpatial
+
+Provides support for Neo4j Spatial to Neo4j.rb 5+.
+
+It is more or less a Neo4j.rb-flavored implementation of [Max De Marzi](https://github.com/maxdemarzi)'s
+[code](https://github.com/maxdemarzi/neography/blob/46be2bb3c66aea14e707b1e6f82937e65f686ccc/lib/neography/rest/spatial.rb) from
+[Neography](https://github.com/maxdemarzi/neography).
+
+For support, open an issue or say hello through [Gitter](https://gitter.im/neo4jrb/neo4j).
+
+## What it provides
+
+* Basic index and layer management
+* Basic node-to-index management
+* Hooks for Neo4j::ActiveNode::Query::QueryProxy models if you are using them
+
+It is powered by an implementation of [Neography's](https://github.com/maxdemarzi/neography) [spatial module](https://github.com/maxdemarzi/neography/blob/46be2bb3c66aea14e707b1e6f82937e65f686ccc/lib/neography/rest/spatial.rb).
+Clearly, a huge debt is owed to [Max De Marzi](https://github.com/maxdemarzi) for doing all the hard work.
+
+## Requirements
+
+* Neo4j-core 5.0.1+
+* Neo4j Server 2.2.2+ (earlier versions will likely work but are not tested)
+* Ruby MRI 2.2.2+
+* Compatible version of [Neo4j Spatial](https://github.com/neo4j-contrib/spatial)
+
+Optionally:
+
+* v5.0.1+ of the [Neo4j gem](https://github.com/neo4jrb/neo4j)
+
+# Usage
+
+
+## Require it
+
+```
+# neo4j-core only?
+require 'neo4j/spatial'
+
+# neo4j gem/ActiveNode can omit the line above, just include the module in your model
+include Neo4j::ActiveNode::Spatial
+```
+
+## Basics - Neo4j-core
+
+```ruby
+# Create an index
+Neo4j::Session.current.create_spatial_index('restaurants')
+
+# Create a node
+node = Neo4j::Node.create({:name => "Indie Cafe", :lat => 41.990326, :lon => -87.672907 }, :Restaurant)
+
+# Add a node to the index
+Neo4j::Session.current.add_node_to_spatial_index('restaurants', node)
+
+# Query around the index
+Neo4j::Session.current.query.start('n = node:restaurants({location})').params(location: 'withinDistance:[41.99,-87.67,10.0]').pluck(:n)
+# => CypherNode 90126 (70333884677220)
+```
+
+## Basics - Neo4j gem
+
+ Neo4j.rb does not support legacy indexes, so a helper method is provided to add nodes. As with normal properties, your lat and lon
+ should be explicitly declared.
+ 
+### Automatic index addition
+
+At the moment, automatic index addition is not implemented.
+
+### Manual index addition
+
+All of the Neo4j-core spatial methods accept ActiveNode-including nodes, so you can use them as arguments for all defined methods as you would
+Neo4j::Server::CypherNode instances.
+
+Additionally, you can call the `add_to_spatial_index` instance method on any node to add it to its model's defined index.
+
+### Spatial queries
+
+No helpers are provided to query against the REST API -- you'll need to use the ones provided for Neo4j-core; however, a class method is provided 
+to make Cypher queries easier: `spatial_match`.
+
+```
+# Use the index defined on the model as demonstrated above
+Restaurant.all.spatial_match(:r, params_string)
+# Generates:
+# => "START r = node:restaurants({params_string})"
+```
+
+It then drops you back into a QueryProxy in the context of the class. If you had an `employees` association defined in your model:
+ 
+ ```
+ # Find all restaurants within the specified distance, then find their employees who are age 30
+ Restauarant.all.spatial_match(:r, 'withinDistance:[41.99,-87.67,10.0]').employees.where(age: 30)
+ ```
+ 
+ Alternatively, if you did no define `spatial_index` on your model, you can feed a third argument: the index to use for the query.
+
+## Additional Resources
+
+Check out the specs and the code for help, it's rather straightforward.
+
+[Max's blog post](http://maxdemarzi.com/2014/01/31/neo4j-spatial-part-1/) on using Neography with Spatial
+mostly works for an idea of the basics, just replace Neography-specific commands with their Neo4j-core versions.
+
+## Contributions
+
+Pull requests and maintanence help would be swell. In addition to being fully tested, please ensure rubocop passes by running `rubocop` from the CLI. 

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'neo4jrb_spatial'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/neo4j/active_node/spatial.rb

@@ -0,0 +1,40 @@
+module Neo4j::ActiveNode
+  module Spatial
+    def self.included(other)
+      other.extend(ClassMethods)
+    end
+
+    def add_to_spatial_index(index_name = nil)
+      index = index_name || self.class.spatial_index_name
+      fail 'index name not found' unless index
+      Neo4j::Session.current.add_node_to_spatial_index(index, self)
+    end
+
+    module ClassMethods
+      attr_reader :spatial_index_name
+      def spatial_index(index_name = nil)
+        return spatial_index_name unless index_name
+        # create_index_callback(index_name)
+        @spatial_index_name = index_name
+      end
+
+      # This will not work for now. Neo4j Spatial's REST API doesn't seem to work within transactions.
+      # def create_index_callback(index_name)
+      #   after_create(proc { |node| Neo4j::Session.current.add_node_to_spatial_index(index_name, node) })
+      # end
+
+      # private :create_index_callback
+    end
+
+    class Query::QueryProxy
+      def spatial_match(var, params_string, spatial_index = nil)
+        index = model.spatial_index_name || spatial_index
+        fail 'Cannot query without index. Set index in model or as third argument.' unless index
+        Neo4j::Session.current.query
+          .start("#{var} = node:#{index}({spatial_params})")
+          .proxy_as(model, var)
+          .params(spatial_params: params_string)
+      end
+    end
+  end
+end

data/lib/neo4j/spatial.rb

@@ -0,0 +1,130 @@
+module Neo4j::Server
+  module Spatial
+    def spatial?
+      Neo4j::Session.current.connection.get('/db/data/ext/SpatialPlugin').status == 200
+    end
+
+    def spatial_plugin
+      Neo4j::Session.current.connection.get('/db/data/ext/SpatialPlugin').body
+    end
+
+    def add_point_layer(layer, lat = nil, lon = nil)
+      options = {
+        layer: layer,
+        lat: lat || 'lat',
+        lon: lon || 'lon'
+      }
+
+      spatial_post('/ext/SpatialPlugin/graphdb/addSimplePointLayer', options)
+    end
+
+    def add_editable_layer(layer, format = 'WKT', node_property_name = 'wkt')
+      options = {
+        layer: layer,
+        format: format,
+        nodePropertyName: node_property_name
+      }
+
+      spatial_post('/ext/SpatialPlugin/graphdb/addEditableLayer', options)
+    end
+
+    def get_layer(layer)
+      options = {
+        layer: layer
+      }
+      spatial_post('/ext/SpatialPlugin/graphdb/getLayer', options)
+    end
+
+    def add_geometry_to_layer(layer, geometry)
+      options = {
+        layer: layer,
+        geometry: geometry
+      }
+      spatial_post('/ext/SpatialPlugin/graphdb/addGeometryWKTToLayer', options)
+    end
+
+    def edit_geometry_from_layer(layer, geometry, node)
+      options = {
+        layer: layer,
+        geometry: geometry,
+        geometryNodeId: get_id(node)
+      }
+      spatial_post('/ext/SpatialPlugin/graphdb/updateGeometryFromWKT', options)
+    end
+
+    def add_node_to_layer(layer, node)
+      options = {
+        layer: layer,
+        node: "#{resource_url}node/#{node.neo_id}"
+      }
+      spatial_post('/ext/SpatialPlugin/graphdb/addNodeToLayer', options)
+    end
+
+    def find_geometries_in_bbox(layer, minx, maxx, miny, maxy)
+      options = {
+        layer: layer,
+        minx: minx,
+        maxx: maxx,
+        miny: miny,
+        maxy: maxy
+      }
+      spatial_post('/ext/SpatialPlugin/graphdb/findGeometriesInBBox', options)
+    end
+
+    def find_geometries_within_distance(layer, pointx, pointy, distance)
+      options = {
+        layer: layer,
+        pointX: pointx,
+        pointY: pointy,
+        distanceInKm: distance
+      }
+      spatial_post('/ext/SpatialPlugin/graphdb/findGeometriesWithinDistance', options)
+    end
+
+    def create_spatial_index(name, type = nil, lat = nil, lon = nil)
+      options = {
+        name: name,
+        config: {
+          provider: 'spatial',
+          geometry_type: type || 'point',
+          lat: lat || 'lat',
+          lon: lon || 'lon'
+        }
+      }
+      spatial_post('/index/node', options)
+    end
+
+    def add_node_to_spatial_index(index, node)
+      options = {
+        uri: "/#{get_id(node)}",
+        key: 'k',
+        value: 'v'
+      }
+      spatial_post("/index/node/#{index}", options)
+    end
+
+    private
+
+    def spatial_post(path, options)
+      Neo4j::Session.current.connection.post("/db/data/#{path}", options).body
+    end
+
+    def get_id(id)
+      return id.neo_id if id.respond_to?(:neo_id)
+      case id
+      when Array
+        get_id(id.first)
+      when Hash
+        id[:self].split('/').last
+      when String
+        id.split('/').last
+      else
+        id
+      end
+    end
+  end
+
+  class CypherSession
+    include Spatial
+  end
+end

data/lib/neo4jrb_spatial.rb

@@ -0,0 +1,3 @@
+require 'neo4jrb_spatial/version'
+require 'neo4j/spatial'
+require 'neo4j/active_node/spatial'

data/lib/neo4jrb_spatial/version.rb

@@ -0,0 +1,3 @@
+module Neo4jrbSpatial
+  VERSION = '1.0.0'
+end

data/neo4jrb_spatial.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'neo4jrb_spatial/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'neo4jrb_spatial'
+  spec.version       = Neo4jrbSpatial::VERSION
+  spec.authors       = ['Chris Grigg']
+  spec.email         = ['chris@subvertallmedia.com']
+
+  spec.summary       = 'Provides basic support for Neo4j Spatial with Neo4j.rb.'
+  spec.homepage      = 'https://github.com/neo4jrb/neo4jrb_spatial'
+
+  spec.files         = Dir.glob('{bin,lib,config}/**/*') + %w(README.md CHANGELOG.md Gemfile neo4jrb_spatial.gemspec)
+  spec.bindir        = 'exe'
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency('rubocop', '~> 0.29.1')
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+
+  spec.add_dependency 'neo4j', '~> 5.0.1'
+  spec.add_dependency 'neo4j-core', '~> 5.0.1'
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: neo4jrb_spatial
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chris Grigg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.29.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.29.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
+  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: neo4j
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+- !ruby/object:Gem::Dependency
+  name: neo4j-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+description: 
+email:
+- chris@subvertallmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- README.md
+- bin/console
+- bin/setup
+- lib/neo4j/active_node/spatial.rb
+- lib/neo4j/spatial.rb
+- lib/neo4jrb_spatial.rb
+- lib/neo4jrb_spatial/version.rb
+- neo4jrb_spatial.gemspec
+homepage: https://github.com/neo4jrb/neo4jrb_spatial
+licenses: []
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Provides basic support for Neo4j Spatial with Neo4j.rb.
+test_files: []