neo4j_bolt 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f7a73b8f8b557258fa8f56204db5f54431c007cbe30074cec9391c7b22054c3
-  data.tar.gz: c78f05d1ac8f44c20ad87de565a8e5b1d342858814dcdc148d080f64582c789c
+  metadata.gz: 4cc002cc5c04a6aa43ef9db40432dc77bb2a1cfa497e51509a44a9e978bc2ccb
+  data.tar.gz: d3ae31acea372c8b89daf38debd38b71ded70a6df589f970934bf0798fa2fb63
 SHA512:
-  metadata.gz: cd9ea5265951e222c17dfafa29b734b3f0fd2f506b08f4ff9b1454ef5a5a4f63f1b042279297a65da1d9fae20dcb8b1bff590afab2aca395a9ad4893b0b8c198
-  data.tar.gz: d5a88f27219309adc1e03a3cb8b9b1e1d6cd0624a6199357947771304354c8423313994c14ff956900f8372a92865fbcd2221138a1038479e8668ed435c5abdb
+  metadata.gz: c50f906643998a24fd2eeb32ecd54c8ca9ba64715e6c16d10077d4fe281cae9a6e3184a20bee006afc4f1d94c06f387e6d6b611c82f29ef208638a332837129e
+  data.tar.gz: 65063c69802e4b54369ea5c78ddf4db4e1805140d6bfbd143a55317e369b952e0930fe091401866bb53d382b4157e363c461e44be2b3c39525cfa2bbe97a7068

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    neo4j_bolt (0.1.0)
+    neo4j_bolt (0.1.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,16 +1,6 @@
 # Neo4jBolt
 
-A Neo4j/Bolt driver written in pure Ruby.
-
-🚀 **Streaming support!** Neo4j sends responses in chunks of max. 64 kb. When running queries, specify a block to obtain rows as soon as they arrive.
-
-## Supported and unsupported aspects
-
-|  | Supported | Unsupported |
-|-|-|-
-| Neo4j | 4.4 | 1.x 2.x 3.x <br /> 4.0 4.1 4.2 4.3 <br /> 5.x |
-| Bolt | 4.4 | 1 2 3 4.0 4.1 4.2 4.3 |
-
+A Neo4j/Bolt driver written in pure Ruby. Currently only supporting Neo4j 4.4.
 
 ## Installation
 
@@ -36,7 +26,56 @@ In order to use this gem, you need a running Neo4j database. You can start one u
 docker run --rm --env NEO4J_AUTH=none --publish 7687:7687 neo4j:4.4-community
 ```
 
-TODO: Write usage instructions here
+### Connecting to a Neo4j database
+
+Specify your Bolt host and port (if you omit this it will be localhost:7687 by default):
+
+```ruby
+Neo4jBolt.bolt_host = 'localhost'
+Neo4jBolt.bolt_port = 7687
+```
+
+Use `cleanup_neo4j` to disconnect (this is important when running a web app – it might be a good idea to close a socket once we're done with it so we don't run out of ports).
+
+
+### Running queries
+
+Use `neo4j_query` to run a query and receive all results:
+
+```ruby
+entries = neo4j_query("MATCH (n) RETURN n;")
+```
+Alternatively, specify a block to make use of Neo4j's streaming capabilities and receive entries one by one:
+
+```ruby
+neo4j_query("MATCH (n) RETURN n;") do |entry|
+    # handle entry here
+end
+```
+
+Using streaming avoids memory hog since it prevents having to read all entries into memory before handling them. Nodes are returned as `Neo4jBolt::Node`, relationships as `Neo4jBolt::Relationship`. Both are subclasses of `Hash`, providing access to all properties plus a few extra details:
+
+- `Neo4jBolt::Node`: `id`, `labels`
+- `Neo4jBolt::Relationship`: `id`, `start_node_id`, `end_node_id`, `type`
+
+```ruby
+node = neo4j_query_expect_one("CREATE (n:Node {a: 1, b: 2}) RETURN n;")['n']
+# All nodes returned from Neo4j are a Neo4jBolt::Node
+# It's a subclass of Hash and it stores all the node's
+# properties plus two attributes called id and labels:
+puts node.id
+puts node.labels
+puts node.keys
+node.each_pair { |k, v| puts "#{k}: #{v}" }
+puts node.to_json
+```
+Use `neo4j_query_expect_one` if you want to make sure there's exactly one entry to be returned:
+
+```ruby
+node = neo4j_query_expect_one("MATCH (n) RETURN n LIMIT 1;")['n']
+```
+
+If there's zero, two, or more results, this will raise a `ExpectedOneResultError`.
 
 ## Development
 

data/lib/neo4j_bolt/version.rb

@@ -1,3 +1,3 @@
 module Neo4jBolt
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/neo4j_bolt.rb

@@ -4,6 +4,12 @@ require 'json'
 require 'yaml'
 
 module Neo4jBolt
+    class << self
+        attr_accessor :bolt_host, :bolt_port
+    end
+    self.bolt_host = 'localhost'
+    self.bolt_port = 7687
+
     NEO4J_DEBUG = 0
 
     module ServerState
@@ -266,9 +272,7 @@ module Neo4jBolt
 
     class BoltSocket
 
-        def initialize(host = 'localhost', port = 7687)
-            @host = host
-            @port = port
+        def initialize()
             @socket = nil
             @transaction = 0
             @transaction_failed = false
@@ -594,8 +598,13 @@ module Neo4jBolt
                     append_uint8(0xb1)
                     append_token(BoltMarker::BOLT_RESET)
                     flush()
-                    @state.set(ServerState::READY)
-                    read_response()
+                    read_response() do |data|
+                        if data[:marker] == BoltMarker::BOLT_SUCCESS
+                            @state.set(ServerState::READY)
+                        else
+                            raise UnexpectedServerResponse.new(data[:marker])
+                        end
+                    end
                     # BoltBuffer.new(@socket).flush()
                     raise bolt_error(response_dict[:data]['code'], response_dict[:data]['message'])
                 end
@@ -607,7 +616,7 @@ module Neo4jBolt
 
         def connect()
             # STDERR.write "Connecting to Neo4j via Bolt..."
-            @socket = TCPSocket.new(@host, @port)
+            @socket = TCPSocket.new(Neo4jBolt.bolt_host, Neo4jBolt.bolt_port)
             # @socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
             # @socket.setsockopt(Socket::SOL_TCP, Socket::TCP_KEEPIDLE, 50)
             # @socket.setsockopt(Socket::SOL_TCP, Socket::TCP_KEEPINTVL, 10)
@@ -628,7 +637,7 @@ module Neo4jBolt
             data = {
                 :routing => nil,
                 :scheme => 'none',
-                :user_agent => 'qts/0.1'
+                :user_agent => 'neo4j_bolt/0.1'
             }
             append_uint8(0xb1)
             append_token(BoltMarker::BOLT_HELLO)
@@ -673,6 +682,8 @@ module Neo4jBolt
                         @transaction_failed = false
                     elsif data[:marker] == BoltMarker::BOLT_FAILURE
                         @state.set(ServerState::FAILED)
+                    else
+                        raise UnexpectedServerResponse.new(data[:marker])
                     end
                 end
             end
@@ -709,10 +720,15 @@ module Neo4jBolt
                 append_uint8(0xb1)
                 append_token(BoltMarker::BOLT_COMMIT)
                 flush()
-                read_response()
-                @transaction = 0
-                @transaction_failed = false
-                @state.set(ServerState::READY)
+                read_response() do |data|
+                    if data[:marker] == BoltMarker::BOLT_SUCCESS
+                        @transaction = 0
+                        @transaction_failed = false
+                        @state.set(ServerState::READY)
+                    else
+                        raise UnexpectedServerResponse.new(data[:marker])
+                    end
+                end
             end
         end
 
@@ -779,6 +795,8 @@ module Neo4jBolt
                             elsif data[:marker] == BoltMarker::BOLT_SUCCESS
                                 # STDERR.puts data.to_yaml
                                 @state.set(ServerState::TX_READY)
+                            else
+                                raise UnexpectedServerResponse.new(data[:marker])
                             end
                         end
                     elsif data[:marker] == BoltMarker::BOLT_FAILURE
@@ -811,10 +829,6 @@ module Neo4jBolt
         end
     end
 
-    def connect_bolt_socket(host, port)
-        @bolt_socket ||= BoltSocket.new(host, port)
-    end
-
     def transaction(&block)
         @bolt_socket ||= BoltSocket.new()
         @bolt_socket.transaction { yield }

data/neo4j_bolt.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["micha.specht@gmail.com"]
   spec.licenses      = ['GPL-3.0-only']
 
-  spec.summary       = "A pure Neo4j/Bolt driver written in pure Ruby"
+  spec.summary       = "A Neo4j/Bolt driver written in pure Ruby"
   spec.homepage      = "https://github.com/specht/neo4j_bolt"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neo4j_bolt
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Michael Specht
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-27 00:00:00.000000000 Z
+date: 2022-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -69,5 +69,5 @@ requirements: []
 rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
-summary: A pure Neo4j/Bolt driver written in pure Ruby
+summary: A Neo4j/Bolt driver written in pure Ruby
 test_files: []