keymaker 0.0.7 → 0.0.8

data/README.md

@@ -1,8 +1,6 @@
 # Keymaker
 
-## NOTICE OF WORK IN PROGRESS
-
-A multi-layer REST API Ruby wrapper for the neo4j graph database.
+A multi-layer REST API Ruby wrapper for the Neo4j graph database built on top of [Faraday][].
 
 ```
 Oracle: Our time is up. Listen to me, Neo.
@@ -13,24 +11,86 @@ Neo:    The Keymaker?
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install and start the Neo4j server:
 
-    gem 'keymaker'
+```ruby
+rake neo4j:install
+rake neo4j:start
+# optionally for testing
+rake neo4j:install RAILS_ENV=test
+rake neo4j:start RAILS_ENV=test
+```
 
-And then execute:
+Add this line to your application's Gemfile:
 
-    $ bundle
+```ruby
+gem 'keymaker'
+```
 
-Or install it yourself as:
+And then execute:
 
-    $ gem install keymaker
+```
+$ bundle
+```
 
 ## Usage
 
 ### Configuration
 
+Create a `config/neo4j.yml` file:
+
+```ruby
+development:
+  server: localhost
+  port: 7474
+test:
+  server: localhost
+  port: 7475
 ```
-Coming soon
+
+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')
+  Keymaker.configure do |c|
+    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']
+  end
+end
+```
+
+### Low-level REST API Calls
+
+```ruby
+
+Keymaker.configure do |c|
+  c.server = "localhost"
+  c.port = 7474
+end
+
+## Create a node ##
+
+response = Keymaker.service.create_node_request({:name => 'John Connor', :catch_phrase => 'No problemo'})
+
+## Update node properties ##
+
+## Delete a node ##
+
+## Create a relationship ##
+
+## Update relationship properties ##
+
+## Delete a relationship ##
+
 ```
 
 ### Nodes
@@ -69,7 +129,6 @@ Coming soon
 ## TODO:
 
 - Test coverage
-- Helper rake tasks for development
 - Contributing documentation (installing neo4j, etc).
 - Documentation
 
@@ -85,3 +144,4 @@ Copyright (c) 2012 [Rogelio J. Samour](mailto:rogelio@therubymug.com)
 See [LICENSE][] for details.
 
 [license]: https://github.com/therubymug/keymaker/blob/master/LICENSE.md
+[faraday]: https://github.com/technoweenie/faraday

data/Rakefile

@@ -127,7 +127,7 @@ end
 #
 #############################################################################
 
-KEYMAKER_ROOT = File.expand_path(File.dirname(__FILE__) + '/../..')
+KEYMAKER_ROOT = File.expand_path(File.dirname(__FILE__))
 KEYMAKER_TMP_DIR = File.expand_path(File.join(KEYMAKER_ROOT, "tmp"))
 NEO4J_INSTALL_DIR = ENV['NEO4J_INSTALL_DIR'] || File.expand_path(File.join(KEYMAKER_TMP_DIR, "keymaker_development"))
 NEO4J_PORT = ENV['NEO4J_PORT'] || '7477' # Don't clobber standard neo4j ports 7474 or 7475 for development

data/keymaker.gemspec

@@ -14,8 +14,8 @@ Gem::Specification.new do |s|
   ## 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.7'
-  s.date              = '2012-06-15'
+  s.version           = '0.0.8'
+  s.date              = '2012-07-19'
 
   ## Make sure your summary is short. The description may be as long
   ## as you like.
@@ -41,17 +41,20 @@ Gem::Specification.new do |s|
   ## 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 'faraday'
   s.add_dependency 'faraday_middleware'
-  s.add_dependency 'activemodel'
 
   ## 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'
   s.add_development_dependency 'ruby-debug19'
+  s.add_development_dependency 'vcr'
 
   ## Leave this section as-is. It will be automatically generated from the
   ## contents of your Git repository via the gemspec task. DO NOT REMOVE
@@ -64,30 +67,58 @@ Gem::Specification.new do |s|
     Rakefile
     keymaker.gemspec
     lib/keymaker.rb
-    lib/keymaker/add_node_to_index_request.rb
-    lib/keymaker/batch_get_nodes_request.rb
     lib/keymaker/configuration.rb
-    lib/keymaker/create_node_request.rb
-    lib/keymaker/create_relationship_request.rb
-    lib/keymaker/delete_relationship_request.rb
-    lib/keymaker/execute_cypher_request.rb
-    lib/keymaker/execute_gremlin_request.rb
+    lib/keymaker/errors.rb
     lib/keymaker/indexing.rb
+    lib/keymaker/match_method.rb
     lib/keymaker/node.rb
-    lib/keymaker/path_traverse_request.rb
     lib/keymaker/rails_tasks.rb
     lib/keymaker/railtie.rb
-    lib/keymaker/remove_node_from_index_request.rb
     lib/keymaker/request.rb
+    lib/keymaker/requests/add_node_to_index_request.rb
+    lib/keymaker/requests/batch_get_nodes_request.rb
+    lib/keymaker/requests/batch_request.rb
+    lib/keymaker/requests/create_node_request.rb
+    lib/keymaker/requests/create_relationship_request.rb
+    lib/keymaker/requests/delete_node_request.rb
+    lib/keymaker/requests/delete_relationship_request.rb
+    lib/keymaker/requests/execute_cypher_request.rb
+    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/update_node_properties_request.rb
     lib/keymaker/response.rb
     lib/keymaker/serialization.rb
     lib/keymaker/service.rb
-    lib/keymaker/update_node_properties_request.rb
-    spec/keymaker/configuration_spec.rb
-    spec/keymaker/service_spec.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_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_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/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/delete_node_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_spec.rb
+    spec/service_spec.rb
     spec/spec_helper.rb
     spec/support/keymaker.rb
+    spec/support/vcr.rb
   ]
   # = MANIFEST =
 

data/lib/keymaker.rb

@@ -1,22 +1,35 @@
 require 'faraday'
 require 'faraday_middleware'
 require 'active_model'
+require 'active_support/core_ext/string/inflections'
 
-require 'keymaker/request'
+require 'keymaker/match_method'
+require 'keymaker/errors'
 require 'keymaker/response'
 require 'keymaker/configuration'
 require 'keymaker/service'
 
-require 'keymaker/add_node_to_index_request'
-require 'keymaker/batch_get_nodes_request'
-require 'keymaker/create_node_request'
-require 'keymaker/create_relationship_request'
-require 'keymaker/delete_relationship_request'
-require 'keymaker/execute_cypher_request'
-require 'keymaker/execute_gremlin_request'
-require 'keymaker/path_traverse_request'
-require 'keymaker/remove_node_from_index_request'
-require 'keymaker/update_node_properties_request'
+require 'keymaker/request'
+
+require 'keymaker/requests/batch_request'
+require 'keymaker/requests/batch_get_nodes_request'
+
+require 'keymaker/requests/create_node_request'
+require 'keymaker/requests/delete_node_request'
+require 'keymaker/requests/get_node_request'
+
+require 'keymaker/requests/add_node_to_index_request'
+require 'keymaker/requests/remove_node_from_index_request'
+require 'keymaker/requests/update_node_properties_request'
+
+require 'keymaker/requests/create_relationship_request'
+require 'keymaker/requests/delete_relationship_request'
+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/service_root_request'
 
 require 'keymaker/indexing'
 require 'keymaker/serialization'
@@ -26,7 +39,7 @@ require 'keymaker/railtie' if defined? Rails::Railtie
 
 module Keymaker
 
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 
   def self.service
     @service ||= Keymaker::Service.new(Keymaker::Configuration.new)

data/lib/keymaker/configuration.rb

@@ -79,6 +79,10 @@ module Keymaker
       [data_directory, "relationship", relationship_id.to_s].join("/")
     end
 
+    def relationship_types_path
+      [data_directory, "relationship", "types"].join("/")
+    end
+
     def relationships_path_for_node(node_id)
       [node_path, node_id.to_s, "relationships"].join("/")
     end

data/lib/keymaker/errors.rb

@@ -0,0 +1,22 @@
+require 'forwardable'
+
+module Keymaker
+  class Error < StandardError; end
+  class HttpError < Error
+    extend Forwardable
+
+    attr_reader :response
+
+    def_delegator :response, :status
+
+    def initialize(response, message=response.status.to_s)
+      @response = response
+      super(message)
+    end
+  end
+  class ClientError < HttpError; end
+  class ConflictError < ClientError; end
+  class ResourceNotFound < ClientError; end
+  class ServerError < HttpError; end
+  class BatchRequestError < ServerError; end
+end

data/lib/keymaker/match_method.rb

@@ -0,0 +1,24 @@
+# Avdi's magic sauce
+module Keymaker
+  module MatchMethodMacros
+    def match_method(matcher, &method_body)
+      mod = Module.new do
+        define_method(:method_missing) do |method_name, *args|
+          if matcher === method_name.to_s
+            instance_exec(method_name, *args, &method_body)
+          else
+            super(method_name, *args)
+          end
+        end
+
+        define_method(:respond_to_missing?) do |method_name, include_private|
+          # Even though this is in the #respond_to_missing? hook we
+          # still need to call 'super' in case there are other included
+          # modules which also define #respond_to_missing?
+          (matcher === method_name) || super(method_name, include_private)
+        end
+      end
+      include mod
+    end
+  end
+end

data/lib/keymaker/request.rb

@@ -3,9 +3,9 @@ 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
     def_delegator :config, :full_gremlin_path
     def_delegator :config, :node_full_index_path
@@ -16,6 +16,7 @@ module Keymaker
     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
 
     def_delegator :response, :body
     def_delegator :response, :status

data/lib/keymaker/requests/batch_get_nodes_request.rb

@@ -0,0 +1,24 @@
+module Keymaker
+
+  class BatchGetNodesRequest < BatchRequest
+
+    attr_accessor :node_ids
+
+    def initialize(service, node_ids)
+      self.config = service.config
+      self.node_ids = node_ids
+      self.service = service
+      self.opts = build_job_descriptions_collection
+    end
+
+    def build_job_descriptions_collection
+      [].tap do |batch_jobs|
+        node_ids.each_with_index do |node_id, job_id|
+          batch_jobs << {id: job_id, to: node_uri(node_id), method: "GET"}
+        end
+      end
+    end
+
+  end
+
+end

data/lib/keymaker/requests/batch_request.rb

@@ -0,0 +1,18 @@
+module Keymaker
+
+  class BatchRequest < Request
+
+    def submit
+      service.post(batch_path, opts).on_error do |response|
+        case response.status
+        when (400..499)
+          raise ClientError.new(response, response.body)
+        when (500..599)
+          raise BatchRequestError.new(response, response.body)
+        end
+      end
+    end
+
+  end
+
+end

data/lib/keymaker/requests/delete_node_request.rb

@@ -0,0 +1,18 @@
+module Keymaker
+  class DeleteNodeRequest < Request
+    def submit
+      service.delete(node_uri(opts[:node_id])).on_error do |response|
+        case response.status
+        when 404
+          raise ResourceNotFound.new(response, response.body)
+        when 409
+          raise ConflictError.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
+end