chalk_ruby 0.2.8 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd2402b4edf2bce128c0f86f9b81ff089bed5a2cb9564fc5c1b30d4290b2d062
-  data.tar.gz: 38380294054c04a7743adf9b2e2080dcba1d73e9a8cb9f1c1ddca032bbb46883
+  metadata.gz: 5078b236fa2532b078ba26509838b574bcb72c624ac4a27eb41f7fb34b9fb617
+  data.tar.gz: af01a9060816db57ff9198129a8d3ac2d0c7cce683e0ea59da1f9f6ed7ead09a
 SHA512:
-  metadata.gz: 99e17dd176aab3cbec5b2c65f1b1e44364978e5f2451f631c0b0c93832078cf73519c2a04982e3cb31ef69b93209550a9610c20326d3120ff361cdd6cedff754
-  data.tar.gz: 0db6e82923b3aaa2ced3401d5a40988b2a98b79ababf13ec50ab228234ab08ebe7c723015f86a8a1438488c5db3627bced34a4ed3bcff5a82ed1aa23a67950a6
+  metadata.gz: f0f5a7f1ca26cefac916b76bf8f83b77b94ecc64344985d7d5adf6fe77aaebc61b811b6c9f5cbc3dd1cc78dc7b1fe519a3d7b9e45656294c0bc021b42cafe9cf
+  data.tar.gz: 910e8c846f446f44bb556f34c430d4eec7e24482ff3e13f29ad6874c635f48f5539e0502c25dfb8a9d6d48227a538beedbcd598474d6bc3c059136746f9194b6

data/Dockerfile

@@ -0,0 +1,26 @@
+FROM ubuntu:22.04
+
+ENV BUNDLER_VERSION=2.3.6 \
+    BUNDLE_PATH=/app/vendor/bundle
+
+RUN apt-get update && apt-get install -y \
+    ca-certificates \
+    sudo \
+    wget \
+    lsb-release \
+    build-essential \
+    bash \
+    jq \
+    curl \
+    libffi-dev \
+    git \
+    libglib2.0-dev \
+    ruby-full
+
+# Install Apache Arrow 18
+RUN wget https://apache.jfrog.io/artifactory/arrow/ubuntu/apache-arrow-apt-source-latest-jammy.deb && \
+    apt-get install -y -V ./apache-arrow-apt-source-latest-jammy.deb && \
+    apt-get update && \
+    apt-get install -y -V libarrow-dev=18.* libarrow-glib-dev=18.* libparquet-dev=18.* libarrow-acero-dev=18.* gir1.2-arrow-1.0=18.*
+
+RUN gem install bundler

data/README.md

@@ -1,29 +1,115 @@
-## ChalkRuby Ruby
+# ChalkRuby - Ruby Client for Chalk
 
 [![Gem Version](https://badge.fury.io/rb/chalk_ruby.svg)](https://badge.fury.io/rb/chalk_ruby)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
 
-Ruby client for Chalk!
+A Ruby client library for [Chalk](https://chalk.ai/), a feature engineering platform for machine learning and data applications.
 
-https://rubygems.org/gems/chalk_ruby
+## Installation
 
-## Getting Started
+Add this line to your application's Gemfile:
 
-First, install ChalkRuby Ruby API Client via the [RubyGems](https://rubygems.org/) package manager:
+```ruby
+gem 'chalk_ruby'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it directly:
 
 ```bash
 gem install chalk_ruby
 ```
 
-Then, create a new client using your client ID and client secret:
+## Quick Start
 
 ```ruby
-client = ChalkRuby::Client.create('my-client-id', 'my-client-secret')
+# Create a client with credentials
+client = ChalkRuby::Client.create(
+  'my-client-id',
+  'my-client-secret',
+  'my-environment-id' # Optional, can also use CHALK_ACTIVE_ENVIRONMENT env var
+)
+
+# Query features
 results = client.query(
   input: { 'user.id': 'my-user-id' },
-  output: %w(user.id user.name user.email)
+  output: %w(user.id user.name user.email),
+  query_name: 'user_profile' # Optional: for tracking and monitoring
 )
+
+# Access feature values
+puts results['user.name']
 ```
 
+## Authentication
+
+Authentication can be provided in multiple ways:
+
+1. Directly in the client constructor:
+   ```ruby
+   client = ChalkRuby::Client.create('my-client-id', 'my-client-secret')
+   ```
+
+2. Using environment variables:
+   ```
+   CHALK_CLIENT_ID=my-client-id
+   CHALK_CLIENT_SECRET=my-client-secret
+   CHALK_ACTIVE_ENVIRONMENT=my-environment # Optional
+   ```
+   ```ruby
+   client = ChalkRuby::Client.create
+   ```
+
+## Advanced Usage
+
+### Query Options
+
+The `query` method supports several options:
+
+```ruby
+client.query(
+  input: { 'user.id': 'my-user-id' },
+  output: %w(user.id user.name user.credit_score),
+  now: Time.now,                      # Optional: time at which to evaluate the query
+  staleness: { 'user.credit_score': '1d' }, # Optional: max staleness for cached features
+  tags: { 'environment': 'production' },    # Optional: tags for resolver selection
+  branch: 'my-feature-branch',        # Optional: route request to a specific branch
+  correlation_id: 'request-123',      # Optional: ID for tracing in logs
+  query_name: 'user_profile',         # Optional: semantic name for the query
+  timeout: 5.0                        # Optional: timeout in seconds
+)
+```
+
+### Configuration
+
+Create a client with custom configuration:
+
+```ruby
+config = ChalkRuby::Config.new(
+  client_id: 'my-client-id',
+  client_secret: 'my-client-secret',
+  environment: 'my-environment',
+  query_server: 'https://custom-query-server.chalk.ai',
+  api_server: 'https://custom-api.chalk.ai',
+  additional_headers: { 'X-Custom-Header': 'value' }
+)
+
+client = ChalkRuby::Client.create_with_config(config)
+```
+
+## Requirements
+
+- Ruby 2.7 or higher
+
+## Version
+
+Current version: `0.2.8`
+
 ## License
 
-The Chalk Ruby API Client is an open-sourced software licensed under the [Apache 2 License](LICENSE.md).
+The Chalk Ruby Client is open-sourced software licensed under the [Apache 2.0 License](LICENSE).

data/lib/chalk_ruby/client.rb

@@ -150,7 +150,8 @@ module ChalkRuby
       explain: nil,
       include_meta: nil,
       store_plan_stages: nil,
-      timeout: nil
+      timeout: nil,
+      planner_options: nil
     )
       query_server_request(
         method: :post,
@@ -168,10 +169,11 @@ module ChalkRuby
           meta: meta,
           explain: explain || false,
           include_meta: include_meta || false,
-          store_plan_stages: store_plan_stages || false
+          store_plan_stages: store_plan_stages || false,
+          planner_options: planner_options || {}
         },
         headers: get_authenticated_engine_headers(branch: branch),
-        timeout:
+        timeout: timeout
       )
     end
 

data/lib/chalk_ruby/grpc_client.rb

@@ -146,6 +146,14 @@ module ChalkRuby
       query_service.ping(Chalk::Engine::V1::PingRequest.new(num: 1))
     end
 
+    def convert_to_proto_values(options_hash)
+      return {} if options_hash.nil?
+
+      options_hash.transform_values do |value|
+        convert_to_protobuf_value(value)
+      end
+    end
+
     def query_bulk(
       input:,
       output:,
@@ -157,7 +165,8 @@ module ChalkRuby
       timeout: nil,
       query_name: nil,
       query_name_version: nil,
-      correlation_id: nil
+      correlation_id: nil,
+      planner_options: nil
       )
       # Convert input to feather format
       inputs_feather = to_feather(input)
@@ -167,7 +176,12 @@ module ChalkRuby
         inputs_feather: inputs_feather,
         outputs: output.map { |o| Chalk::Common::V1::OutputExpr.new(feature_fqn: o) },
         staleness: staleness || {},
-        context: context || Chalk::Common::V1::OnlineQueryContext.new(query_name: query_name, query_name_version: query_name_version, correlation_id: correlation_id),
+        context: context || Chalk::Common::V1::OnlineQueryContext.new(
+          query_name: query_name,
+          query_name_version: query_name_version,
+          correlation_id: correlation_id,
+          options: convert_to_proto_values(planner_options)
+        ),
         response_options: response_options || Chalk::Common::V1::OnlineQueryResponseOptions.new,
         body_type: body_type || :FEATHER_BODY_TYPE_UNSPECIFIED
       )
@@ -205,13 +219,16 @@ module ChalkRuby
       explain: nil,
       include_meta: nil,
       store_plan_stages: nil,
-      timeout: nil
+      timeout: nil,
+      planner_options: nil
     )
       formatted_inputs = input.transform_values { |value| self.convert_to_protobuf_value(value) }
 
       context = Chalk::Common::V1::OnlineQueryContext.new(
         query_name: query_name,
         query_name_version: query_name_version,
+        correlation_id: correlation_id,
+        options: planner_options || {}
       )
 
       r = Chalk::Common::V1::OnlineQueryRequest.new(

data/lib/chalk_ruby/version.rb

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

data/test/chalk_ruby/integration/client_test.rb

@@ -3,15 +3,27 @@ require 'rspec/autorun'
 require 'chalk_ruby/client'
 require 'chalk_ruby/error'
 
-CLIENT_ID     = 'client-095f628e339a593e12a58559f5f8cd00'
-CLIENT_SECRET = 'secret-55601b885bcc0d558c4abede69480aaac1dba6e1679889fa1d5196ba04f7af89'
+CLIENT_ID     = ''
+CLIENT_SECRET = ''
 
 RSpec.describe 'Online query' do
   it 'should accept valid queries' do
     client   = ChalkRuby::Client.create(CLIENT_ID, CLIENT_SECRET)
     response = client.query(
       input: { 'user.id': 3454 },
-      output: %w(user.id)
+      output: %w(user.id),
+      query_name: "no_planner_options_test",
+    )
+
+    print response
+  end
+  it 'should run with planner options' do
+    client   = ChalkRuby::Client.create(CLIENT_ID, CLIENT_SECRET)
+    response = client.query(
+      input: { 'user.id': 3454 },
+      output: %w(user.id),
+      query_name: "planner_options_test",
+      planner_options: {'defer_non_bus_persist_operators': "1"} # test planner option
     )
 
     print response

data/test/chalk_ruby/integration/grpc_client_test.rb

@@ -14,8 +14,6 @@ require 'chalk_ruby/protos/chalk/engine/v1/query_server_services_pb'
 require 'arrow'
 
 
-CLIENT_ID     = 'client-095f628e339a593e12a58559f5f8cd00'
-CLIENT_SECRET = 'secret-55601b885bcc0d558c4abede69480aaac1dba6e1679889fa1d5196ba04f7af89'
 
 
 RSpec.describe ChalkRuby::GrpcClient do
@@ -51,16 +49,28 @@ RSpec.describe ChalkRuby::GrpcClient do
     it 'can perform bulk queries' do
       response = client.query_bulk(
         input: { 'user.id': 1 },
-        output: %w(user.id user.socure_score user.full_name)
+        output: %w(user.id user.socure_score),
+        planner_options: {'defer_non_bus_persist_operators': "1"}, # test planner option
+        query_name: "planner_options_test",
+
       )
 
       expect(response).not_to be_nil
-      # The response should be a OnlineQueryBulkResponse
-      # expect(response).to be_a(Chalk::Common::V1::OnlineQueryBulkResponse)
-
-      # puts response.scalars_data
+      # The response should have no errors and user_id of 1
+      expect(response[:errors]).to be_empty
+      expect(response[:data][0]['user.id']).to eq(1)
+    end
+    it 'can perform bulk queries without planner options' do
+      response = client.query_bulk(
+        input: { 'user.id': 1 },
+        output: %w(user.id user.socure_score),
+        query_name: "no_planner_options_test",
+      )
 
-      puts response
+      expect(response).not_to be_nil
+      # The response should have no errors and user_id of 1
+      expect(response[:errors]).to be_empty
+      expect(response[:data][0]['user.id']).to eq(1)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chalk_ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.1
 platform: ruby
 authors:
 - Chalk AI, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-10 00:00:00.000000000 Z
+date: 2025-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -237,6 +237,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- Dockerfile
 - Gemfile
 - LICENSE
 - README.dev.md