chalk_ruby 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5078b236fa2532b078ba26509838b574bcb72c624ac4a27eb41f7fb34b9fb617
-  data.tar.gz: af01a9060816db57ff9198129a8d3ac2d0c7cce683e0ea59da1f9f6ed7ead09a
+  metadata.gz: be8baa09bb22ab16fe18d5d82d89fa4d5ca75f2216f60daeb240ee185aecafc1
+  data.tar.gz: 07cfafd2ff5de2898f492697f17eba513e5cdea23df58ed8489b637c3a5b6b40
 SHA512:
-  metadata.gz: f0f5a7f1ca26cefac916b76bf8f83b77b94ecc64344985d7d5adf6fe77aaebc61b811b6c9f5cbc3dd1cc78dc7b1fe519a3d7b9e45656294c0bc021b42cafe9cf
-  data.tar.gz: 910e8c846f446f44bb556f34c430d4eec7e24482ff3e13f29ad6874c635f48f5539e0502c25dfb8a9d6d48227a538beedbcd598474d6bc3c059136746f9194b6
+  metadata.gz: befc8666980d27db057207bcf38a97e8f347879ed0938a9f8a5fcd3cbb07fe06d00e458ec50b7a54c0f308ab1f8ad2c331abe5c63213acde8073e04954ae1442
+  data.tar.gz: b8fdb9a0157d03e68047bcc5da8ecd569441cbc60c93f9b42378c6a227a401b99b0a3eede639f5ec1bcf44891193fc619ea3ca7e5e64bc470e8cf40eeec3dc31

data/.github/workflows/release.yml

@@ -0,0 +1,41 @@
+name: Release Gem
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.0'
+          bundler-cache: true
+          
+      - name: Extract version from tag
+        id: get_version
+        run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV
+        
+      - name: Update version.rb
+        run: |
+          sed -i "s/VERSION = '.*'/VERSION = '${{ env.VERSION }}'/g" lib/chalk_ruby/version.rb
+          
+      - name: Build gem
+        run: gem build chalk_ruby.gemspec
+        
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem push "chalk_ruby-${{ env.VERSION }}.gem"
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}

data/.github/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Run Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1']
+    
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      
+      - name: Install dependencies
+        run: bundle install
+      
+      - name: Run linter
+        run: bundle exec rake rubocop
+        
+      - name: Run tests
+        run: bundle exec rake test:all

data/chalk_ruby.gemspec

@@ -42,11 +42,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'multi_json', '~> 1.0'
   spec.add_dependency 'net-http-persistent'
-  spec.add_dependency 'red-arrow', '~> 18.0.0'
 
   spec.add_development_dependency 'httpclient'
   spec.add_development_dependency 'm'
   spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'minitest-hooks'
   spec.add_development_dependency 'minitest-proveit'
+  spec.add_development_dependency 'red-arrow', '~> 18.0.0'
 end

data/lib/chalk_ruby/client.rb

@@ -29,6 +29,11 @@ module ChalkRuby
     # @param additional_headers [Hash[String, String]]
     #   Additional headers to be sent with every request. Typically not required.
     #
+    # @param eagerly_initialize_connection_pool [Boolean]
+    #   Whether to eagerly initialize connections to the query and API servers.
+    #   When true, connections will be pre-warmed during client initialization.
+    #   Default is false (lazy initialization).
+    #
     # @return self
     #
     def self.create(
@@ -37,7 +42,8 @@ module ChalkRuby
       environment = nil,
       query_server = nil,
       api_server = nil,
-      additional_headers = {}
+      additional_headers = {},
+      eagerly_initialize_connection_pool = false
     )
       config = Config.new(
         client_id: client_id,
@@ -45,7 +51,8 @@ module ChalkRuby
         environment: environment,
         query_server: query_server,
         api_server: api_server,
-        additional_headers: additional_headers
+        additional_headers: additional_headers,
+        eagerly_initialize_connection_pool: eagerly_initialize_connection_pool
       )
       create_with_config(config)
     end
@@ -213,9 +220,46 @@ module ChalkRuby
       logger       = opts[:logger] || LoggerHelper.create
       requester    = opts[:http_requester] || Defaults::REQUESTER_CLASS.new(adapter: adapter, logger: logger)
       @transporter = Http::HttpRequesterChalk.new(requester: requester)
+      
+      # Eagerly initialize connections if configured
+      if @config.eagerly_initialize_connection_pool
+        warm_connections
+      end
+    end
+
+    # Warm up connections to the API and query servers by establishing
+    # TCP connections with lightweight HEAD requests
+    def warm_connections
+      # Get the query server host
+      query_host = query_server_host
+      
+      # Warm up API server connection
+      warm_connection(@config.api_server)
+      
+      # Warm up query server connection
+      warm_connection(query_host)
     end
 
     private
+    
+    # Establish a connection to a host by making a lightweight request
+    def warm_connection(host)
+      # Access the underlying HTTP requester
+      requester = @transporter.instance_variable_get(:@http_requester)
+      
+      # Create the Faraday connection object
+      connection = requester.connection(host)
+      
+      # Make a HEAD request to "/" to actually establish the TCP connection
+      # HEAD is used as it's lightweight and most servers support it
+      begin
+        connection.head('/')
+      rescue => e
+        # Ignore errors - we're just warming the connection
+        # The server might not support HEAD on /, but the TCP connection
+        # will still be established
+      end
+    end
 
     def api_server_request(method:, path:, body:, headers:)
       @transporter.send_request(

data/lib/chalk_ruby/config.rb

@@ -17,7 +17,8 @@ module ChalkRuby
                   :api_timeout,
                   :connect_timeout,
                   :query_service_root_ca_path,
-                  :additional_headers
+                  :additional_headers,
+                  :eagerly_initialize_connection_pool
 
     # Creates a new ChalkRuby::Config object for use with ChalkRuby::Client.
     #
@@ -52,6 +53,11 @@ module ChalkRuby
     # @option options [Hash<String, String>?] :additional_headers
     #  Additional headers to be sent with every request. Typically not required.
     #
+    # @option options [Boolean?] :eagerly_initialize_connection_pool
+    #  Whether to eagerly initialize connections to the query and API servers.
+    #  When true, connections will be pre-warmed during client initialization.
+    #  Default is false (lazy initialization).
+    #
     def initialize(opts = {})
       @client_id                        = opts[:client_id] || ENV['CHALK_CLIENT_ID']
       @client_secret                    = opts[:client_secret] || ENV['CHALK_CLIENT_SECRET']
@@ -63,6 +69,7 @@ module ChalkRuby
       @connect_timeout                  = opts[:connect_timeout] || Defaults::CONNECT_TIMEOUT
       @query_service_root_ca_path       = opts[:query_service_root_ca_path] || Defaults::ROOT_CA_PATH
       @additional_headers = opts[:additional_headers] || {}
+      @eagerly_initialize_connection_pool = opts[:eagerly_initialize_connection_pool] || false
 
       raise ChalkError, 'No Client ID provided, please set :client_id' if @client_id.nil?
       raise ChalkError, 'No Client Secret provided, please set :client_secret' if @client_secret.nil?

data/lib/chalk_ruby/grpc_client.rb

@@ -168,6 +168,9 @@ module ChalkRuby
       correlation_id: nil,
       planner_options: nil
       )
+      unless red_arrow_available?
+        raise NotImplementedError, "query_bulk requires the 'red-arrow' gem. Please add it to your Gemfile: gem 'red-arrow', '~> 18.0.0'"
+      end
       # Convert input to feather format
       inputs_feather = to_feather(input)
 
@@ -412,10 +415,22 @@ module ChalkRuby
 
       private
 
+    def red_arrow_available?
+      @red_arrow_available ||= begin
+        require 'arrow'
+        true
+      rescue LoadError
+        false
+      end
+    end
+
     # Converts Arrow binary data to an array of hashes
     # @param arrow_data [String] Binary Arrow data (IPC stream format)
     # @return [Array<Hash>] Array of hashes with column name as keys and Ruby values
     def arrow_table_to_array(arrow_data)
+      unless red_arrow_available?
+        raise NotImplementedError, "arrow_table_to_array requires the 'red-arrow' gem. Please add it to your Gemfile: gem 'red-arrow', '~> 18.0.0'"
+      end
       require 'arrow'
       
       buffer = Arrow::Buffer.new(arrow_data)
@@ -454,6 +469,9 @@ module ChalkRuby
     end
 
     def to_feather(input_hash)
+      unless red_arrow_available?
+        raise NotImplementedError, "to_feather requires the 'red-arrow' gem. Please add it to your Gemfile: gem 'red-arrow', '~> 18.0.0'"
+      end
       require 'arrow'
 
       # Ensure all values in the input hash are arrays

data/lib/chalk_ruby/version.rb

@@ -1,3 +1,3 @@
 module ChalkRuby
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.4.1'.freeze
 end

data/test/chalk_ruby/integration/client_test.rb

@@ -8,7 +8,7 @@ CLIENT_SECRET = ''
 
 RSpec.describe 'Online query' do
   it 'should accept valid queries' do
-    client   = ChalkRuby::Client.create(CLIENT_ID, CLIENT_SECRET)
+    client   = ChalkRuby::Client.create(CLIENT_ID, CLIENT_SECRET, "tmnmrbyb8x53f")
     response = client.query(
       input: { 'user.id': 3454 },
       output: %w(user.id),

data/test/chalk_ruby/integration/connection_warming_test.rb

@@ -0,0 +1,35 @@
+require 'minitest/autorun'
+require 'chalk_ruby/client'
+require 'chalk_ruby/config'
+
+describe 'Connection warming' do
+  it 'should accept eagerly_initialize_connection_pool parameter in config' do
+    config = ChalkRuby::Config.new(
+      client_id: 'test_id',
+      client_secret: 'test_secret',
+      eagerly_initialize_connection_pool: true
+    )
+    
+    assert_equal true, config.eagerly_initialize_connection_pool
+  end
+  
+  it 'should default eagerly_initialize_connection_pool to false' do
+    config = ChalkRuby::Config.new(
+      client_id: 'test_id',
+      client_secret: 'test_secret'
+    )
+    
+    assert_equal false, config.eagerly_initialize_connection_pool
+  end
+  
+  it 'should accept eagerly_initialize_connection_pool parameter in create method' do
+    # This test verifies the parameter is accepted
+    params = ChalkRuby::Client.method(:create).parameters.map(&:last)
+    assert params.include?(:eagerly_initialize_connection_pool)
+  end
+  
+  it 'should have warm_connections method' do
+    # Test that the method exists on the class
+    assert ChalkRuby::Client.public_instance_methods.include?(:warm_connections)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chalk_ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Chalk AI, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-05 00:00:00.000000000 Z
+date: 2025-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -140,20 +140,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: red-arrow
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 18.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 18.0.0
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
@@ -224,6 +210,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: red-arrow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 18.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 18.0.0
 description: A simple Ruby client for Chalk
 email:
 - help@chalk.ai
@@ -234,6 +234,8 @@ files:
 - ".github/CODEOWNERS"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -364,6 +366,7 @@ files:
 - sig/chalk_ruby/versions.rbs
 - test/chalk_ruby/integration/arrow_conversion_test.rb
 - test/chalk_ruby/integration/client_test.rb
+- test/chalk_ruby/integration/connection_warming_test.rb
 - test/chalk_ruby/integration/grpc_client_test.rb
 - test/chalk_ruby/test_helper.rb
 homepage: https://github.com/chalk-ai/chalk-ruby
@@ -395,5 +398,6 @@ summary: A simple Ruby client for Chalk
 test_files:
 - test/chalk_ruby/integration/arrow_conversion_test.rb
 - test/chalk_ruby/integration/client_test.rb
+- test/chalk_ruby/integration/connection_warming_test.rb
 - test/chalk_ruby/integration/grpc_client_test.rb
 - test/chalk_ruby/test_helper.rb