keymaker 0.0.8 → 0.0.9

data/README.md

@@ -2,6 +2,10 @@
 
 A multi-layer REST API Ruby wrapper for the Neo4j graph database built on top of [Faraday][].
 
+- Layer 1 interacts with the Neo4j REST API raw requests
+- Layer 2 binds the raw HTTP requests into Ruby Objects
+- Layer 3 implements ActiveModel and treats Nodes and Relationships as Ruby Objects
+
 ```
 Oracle: Our time is up. Listen to me, Neo.
         You can save Zion if you reach The Source,
@@ -24,7 +28,7 @@ rake neo4j:start RAILS_ENV=test
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'keymaker'
+gem "keymaker"
 ```
 
 And then execute:
@@ -52,18 +56,18 @@ Then, create a Rails initializer `config/initializers/keymaker.rb`:
 
 ```ruby
 if Rails.env.development? || Rails.env.test?
-  database_config = YAML::load_file('config/neo4j.yml')
+  database_config = YAML::load_file("config/neo4j.yml")
   Keymaker.configure do |c|
-    c.server = database_config["#{Rails.env}"]['server']
-    c.port = database_config["#{Rails.env}"]['port']
+    c.server = database_config["#{Rails.env}"]["server"]
+    c.port = database_config["#{Rails.env}"]["port"]
   end
 else
   # Heroku neo4j add-on
   Keymaker.configure do |c|
-    c.server = ENV['NEO4J_HOST']
-    c.port = ENV['NEO4J_PORT'].to_i
-    c.username = ENV['NEO4J_LOGIN']
-    c.password = ENV['NEO4J_PASSWORD']
+    c.server = ENV["NEO4J_HOST"]
+    c.port = ENV["NEO4J_PORT"]
+    c.username = ENV["NEO4J_LOGIN"]
+    c.password = ENV["NEO4J_PASSWORD"]
   end
 end
 ```
@@ -79,18 +83,40 @@ end
 
 ## Create a node ##
 
-response = Keymaker.service.create_node_request({:name => 'John Connor', :catch_phrase => 'No problemo'})
+terminator_response = Keymaker.service.create_node_request({:name => "Terminator",
+                                                            :catch_phrase => "I'll be back"})
+terminator = Keymaker.service.get_node(terminator_response.neo4j_id)
+ 
+john_response = Keymaker.service.create_node_request({:name => "John Connor",
+                                                      :catch_phrase => "No problemo"})
+
+john_connor = Keymaker.service.get_node(john_response.neo4j_id)
+john_connor.name # => "John Connor"
+john_connor.catch_phrase # => "No problemo"
 
 ## Update node properties ##
 
+Keymaker.service.update_node_properties_request({:node_id => john_connor.neo4j_id,
+                                                 :catch_phrase => "Easy money!"})
+john_connor.catch_phrase # => "Easy money!"
+
 ## Delete a node ##
 
+Keymaker.service.delete_node_request({:node_id => john_connor.neo4j_id})
+Keymaker.service.get_node_request({:node_id => john_connor.neo4j_id})
+# => Keymaker::ResourceNotFound raised
+
 ## Create a relationship ##
 
-## Update relationship properties ##
+rel = Keymaker.service.create_relationship_request({:node_id => john_connor.neo4j_id,
+                                                    :end_node_id => terminator.neo4j_id,
+                                                    :rel_type => "knows",
+                                                    :data => {:since => "Summer of 1984"})
 
 ## Delete a relationship ##
 
+Keymaker.service.delete_relationship_request(:relationship_id => rel.neo4j_id)
+
 ```
 
 ### Nodes

data/keymaker.gemspec

@@ -1,55 +1,31 @@
 # -*- encoding: utf-8 -*-
-## This is the rakegem gemspec template. Make sure you read and understand
-## all of the comments. Some sections require modification, and others can
-## be deleted if you don't need them. Once you understand the contents of
-## this file, feel free to delete any comments that begin with two hash marks.
-## You can find comprehensive Gem::Specification documentation, at
-## http://docs.rubygems.org/read/chapter/20
 Gem::Specification.new do |s|
   s.specification_version = 2 if s.respond_to? :specification_version=
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.rubygems_version = '1.3.5'
 
-  ## Leave these as is they will be modified for you by the rake gemspec task.
-  ## If your rubyforge_project name is different, then edit it and comment out
-  ## the sub! line in the Rakefile
   s.name              = 'keymaker'
-  s.version           = '0.0.8'
-  s.date              = '2012-07-19'
+  s.version           = '0.0.9'
+  s.date              = '2012-09-22'
 
-  ## Make sure your summary is short. The description may be as long
-  ## as you like.
   s.description   = %q{A multi-layer REST API wrapper for neo4j.}
   s.summary       = %q{A multi-layer REST API wrapper for neo4j.}
 
-  ## List the primary authors. If there are a bunch of authors, it's probably
-  ## better to set the email to an email list or something. If you don't have
-  ## a custom homepage, consider using your GitHub URL or the like.
   s.authors       = ["Rogelio J. Samour", "Travis L. Anderson"]
   s.email         = ["rogelio@therubymug.com", "travis@travisleeanderson.com"]
   s.homepage      = "https://github.com/therubymug/keymaker"
 
-  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
-  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
   s.require_paths = %w[lib]
 
-  ## Specify any RDoc options here. You'll want to add your README and
-  ## LICENSE files to the extra_rdoc_files list.
-  ## s.rdoc_options = ["--charset=UTF-8"]
   s.extra_rdoc_files = %w[README.md LICENSE.md]
 
-  ## List your runtime dependencies here. Runtime dependencies are those
-  ## that are needed for an end user to actually USE your code.
-  ## s.add_dependency('DEPNAME', [">= 1.1.0", "< 2.0.0"])
   s.add_dependency 'activemodel'
   s.add_dependency 'activesupport'
   s.add_dependency 'addressable'
+  s.add_dependency 'hashie'
   s.add_dependency 'faraday'
   s.add_dependency 'faraday_middleware'
 
-  ## List your development dependencies here. Development dependencies are
-  ## those that are only needed during development
-  ## s.add_development_dependency('DEVDEPNAME', [">= 1.1.0", "< 2.0.0"])
   s.add_development_dependency 'fakeweb'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
@@ -86,34 +62,64 @@ Gem::Specification.new do |s|
     lib/keymaker/requests/execute_gremlin_request.rb
     lib/keymaker/requests/get_node_request.rb
     lib/keymaker/requests/get_relationship_types_request.rb
-    lib/keymaker/requests/path_traverse_request.rb
     lib/keymaker/requests/remove_node_from_index_request.rb
     lib/keymaker/requests/service_root_request.rb
+    lib/keymaker/requests/traverse_path_request.rb
     lib/keymaker/requests/update_node_properties_request.rb
     lib/keymaker/response.rb
     lib/keymaker/serialization.rb
     lib/keymaker/service.rb
-    spec/cassettes/Keymaker_AddNodeToIndexRequest/returns_a_201_status_code.yml
-    spec/cassettes/Keymaker_AddNodeToIndexRequest/returns_application/json.yml
-    spec/cassettes/Keymaker_AddNodeToIndexRequest/returns_the_Neo4j_REST_API_starting_point_response_request.yml
+    spec/cassettes/Keymaker_AddNodeToIndexRequest/with_valid_options/returns_a_201_status_code.yml
+    spec/cassettes/Keymaker_AddNodeToIndexRequest/with_valid_options/returns_application/json.yml
+    spec/cassettes/Keymaker_AddNodeToIndexRequest/with_valid_options/returns_the_Neo4j_REST_API_starting_point_response_request.yml
     spec/cassettes/Keymaker_BatchRequest/when_a_resource_is_not_found/raises_BatchRequestError.yml
     spec/cassettes/Keymaker_BatchRequest/when_to_and_method_are_not_set/raises_BatchRequestError.yml
     spec/cassettes/Keymaker_BatchRequest/with_valid_options/returns_a_200_status_code.yml
     spec/cassettes/Keymaker_BatchRequest/with_valid_options/runs_the_commands_and_returns_their_respective_results.yml
+    spec/cassettes/Keymaker_CreateNodeRequest/returns_a_201_status_code.yml
+    spec/cassettes/Keymaker_CreateNodeRequest/returns_application/json.yml
+    spec/cassettes/Keymaker_CreateNodeRequest/with_properties/creates_a_node_with_the_given_properties.yml
+    spec/cassettes/Keymaker_CreateNodeRequest/without_properties/creates_an_empty_node.yml
+    spec/cassettes/Keymaker_CreateRelationshipRequest/with_invalid_options/raises_ClientError.yml
+    spec/cassettes/Keymaker_CreateRelationshipRequest/with_properties/creates_a_node_with_the_given_properties.yml
+    spec/cassettes/Keymaker_CreateRelationshipRequest/with_properties/returns_a_201_status_code.yml
+    spec/cassettes/Keymaker_CreateRelationshipRequest/with_properties/returns_application/json.yml
+    spec/cassettes/Keymaker_CreateRelationshipRequest/without_properties/creates_an_empty_relationship_of_type_birthed_.yml
+    spec/cassettes/Keymaker_DeleteRelationshipRequest/with_a_non-existent_relationship/raises_ResourceNotFound.yml
+    spec/cassettes/Keymaker_DeleteRelationshipRequest/with_an_existing_relationship/deletes_the_relationship.yml
+    spec/cassettes/Keymaker_ExecuteCypherRequest/with_a_valid_Cypher_Query/returns_a_200_status_code.yml
+    spec/cassettes/Keymaker_ExecuteCypherRequest/with_an_invalid_Cypher_Query/raises_ClientError.yml
+    spec/cassettes/Keymaker_ExecuteGremlinRequest/with_a_valid_Gremlin_Script/returns_a_200_status_code.yml
+    spec/cassettes/Keymaker_ExecuteGremlinRequest/with_an_invalid_Gremlin_Script/raises_ClientError.yml
     spec/cassettes/Keymaker_GetNodeRequest/with_a_non-existent_node_id/raises_ResourceNotFound.yml
     spec/cassettes/Keymaker_GetNodeRequest/with_an_empty_node_id/raises_ClientError.yml
     spec/cassettes/Keymaker_GetRelationshipTypesRequest/with_existing_relationships/returns_a_unique_array_of_relationship_types.yml
     spec/cassettes/Keymaker_ServiceRootRequest/returns_a_200_status_code.yml
     spec/cassettes/Keymaker_ServiceRootRequest/returns_application/json.yml
     spec/cassettes/Keymaker_ServiceRootRequest/returns_the_Neo4j_REST_API_starting_point_response_request.yml
+    spec/cassettes/Keymaker_TraversePathRequest/_traverse_path_properties/with_options/builds_the_query_properties_with_defaults.yml
+    spec/cassettes/Keymaker_TraversePathRequest/with_invalid_options/raise_a_ClientError.yml
+    spec/cassettes/Keymaker_TraversePathRequest/with_valid_options/returns_status_code_200.yml
+    spec/cassettes/Keymaker_UpdateNodePropertiesRequest/_node_properties/excludes_the_node_id.yml
+    spec/cassettes/Keymaker_UpdateNodePropertiesRequest/with_invalid_options/raises_a_ClientError.yml
+    spec/cassettes/Keymaker_UpdateNodePropertiesRequest/with_valid_options/returns_a_status_of_204.yml
+    spec/cassettes/Keymaker_UpdateNodePropertiesRequest/with_valid_options/updates_the_properties.yml
     spec/configuration_spec.rb
     spec/keymaker/requests/add_node_to_index_request_spec.rb
     spec/keymaker/requests/batch_get_nodes_request_spec.rb
     spec/keymaker/requests/batch_request_spec.rb
+    spec/keymaker/requests/create_node_request_spec.rb
+    spec/keymaker/requests/create_relationship_request_spec.rb
     spec/keymaker/requests/delete_node_request_spec.rb
+    spec/keymaker/requests/delete_relationship_request_spec.rb
+    spec/keymaker/requests/execute_cypher_request_spec.rb
+    spec/keymaker/requests/execute_gremlin_request_spec.rb
     spec/keymaker/requests/get_node_request_spec.rb
     spec/keymaker/requests/get_relationship_types_request_spec.rb
     spec/keymaker/requests/service_root_request_spec.rb
+    spec/keymaker/requests/traverse_path_request_spec.rb
+    spec/keymaker/requests/update_node_properties_request_spec.rb
+    spec/keymaker/service_spec.rb
     spec/keymaker_spec.rb
     spec/service_spec.rb
     spec/spec_helper.rb
@@ -122,7 +128,5 @@ Gem::Specification.new do |s|
   ]
   # = MANIFEST =
 
-  ## Test files will be grabbed from the file list. Make sure the path glob
-  ## matches what you actually use.
   s.test_files    = s.files.grep(%r{^spec/})
 end

data/lib/keymaker.rb

@@ -1,5 +1,6 @@
 require 'faraday'
 require 'faraday_middleware'
+require 'hashie'
 require 'active_model'
 require 'active_support/core_ext/string/inflections'
 
@@ -28,7 +29,7 @@ require 'keymaker/requests/get_relationship_types_request'
 
 require 'keymaker/requests/execute_cypher_request'
 require 'keymaker/requests/execute_gremlin_request'
-require 'keymaker/requests/path_traverse_request'
+require 'keymaker/requests/traverse_path_request'
 require 'keymaker/requests/service_root_request'
 
 require 'keymaker/indexing'
@@ -39,7 +40,7 @@ require 'keymaker/railtie' if defined? Rails::Railtie
 
 module Keymaker
 
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 
   def self.service
     @service ||= Keymaker::Service.new(Keymaker::Configuration.new)

data/lib/keymaker/configuration.rb

@@ -3,25 +3,21 @@ require "addressable/uri"
 module Keymaker
   class Configuration
 
-    attr_accessor :protocol, :server, :port,
-      :data_directory, :cypher_path, :gremlin_path,
-      :log_file, :log_enabled, :logger,
+    attr_accessor :protocol, :server, :port, :data_directory,
       :authentication, :username, :password
 
     def initialize(attrs={})
       self.protocol       = attrs.fetch(:protocol) {'http'}
       self.server         = attrs.fetch(:server) {'localhost'}
       self.port           = attrs.fetch(:port) {7474}
-      self.data_directory = attrs.fetch(:data_directory) {'db/data'}
-      self.cypher_path    = attrs.fetch(:cypher_path) {'cypher'}
-      self.gremlin_path   = attrs.fetch(:gremlin_path) {'ext/GremlinPlugin/graphdb/execute_script'}
       self.authentication = attrs.fetch(:authentication) {{}}
       self.username       = attrs.fetch(:username) {nil}
       self.password       = attrs.fetch(:password) {nil}
+      self.data_directory = 'db/data'
     end
 
     def service_root
-      service_root_url.to_s
+      @service_root ||= Keymaker.service.service_root_request.body
     end
 
     def service_root_url
@@ -47,32 +43,30 @@ module Keymaker
       end
     end
 
+    # paths
+
     def full_cypher_path
-      [service_root, data_directory, cypher_path].join("/")
+      service_root.cypher
     end
 
     def full_gremlin_path
-      [service_root, data_directory, gremlin_path].join("/")
+      service_root.extensions.fetch('GremlinPlugin', {}).fetch('execute_script', nil)
     end
 
     def node_path
-      [data_directory, "node"].join("/")
+      service_root.node
     end
 
     def node_properties_path(node_id)
-      [node_path, node_id.to_s, "properties"].join("/")
-    end
-
-    def path_traverse_node_path(node_id)
-      [node_path, node_id.to_s, "traverse", "path"].join("/")
+      [node_path, node_id.to_s, 'properties'].join('/')
     end
 
-    def batch_node_path(node_id)
-      ["/node", node_id.to_s].join("/")
+    def node_uri(node_id)
+      [node_path, node_id.to_s].join("/")
     end
 
     def batch_path
-      [data_directory, "batch"].join("/")
+      service_root.batch
     end
 
     def relationship_path(relationship_id)
@@ -80,7 +74,7 @@ module Keymaker
     end
 
     def relationship_types_path
-      [data_directory, "relationship", "types"].join("/")
+      service_root.relationship_types
     end
 
     def relationships_path_for_node(node_id)
@@ -92,11 +86,7 @@ module Keymaker
     end
 
     def node_index_path(index_name)
-      [data_directory, "index", "node", index_name.to_s].join("/")
-    end
-
-    def node_uri(node_id)
-      [service_root, node_path, node_id.to_s].join("/")
+      [service_root.node_index, index_name.to_s].join("/")
     end
 
   end

data/lib/keymaker/node.rb

@@ -96,8 +96,8 @@ module Keymaker
         neo_service.create_node(sanitize(attributes)).on_success do |response|
           self.node_id = response.neo4j_id
           self.new_node = false
-          self
         end
+        self
       end
     end
 

data/lib/keymaker/request.rb

@@ -3,7 +3,6 @@ module Keymaker
 
     extend Forwardable
 
-    def_delegator :config, :batch_node_path
     def_delegator :config, :batch_path
     def_delegator :config, :data_directory_path
     def_delegator :config, :full_cypher_path
@@ -13,7 +12,6 @@ module Keymaker
     def_delegator :config, :node_path
     def_delegator :config, :node_properties_path
     def_delegator :config, :node_uri
-    def_delegator :config, :path_traverse_node_path
     def_delegator :config, :relationship_path
     def_delegator :config, :relationships_path_for_node
     def_delegator :config, :relationship_types_path

data/lib/keymaker/requests/add_node_to_index_request.rb

@@ -2,7 +2,16 @@ module Keymaker
   class AddNodeToIndexRequest < Request
 
     def submit
-      service.post(node_index_path(opts[:index_name]), {key: opts[:key], value: opts[:value], uri: node_uri(opts[:node_id])})
+      service.post(node_index_path(opts[:index_name]), {key: opts[:key], value: opts[:value], uri: node_uri(opts[:node_id])}).on_error do |response|
+        case response.status
+        when 404
+          raise ResourceNotFound.new(response, response.body)
+        when (400..499)
+          raise ClientError.new(response, response.body)
+        when (500..599)
+          raise ServerError.new(response, response.body)
+        end
+      end
     end
 
   end

data/lib/keymaker/requests/create_relationship_request.rb

@@ -10,7 +10,14 @@ module Keymaker
   class CreateRelationshipRequest < Request
 
     def submit
-      service.post(relationships_path_for_node(opts[:node_id]), rel_properties)
+      service.post(relationships_path_for_node(opts[:node_id]), rel_properties).on_error do |response|
+        case response.status
+        when (400..499)
+          raise ClientError.new(response, response.body)
+        when (500..599)
+          raise ServerError.new(response, response.body)
+        end
+      end
     end
 
     def rel_properties

data/lib/keymaker/requests/delete_relationship_request.rb

@@ -9,7 +9,16 @@ module Keymaker
   class DeleteRelationshipRequest < Request
 
     def submit
-      service.delete(relationship_path(opts[:relationship_id]))
+      service.delete(relationship_path(opts[:relationship_id])).on_error do |response|
+        case response.status
+        when 404
+          raise ResourceNotFound.new(response, response.body)
+        when (400..499)
+          raise ClientError.new(response, response.body)
+        when (500..599)
+          raise ServerError.new(response, response.body)
+        end
+      end
     end
 
   end

data/lib/keymaker/requests/execute_cypher_request.rb

@@ -1,9 +1,14 @@
 module Keymaker
   class ExecuteCypherRequest < Request
-
     def submit
-      service.post(full_cypher_path, opts).body
+      service.post(full_cypher_path, opts).on_error do |response|
+        case response.status
+        when (400..499)
+          raise ClientError.new(response, response.body)
+        when (500..599)
+          raise ServerError.new(response, response.body)
+        end
+      end
     end
-
   end
 end

data/lib/keymaker/requests/execute_gremlin_request.rb

@@ -1,9 +1,14 @@
 module Keymaker
   class ExecuteGremlinRequest < Request
-
     def submit
-      service.post(full_gremlin_path, opts).body
+      service.post(full_gremlin_path, opts).on_error do |response|
+        case response.status
+        when (400..499)
+          raise ClientError.new(response, response.body)
+        when (500..599)
+          raise ServerError.new(response, response.body)
+        end
+      end
     end
-
   end
 end