neo4j_bolt 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38ed2e6727f1bc4baccc838b195d72a2392bbb82788598d704a1e81bd0f20de0
-  data.tar.gz: d781a67c3eee09dd9e32a9af60fe1fb65a61bb8afddb96307dd897cbcd99ddf1
+  metadata.gz: e6322e3f763f052647f81029aaa96e45d6cb6f41a8e8d625c198d025b1408a81
+  data.tar.gz: ddf55ab34e93f5b65b36273a2c148037f4455e18252aba692296e52598668902
 SHA512:
-  metadata.gz: e1d4c318c5adb68878da6368dc8d694a63c79cc953ab0e87ffe5aceaf77ce9d47d06b35a80cef8ea835ac90e6753974a59c2bb2bd9088f144fdf8761976b9b8a
-  data.tar.gz: d28fd8341cbbfe89391c7685331ed8fc666864edb7222f8ccb3530ddd3e93b2bad68d9fa6ebdf75049cad99c8d68926b356e3b55fadcb795e017dfc0be9d0f22
+  metadata.gz: bff514f49ee709624ac1b178e2216edd001ad168845c397aff2f9d28a3d3752a4c3fcbf0d7f9ea4bc6c0a1f68ffd6feef8fae560127774c0aa0277a4d6cf6ffd
+  data.tar.gz: d5ef2dbebc19f6f1538ee461993ec20a9184b734ba4b490ca6a941f4de7b2cb526f22ad59daa9f8578afee00f0be25728c16eed29f6ddfab1a581901b8eabb42

data/README.md

@@ -4,14 +4,14 @@ Neo4jBolt 0.4 is a small compatibility and convenience layer for Ruby applicatio
 
 Neo4jBolt no longer implements the Bolt wire protocol itself.
 
-`0.4.0` requires Ruby 3.4 or newer and pins `neo4j-ruby-driver` to `6.2.1.beta.4`. Applications on older Rubies can remain on the Neo4jBolt 0.3.x line; this prerelease is intentionally not an automatic upgrade for them.
+`0.4.4` requires Ruby 3.4 or newer and pins `neo4j-ruby-driver` to `6.2.1.beta.4`. Applications on older Rubies can remain on the Neo4jBolt 0.3.x line; this prerelease is intentionally not an automatic upgrade for them.
 
 ## Installation
 
 For this prerelease, specify the version explicitly:
 
 ```ruby
-gem "neo4j_bolt", "0.4.0"
+gem "neo4j_bolt", "0.4.4"
 ```
 
 Then run `bundle install`. A running Neo4j database is required.
@@ -26,6 +26,24 @@ Neo4jBolt.bolt_port = 7687
 Neo4jBolt.bolt_verbosity = 0
 ```
 
+Authentication and database selection can use the standard Neo4j client environment variables:
+
+```bash
+export NEO4J_USERNAME=neo4j
+export NEO4J_PASSWORD=secret
+export NEO4J_DATABASE=neo4j
+```
+
+They are read when `neo4j_bolt` is loaded. Explicit Ruby configuration overrides those defaults:
+
+```ruby
+Neo4jBolt.bolt_username = "neo4j"
+Neo4jBolt.bolt_password = "secret"
+Neo4jBolt.bolt_database = "movies"
+```
+
+If both username and password are unset, Neo4jBolt keeps the existing unauthenticated connection behavior. If only one is set, the first query raises `Neo4jBolt::Error`. Leaving the database unset lets Neo4j choose the user's/server's default database.
+
 Applications can include the module as before:
 
 ```ruby
@@ -36,7 +54,7 @@ They can also extend another object or call the convenience methods directly on
 
 One lazily initialized upstream driver owns a thread-safe connection pool. Each standalone query uses a short-lived session and returns its connection to that pool after its result has been consumed. Queries from several Puma threads are not globally serialized.
 
-`cleanup_neo4j` safely retires the driver and its pool after active operations finish. A later query creates a new driver. Do not call cleanup from inside an active query or transaction on the same thread.
+`cleanup_neo4j` safely retires the driver and its pool after active operations finish. A later query creates a new driver. Changing host, port, username, or password also retires the pool so later connections use the new settings. Database selection is a session setting and therefore applies to newly opened sessions without rebuilding the driver. Do not call cleanup from inside an active query or transaction on the same thread.
 
 ## Running queries
 
@@ -188,7 +206,7 @@ The `neo4j_bolt` executable retains these commands:
 | `neo4j_bolt index rm --force` | Remove all constraints and indexes |
 | `neo4j_bolt visualize` | Generate a GraphViz document |
 
-Use `--host HOST:PORT` to select a server. `gli` remains a runtime dependency for the CLI, and `pry` remains for the separate `bin/console` executable.
+Use `--host HOST:PORT`, `--username USER`, `--password PASSWORD`, and `--database DATABASE` to override connection settings. Username, password, and database otherwise inherit `NEO4J_USERNAME`, `NEO4J_PASSWORD`, and `NEO4J_DATABASE`. Prefer the password environment variable for routine use because command-line arguments may be visible in shell history or process listings. `gli` remains a runtime dependency for the CLI, and `pry` remains for the separate `bin/console` executable.
 
 ## Tested Neo4j versions
 
@@ -198,7 +216,7 @@ The same complete integration suite is run against these exact Community images:
 - `neo4j:5.26.28-community`
 - `neo4j:2026.06.0-community`
 
-No compatibility beyond this matrix is claimed for `0.4.0`.
+No compatibility beyond this matrix is claimed for `0.4.4`.
 
 Run one modern LTS target:
 
@@ -212,15 +230,16 @@ Run the complete sequential matrix:
 bundle exec rake spec:matrix
 ```
 
-The harness creates uniquely named disposable containers with `NEO4J_AUTH=none`, dynamically publishes Bolt ports, waits by establishing a real driver/query connection, and cleans every container through shell traps. A developer does not need to start Neo4j manually.
+The harness creates uniquely named disposable containers with Basic authentication enabled, dynamically publishes Bolt ports, waits by establishing a real driver/query connection, and cleans every container through shell traps. A developer does not need to start Neo4j manually.
 
-To point RSpec itself at an already disposable database, set `NEO4J_BOLT_TEST_HOST` and `NEO4J_BOLT_TEST_PORT`. The explicit port requirement protects real databases from the destructive integration suite.
+To point RSpec itself at an already disposable database, set `NEO4J_BOLT_TEST_HOST` and `NEO4J_BOLT_TEST_PORT`. If it requires authentication or an explicit database, also set `NEO4J_USERNAME`, `NEO4J_PASSWORD`, and `NEO4J_DATABASE`. The explicit port requirement protects real databases from the destructive integration suite.
 
 ## Compatibility inventory for 0.4
 
 | API | Status |
 | --- | --- |
 | `bolt_host`, `bolt_port`, `bolt_verbosity` | Preserved |
+| `bolt_username`, `bolt_password`, `bolt_database` | Additive authentication/database configuration |
 | Included/extended/module-style use | Preserved |
 | `neo4j_query`, including incremental block form | Preserved via adapter |
 | `neo4j_query_expect_one` | Preserved via adapter |
@@ -235,12 +254,13 @@ To point RSpec itself at an already disposable database, set `NEO4J_BOLT_TEST_HO
 | CLI commands | Preserved |
 | `BoltSocket`, `BoltBuffer`, protocol markers/state/parser/packer | Intentionally removed private implementation details |
 
-## 0.4.0 migration notes
+## 0.4.4 migration notes
 
 - Ruby 3.4 or newer is required; Ruby 2.x/3.0–3.3 applications should stay on 0.3.x until upgraded.
 - The exact prerelease upstream dependency is pinned while no stable `neo4j-ruby-driver` 6.2.x exists.
 - Connections are pooled and safe for concurrent use instead of one mutable socket per including object.
-- TLS, routing, authentication, database selection, and other upstream-driver configuration are not newly exposed through the legacy three-setting API in this compatibility prerelease.
+- Basic authentication and database selection are now exposed through `bolt_username`, `bolt_password`, and `bolt_database`, with `NEO4J_USERNAME`, `NEO4J_PASSWORD`, and `NEO4J_DATABASE` as environment defaults.
+- TLS, routing, URI schemes, and other upstream-driver configuration are still not exposed through the compatibility API.
 - `BoltSocket`, `BoltBuffer`, `ServerState`, `BoltMarker`, `UnexpectedServerResponse`, `State`, and `CypherError` were undocumented wire internals and are removed.
 
 ## Development

data/bin/neo4j_bolt

@@ -22,12 +22,18 @@ class App
 
     flag [:v, :verbosity], :default_value => 0
     flag [:h, :host], :default_value => 'localhost:7687'
+    flag [:u, :username], :default_value => nil, :desc => 'Neo4j username (default: NEO4J_USERNAME)'
+    flag [:p, :password], :default_value => nil, :desc => 'Neo4j password (default: NEO4J_PASSWORD)'
+    flag [:d, :database], :default_value => nil, :desc => 'Neo4j database (default: NEO4J_DATABASE)'
 
     pre do |global_options, command, options, args|
         host = global_options[:host]
         Neo4jBolt.bolt_host = host.split(':').first
         Neo4jBolt.bolt_port = host.split(':').last.to_i
         Neo4jBolt.bolt_verbosity = global_options[:verbosity].to_i
+        Neo4jBolt.bolt_username = global_options[:username] unless global_options[:username].nil?
+        Neo4jBolt.bolt_password = global_options[:password] unless global_options[:password].nil?
+        Neo4jBolt.bolt_database = global_options[:database] unless global_options[:database].nil?
         true
     end
 

data/lib/neo4j_bolt/version.rb

@@ -1,3 +1,3 @@
 module Neo4jBolt
-    VERSION = "0.4.3"
+    VERSION = "0.4.4"
 end

data/lib/neo4j_bolt.rb

@@ -335,10 +335,22 @@ module Neo4jBolt
         host = "[#{host}]" if host.include?(":") && !host.start_with?("[")
         Neo4j::Driver::GraphDatabase.driver(
           "bolt://#{host}:#{Neo4jBolt.bolt_port}",
-          Neo4j::Driver::AuthTokens.none
+          authentication_token
         )
       end
 
+      def authentication_token
+        username = Neo4jBolt.bolt_username
+        password = Neo4jBolt.bolt_password
+        return Neo4j::Driver::AuthTokens.none if username.nil? && password.nil?
+
+        if username.nil? || password.nil?
+          raise Error, "Neo4j username and password must either both be set or both be unset"
+        end
+
+        Neo4j::Driver::AuthTokens.basic(username, password)
+      end
+
       def leases
         @leases ||= 0
       end
@@ -354,8 +366,8 @@ module Neo4jBolt
   end
 
   class << self
-    attr_reader :bolt_host, :bolt_port
-    attr_accessor :bolt_verbosity
+    attr_reader :bolt_host, :bolt_port, :bolt_username, :bolt_password
+    attr_accessor :bolt_verbosity, :bolt_database
 
     def bolt_host=(host)
       reconfigure_driver if defined?(@bolt_host) && @bolt_host != host
@@ -367,6 +379,16 @@ module Neo4jBolt
       @bolt_port = port
     end
 
+    def bolt_username=(username)
+      reconfigure_driver if defined?(@bolt_username) && @bolt_username != username
+      @bolt_username = username
+    end
+
+    def bolt_password=(password)
+      reconfigure_driver if defined?(@bolt_password) && @bolt_password != password
+      @bolt_password = password
+    end
+
     private
 
     def reconfigure_driver
@@ -377,10 +399,23 @@ module Neo4jBolt
   self.bolt_host = "localhost"
   self.bolt_port = 7687
   self.bolt_verbosity = 0
+  self.bolt_username = ENV["NEO4J_USERNAME"]
+  self.bolt_password = ENV["NEO4J_PASSWORD"]
+  self.bolt_database = ENV["NEO4J_DATABASE"]
 
   # Keep both `include Neo4jBolt` and direct module-style calls working.
   extend self
 
+  def with_session(driver)
+    database = Neo4jBolt.bolt_database
+    if database.nil?
+      driver.session { |session| yield session }
+    else
+      driver.session(database: database) { |session| yield session }
+    end
+  end
+  private :with_session
+
   def neo4j_query(query, data = {}, &block)
     validate_parameters!(data)
     log_query(query, data)
@@ -390,7 +425,7 @@ module Neo4jBolt
       run_and_convert(context.transaction, query, data, &block)
     else
       DriverRegistry.with_driver do |driver|
-        driver.session do |session|
+        with_session(driver) do |session|
           run_and_convert(session, query, data, &block)
         end
       end
@@ -430,7 +465,7 @@ module Neo4jBolt
     end
 
     DriverRegistry.with_driver do |driver|
-      driver.session do |session|
+      with_session(driver) do |session|
         upstream_transaction = session.begin_transaction
         context = TransactionContext.new(
           session: session, transaction: upstream_transaction, depth: 1, rollback_only: false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neo4j_bolt
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Michael Specht