neo4j-http 1.0.0 → 1.0.2.ben

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a6215260814ae93f5003a9013d59d709819710e8908f2646ff8e7e3555c5d40
-  data.tar.gz: 976402f3c84d5662d61c78d8db1637232d8b6925fe2f1282943064cd8ab9ca05
+  metadata.gz: 5d96303c02ea752544432e28e5510fbe6c88adc8478068cab9924f523dec5c3d
+  data.tar.gz: c905e048958cfd2dd2a4b22c03b2a0cc7d015389689198124a02566242f47a20
 SHA512:
-  metadata.gz: '09bfdc57bd1e10d932c4fd874b5edcc7753943fecc465fbd96aad8e32a54993da33d8f24d7cd84d1a372374cb81eeacd4125b12e42a933f552b4b2896316872f'
-  data.tar.gz: 95f18a7b9ecd1d9ca0d2f51ca80fb310d650aa6463281daf056d626874620912bc65d36c65462ba0b48315950b9874ed88fdc6e5ba682d0664c6e6ff834cc10c
+  metadata.gz: 82acf63f31d626badac509a0018aec7777165caf8507253f7ce88f145f8c235255da55d6277a340d971ec3740202e7ed4dbed4671ffec0d22e76f5b53fc909d9
+  data.tar.gz: d8abb8918f0ee93487928ea09d8983fa7ee8e9be62fa0f5f59f4ab8213282157ddaa2146b600992edbe3f9d12f3b281e2a3d254dd31e02d2ae1414d6fc95663d

data/README.md

@@ -27,21 +27,43 @@ 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`
+* `ACCESS_MODE` - "WRITE", or "READ" for read only instances of Neo4j clients - defaults to `"WRITE"`
 
-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
+  config.access_mode = "WRITE"
 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` -

data/lib/neo4j/http/configuration.rb

@@ -9,6 +9,7 @@ module Neo4j
       attr_accessor :uri
       attr_accessor :user
       attr_accessor :user_agent
+      attr_accessor :access_mode
 
       def initialize(options = ENV)
         @uri = options.fetch("NEO4J_URL", "http://localhost:7474")
@@ -17,8 +18,11 @@ module Neo4j
         @database_name = options.fetch("NEO4J_DATABASE", nil)
         @user_agent = options.fetch("NEO4J_HTTP_USER_AGENT", "Ruby Neo4j Http Client")
         @request_timeout_in_seconds = options.fetch("NEO4J_REQUEST_TIMEOUT_IN_SECONDS", nil)
+        @access_mode = options.fetch("NEO4J_ACCESS_MODE", "WRITE")
       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

data/lib/neo4j/http/cypher_client.rb

@@ -12,26 +12,36 @@ module Neo4j
         @default ||= new(Neo4j::Http.config)
       end
 
-      def initialize(configuration)
+      def initialize(configuration, injected_connection = nil)
         @configuration = configuration
+        @injected_connection = injected_connection
       end
 
+      # Executes a cypher query, passing in the cypher statement, with parameters as an optional hash
+      # e.g. Neo4j::Http::Cypherclient.execute_cypher("MATCH (n { foo: $foo }) LIMIT 1 RETURN n", { foo: "bar" })
       def execute_cypher(cypher, parameters = {})
+        # By default the access mode is set to "WRITE", but can be set to "READ"
+        # for improved routing performance on read only queries
+        access_mode = parameters.delete(:access_mode) || @configuration.access_mode
+
         request_body = {
           statements: [
-            {statement: cypher,
-             parameters: parameters.as_json}
+            {
+              statement: cypher,
+              parameters: parameters.as_json
+            }
           ]
         }
 
-        response = connection.post(transaction_path, request_body)
+        @connection = @injected_connection || connection(access_mode)
+        response = @connection.post(transaction_path, request_body)
         results = check_errors!(cypher, response, parameters)
 
         Neo4j::Http::Results.parse(results&.first || {})
       end
 
-      def connection
-        build_connection
+      def connection(access_mode)
+        build_connection(access_mode)
       end
 
       protected
@@ -39,6 +49,10 @@ module Neo4j
       delegate :auth_token, :transaction_path, to: :@configuration
       def check_errors!(cypher, response, parameters)
         raise Neo4j::Http::Errors::InvalidConnectionUrl, response.status if response.status == 404
+        if response.body["errors"].any? { |error| error["message"][/Routing WRITE queries is not supported/] }
+          raise Neo4j::Http::Errors::ReadOnlyError
+        end
+
         body = response.body || {}
         errors = body.fetch("errors", [])
         return body.fetch("results", {}) unless errors.present?
@@ -61,8 +75,10 @@ module Neo4j
         Neo4j::Http::Errors::Neo4jCodedError
       end
 
-      def build_connection
-        Faraday.new(url: @configuration.uri, headers: build_http_headers, request: build_request_options) do |f|
+      def build_connection(access_mode)
+        # https://neo4j.com/docs/http-api/current/actions/transaction-configuration/
+        headers = build_http_headers.merge({"access-mode" => access_mode})
+        Faraday.new(url: @configuration.uri, headers: headers, request: build_request_options) do |f|
           f.request :json # encode req bodies as JSON
           f.request :retry # retry transient failures
           f.response :json # decode response bodies as JSON

data/lib/neo4j/http/errors.rb

@@ -4,6 +4,7 @@ module Neo4j
       Neo4jError = Class.new(StandardError)
       InvalidConnectionUrl = Class.new(Neo4jError)
       Neo4jCodedError = Class.new(Neo4jError)
+      ReadOnlyError = Class.new(Neo4jError)
 
       # These are specific Errors Neo4j can raise
       module Neo

data/lib/neo4j/http/node_client.rb

@@ -41,15 +41,16 @@ module Neo4j
       def find_node_by(label:, **attributes)
         selectors = attributes.map { |key, value| "#{key}: $attributes.#{key}" }.join(", ")
         cypher = "MATCH (node:#{label} { #{selectors} }) RETURN node LIMIT 1"
-        results = @cypher_client.execute_cypher(cypher, attributes: attributes)
+        results = @cypher_client.execute_cypher(cypher, attributes: attributes.merge(access_mode: "READ"))
         return if results.empty?
+
         results.first&.fetch("node")
       end
 
       def find_nodes_by(label:, attributes:, limit: 100)
         selectors = build_selectors(attributes)
         cypher = "MATCH (node:#{label}) where #{selectors} RETURN node LIMIT #{limit}"
-        results = @cypher_client.execute_cypher(cypher, attributes: attributes)
+        results = @cypher_client.execute_cypher(cypher, attributes: attributes.merge(access_mode: "READ"))
         results.map { |result| result["node"] }
       end
 

data/lib/neo4j/http/relationship_client.rb

@@ -52,7 +52,13 @@ module Neo4j
           RETURN from, to, relationship
         CYPHER
 
-        results = @cypher_client.execute_cypher(cypher, from: from, to: to, relationship: relationship)
+        results = @cypher_client.execute_cypher(
+          cypher,
+          from: from,
+          to: to,
+          relationship: relationship,
+          access_mode: "READ"
+        )
         results&.first
       end
 

data/lib/neo4j/http/results.rb

@@ -4,7 +4,10 @@ module Neo4j
   module Http
     class Results
       # Example result set:
-      # [{"columns"=>["n"], "data"=>[{"row"=>[{"name"=>"Foo", "uuid"=>"8c7dcfda-d848-4937-a91a-2e6debad2dd6"}], "meta"=>[{"id"=>242, "type"=>"node", "deleted"=>false}]}]}]
+      # [{"columns"=>["n"],
+      # "data"=>
+      # [{"row"=>[{"name"=>"Foo", "uuid"=>"8c7dcfda-d848-4937-a91a-2e6debad2dd6"}],
+      #   "meta"=>[{"id"=>242, "type"=>"node", "deleted"=>false}]}]}]
       #
       def self.parse(results)
         columns = results["columns"]

data/lib/neo4j/http/version.rb

@@ -1,5 +1,5 @@
 module Neo4j
   module Http
-    VERSION = "1.0.0"
+    VERSION = "1.0.2.ben"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neo4j-http
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2.ben
 platform: ruby
 authors:
 - Ryan Stawarz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-29 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -73,7 +73,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -121,9 +121,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.11
 signing_key: