neography 1.3.6 → 1.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0370d9441fe781940dd20f4a89eac1306299d8a
-  data.tar.gz: 51f228c713783eac9783df52a61676ddead5435c
+  metadata.gz: c8915c7b2abbc72fbe16cb33d50b7e80d0c71b15
+  data.tar.gz: 2933f91d72dd64da8a60f9a2155068b9baacff32
 SHA512:
-  metadata.gz: ac5122807662830386f371b96335e98b6d3b967bd871dbe8c4f5e53de41ece3638e251d05d891a9323f5551c80d4ae3e1857307c23573c56bf414416a3e4445e
-  data.tar.gz: 6e8b5282ece9f8b52c30c5b599a7ea7ef1d08facb786d34b62be2078e836214f51e4782123d88295de50d71b49abc4f2011f30f45a86db42a8eda51b99ba514a
+  metadata.gz: 89c856460ee6365d4e24ebb270349b2fba5f8e4430afba1ba093ba3f85eed84bb524881e19a3f0e9e20792a57d2e5d930ec473b0234af1c3034cdafd136b133c
+  data.tar.gz: e7bcf2213babefd378c24c910163795c680a49a8bbb9cec62cb46064cb5f9506adbd16d7e58cee9ec412529f3ff74055527f998d3207793ab3877121c221dc11

data/.travis.yml

@@ -1,4 +1,4 @@
-script: "bundle exec rake neo4j:install['enterprise','2.0.0'] neo4j:start spec --trace"
+script: "bundle exec rake neo4j:install['enterprise','2.0.0'] neo4j:get_spatial neo4j:start spec --trace"
 language: ruby
 rvm:
   - 1.9.3

data/README.md

@@ -138,12 +138,29 @@ node2 = @neo.create_node("age" => 33, "name" => "Roel")
 @neo.add_node_to_index("people", "name", "max", node1)
 @neo.get_node_index("people", "name", "max")
 
-# Cypher queries:
-@neo.execute_query("start n=node(0) return n")
-
 # Batches:
 @neo.batch [:create_node, {"name" => "Max"}],
            [:create_node, {"name" => "Marc"}]
+           
+# Cypher queries:
+@neo.execute_query("start n=node(0) return n")
+           
+```
+
+You can also use the [cypher gem](https://github.com/andreasronge/neo4j-cypher) instead of writing cypher as text.
+
+
+```
+node(1).outgoing(rel(:friends).where{|r| r[:since] == 1994})
+```
+
+would become:
+
+```
+START me=node(1) 
+MATCH (me)-[friend_rel:`friends`]->(friends) 
+WHERE (friend_rel.since = 1994) 
+RETURN friends
 ```
 
 This is just a small sample of the full API, see the [Wiki documentation](https://github.com/maxdemarzi/neography/wiki) for the full API.

data/lib/neography/rest.rb

@@ -28,6 +28,7 @@ require 'neography/rest/extensions'
 require 'neography/rest/batch'
 require 'neography/rest/clean'
 require 'neography/rest/transactions'
+require 'neography/rest/spatial'
 
 require 'neography/errors'
 
@@ -69,6 +70,7 @@ module Neography
       @batch                     = Batch.new(@connection)
       @clean                     = Clean.new(@connection)
       @transactions              = Transactions.new(@connection)
+      @spatial                   = Spatial.new(@connection)
     end
 
     # meta-data
@@ -452,7 +454,53 @@ module Neography
     def batch_not_streaming(*args)
       @batch.not_streaming(*args)
     end
+    
+    # spatial
+    
+    def get_spatial
+      @spatial.index
+    end
+    
+    def add_point_layer(layer, lat = nil, lon = nil)
+      @spatial.add_point_layer(layer, lat, lon)
+    end
+
+    def add_editable_layer(layer, format, node_property_name)
+      @spatial.add_editable_layer(layer, format, node_property_name)
+    end
+
+    def get_layer(layer)
+      @spatial.get_layer(layer)
+    end
 
+    def add_geometry_to_layer(layer, geometry)
+      @spatial.add_geometry_to_layer(layer, geometry)
+    end
+    
+    def edit_geometry_from_layer(layer, geometry, node)
+      @spatial.edit_geometry_from_layer(layer, geometry, node)
+    end
+    
+    def add_node_to_layer(layer, node)
+      @spatial.add_node_to_layer(layer, node)
+    end
+    
+    def find_geometries_in_bbox(layer, minx, maxx, miny, maxy)
+      @spatial.find_geometries_in_bbox(layer, minx, maxx, miny, maxy)
+    end
+    
+    def find_geometries_within_distance(layer, pointx, pointy, distance)
+      @spatial.find_geometries_within_distance(layer, pointx, pointy, distance)
+    end
+    
+    def create_spatial_index(name, type = nil, lat = nil, lon = nil)
+      @spatial.create_spatial_index(name, type, lat, lon)
+    end
+    
+    def add_node_to_spatial_index(index, id)
+      @spatial.add_node_to_spatial_index(index, id)
+    end
+    
     # clean database
 
     # For testing (use a separate neo4j instance)

data/lib/neography/rest/spatial.rb

@@ -0,0 +1,154 @@
+module Neography
+  class Rest
+    class Spatial
+      extend Neography::Rest::Paths
+      include Neography::Rest::Helpers
+
+      add_path :index,                          "/ext/SpatialPlugin"
+      add_path :add_simple_point_layer,         "/ext/SpatialPlugin/graphdb/addSimplePointLayer"
+      add_path :add_editable_layer,             "/ext/SpatialPlugin/graphdb/addEditableLayer"
+      add_path :get_layer,                      "/ext/SpatialPlugin/graphdb/getLayer"
+      add_path :add_geometry_to_layer,          "/ext/SpatialPlugin/graphdb/addGeometryWKTToLayer"
+      add_path :edit_geometry_from_layer,       "/ext/SpatialPlugin/graphdb/updateGeometryFromWKT"
+      add_path :add_node_to_layer,              "/ext/SpatialPlugin/graphdb/addNodeToLayer"
+      add_path :find_geometries_in_bbox,        "/ext/SpatialPlugin/graphdb/findGeometriesInBBox"
+      add_path :find_geometries_within_distance,"/ext/SpatialPlugin/graphdb/findGeometriesWithinDistance"
+      add_path :create_index,                   "/index/node"
+      add_path :add_to_index,                   "/index/node/:index"
+
+      def initialize(connection)
+        @connection = connection
+      end
+
+      def index
+        @connection.get(index_path)
+      end
+
+      def add_point_layer(layer, lat, lon)
+        options = {
+          :body => {
+            :layer => layer,
+            :lat => lat || "lat",
+            :lon => lon || "lon"
+          }.to_json,
+          :headers => json_content_type.merge({'Accept' => 'application/json;charset=UTF-8'})
+        }
+        
+        @connection.post(add_simple_point_layer_path, options)        
+      end
+
+      def add_editable_layer(layer, format = "WKT", node_property_name = "wkt")
+        options = {
+          :body => {
+            :layer => layer,
+            :format => format,
+            :nodePropertyName => node_property_name
+          }.to_json,
+          :headers => json_content_type.merge({'Accept' => 'application/json;charset=UTF-8'})
+        }
+        
+        @connection.post(add_editable_layer_path, options)        
+      end
+
+      def get_layer(layer)
+        options = {
+          :body => {
+            :layer => layer
+          }.to_json,
+          :headers => json_content_type.merge({'Accept' => 'application/json;charset=UTF-8'})
+        }
+        @connection.post(get_layer_path, options)
+      end
+      
+      def add_geometry_to_layer(layer, geometry)
+        options = {
+          :body => {
+            :layer => layer,
+            :geometry => geometry
+          }.to_json,
+          :headers => json_content_type.merge({'Accept' => 'application/json;charset=UTF-8'})
+        }
+        @connection.post(add_geometry_to_layer_path, options)
+      end
+
+      def edit_geometry_from_layer(layer, geometry, node)
+        options = {
+          :body => {
+            :layer => layer,
+            :geometry => geometry,
+            :geometryNodeId => get_id(node)
+          }.to_json,
+          :headers => json_content_type.merge({'Accept' => 'application/json;charset=UTF-8'})
+        }
+        @connection.post(edit_geometry_from_layer_path, options)
+      end
+
+      def add_node_to_layer(layer, node)
+        options = {
+          :body => {
+            :layer => layer,
+            :node => get_id(node)
+          }.to_json,
+          :headers => json_content_type.merge({'Accept' => 'application/json;charset=UTF-8'})
+        }
+        @connection.post(add_node_to_layer_path, options)
+      end
+
+      def find_geometries_in_bbox(layer, minx, maxx, miny, maxy)
+        options = {
+          :body => {
+            :layer => layer,
+            :minx => minx,
+            :maxx => maxx,
+            :miny => miny,
+            :maxy => maxy
+          }.to_json,
+          :headers => json_content_type.merge({'Accept' => 'application/json;charset=UTF-8'})
+        }
+        @connection.post(find_geometries_in_bbox_path, options)
+      end
+
+      def find_geometries_within_distance(layer, pointx, pointy, distance)
+        options = {
+          :body => {
+            :layer => layer,
+            :pointX => pointx,
+            :pointY => pointy,
+            :distanceInKm => distance
+          }.to_json,
+          :headers => json_content_type.merge({'Accept' => 'application/json;charset=UTF-8'})
+        }
+        @connection.post(find_geometries_within_distance_path, options)
+      end
+      
+      def create_spatial_index(name, type, lat, lon)
+        options = {
+          :body => {
+            :name => name,
+            :config => {
+              :provider => "spatial",
+              :geometry_type => type || "point",
+              :lat => lat || "lat",
+              :lon => lon || "lon"
+            }
+          }.to_json,
+          :headers => json_content_type.merge({'Accept' => 'application/json;charset=UTF-8'})
+        }
+        @connection.post(create_index_path, options) 
+      end
+
+      def add_node_to_spatial_index(index, id)
+        options = {
+          :body => {
+            :uri   => @connection.configuration + "/node/#{get_id(id)}",
+            :key => "k",
+            :value => "v"
+          }.to_json,
+          :headers => json_content_type.merge({'Accept' => 'application/json;charset=UTF-8'})
+        }
+        @connection.post(add_to_index_path(:index => index), options)
+      end
+
+    end
+  end
+end

data/lib/neography/tasks.rb

@@ -155,4 +155,51 @@ namespace :neo4j do
     end
   end
 
+  task :get_spatial, :version  do |t, args|
+    args.with_defaults(:version => "2.0.0")
+    puts "Installing Neo4j-Spatial #{args[:version]}"
+
+      unless File.exist?('neo4j-spatial.zip')
+        df = File.open('neo4j-spatial.zip', 'wb')
+        case args[:version]
+          when "2.0.0"
+            dist = "dist.neo4j.org"
+            request = "/spatial/neo4j-spatial-0.12-neo4j-2.0.0-server-plugin.zip"
+          when "1.9"
+            dist = "dist.neo4j.org.s3.amazonaws.com"
+            request = "/spatial/neo4j-spatial-0.11-neo4j-1.9-server-plugin.zip"
+          when "1.8.2"
+            dist = "dist.neo4j.org.s3.amazonaws.com"
+            request = "/spatial/neo4j-spatial-0.9.1-neo4j-1.8.2-server-plugin.zip"
+          else
+            abort("I don't know that version of the neo4j spatial plugin")
+        end
+        
+        begin
+          Net::HTTP.start(dist) do |http|            
+            http.request_get(request) do |resp|
+                resp.read_body do |segment|
+                    df.write(segment)
+                end
+            end
+          end
+        ensure
+          df.close()
+        end
+      end
+
+      # Extract to neo4j plugins directory
+      Zip::File.open('neo4j-spatial.zip') do |zip_file|
+        zip_file.each do |f|
+         f_path=File.join("neo4j/plugins/", f.name)
+         FileUtils.mkdir_p(File.dirname(f_path))
+         begin
+           zip_file.extract(f, f_path) unless File.exist?(f_path)
+         rescue
+           puts f.name + " failed to extract."
+         end
+        end
+     end
+
+  end
 end  

data/lib/neography/version.rb

@@ -1,3 +1,3 @@
 module Neography
-  VERSION = "1.3.6"
+  VERSION = "1.3.7"
 end

data/spec/integration/rest_spatial_spec.rb

@@ -0,0 +1,166 @@
+require 'spec_helper'
+
+describe Neography::Rest do
+  before(:each) do
+    @neo = Neography::Rest.new
+  end
+
+  describe "find the spatial plugin" do
+    it "can get a description of the spatial plugin" do
+      si = @neo.get_spatial
+      si.should_not be_nil
+      si["graphdb"]["addEditableLayer"].should_not be_nil
+    end
+  end
+
+  describe "add a point layer" do
+    it "can add a simple point layer" do
+      pl = @neo.add_point_layer("restaurants") 
+      pl.should_not be_nil
+      pl.first["data"]["layer"].should == "restaurants"
+      pl.first["data"]["geomencoder_config"].should == "lon:lat"
+    end
+
+    it "can add a simple point layer with lat and long" do
+      pl = @neo.add_point_layer("coffee_shops", "latitude", "longitude") 
+      pl.should_not be_nil
+      pl.first["data"]["layer"].should == "coffee_shops"
+      pl.first["data"]["geomencoder_config"].should == "longitude:latitude"
+    end
+  end
+
+  describe "add an editable layer" do
+    it "can add an editable layer" do
+      el = @neo.add_editable_layer("zipcodes", "WKT", "wkt") 
+      el.should_not be_nil
+      el.first["data"]["layer"].should == "zipcodes"
+      el.first["data"]["geomencoder_config"].should == "wkt"
+    end
+  end
+
+  describe "get a spatial layer" do
+    it "can get a layer" do
+      sl = @neo.get_layer("restaurants")
+      sl.should_not be_nil
+      sl.first["data"]["layer"].should == "restaurants"
+    end
+  end
+
+  describe "create a spatial index" do
+    it "can create a spatial index" do
+      index = @neo.create_spatial_index("restaurants")
+      index["provider"].should == "spatial"
+      index["geometry_type"].should == "point"
+      index["lat"].should == "lat"
+      index["lon"].should == "lon"
+    end
+  end
+
+  describe "add geometry to spatial layer" do
+    it "can add a geometry" do
+      geometry = "LINESTRING (15.2 60.1, 15.3 60.1)"
+      geo = @neo.add_geometry_to_layer("zipcodes", geometry)
+      geo.should_not be_nil
+      geo.first["data"]["wkt"].should == geometry
+    end
+  end
+
+  describe "update geometry from spatial layer" do
+    it "can update a geometry" do
+      geometry = "LINESTRING (15.2 60.1, 15.3 60.1)"
+      geo = @neo.add_geometry_to_layer("zipcodes", geometry)
+      geo.should_not be_nil
+      geo.first["data"]["wkt"].should == geometry
+      geometry = "LINESTRING (14.7 60.1, 15.3 60.1)"
+      existing_geo = @neo.edit_geometry_from_layer("zipcodes", geometry, geo)
+      existing_geo.first["data"]["wkt"].should == geometry
+      existing_geo.first["self"].split('/').last.to_i.should ==  geo.first["self"].split('/').last.to_i 
+    end
+  end
+
+  describe "add a node to a layer" do
+    it "can add a node to a simple point layer" do
+      properties = {:name => "Max's Restaurant", :lat => 41.8819, :lon => 87.6278}
+      node = @neo.create_node(properties)
+      node.should_not be_nil
+      added = @neo.add_node_to_layer("restaurants", node)
+      added.first["data"]["lat"].should == properties[:lat]
+      added.first["data"]["lon"].should == properties[:lon]
+
+      added = @neo.add_node_to_index("restaurants", "dummy", "dummy", node)
+      added["data"]["lat"].should == properties[:lat]
+      added["data"]["lon"].should == properties[:lon]
+    end
+  end
+  
+  describe "find geometries in a bounding box" do
+    it "can find a geometry in a bounding box" do
+      properties = {:name => "Max's Restaurant", :lat => 41.8819, :lon => 87.6278}
+      node = @neo.find_geometries_in_bbox("restaurants", 87.5, 87.7, 41.7, 41.9)
+      node.should_not be_empty
+      node.first["data"]["lat"].should == properties[:lat]
+      node.first["data"]["lon"].should == properties[:lon]
+      node.first["data"]["name"].should == "Max's Restaurant"
+    end
+    
+    it "can find a geometry in a bounding box using cypher" do
+      properties = {:lat => 60.1, :lon => 15.2}
+      @neo.create_spatial_index("geombbcypher", "point", "lat", "lon")
+      node = @neo.create_node(properties)
+      added = @neo.add_node_to_index("geombbcypher", "dummy", "dummy", node)
+      existing_node = @neo.execute_query("start node = node:geombbcypher('bbox:[15.0,15.3,60.0,60.2]') return node")
+      existing_node.should_not be_empty
+      existing_node["data"][0][0]["data"]["lat"].should == properties[:lat]
+      existing_node["data"][0][0]["data"]["lon"].should == properties[:lon]
+    end
+
+    it "can find a geometry in a bounding box using cypher two" do
+      properties = {:lat => 60.1, :lon => 15.2}
+      @neo.create_spatial_index("geombbcypher2", "point", "lat", "lon")
+      node = @neo.create_node(properties)
+      added = @neo.add_node_to_spatial_index("geombbcypher2", node)
+      existing_node = @neo.execute_query("start node = node:geombbcypher2('bbox:[15.0,15.3,60.0,60.2]') return node")
+      existing_node.should_not be_empty
+      existing_node["data"][0][0]["data"]["lat"].should == properties[:lat]
+      existing_node["data"][0][0]["data"]["lon"].should == properties[:lon]
+    end
+
+  end
+
+  describe "find geometries within distance" do
+    it "can find a geometry within distance" do
+      properties = {:name => "Max's Restaurant", :lat => 41.8819, :lon => 87.6278}
+      node = @neo.find_geometries_within_distance("restaurants", 87.627, 41.881, 10)
+      node.should_not be_empty
+      node.first["data"]["lat"].should == properties[:lat]
+      node.first["data"]["lon"].should == properties[:lon]
+      node.first["data"]["name"].should == "Max's Restaurant"
+    end
+
+    it "can find a geometry within distance using cypher" do
+      properties = {:lat => 60.1, :lon => 15.2}
+      @neo.create_spatial_index("geowdcypher", "point", "lat", "lon")
+      node = @neo.create_node(properties)
+      added = @neo.add_node_to_index("geowdcypher", "dummy", "dummy", node)
+      existing_node = @neo.execute_query("start n = node:geowdcypher({bbox}) return n", {:bbox => "withinDistance:[60.0,15.0,100.0]"})
+      existing_node.should_not be_empty
+      existing_node.should_not be_empty
+      existing_node["data"][0][0]["data"]["lat"].should == properties[:lat]
+      existing_node["data"][0][0]["data"]["lon"].should == properties[:lon]
+    end
+
+    it "can find a geometry within distance using cypher 2"  do
+      properties = {:lat => 60.1, :lon => 15.2}
+      @neo.create_spatial_index("geowdcypher2", "point", "lat", "lon")
+      node = @neo.create_node(properties)
+      added = @neo.add_node_to_spatial_index("geowdcypher2", node)
+      existing_node = @neo.execute_query("start n = node:geowdcypher2({bbox}) return n", {:bbox => "withinDistance:[60.0,15.0,100.0]"})
+      existing_node.should_not be_empty
+      existing_node.should_not be_empty
+      existing_node["data"][0][0]["data"]["lat"].should == properties[:lat]
+      existing_node["data"][0][0]["data"]["lon"].should == properties[:lon]
+    end
+
+  end
+  
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neography
 version: !ruby/object:Gem::Version
-  version: 1.3.6
+  version: 1.3.7
 platform: ruby
 authors:
 - Max De Marzi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-23 00:00:00.000000000 Z
+date: 2014-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -202,6 +202,7 @@ files:
 - lib/neography/rest/relationship_types.rb
 - lib/neography/rest/relationships.rb
 - lib/neography/rest/schema_indexes.rb
+- lib/neography/rest/spatial.rb
 - lib/neography/rest/transactions.rb
 - lib/neography/tasks.rb
 - lib/neography/version.rb
@@ -231,6 +232,7 @@ files:
 - spec/integration/rest_relationship_spec.rb
 - spec/integration/rest_relationship_types_spec.rb
 - spec/integration/rest_schema_index_spec.rb
+- spec/integration/rest_spatial_spec.rb
 - spec/integration/rest_transaction_spec.rb
 - spec/integration/rest_traverse_spec.rb
 - spec/matchers.rb
@@ -312,6 +314,7 @@ test_files:
 - spec/integration/rest_relationship_spec.rb
 - spec/integration/rest_relationship_types_spec.rb
 - spec/integration/rest_schema_index_spec.rb
+- spec/integration/rest_spatial_spec.rb
 - spec/integration/rest_transaction_spec.rb
 - spec/integration/rest_traverse_spec.rb
 - spec/matchers.rb