chalk_ruby 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be35291268749664bfdee468de9a997bd421f3b16683ffb847e12f3089f22e46
-  data.tar.gz: 3670d6543e87f11cee499ed8477729364e57a2072437ed798f1a721d7823e93d
+  metadata.gz: 9c3106a09f290ee6b461da0b625682c15d9e855d55cb0ac431dcd709270cb7e0
+  data.tar.gz: 4bab11c1d4580ec5481a46e9a2018e5060ba02cd5b2e044f0599a6cee5ae4ffb
 SHA512:
-  metadata.gz: 87b9e3a20075fda23a00ba5e38dc91827afcc18922b6b664e1fb31676623ce2d67627cd0d1a56831740fa03eeeaf99439841151073bfd1413b33e9811aa45281
-  data.tar.gz: 908b81be15e3c99571a7195f9464496b0f52bb5447f96728d82e2ed57365b5828dfef48c911a42d850ed9262a1bfb4c26b496cd7649e8a1512605c28a10a4c4f
+  metadata.gz: 9772a0495e12a417df35c25492c14ff6fdce02e3d3607fe24762554f9aaad32a6995d0929b61c0d08917606bb4b7a722f7c1b398ad166dc632bdf1e45ea21eb8
+  data.tar.gz: 60aaa19445588e8823d5afb75d4993128179ae5744c5fc0fa0281ca54c372e7f11a934ac6634fedc98687929901e926ad2bd69a338430c48df0adf9d9371868a

data/README.md

@@ -1,6 +1,8 @@
 ## ChalkRuby Ruby
 
-Ruby client for ChalkRuby
+[![Gem Version](https://badge.fury.io/rb/chalk_ruby.svg)](https://badge.fury.io/rb/chalk_ruby)
+
+Ruby client for Chalk!
 
 https://rubygems.org/gems/chalk_ruby
 
@@ -9,7 +11,7 @@ https://rubygems.org/gems/chalk_ruby
 First, install ChalkRuby Ruby API Client via the [RubyGems](https://rubygems.org/) package manager:
 
 ```bash
-gem install chalk_ai
+gem install chalk_ruby
 ```
 
 Then, create a new client using your client ID and client secret:

data/Rakefile

@@ -17,7 +17,7 @@ namespace :test do
   Rake::TestTask.new(:integration) do |t|
     t.libs << 'test'
     t.libs << 'lib'
-    t.test_files = FileList['test/chalk/integration/**/*_test.rb']
+    t.test_files = FileList['test/chalk_ruby/integration/**/*_test.rb']
     t.verbose    = true
     t.warning    = false
   end

data/SECURITY.md

@@ -1,17 +1,17 @@
 ## Security
 
-If you believe you have found a security vulnerability in ChalkRuby's Ruby package, please report it to us!
+If you believe you have found a security vulnerability in Chalk's Ruby package, please report it to us!
 
 ### Reporting Security Issues
 
 **Please do not report security vulnerabilities through public GitHub issues.**
 
-Please email security concerns to [security@chalk_ai.ai](mailto:security@chalk_ai.ai).
+Please email security concerns to [security@chalk.ai](mailto:security@chalk.ai).
 
 ### Security Overview
 
-https://docs.chalk_ai.ai/docs/security
+https://docs.chalk.ai/docs/security
 
 ### SOC-2 Report
 
-To request access to ChalkRuby's SOC-2 report, please email [security@chalk_ai.ai](mailto:security@chalk_ai.ai).
+To request access to ChalkRuby's SOC-2 report, please email [security@chalk.ai](mailto:security@chalk_ruby.ai).

data/lib/chalk_ruby/client.rb

@@ -107,6 +107,12 @@ module ChalkRuby
     #     Typically, each query that you make from your application should have a name.
     #     Chalk will present metrics and dashboard functionality grouped by 'query_name'.
     #
+    # @param query_name_version [String?]
+    #    If query_name is specified, this specifies the version of the named query you're
+    #    making. This is only useful if you want your query to use a NamedQuery with a
+    #    specific name and a specific version. If a query_name has not been supplied, then
+    #    this parameter is ignored.
+    #
     # @param meta [Hash[String, String]?]
     #     Arbitrary `key:value` pairs to associate with a query.
     #
@@ -125,6 +131,9 @@ module ChalkRuby
     #     This option dramatically impacts the performance of the query,
     #     so it should only be used for debugging.
     #
+    # @option options [Float?] :timeout
+    #   Allows overriding default timeout for query operations (in seconds).
+    #
     # @return [Hash[Symbol, String]]
     #
     def query(
@@ -136,10 +145,12 @@ module ChalkRuby
       branch: nil,
       correlation_id: nil,
       query_name: nil,
+      query_name_version: nil,
       meta: nil,
       explain: nil,
       include_meta: nil,
-      store_plan_stages: nil
+      store_plan_stages: nil,
+      timeout: nil
     )
       query_server_request(
         method: :post,
@@ -153,12 +164,14 @@ module ChalkRuby
           branch_id: branch,
           correlation_id: correlation_id,
           query_name: query_name,
+          query_name_version: query_name_version,
           meta: meta,
           explain: explain || false,
           include_meta: include_meta || false,
           store_plan_stages: store_plan_stages || false
         },
-        headers: get_authenticated_engine_headers(branch: branch)
+        headers: get_authenticated_engine_headers(branch: branch),
+        timeout:
       )
     end
 
@@ -214,12 +227,12 @@ module ChalkRuby
       )
     end
 
-    def query_server_request(method:, path:, body:, headers:)
+    def query_server_request(method:, path:, body:, headers:, timeout: nil)
       @transporter.send_request(
         method: method,
         host: query_server_host,
         path: path,
-        timeout: @config.query_timeout,
+        timeout: timeout || @config.query_timeout,
         connect_timeout: @config.connect_timeout,
         body: body,
         headers: headers

data/lib/chalk_ruby/config.rb

@@ -31,13 +31,13 @@ module ChalkRuby
     #   The API server to use.
     #   If not provided, it will be read from the CHALK_API_SERVER environment variable.
     #
-    # @option options [Integer?] :read_timeout
-    #   The timeout for read operations (in seconds).
+    # @option options [Float?] :query_timeout
+    #   The timeout for query operations (in seconds).
     #
-    # @option options [Integer?] :write_timeout
-    #   The timeout for write operations (in seconds).
+    # @option options [Float?] :api_timeout
+    #   The timeout for non-query API operations (in seconds).
     #
-    # @option options [Integer?] :connect_timeout
+    # @option options [Float?] :connect_timeout
     #   The timeout for connect operations (in seconds).
     #
     # @option options [Hash<String, String>?] :additional_headers
@@ -49,8 +49,8 @@ module ChalkRuby
       @environment        = opts[:environment] || ENV['CHALK_ACTIVE_ENVIRONMENT']
       @query_server       = opts[:query_server] || ENV['CHALK_QUERY_SERVER'] || Defaults::QUERY_SERVER
       @api_server         = opts[:api_server] || ENV['CHALK_API_SERVER'] || Defaults::API_SERVER
-      @query_timeout      = opts[:query_timeout] || Defaults::API_TIMEOUT
-      @api_timeout        = opts[:api_timeout] || Defaults::QUERY_TIMEOUT
+      @query_timeout      = opts[:query_timeout] || Defaults::QUERY_TIMEOUT
+      @api_timeout        = opts[:api_timeout] || Defaults::API_TIMEOUT
       @connect_timeout    = opts[:connect_timeout] || Defaults::CONNECT_TIMEOUT
       @additional_headers = opts[:additional_headers] || {}
 

data/lib/chalk_ruby/http/http_requester_chalk.rb

@@ -34,11 +34,17 @@ module ChalkRuby
         end
 
         unless success?(http_response_code: response.status)
-          decoded_error = json_to_hash(json: response.error, symbolize_keys: true)
-          raise ChalkHttpError.new(
-            code: get_option(hash: decoded_error, key: 'status'),
-            message: get_option(hash: decoded_error, key: 'message')
-          )
+          begin
+            decoded_error = json_to_hash(json: response.error, symbolize_keys: true)
+            message = get_option(hash: decoded_error, key: 'description')
+          rescue MultiJson::ParseError
+            message = response.error
+          ensure
+            raise ChalkHttpError.new(
+              code: response.status,
+              message: message
+            )
+          end
         end
         json_to_hash(json: response.body, symbolize_keys: true)
       end

data/lib/chalk_ruby/version.rb

@@ -1,3 +1,3 @@
 module ChalkRuby
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.1.4'.freeze
 end

data/sig/chalk_ruby/client.rbs

@@ -29,7 +29,8 @@ module ChalkRuby
         meta: Hash[String, String]?,
         explain: bool,
         include_meta: bool,
-        store_plan_stages: bool
+        store_plan_stages: bool,
+        timeout: Float?
       ) -> Hash[Symbol, untyped]
 
     private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chalk_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Chalk AI, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-12 00:00:00.000000000 Z
+date: 2024-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -236,8 +236,8 @@ files:
 - sig/chalk_ruby/http/response.rbs
 - sig/chalk_ruby/token.rbs
 - sig/chalk_ruby/versions.rbs
-- test/chalk_ai/integration/client_test.rb
-- test/chalk_ai/test_helper.rb
+- test/chalk_ruby/integration/client_test.rb
+- test/chalk_ruby/test_helper.rb
 homepage: https://github.com/chalk-ai/chalk-ruby
 licenses:
 - Apache-2.0
@@ -265,5 +265,5 @@ signing_key:
 specification_version: 4
 summary: A simple Ruby client for Chalk
 test_files:
-- test/chalk_ai/integration/client_test.rb
-- test/chalk_ai/test_helper.rb
+- test/chalk_ruby/integration/client_test.rb
+- test/chalk_ruby/test_helper.rb