neography 0.0.9 → 0.0.10

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    neography (0.0.7)
+    neography (0.0.9)
       httparty (~> 0.7.3)
       json
 

data/README.rdoc

@@ -2,7 +2,7 @@
 
 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-rest/]
+* {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
 
@@ -19,7 +19,7 @@ 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.
+I am hosting an instance of Neo4j (1.2) at neography.org for you to try out.
 
 You can see the administration at: {Neo4j Web Admin}[http://neography.org]
 
@@ -44,8 +44,6 @@ Just add gem 'neography' to your Gemfile and run bundle install
 
 === Documentation
 
-A thin ruby wrapper Neography::Rest which tries to mirror the Neo4j Rest API and returns JSON or Nil:
-
   @neo = Neography::Rest.new({:protocol => 'http://', 
                               :server => 'localhost', 
                               :port => 7474, 
@@ -57,9 +55,14 @@ A thin ruby wrapper Neography::Rest which tries to mirror the Neo4j Rest API and
                               :log_enabled => false,
                               :max_threads => 20})
 
+Quick initializer (assumes basic authorization if username is given):
+
+  @neo = Neography::Rest.new("http://username:password@myserver.com:7474/mydirectory")
+
+
 To Use:
 
-  @neo = Neography::Rest.new 
+  @neo = Neography::Rest.new                                 # Inialize using all default parameters 
 
   @neo.get_root                                              # Get the root node
   node1 = @neo.create_node                                   # Create an empty node
@@ -92,10 +95,15 @@ To Use:
   @neo.remove_relationship_properties(rel1, "since")         # Remove one property of a relationship
   @neo.remove_relationship_properties(rel1, ["since","met"]) # Remove multiple properties of a relationship
 
-  @neo.list_indexes                                          # gives names and query templates for all defined indices
-  @neo.add_to_index(index, key, value, node1)                # adds a node to the specified index with the given key/value pair
-  @neo.remove_from_index(index, key, value, node1)           # removes a node from the specified index with the given key/value pair
-  @neo.get_index(index, key, value)                          # queries the specified index with the given key/value pair
+  @neo.list_node_indexes                                     # gives names and query templates for all defined indices
+  @neo.add_node_to_index(index, key, value, node1)           # adds a node to the index with the given key/value pair
+  @neo.remove_node_from_index(index, key, value, node1)      # removes a node from the index with the given key/value pair
+  @neo.get_node_index(index, key, value)                     # queries the index with the given key/value pair
+  @neo.list_relationship_indexes                             # gives names and query templates for relationship indices
+  @neo.add_relationship_to_index(index, key, value, rel1)    # adds a relationship to the index with the given key/value pair
+  @neo.remove_relationship_from_index(index, key, value, rel1) # removes a relationship from the index with the given key/value pair
+  @neo.get_relationship_index(index, key, value)             # queries the relationship index with the given key/value pair
+
 
   @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
@@ -133,7 +141,7 @@ Experimental:
   another_node = @neo.create_node("age" => 31, "name" => "Max")
   nodes = @neo.get_nodes([one_set_nodes, another_node])                     # Get four nodes
 
-=== Phase 2 (work in progress):
+=== Phase 2
 
 Trying to mimic the Neo4j.rb API.
 

data/lib/neography/config.rb

@@ -1,6 +1,6 @@
 module Neography
   class Config 
-    class << self; attr_accessor :protocol, :server, :port, :directory, :log_file, :log_enabled, :logger, :max_threads, :authentication end
+    class << self; attr_accessor :protocol, :server, :port, :directory, :log_file, :log_enabled, :logger, :max_threads, :authentication, :username, :password end
 
     @protocol = 'http://'
     @server = 'localhost'
@@ -11,5 +11,7 @@ module Neography
     @logger = Logger.new(@log_file) if @log_enabled
     @max_threads = 20
     @authentication = {}
+    @username = nil
+    @password = nil
   end
 end

data/lib/neography/node_index.rb

@@ -0,0 +1,9 @@
+module Neography
+  module NodeIndex
+
+    def find
+
+    end
+
+  end
+end

data/lib/neography/rest.rb

@@ -5,15 +5,31 @@ module Neography
     attr_accessor :protocol, :server, :port, :directory, :log_file, :log_enabled, :logger, :max_threads, :authentication, :username, :password
 
       def initialize(options={})
-        init = {:protocol => Neography::Config.protocol, 
-                :server => Neography::Config.server, 
-                :port => Neography::Config.port, 
-                :directory => Neography::Config.directory, 
-                :log_file => Neography::Config.log_file, 
-                :log_enabled => Neography::Config.log_enabled, 
-                :max_threads => Neography::Config.max_threads,
-                :authentication => Neography::Config.authentication}
+        init = {:protocol       => Neography::Config.protocol, 
+                :server         => Neography::Config.server, 
+                :port           => Neography::Config.port, 
+                :directory      => Neography::Config.directory, 
+                :log_file       => Neography::Config.log_file, 
+                :log_enabled    => Neography::Config.log_enabled, 
+                :max_threads    => Neography::Config.max_threads,
+                :authentication => Neography::Config.authentication,
+                :username       => Neography::Config.username,
+                :password       => Neography::Config.password}
+
+        unless options.respond_to?(:each_pair)
+          url = URI.parse(options)
+          options = Hash.new
+          options[:protocol] = url.scheme + "://"
+          options[:server] = url.host
+          options[:port] = url.port
+          options[:directory] = url.path
+          options[:username] = url.user
+          options[:password] = url.password
+          options[:authentication] = 'basic' unless url.user.nil?
+        end
+
         init.merge!(options)
+        puts init.inspect
 
         @protocol       = init[:protocol]
         @server         = init[:server]
@@ -25,6 +41,7 @@ module Neography
         @max_threads    = init[:max_threads]
         @authentication = Hash.new
         @authentication = {"#{init[:authentication]}_auth".to_sym => {:username => init[:username], :password => init[:password]}} unless init[:authentication].empty?
+        puts "Authentication: #{@authentication.inspect}"
       end
 
       def configure(protocol, server, port, directory)
@@ -219,25 +236,48 @@ module Neography
         delete("/node/#{get_id(id)}")
       end
 
-      def list_indexes
+      def list_node_indexes
         get("/index/node")
       end
 
-      def add_to_index(index, key, value, id)
+      def add_node_to_index(index, key, value, id)
         options = { :body => (self.configuration + "/node/#{get_id(id)}").to_json, :headers => {'Content-Type' => 'application/json'} } 
         post("/index/node/#{index}/#{key}/#{value}", options)
       end
 
-      def remove_from_index(index, key, value, id)
+      def remove_node_from_index(index, key, value, id)
         delete("/index/node/#{index}/#{key}/#{value}/#{get_id(id)}")
       end
 
-      def get_index(index, key, value)
+      def get_node_index(index, key, value)
         index = get("/index/node/#{index}/#{key}/#{value}") || Array.new
         return nil if index.empty?
         index
       end
 
+      alias_method :list_indexes, :list_node_indexes
+      alias_method :add_to_index, :add_node_to_index
+      alias_method :remove_from_index, :remove_node_from_index
+      alias_method :get_index, :get_node_index
+
+      def list_relationship_indexes
+        get("/index/relationship")
+      end
+
+      def add_relationship_to_index(index, key, value, id)
+        options = { :body => (self.configuration + "/relationship/#{get_id(id)}").to_json, :headers => {'Content-Type' => 'application/json'} } 
+        post("/index/relationship/#{index}/#{key}/#{value}", options)
+      end
+
+      def remove_relationship_from_index(index, key, value, id)
+        delete("/index/relationship/#{index}/#{key}/#{value}/#{get_id(id)}")
+      end
+
+      def get_relationship_index(index, key, value)
+        index = get("/index/relationship/#{index}/#{key}/#{value}") || Array.new
+        return nil if index.empty?
+        index
+      end
       def traverse(id, return_type, description)
         options = { :body => {"order" => get_order(description["order"]), 
                               "uniqueness" => get_uniqueness(description["uniqueness"]), 

data/lib/neography/version.rb

@@ -1,3 +1,3 @@
 module Neography
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

data/spec/integration/authorization_spec.rb

@@ -0,0 +1,48 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Neography::Rest do
+  describe "basic authentication" do
+    describe "get_root" do
+      it "can get the root node" do
+        @neo = Neography::Rest.new({:server => '4c36b641.neo4j.atns.de', :port => 7474, :directory => '/9dc1fda5be8b5cde29621e21cae5adece3de0f37', :authentication => 'basic', :username => "abbe3c012", :password => "34d7b22eb"})
+        root_node = @neo.get_root
+        root_node.should have_key("reference_node")
+      end
+    end
+
+    describe "create_node" do
+      it "can create an empty node" do
+        @neo = Neography::Rest.new({:server => '4c36b641.neo4j.atns.de', :port => 7474, :directory => '/9dc1fda5be8b5cde29621e21cae5adece3de0f37', :authentication => 'basic', :username => "abbe3c012", :password => "34d7b22eb"})
+        new_node = @neo.create_node
+        new_node.should_not be_nil
+      end
+    end
+
+    describe "quick initalizer" do
+      it "can get the root node" do
+        @neo = Neography::Rest.new("http://abbe3c012:34d7b22eb@4c36b641.neo4j.atns.de:7474/9dc1fda5be8b5cde29621e21cae5adece3de0f37")
+        root_node = @neo.get_root
+        root_node.should have_key("reference_node")
+      end
+    end
+  end
+
+  describe "digest authentication" do
+    describe "get_root" do
+      it "can get the root node" do
+        @neo = Neography::Rest.new({:server => '4c36b641.neo4j.atns.de', :port => 7474, :directory => '/9dc1fda5be8b5cde29621e21cae5adece3de0f37', :authentication => 'digest', :username => "abbe3c012", :password => "34d7b22eb"})
+        root_node = @neo.get_root
+        root_node.should have_key("reference_node")
+      end
+    end
+
+    describe "create_node" do
+      it "can create an empty node" do
+        @neo = Neography::Rest.new({:server => '4c36b641.neo4j.atns.de', :port => 7474, :directory => '/9dc1fda5be8b5cde29621e21cae5adece3de0f37', :authentication => 'digest', :username => "abbe3c012", :password => "34d7b22eb"})
+        new_node = @neo.create_node
+        new_node.should_not be_nil
+      end
+    end
+  end
+
+end

data/spec/integration/index_spec.rb

@@ -0,0 +1,31 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Neography::Relationship, "find" do
+  before(:each) do
+    Neography::Relationship.index(:strength)
+  end
+
+  it "can index when Neography::Relationships are created" do
+    a            = Neography::Node.create
+    b            = Neography::Node.create
+    r            = Neography::Relationship.create(:friends, a, b)
+    r[:strength] = 'strong'
+    Neography::Relationship.find('strength: strong').first.should == r
+  end
+
+  it "can remove index when Neography::Relationship is deleted, just like nodes" do
+    a            = Neography::Node.create
+    b            = Neography::Node.create
+    r            = Neography::Relationship.create(:friends, a, b)
+    r[:strength] = 'weak'
+    r2           = Neography::Relationship.find('strength: weak').first
+    r2.should == r
+    r2.del
+    Neography::Relationship.find('strength: weak').should be_empty
+  end
+end
+
+
+describe Neography::Node, "find" do
+
+end

data/spec/integration/rest_index_spec.rb

@@ -6,13 +6,23 @@ describe Neography::Rest do
   end
 
   describe "list indexes" do
-    it "can get a listing of indexes" do
+    it "can get a listing of node indexes" do
       new_node = @neo.create_node
       key = generate_text(6)
       value = generate_text
-      @neo.add_to_index("test_index", key, value, new_node) 
+      @neo.add_node_to_index("test_index", key, value, new_node) 
       @neo.list_indexes.should_not be_nil
     end
+
+    it "can get a listing of relationship indexes" 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) 
+      @neo.list_relationship_indexes.should_not be_nil
+    end
   end
 
   describe "add to index" do
@@ -20,10 +30,22 @@ describe Neography::Rest do
       new_node = @neo.create_node
       key = generate_text(6)
       value = generate_text
-      @neo.add_to_index("test_index", key, value, new_node) 
-      new_index = @neo.get_index("test_index", key, value) 
+      @neo.add_node_to_index("test_index", key, value, new_node) 
+      new_index = @neo.get_node_index("test_index", key, value) 
+      new_index.should_not be_nil
+      @neo.remove_node_from_index("test_index", key, value, new_node) 
+    end
+  
+    it "can add a relationship to an index" 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.get_relationship_index("test_index", key, value) 
       new_index.should_not be_nil
-      @neo.remove_from_index("test_index", key, value, new_node) 
+      @neo.remove_relationship_from_index("test_index", key, value, new_relationship) 
     end
   end
 
@@ -32,25 +54,76 @@ describe Neography::Rest do
       new_node = @neo.create_node
       key = generate_text(6)
       value = generate_text
-      @neo.add_to_index("test_index", key, value, new_node) 
-      new_index = @neo.get_index("test_index", key, value) 
+      @neo.add_node_to_index("test_index", key, value, new_node) 
+      new_index = @neo.get_node_index("test_index", key, value) 
       new_index.should_not be_nil
-      @neo.remove_from_index("test_index", key, value, new_node) 
-      new_index = @neo.get_index("test_index", key, value) 
+      @neo.remove_node_from_index("test_index", key, value, new_node) 
+      new_index = @neo.get_node_index("test_index", key, value) 
+      new_index.should be_nil
+    end
+
+    it "can remove a relationshp from an index" 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.get_relationship_index("test_index", key, value) 
+      new_index.should_not be_nil
+      @neo.remove_relationship_from_index("test_index", key, value, new_relationship) 
+      new_index = @neo.get_relationship_index("test_index", key, value) 
       new_index.should be_nil
     end
   end
 
   describe "get index" do
-    it "can get an index" do
+    it "can get a node index" do
       new_node = @neo.create_node
       key = generate_text(6)
       value = generate_text
-      @neo.add_to_index("test_index", key, value, new_node) 
-      new_index = @neo.get_index("test_index", key, value) 
+      @neo.add_node_to_index("test_index", key, value, new_node) 
+      new_index = @neo.get_node_index("test_index", key, value) 
+      new_index.should_not be_nil
+      @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
+      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.get_relationship_index("test_index", key, value) 
       new_index.should_not be_nil
-      @neo.remove_from_index("test_index", key, value, new_node) 
+      @neo.remove_relationship_from_index("test_index", key, value, new_relationship)
     end
   end
 
+  describe "query index" do
+    it "can query a node index" 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.get_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
+      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.get_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
+  end
+
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: neography
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 0
   - 0
-  - 9
-  version: 0.0.9
+  - 10
+  version: 0.0.10
 platform: ruby
 authors: 
 - Max De Marzi
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-04 00:00:00 -08:00
+date: 2011-02-10 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -124,6 +124,7 @@ files:
 - lib/neography/equal.rb
 - lib/neography/neography.rb
 - lib/neography/node.rb
+- lib/neography/node_index.rb
 - lib/neography/node_path.rb
 - lib/neography/node_relationship.rb
 - lib/neography/node_traverser.rb
@@ -135,7 +136,8 @@ files:
 - lib/neography/rest.rb
 - lib/neography/version.rb
 - neography.gemspec
-- spec/integration/heroku_spec.rb
+- spec/integration/authorization_spec.rb
+- spec/integration/index_spec.rb
 - spec/integration/neography_spec.rb
 - spec/integration/node_path_spec.rb
 - spec/integration/node_relationship_spec.rb

data/spec/integration/heroku_spec.rb

@@ -1,21 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', 'spec_helper')
-
-describe Neography::Rest do
-  before(:each) do
-    @neo = Neography::Rest.new({:server => '4c36b641.neo4j.atns.de', :port => 7474, :directory => '/9dc1fda5be8b5cde29621e21cae5adece3de0f37', :authentication => 'basic', :username => "abbe3c012", :password => "34d7b22eb"})
-  end
-
-  describe "get_root" do
-    it "can get the root node" do
-      root_node = @neo.get_root
-      root_node.should have_key("reference_node")
-    end
-  end
-
-  describe "create_node" do
-    it "can create an empty node" do
-      new_node = @neo.create_node
-      new_node.should_not be_nil
-    end
-  end
-end