neo4j-ruby-driver 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20187e624cb8b3b41c311fa3212d0464f326fd382b463a77c1943087667de719
+  data.tar.gz: 14dd13179266b82ffdca7ca880580d533d7f703fc85693486d5368f5a2db76ed
+SHA512:
+  metadata.gz: 601176c163751a2dfd9ccec38d6f266ba731533e142c138e7e77f5947dd4d27e4bc0c5ff63ec6db09070cf45fa5a590c1bed330dd8f4305a872577d40e804e46
+  data.tar.gz: 1ba727e6f43f9933eda745a48dc0d334f90b9544bf17db9b9729f0e3ee7fa4d2beea7650e61e04ba95c1aed48819f176924de599a79d28e7188e1579b045963c

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in neo4j-driver.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Heinrich Klobuczek
+
+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,68 @@
+# 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][https://neo4j.com/docs/developer-manual/3.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:
+
+```ruby
+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](https://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
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+[https://neo4j.com/docs/developer-manual/3.4/drivers/]: https://neo4j.com/docs/developer-manual/3.4/drivers/
+
+[https://neo4j.com/docs/developer-manual/3.4/drivers/]: https://neo4j.com/docs/developer-manual/3.4/drivers/

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'neo4j/rake_tasks'
+
+if RUBY_PLATFORM.match?(/java/) && ENV['SEABOLT_LIB']&.length&.positive?
+  require 'jars/installer'
+  task :install_jars do
+    Jars::Installer.vendor_jars!('jruby')
+  end
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/ffi/bolt/address.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Bolt
+  module Address
+    extend Bolt::Library
+    attach_function :create, :BoltAddress_create, %i[string string], :auto_pointer
+    attach_function :destroy, :BoltAddress_destroy, [:pointer], :void
+    attach_function :host, :BoltAddress_host, [:pointer], :strptr
+    attach_function :port, :BoltAddress_port, [:pointer], :strptr
+  end
+end

data/ffi/bolt/auth.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Bolt
+  module Auth
+    extend Bolt::Library
+    attach_function :basic, :BoltAuth_basic, %i[string string string], :auto_pointer,
+                    releaser: Bolt::Value.method(:destroy)
+    attach_function :none, :BoltAuth_none, [], :auto_pointer, releaser: Bolt::Value.method(:destroy)
+  end
+end

data/ffi/bolt/auto_releasable.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Bolt
+  module AutoReleasable
+    def attach_function(name, func, args, returns = nil, options = nil)
+      return super unless returns == :auto_pointer
+
+      super(name, func, args, :pointer, options)
+      singleton_class.prepend with_auto_releaser(name, options&.dig(:releaser))
+    end
+
+    private
+
+    def with_auto_releaser(method, releaser)
+      Module.new do
+        define_method(method) do |*args|
+          FFI::AutoPointer.new(super(*args), releaser || self.method(:destroy))
+        end
+      end
+    end
+  end
+end

data/ffi/bolt/boolean.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Bolt
+  module Boolean
+    extend Bolt::Library
+
+    attach_function :get, :BoltBoolean_get, %i[pointer], :char
+  end
+end

data/ffi/bolt/bytes.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Bolt
+  module Bytes
+    extend Bolt::Library
+
+    attach_function :get, :BoltBytes_get, %i[pointer int32], :char
+    attach_function :get_all, :BoltBytes_get_all, %i[pointer], :pointer
+  end
+end

data/ffi/bolt/config.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Bolt
+  module Config
+    extend Bolt::Library
+    attach_function :create, :BoltConfig_create, [], :auto_pointer
+    attach_function :destroy, :BoltConfig_destroy, [:pointer], :void
+    attach_function :set_user_agent, :BoltConfig_set_user_agent, %i[pointer string], :int32
+  end
+end

data/ffi/bolt/connection.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Bolt
+  module Connection
+    extend Bolt::Library
+
+    typedef :uint64, :bolt_request
+
+    attach_function :flush, :BoltConnection_send, [:pointer], :int32
+    attach_function :fetch, :BoltConnection_fetch, %i[pointer bolt_request], :int32
+    attach_function :fetch_summary, :BoltConnection_fetch_summary, %i[pointer bolt_request], :int32
+    attach_function :clear_begin, :BoltConnection_clear_begin, %i[pointer], :int32
+    attach_function :set_begin_bookmarks, :BoltConnection_set_begin_bookmarks, %i[pointer pointer], :int32
+    attach_function :set_begin_tx_timeout, :BoltConnection_set_begin_tx_timeout, %i[pointer int64], :int32
+    attach_function :set_begin_tx_metadata, :BoltConnection_set_begin_tx_metadata, %i[pointer pointer], :int32
+    attach_function :load_begin_request, :BoltConnection_load_begin_request, %i[pointer], :int32
+    attach_function :load_commit_request, :BoltConnection_load_commit_request, %i[pointer], :int32
+    attach_function :load_rollback_request, :BoltConnection_load_rollback_request, %i[pointer], :int32
+    attach_function :clear_run, :BoltConnection_clear_run, %i[pointer], :int32
+    attach_function :set_run_bookmarks, :BoltConnection_set_run_bookmarks, %i[pointer pointer], :int32
+    attach_function :set_run_tx_timeout, :BoltConnection_set_run_tx_timeout, %i[pointer int64], :int32
+    attach_function :set_run_tx_metadata, :BoltConnection_set_run_tx_metadata, %i[pointer pointer], :int32
+    attach_function :set_run_cypher, :BoltConnection_set_run_cypher, %i[pointer string uint64 int32], :int32
+    attach_function :set_run_cypher_parameter, :BoltConnection_set_run_cypher_parameter,
+                    %i[pointer int32 string uint64], :pointer
+    attach_function :load_run_request, :BoltConnection_load_run_request, [:pointer], :int32
+    attach_function :load_discard_request, :BoltConnection_load_discard_request, %i[pointer int32], :int32
+    attach_function :load_pull_request, :BoltConnection_load_pull_request, %i[pointer int32], :int32
+    attach_function :load_reset_request, :BoltConnection_load_reset_request, [:pointer], :int32
+    attach_function :last_request, :BoltConnection_last_request, [:pointer], :bolt_request
+    attach_function :server, :BoltConnection_server, %i[pointer], :strptr
+    attach_function :id, :BoltConnection_id, %i[pointer], :strptr
+    attach_function :address, :BoltConnection_address, %i[pointer], :pointer
+    attach_function :remote_endpoint, :BoltConnection_remote_endpoint, %i[pointer], :pointer
+    attach_function :local_endpoint, :BoltConnection_local_endpoint, %i[pointer], :pointer
+    attach_function :last_bookmark, :BoltConnection_last_bookmark, %i[pointer], :strptr
+    attach_function :summary_success, :BoltConnection_summary_success, [:pointer], :int32
+    attach_function :failure, :BoltConnection_failure, [:pointer], :pointer
+    attach_function :field_names, :BoltConnection_field_names, [:pointer], :pointer
+    attach_function :field_values, :BoltConnection_field_values, [:pointer], :pointer
+    attach_function :metadata, :BoltConnection_metadata, %i[pointer], :pointer
+    attach_function :status, :BoltConnection_status, [:pointer], :pointer
+  end
+end

data/ffi/bolt/connector.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Bolt
+  module Connector
+    extend Bolt::Library
+
+    BoltAccessMode = enum(
+      :bolt_access_mode_write,
+      :bolt_access_mode_read
+    )
+
+    attach_function :create, :BoltConnector_create, %i[pointer pointer pointer], :pointer
+    attach_function :destroy, :BoltConnector_destroy, [:pointer], :void
+    attach_function :acquire, :BoltConnector_acquire, [:pointer, BoltAccessMode, :pointer], :pointer
+    attach_function :release, :BoltConnector_release, %i[pointer pointer], :void
+  end
+end

data/ffi/bolt/dictionary.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Bolt
+  module Dictionary
+    extend Bolt::Library
+
+    attach_function :key, :BoltDictionary_key, %i[pointer int32], :pointer
+    attach_function :get_key, :BoltDictionary_get_key, %i[pointer int32], :pointer
+    attach_function :get_key_size, :BoltDictionary_get_key_size, %i[pointer int32], :int32
+    attach_function :get_key_index, :BoltDictionary_get_key_index, %i[pointer string int32 int32], :int32
+    attach_function :set_key, :BoltDictionary_set_key, %i[pointer int32 string int32], :int32
+    attach_function :value, :BoltDictionary_value, %i[pointer int32], :pointer
+    attach_function :value_by_key, :BoltDictionary_value_by_key, %i[pointer string int32], :pointer
+  end
+end

data/ffi/bolt/error.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Bolt
+  module Error
+    extend Bolt::Library
+
+    # Identifies a successful operation which is defined as 0
+    BOLT_SUCCESS = 0
+    # Unknown error
+    BOLT_UNKNOWN_ERROR = 1
+    # Unsupported protocol or address family
+    BOLT_UNSUPPORTED = 2
+    # Operation interrupted
+    BOLT_INTERRUPTED = 3
+    # Connection reset by peer
+    BOLT_CONNECTION_RESET = 4
+    # No valid resolved addresses found to connect
+    BOLT_NO_VALID_ADDRESS = 5
+    # Operation timed out
+    BOLT_TIMED_OUT = 6
+    # Permission denied
+    BOLT_PERMISSION_DENIED = 7
+    # Too may open files
+    BOLT_OUT_OF_FILES = 8
+    # Out of memory
+    BOLT_OUT_OF_MEMORY = 9
+    # Too many open ports
+    BOLT_OUT_OF_PORTS = 10
+    # Connection refused
+    BOLT_CONNECTION_REFUSED = 11
+    # Network unreachable
+    BOLT_NETWORK_UNREACHABLE = 12
+    # An unknown TLS error
+    BOLT_TLS_ERROR = 13
+    # Connection closed by remote peer
+    BOLT_END_OF_TRANSMISSION = 15
+    # Server returned a FAILURE message, more info available through \ref BoltConnection_failure
+    BOLT_SERVER_FAILURE = 16
+    # Unsupported bolt transport
+    BOLT_TRANSPORT_UNSUPPORTED = 0x400
+    # Unsupported protocol usage
+    BOLT_PROTOCOL_VIOLATION = 0x500
+    # Unsupported bolt type
+    BOLT_PROTOCOL_UNSUPPORTED_TYPE = 0x501
+    # Unknown pack stream type
+    BOLT_PROTOCOL_NOT_IMPLEMENTED_TYPE = 0x502
+    # Unexpected marker
+    BOLT_PROTOCOL_UNEXPECTED_MARKER = 0x503
+    # Unsupported bolt protocol version
+    BOLT_PROTOCOL_UNSUPPORTED = 0x504
+    # Connection pool is full
+    BOLT_POOL_FULL = 0x600
+    # Connection acquisition from the connection pool timed out
+    BOLT_POOL_ACQUISITION_TIMED_OUT = 0x601
+    # Address resolution failed
+    BOLT_ADDRESS_NOT_RESOLVED = 0x700
+    # Routing table retrieval failed
+    BOLT_ROUTING_UNABLE_TO_RETRIEVE_ROUTING_TABLE = 0x800
+    # No servers to select for the requested operation
+    BOLT_ROUTING_NO_SERVERS_TO_SELECT = 0x801
+    # Connection pool construction for server failed
+    BOLT_ROUTING_UNABLE_TO_CONSTRUCT_POOL_FOR_SERVER = 0x802
+    # Routing table refresh failed
+    BOLT_ROUTING_UNABLE_TO_REFRESH_ROUTING_TABLE = 0x803
+    # Invalid discovery response
+    BOLT_ROUTING_UNEXPECTED_DISCOVERY_RESPONSE = 0x804
+    # Error set in connection
+    BOLT_CONNECTION_HAS_MORE_INFO = 0xFFE
+    # Error set in connection
+    BOLT_STATUS_SET = 0xFFF
+
+    attach_function :get_string, :BoltError_get_string, [:int32], :string
+  end
+end

data/ffi/bolt/float.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Bolt
+  module Float
+    extend Bolt::Library
+
+    attach_function :get, :BoltFloat_get, %i[pointer], :double
+  end
+end

data/ffi/bolt/integer.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Bolt
+  module Integer
+    extend Bolt::Library
+
+    attach_function :get, :BoltInteger_get, %i[pointer], :int64
+  end
+end

data/ffi/bolt/library.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Bolt
+  module Library
+    include FFI::Library
+    include Bolt::AutoReleasable
+
+    def self.extended(mod)
+      mod.ffi_lib ENV['SEABOLT_LIB']
+    end
+  end
+end

data/ffi/bolt/lifecycle.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Bolt
+  module Lifecycle
+    extend Bolt::Library
+    attach_function :startup, :Bolt_startup, [], :void
+    attach_function :shutdown, :Bolt_shutdown, [], :void
+  end
+end

data/ffi/bolt/list.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Bolt
+  module List
+    extend Bolt::Library
+
+    attach_function :resize, :BoltList_resize, %i[pointer int32], :void
+    attach_function :value, :BoltList_value, %i[pointer int32], :pointer
+  end
+end

data/ffi/bolt/status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Bolt
+  module Status
+    extend Bolt::Library
+
+    typedef :int32, :bolt_connection_state
+
+    attach_function :create, :BoltStatus_create, [], :auto_pointer
+    attach_function :destroy, :BoltStatus_destroy, [:pointer], :void
+    attach_function :get_state, :BoltStatus_get_state, [:pointer], :bolt_connection_state
+    attach_function :get_error, :BoltStatus_get_error, [:pointer], :int32
+    attach_function :get_error_context, :BoltStatus_get_error_context, [:pointer], :string
+  end
+end

data/ffi/bolt/string.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Bolt
+  module String
+    extend Bolt::Library
+
+    attach_function :get, :BoltString_get, [:pointer], :pointer
+  end
+end