Neo4j::Driver

Proposal for an API for neo4j ruby driver. This gem contains reference implementation in jruby with most of the features completed. The proposed API is heavilly inspired but the java and javascipt driver. Please add comments and suggestions if you feel there is better idiomatic alternative in ruby.

The file doc/dev_manual_examples_spec.rb contains all the code examples included in the Chapter 4. Drivers of the Developer Manual and should be reviewed side by side with that manual.

Installation

Add this line to your application's Gemfile:

gem 'neo4j-ruby-driver'

And then execute:

$ bundle

Or install it yourself as:

$ gem install neo4j-ruby-driver

Usage

Refer to https://neo4j.com/docs/developer-manual/3.4/drivers/.

Development

After checking out the repo, run bin/setup to install dependencies. In order to run test by running rake spec you may have to set your own NEO4J_BOLT_URL URI or it will fallback to bolt://localhost:7687. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

This gem includes 2 different implementations: java driver based and another one using seabolt via ffi

For java driver based:

$ rvm use jruby-9.2.5.0
$ bundle
$ rspec

FFI based:

$ rvm use 2.5.3 # or jruby-9.2.5.0
$ SEABOLT_LIB=~/seabolt/build/dist/lib/libseabolt17.dylib bundle
$ SEABOLT_LIB=~/seabolt/build/dist/lib/libseabolt17.dylib rspec

Please note that seabolt for now has to be installed separately: https://github.com/neo4j-drivers/seabolt

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/neo4j-driver.

License