chalk_ruby 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2ede1c8828c78063446a6dde9f51f7b9bc487c5d25a4ffc36d4fa48c200504b
-  data.tar.gz: 80d0d2513511d278d9ceeb2b64b71935287d9957c5f9df7e2e4758eea217b25f
+  metadata.gz: 9c3106a09f290ee6b461da0b625682c15d9e855d55cb0ac431dcd709270cb7e0
+  data.tar.gz: 4bab11c1d4580ec5481a46e9a2018e5060ba02cd5b2e044f0599a6cee5ae4ffb
 SHA512:
-  metadata.gz: 0afdcc9b35ce5ae8a2cc4a1761e958ed844d0e0dc5e36f77192e538018fd420fca7ab0316a2ed4b6a85e4a05db896ace76385db236c5e1075d58ccd854396547
-  data.tar.gz: 55ef6712afc0f55785065e19a8ef9392c1319851df453742192703cd4f396c4ae9971b429464b6bd40443956193d9036fa84975eaee37113e22c3fc8971ad654
+  metadata.gz: 9772a0495e12a417df35c25492c14ff6fdce02e3d3607fe24762554f9aaad32a6995d0929b61c0d08917606bb4b7a722f7c1b398ad166dc632bdf1e45ea21eb8
+  data.tar.gz: 60aaa19445588e8823d5afb75d4993128179ae5744c5fc0fa0281ca54c372e7f11a934ac6634fedc98687929901e926ad2bd69a338430c48df0adf9d9371868a

data/README.md

@@ -8,7 +8,7 @@ https://rubygems.org/gems/chalk_ruby
 
 ## Getting Started
 
-First, install `chalk_ruby` via the [RubyGems](https://rubygems.org/) package manager:
+First, install ChalkRuby Ruby API Client via the [RubyGems](https://rubygems.org/) package manager:
 
 ```bash
 gem install chalk_ruby

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/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.3'.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.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Chalk AI, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-26 00:00:00.000000000 Z
+date: 2024-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler