neo4jr-social 0.1.1 → 0.1.2

data/.gitignore

@@ -17,5 +17,7 @@ tmtags
 coverage
 rdoc
 pkg
+tmp
 
 ## PROJECT::SPECIFIC
+.idea

data/README.rdoc

@@ -2,90 +2,31 @@
 
 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 as a self-contained service or can be deployed under Jetty or Tomcat.
 
 = Getting Started
 
-=== Prerequisites
+== Prerequisites
+
 * Java
 * JRuby: http://jruby.org
 
-=== Installing
-Install Ruby Gem: json_pure
-  jgem install json_pure
-Install Ruby Gem: sinatra
-  jgem install sinatra
-Install Ruby Gem: neo4jr-simple
-  jgem install neo4jr-simple
-Install Ruby Gem: neo4jr-social
-  jgem install neo4jr-simple
-
-=== Starting Neo4jr-Social
+== Running Neo4jr-Social
 
-After installing the above gems, an executable 'start-neo4jr-social' should be in your path. This will start the service and the database and listen for HTTP requests on localhost at port 8988:
+After installing the above gems, an executable 'start-neo4jr-social' should be in your $PATH. This will start the service and the database and listen for HTTP requests on localhost at port 8988 by default:
 
   start-neo4jr-social -p8988
 
 You can also start the service and specify the directory of where the neo4j database is stored or where to create a new database. If you omit this setting a database will be created in your tmp directory and destroyed when you shutdown the server.
 
   start-neo4jr-social -p8988 -dsome_relative_or_absolute_directory
-  
+
 Run start-neo4jr-social --help to see all options
 
-=== API Overview
-All results returned will be in JSON
-  
-==== GET /info
-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 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
-  
-==== PUT /nodes/:node_id  
-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.
-  
-==== DELETE /nodes/:node_id
-Deletes the specified node, where :node_id is the numeric id for the node.
-  
-==== POST /nodes/:node_id/relationships
-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.
-  * Required: 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 related to each other you will need to make individual POSTs for each direction of the relationship.
-  * Required: type - this is the type of the relationship, i.e. 'friends'. This can be any string that is sensible in your domain. 
-  * Optional: 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
-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/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
+=== API
+
+  The service is documented at http://wiki.github.com/mdeiters/neo4jr-social/
+
 == Contributors
 
 ====Matthew Deiters

data/Rakefile

@@ -15,11 +15,9 @@ 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['dev_on_gem']
+    gem.add_dependency 'neo4jr-simple', ">= 0.1.6" unless ENV['neo4jr_simple']
     gem.add_dependency 'sinatra'
     gem.add_dependency 'json_pure'
-    
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/TODO

@@ -1,9 +1,9 @@
-* Figure out a better way to shebang for start-neo4jr-social
 * Validate requests, check parameters, etc
-* Figure out how we should handle the Neo4j node's classname
+* 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
 * Query Type: Amazon Recommendations
 * Query Type: Most Popular
 * Query Type: Primitive dynamic querying on all nodes
-* Enable solr type parameters with lt gt eq etc
-* Explore vendor-ize all ruby libs into WEB-INF
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/config/warble.rb

@@ -0,0 +1,18 @@
+# Warbler web application assembly configuration file
+Warbler::Config.new do |config|
+  config.dirs = %w(lib)
+  config.includes = FileList["config.ru"]
+
+  config.gems['sinatra']       = '0.9.4'
+  config.gems['json_pure']     = '1.2.0'
+  config.gems['neo4jr-simple'] = '0.1.7'
+  
+  config.gem_dependencies = true
+  config.webxml.booter = :rack
+
+  # Control the pool of runtimes. Leaving unspecified means
+  # the pool will grow as needed to service requests. It is recommended
+  # that you fix these values when running a production server!
+  # config.webxml.jruby.min.runtimes = 2
+  # config.webxml.jruby.max.runtimes = 4
+end

data/examples/facebook.rb

@@ -30,4 +30,6 @@ make_mutual_friends(phill, mary)
 make_mutual_friends(phill, luke)
 
 puts "Johnathan should become friends with #{suggestions_for(johnathan).map{|n| n['name']}.join(', ')}"
-#=> Johnathan should become friends with Mary, Phill
+
+# RESULT
+# Johnathan should become friends with Mary, Phill

data/examples/linkedin.rb

@@ -34,5 +34,6 @@ degrees_of_seperation(johnathan, mary).each do |path|
   puts path.map{|node| node['name'] || node['type']}.join(' => ') 
 end
 
+# RESULT
 # Johnathan => friends => Mark => friends => Phill => friends => Mary
 # Johnathan => friends => Mark => friends => Mary

data/lib/neo4jr-social/format_handler.rb

@@ -0,0 +1,50 @@
+module Neo4jr
+  module FormatHandler
+    def self.registered(app)
+      app.send :mime, :json, 'application/json'
+      app.set :assume_xhr_is_js, true
+      app.helpers self
+      app.before do
+        if request.env['HTTP_ACCEPT'] && request.env['HTTP_ACCEPT'].include?('text/html')
+          format :html
+        else
+          format :json
+        end
+        charset 'utf-8'
+      end      
+    end
+    
+    def render_for_format(data)
+      case format
+        when :json : return JsonPrinter.render(data)
+        when :html : return JsonPrinter.render_html(data)
+        else
+           fail("#{format} is not a supported MIME type")
+      end
+    end
+       
+    def format(val=nil)
+      unless val.nil?
+       mime_type = media_type(val)
+       fail "Unknown media type #{val}\nTry registering the extension with a mime type" if mime_type.nil?
+
+       @format = val.to_sym
+       response['Content-Type'].sub!(/^[^;]+/, mime_type)
+      end
+
+      @format
+    end
+
+    def charset(val=nil)
+      fail "Content-Type must be set in order to specify a charset" if response['Content-Type'].nil?
+
+      if response['Content-Type'] =~ /charset=[^;]+/
+        response['Content-Type'].sub!(/charset=[^;]+/, (val == '' && '') || "charset=#{val}")
+      else
+        response['Content-Type'] += ";charset=#{val}"
+      end unless val.nil?
+
+      response['Content-Type'][/charset=([^;]+)/, 1]
+    end
+  end
+end

data/lib/neo4jr-social/json_printer.rb

@@ -0,0 +1,154 @@
+# Please see http://github.com/techcrunch/json_printer
+# 
+class JsonPrinter
+  attr_reader :buf, :indent
+  
+  # ==== Arguments
+  # obj<Object>::
+  #   The object to be rendered into JSON.  This object and all of its 
+  #   associated objects must be either nil, true, false, a String, a Symbol,
+  #   a Numeric, an Array, or a Hash.
+  #
+  # ==== Returns
+  # <String>::
+  #   The pretty-printed JSON ecoding of the given <i>obj</i>.  This string
+  #   can be parsed by any compliant JSON parser without modification.
+  #
+  # ==== Examples
+  # See <tt>JsonPrinter</tt> docs.
+  #
+  def self.render(obj)
+    new(obj).buf
+  end
+  
+  def self.render_html(obj)
+    render(obj).gsub(' ', '&nbsp;').gsub("\n", "<br>")
+  end
+  
+  private
+  
+  # Execute the JSON rendering of <i>obj</i>, storing the result in the 
+  # <tt>buf</tt>.
+  #
+  def initialize(obj)
+    @buf = ""
+    @indent = ""
+    render(obj)
+  end
+  
+  # Increase the indentation level.
+  #
+  def indent_out
+    @indent << " "
+  end
+  
+  # Decrease the indendation level.
+  #
+  def indent_in
+    @indent.slice!(-1, 1)
+  end
+  
+  # Append the given <i>str</i> to the <tt>buf</tt>.
+  #
+  def print(str)
+    @buf << str
+  end
+  
+  
+  # Recursive rendering method.  Primitive values, like nil, true, false, 
+  # numbers, symbols, and strings are converted to JSON and appended to the
+  # buffer.  Enumerables are treated specially to generate pretty whitespace.
+  #
+  def render(obj)
+    # We can't use a case statement here becuase "when Hash" doesn't work for
+    # ActiveSupport::OrderedHash - respond_to?(:values) is a more reliable
+    # indicator of hash-like behavior.
+    if NilClass === obj
+      print("null")
+      
+    elsif TrueClass === obj
+      print("true")
+    
+    elsif FalseClass === obj
+      print("false")
+    
+    elsif String === obj
+      print(escape_json_string(obj))
+      
+    elsif Symbol === obj
+      print("\"#{obj}\"")
+      
+    elsif Numeric === obj
+      print(obj.to_s)
+    
+    elsif Time === obj
+      print(obj.to_s)
+    
+    elsif obj.respond_to?(:keys)
+      print("{")
+      indent_out
+      last_key = obj.keys.last
+      obj.each do |(key, val)|
+        render(key)
+        case val
+        when Hash, Array
+          indent_out
+          print(":\n#{indent}")
+          render(val)
+          indent_in
+        else
+          print(": ")
+          render(val)
+        end
+        print(",\n#{indent}") unless key == last_key
+      end
+      indent_in
+      print("}")
+      
+    elsif Array === obj
+      print("[")
+      indent_out
+      last_index = obj.size - 1
+      obj.each_with_index do |elem, index|
+        render(elem)
+        print(",\n#{indent}") unless index == last_index
+      end
+      indent_in
+      print("]")
+      
+    else
+      raise "unrenderable object: #{obj.inspect}"
+    end
+  end
+  
+  # Special JSON character escape cases.
+  ESCAPED_CHARS = {
+    "\010" =>  '\b',
+    "\f"   =>  '\f',
+    "\n"   =>  '\n',
+    "\r"   =>  '\r',
+    "\t"   =>  '\t',
+    '"'    =>  '\"',
+    '\\'   =>  '\\\\',
+    '>'    =>  '\u003E',
+    '<'    =>  '\u003C',
+    '&'    =>  '\u0026'}
+  
+  # String#to_json extracted from ActiveSupport, using interpolation for speed.
+  #
+  def escape_json_string(str)
+    begin
+      "\"#{
+      str.gsub(/[\010\f\n\r\t"\\><&]/) { |s| ESCAPED_CHARS[s] }.
+          gsub(/([\xC0-\xDF][\x80-\xBF]|
+                 [\xE0-\xEF][\x80-\xBF]{2}|
+                 [\xF0-\xF7][\x80-\xBF]{3})+/nx) do |s|
+            s.unpack("U*").pack("n*").unpack("H*")[0].gsub(/.{4}/, '\\\\u\&')
+          end
+      }\""
+    rescue Encoding::CompatibilityError
+      rawbytes = str.dup.force_encoding 'ASCII-8BIT'
+      escape_json_string(rawbytes)
+    end
+  end
+end

data/lib/neo4jr-social/param_helper.rb

@@ -0,0 +1,32 @@
+module Neo4jr
+  module ParamHelper
+
+    def param_node_id
+      params.delete('node_id')
+    end
+    
+    def param_relationship_type
+      @param_relationship_type ||= params.delete('type')
+    end
+    
+    def param_to_node_id
+      params.delete('to')
+    end
+
+    def param_depth
+      (params.delete('depth') || 2).to_i
+    end
+    
+    def param_level 
+      @param_level ||= (params.delete('level') || 1).to_i
+    end
+
+    def param_direction
+      Neo4jr::Direction.from_string(params.delete('direction') || 'both')
+    end
+
+    def relationship_types
+      (param_relationship_type.nil? ? [] : [param_relationship_type].flatten.map {|name| DynamicRelationshipType.with_name(name)}).to_java(DynamicRelationshipType)
+    end
+  end
+end

data/lib/neo4jr-social/self_documentor.rb

@@ -0,0 +1,43 @@
+module Neo4jr
+  module SelfDocumentor
+    def describe(info)
+      SelfDocumentor.capture info
+    end
+    
+    def required_param(*args)
+      SelfDocumentor.required_param(*args)
+    end
+    
+    def optional_param(*args)
+      SelfDocumentor.optional_param(*args)
+    end
+        
+    def self.required_param(*args)
+      (@capture_required_param ||= []) << {args.first => args.last}
+    end
+    
+    def self.optional_param(*args)
+      args.unshift(:note) if args.size == 1
+      (@capture_optional_param ||= []) << {args.first => args.last}
+    end
+    
+    def self.capture(text)
+      @capture = text
+    end
+    
+    def self.route_added(verb, path, proc)
+      if [:get, :post, :put, :delete].include?(verb.downcase.to_sym)
+        document = {:path => path, :description => (@capture || '').to_s}
+        document[:required] = @capture_required_param if @capture_required_param
+        document[:optional] = @capture_optional_param if @capture_optional_param
+        (@@document ||= []) << document
+        @capture_optional_param = nil
+        @capture_required_param = nil
+      end
+    end
+    
+    def self.output
+      @@document
+    end
+  end
+end

data/lib/neo4jr-social/service.rb

@@ -1,114 +1,144 @@
 module Neo4jr
   class Service < Sinatra::Base
-            
+    helpers ParamHelper
+    register SelfDocumentor, FormatHandler
+    
+    describe "Lists all possible request types with descriptions"
+    get '/' do
+      render_for_format(SelfDocumentor.output)
+    end
+
+    describe "Returns details about the Neo4j database like the location of the database and the number of nodes."
     get '/info' do
       Neo4jr::DB.stats.to_json
     end
-    
+
+    describe "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."
     get '/nodes' do
       nodes = Neo4jr::DB.execute do |neo|
-        nodes = neo.all_nodes.map{|m| m.to_hash }        
+        nodes = neo.all_nodes.map{|m| m.to_hash }
       end
       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."
     post '/nodes' do
       node = Neo4jr::DB.execute do |neo|
         node = neo.create_node(params)
       end
       node.to_hash.to_json
     end
-    
+
+    describe "Returns the properties for the specified node, where :node_id is the numeric id for the node."
     get '/nodes/:node_id' do
-      Neo4jr::DB.getNodeById(params.delete('node_id')).to_json
+      node = Neo4jr::DB.execute do |neo|
+        neo.getNodeById(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."
     put '/nodes/:node_id' do
       node = Neo4jr::DB.execute do |neo|
-        node = neo.getNodeById(params.delete('node_id'))
+        node = neo.getNodeById(param_node_id)
         node.update_properties(params)
       end
       node.to_hash.to_json
     end
-    
+
+    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(params['node_id'])
+        node = neo.getNodeById(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."
+    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(params.delete('node_id'))
-        if relationship_type = params.delete('type')
-          relationship_type = RelationshipType.instance(relationship_type)
-          node.getRelationships(relationship_type.to_a).hashify_objects
+        node = neo.getNodeById(param_node_id)
+        if param_relationship_type
+          relationship_type = RelationshipType.instance(param_relationship_type)
+          node.getRelationships(param_relationship_type.to_a).hashify_objects
         else
           node.getRelationships.hashify_objects
         end
       end
       relationships.to_json
     end
-    
+
+    describe "Returns relationships to other nodes for the specified node, where :node_id is the numeric id for the node."
+    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(params.delete('node_id'))
-        to_node           = neo.getNodeById(params.delete('to'))
-        relationship_type = RelationshipType.instance(params.delete('type'))
-        relationship      = node.create_relationship_to to_node, relationship_type
+        node = neo.getNodeById(param_node_id)
+        to_node = neo.getNodeById(param_to_node_id)
+        relationship_type = RelationshipType.instance(param_relationship_type)
+        relationship = node.create_relationship_to to_node, relationship_type
         relationship.update_properties(params)
         node.getRelationships(relationship_type.to_a).hashify_objects
       end
       relationships.to_json
     end
 
+    describe "This returns all the ways two nodes are connected to each other and is similar to LinkedIn's degrees of separation. Warning: This is only good for sparse graphs, shortest_paths is better at handling larger connected graphs."
+    required_param :to, "the id of the node that your trying to find a path to from the starting node, :node_id"
+    required_param :type, "the type of relationships between nodes to follow"
+    optional_param :depth, "the maximum degrees of separation to find, the default is 2 degrees. Note: There may be performance impacts if this number is to high."
+    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(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)
-        paths = shortest_path.getPaths
-        paths.map{|p| p.map{|n| n.to_hash }}
+        start_node = neo.getNodeById(param_node_id)
+        end_node = neo.getNodeById(param_to_node_id)
+        shortest_path = AllSimplePaths.new(start_node, end_node, param_depth, param_direction, relationship_types)
+        to_hash shortest_path.getPaths
       end
       paths.to_json
     end
-    
+
+    describe "This returns the first of the shortest path of two nodes that are connected to each other"
+    required_param :to, "the id of the node that your trying to find a path to from the starting node, :node_id" 
+    required_param :type, "the type of relationships between nodes to follow"
     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(
+        dijkstra = Dijkstra.new(
           0.0,
-          start_node,
-          end_node,
+          neo.getNodeById(param_node_id),
+          neo.getNodeById(param_to_node_id),
           Neo4jr::SimpleEvaluator.new,
           DoubleAdder.new,
           DoubleComparator.new,
-          Direction::BOTH,
-          relationship.to_a)
-        dijkstra.getPath.map{|n| n.to_hash }
+          direction,
+          relationship_types)
+        (p=dijkstra.getPath) and p.map{|n| n.to_hash }
       end
       path.to_json
     end
-    
+
+    describe "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_param :type, "the type of relationships between nodes to follow" 
+    optional_param :leve, "the degree of separation that you want recommendations for, the default is 1 degree away which is similar to facebook's behavior"
     get '/nodes/:node_id/recommendations' do
       suggestions = Neo4jr::DB.execute do |neo|
-        relationship = Neo4jr::RelationshipType.incoming(params.delete('type'))
-        start_node   = neo.getNodeById(params.delete('node_id'))
-        level        = (params.delete('level') || 1).to_i
-        order        = Order::BREADTH_FIRST
-        return_when  = Return.when do |current_position|
-          current_position.depth > level
+        relationship = Neo4jr::RelationshipType.incoming(param_relationship_type)
+        start_node = neo.getNodeById(param_node_id)
+        order = Order::BREADTH_FIRST
+        return_when = Return.when do |current_position|
+          current_position.depth > param_level
         end
-        traverser = start_node.traverse(order, Stop.at(level + 1), return_when, relationship)
+        traverser = start_node.traverse(order, Stop.at(param_level + 1), return_when, relationship)
         traverser.map{|node| node.to_hash }
       end
       suggestions.to_json
     end
+
+    private
+    def to_hash paths
+      paths and paths.map{|p| p.map{|n| n.to_hash }}
+    end
   end
 end

data/lib/neo4jr-social.rb

@@ -1,15 +1,48 @@
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
 
+def find_and_require_neo4jr_simple
+  neo4jr_simple_root = java.lang.System.getProperty('neo4jr.simple') || ENV['neo4jr_simple']
+  if neo4jr_simple_root
+    $LOAD_PATH.unshift(File.join(neo4jr_simple_root, 'lib'))
+  else
+    gem 'neo4jr-simple'
+  end  
+  require 'neo4jr-simple'
+end
+
+def find_and_require_user_defined_code
+  extensions_path = java.lang.System.getProperty('neo4jr.extensions') || ENV['neo4jr_extensions'] || "~/.neo4jr-social"
+  extensions_path = File.expand_path(extensions_path)
+  if File.exists?(extensions_path)
+    Dir.open extensions_path do |dir|
+      dir.entries.each do |file|
+        if file.split('.').size > 1 && file.split('.').last == 'rb'
+          extension = File.join(File.expand_path(extensions_path), file) 
+          require(extension) && puts("Loaded Extension: #{extension}")
+        end
+      end
+    end
+  else
+    puts "No Extensions Found: #{extensions_path}"
+  end
+end
+
 include Java
 
 require 'rubygems'
+
 gem 'sinatra'
-gem 'json_pure'  
-gem 'neo4jr-simple' unless ENV['dev_on_gem']
+gem 'json_pure'
 
 require 'sinatra'
 require 'json'
-require 'neo4jr-simple'
-require 'neo4jr-social/simple_cost_evaluator'
+
+find_and_require_neo4jr_simple
+
+require 'neo4jr-social/self_documentor'
+require 'neo4jr-social/param_helper'
+require 'neo4jr-social/format_handler'
+require 'neo4jr-social/json_printer'
 require 'neo4jr-social/service'
 
+find_and_require_user_defined_code

data/neo4jr-social.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{neo4jr-social}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matthew Deiters"]
-  s.date = %q{2009-12-26}
+  s.date = %q{2010-01-19}
   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}
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
      "VERSION",
      "bin/start-neo4jr-social",
      "config.ru",
+     "config/warble.rb",
      "examples/facebook.rb",
      "examples/linkedin.rb",
      "jetty-runtime/etc/jetty.xml",
@@ -43,20 +44,17 @@ Gem::Specification.new do |s|
      "jetty-runtime/start.jar",
      "jetty-runtime/webapps/neo4jr-social.war",
      "lib/neo4jr-social.rb",
+     "lib/neo4jr-social/format_handler.rb",
+     "lib/neo4jr-social/json_printer.rb",
+     "lib/neo4jr-social/param_helper.rb",
+     "lib/neo4jr-social/self_documentor.rb",
      "lib/neo4jr-social/service.rb",
-     "lib/neo4jr-social/simple_cost_evaluator.rb",
-     "lib/neo4jr-social/version.rb",
      "neo4jr-social.gemspec",
+     "spec/format_handler_spec.rb",
+     "spec/json_printer_spec.rb",
      "spec/service_spec.rb",
      "spec/spec.opts",
-     "spec/spec_helper.rb",
-     "tmp/war/WEB-INF/lib/jruby-core-1.4.0.jar",
-     "tmp/war/WEB-INF/lib/jruby-rack-0.9.5.jar",
-     "tmp/war/WEB-INF/lib/jruby-stdlib-1.4.0.jar",
-     "tmp/war/WEB-INF/lib/neo4jr-social.rb",
-     "tmp/war/WEB-INF/lib/neo4jr-social/service.rb",
-     "tmp/war/WEB-INF/lib/neo4jr-social/version.rb",
-     "tmp/war/WEB-INF/web.xml"
+     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/mdeiters/neo4jr-social}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -64,7 +62,9 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{A self-containted and lightweight REST interface to Neo4j using JRuby.}
   s.test_files = [
-    "spec/service_spec.rb",
+    "spec/format_handler_spec.rb",
+     "spec/json_printer_spec.rb",
+     "spec/service_spec.rb",
      "spec/spec_helper.rb",
      "examples/facebook.rb",
      "examples/linkedin.rb"
@@ -77,20 +77,17 @@ 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.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.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.1.6"])
     s.add_dependency(%q<sinatra>, [">= 0"])
     s.add_dependency(%q<json_pure>, [">= 0"])
   end

data/spec/format_handler_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Neo4jr::FormatHandler do
+
+  it 'returns pure json by default' do
+    get '/'
+    last_response.body.should_not include(html_space = ' ')
+    last_response.headers['Content-Type'].should include('application/json')
+  end
+
+  it 'returns htmlized json if a browser request' do
+    get '/', {}, {'HTTP_ACCEPT' => 'text/html'}
+    last_response.body.should include(html_space = ' ')
+    last_response.headers['Content-Type'].should include('text/html')
+  end
+  
+  it 'always returns utf compliant text' do
+    get '/'
+    last_response.headers['Content-Type'].should include('charset=utf-8')
+  end
+  
+end

data/spec/json_printer_spec.rb

@@ -0,0 +1,94 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "JsonPrinter" do
+  describe ".render" do
+    it "should raise an error for invalid objects" do
+      lambda {
+        JsonPrinter.render(Object.new)
+      }.should raise_error
+    end
+    
+    it "should render nil with null" do
+      JsonPrinter.render(nil).should == %{null}
+    end
+    
+    it "should render true with true" do
+      JsonPrinter.render(true).should == %{true}
+    end
+    
+    it "should render false with false" do
+      JsonPrinter.render(false).should == %{false}
+    end
+          
+    it "should render JSON-escaped strings" do
+      JsonPrinter.render(%{foo&}).should == %{"foo\\u0026"}
+    end
+    
+    it "should render symbols as strings" do
+      JsonPrinter.render(:foo).should == %{"foo"}
+    end
+    
+    it "should render numbers" do
+      JsonPrinter.render(7).should == %{7}
+    end
+    
+    it "should render times" do
+      t = Time.at(946702800).utc
+      JsonPrinter.render(t).should == "Sat Jan 01 05:00:00 UTC 2000"
+    end
+    
+    it "should render arrays" do
+      JsonPrinter.render([:foo, :bar, :bat]).should ==
+        %{["foo",\n} <<
+        %{ "bar",\n} <<
+        %{ "bat"]}
+    end
+    
+    it "should render arrays with repeated values" do
+      JsonPrinter.render([:foo, :bar, :foo]).should ==
+        %{["foo",\n} <<
+        %{ "bar",\n} <<
+        %{ "foo"]}
+    end
+    
+    # TODO: would be nice to spec the actual output formatting
+    
+    it "should render hashes" do
+      d = {"foo" => "bar", "biz" => "bat", "bing" => "bong"}
+      JSON.parse(JsonPrinter.render(d)).should == d
+    end
+    
+    it "should render hashes with repeated values" do
+      d = {"foo" => "bar", "biz" => "bar", "bing" => "bar"}
+      JSON.parse(JsonPrinter.render(d)).should == d
+    end
+    
+    describe "on compound data structures" do
+      before :each do 
+        @d = 
+          ["foo",
+           "bar",
+           ["biz",
+            "bang",
+            {"biz" => "bat",
+             "bang" => "yang"},
+            "zoo"],
+           "bat",
+           {"bang" => "str",
+            "comp" =>
+              ["foo",
+               "bar",
+               "bat"],
+            "hash" =>
+              {"from" => "to",
+               "next" => "best"}},
+           "fin",
+           "end"]
+      end
+      
+      it "should render" do
+        JSON.parse(JsonPrinter.render(@d)).should == @d
+      end
+    end
+  end
+end

data/spec/service_spec.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Neo4jr::Service do
-  
+
   it "should be able to create a node" do
     post '/nodes', 'some_property=a_value&type=person'
     node = response_to_ruby

data/spec/spec_helper.rb

@@ -1,14 +1,14 @@
 $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'
-
 require 'neo4jr-social'
 require 'spec'
 require 'spec/autorun'
 require 'rack/test'
 
+# Neo4jr::Configuration.database_path = File.join(File.expand_path(File.dirname(__FILE__)), 'test-imdb-database')
+# puts Neo4jr::Configuration.database_path
+
 Spec::Runner.configure do |config|
   include Rack::Test::Methods
 
@@ -18,5 +18,5 @@ Spec::Runner.configure do |config|
   
   def response_to_ruby
     JSON.parse(last_response.body)
-  end   
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: neo4jr-social
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
   - Matthew Deiters
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-26 00:00:00 -08:00
+date: 2010-01-19 00:00:00 -08:00
 default_executable: start-neo4jr-social
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -32,16 +32,6 @@ 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.1.6
-      version: 
   - !ruby/object:Gem::Dependency 
     name: sinatra
     type: :runtime
@@ -82,6 +72,7 @@ files:
   - VERSION
   - bin/start-neo4jr-social
   - config.ru
+  - config/warble.rb
   - examples/facebook.rb
   - examples/linkedin.rb
   - jetty-runtime/etc/jetty.xml
@@ -96,20 +87,17 @@ files:
   - jetty-runtime/start.jar
   - jetty-runtime/webapps/neo4jr-social.war
   - lib/neo4jr-social.rb
+  - lib/neo4jr-social/format_handler.rb
+  - lib/neo4jr-social/json_printer.rb
+  - lib/neo4jr-social/param_helper.rb
+  - lib/neo4jr-social/self_documentor.rb
   - lib/neo4jr-social/service.rb
-  - lib/neo4jr-social/simple_cost_evaluator.rb
-  - lib/neo4jr-social/version.rb
   - neo4jr-social.gemspec
+  - spec/format_handler_spec.rb
+  - spec/json_printer_spec.rb
   - spec/service_spec.rb
   - spec/spec.opts
   - spec/spec_helper.rb
-  - tmp/war/WEB-INF/lib/jruby-core-1.4.0.jar
-  - tmp/war/WEB-INF/lib/jruby-rack-0.9.5.jar
-  - tmp/war/WEB-INF/lib/jruby-stdlib-1.4.0.jar
-  - tmp/war/WEB-INF/lib/neo4jr-social.rb
-  - tmp/war/WEB-INF/lib/neo4jr-social/service.rb
-  - tmp/war/WEB-INF/lib/neo4jr-social/version.rb
-  - tmp/war/WEB-INF/web.xml
 has_rdoc: true
 homepage: http://github.com/mdeiters/neo4jr-social
 licenses: []
@@ -139,6 +127,8 @@ signing_key:
 specification_version: 3
 summary: A self-containted and lightweight REST interface to Neo4j using JRuby.
 test_files: 
+  - spec/format_handler_spec.rb
+  - spec/json_printer_spec.rb
   - spec/service_spec.rb
   - spec/spec_helper.rb
   - examples/facebook.rb

data/lib/neo4jr-social/simple_cost_evaluator.rb

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

data/lib/neo4jr-social/version.rb

@@ -1,3 +0,0 @@
-module Neo4jr::Social
-  VERSION = File.read(File.expand_path(File.dirname(__FILE__) + "/../../VERSION")) unless defined?(Neo4jr::Social::VERSION)
-end

data/tmp/war/WEB-INF/lib/neo4jr-social/service.rb

@@ -1,97 +0,0 @@
-module Neo4jr
-  class Service < Sinatra::Base
-            
-    get '/info' do
-      Neo4jr::DB.stats.to_json
-    end
-    
-    get '/nodes' do
-      nodes = Neo4jr::DB.execute do |neo|
-        nodes = neo.all_nodes.map{|m| m.to_hash }        
-      end
-      nodes.to_json
-    end
-  
-    post '/nodes' do
-      node = Neo4jr::DB.execute do |neo|
-        node = neo.create_node(params)
-      end
-      node.to_hash.to_json
-    end
-    
-    get '/nodes/:node_id' do
-      Neo4jr::DB.getNodeById(params.delete('node_id')).to_json
-    end
-      
-    put '/nodes/:node_id' do
-      node = Neo4jr::DB.execute do |neo|
-        node = neo.getNodeById(params.delete('node_id'))
-        node.update_properties(params)
-      end
-      node.to_hash.to_json
-    end
-    
-    delete '/nodes/:node_id' do
-      Neo4jr::DB.execute do |neo|
-        node = neo.getNodeById(params['node_id'])
-        node.delete
-      end
-    end
-    
-    get '/nodes/:node_id/relationships' do
-      relationships = Neo4jr::DB.execute do |neo|
-        node              = neo.getNodeById(params.delete('node_id'))
-        if relationship_type = params.delete('type')
-          relationship_type = RelationshipType.instance(relationship_type)
-          node.getRelationships(relationship_type.to_a).hashify_objects
-        else
-          node.getRelationships.hashify_objects
-        end
-      end
-      relationships.to_json
-    end
-    
-    post '/nodes/:node_id/relationships' do
-      relationships = Neo4jr::DB.execute do |neo|
-        node              = neo.getNodeById(params.delete('node_id'))
-        to_node           = neo.getNodeById(params.delete('to'))
-        relationship_type = RelationshipType.instance(params.delete('type'))
-        relationship      = node.create_relationship_to to_node, relationship_type
-        relationship.update_properties(params)
-        node.getRelationships(relationship_type.to_a).hashify_objects
-      end
-      relationships.to_json
-    end
-
-    #optional direction & depth
-    get '/nodes/:node_id/path' 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'))
-        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)
-        paths = shortest_path.getPaths
-        paths.map{|p| p.map{|n| n.to_hash }}
-      end
-      paths.to_json
-    end
-    
-    #optional
-    get '/nodes/:node_id/recommendations' do
-      suggestions = Neo4jr::DB.execute do |neo|
-        relationship = Neo4jr::RelationshipType.incoming(params.delete('type'))
-        start_node   = neo.getNodeById(params.delete('node_id'))
-        level        = (params.delete('level') || 1).to_i
-        order        = Order::BREADTH_FIRST
-        return_when  = Return.when do |current_position|
-          current_position.depth > level
-        end
-        traverser = start_node.traverse(order, Stop.at(level + 1), return_when, relationship)
-        traverser.map{|node| node.to_hash }
-      end
-      suggestions.to_json
-    end
-  end
-end

data/tmp/war/WEB-INF/lib/neo4jr-social/version.rb

@@ -1,3 +0,0 @@
-module Neo4jr::Social
-  VERSION = File.read(File.expand_path(File.dirname(__FILE__) + "/../../VERSION")) unless defined?(Neo4jr::Social::VERSION)
-end

data/tmp/war/WEB-INF/lib/neo4jr-social.rb

@@ -1,14 +0,0 @@
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
-
-include Java
-
-require 'rubygems'
-gem 'sinatra'
-gem 'json_pure'
-gem 'neo4jr-simple'
-
-require 'sinatra'
-require 'json'
-require 'neo4jr-simple'
-require 'neo4jr-social/service'
-

data/tmp/war/WEB-INF/web.xml

@@ -1,38 +0,0 @@
-<!DOCTYPE web-app PUBLIC
-  "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
-  "http://java.sun.com/dtd/web-app_2_3.dtd">
-<web-app>
-
-  <context-param>
-    <param-name>rails.env</param-name>
-    <param-value>production</param-value>
-  </context-param>
-
-  <context-param>
-    <param-name>public.root</param-name>
-    <param-value>/</param-value>
-  </context-param>
-
-  <context-param>
-    <param-name>rackup</param-name>
-    <param-value>require 'lib/neo4jr-social'
-
-run Neo4jr::Service</param-value>
-  </context-param>
-
-
-  <filter>
-    <filter-name>RackFilter</filter-name>
-    <filter-class>org.jruby.rack.RackFilter</filter-class>
-  </filter>
-  <filter-mapping>
-    <filter-name>RackFilter</filter-name>
-    <url-pattern>/*</url-pattern>
-  </filter-mapping>
-
-  <listener>
-    <listener-class>org.jruby.rack.RackServletContextListener</listener-class>
-  </listener>
-
-
-</web-app>