chalk_ruby 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f55160574645e2052ff5e688d77f508e85dc77ab01f6e97905e3367d85b11156
-  data.tar.gz: 63f3c23d00f5432082229ee40666316058714170e0f71a06e6a61d989b1d0d89
+  metadata.gz: 8e3e6e01afae6634b4b66b557f658573bf4ffd2b657c082652e45185ec48ec05
+  data.tar.gz: 58222edf6ee281ae1cfbaaeec09b628985cfe96ddce3299054f5318e61a1d036
 SHA512:
-  metadata.gz: f6e201a24d058a626add01241c3e065dba7f83f9824701727b36b5991268e845a8aecb3878105dd7f7a2269f9b334e8aaff01696519aab6335213801a842376c
-  data.tar.gz: 107156aececa9c7fdfcd98368f78492cb76c08845be3e49c21a9060275da2844bd96cbe28ab836b6d8a7ec9a2db0a1a5197dba7c8bd5ad4286a447eba1f5e9cf
+  metadata.gz: 0e995a01c66b8086fff20b2b7d1304458d2370a73205b87b2c6c2860df0a03e93affda126d20cf8d018ed3fe32f0e612e6ef4b7cdef5d95d1b5b02456994eb5b
+  data.tar.gz: b00008371f1f5f5a2fbd3113a7e2db1cca4e58100ac5ba8385cfad08f065acb1476d645edc5f853ca5d8a67392cd4b3ce3d2aed8b85f979aebd618bedde48a68

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
       )
@@ -229,13 +243,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.7'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/test/chalk_ruby/integration/client_test.rb

@@ -11,7 +11,19 @@ RSpec.describe 'Online query' 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

@@ -1,64 +1,43 @@
-$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)
-# require 'rspec'
-# require 'chalk_ruby'
-# require 'chalk_ruby'
-
-require 'date'
-require 'rspec/autorun'
-require 'chalk_ruby/grpc_client'
-require 'chalk_ruby/grpc/auth_interceptor'
-require 'chalk_ruby/error'
-require 'chalk_ruby/protos/chalk/server/v1/auth_pb'
-require 'chalk_ruby/protos/chalk/server/v1/auth_services_pb'
-require 'chalk_ruby/protos/chalk/engine/v1/query_server_services_pb'
-require 'arrow'
-
-
-
+require 'rspec'
+require 'chalk_ruby'
 
 RSpec.describe ChalkRuby::GrpcClient do
-  describe '#query' do
+  describe '#query_bulk' do
     let(:client) do
-      ChalkRuby::GrpcClient.new(
-        ChalkRuby::Config.new(
-          query_server: "standard-gke.chalk-develop.gcp.chalk.ai",
-          api_server: "api.staging.chalk.ai:443",
-          client_id: CLIENT_ID,
-          client_secret: CLIENT_SECRET,
-          environment: "tmnmc9beyujew",
-          # api_timeout: 0.6, # seconds
-          # connect_timeout: 0.3, # seconds
-          # query_service_root_ca_path: "/Users/andrew/found_ca.pem" # path to the root ca for chalkai.internal.found.app,
-        )
+      ChalkRuby::GrpcClient.create(
+        ENV.fetch('CHALK_CLIENT_ID'),
+        ENV.fetch('CHALK_CLIENT_SECRET'),
+        ENV.fetch('CHALK_ENVIRONMENT', 'tmnmc9beyujew'),
+        ENV.fetch('CHALK_QUERY_SERVER', 'standard-gke.chalk-develop.gcp.chalk.ai'),
+        ENV.fetch('CHALK_API_SERVER', 'api.staging.chalk.ai:443')
       )
     end
 
-    # it 'can perform queries' do
-    #   response = client.query(
-    #     input: { 'business.id': 1 },
-    #     output: %w(business.id)
-    #   )
-    #
-    #   expect(response).not_to be_nil
-    #
-    #   puts response
-    #   # The response should be a OnlineQueryBulkResponse
-    #   # expect(response).to be_a(Chalk::Common::V1::OnlineQueryBulkResponse)
-    # end
-
     it 'can perform bulk queries' do
       response = client.query_bulk(
         input: { 'user.id': 1 },
-        output: %w(user.id user.socure_score)
+        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.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Chalk AI, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-08 00:00:00.000000000 Z
+date: 2025-03-26 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