altertable 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8e41db18f92cfe24f4683b754172ebb01eb38ba880184bdf03d1e66b8771153
-  data.tar.gz: 46ce07f124fedec9d6054b3e66e28605fb847816f787506d62b99eda97dd474b
+  metadata.gz: 6578d35fc3a2278e59800c3e1856da5f5a569b8051d912d4dff7f0485fde74e9
+  data.tar.gz: f29994d0c964d70e1f45b000e1fc19ef5ae8b7ce1464d46f3f423374e4d17c15
 SHA512:
-  metadata.gz: 71d0cc5553baba7918630973a66413aeb6eda1f6332977695a8ba686852748a0e9c183a244f343800d81de6535762ce1c64e61d38465b7ca05965e2b89caa3e8
-  data.tar.gz: 8b9e20155315a28c9479b4701b89fba0ec5e2ffcecfff8a19890bb841d1569effd17e6e99fac40dfdf4db73e7e290c41437da83969f6fb48ab182b0c1fcca1a0
+  metadata.gz: '029043ea4734d6ef374f7a426fc48c0b2a387c40d2cd6c5db332e0fef769da063a9ef884ecef6b6538a92d62830b92ddf6b9b76e3753552014332977cc56cc5d'
+  data.tar.gz: 9d517e40f86b34ad5985df17c4ed1511d0c0e0bc8231e24f2fae2a3bf698fc34838ac4d7291a07f9ae1c18a4e520c481c5c9c84c6d605e982f226c6f7147fca2

data/.github/workflows/ci.yml

@@ -3,9 +3,7 @@ name: CI
 on:
   push:
     branches: [main]
-  pull_request:
-    branches: [main]
-
+  pull_request: {}
 jobs:
   lint:
     runs-on: ubuntu-latest

data/.github/workflows/semantic-pull-request.yml

@@ -0,0 +1,16 @@
+name: Semantic Pull Request
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-    ".": "1.1.0"
+    ".": "1.1.2"
 }

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [1.1.2](https://github.com/altertable-ai/altertable-ruby/compare/altertable/v1.1.1...altertable/v1.1.2) (2026-03-19)
+
+
+### Bug Fixes
+
+* **readme:** correct package name ([#33](https://github.com/altertable-ai/altertable-ruby/issues/33)) ([5838578](https://github.com/altertable-ai/altertable-ruby/commit/58385785e8849cda3627bdd04e563eadab933ba3))
+* **transport:** remove the hard dep on `faraday-retry` ([#42](https://github.com/altertable-ai/altertable-ruby/issues/42)) ([f758d02](https://github.com/altertable-ai/altertable-ruby/commit/f758d0254d86de2ea3d6105a429d885c6a8aadbf))
+
+## [1.1.1](https://github.com/altertable-ai/altertable-ruby/compare/altertable/v1.1.0...altertable/v1.1.1) (2026-03-09)
+
+
+### Bug Fixes
+
+* **sorbet:** trigger build ([#31](https://github.com/altertable-ai/altertable-ruby/issues/31)) ([e30cbbf](https://github.com/altertable-ai/altertable-ruby/commit/e30cbbf6aa8c9264423101f69d572d25776ebff2))
+
 ## [1.1.0](https://github.com/altertable-ai/altertable-ruby/compare/altertable/v1.0.0...altertable/v1.1.0) (2026-03-09)
 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    altertable (1.1.0)
+    altertable (1.1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -25,8 +25,6 @@ GEM
       logger
     faraday-net_http (3.4.2)
       net-http (~> 0.5)
-    faraday-retry (2.4.0)
-      faraday (~> 2.0)
     http-2 (1.1.3)
     httpx (1.7.3)
       http-2 (>= 1.1.3)
@@ -144,8 +142,6 @@ DEPENDENCIES
   altertable!
   base64
   faraday (~> 2.0)
-  faraday-net_http
-  faraday-retry
   httpx
   rake (~> 13.0)
   rbs

data/README.md

@@ -1,55 +1,98 @@
 # Altertable Ruby SDK
 
+[![Build Status](https://github.com/altertable-ai/altertable-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/altertable-ai/altertable-ruby/actions)
+[![Gem Version](https://badge.fury.io/rb/altertable.svg)](https://rubygems.org/gems/altertable)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
 Official Ruby SDK for Altertable Product Analytics.
 
-## Installation
+## Install
 
-Add this line to your application's Gemfile:
+Install the gem with a single command:
 
-```ruby
-gem 'altertable-ruby'
+```bash
+gem install altertable
 ```
 
-And then execute:
-
-    $ bundle install
-
-## Usage
+## Quick Start
 
-### Initialization
+Initialize the client and track your first event. Call `track()` to record an action a user performed.
 
 ```ruby
 require 'altertable'
 
-Altertable.init('your_api_key', {
-  environment: 'production'
+# Initialize the Altertable client
+Altertable.init('pk_live_abc123', environment: 'production')
+
+# Track an event
+Altertable.track('button_clicked', 'user_123', properties: {
+  button_id: 'signup_btn',
+  page: 'home'
 })
 ```
 
+## API Reference
+
+### Initialization
+
+Initialize the global Altertable client instance.
+
+`Altertable.init(api_key, options = {})`
+
+```ruby
+Altertable.init('pk_live_abc123', environment: 'production', debug: true)
+```
+
 ### Tracking Events
 
+Record an action performed by a user.
+
+`Altertable.track(event, distinct_id, **options)`
+
 ```ruby
-Altertable.track('button_clicked', 'user_123', properties: {
-  button_id: 'signup_btn',
-  page: 'home'
-}, timestamp: Time.now.utc.iso8601)
+Altertable.track('item_purchased', 'user_123', properties: {
+  item_id: 'item_999',
+  price: 19.99
+})
 ```
 
 ### Identifying Users
 
+Link a user ID to their traits (like email or name).
+
+`Altertable.identify(user_id, **options)`
+
 ```ruby
 Altertable.identify('user_123', traits: {
   email: 'user@example.com',
   name: 'John Doe'
-}, anonymous_id: 'previous_anon_id')
+})
 ```
 
 ### Alias
 
+Merge a previous anonymous ID with a newly identified user ID.
+
+`Altertable.alias(distinct_id, new_user_id, **options)`
+
 ```ruby
-Altertable.alias('previous_anonymous_id', 'new_user_id')
+Altertable.alias('anon_session_456', 'user_123')
 ```
 
+## Configuration
+
+You can configure the client by passing options during initialization.
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `environment` | String | `"production"` | Environment name (e.g., `production`, `development`). |
+| `base_url` | String | `"https://api.altertable.ai"` | Base URL for API requests. |
+| `request_timeout` | Integer | `5` | Request timeout in seconds. |
+| `release` | String | `nil` | Application release version (e.g., commit hash). |
+| `debug` | Boolean | `false` | Enable debug logging. |
+| `on_error` | Proc | `nil` | Callback for handling errors. |
+| `adapter` | Symbol | auto-detect | HTTP adapter to use (`:faraday`, `:httpx`, `:net_http`). |
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/altertable.gemspec

@@ -37,7 +37,5 @@ Gem::Specification.new do |spec|
 
   # Optional adapter support (development only)
   spec.add_development_dependency "faraday", "~> 2.0"
-  spec.add_development_dependency "faraday-retry"
-  spec.add_development_dependency "faraday-net_http"
   spec.add_development_dependency "httpx"
 end

data/lib/altertable/adapters.rb

@@ -18,13 +18,10 @@ module Altertable
       def initialize(base_url:, timeout:, headers: {})
         super
         require "faraday"
-        require "faraday/retry"
-        require "faraday/net_http"
         
         @conn = Faraday.new(url: @base_url) do |f|
           @headers.each { |k, v| f.headers[k] = v }
           f.options.timeout = @timeout
-          f.request :retry, max: 3, interval: 0.05, backoff_factor: 2
           f.adapter Faraday.default_adapter
         end
       end

data/lib/altertable/version.rb

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

data/rbi/altertable.rbi

@@ -77,7 +77,7 @@ module Altertable
       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) }
+      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(Altertable::Adapters::Response) }
       def post(path, body: nil, params: nil, &block); end
     end
 
@@ -85,12 +85,12 @@ module Altertable
       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) }
+      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(Altertable::Adapters::Response) }
       def post(path, body: nil, params: nil, &block); end
 
       private
 
-      sig { params(resp: T.untyped).returns(Response) }
+      sig { params(resp: T.untyped).returns(Altertable::Adapters::Response) }
       def wrap_response(resp); end
     end
 
@@ -98,12 +98,12 @@ module Altertable
       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) }
+      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(Altertable::Adapters::Response) }
       def post(path, body: nil, params: nil, &block); end
 
       private
 
-      sig { params(resp: T.untyped).returns(Response) }
+      sig { params(resp: T.untyped).returns(Altertable::Adapters::Response) }
       def wrap_response(resp); end
     end
 
@@ -111,7 +111,7 @@ module Altertable
       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) }
+      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(Altertable::Adapters::Response) }
       def post(path, body: nil, params: nil, &block); end
     end
   end

data/rbi/todo.rbi

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: altertable
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Altertable
@@ -149,34 +149,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: faraday-retry
-  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-net_http
-  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: httpx
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +174,7 @@ files:
 - ".github/ISSUE_TEMPLATE/feature_request.yml"
 - ".github/workflows/ci.yml"
 - ".github/workflows/release-please.yml"
+- ".github/workflows/semantic-pull-request.yml"
 - ".gitmodules"
 - ".release-please-manifest.json"
 - ".rubocop.yml"