altertable 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c8be063d691285f7602a24d6b3a1531423630d7381b458ede9756ada79239c0
-  data.tar.gz: 56bcdd6d6fc488b2f611691bf36a483993695580b9e81984529d70bdcea381a9
+  metadata.gz: 574aa97c12dd4aa1269c82025cb2d754e6efacd84b5ab731677be50489e53798
+  data.tar.gz: 90686c8a67e974d038bf4cf72749c02ef981e159096ab033b6273e50b3ad3f87
 SHA512:
-  metadata.gz: 4b8c97dc8b98784b68f65bbd3f60eba9079bb2522cdfc81d5ccec6e49bc0b2af0d231a7fe1b3923b8644106625c271d8a723252cbbfbcd13c1d13f774fc60622
-  data.tar.gz: a6f4f4d39a09666af08a85317fb64e66065bc1700ad2c47e8be2d1da791d749c623ceb04adbc4bebb5a5c0dcfff94ab4df3042c2cfcc132b2a15fde4036e5eec
+  metadata.gz: 84bfd405b72decd8ab65dced443a74ea5d6bf7b53a16cd206b965e2735085fb3e36e52a71e0a100aa10a6e60801d3e28a1e89a65cdec00e078f97bd35842f071
+  data.tar.gz: ac1939bddc0385a4df1727b98e1eb33d7c85cef7d76d9fb9c151afd22bb8b132522656d6ff75d50126bbb0575c279b0ea722f29c79ff6ed6280db161b5b998ea

data/.github/workflows/ci.yml

@@ -40,3 +40,18 @@ jobs:
 
       - name: Run tests
         run: bundle exec rake spec
+
+  typing:
+    name: "Typing & lint"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+          bundler-cache: true
+      - name: Validate RBS
+        run: bundle exec rbs validate
+      - name: Typecheck with Sorbet
+        run: bundle exec srb tc

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-    ".": "0.3.0"
+    ".": "1.0.0"
 }

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [1.0.0](https://github.com/altertable-ai/altertable-ruby/compare/altertable/v0.4.0...altertable/v1.0.0) (2026-03-09)
+
+
+### ⚠ BREAKING CHANGES
+
+* update method signatures to v0.9.0 specs ([#23](https://github.com/altertable-ai/altertable-ruby/issues/23))
+
+### Features
+
+* update method signatures to v0.9.0 specs ([#23](https://github.com/altertable-ai/altertable-ruby/issues/23)) ([1c26f52](https://github.com/altertable-ai/altertable-ruby/commit/1c26f5229aa4bd3811ac83351df06d3275496d2f))
+
+## [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)
 
 

data/Gemfile

@@ -5,3 +5,5 @@ gemspec
 gem "rspec"
 gem "testcontainers"
 gem "base64"
+
+gem 'tapioca', require: false, group: [:development, :test]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    altertable (0.3.0)
+    altertable (1.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -10,11 +10,13 @@ GEM
       public_suffix (>= 2.0.2, < 8.0)
     ast (2.4.3)
     base64 (0.3.0)
+    benchmark (0.5.0)
     bigdecimal (4.0.1)
     diff-lcs (1.6.2)
     docker-api (2.4.0)
       excon (>= 0.64.0)
       multi_json
+    erubi (1.13.1)
     excon (1.4.0)
       logger
     faraday (2.14.1)
@@ -40,6 +42,7 @@ GEM
     multi_json (1.19.1)
     net-http (0.9.1)
       uri (>= 0.11.1)
+    netrc (0.11.0)
     parallel (1.27.0)
     parser (3.3.10.2)
       ast (~> 2.4.1)
@@ -49,7 +52,14 @@ GEM
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.3.1)
+    rbi (0.3.9)
+      prism (~> 1.0)
+      rbs (>= 3.4.4)
+    rbs (3.10.3)
+      logger
+      tsort
     regexp_parser (2.11.3)
+    rexml (3.4.4)
     rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -96,18 +106,48 @@ GEM
     rubocop-rspec_rails (2.29.1)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
+    sorbet (0.6.12997)
+      sorbet-static (= 0.6.12997)
+    sorbet-runtime (0.6.12997)
+    sorbet-static (0.6.12997-universal-darwin)
+    sorbet-static (0.6.12997-x86_64-linux)
+    sorbet-static-and-runtime (0.6.12997)
+      sorbet (= 0.6.12997)
+      sorbet-runtime (= 0.6.12997)
+    spoom (1.6.3)
+      erubi (>= 1.10.0)
+      prism (>= 0.28.0)
+      rbi (>= 0.3.3)
+      rexml (>= 3.2.6)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      thor (>= 0.19.2)
+    tapioca (0.16.11)
+      benchmark
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.2)
+      sorbet-static-and-runtime (>= 0.5.11087)
+      spoom (>= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
     testcontainers (0.2.0)
       testcontainers-core (= 0.2.0)
     testcontainers-core (0.2.0)
       docker-api (~> 2.2)
+    thor (1.5.0)
+    tsort (0.2.0)
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)
     unicode-emoji (4.2.0)
     uri (1.1.1)
+    yard (0.9.38)
+    yard-sorbet (0.9.0)
+      sorbet-runtime
+      yard
 
 PLATFORMS
   arm64-darwin-25
-  ruby
   x86_64-linux
 
 DEPENDENCIES
@@ -118,10 +158,14 @@ DEPENDENCIES
   faraday-retry
   httpx
   rake (~> 13.0)
+  rbs
   rspec (~> 3.0, >= 0)
   rubocop (~> 1.0)
   rubocop-performance (~> 1.0)
   rubocop-rspec (~> 2.0)
+  sorbet
+  sorbet-runtime
+  tapioca
   testcontainers
 
 BUNDLED WITH

data/README.md

@@ -29,25 +29,25 @@ Altertable.init('your_api_key', {
 ### Tracking Events
 
 ```ruby
-Altertable.track('button_clicked', 'user_123', {
+Altertable.track('button_clicked', 'user_123', properties: {
   button_id: 'signup_btn',
   page: 'home'
-})
+}, timestamp: Time.now.utc.iso8601)
 ```
 
 ### Identifying Users
 
 ```ruby
-Altertable.identify('user_123', {
+Altertable.identify('user_123', traits: {
   email: 'user@example.com',
   name: 'John Doe'
-})
+}, anonymous_id: 'previous_anon_id')
 ```
 
 ### Alias
 
 ```ruby
-Altertable.alias('new_user_id', 'previous_anonymous_id')
+Altertable.alias('previous_anonymous_id', 'new_user_id')
 ```
 
 ## License

data/altertable.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.metadata["changelog_uri"] = "https://github.com/altertable-ai/altertable-ruby/blob/main/CHANGELOG.md"
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|sorbet)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -31,6 +31,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop-performance", "~> 1.0"
   spec.add_development_dependency "rubocop-rspec", "~> 2.0"
   spec.add_development_dependency "testcontainers"
+  spec.add_development_dependency "rbs"
+  spec.add_development_dependency "sorbet"
+  spec.add_development_dependency "sorbet-runtime"
 
   # Optional adapter support (development only)
   spec.add_development_dependency "faraday", "~> 2.0"

data/lib/altertable/client.rb

@@ -31,9 +31,11 @@ module Altertable
       @adapter = select_adapter(adapter_name, { base_url: @base_url, timeout: @timeout, headers: headers })
     end
 
-    def track(event, distinct_id, properties = {})
+    def track(event, distinct_id, **options)
+      properties = options[:properties] || {}
+      timestamp = options[:timestamp] || Time.now.utc.iso8601(3)
       payload = {
-        timestamp: Time.now.utc.iso8601(3),
+        timestamp: timestamp,
         event: event,
         environment: @environment,
         distinct_id: distinct_id,
@@ -43,26 +45,33 @@ module Altertable
         }.merge(properties)
       }
       payload[:properties]["$release"] = @release if @release
+      payload[:anonymous_id] = options[:anonymous_id] if options.key?(:anonymous_id)
+      payload[:device_id] = options[:device_id] if options.key?(:device_id)
 
       post("/track", payload)
     end
 
-    def identify(user_id, traits = {})
+    def identify(user_id, **options)
+      traits = options[:traits] || {}
+      timestamp = options[:timestamp] || Time.now.utc.iso8601(3)
       payload = {
-        timestamp: Time.now.utc.iso8601(3),
+        timestamp: timestamp,
         environment: @environment,
         distinct_id: user_id,
         traits: traits
       }
+      payload[:anonymous_id] = options[:anonymous_id] if options.key?(:anonymous_id)
+      payload[:device_id] = options[:device_id] if options.key?(:device_id)
 
       post("/identify", payload)
     end
 
-    def alias(new_user_id, previous_id)
+    def alias(distinct_id, new_user_id, **options)
+      timestamp = options[:timestamp] || Time.now.utc.iso8601(3)
       payload = {
-        timestamp: Time.now.utc.iso8601(3),
+        timestamp: timestamp,
         environment: @environment,
-        distinct_id: previous_id,
+        distinct_id: distinct_id,
         new_user_id: new_user_id
       }
 

data/lib/altertable/version.rb

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

data/lib/altertable.rb

@@ -10,16 +10,16 @@ module Altertable
       @client = Client.new(api_key, options)
     end
 
-    def track(event, user_id, properties = {})
-      client.track(event, user_id, properties)
+    def track(event, distinct_id, **options)
+      client.track(event, distinct_id, **options)
     end
 
-    def identify(user_id, traits = {})
-      client.identify(user_id, traits)
+    def identify(user_id, **options)
+      client.identify(user_id, **options)
     end
 
-    def alias(new_user_id, previous_id)
-      client.alias(new_user_id, previous_id)
+    def alias(distinct_id, new_user_id, **options)
+      client.alias(distinct_id, new_user_id, **options)
     end
 
     def client

data/mise.toml

@@ -0,0 +1,2 @@
+[tools]
+ruby = "3.4"

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, options: T.untyped).returns(T.untyped) }
+    def track(event, distinct_id, **options); end
+
+    sig { params(user_id: String, options: T.untyped).returns(T.untyped) }
+    def identify(user_id, **options); end
+
+    sig { params(distinct_id: String, new_user_id: String, options: T.untyped).returns(T.untyped) }
+    def alias(distinct_id, new_user_id, **options); 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]), block: T.nilable(T.proc.params(arg0: T.untyped).void)).returns(Response) }
+      def post(path, body: nil, params: nil, &block); 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]), block: T.nilable(T.proc.params(arg0: T.untyped).void)).returns(Response) }
+      def post(path, body: nil, params: nil, &block); 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]), block: T.nilable(T.proc.params(arg0: T.untyped).void)).returns(Response) }
+      def post(path, body: nil, params: nil, &block); 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]), block: T.nilable(T.proc.params(arg0: T.untyped).void)).returns(Response) }
+      def post(path, body: nil, params: nil, &block); 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, distinct_id: String, options: T.untyped).returns(T.untyped) }
+  def self.track(event, distinct_id, **options); end
+
+  sig { params(user_id: String, options: T.untyped).returns(T.untyped) }
+  def self.identify(user_id, **options); end
+
+  sig { params(distinct_id: String, new_user_id: String, options: T.untyped).returns(T.untyped) }
+  def self.alias(distinct_id, new_user_id, **options); end
+
+  sig { returns(Client) }
+  def self.client; end
+end

data/rbi/todo.rbi

@@ -0,0 +1,6 @@
+module Faraday; end
+class Faraday::ConnectionFailed < StandardError; end
+class Faraday::TimeoutError < StandardError; end
+module HTTPX; end
+class HTTPX::Error < StandardError; end
+class HTTPX::ErrorResponse; end

data/sig/altertable/client.rbs

@@ -15,11 +15,11 @@ module Altertable
 
     def initialize: (String api_key, ?::Hash[Symbol, untyped] options) -> void
 
-    def track: (String event, String distinct_id, ?::Hash[Symbol | String, untyped] properties) -> untyped
+    def track: (String event, String distinct_id, **untyped options) -> untyped
 
-    def identify: (String user_id, ?::Hash[Symbol | String, untyped] traits) -> untyped
+    def identify: (String user_id, **untyped options) -> untyped
 
-    def alias: (String new_user_id, String previous_id) -> untyped
+    def alias: (String distinct_id, String new_user_id, **untyped options) -> untyped
 
     private
 

data/sig/altertable.rbs

@@ -3,11 +3,11 @@ module Altertable
 
   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.track: (String event, String distinct_id, **untyped options) -> untyped
 
-  def self.identify: (String user_id, ?::Hash[Symbol | String, untyped] traits) -> untyped
+  def self.identify: (String user_id, **untyped options) -> untyped
 
-  def self.alias: (String new_user_id, String previous_id) -> untyped
+  def self.alias: (String distinct_id, String new_user_id, **untyped options) -> untyped
 
   def self.client: () -> Client
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: altertable
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Altertable
@@ -93,6 +93,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +220,9 @@ files:
 - lib/altertable/client.rb
 - lib/altertable/errors.rb
 - lib/altertable/version.rb
+- mise.toml
+- rbi/altertable.rbi
+- rbi/todo.rbi
 - release-please-config.json
 - sig/altertable.rbs
 - sig/altertable/adapters.rbs