tigerbeetle 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c101b60abf7896313b3f33a87681729a17da2861e59922e3d77ecfdf7e24a539
-  data.tar.gz: 843d64b05acdb682f56170a30dff92ff5564337dbcb30290a7935d7d7a27c605
+  metadata.gz: 9fcbf6ee3840a30076501bc9afa231f601b9ffcd3740ba476919014e18a1eaab
+  data.tar.gz: 44825b4988b8c928c6e85a79f6539111036eb07d0a6d92309d398747e288ac5d
 SHA512:
-  metadata.gz: 362419b8c5c2a43c969a74002a5f9de20fc5ff2b525ea100d8089c4b8b8a6d8df1da20cd7705670e5816e6121b2f44c4d1d7a3d3f6cdebd91d8f718dacf32a94
-  data.tar.gz: 73b12180e9d5670c59967475e61c1b6c98afa918b2c3ea56bcc83513c6f3d8e8b2a2950a957bd85548a8ab4671791fcb32f4a94f515ce427f600a0cd5f239454
+  metadata.gz: 56c7c962577de854c3c9289450a05ee06ed462e7443c00c96d05c77ac2ba2d1c132931dbb8b5598a84bdca4b6a228b6c2459e3c371f3494eb1ab7536d10c25ef
+  data.tar.gz: a634fb7d8f076208498a75c6dae6946a6961f27d40515d1567ff0537f9d609d6cd317e49573b555be268825a6fb1455329d21dbb8939161570c4a55a60744b96

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 0.0.3
+
+- Bug fixes
+- Based on TigerBeetle 0.16.40
+
+## 0.0.2
+
+- Non-optional fields no longer have default values
+- Client errors are now `TigerBeetle::ClientError`
+- Dependency versions corrected
+- Fixed issue with in-flight requests
+
 ## 0.0.1
 
 - First release

data/README.md

@@ -1,6 +1,8 @@
 # Ruby Client for TigerBeetle
 
+[![Gem](https://badge.fury.io/rb/tigerbeetle.svg)](https://rubygems.org/gems/tigerbeetle)
 [![CI](https://github.com/antstorm/tigerbeetle-ruby/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/antstorm/tigerbeetle-ruby/actions/workflows/ci.yml)
+[![License](https://img.shields.io/github/license/antstorm/tigerbeetle-ruby.svg)](https://opensource.org/licenses/apache-2-0)
 
 Are you looking to integrate [Tigebeetle](https://tigerbeetle.com/) into your Ruby (or Rails) stack?
 You've come to the right place!
@@ -74,6 +76,29 @@ client.create_accounts(
 *More on how to approach this — https://docs.tigerbeetle.com/coding/data-modeling/#id.*
 
 
+## Async
+
+All the lower level calls executed by the client are non-blocking. However, since async calls are
+much less common in Ruby, these are made blocking by default. In order to use the client
+asynchronously all you need to do is provide your own callback to any method on the client:
+
+```ruby
+# default blocking call
+result = client.lookup_accounts(100)
+result # [#<struct TigerBeetle::Account id=100, ... >]
+
+# async non-blocking call
+client.lookup_accounts(100) do |result|
+  result # [#<struct TigerBeetle::Account id=100, ... >]
+end
+```
+
+*In the example above the first call will block until TigerBeetle responds and the return value of
+the call will contain the result. The second call however will return `nil` straight away (and keep
+executing your code) while calling the provided block only once TigerBeetle has responded, passing
+in the result as an argument to the block.*
+
+
 ## Contributing
 
 We'd love your help building the TigerBeetle Ruby gem.

data/ext/tb_client/extconf.rb

@@ -2,7 +2,8 @@
 require 'mkmf'
 
 makefile_path = File.join('Makefile')
-client_version = '0.16.37'
+client_version = '0.16.40'
+min_client_version = '0.16.37'
 tar_package = 'pkg.tar.gz'
 
 makefile = ''
@@ -12,7 +13,7 @@ if find_executable('zig') && File.exist?('./tigerbeetle/build.zig')
     all:
     \techo "Compiling native TB client from the source"
     \tzig version
-    \tunset -v DESTDIR && cd ./tigerbeetle && zig build clients:c -Dconfig-release=#{client_version} -Dconfig-release-client-min=#{client_version}
+    \tunset -v DESTDIR && cd ./tigerbeetle && zig build clients:c -Dconfig-release=#{client_version} -Dconfig-release-client-min=#{min_client_version}
     \n\n
     install:
     \tcp -rf ./tigerbeetle/src/clients/c/lib ./pkg

data/lib/tigerbeetle/account.rb

@@ -6,7 +6,7 @@ module TigerBeetle
 
   Account = Struct.new(*ACCOUNT_PARAMS) do
     def initialize(
-      id: 0,
+      id:,
       debits_pending: 0,
       debits_posted: 0,
       credits_pending: 0,
@@ -14,8 +14,8 @@ module TigerBeetle
       user_data_128: 0,
       user_data_64: 0,
       user_data_32: 0,
-      ledger: 0,
-      code: 0,
+      ledger:,
+      code:,
       flags: [],
       timestamp: nil
     )

data/lib/tigerbeetle/account_filter.rb

@@ -5,14 +5,14 @@ module TigerBeetle
 
   AccountFilter = Struct.new(*ACCOUNT_FILTER_PARAMS) do
     def initialize(
-      account_id: 0,
+      account_id:,
       user_data_128: 0,
       user_data_64: 0,
       user_data_32: 0,
       code: 0,
       timestamp_min: 0,
       timestamp_max: 0,
-      limit: 0,
+      limit:,
       flags: []
     )
       super(

data/lib/tigerbeetle/atomic_counter.rb

@@ -0,0 +1,14 @@
+module TigerBeetle
+  class AtomicCounter
+    attr_reader :value
+
+    def initialize(value = 0)
+      @value = value
+      @mutex = Mutex.new
+    end
+
+    def increment
+      @mutex.synchronize { @value += 1 }
+    end
+  end
+end

data/lib/tigerbeetle/client.rb

@@ -4,17 +4,17 @@ require 'tigerbeetle/converters'
 require 'tigerbeetle/account'
 require 'tigerbeetle/account_balance'
 require 'tigerbeetle/account_filter'
+require 'tigerbeetle/atomic_counter'
+require 'tigerbeetle/error'
 require 'tigerbeetle/query_filter'
 require 'tigerbeetle/request'
 require 'tigerbeetle/transfer'
 
 module TigerBeetle
   class Client
-    # TODO: Make this counter atomic
-    @counter = 0
-
     def self.next_id
-      @counter += 1
+      @counter ||= AtomicCounter.new
+      @counter.increment
     end
 
     def initialize(cluster_id = 0, address = '3000')
@@ -35,7 +35,7 @@ module TigerBeetle
         @client_id,
         &@callback
       )
-      raise "Error while initializing client: #{status}" unless status == :SUCCESS
+      raise ClientError, "Unable to initialize native client: #{status}" unless status == :SUCCESS
 
       # Make sure to deinitialize all clients when the process terminates
       at_exit { deinit }
@@ -46,7 +46,7 @@ module TigerBeetle
       @log_callback = @logger ? Proc.new { |*args| log_callback(*args) } : nil
 
       status = TBClient.tb_client_register_log_callback(@log_callback, true)
-      raise "Error registering a logger: #{status}" unless status == :SUCCESS
+      raise ClientError, "Unable to register logger: #{status}" unless status == :SUCCESS
     end
 
     def create_accounts(*accounts, &block)
@@ -131,6 +131,7 @@ module TigerBeetle
 
     def deinit
       return unless client
+      return unless inflight_requests.empty?
 
       TBClient.tb_client_deinit(client)
       @client = nil
@@ -152,13 +153,13 @@ module TigerBeetle
 
     def callback(client_id, packet, timestamp, result_ptr, result_len)
       request_id = packet[:user_data].read_uint64
-      request = inflight_requests[request_id]
+      request = inflight_requests.delete(request_id)
       result = deserialize(result_ptr, request.converter, result_len)
       request.block.call(result)
     end
 
     def submit_request(operation, request, request_converter, response_converter, &block)
-      raise 'Client is not connected' unless client
+      raise ClientError, 'Client is not connected' unless client
 
       request_id = self.class.next_id
       user_data_ptr = FFI::MemoryPointer.new(:uint64, 1)
@@ -183,7 +184,7 @@ module TigerBeetle
       end
 
       status = TBClient.tb_client_submit(client, packet)
-      raise "Unable to submit request: #{status}" unless status == :OK
+      raise ClientError, "Unable to submit request: #{status}" unless status == :OK
 
       # block until the client return a response
       queue.pop unless block

data/lib/tigerbeetle/error.rb

@@ -0,0 +1,4 @@
+module TigerBeetle
+  class Error < StandardError; end
+  class ClientError < Error; end
+end

data/lib/tigerbeetle/query_filter.rb

@@ -12,7 +12,7 @@ module TigerBeetle
       code: 0,
       timestamp_min: 0,
       timestamp_max: 0,
-      limit: 0,
+      limit:,
       flags: []
     )
       super(

data/lib/tigerbeetle/transfer.rb

@@ -6,7 +6,7 @@ module TigerBeetle
 
   Transfer = Struct.new(*TRANSFER_PARAMS) do
     def initialize(
-      id: 0,
+      id:,
       debit_account_id: 0,
       credit_account_id: 0,
       amount: 0,

data/lib/tigerbeetle/version.rb

@@ -1,3 +1,3 @@
 module TigerBeetle
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.3'.freeze
 end

data/tigerbeetle.gemspec

@@ -25,9 +25,9 @@ Gem::Specification.new do |spec|
     'tigerbeetle.gemspec'
   ].flatten
 
-  spec.add_dependency 'ffi'
+  spec.add_dependency 'ffi', '~> 1.14'
 
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 13.1'
+  spec.add_development_dependency 'rspec', '~> 3.11'
+  spec.add_development_dependency 'pry', '~> 0.15'
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: tigerbeetle
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Anthony D
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-03 00:00:00.000000000 Z
+date: 2025-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.15'
 description: A Ruby client for interacting with the high performance TigerBeetle ledger
 email:
 - anthony.dmitriyev@gmail.com
@@ -85,6 +85,7 @@ files:
 - lib/tigerbeetle/account.rb
 - lib/tigerbeetle/account_balance.rb
 - lib/tigerbeetle/account_filter.rb
+- lib/tigerbeetle/atomic_counter.rb
 - lib/tigerbeetle/client.rb
 - lib/tigerbeetle/converters.rb
 - lib/tigerbeetle/converters/account.rb
@@ -97,6 +98,7 @@ files:
 - lib/tigerbeetle/converters/time.rb
 - lib/tigerbeetle/converters/transfer.rb
 - lib/tigerbeetle/converters/uint_128.rb
+- lib/tigerbeetle/error.rb
 - lib/tigerbeetle/id.rb
 - lib/tigerbeetle/query_filter.rb
 - lib/tigerbeetle/request.rb