Merge pull request #6 from doximity/bls-improve-README-on-config

Clarify configuration and ENV values

Author: bsimpson

CHANGELOG.md

@@ -1,6 +1,9 @@
 Changelog
 =========
 
+## v1.0.1 05/24/2022
+* Expand documentation configuration settings
+
 ## v1.0.0 04/28/2022
 * Initial gem extraction from Doximity
 

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    neo4j-http (1.0.0)
+    neo4j-http (1.0.1)
       activesupport (>= 5.2)
       faraday (< 2)
       faraday-retry
@@ -10,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2.4)
+    activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -106,4 +106,4 @@ DEPENDENCIES
   standard
 
 BUNDLED WITH
-   2.1.4
+   2.3.0

README.md

@@ -27,21 +27,41 @@ Or install it yourself as:
 
 The client is configured by default via a set of environment variables from [Neo4j::Http::Configuration](https://github.com/doximity/neo4j-http/blob/master/lib/neo4j/http/configuration.rb):
 
-* `NEO4J_URL`  - The base URL to connect to Neo4j at
-* `NEO4J_USER` - The user name to use when authenticating to neo4j
-* `NEO4J_PASSWORD` - The password of the user to be used for authentication
-* `NEO4J_DATABASE` - The database name to be used when connecting.  By default this will be nil and the path used for connecting to Neo4j wil be `/db/data/transaction/commit` to make it compliant with v3.5 of neo4j
-* `NEO4J_HTTP_USER_AGENT` - The user agent name provided in the request - defaults to `Ruby Neo4j Http Client`
-* `NEO4J_REQUEST_TIMEOUT_IN_SECONDS` - The number of seconds for the http request to time out if provided, defaults to nil
+* `NEO4J_URL`  - The base URL to connect to Neo4j at - defaults to `"http://localhost:7474"`
+* `NEO4J_USER` - The user name to use when authenticating to neo4j - defaults to `""`
+* `NEO4J_PASSWORD` - The password of the user to be used for authentication - defaults to `""`
+* `NEO4J_DATABASE` - The database name to be used when connecting.  By default this will be `nil`.
+* `NEO4J_HTTP_USER_AGENT` - The user agent name provided in the request - defaults to `"Ruby Neo4j Http Client"`
+* `NEO4J_REQUEST_TIMEOUT_IN_SECONDS` - The number of seconds for the http request to time out if provided - defaults to `nil`
 
-These configuration values can also be set during initalization like:
+These configuration values can also be set during initalization, and take precedence over the environment variables:
 
 ```ruby
 Neo4j::Http.configure do |config|
-  config.request_timeout_in_seconds = 42
+  config.uri = "http://localhost:7474"
+  config.user = ""
+  config.password = ""
+  config.database_name = nil
+  config.user_agent = "Ruby Neo4j Http Client"
+  config.request_timeout_in_seconds = nil
 end
 ```
 
+### Multiple databases
+
+The HTTP API endpoints [follow the pattern](https://neo4j.com/docs/upgrade-migration-guide/current/migration/surface-changes/http-api/) `/db/<NEO4J_DATABASE>/tx`
+
+To route to a different database, set a value for `NEO4J_DATABASE`. If no value is supplied, or this ENV is unset, the URI defaults to `/db/data/transaction/commit`
+
+This can be used for testing by setting up a test environment only variable using a gem like [dotenv-rails](https://github.com/bkeepers/dotenv):
+
+```
+# .env.testing
+NEO4J_DATABASE=test
+```
+
+All testing operations are now routed to the URI `/db/test/tx/commit`.
+
 ## Usage
 
 The core interface can be directly accessed on `Neo4::Http::Client` -

lib/neo4j/http/configuration.rb

@@ -19,6 +19,8 @@ def initialize(options = ENV)
         @request_timeout_in_seconds = options.fetch("NEO4J_REQUEST_TIMEOUT_IN_SECONDS", nil)
       end
 
+      # https://neo4j.com/developer/manage-multiple-databases/
+      # https://neo4j.com/docs/upgrade-migration-guide/current/migration/surface-changes/http-api/
       def transaction_path
         # v3.5 - /db/data/transaction/commit
         # v4.x - /db/#{database_name}/tx/commit

lib/neo4j/http/version.rb

@@ -1,5 +1,5 @@
 module Neo4j
   module Http
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end