neo4jr-social 0.1.0 → 0.1.1

data/README.rdoc

@@ -2,7 +2,7 @@
 
 Neo4jr-Social is a self contained HTTP REST + JSON interface to the graph database Neo4j. Neo4jr-Social supports simple dynamic node creation, building relationships between nodes and also includes a few common social networking queries out of the box (i.e. linkedin degrees of seperation and facebook friend suggestion) with more to come. Think of Neo4jr-Social is to Neo4j like Solr is to Lucene.
 
-Neo4jr-Social was built in JRuby but is language agnostic and is designed to run under Jetty or Tomcat. 
+Neo4jr-Social was built in JRuby but is language agnostic and is designed to run under Jetty or Tomcat.
 
 = Getting Started
 
@@ -11,13 +11,13 @@ Neo4jr-Social was built in JRuby but is language agnostic and is designed to run
 * JRuby: http://jruby.org
 
 === Installing
-* Install Ruby Gem: json_pure
+Install Ruby Gem: json_pure
   jgem install json_pure
-* Install Ruby Gem: sinatra
+Install Ruby Gem: sinatra
   jgem install sinatra
-* Install Ruby Gem: neo4jr-simple
+Install Ruby Gem: neo4jr-simple
   jgem install neo4jr-simple
-* Install Ruby Gem: neo4jr-social
+Install Ruby Gem: neo4jr-social
   jgem install neo4jr-simple
 
 === Starting Neo4jr-Social
@@ -36,13 +36,13 @@ Run start-neo4jr-social --help to see all options
 All results returned will be in JSON
   
 ==== GET /info
-Returns details about the Neo4jr database like the location of the database and the number of nodes.
+Returns details about the Neo4j database like the location of the database and the number of nodes.
   
 ==== GET /nodes
 Returns all nodes in the database. Use this method with caution, this could crash your server if you have a database with more then a few thousand nodes.
   
 ==== POST /nodes
-Creates a new node in the neo4jr database. Any parameters based in the body of the POST will be treated as properties for the node and will be stored in the database.
+Creates a new node in the neo4j database. Any parameters based in the body of the POST will be treated as properties for the node and will be stored in the database.
   
 ==== GET /nodes/:node_id
 Returns the properties for the specified node, where :node_id is the numeric id for the node
@@ -63,18 +63,29 @@ Creates a relations for the specified node, where :node_id is the numeric id for
 Returns relationships to other nodes for the specified node, where :node_id is the numeric id for the node.
   * Optional: type - Specify a type if only certain relationships are of interest
   
-==== GET /nodes/:node_id/path
+==== GET /nodes/:node_id/paths
 This returns all the ways two nodes are connected to each other and is similar to LinkedIn's degrees of separation. 
   * Required: to - the id of the node that your trying to find a path to from the starting node, :node_id
   * Required: type - the type of relationships between nodes to follow
   * Optional: depth - maximum degrees of separation to find, the default is 2 degrees. Note: There may be performance impacts if this number is to high.
   * Optional: direction - What direction of relationships to follow, the default is 'both'
+
+==== GET /nodes/:node_id/shortest_path
+This returns the shortest path of two nodes that are connected to each other
+  * Required: to - the id of the node that your trying to find a path to from the starting node, :node_id
+  * Required: type - the type of relationships between nodes to follow
   
 ==== GET /nodes/:node_id/recommendations
 This returns node suggestions for the given :node_id. This is similar to facebook friend suggestions where your friend's friends that your not friends with are suggested to you. 
   * Required: type - the type of relationships between nodes to follow
   * Optional: level - the degree of separation that you want recommendations for, the default is 1 degree away which is similar to facebook's behavior
 
+
+== Troubleshooting
+  
+  /usr/bin/env: jruby: No such file or directory
+  
+  You need to either install jruby or if you used a utility like rvm then your jruby executable may actually be called jruby-1.4, if this is the case create an alias somewhere in your PATH
 == Contributors
 
 ====Matthew Deiters

data/Rakefile

@@ -15,7 +15,7 @@ begin
     gem.authors = ["Matthew Deiters"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_development_dependency "rest-client"
-    gem.add_dependency 'neo4jr-simple'
+    gem.add_dependency 'neo4jr-simple', ">= 0.1.6" unless ENV['dev_on_gem']
     gem.add_dependency 'sinatra'
     gem.add_dependency 'json_pure'
     

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/bin/start-neo4jr-social

@@ -1,4 +1,4 @@
-#!/usr/bin/env jruby-1.4.0
+#!/usr/bin/env jruby
 
 using_gems = false
 begin

data/examples/linkedin.rb

@@ -15,7 +15,7 @@ def make_mutual_friends(node1, node2)
 end
 
 def degrees_of_seperation(start_node, destination_node)
-  url = "http://localhost:8988/neo4jr-social/nodes/#{start_node['node_id']}/path?to=#{destination_node['node_id']}&type=friends&depth=3&direction=outgoing"
+  url = "http://localhost:8988/neo4jr-social/nodes/#{start_node['node_id']}/paths?to=#{destination_node['node_id']}&type=friends&depth=3&direction=outgoing"
   response = RestClient.get(url)
   JSON.parse(response)
 end

data/lib/neo4jr-social/service.rb

@@ -63,12 +63,11 @@ module Neo4jr
       relationships.to_json
     end
 
-    #optional direction & depth
-    get '/nodes/:node_id/path' do
+    get '/nodes/:node_id/paths' do
       paths = Neo4jr::DB.execute do |neo|
-        relationship  = Neo4jr::RelationshipType.instance(params.delete('type'))
         start_node    = neo.getNodeById(params.delete('node_id'))
         end_node      = neo.getNodeById(params.delete('to'))
+        relationship  = Neo4jr::RelationshipType.instance(params.delete('type'))
         depth         = params.delete('depth') || 2
         direction     = Neo4jr::Direction.from_string(params.delete('direction') || 'both')
         shortest_path = AllSimplePaths.new(start_node, end_node, depth.to_i, direction, relationship.to_a)
@@ -78,7 +77,25 @@ module Neo4jr
       paths.to_json
     end
     
-    #optional
+    get '/nodes/:node_id/shortest_path' do
+      path = Neo4jr::DB.execute do |neo|
+        start_node    = neo.getNodeById(params.delete('node_id'))
+        end_node      = neo.getNodeById(params.delete('to'))
+        relationship  = Neo4jr::RelationshipType.instance(params.delete('type'))
+        dijkstra = Neo4jr::Dijkstra.new(
+          0.0,
+          start_node,
+          end_node,
+          Neo4jr::SimpleEvaluator.new,
+          DoubleAdder.new,
+          DoubleComparator.new,
+          Direction::BOTH,
+          relationship.to_a)
+        dijkstra.getPath.map{|n| n.to_hash }
+      end
+      path.to_json
+    end
+    
     get '/nodes/:node_id/recommendations' do
       suggestions = Neo4jr::DB.execute do |neo|
         relationship = Neo4jr::RelationshipType.incoming(params.delete('type'))

data/lib/neo4jr-social/simple_cost_evaluator.rb

@@ -0,0 +1,9 @@
+module Neo4jr
+  class SimpleEvaluator
+    include org.neo4j.graphalgo.shortestpath.CostEvaluator
+
+    def getCost(relationship, backwards)
+      1.0
+    end
+  end
+end

data/lib/neo4jr-social.rb

@@ -4,11 +4,12 @@ include Java
 
 require 'rubygems'
 gem 'sinatra'
-gem 'json_pure'
-gem 'neo4jr-simple'
+gem 'json_pure'  
+gem 'neo4jr-simple' unless ENV['dev_on_gem']
 
 require 'sinatra'
 require 'json'
 require 'neo4jr-simple'
+require 'neo4jr-social/simple_cost_evaluator'
 require 'neo4jr-social/service'
 

data/neo4jr-social.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{neo4jr-social}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matthew Deiters"]
-  s.date = %q{2009-12-23}
+  s.date = %q{2009-12-26}
   s.default_executable = %q{start-neo4jr-social}
   s.description = %q{A self-containted lightweight REST interface to Neo4j using JRuby }
   s.email = %q{matthew_deiters@mckinsey.com}
@@ -44,6 +44,7 @@ Gem::Specification.new do |s|
      "jetty-runtime/webapps/neo4jr-social.war",
      "lib/neo4jr-social.rb",
      "lib/neo4jr-social/service.rb",
+     "lib/neo4jr-social/simple_cost_evaluator.rb",
      "lib/neo4jr-social/version.rb",
      "neo4jr-social.gemspec",
      "spec/service_spec.rb",
@@ -76,20 +77,20 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_development_dependency(%q<rest-client>, [">= 0"])
-      s.add_runtime_dependency(%q<neo4jr-simple>, [">= 0"])
+      s.add_runtime_dependency(%q<neo4jr-simple>, [">= 0.1.6"])
       s.add_runtime_dependency(%q<sinatra>, [">= 0"])
       s.add_runtime_dependency(%q<json_pure>, [">= 0"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<rest-client>, [">= 0"])
-      s.add_dependency(%q<neo4jr-simple>, [">= 0"])
+      s.add_dependency(%q<neo4jr-simple>, [">= 0.1.6"])
       s.add_dependency(%q<sinatra>, [">= 0"])
       s.add_dependency(%q<json_pure>, [">= 0"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
     s.add_dependency(%q<rest-client>, [">= 0"])
-    s.add_dependency(%q<neo4jr-simple>, [">= 0"])
+    s.add_dependency(%q<neo4jr-simple>, [">= 0.1.6"])
     s.add_dependency(%q<sinatra>, [">= 0"])
     s.add_dependency(%q<json_pure>, [">= 0"])
   end

data/spec/service_spec.rb

@@ -52,61 +52,76 @@ describe Neo4jr::Service do
     relationship['type'].should == 'acted_in'
     relationship['to'].should == movie['node_id']
   end
-  
-  describe 'degrees of seperation using shortest path' do
-    let(:actor1) { post('/nodes', {:name => 'Philip Seymour Hoffman'}) && response_to_ruby }
-    let(:actor2) { post('/nodes', {:name => 'Tina Fey'}) && response_to_ruby}
-    let(:movie)  { post('/nodes', {:title => 'The Invention of Lying'}) && response_to_ruby}
     
-    it 'determines degrees of seperation between nodes like LinkedIn' do
-      post "/nodes/#{actor1['node_id']}/relationships", { :to => movie['node_id'], :type => 'acted_in', :year => 2009 }
-      post "/nodes/#{actor2['node_id']}/relationships", { :to => movie['node_id'], :type => 'acted_in', :year => 2009 }
-
-      get "/nodes/#{actor1['node_id']}/path", { :to => actor2['node_id'], :type => 'acted_in'} 
-      last_response.status.should == 200
-      paths = response_to_ruby
-      first_path = paths.first
-      first_path[0]['name'].should == 'Philip Seymour Hoffman'
-      first_path[2]['title'].should == 'The Invention of Lying'
-      first_path[4]['name'].should == 'Tina Fey'
-    end
-    
-  end
-  
-  describe 'suggestions' do
+  describe 'querying paths' do
     let(:hoffman) { post('/nodes', {:name => 'Philip Seymour Hoffman'}) && response_to_ruby }
     let(:fey)     { post( '/nodes', {:name => 'Tina Fey'}) && response_to_ruby}
     let(:hanks)   { post( '/nodes', {:name => 'Tom Hanks'}) && response_to_ruby}
     let(:murphy)  { post( '/nodes', {:name => 'Brittney Murphy'}) && response_to_ruby}
     let(:bale)    { post( '/nodes', {:name => 'Christian Bale'}) && response_to_ruby}
+    let(:cruise)  { post( '/nodes', {:name => 'Tom Cruise'}) && response_to_ruby}
     
     before :each do
-      create_mutual_friends = Proc.new do |node1, node2|
+      @create_mutual_friends = Proc.new do |node1, node2|
         post "/nodes/#{node1['node_id']}/relationships", { :to => node2['node_id'], :type => 'friends' }
         post "/nodes/#{node2['node_id']}/relationships", { :to => node1['node_id'], :type => 'friends' }
       end
       
-      create_mutual_friends.call(hoffman, fey)
-      create_mutual_friends.call(hoffman, murphy)
-      create_mutual_friends.call(murphy, fey)
-      create_mutual_friends.call(murphy, hanks)
-      create_mutual_friends.call(hanks, bale)
+      @create_mutual_friends.call(hoffman, fey)
+      @create_mutual_friends.call(hoffman, murphy)
+      @create_mutual_friends.call(murphy, fey)
+      @create_mutual_friends.call(murphy, hanks)
+      @create_mutual_friends.call(hanks, bale)
     end
     
-    it "gets my friend's friends that I'm not friends with as suggestions" do
-      get "/nodes/#{hoffman['node_id']}/recommendations?type=friends"
-      last_response.status.should == 200
-      suggestions = response_to_ruby
-      suggestions.size.should == 1
-      suggestions.first['name'].should == 'Tom Hanks'
+    describe 'suggestions' do
+      it "gets my friend's friends that I'm not friends with as suggestions" do
+        get "/nodes/#{hoffman['node_id']}/recommendations?type=friends"
+        last_response.status.should == 200
+        suggestions = response_to_ruby
+        suggestions.size.should == 1
+        suggestions.first['name'].should == 'Tom Hanks'
+      end
+
+      it "gets my friend's friend's friends that I'm not friends with as suggestions" do
+        get "/nodes/#{hoffman['node_id']}/recommendations?type=friends&level=2"
+        last_response.status.should == 200
+        suggestions = response_to_ruby
+        suggestions.size.should == 1
+        suggestions.first['name'].should == 'Christian Bale'
+      end    
     end
+    
+    it 'retrieves only shortest path between nodes' do
+      @create_mutual_friends.call(fey, cruise)
+      @create_mutual_friends.call(hanks, cruise)
+      
+      get "/nodes/#{hoffman['node_id']}/shortest_path?type=friends&to=#{cruise['node_id']}"
+      path_to_cruise = response_to_ruby
+      path_to_cruise[0]['name'].should == 'Philip Seymour Hoffman'
+      path_to_cruise[1]['type'].should == 'friends'
+      path_to_cruise[2]['name'].should == 'Tina Fey'
+      path_to_cruise[3]['type'].should == 'friends'
+      path_to_cruise[4]['name'].should == 'Tom Cruise'
+    end    
+  end
+  
+  describe 'getting paths between nodes' do
+    let(:actor1) { post('/nodes', {:name => 'Philip Seymour Hoffman'}) && response_to_ruby }
+    let(:actor2) { post('/nodes', {:name => 'Tina Fey'}) && response_to_ruby}
+    let(:movie)  { post('/nodes', {:title => 'The Invention of Lying'}) && response_to_ruby}
+    
+    it 'determines all degrees of seperation between nodes like LinkedIn' do
+      post "/nodes/#{actor1['node_id']}/relationships", { :to => movie['node_id'], :type => 'acted_in', :year => 2009 }
+      post "/nodes/#{actor2['node_id']}/relationships", { :to => movie['node_id'], :type => 'acted_in', :year => 2009 }
 
-    it "gets my friend's friend's friends that I'm not friends with as suggestions" do
-      get "/nodes/#{hoffman['node_id']}/recommendations?type=friends&level=2"
+      get "/nodes/#{actor1['node_id']}/paths", { :to => actor2['node_id'], :type => 'acted_in'} 
       last_response.status.should == 200
-      suggestions = response_to_ruby
-      suggestions.size.should == 1
-      suggestions.first['name'].should == 'Christian Bale'
-    end    
+      paths = response_to_ruby
+      first_path = paths.first
+      first_path[0]['name'].should == 'Philip Seymour Hoffman'
+      first_path[2]['title'].should == 'The Invention of Lying'
+      first_path[4]['name'].should == 'Tina Fey'
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,8 +1,8 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-# $LOAD_PATH.unshift(File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', 'neo4jr-simple', 'lib'))
-# require 'neo4jr-simple'
+$LOAD_PATH.unshift(File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', 'neo4jr-simple', 'lib'))
+require 'neo4jr-simple'
 
 require 'neo4jr-social'
 require 'spec'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: neo4jr-social
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
   - Matthew Deiters
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-23 00:00:00 -08:00
+date: 2009-12-26 00:00:00 -08:00
 default_executable: start-neo4jr-social
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -40,7 +40,7 @@ dependencies:
       requirements: 
         - - ">="
           - !ruby/object:Gem::Version 
-            version: "0"
+            version: 0.1.6
       version: 
   - !ruby/object:Gem::Dependency 
     name: sinatra
@@ -97,6 +97,7 @@ files:
   - jetty-runtime/webapps/neo4jr-social.war
   - lib/neo4jr-social.rb
   - lib/neo4jr-social/service.rb
+  - lib/neo4jr-social/simple_cost_evaluator.rb
   - lib/neo4jr-social/version.rb
   - neo4jr-social.gemspec
   - spec/service_spec.rb