neography 0.0.15 → 0.0.16

data/.project

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>neography</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+		<nature>com.aptana.ruby.core.rubynature</nature>
+	</natures>
+</projectDescription>

data/CONTRIBUTORS

@@ -4,4 +4,9 @@ Maintainer:
 Contributors:
 * Peter Neubauer
 * Ian Dees
-* Phuong CAO
+* Phuong CAO
+* Carlo Alberto Degli Atti
+* Stephen Becker IV
+* Thomas Baum
+* Maximilian Schulz
+* Hesham Amiri

data/Gemfile.lock

@@ -1,21 +1,22 @@
 PATH
   remote: .
   specs:
-    neography (0.0.13)
+    neography (0.0.15)
       httparty (~> 0.7.3)
       json
+      os
+      rubyzip
 
 GEM
   remote: http://rubygems.org/
   specs:
     crack (0.1.8)
     diff-lcs (1.1.2)
-    fakeweb (1.3.0)
-    httparty (0.7.4)
+    httparty (0.7.8)
       crack (= 0.1.8)
-    json (1.4.6)
-    json (1.4.6-java)
+    json (1.6.1)
     net-http-spy (0.2.1)
+    os (0.9.4)
     rake (0.8.7)
     rspec (2.0.1)
       rspec-core (~> 2.0.1)
@@ -27,13 +28,13 @@ GEM
     rspec-mocks (2.0.1)
       rspec-core (~> 2.0.1)
       rspec-expectations (~> 2.0.1)
+    rubyzip (0.9.4)
 
 PLATFORMS
   java
   ruby
 
 DEPENDENCIES
-  fakeweb (~> 1.3.0)
   neography!
   net-http-spy (= 0.2.1)
   rake (~> 0.8.7)

data/README.rdoc

@@ -4,11 +4,20 @@ Neography is a thin Ruby wrapper to the Neo4j Rest API, for more information:
 * {Getting Started with Neo4j Server}[http://wiki.neo4j.org/content/Getting_Started_with_Neo4j_Server]
 * {Neo4j Rest API Reference}[http://components.neo4j.org/neo4j-server/milestone/rest.html]
 
-If you want to the full power of Neo4j, you will want to use JRuby and the excellent Neo4j.rb gem at https://github.com/andreasronge/neo4j
+If you want to the full power of Neo4j, you will want to use JRuby and the excellent Neo4j.rb gem at https://github.com/andreasronge/neo4j by Andreas Ronge
+
+A complement to Neography is the Neology Gem at https://github.com/lordkada/neology by Carlo Alberto Degli Atti
+
+An alternative is the Architect4r Gem at https://github.com/namxam/architect4r by Maximilian Schulz 
+
 
 === Installation
 
-  gem install 'neography'
+  gem install 'neography', '0.0.14' # for version 1.4 of Neo4j
+
+or 
+
+  gem install 'neography', '0.0.15' # for version 1.5 of Neo4j
 
 After that, in your ruby script:
 
@@ -17,15 +26,6 @@ After that, in your ruby script:
 
 in order to access the functionality.
 
-=== Try it now!
-
-I am hosting an instance of Neo4j (1.3M04) 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
 
@@ -40,7 +40,25 @@ You can see the administration at: {Neo4j Web Admin}[http://neography.org]
 
 ==== Rails
 
-Just add gem 'neography' to your Gemfile and run bundle install
+Just add gem 'neography' to your Gemfile and run bundle install.
+
+The following tasks will be available to you:
+  
+  rake neo4j:install                           # Install Neo4j to the neo4j directory under your project 
+  rake neo4j:start                             # Start Neo4j
+  rake neo4j:stop                              # Stop Neo4j
+  rake neo4j:restart                           # Restart Neo4j
+  rake neo4j:reset_yes_i_am_sure               # Wipe your Neo4j Database 
+
+Windows users will need to run in a command prompt with Administrative Privileges
+in order to install Neo4j as a Service. 
+
+If you are not using Rails, then add:
+
+  require 'neography/tasks'
+
+to your Rakefile to have access to these tasks.
+
 
 === Documentation
 
@@ -103,6 +121,7 @@ To Use:
   @neo.remove_node_from_index(index, node1)                  # removes a node from the index
   @neo.get_node_index(index, key, value)                     # exact query of the node index with the given key/value pair
   @neo.find_node_index(index, key, value)                    # advanced query of the node index with the given key/value pair
+  @neo.find_node_index(index, query )                        # advanced query of the node index with the given query
   @neo.list_relationship_indexes                             # gives names and query templates for relationship indices
   @neo.create_relationship_index(name, "fulltext", provider) # creates a relationship index with "fulltext" option
   @neo.add_relationship_to_index(index, key, value, rel1)    # adds a relationship to the index with the given key/value pair
@@ -111,7 +130,9 @@ To Use:
   @neo.remove_relationship_from_index(index, rel1)           # removes a relationship from the index
   @neo.get_relationship_index(index, key, value)             # exact query of the relationship index with the given key/value pair
   @neo.find_relationship_index(index, key, value)            # advanced query of the relationship index with the given key/value pair
-
+  @neo.find_relationship_index(index, query)                 # advanced query of the relationship index with the given query
+  @neo.execute_script("g.v(0)")                              # sends a Groovy script(through the Gremlin plugin)
+  @neo.execute_query("start n=node(0) return n")             # sends a Cypher query (through the Cypher plugin)
 
   @neo.get_path(node1, node2, relationships, depth=4, algorithm="shortestPath") # finds the shortest path between two nodes 
   @neo.get_paths(node1, node2, relationships, depth=3, algorithm="allPaths")    # finds all paths between two nodes

data/Rakefile

@@ -8,4 +8,7 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = "spec/integration/*_spec.rb"
 end
 
-task :default => :spec
+desc "Run Tests"
+task :default => :spec
+
+

data/lib/neography.rb

@@ -17,10 +17,13 @@ end
 
 DIRECTIONS = ["incoming", "in", "outgoing", "out", "all", "both"]
 
+require 'cgi'
 require 'httparty'
 require 'json'
 require 'logger'
 require 'ostruct'
+require 'os'
+require 'zip/zipfilesystem'
 
 require 'neography/config'
 require 'neography/rest'
@@ -39,5 +42,7 @@ require 'neography/index'
 require 'neography/node'
 require 'neography/relationship'
 
+require 'neography/railtie' if defined? Rails
+
 find_and_require_user_defined_code
 

data/lib/neography/railtie.rb

@@ -0,0 +1,8 @@
+require 'rails'
+
+class Railtie < Rails::Railtie 
+
+  rake_tasks do
+    load "neography/tasks.rb"
+  end  
+end

data/lib/neography/rest.rb

@@ -263,8 +263,11 @@ module Neography
         index
       end
 
-      def find_node_index(index, key, value)
-        index = get("/index/node/#{index}/#{key}?query=#{value}") || Array.new
+      def find_node_index(*args)
+        case args.size
+          when 3 then index = get("/index/node/#{args[0]}/#{args[1]}?query=#{args[2]}") || Array.new
+          when 2 then index = get("/index/node/#{args[0]}?query=#{args[1]}") || Array.new
+        end
         return nil if index.empty?
         index
       end
@@ -302,8 +305,11 @@ module Neography
         index
       end
 
-      def find_relationship_index(index, key, value)
-        index = get("/index/relationship/#{index}/#{key}?query=#{value}") || Array.new
+      def find_relationship_index(*args)
+        case args.size
+          when 3 then index = get("/index/relationship/#{args[0]}/#{args[1]}?query=#{args[2]}") || Array.new
+          when 2 then index = get("/index/relationship/#{args[0]}?query=#{args[1]}") || Array.new
+        end
         return nil if index.empty?
         index
       end
@@ -328,12 +334,22 @@ module Neography
         paths = post("/node/#{get_id(from)}/paths", options) || Array.new
       end
 
+      def execute_query(query)
+          options = { :body => {:query => query}.to_json, :headers => {'Content-Type' => 'application/json'} }
+          result = post("/ext/CypherPlugin/graphdb/execute_query", options)
+      end
+      
+      def execute_script(script)
+        options = { :body => "script=" + CGI::escape(script), :headers => {'Content-Type' => 'application/x-www-form-urlencoded'} }
+        result = post("/ext/GremlinPlugin/graphdb/execute_script", options)
+        result == "null" ? nil : result
+      end
+            
       private
 
       def evaluate_response(response)
         code = response.code
         body = response.body
-     
         case code 
           when 200 
             @logger.debug "OK" if @log_enabled

data/lib/neography/tasks.rb

@@ -0,0 +1,129 @@
+# borrowed from architect4r
+
+namespace :neo4j do
+  desc "Install Neo4j"
+  task :install do
+    puts 'Installing Neo4j...'
+    
+    if OS::Underlying.windows?
+      # Download Neo4j    
+      unless File.exist?('neo4j.zip')
+        df = File.open('neo4j.zip', 'wb')
+        begin
+          df << HTTParty.get("http://dist.neo4j.org/neo4j-community-1.5.M02-windows.zip")
+        ensure
+          df.close()
+        end
+      end
+
+      # Extract and move to neo4j directory
+      unless File.exist?('neo4j')
+        Zip::ZipFile.open('neo4j.zip') do |zip_file|
+          zip_file.each do |f|
+           f_path=File.join(".", 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
+        FileUtils.mv "neo4j-community-1.5.M02", "neo4j"
+     end
+
+      # Install if running with Admin Privileges
+      if %x[reg query "HKU\\S-1-5-19"].size > 0 
+        %x[neo4j/bin/neo4j install]
+        puts "Neo4j Installed as a service."
+      end
+
+    else    
+      %x[wget http://dist.neo4j.org/neo4j-community-1.5.M02-unix.tar.gz]
+      %x[tar -xvzf neo4j-community-1.5.M02-unix.tar.gz]
+      %x[mv neo4j-community-1.5.M02 neo4j]
+      %x[rm neo4j-community-1.5.M02-unix.tar.gz]
+      puts "Neo4j Installed in to neo4j directory."
+    end
+    puts "Type 'rake neo4j:start' to start it"
+  end
+  
+  desc "Start the Neo4j Server"
+  task :start do
+    puts "Starting Neo4j..."
+    if OS::Underlying.windows? 
+      if %x[reg query "HKU\\S-1-5-19"].size > 0 
+        %x[neo4j/bin/Neo4j.bat start]  #start service
+      else
+        puts "Starting Neo4j directly, not as a service."
+        %x[neo4j/bin/Neo4j.bat]
+      end      
+    else
+      %x[neo4j/bin/neo4j start]  
+    end
+  end
+  
+  desc "Stop the Neo4j Server"
+  task :stop do
+    puts "Stopping Neo4j..."
+    if OS::Underlying.windows? 
+      if %x[reg query "HKU\\S-1-5-19"].size > 0
+         %x[neo4j/bin/Neo4j.bat stop]  #stop service
+      else
+        puts "You do not have administrative rights to stop the Neo4j Service"   
+      end
+    else  
+      %x[neo4j/bin/neo4j stop]
+    end
+  end
+
+  desc "Restart the Neo4j Server"
+  task :restart do
+    puts "Restarting Neo4j..."
+    if OS::Underlying.windows? 
+      if %x[reg query "HKU\\S-1-5-19"].size > 0
+         %x[neo4j/bin/Neo4j.bat restart] 
+      else
+        puts "You do not have administrative rights to restart the Neo4j Service"   
+      end
+    else  
+      %x[neo4j/bin/neo4j restart]
+    end
+  end
+
+  desc "Reset the Neo4j Server"
+  task :reset_yes_i_am_sure do
+    # Stop the server
+    if OS::Underlying.windows? 
+      if %x[reg query "HKU\\S-1-5-19"].size > 0
+         %x[neo4j/bin/Neo4j.bat stop]
+         
+        # Reset the database
+        FileUtils.rm_rf("neo4j/data/graph.db")
+        FileUtils.mkdir("neo4j/data/graph.db")
+        
+        # Remove log files
+        FileUtils.rm_rf("neo4j/data/log")
+        FileUtils.mkdir("neo4j/data/log")
+
+        %x[neo4j/bin/Neo4j.bat start]
+      else
+        puts "You do not have administrative rights to reset the Neo4j Service"   
+      end
+    else  
+      %x[neo4j/bin/neo4j stop]
+      
+      # Reset the database
+      FileUtils.rm_rf("neo4j/data/graph.db")
+      FileUtils.mkdir("neo4j/data/graph.db")
+      
+      # Remove log files
+      FileUtils.rm_rf("neo4j/data/log")
+      FileUtils.mkdir("neo4j/data/log")
+      
+      # Start the server
+      %x[neo4j/bin/neo4j start]
+    end
+  end
+
+end  

data/lib/neography/version.rb

@@ -1,3 +1,3 @@
 module Neography
-  VERSION = "0.0.15"
+  VERSION = "0.0.16"
 end

data/neography.gemspec

@@ -21,8 +21,9 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rspec", "~> 2.0.0.beta.22"
   s.add_development_dependency "net-http-spy", "0.2.1"
-  s.add_development_dependency "fakeweb", "~> 1.3.0"
   s.add_development_dependency "rake", "~> 0.8.7"
   s.add_dependency "httparty", "~> 0.7.3"
   s.add_dependency "json"
+  s.add_dependency "os"
+  s.add_dependency "rubyzip"
 end

data/spec/integration/rest_index_spec.rb

@@ -214,6 +214,16 @@ describe Neography::Rest do
       @neo.remove_node_from_index("test_index", key, value, new_node) 
     end
 
+    it "can find a node index using generic query" do
+      new_node = @neo.create_node
+      key = generate_text(6)
+      value = generate_text
+      @neo.add_node_to_index("test_index", key, value, new_node)
+      new_index = @neo.find_node_index("test_index", "#{key}: #{value}")
+      new_index.first["self"].should == new_node["self"]
+      @neo.remove_node_from_index("test_index", key, value, new_node)
+    end
+
     it "can get a relationship index" do
       new_node1 = @neo.create_node
       new_node2 = @neo.create_node
@@ -250,6 +260,18 @@ describe Neography::Rest do
       @neo.remove_relationship_from_index("test_index", key, value, new_relationship)
     end
 
+    it "can find a relationship index using generic query" do
+      new_node1 = @neo.create_node
+      new_node2 = @neo.create_node
+      new_relationship = @neo.create_relationship("friends", new_node1, new_node2)
+      key = generate_text(6)
+      value = generate_text
+      @neo.add_relationship_to_index("test_index", key, value, new_relationship)
+      new_index = @neo.find_relationship_index("test_index", "#{key}: #{value}")
+      new_index.first["self"].should == new_relationship["self"]
+      @neo.remove_relationship_from_index("test_index", key, value, new_relationship)
+    end
+
     it "can find use the results of a node index" do
       new_node1 = @neo.create_node
       new_node2 = @neo.create_node

data/spec/integration/rest_plugin_spec.rb

@@ -0,0 +1,26 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Neography::Rest do
+  before(:each) do
+    @neo = Neography::Rest.new
+  end
+
+  describe "execute gremlin script" do
+    it "can get the root node id" do
+      root_node = @neo.execute_script("g.v(0)")
+      root_node.should have_key("self")
+      root_node["self"].split('/').last.should == "0"
+    end
+  end
+
+  describe "execute cypher query" do
+    it "can get the root node id" do
+      root_node = @neo.execute_query("start n=node(0) return n")
+      root_node.should have_key("data")
+      root_node.should have_key("columns")
+      root_node["data"][0][0].should have_key("self")
+      root_node["data"][0][0]["self"].split('/').last.should == "0"
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,18 +1,7 @@
 require 'neography'
-require 'fake_web'
 require 'benchmark'
 
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
-
-FakeWeb.allow_net_connect = false
-
-# To test against a real database:
-# 1. Make sure empty database is running on your test neo4j server (bin/neo4j start)
-# 2. Uncomment the next two lines
-FakeWeb.clean_registry 
-FakeWeb.allow_net_connect = true
-
-# 3. If you want to see more, uncomment the next few lines
+# If you want to see more, uncomment the next few lines
 # require 'net-http-spy'
 # Net::HTTP.http_logger_options = {:body => true}    # just the body
 # Net::HTTP.http_logger_options = {:verbose => true} # see everything

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: neography
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 63
   prerelease: 
   segments: 
   - 0
   - 0
-  - 15
-  version: 0.0.15
+  - 16
+  version: 0.0.16
 platform: ruby
 authors: 
 - Max De Marzi
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-17 00:00:00 Z
+date: 2011-11-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -52,55 +52,53 @@ dependencies:
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: fakeweb
+  name: rake
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 49
         segments: 
-        - 1
-        - 3
         - 0
-        version: 1.3.0
+        - 8
+        - 7
+        version: 0.8.7
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: httparty
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 49
+        hash: 5
         segments: 
         - 0
-        - 8
         - 7
-        version: 0.8.7
-  type: :development
+        - 3
+        version: 0.7.3
+  type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: httparty
+  name: json
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 5
+        hash: 3
         segments: 
         - 0
-        - 7
-        - 3
-        version: 0.7.3
+        version: "0"
   type: :runtime
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: os
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
@@ -113,6 +111,20 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rubyzip
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
 description: A Ruby wrapper to the Neo4j Rest API see http://components.neo4j.org/neo4j-rest/ for more details.
 email: maxdemarzi@gmail.com
 executables: []
@@ -123,6 +135,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .project
 - CONTRIBUTORS
 - Gemfile
 - Gemfile.lock
@@ -147,9 +160,11 @@ files:
 - lib/neography/path_traverser.rb
 - lib/neography/property.rb
 - lib/neography/property_container.rb
+- lib/neography/railtie.rb
 - lib/neography/relationship.rb
 - lib/neography/relationship_traverser.rb
 - lib/neography/rest.rb
+- lib/neography/tasks.rb
 - lib/neography/version.rb
 - neography.gemspec
 - spec/integration/authorization_spec.rb
@@ -164,10 +179,10 @@ files:
 - spec/integration/rest_index_spec.rb
 - spec/integration/rest_node_spec.rb
 - spec/integration/rest_path_spec.rb
+- spec/integration/rest_plugin_spec.rb
 - spec/integration/rest_relationship_spec.rb
 - spec/integration/rest_traverse_spec.rb
 - spec/spec_helper.rb
-- spec/support/fake_root_spec.rb
 homepage: http://rubygems.org/gems/neography
 licenses: []
 

data/spec/support/fake_root_spec.rb

@@ -1,5 +0,0 @@
-FakeWeb.register_uri(:get, "http://localhost:7474/", :body => '{
-  "index" : "http://localhost:7474/index",
-  "node" : "http://localhost:7474/node",
-  "reference_node" : "http://localhost:7474/node/0"
-}')