neo4jr-social 0.1.2 → 0.2.0

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', ">= 0.1.6" unless ENV['neo4jr_simple']
+    gem.add_dependency 'neo4jr-simple', "0.2.1" unless ENV['neo4jr_simple']
     gem.add_dependency 'sinatra'
     gem.add_dependency 'json_pure'
   end

data/TODO

@@ -1,5 +1,4 @@
 * Validate requests, check parameters, etc
-* Retrieve Node by identifier other then node id
 * Figure out how to handle the Neo4j nodes classname
 * More querying potential: Enable solr type parameters with lt gt eq etc or enable gremlin
 Examples

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/config/warble.rb

@@ -5,7 +5,7 @@ Warbler::Config.new do |config|
 
   config.gems['sinatra']       = '0.9.4'
   config.gems['json_pure']     = '1.2.0'
-  config.gems['neo4jr-simple'] = '0.1.7'
+  config.gems['neo4jr-simple'] = '0.2.1'
   
   config.gem_dependencies = true
   config.webxml.booter = :rack

data/lib/neo4jr-social/service.rb

@@ -1,5 +1,6 @@
 module Neo4jr
   class Service < Sinatra::Base
+    include Neo4jr::PathRater
     helpers ParamHelper
     register SelfDocumentor, FormatHandler
     
@@ -21,7 +22,7 @@ module Neo4jr
       nodes.to_json
     end
 
-    describe "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."
+    describe "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. The response will be the neo4j node id. Additionally you can add the identifier property which if exsists can be used as the node_id for other requests."
     post '/nodes' do
       node = Neo4jr::DB.execute do |neo|
         node = neo.create_node(params)
@@ -29,17 +30,17 @@ module Neo4jr
       node.to_hash.to_json
     end
 
-    describe "Returns the properties for the specified node, where :node_id is the numeric id for the node."
+    describe "Returns the properties for the specified node, where :node_id is the value of the identifier propery of the node or if no identifier is specified you can use the numeric neo4j id."
     get '/nodes/:node_id' do
       node = Neo4jr::DB.execute do |neo|
-        neo.getNodeById(param_node_id).to_hash.to_json
+        neo.find_node(param_node_id).to_hash.to_json
       end
     end
 
-    describe "Updates the properties of the specified node, where :node_id is the numeric id for the node. Any parameters pased in the body of the PUT will be treated as properties for the node. If you add a new parameters (i.e. age=4) which previously were not on the node, neo4jr-social will still add that property to the node."
+    describe "Updates the properties of the specified node, where :node_id is the value of the identifier propery of the node or if no identifier is specified you can use the numeric neo4j id. Any parameters pased in the body of the PUT will be treated as properties for the node. If you add a new parameters (i.e. age=4) which previously were not on the node, neo4jr-social will still add that property to the node."
     put '/nodes/:node_id' do
       node = Neo4jr::DB.execute do |neo|
-        node = neo.getNodeById(param_node_id)
+        node = neo.find_node(param_node_id)
         node.update_properties(params)
       end
       node.to_hash.to_json
@@ -48,19 +49,19 @@ module Neo4jr
     describe "Deletes the specified node, where :node_id is the numeric id for the node."
     delete '/nodes/:node_id' do
       Neo4jr::DB.execute do |neo|
-        node = neo.getNodeById(param_node_id)
+        node = neo.find_node(param_node_id)
         node.get_relationships.each { |r| r.delete }
         node.delete
       end
     end
 
-    describe "Creates a relations for the specified node, where :node_id is the numeric id for the node. This is how you designate how two nodes are related to each other."
+    describe "Creates a relations for the specified node, where :node_id is the value of the identifier propery of the node or if no identifier is specified you can use the numeric neo4j id. This is how you designate how two nodes are related to each other."
     required_param :to,   'This is the node id of the node you want to make a relationship to. This is a one-way relationship. If you want both nodes to be.'
     required_param :type, "this is the type of the relationship, i.e. 'friends'. This can be any string that is sensible in your domain."
     optional_param "Any other parameters you supply in the body of the POST will be added as properties to the relationship. For example if you were making 'friend' relationships and wanted to add a date since the friendship started you could pass a 'since' parameter in the POST."
     get '/nodes/:node_id/relationships' do
       relationships = Neo4jr::DB.execute do |neo|
-        node = neo.getNodeById(param_node_id)
+        node = neo.find_node(param_node_id)
         if param_relationship_type
           relationship_type = RelationshipType.instance(param_relationship_type)
           node.getRelationships(param_relationship_type.to_a).hashify_objects
@@ -71,12 +72,12 @@ module Neo4jr
       relationships.to_json
     end
 
-    describe "Returns relationships to other nodes for the specified node, where :node_id is the numeric id for the node."
+    describe "Returns relationships to other nodes for the specified node, where :node_id is the value of the identifier propery of the node or if no identifier is specified you can use the numeric neo4j id."
     optional_param :type, "Specify a type if only certain relationships are of interest"
     post '/nodes/:node_id/relationships' do
       relationships = Neo4jr::DB.execute do |neo|
-        node = neo.getNodeById(param_node_id)
-        to_node = neo.getNodeById(param_to_node_id)
+        node = neo.find_node(param_node_id)
+        to_node = neo.find_node(param_to_node_id)
         relationship_type = RelationshipType.instance(param_relationship_type)
         relationship = node.create_relationship_to to_node, relationship_type
         relationship.update_properties(params)
@@ -92,8 +93,8 @@ module Neo4jr
     optional_param :direction, "hat direction of relationships to follow, the default is 'both'"
     get '/nodes/:node_id/paths' do
       paths = Neo4jr::DB.execute do |neo|
-        start_node = neo.getNodeById(param_node_id)
-        end_node = neo.getNodeById(param_to_node_id)
+        start_node = neo.find_node(param_node_id)
+        end_node = neo.find_node(param_to_node_id)
         shortest_path = AllSimplePaths.new(start_node, end_node, param_depth, param_direction, relationship_types)
         to_hash shortest_path.getPaths
       end
@@ -107,14 +108,14 @@ module Neo4jr
       path = Neo4jr::DB.execute do |neo|
         dijkstra = Dijkstra.new(
           0.0,
-          neo.getNodeById(param_node_id),
-          neo.getNodeById(param_to_node_id),
+          neo.find_node(param_node_id),
+          neo.find_node(param_to_node_id),
           Neo4jr::SimpleEvaluator.new,
           DoubleAdder.new,
           DoubleComparator.new,
           direction,
           relationship_types)
-        (p=dijkstra.getPath) and p.map{|n| n.to_hash }
+        (p=dijkstra.getPath) and {:path => p.map{|n| n.to_hash }, :cost => dijkstra.getCost}
       end
       path.to_json
     end
@@ -125,7 +126,7 @@ module Neo4jr
     get '/nodes/:node_id/recommendations' do
       suggestions = Neo4jr::DB.execute do |neo|
         relationship = Neo4jr::RelationshipType.incoming(param_relationship_type)
-        start_node = neo.getNodeById(param_node_id)
+        start_node = neo.find_node(param_node_id)
         order = Order::BREADTH_FIRST
         return_when = Return.when do |current_position|
           current_position.depth > param_level
@@ -137,6 +138,15 @@ module Neo4jr
     end
 
     private
+
+    def to_rated_hash path, start_cost=0.0, cost_evaluator=Neo4jr::SimpleEvaluator.new, cost_accumulator=DoubleAdder.new
+        {:path => path.map{|n| n.to_hash}, :cost => get_cost(path, start_cost, cost_evaluator, cost_accumulator)}
+    end
+
+    def to_rated_hashes paths, start_cost=0.0, cost_evaluator=Neo4jr::SimpleEvaluator.new, cost_accumulator=DoubleAdder.new
+        paths and paths.map{|p| to_rated_hash p, start_cost, cost_evaluator, cost_accumulator}
+    end
+
     def to_hash paths
       paths and paths.map{|p| p.map{|n| n.to_hash }}
     end

data/neo4jr-social.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{neo4jr-social}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matthew Deiters"]
-  s.date = %q{2010-01-19}
+  s.date = %q{2010-01-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}
@@ -77,17 +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.2.1"])
       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.2.1"])
       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.2.1"])
     s.add_dependency(%q<sinatra>, [">= 0"])
     s.add_dependency(%q<json_pure>, [">= 0"])
   end

data/spec/service_spec.rb

@@ -97,7 +97,7 @@ describe Neo4jr::Service do
       @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 = response_to_ruby['path']
       path_to_cruise[0]['name'].should == 'Philip Seymour Hoffman'
       path_to_cruise[1]['type'].should == 'friends'
       path_to_cruise[2]['name'].should == 'Tina Fey'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: neo4jr-social
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
   - Matthew Deiters
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-19 00:00:00 -08:00
+date: 2010-01-26 00:00:00 -08:00
 default_executable: start-neo4jr-social
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -32,6 +32,16 @@ dependencies:
           - !ruby/object:Gem::Version 
             version: "0"
       version: 
+  - !ruby/object:Gem::Dependency 
+    name: neo4jr-simple
+    type: :runtime
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Requirement 
+      requirements: 
+        - - "="
+          - !ruby/object:Gem::Version 
+            version: 0.2.1
+      version: 
   - !ruby/object:Gem::Dependency 
     name: sinatra
     type: :runtime