chalk_ruby 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 475cbc00a9b6c9a048e287fdca499ffd257a768c63471598c1db61d8a4757baf
-  data.tar.gz: bee580988929bc2219c4f6e6778e17eb8c2055ed80799be251d5af21295e32c8
+  metadata.gz: d2ede1c8828c78063446a6dde9f51f7b9bc487c5d25a4ffc36d4fa48c200504b
+  data.tar.gz: 80d0d2513511d278d9ceeb2b64b71935287d9957c5f9df7e2e4758eea217b25f
 SHA512:
-  metadata.gz: 64ea24c0bc3d3ea81f2d32c72a7220c70a5e1c7e88a0dcef1c5907dbccbc40d4f9a9d6d91e1917359ec516c7a864b9ba3a57c2848c98f5dba83a2cf61c8f1d7e
-  data.tar.gz: f8821a753ba007213b63977d6a0b465944320e20d96728db4edd7e57a4a2aeb9b5f79ef2dc18ce5cfa29e648151a354d90061f19f7dd43a77c85c7bf0e28dfa5
+  metadata.gz: 0afdcc9b35ce5ae8a2cc4a1761e958ed844d0e0dc5e36f77192e538018fd420fca7ab0316a2ed4b6a85e4a05db896ace76385db236c5e1075d58ccd854396547
+  data.tar.gz: 55ef6712afc0f55785065e19a8ef9392c1319851df453742192703cd4f396c4ae9971b429464b6bd40443956193d9036fa84975eaee37113e22c3fc8971ad654

data/README.md

@@ -1,13 +1,17 @@
 ## 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
 
 ## Getting Started
 
-First, install ChalkRuby Ruby API Client via the [RubyGems](https://rubygems.org/) package manager:
+First, install `chalk_ruby` 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:
@@ -22,4 +26,4 @@ results = client.query(
 
 ## License
 
-The ChalkRuby Ruby API Client is an open-sourced software licensed under the [Apache 2 License](LICENSE.md).
+The Chalk Ruby API Client is an open-sourced software licensed under the [Apache 2 License](LICENSE.md).

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

@@ -26,6 +26,9 @@ module ChalkRuby
     # @param api_server [String]
     #   ChalkRuby API server
     #
+    # @param additional_headers [Hash[String, String]]
+    #   Additional headers to be sent with every request. Typically not required.
+    #
     # @return self
     #
     def self.create(
@@ -33,14 +36,16 @@ module ChalkRuby
       client_secret = nil,
       environment = nil,
       query_server = nil,
-      api_server = nil
+      api_server = nil,
+      additional_headers = {}
     )
       config = Config.new(
         client_id: client_id,
         client_secret: client_secret,
         environment: environment,
         query_server: query_server,
-        api_server: api_server
+        api_server: api_server,
+        additional_headers: additional_headers
       )
       create_with_config(config)
     end
@@ -153,7 +158,7 @@ module ChalkRuby
           include_meta: include_meta || false,
           store_plan_stages: store_plan_stages || false
         },
-        headers: get_authenticated_headers(branch: branch)
+        headers: get_authenticated_engine_headers(branch: branch)
       )
     end
 
@@ -221,15 +226,17 @@ module ChalkRuby
       )
     end
 
-    def get_authenticated_headers(branch:)
-      t = valid_token
-      {
+    def get_authenticated_engine_headers(branch:)
+      t      = valid_token
+      tokens = {
         'Content-Type': 'application/json',
         'Accept': 'application/json',
         'Authorization': 'Bearer ' + t.token,
         'X-Chalk-Env-Id': @config.environment || t.environment,
-        'X-Chalk-Branch-Id': branch
+        'X-Chalk-Branch-Id': branch,
+        'X-Chalk-Deployment-Type': branch.nil? ? 'engine' : 'branch'
       }
+      tokens.merge(@config.additional_headers)
     end
 
     def get_unauthenticated_headers
@@ -237,7 +244,7 @@ module ChalkRuby
         'Content-Type': 'application/json',
         'Accept': 'application/json',
         'X-Chalk-Env-Id': @config.environment
-      }
+      }.merge(@config.additional_headers)
     end
 
     def query_server_host

data/lib/chalk_ruby/config.rb

@@ -10,7 +10,8 @@ module ChalkRuby
                   :environment,
                   :query_timeout,
                   :api_timeout,
-                  :connect_timeout
+                  :connect_timeout,
+                  :additional_headers
 
     # Creates a new ChalkRuby::Config object for use with ChalkRuby::Client.
     #
@@ -30,24 +31,28 @@ 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
+    #  Additional headers to be sent with every request. Typically not required.
+    #
     def initialize(opts = {})
-      @client_id       = opts[:client_id] || ENV['CHALK_CLIENT_ID']
-      @client_secret   = opts[:client_secret] || ENV['CHALK_CLIENT_SECRET']
-      @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
-      @connect_timeout = opts[:connect_timeout] || Defaults::CONNECT_TIMEOUT
+      @client_id          = opts[:client_id] || ENV['CHALK_CLIENT_ID']
+      @client_secret      = opts[:client_secret] || ENV['CHALK_CLIENT_SECRET']
+      @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::QUERY_TIMEOUT
+      @api_timeout        = opts[:api_timeout] || Defaults::API_TIMEOUT
+      @connect_timeout    = opts[:connect_timeout] || Defaults::CONNECT_TIMEOUT
+      @additional_headers = opts[:additional_headers] || {}
 
       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/version.rb

@@ -1,3 +1,3 @@
 module ChalkRuby
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.3'.freeze
 end

data/sig/chalk_ruby/client.rbs

@@ -4,7 +4,14 @@ module ChalkRuby
     @token: Token?
     @transporter: Http::HttpRequesterChalk
 
-    def self.create: -> Client
+    def self.create: (
+        String? client_id,
+        String? client_secret,
+        String? environment,
+        String? query_server,
+        String? api_server,
+        Hash[String, String]? additional_headers
+      ) -> Client
 
     def self.create_with_config: -> Client
 
@@ -27,7 +34,7 @@ module ChalkRuby
 
     private
 
-    def get_authenticated_headers: -> Hash[Symbol, String | nil]
+    def get_authenticated_engine_headers: (String? branch) -> Hash[Symbol, String | nil]
 
     def get_unauthenticated_headers: -> Hash[Symbol, String | nil]
 

data/sig/chalk_ruby/config.rbs

@@ -1,5 +1,6 @@
 module ChalkRuby
   class Config
+    attr_accessor additional_headers: Hash[String, String]?
     attr_accessor client_id: String
     attr_accessor client_secret: String
 
@@ -22,7 +23,8 @@ module ChalkRuby
         query_timeout: Integer?,
         api_timeout: Integer?,
         connect_timeout: Integer?,
-        compression_type: String?
+        compression_type: String?,
+        additional_headers: Hash[String, String]?
       }
 
     def initialize: (options opts) -> void

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chalk_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Chalk AI, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-01-26 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