keymaker 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in keymaker.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Rogelio J. Samour
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# Keymaker
+
+## NOTICE OF WORK IN PROGRESS
+
+A multi-layer REST API Ruby wrapper for the neo4j graph database.
+
+```
+Oracle: Our time is up. Listen to me, Neo.
+        You can save Zion if you reach The Source,
+        but to do that you will need the Keymaker.
+Neo:    The Keymaker?
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'keymaker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keymaker
+
+## Usage
+
+### Configuration
+
+```
+Coming soon
+```
+
+### Nodes
+
+```
+Coming soon
+```
+
+### Relationships
+
+```
+Coming soon
+```
+
+### Indices
+
+```
+Coming soon
+```
+
+### Querying
+
+```
+Coming soon
+```
+
+## Contributing
+
+1. Fork it
+2. Create a feature branch (`git checkout -b my_new_feature`)
+3. Write passing tests!
+3. Commit your changes (`git commit -v`)
+4. Push to the branch (`git push origin my_new_feature`)
+5. Create new Pull Request
+
+## TODO:
+
+- Test coverage
+- Helper rake tasks for development
+- Contributing documentation (installing neo4j, etc).
+- Documentation
+
+## Acknowledgements
+
+- Avdi Grimm
+- Micah Cooper
+- Stephen Caudill
+
+## Copyright
+Copyright (c) 2012 [Rogelio J. Samour](mailto:rogelio@therubymug.com)
+See [LICENSE][] for details.
+
+[license]: https://github.com/therubymug/keymaker/blob/master/LICENSE.md

data/Rakefile

@@ -0,0 +1,123 @@
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+task RSpec::Core::RakeTask.new('spec')
+
+task :default => "spec"
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/keymaker.gemspec

@@ -0,0 +1,94 @@
+# -*- 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.1'
+  s.date              = '2012-06-06'
+
+  ## 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 '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 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'ruby-debug19'
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    LICENSE.md
+    README.md
+    Rakefile
+    keymaker.gemspec
+    keymaker_integration_spec.rb
+    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/indexing.rb
+    lib/keymaker/node.rb
+    lib/keymaker/path_traverse_request.rb
+    lib/keymaker/remove_node_from_index_request.rb
+    lib/keymaker/request.rb
+    lib/keymaker/response.rb
+    lib/keymaker/serialization.rb
+    lib/keymaker/service.rb
+    lib/keymaker/update_node_properties_request.rb
+    spec/lib/keymaker_integration_spec.rb
+    spec/spec_helper.rb
+    spec/support/keymaker.rb
+  ]
+  # = 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/keymaker_integration_spec.rb

@@ -0,0 +1,182 @@
+require 'spec_helper'
+
+describe Keymaker do
+
+  include_context "John and Sarah nodes"
+
+  context "indeces" do
+    include_context "John and Sarah indexed nodes"
+
+    context "given a bad port number" do
+
+      let(:url) { john_node_url.dup.gsub("7475", "49152") }
+
+      after { service.connection = connection }
+
+      def do_it
+        connection.get(url)
+      end
+
+      it "raises an error" do
+        expect { do_it }.to raise_error
+      end
+
+    end
+
+    context "given an explicit connection" do
+
+      let(:url) { john_node_url }
+
+      before { service.connection = test_connection }
+      after { service.connection = connection }
+
+      def do_it
+        service.connection.get(url)
+      end
+
+      it "uses the connection for requests" do
+        faraday_stubs.get(Addressable::URI.parse(url).path) do
+          [200, {}, "{}"]
+        end
+        do_it
+        faraday_stubs.verify_stubbed_calls
+      end
+
+    end
+
+    describe "#add_node_to_index(index_name, key, value, node_id)" do
+
+      def do_it
+        service.add_node_to_index(:users, :email, email, node_id)
+      end
+
+      context "given existing values" do
+
+        let(:email) { john_email }
+        let(:node_id) { john_node_id }
+
+        it "adds the node to the index" do
+          do_it
+          connection.get(index_query_for_john_url).body.should be_present
+        end
+
+        it "returns a status of 201" do
+          do_it.status.should == 201
+        end
+
+      end
+
+      context "given an invalid node id" do
+
+        let(:email) { john_email }
+        let(:node_id) { -22 }
+
+        it "returns a 500 status" do
+          do_it.status.should == 500
+        end
+
+      end
+
+    end
+
+    describe "#remove_node_from_index(index_name, key, value, node_id)" do
+
+      def do_it
+        service.remove_node_from_index(:users, :email, email, node_id)
+      end
+
+      context "given existing values" do
+
+        let(:email) { john_email }
+        let(:node_id) { john_node_id }
+
+        it "removes the node from the index" do
+          do_it
+          connection.get(index_query_for_john_url).body.should be_empty
+        end
+
+        it "returns a status of 204" do
+          do_it.status.should == 204
+        end
+
+        it "keeps the other node indices" do
+          do_it
+          connection.get(index_query_for_sarah_url).body.should_not be_empty
+        end
+
+      end
+
+      context "given unmatched values" do
+
+        let(:email) { "unknown@example.com" }
+        let(:node_id) { -22 }
+
+        it "returns a 404 status" do
+          do_it.status.should == 404
+        end
+
+      end
+
+    end
+  end
+
+  describe "#execute_query" do
+
+    def do_it
+      service.execute_query("START user=node:users(email={email} RETURN user", email: john_email)
+    end
+
+    context "given existing values" do
+
+      before { service.add_node_to_index(:users, :email, john_email, john_node_id) }
+
+      it "performs the cypher query and responds" do
+        do_it.should be_present
+      end
+
+    end
+
+  end
+
+  context "nodes" do
+
+    include_context "Keymaker connections"
+
+    describe "#create_node" do
+
+      let(:properties) { { first_name: "john", last_name: "connor", email: "john@resistance.net" } }
+
+      def do_it
+        new_node_id = service.create_node(properties).neo4j_id
+        connection.get("/db/data/node/#{new_node_id}/properties").body
+      end
+
+      it "creates a node with properties" do
+        do_it.should == {"first_name"=>"john", "email"=>"john@resistance.net", "last_name"=>"connor"}
+      end
+
+    end
+
+  end
+
+  context "relationships" do
+
+    include_context "Keymaker connections"
+
+    describe "#create_relationship" do
+
+      def do_it
+        service.create_relationship(:loves, john_node_id, sarah_node_id).neo4j_id
+        connection.get("/db/data/node/#{john_node_id}/relationships/all/loves").body.first
+      end
+
+      it "creates the relationship between the two nodes" do
+        do_it["start"].should == john_node_url
+        do_it["end"].should == sarah_node_url
+      end
+
+    end
+
+  end
+
+end