neography 0.0.6 → 0.0.7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    neography (0.0.5)
+    neography (0.0.6)
       httparty (~> 0.6.1)
       json
 

data/README.rdoc

@@ -10,12 +10,23 @@ If you want to the full power of Neo4j, you will want to use JRuby and the excel
 
   gem install 'neography'
 
-After that, in your ruby script, do
+After that, in your ruby script:
 
   require 'rubygems'
   require 'neography'
 
 in order to access the functionality.
+
+=== Try it now!
+
+I am hosting an instance of Neo4j (1.2 M5) at neography.org for you to try out.
+
+You can see the administration at: {Neo4j Web Admin}[http://neography.org]
+
+  # Add this to your ruby file to use it
+  Neography::Config.server = 'neography.org'
+
+
 === Dependencies
 
   for use:
@@ -197,6 +208,17 @@ The Neo4j ID is available by using node.neo_id .
   n1.rels(:friends).incoming                                           # Get incoming friends relationships
   n1.rels(:friends,:work)                                              # Get friends and work relationships
   n1.rels(:friends,:work).outgoing                                     # Get outgoing friends and work relationships          
+  
+  n1.all_paths_to(n2).incoming(:friends).depth(4)                      # Gets all paths of a specified type
+  n1.all_simple_paths_to(n2).incoming(:friends).depth(4)               # for the relationships defined
+  n1.all_shortest_paths_to(n2).incoming(:friends).depth(4)             # at a maximum depth 
+  n1.path_to(n2).incoming(:friends).depth(4)                           # Same as above, but just one path.
+  n1.simple_path_to(n2).incoming(:friends).depth(4)                    
+  n1.shortest_path_to(n2).incoming(:friends).depth(4)
+
+  n1.shortest_path_to(n2).incoming(:friends).depth(4).rels             # Gets just relationships in path
+  n1.shortest_path_to(n2).incoming(:friends).depth(4).nodes            # Gets just nodes in path
+
 
 See Neo4j API for:
 * {Order}[http://components.neo4j.org/neo4j-examples/1.2.M04/apidocs/org/neo4j/graphdb/Traverser.Order.html]

data/examples/facebook.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'neography'
 
+Neography::Config.server = 'neography.org'
 @neo = Neography::Rest.new
 
 def create_person(name)

data/examples/facebook_v2.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'neography'
+
+Neography::Config.server = 'neography.org'
+@neo = Neography::Rest.new
+
+def suggestions_for(node)
+  node.incoming(:friends).order("breadth first").uniqueness("node global").filter("position.length() == 2;").depth(2)
+end
+
+johnathan = Neography::Node.create("name" =>'Johnathan')
+mark      = Neography::Node.create("name" =>'Mark')
+phill     = Neography::Node.create("name" =>'Phill')
+mary      = Neography::Node.create("name" =>'Mary')
+luke      = Neography::Node.create("name" =>'Luke')
+
+johnathan.both(:friends) << mark
+mark.both(:friends) << mary
+mark.both(:friends) << phill
+phill.both(:friends) << mary
+phill.both(:friends) << luke
+
+puts "Johnathan should become friends with #{suggestions_for(johnathan).map{|n| n.name }.join(', ')}"
+
+# RESULT
+# Johnathan should become friends with Mary, Phill

data/examples/linkedin.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'neography'
 
+Neography::Config.server = 'neography.org'
 @neo = Neography::Rest.new
 
 def create_person(name)

data/examples/linkedin_v2.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'neography'
+
+Neography::Config.server = 'neography.org'
+@neo = Neography::Rest.new
+
+johnathan = Neography::Node.create("name" =>'Johnathan')
+mark      = Neography::Node.create("name" =>'Mark')
+phill     = Neography::Node.create("name" =>'Phill')
+mary      = Neography::Node.create("name" =>'Mary')
+
+johnathan.both(:friends) << mark
+mark.both(:friends) << phill
+phill.both(:friends) << mary
+mark.both(:friends) << mary
+
+johnathan.all_simple_paths_to(mary).incoming(:friends).depth(4).nodes.each do |node|
+  puts node.map{|n| n.name }.join(' => friends => ')
+end
+
+# RESULT
+# Johnathan => friends => Mark => friends => Phill => friends => Mary
+# Johnathan => friends => Mark => friends => Mary

data/lib/neography.rb

@@ -29,11 +29,12 @@ require 'neography/neography'
 require 'neography/property_container'
 require 'neography/property'
 require 'neography/node_relationship'
+require 'neography/node_path'
 require 'neography/relationship_traverser'
 require 'neography/node_traverser'
+require 'neography/path_traverser'
 require 'neography/equal'
 
-
 require 'neography/node'
 require 'neography/relationship'
 

data/lib/neography/node.rb

@@ -1,6 +1,7 @@
 module Neography
   class Node < PropertyContainer
     include Neography::NodeRelationship
+    include Neography::NodePath
     include Neography::Equal
     include Neography::Property
 

data/lib/neography/node_path.rb

@@ -0,0 +1,29 @@
+module Neography
+  module NodePath
+
+    def all_paths_to(to)
+      PathTraverser.new(self, to, "allPaths", true)
+    end
+
+    def all_simple_paths_to(to)
+      PathTraverser.new(self, to, "allSimplePaths", true)
+    end
+
+    def all_shortest_paths_to(to)
+      PathTraverser.new(self, to, "shortestPath", true)
+    end
+
+    def path_to(to)
+      PathTraverser.new(self, to, "allPaths", false)
+    end
+
+    def simple_path_to(to)
+      PathTraverser.new(self, to, "allSimplePaths", false)
+    end
+
+    def shortest_path_to(to)
+      PathTraverser.new(self, to, "shortestPath", false)
+    end
+
+  end
+end

data/lib/neography/node_traverser.rb

@@ -48,6 +48,16 @@ module Neography
       self
     end
 
+    def uniqueness(u)
+      @uniqueness = u
+      self
+    end
+
+    def order(o)
+      @order = o
+      self
+    end
+
     def filter(body)
       @filter = Hash.new
       @filter["language"] = "javascript"

data/lib/neography/path_traverser.rb

@@ -0,0 +1,94 @@
+module Neography
+  class PathTraverser
+    include Enumerable
+
+    attr_accessor :depth, :algorithm, :relationships, :get
+
+    def initialize(from, to, algorithm, all=false, types = nil, dir = "all" )
+      @from  = from
+      @to = to
+      @algorithm = algorithm
+      @all = all
+      @relationships = Array.new
+      types.each do |type|
+        @relationships << {"type" => type.to_s, "direction" => dir.to_s }
+      end unless types.nil?
+      @get = ["node","rel"]
+      @loaded = Array.new
+    end
+
+    def nodes
+      @get = ["node"]
+      self
+    end
+
+    def relationships
+      @get = ["rel"]
+      self
+    end
+
+    alias_method :rels, :relationships
+
+    def both(type)
+      @relationships << {"type" => type.to_s, "direction" => "all"}
+      self
+    end
+
+    def outgoing(type)
+      @relationships << {"type" => type.to_s, "direction" => "out"}
+      self
+    end
+
+    def incoming(type)
+      @relationships << {"type" => type.to_s, "direction" => "in"}
+      self
+    end
+
+    def depth(d)
+      d = 2147483647 if d == :all
+      @depth = d
+      self
+    end
+
+    def size
+      [*self].size
+    end
+
+    alias_method :length, :size
+
+    def each
+      iterator.each do |path|
+        paths = Array.new
+
+        if @get.include?("node")
+          path["nodes"].each_with_index do |n, i|
+            @loaded[n.split('/').last.to_i] = Neography::Node.load(n) if @loaded.at(n.split('/').last.to_i).nil?
+            paths[i * 2] =  @loaded[n.split('/').last.to_i]
+          end
+        end
+
+        if @get.include?("rel") 
+          path["relationships"].each_with_index do |r, i|
+            @loaded[r.split('/').last.to_i] = Neography::Relationship.load(r) if @loaded.at(r.split('/').last.to_i).nil?
+            paths[i * 2 + 1] =  @loaded[r.split('/').last.to_i] 
+          end
+        end
+ 
+        yield paths.compact
+      end
+    end
+
+    def empty?
+      first == nil
+    end
+
+    def iterator
+      if @all.nil?
+        @from.neo_server.get_path(@from, @to, @relationships, @depth, @algorithm)
+      else
+        @from.neo_server.get_paths(@from, @to, @relationships, @depth, @algorithm)
+      end
+    end
+
+  end
+end

data/lib/neography/version.rb

@@ -1,3 +1,3 @@
 module Neography
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/integration/node_path_spec.rb

@@ -0,0 +1,222 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Neography::NodePath do
+
+  def create_nodes
+    johnathan = Neography::Node.create("name" =>'Johnathan')
+    mark      = Neography::Node.create("name" =>'Mark')
+    phill     = Neography::Node.create("name" =>'Phill')
+    mary      = Neography::Node.create("name" =>'Mary')
+
+    johnathan.both(:friends) << mark
+    mark.both(:friends) << mary
+    mark.both(:friends) << phill
+    phill.both(:friends) << mary
+
+    [johnathan, mark, phill, mary]
+  end
+
+  describe "all_paths" do
+    it "can return nodes" do
+      johnathan, mark, phill, mary = create_nodes
+
+      johnathan.all_paths_to(mary).incoming(:friends).depth(4).nodes.each do |path|
+         path.map{|n| n.is_a?(Neography::Node).should be_true}
+         path.map{|n| n.is_a?(Neography::Relationship).should be_false}
+      end
+    end
+
+    it "can return relationships" do
+      johnathan, mark, phill, mary = create_nodes
+
+      johnathan.all_paths_to(mary).incoming(:friends).depth(4).rels.each do |path|
+         path.map{|n| n.is_a?(Neography::Node).should be_false}
+         path.map{|n| n.is_a?(Neography::Relationship).should be_true}
+      end
+    end
+
+    it "can return both" do
+      johnathan, mark, phill, mary = create_nodes
+
+      johnathan.all_paths_to(mary).incoming(:friends).depth(4).each do |path|
+        path.each_with_index do  |n,i| 
+          if i.even?
+            n.is_a?(Neography::Node).should be_true
+          else
+            n.is_a?(Neography::Relationship).should be_true 
+          end
+        end
+      end
+    end
+  end
+
+  describe "all_simple_paths" do
+    it "can return nodes" do
+      johnathan, mark, phill, mary = create_nodes
+
+      johnathan.all_simple_paths_to(mary).incoming(:friends).depth(4).nodes.each do |path|
+         path.map{|n| n.is_a?(Neography::Node).should be_true}
+         path.map{|n| n.is_a?(Neography::Relationship).should be_false}
+      end
+    end
+
+    it "can return relationships" do
+      johnathan, mark, phill, mary = create_nodes
+
+      johnathan.all_simple_paths_to(mary).incoming(:friends).depth(4).rels.each do |path|
+         path.map{|n| n.is_a?(Neography::Node).should be_false}
+         path.map{|n| n.is_a?(Neography::Relationship).should be_true}
+      end
+    end
+
+    it "can return both" do
+      johnathan, mark, phill, mary = create_nodes
+
+      johnathan.all_simple_paths_to(mary).incoming(:friends).depth(4).each do |path|
+        path.each_with_index do  |n,i| 
+          if i.even?
+            n.is_a?(Neography::Node).should be_true
+          else
+            n.is_a?(Neography::Relationship).should be_true 
+          end
+        end
+      end
+    end
+  end
+
+  describe "all_shortest_paths_to" do
+    it "can return nodes" do
+      johnathan, mark, phill, mary = create_nodes
+
+      johnathan.all_shortest_paths_to(mary).incoming(:friends).depth(4).nodes.each do |path|
+         path.map{|n| n.is_a?(Neography::Node).should be_true}
+         path.map{|n| n.is_a?(Neography::Relationship).should be_false}
+      end
+    end
+
+    it "can return relationships" do
+      johnathan, mark, phill, mary = create_nodes
+
+      johnathan.all_shortest_paths_to(mary).incoming(:friends).depth(4).rels.each do |path|
+         path.map{|n| n.is_a?(Neography::Node).should be_false}
+         path.map{|n| n.is_a?(Neography::Relationship).should be_true}
+      end
+    end
+
+    it "can return both" do
+      johnathan, mark, phill, mary = create_nodes
+
+      johnathan.all_shortest_paths_to(mary).incoming(:friends).depth(4).each do |path|
+        path.each_with_index do  |n,i| 
+          if i.even?
+            n.is_a?(Neography::Node).should be_true
+          else
+            n.is_a?(Neography::Relationship).should be_true 
+          end
+        end
+      end
+    end
+  end
+
+  describe "path_to" do
+    it "can return nodes" do
+      johnathan, mark, phill, mary = create_nodes
+
+      johnathan.path_to(mary).incoming(:friends).depth(4).nodes.each do |path|
+         path.map{|n| n.is_a?(Neography::Node).should be_true}
+         path.map{|n| n.is_a?(Neography::Relationship).should be_false}
+      end
+    end
+
+    it "can return relationships" do
+      johnathan, mark, phill, mary = create_nodes
+
+      johnathan.path_to(mary).incoming(:friends).depth(4).rels.each do |path|
+         path.map{|n| n.is_a?(Neography::Node).should be_false}
+         path.map{|n| n.is_a?(Neography::Relationship).should be_true}
+      end
+    end
+
+    it "can return both" do
+      johnathan, mark, phill, mary = create_nodes
+
+      johnathan.path_to(mary).incoming(:friends).depth(4).each do |path|
+        path.each_with_index do  |n,i| 
+          if i.even?
+            n.is_a?(Neography::Node).should be_true
+          else
+            n.is_a?(Neography::Relationship).should be_true 
+          end
+        end
+      end
+    end
+  end
+
+  describe "simple_path_to" do
+    it "can return nodes" do
+      johnathan, mark, phill, mary = create_nodes
+
+      johnathan.simple_path_to(mary).incoming(:friends).depth(4).nodes.each do |path|
+         path.map{|n| n.is_a?(Neography::Node).should be_true}
+         path.map{|n| n.is_a?(Neography::Relationship).should be_false}
+      end
+    end
+
+    it "can return relationships" do
+      johnathan, mark, phill, mary = create_nodes
+
+      johnathan.simple_path_to(mary).incoming(:friends).depth(4).rels.each do |path|
+         path.map{|n| n.is_a?(Neography::Node).should be_false}
+         path.map{|n| n.is_a?(Neography::Relationship).should be_true}
+      end
+    end
+
+    it "can return both" do
+      johnathan, mark, phill, mary = create_nodes
+
+      johnathan.simple_path_to(mary).incoming(:friends).depth(4).each do |path|
+        path.each_with_index do  |n,i| 
+          if i.even?
+            n.is_a?(Neography::Node).should be_true
+          else
+            n.is_a?(Neography::Relationship).should be_true 
+          end
+        end
+      end
+    end
+  end
+
+  describe "shortest_path_to" do
+    it "can return nodes" do
+      johnathan, mark, phill, mary = create_nodes
+
+      johnathan.shortest_path_to(mary).incoming(:friends).depth(4).nodes.each do |path|
+         path.map{|n| n.is_a?(Neography::Node).should be_true}
+         path.map{|n| n.is_a?(Neography::Relationship).should be_false}
+      end
+    end
+
+    it "can return relationships" do
+      johnathan, mark, phill, mary = create_nodes
+
+      johnathan.shortest_path_to(mary).incoming(:friends).depth(4).rels.each do |path|
+         path.map{|n| n.is_a?(Neography::Node).should be_false}
+         path.map{|n| n.is_a?(Neography::Relationship).should be_true}
+      end
+    end
+
+    it "can return both" do
+      johnathan, mark, phill, mary = create_nodes
+
+      johnathan.shortest_path_to(mary).incoming(:friends).depth(4).each do |path|
+        path.each_with_index do  |n,i| 
+          if i.even?
+            n.is_a?(Neography::Node).should be_true
+          else
+            n.is_a?(Neography::Relationship).should be_true 
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Max De Marzi
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-10 00:00:00 -08:00
+date: 2010-12-11 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -109,15 +109,19 @@ files:
 - README.rdoc
 - Rakefile
 - examples/facebook.rb
+- examples/facebook_v2.rb
 - examples/linkedin.rb
+- examples/linkedin_v2.rb
 - examples/traversal_example1.rb
 - lib/neography.rb
 - lib/neography/config.rb
 - lib/neography/equal.rb
 - lib/neography/neography.rb
 - lib/neography/node.rb
+- lib/neography/node_path.rb
 - lib/neography/node_relationship.rb
 - lib/neography/node_traverser.rb
+- lib/neography/path_traverser.rb
 - lib/neography/property.rb
 - lib/neography/property_container.rb
 - lib/neography/relationship.rb
@@ -126,6 +130,7 @@ files:
 - lib/neography/version.rb
 - neography.gemspec
 - spec/integration/neography_spec.rb
+- spec/integration/node_path_spec.rb
 - spec/integration/node_relationship_spec.rb
 - spec/integration/node_spec.rb
 - spec/integration/relationship_spec.rb