chalk_ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4fd0a5371c88110f52a5c065272d227414d4b0e51dde2404ef25d4ade9ed1da
-  data.tar.gz: ea5a203ada4c2f203bba64b8fe6329648b0ddd616358ee39e5fea8d0f4423c1e
+  metadata.gz: 475cbc00a9b6c9a048e287fdca499ffd257a768c63471598c1db61d8a4757baf
+  data.tar.gz: bee580988929bc2219c4f6e6778e17eb8c2055ed80799be251d5af21295e32c8
 SHA512:
-  metadata.gz: 903bc4377ae97bc37417e3ffd510b2a0aae0259f5b5062039f38707dc3d8f6e01279872e5531a855423d7fbe233e1f2819a9c3d4b4368370c4425f4dc4d4d661
-  data.tar.gz: 2fa0ef1c0c242e3074eff668c36a7f143bbdfff865441a55419ca486348622bcfac91a8742ed2bce3ff82b6fc4ce48ea58a5781ada24185207b9ecf3bc62dc74
+  metadata.gz: 64ea24c0bc3d3ea81f2d32c72a7220c70a5e1c7e88a0dcef1c5907dbccbc40d4f9a9d6d91e1917359ec516c7a864b9ba3a57c2848c98f5dba83a2cf61c8f1d7e
+  data.tar.gz: f8821a753ba007213b63977d6a0b465944320e20d96728db4edd7e57a4a2aeb9b5f79ef2dc18ce5cfa29e648151a354d90061f19f7dd43a77c85c7bf0e28dfa5

data/.rubocop_todo.yml

@@ -1,14 +1,3 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2019-12-12 11:07:55 +0100 using RuboCop version 0.77.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
 Style/Documentation:
   Exclude:
-    - 'spec/**/*'
     - 'test/**/*'
-    - 'lib/rubybundle/search_config.rb'

data/lib/chalk_ruby/client.rb

@@ -1,55 +1,36 @@
-require 'chalk_ruby/config/config'
+require 'chalk_ruby/config'
 require 'chalk_ruby/logger_helper'
-require 'chalk_ruby/transport/transport'
+require 'chalk_ruby/http/http_requester_chalk'
 require 'chalk_ruby/http/response'
+require 'chalk_ruby/token'
 
 module ChalkRuby
-  class Token
-    attr_accessor :token, :expires_at, :environment, :engines
-
-    # @param [Hash[String, untyped]] exchange_credentials_response
-    def initialize(exchange_credentials_response)
-      @token       = exchange_credentials_response[:access_token]
-      @expires_at  = DateTime.parse(exchange_credentials_response[:expires_at])
-      @environment = exchange_credentials_response[:primary_environment]
-      @engines     = exchange_credentials_response[:engines]
-    end
-
-    def expired?
-      DateTime.now.advance({ seconds: 60 }) > @expires_at
-    end
-  end
-
   class Client
-    # Initializes the Personalization client
+    # Create a new client.
     #
-    # @param chalk_config [ChalkRuby::Config] a ChalkRuby::Config object which contains your APP_ID and API_KEY
-    # @option adapter [Object] adapter object used for the connection
-    # @option logger [Object]
-    # @option http_requester [Object] http_requester object used for the connection
+    # @param client_id [String]
+    #   Chalk client ID.
+    #   If not provided, it will be read from the CHALK_CLIENT_ID environment variable.
     #
-    def initialize(chalk_config, opts = {})
-      @token       = nil
-      @config      = chalk_config
-      adapter      = opts[:adapter] || Defaults::ADAPTER
-      logger       = opts[:logger] || LoggerHelper.create
-      requester    = opts[:http_requester] || Defaults::REQUESTER_CLASS.new(adapter: adapter, logger: logger)
-      @transporter = Transport::Transport.new(requester: requester)
-    end
-
-    # Create a new client providing only app ID and API key
+    # @param client_secret [String]
+    #   Chalk client secret.
+    #   If not provided, it will be read from the CHALK_CLIENT_SECRET environment variable.
     #
-    # @param client_id [String] ChalkRuby application ID
-    # @param client_secret [String] ChalkRuby API key
-    # @param environment [String] ChalkRuby environment
-    # @param query_server [String] ChalkRuby query server
-    # @param api_server [String] ChalkRuby API server
+    # @param environment [String]
+    #   The Chalk environment id (not the name of the environment).
+    #   If not provided, it will be read from the CHALK_ACTIVE_ENVIRONMENT environment variable.
+    #
+    # @param query_server [String]
+    #   ChalkRuby query server
+    #
+    # @param api_server [String]
+    #   ChalkRuby API server
     #
     # @return self
     #
     def self.create(
-      client_id,
-      client_secret,
+      client_id = nil,
+      client_secret = nil,
       environment = nil,
       query_server = nil,
       api_server = nil
@@ -87,46 +68,137 @@ module ChalkRuby
     #     is defined on the `User` namespace, and all features on the `User` namespace
     #     (excluding has-one and has-many relationships) will be used as outputs.
     #
+    # @param now [DateTime?]
+    #     The time at which to evaluate the query. If not specified, the current time will be used.
+    #     This parameter is complex in the context of online_query since the online store
+    #     only stores the most recent value of an entity's features. If `now` is in the past,
+    #     it is extremely likely that `None` will be returned for cache-only features.
+    #
+    #     This parameter is primarily provided to support:
+    #        - controlling the time window for aggregations over cached has-many relationships
+    #        - controlling the time window for aggregations over has-many relationships loaded from an
+    #          external database
+    #
+    #     If you are trying to perform an exploratory analysis of past feature values, prefer `offline_query`.
+    #
+    # @param staleness [Hash[String, String]?]
+    #     Maximum staleness overrides for any output features or intermediate features.
+    #     See https://docs.chalk.ai/docs/query-caching for more information.
+    #
+    # @param tags [Hash[String, String]?]
+    #     The tags used to scope the resolvers.
+    #     See https://docs.chalk.ai/docs/resolver-tags for more information.
+    #
+    # @param branch [String?]
+    #     If specified, Chalk will route your request to the relevant branch.
+    #
+    # @param correlation_id [String?]
+    #     You can specify a correlation ID to be used in logs and web interfaces.
+    #     This should be globally unique, i.e. a `uuid` or similar. Logs generated
+    #     during the execution of your query will be tagged with this correlation id.
+    #
+    # @param query_name [String?]
+    #     The semantic name for the query you're making, for example, `"loan_application_model"`.
+    #     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 meta [Hash[String, String]?]
+    #     Arbitrary `key:value` pairs to associate with a query.
+    #
+    # @param explain [Boolean?]
+    #     Log the query execution plan. Requests using `explain=true` will be slower
+    #     than requests using `explain=false`. If `"only"`, the query will not be executed,
+    #     and only the query plan will be returned.
+    #
+    #     If true, 'include_meta' will be set to true as well.
+    #
+    # @param include_meta [Boolean?]
+    #     Whether to include metadata about the query execution.
+    #
+    # @param store_plan_stages [Boolean?]
+    #     If `true`, the output of each of the query plan stages will be stored.
+    #     This option dramatically impacts the performance of the query,
+    #     so it should only be used for debugging.
     #
     # @return [Hash[Symbol, String]]
     #
     def query(
       input:,
       output:,
-      # now,
-      opts: {}
-      # _staleness
+      now: nil,
+      staleness: nil,
+      tags: nil,
+      branch: nil,
+      correlation_id: nil,
+      query_name: nil,
+      meta: nil,
+      explain: nil,
+      include_meta: nil,
+      store_plan_stages: nil
     )
       query_server_request(
         method: :post,
         path: 'v1/query/online',
         body: {
           inputs: input,
-          outputs: output
-          # now: now
+          outputs: output,
+          now: now,
+          staleness: staleness,
+          context: tags && { tags: tags },
+          branch_id: branch,
+          correlation_id: correlation_id,
+          query_name: query_name,
+          meta: meta,
+          explain: explain || false,
+          include_meta: include_meta || false,
+          store_plan_stages: store_plan_stages || false
         },
-        headers: get_authenticated_headers
+        headers: get_authenticated_headers(branch: branch)
       )
     end
 
     def get_token
-      response = api_server_request(
-        method: :post,
-        path: '/v1/oauth/token',
-        body: {
-          client_id: @config.client_id,
-          client_secret: @config.client_secret,
-          grant_type: 'client_credentials'
-        },
-        headers: get_unauthenticated_headers
+      Token.new(
+        api_server_request(
+          method: :post,
+          path: '/v1/oauth/token',
+          body: {
+            client_id: @config.client_id,
+            client_secret: @config.client_secret,
+            grant_type: 'client_credentials'
+          },
+          headers: get_unauthenticated_headers
+        )
       )
-      Token.new(response)
+    end
+
+    # Initializes the ChalkRuby client. Generally, you should not need to call this directly.
+    # Instead, use ChalkRuby::Client.create or ChalkRuby::Client.create_with_config.
+    #
+    # @param chalk_config [ChalkRuby::Config]
+    #   A ChalkRuby::Config object which contains your CLIENT_ID and CLIENT_SECRET
+    #
+    # @option adapter [Object]
+    #   Adapter object used for the connection
+    #
+    # @option logger [Object]
+    #
+    # @option http_requester [Object]
+    #   object used for the connection
+    #
+    def initialize(chalk_config, opts = {})
+      @token       = nil
+      @config      = chalk_config
+      adapter      = opts[:adapter] || Defaults::ADAPTER
+      logger       = opts[:logger] || LoggerHelper.create
+      requester    = opts[:http_requester] || Defaults::REQUESTER_CLASS.new(adapter: adapter, logger: logger)
+      @transporter = Http::HttpRequesterChalk.new(requester: requester)
     end
 
     private
 
     def api_server_request(method:, path:, body:, headers:)
-      @transporter.request_simple(
+      @transporter.send_request(
         method: method,
         host: @config.api_server,
         path: path,
@@ -138,7 +210,7 @@ module ChalkRuby
     end
 
     def query_server_request(method:, path:, body:, headers:)
-      @transporter.request_simple(
+      @transporter.send_request(
         method: method,
         host: query_server_host,
         path: path,
@@ -149,13 +221,14 @@ module ChalkRuby
       )
     end
 
-    def get_authenticated_headers
+    def get_authenticated_headers(branch:)
       t = valid_token
       {
         'Content-Type': 'application/json',
         'Accept': 'application/json',
         'Authorization': 'Bearer ' + t.token,
-        'X-ChalkRuby-Environment': @config.environment || t.environment
+        'X-Chalk-Env-Id': @config.environment || t.environment,
+        'X-Chalk-Branch-Id': branch
       }
     end
 
@@ -163,7 +236,7 @@ module ChalkRuby
       {
         'Content-Type': 'application/json',
         'Accept': 'application/json',
-        'X-ChalkRuby-Environment': @config.environment
+        'X-Chalk-Env-Id': @config.environment
       }
     end
 
@@ -187,6 +260,5 @@ module ChalkRuby
         @token
       end
     end
-
   end
 end

data/lib/chalk_ruby/{config/config.rb → config.rb}

@@ -12,14 +12,32 @@ module ChalkRuby
                   :api_timeout,
                   :connect_timeout
 
+    # Creates a new ChalkRuby::Config object for use with ChalkRuby::Client.
     #
-    # @option options [String] :client_id
-    # @option options [String] :client_secret
-    # @option options [String] :query_host
-    # @option options [String] :api_host
-    # @option options [Integer] :read_timeout
-    # @option options [Integer] :write_timeout
-    # @option options [Integer] :connect_timeout
+    # @option options [String?] :client_id
+    #   The Chalk client ID.
+    #   If not provided, it will be read from the CHALK_CLIENT_ID environment variable.
+    #
+    # @option options [String?] :client_secret
+    #   Chalk client secret.
+    #   If not provided, it will be read from the CHALK_CLIENT_SECRET environment variable.
+    #
+    # @option options [String?] :query_host
+    #   The query server to use.
+    #   If not provided, it will be read from the CHALK_QUERY_SERVER environment variable.
+    #
+    # @option options [String?] :api_host
+    #   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 [Integer?] :write_timeout
+    #   The timeout for write operations (in seconds).
+    #
+    # @option options [Integer?] :connect_timeout
+    #   The timeout for connect operations (in seconds).
     #
     def initialize(opts = {})
       @client_id       = opts[:client_id] || ENV['CHALK_CLIENT_ID']
@@ -34,6 +52,5 @@ module ChalkRuby
       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?
     end
-
   end
 end

data/lib/chalk_ruby/defaults.rb

@@ -2,14 +2,14 @@ require 'chalk_ruby/http/http_requester'
 
 module ChalkRuby
   module Defaults
-    REQUESTER_CLASS = ChalkRuby::Http::HttpRequester
+    REQUESTER_CLASS = Http::HttpRequester
     ADAPTER         = 'net_http_persistent'
 
     # HTTP Headers
     # ----------------------------------------
-    HEADER_CLIENT_ID     = 'X-ChalkRuby-Client-Id'.freeze
-    HEADER_CLIENT_SECRET = 'X-ChalkRuby-Client-Secret'.freeze
-    HEADER_ENVIRONMENT   = 'X-ChalkRuby-Env-Id'.freeze
+    HEADER_CLIENT_ID     = 'X-Chalk-Client-Id'.freeze
+    HEADER_CLIENT_SECRET = 'X-Chalk-Client-Secret'.freeze
+    HEADER_ENVIRONMENT   = 'X-Chalk-Env-Id'.freeze
     AUTHORIZATION_HEADER = 'Authorization'.freeze
     USER_AGENT           = "ChalkRuby Ruby (#{ChalkRuby::VERSION}), Ruby (#{RUBY_VERSION})"
 
@@ -27,9 +27,9 @@ module ChalkRuby
 
     # HTTP TIMEOUTS
     # ----------------------------------------
-    CONNECT_TIMEOUT = 2
-    API_TIMEOUT     = 10
-    QUERY_TIMEOUT   = 120
+    CONNECT_TIMEOUT = 100
+    API_TIMEOUT     = 300
+    QUERY_TIMEOUT   = 1200
 
     WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY = 100
   end

data/lib/chalk_ruby/helpers.rb

@@ -40,6 +40,5 @@ module ChalkRuby
     def self.included(base)
       base.extend(Helpers)
     end
-
   end
 end

data/lib/chalk_ruby/http/http_requester.rb

@@ -27,7 +27,7 @@ module ChalkRuby
       # @param timeout [Integer]
       # @param connect_timeout [Integer]
       #
-      # @return [Http::Response]
+      # @return [Response]
       #
       def send_request(
         host:,
@@ -57,24 +57,23 @@ module ChalkRuby
           if ENV['CHALK_DEBUG']
             @logger.info("Request succeeded. Response status: #{response.status}, body: #{response.body}")
           end
-          return Http::Response.new(status: response.status, body: response.body, headers: response.headers)
+          return Response.new(status: response.status, body: response.body, headers: response.headers)
         end
 
         if ENV['CHALK_DEBUG']
           @logger.info("Request failed. Response status: #{response.status}, error: #{response.body}")
         end
-        Http::Response.new(status: response.status, error: response.body, headers: response.headers)
+        Response.new(status: response.status, error: response.body, headers: response.headers)
       rescue Faraday::TimeoutError => e
         if ENV['CHALK_DEBUG']
           @logger.info("Request timed out. Error: #{e.message}")
         end
-        Http::Response.new(error: e.message, has_timed_out: true)
+        Response.new(error: e.message, has_timed_out: true)
       rescue ::StandardError => e
         if ENV['CHALK_DEBUG']
           @logger.info("Request failed. Error: #{e.message}")
         end
-        Http::Response.new(error: e.message, network_failure: true)
-
+        Response.new(error: e.message, network_failure: true)
       end
 
       # Retrieve the connection from the @connections
@@ -88,7 +87,6 @@ module ChalkRuby
           f.adapter @adapter.to_sym
         end
       end
-
     end
   end
 end

data/lib/chalk_ruby/{transport/transport.rb → http/http_requester_chalk.rb}

@@ -4,8 +4,8 @@ require 'faraday/net_http_persistent' unless Faraday::VERSION < '1'
 require 'chalk_ruby/error'
 
 module ChalkRuby
-  module Transport
-    class Transport
+  module Http
+    class HttpRequesterChalk
       include Helpers
 
       # @param requester [ChalkRuby::Http::HttpRequester] requester used for sending requests.
@@ -14,7 +14,7 @@ module ChalkRuby
         @http_requester = requester
       end
 
-      def request_simple(method:, host:, path:, timeout:, connect_timeout:, headers:, body:)
+      def send_request(method:, host:, path:, timeout:, connect_timeout:, headers:, body:)
         response = @http_requester.send_request(
           host: host,
           method: method,
@@ -48,7 +48,6 @@ module ChalkRuby
       def success?(http_response_code:)
         !http_response_code.nil? && (http_response_code.to_i / 100).floor == 2
       end
-
     end
   end
 end

data/lib/chalk_ruby/token.rb

@@ -0,0 +1,18 @@
+module ChalkRuby
+  class Token
+    attr_accessor :token, :expires_at, :environment, :engines
+
+    # @param [Hash[String, untyped]] exchange_credentials_response
+    def initialize(exchange_credentials_response)
+      @token       = exchange_credentials_response[:access_token]
+      @expires_at  = DateTime.parse(exchange_credentials_response[:expires_at])
+      @environment = exchange_credentials_response[:primary_environment]
+      @engines     = exchange_credentials_response[:engines]
+    end
+
+    def expired?
+      DateTime.now.advance({ seconds: 60 }) > @expires_at
+    end
+  end
+end
+

data/lib/chalk_ruby/version.rb

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

data/lib/chalk_ruby.rb

@@ -1,12 +1,11 @@
-# ChalkRuby module
 module ChalkRuby
   require 'chalk_ruby/version'
   require 'chalk_ruby/helpers'
   require 'chalk_ruby/http/http_requester'
   require 'chalk_ruby/defaults'
-  require 'chalk_ruby/config/config'
+  require 'chalk_ruby/config'
   require 'chalk_ruby/http/response'
-  require 'chalk_ruby/transport/transport'
+  require 'chalk_ruby/http/http_requester_chalk'
   require 'chalk_ruby/client'
   require 'chalk_ruby/error'
   require 'chalk_ruby/logger_helper'

data/sig/chalk_ruby/client.rbs

@@ -2,7 +2,7 @@ module ChalkRuby
   class Client
     @config: Config
     @token: Token?
-    @transporter: Transport::Transport
+    @transporter: Http::HttpRequesterChalk
 
     def self.create: -> Client
 
@@ -11,15 +11,24 @@ module ChalkRuby
     def get_token: -> Token
 
     def query: (
-        ::Hash[Symbol|String, untyped] input,
+        Hash[Symbol | String, untyped] input,
         [String] output,
-        Time? now,
-        ?::Hash[String, String] staleness
+        now: Time?,
+        staleness: Hash[String, String],
+        tags: [String]?,
+        branch: String?,
+        correlation_id: String?,
+        query_name: String?,
+        meta: Hash[String, String]?,
+        explain: bool,
+        include_meta: bool,
+        store_plan_stages: bool
       ) -> Hash[Symbol, untyped]
 
     private
 
     def get_authenticated_headers: -> Hash[Symbol, String | nil]
+
     def get_unauthenticated_headers: -> Hash[Symbol, String | nil]
 
     def query_server_host: -> String

data/sig/chalk_ruby/{config/config.rbs → config.rbs}

@@ -14,15 +14,15 @@ module ChalkRuby
     attr_accessor connect_timeout: Integer
 
     type options = {
-        client_id: String,
-        client_secret: String,
-        environment: String,
-        api_server: String,
-        query_server: String,
-        query_timeout: Integer,
-        api_timeout: Integer,
-        connect_timeout: Integer,
-        compression_type: String
+        client_id: String?,
+        client_secret: String?,
+        environment: String?,
+        api_server: String?,
+        query_server: String?,
+        query_timeout: Integer?,
+        api_timeout: Integer?,
+        connect_timeout: Integer?,
+        compression_type: String?
       }
 
     def initialize: (options opts) -> void

data/sig/chalk_ruby/defaults.rbs

@@ -1,6 +1,6 @@
 module ChalkRuby
   module Defaults
-    REQUESTER_CLASS : Http::HttpRequester
+    REQUESTER_CLASS : untyped
     ADAPTER         : String
 
     # HTTP Headers

data/sig/chalk_ruby/{transport/transport.rbs → http/http_requester_chalk.rbs}

@@ -1,9 +1,9 @@
 module ChalkRuby
-  module Transport
-    class Transport
+  module Http
+    class HttpRequesterChalk
       @http_requester: Http::HttpRequester
 
-      def request_simple: (
+      def send_request: (
           Symbol method,
           String host,
           String path,

data/test/chalk_ai/integration/client_test.rb

@@ -3,9 +3,8 @@ require 'rspec/autorun'
 require 'chalk_ruby/client'
 require 'chalk_ruby/error'
 
-CLIENT_ID     = 'token-941b776a2245c2f5bb3bbdbcf582dce4'
-CLIENT_SECRET = 'ts-f76b5a517fce9a53d47bd91db5fbc31ac7718a27f0555d4ad9387557a9313a0b'
-
+CLIENT_ID     = ''
+CLIENT_SECRET = ''
 
 RSpec.describe 'Online query' do
   it 'should accept valid queries' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chalk_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Chalk AI, Inc.
@@ -214,26 +214,27 @@ files:
 - chalk_ruby.gemspec
 - lib/chalk_ruby.rb
 - lib/chalk_ruby/client.rb
-- lib/chalk_ruby/config/config.rb
+- lib/chalk_ruby/config.rb
 - lib/chalk_ruby/defaults.rb
 - lib/chalk_ruby/error.rb
 - lib/chalk_ruby/helpers.rb
 - lib/chalk_ruby/http/http_requester.rb
+- lib/chalk_ruby/http/http_requester_chalk.rb
 - lib/chalk_ruby/http/response.rb
 - lib/chalk_ruby/logger_helper.rb
-- lib/chalk_ruby/transport/transport.rb
+- lib/chalk_ruby/token.rb
 - lib/chalk_ruby/version.rb
 - renovate.json
 - sig/chalk_ruby/client.rbs
-- sig/chalk_ruby/config/config.rbs
+- sig/chalk_ruby/config.rbs
 - sig/chalk_ruby/defaults.rbs
 - sig/chalk_ruby/error.rbs
 - sig/chalk_ruby/helpers.rbs
+- sig/chalk_ruby/http/_connection.rbs
 - sig/chalk_ruby/http/http_requester.rbs
+- sig/chalk_ruby/http/http_requester_chalk.rbs
 - sig/chalk_ruby/http/response.rbs
-- sig/chalk_ruby/interfaces/_connection.rbs
 - sig/chalk_ruby/token.rbs
-- sig/chalk_ruby/transport/transport.rbs
 - sig/chalk_ruby/versions.rbs
 - test/chalk_ai/integration/client_test.rb
 - test/chalk_ai/test_helper.rb