altertable 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42523b8dd9072dbe3eb2756a5a496de2c9e3db0db518b6ae2620c4c383bb7547
-  data.tar.gz: 4fc356b335e47bab34332d4ca42e5d4994381bd388da5079106e96b6c28d6c28
+  metadata.gz: e0d8bbcf3d0a16093a6dd081bebe5d26d36abd91abeee71d8f11bac2ccfbac2c
+  data.tar.gz: 23ed4a849df8c765bc6bf383bf0b58b368d6b6c63be1105b27acc2589a2ad7c7
 SHA512:
-  metadata.gz: 597516dc39dfca5c441174e83dfc519ddc73a81c9a9b88eaeb666262ed255dac382b87870c183ac1c154c382d141c255eef15e0059c3bd5f25c42445f0ae71b9
-  data.tar.gz: 5146fdc9c3b3693ba18196ec27fa5870e6ea690647632ead38f7c1424f343a42aa76396d5cae5ce42f1471a2088da5d926e5928761c60485dc0c8037bbcbca42
+  metadata.gz: 40b209ff5eb900a7ffbad8a0bac3abb67b11a0e5191eb4fdcd8c2d4db1acb3e5135bef6345c54c3846cb2452dada718796059e9462787086d14c9659e37ad532
+  data.tar.gz: 073c87ac9409ed80d4c03d7762493dc5e9126811736385b313db3fa590dd55d6144fdea582ca85a1c1837bfa60b7a83374d174f051199ca82f6334c3bc317497

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-    ".": "0.2.2"
+    ".": "0.4.0"
 }

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.4.0](https://github.com/altertable-ai/altertable-ruby/compare/altertable/v0.3.0...altertable/v0.4.0) (2026-03-09)
+
+
+### Features
+
+* Add Sorbet typings (RBI) ([#21](https://github.com/altertable-ai/altertable-ruby/issues/21)) ([507b41c](https://github.com/altertable-ai/altertable-ruby/commit/507b41c755d76758ed0de777acb8eeadea420758))
+
+## [0.3.0](https://github.com/altertable-ai/altertable-ruby/compare/altertable/v0.2.2...altertable/v0.3.0) (2026-03-09)
+
+
+### Features
+
+* add RBS typings for the SDK ([#19](https://github.com/altertable-ai/altertable-ruby/issues/19)) ([38cb619](https://github.com/altertable-ai/altertable-ruby/commit/38cb619f20a7e2c1a1090fb67f7253e122e936c4))
+
 ## [0.2.2](https://github.com/altertable-ai/altertable-ruby/compare/altertable/v0.2.1...altertable/v0.2.2) (2026-03-08)
 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    altertable (0.2.2)
+    altertable (0.4.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/altertable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Altertable
-  VERSION = "0.2.2"
+  VERSION = "0.4.0"
 end

data/rbi/altertable.rbi

@@ -0,0 +1,133 @@
+# typed: true
+
+module Altertable
+  VERSION = T.let(T.unsafe(nil), String)
+
+  class AltertableError < StandardError
+    sig { returns(T.nilable(Exception)) }
+    attr_reader :cause
+
+    sig { params(message: String, cause: T.nilable(Exception)).void }
+    def initialize(message, cause = nil); end
+  end
+
+  class ConfigurationError < AltertableError; end
+
+  class ApiError < AltertableError
+    sig { returns(Integer) }
+    attr_reader :status
+
+    sig { returns(T::Hash[String, T.untyped]) }
+    attr_reader :details
+
+    sig { params(message: String, status: Integer, details: T::Hash[String, T.untyped]).void }
+    def initialize(message, status, details = {}); end
+  end
+
+  class NetworkError < AltertableError; end
+
+  class Client
+    DEFAULT_BASE_URL = T.let(T.unsafe(nil), String)
+    DEFAULT_TIMEOUT = T.let(T.unsafe(nil), Integer)
+    DEFAULT_ENVIRONMENT = T.let(T.unsafe(nil), String)
+
+    sig { params(api_key: String, options: T::Hash[Symbol, T.untyped]).void }
+    def initialize(api_key, options = {}); end
+
+    sig { params(event: String, distinct_id: String, properties: T::Hash[T.any(Symbol, String), T.untyped]).returns(T.untyped) }
+    def track(event, distinct_id, properties = {}); end
+
+    sig { params(user_id: String, traits: T::Hash[T.any(Symbol, String), T.untyped]).returns(T.untyped) }
+    def identify(user_id, traits = {}); end
+
+    sig { params(new_user_id: String, previous_id: String).returns(T.untyped) }
+    def alias(new_user_id, previous_id); end
+
+    private
+
+    sig { params(name: T.nilable(Symbol), options: T::Hash[Symbol, T.untyped]).returns(T.untyped) }
+    def select_adapter(name, options); end
+
+    sig { params(gem_name: String).returns(T::Boolean) }
+    def try_require(gem_name); end
+
+    sig { params(path: String, payload: T::Hash[T.any(Symbol, String), T.untyped]).returns(T.untyped) }
+    def post(path, payload); end
+
+    sig { params(res: T.untyped).returns(T.untyped) }
+    def handle_response(res); end
+
+    sig { params(error: Exception).returns(T.untyped) }
+    def handle_error(error); end
+  end
+
+  module Adapters
+    class Response
+      sig { returns(Integer) }
+      attr_reader :status
+
+      sig { returns(String) }
+      attr_reader :body
+
+      sig { params(status: Integer, body: String).void }
+      def initialize(status, body); end
+    end
+
+    class Base
+      sig { params(base_url: String, timeout: T.any(Integer, Float), headers: T.nilable(T::Hash[String, String])).void }
+      def initialize(base_url:, timeout:, headers: nil); end
+
+      sig { params(path: String, body: T.nilable(String), params: T.nilable(T::Hash[T.any(Symbol, String), T.untyped])).returns(Response) }
+      def post(path, body: nil, params: nil); end
+    end
+
+    class FaradayAdapter < Base
+      sig { params(base_url: String, timeout: T.any(Integer, Float), headers: T.nilable(T::Hash[String, String])).void }
+      def initialize(base_url:, timeout:, headers: nil); end
+
+      sig { params(path: String, body: T.nilable(String), params: T.nilable(T::Hash[T.any(Symbol, String), T.untyped])).returns(Response) }
+      def post(path, body: nil, params: nil); end
+
+      private
+
+      sig { params(resp: T.untyped).returns(Response) }
+      def wrap_response(resp); end
+    end
+
+    class HttpxAdapter < Base
+      sig { params(base_url: String, timeout: T.any(Integer, Float), headers: T.nilable(T::Hash[String, String])).void }
+      def initialize(base_url:, timeout:, headers: nil); end
+
+      sig { params(path: String, body: T.nilable(String), params: T.nilable(T::Hash[T.any(Symbol, String), T.untyped])).returns(Response) }
+      def post(path, body: nil, params: nil); end
+
+      private
+
+      sig { params(resp: T.untyped).returns(Response) }
+      def wrap_response(resp); end
+    end
+
+    class NetHttpAdapter < Base
+      sig { params(base_url: String, timeout: T.any(Integer, Float), headers: T.nilable(T::Hash[String, String])).void }
+      def initialize(base_url:, timeout:, headers: nil); end
+
+      sig { params(path: String, body: T.nilable(String), params: T.nilable(T::Hash[T.any(Symbol, String), T.untyped])).returns(Response) }
+      def post(path, body: nil, params: nil); end
+    end
+  end
+
+  sig { params(api_key: String, options: T::Hash[Symbol, T.untyped]).returns(Client) }
+  def self.init(api_key, options = {}); end
+
+  sig { params(event: String, user_id: String, properties: T::Hash[T.any(Symbol, String), T.untyped]).returns(T.untyped) }
+  def self.track(event, user_id, properties = {}); end
+
+  sig { params(user_id: String, traits: T::Hash[T.any(Symbol, String), T.untyped]).returns(T.untyped) }
+  def self.identify(user_id, traits = {}); end
+
+  sig { params(new_user_id: String, previous_id: String).returns(T.untyped) }
+  def self.alias(new_user_id, previous_id); end
+
+  sig { returns(Client) }
+  def self.client; end
+end

data/sig/altertable/adapters.rbs

@@ -0,0 +1,48 @@
+module Altertable
+  module Adapters
+    class Response
+      attr_reader status: Integer
+      attr_reader body: String
+
+      def initialize: (Integer status, String body) -> void
+    end
+
+    class Base
+      @base_url: String
+      @timeout: Integer | Float
+      @headers: ::Hash[String, String]
+
+      def initialize: (base_url: String, timeout: Integer | Float, ?headers: ::Hash[String, String]) -> void
+      def post: (String path, ?body: String?, ?params: ::Hash[Symbol | String, untyped]) -> Response
+    end
+
+    class FaradayAdapter < Base
+      @conn: untyped
+
+      def initialize: (base_url: String, timeout: Integer | Float, ?headers: ::Hash[String, String]) -> void
+      def post: (String path, ?body: String?, ?params: ::Hash[Symbol | String, untyped]) -> Response
+
+      private
+
+      def wrap_response: (untyped resp) -> Response
+    end
+
+    class HttpxAdapter < Base
+      @client: untyped
+
+      def initialize: (base_url: String, timeout: Integer | Float, ?headers: ::Hash[String, String]) -> void
+      def post: (String path, ?body: String?, ?params: ::Hash[Symbol | String, untyped]) -> Response
+
+      private
+
+      def wrap_response: (untyped resp) -> Response
+    end
+
+    class NetHttpAdapter < Base
+      @uri: URI::HTTP | URI::HTTPS
+
+      def initialize: (base_url: String, timeout: Integer | Float, ?headers: ::Hash[String, String]) -> void
+      def post: (String path, ?body: String?, ?params: ::Hash[Symbol | String, untyped]) -> Response
+    end
+  end
+end

data/sig/altertable/client.rbs

@@ -0,0 +1,32 @@
+module Altertable
+  class Client
+    @api_key: String
+    @base_url: String
+    @environment: String
+    @timeout: Integer | Float
+    @release: String?
+    @debug: bool
+    @on_error: Proc?
+    @adapter: untyped
+
+    DEFAULT_BASE_URL: String
+    DEFAULT_TIMEOUT: Integer
+    DEFAULT_ENVIRONMENT: String
+
+    def initialize: (String api_key, ?::Hash[Symbol, untyped] options) -> void
+
+    def track: (String event, String distinct_id, ?::Hash[Symbol | String, untyped] properties) -> untyped
+
+    def identify: (String user_id, ?::Hash[Symbol | String, untyped] traits) -> untyped
+
+    def alias: (String new_user_id, String previous_id) -> untyped
+
+    private
+
+    def select_adapter: (Symbol? name, ::Hash[Symbol, untyped] options) -> untyped
+    def try_require: (String gem_name) -> bool
+    def post: (String path, ::Hash[Symbol | String, untyped] payload) -> untyped
+    def handle_response: (untyped res) -> untyped
+    def handle_error: (Exception error) -> untyped
+  end
+end

data/sig/altertable/errors.rbs

@@ -0,0 +1,20 @@
+module Altertable
+  class AltertableError < StandardError
+    attr_reader cause: Exception?
+
+    def initialize: (String message, ?Exception? cause) -> void
+  end
+
+  class ConfigurationError < AltertableError
+  end
+
+  class ApiError < AltertableError
+    attr_reader status: Integer
+    attr_reader details: ::Hash[String, untyped]
+
+    def initialize: (String message, Integer status, ?::Hash[String, untyped] details) -> void
+  end
+
+  class NetworkError < AltertableError
+  end
+end

data/sig/altertable/version.rbs

@@ -0,0 +1,3 @@
+module Altertable
+  VERSION: String
+end

data/sig/altertable.rbs

@@ -0,0 +1,13 @@
+module Altertable
+  @client: Client?
+
+  def self.init: (String api_key, ?::Hash[Symbol, untyped] options) -> Client
+
+  def self.track: (String event, String user_id, ?::Hash[Symbol | String, untyped] properties) -> untyped
+
+  def self.identify: (String user_id, ?::Hash[Symbol | String, untyped] traits) -> untyped
+
+  def self.alias: (String new_user_id, String previous_id) -> untyped
+
+  def self.client: () -> Client
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: altertable
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Altertable
@@ -178,7 +178,13 @@ files:
 - lib/altertable/client.rb
 - lib/altertable/errors.rb
 - lib/altertable/version.rb
+- rbi/altertable.rbi
 - release-please-config.json
+- sig/altertable.rbs
+- sig/altertable/adapters.rbs
+- sig/altertable/client.rbs
+- sig/altertable/errors.rbs
+- sig/altertable/version.rbs
 homepage: https://github.com/altertable-ai/altertable-ruby
 licenses:
 - MIT