hangarx 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68fb5a44f579f4f336f4f63f73f20a1a879fc1beda7b4511bb0a8dcaa11c2923
-  data.tar.gz: dd2417a945455c958e16f4860c585c69eb89422d1fd1a0e2c23cbb558e1da51a
+  metadata.gz: 9daa2494e5b9047d2cb0bb663bbc3cb605b611d688ffcbc1c79ff6298b856533
+  data.tar.gz: 9b65fbec9f2f49bbe2ee2e4c265859d76290696d9c2414763ff04df8ba0864a3
 SHA512:
-  metadata.gz: cee585156d868525dfe51e7a60086234a157b50d0232f34d689f707f3eae1851901cdd71535e72db50bd88c4c4949909100ae54a90092e4b5646b90dd907ed22
-  data.tar.gz: 91debdb39accc97b1af8380566baf65f2d3c2cd66a62c21a3f23221428583778ca5cf2ea2391113015624a4861e7eaa79033ace3a041ea0abfbde12fa5631c61
+  metadata.gz: 51d46059ab58b45af48689f3d95836730612189743a7e79ce67501ef43b21e6c7e1f8488874c0a9b64e610d9dd8a0032005ca6b4ce58aa5f29386b79d3fb475a
+  data.tar.gz: 177c3f139635cfb39869d642b84fa0e6d7dbf94e843ec951149e1c875fc33b6571f592590031a085137bbf90e01dbe3897912f116b0db68cea0afea1d62f26f0

data/README.md

@@ -81,7 +81,158 @@ hangarx.page(
 )
 ```
 
-### 3. Use Growth OS Features
+### 3. Multi-Tenancy Tracking
+
+Track analytics across Organizations, Teams, Client Accounts, and Projects by adding context to your events.
+
+#### Hierarchy Structure
+
+```
+Organizations (Partners/Agencies)
+    ↓
+Teams (Collaboration Units)
+    ↓
+Client Accounts (Business Entities)
+    ↓
+Projects (Websites/Apps)
+    ↓
+Events (User Actions)
+```
+
+#### Adding Multi-Tenancy Context
+
+```ruby
+# Track event with full context
+hangarx.track(
+  user_id: 'user-123',
+  event: 'api_request',
+  properties: {
+    endpoint: '/api/users',
+    method: 'POST',
+    response_time: 145,
+    
+    # Multi-tenancy context
+    organization_id: 'org_marketing_agency',
+    team_id: 'team_client_services',
+    client_account_id: 'client_acme_corp',
+    project_id: 'proj_acme_website'
+  }
+)
+
+# Identify user with context
+hangarx.identify(
+  user_id: 'user-123',
+  traits: {
+    email: 'user@example.com',
+    name: 'John Doe',
+    
+    # Multi-tenancy context
+    organization_id: 'org_marketing_agency',
+    team_id: 'team_client_services',
+    role: 'admin'
+  }
+)
+```
+
+#### Use Cases
+
+**Partner Agency Managing Multiple Clients:**
+
+```ruby
+AGENCY_CONTEXT = {
+  organization_id: 'org_marketing_agency',
+  team_id: 'team_client_services'
+}
+
+# Client 1: E-commerce Store
+hangarx.track(
+  user_id: 'user-123',
+  event: 'product_viewed',
+  properties: {
+    product_id: 'prod_456',
+    **AGENCY_CONTEXT,
+    client_account_id: 'client_ecommerce',
+    project_id: 'proj_store_website'
+  }
+)
+
+# Client 2: SaaS Company
+hangarx.track(
+  user_id: 'user-789',
+  event: 'signup_completed',
+  properties: {
+    plan: 'pro',
+    **AGENCY_CONTEXT,
+    client_account_id: 'client_saas',
+    project_id: 'proj_saas_app'
+  }
+)
+```
+
+**Consultant Managing Client Projects:**
+
+```ruby
+CONSULTANT_CONTEXT = {
+  team_id: 'team_john_consulting',
+  consultant_id: 'user_john'
+}
+
+# Client A: Restaurant
+hangarx.track(
+  user_id: 'visitor-123',
+  event: 'reservation_made',
+  properties: {
+    date: '2025-10-15',
+    party_size: 4,
+    **CONSULTANT_CONTEXT,
+    client_account_id: 'client_restaurant',
+    project_id: 'proj_restaurant_site'
+  }
+)
+```
+
+#### Helper Module
+
+Create a reusable context module:
+
+```ruby
+module AnalyticsContext
+  def self.build(org_id: nil, team_id: nil, client_id: nil, project_id: nil)
+    {}.tap do |ctx|
+      ctx[:organization_id] = org_id if org_id
+      ctx[:team_id] = team_id if team_id
+      ctx[:client_account_id] = client_id if client_id
+      ctx[:project_id] = project_id if project_id
+    end
+  end
+  
+  def self.track(user_id:, event:, properties: {}, **context_params)
+    context = build(**context_params)
+    HangarX.track(
+      user_id: user_id,
+      event: event,
+      properties: properties.merge(context)
+    )
+  end
+end
+
+# Usage
+AnalyticsContext.track(
+  user_id: 'user-123',
+  event: 'button_clicked',
+  properties: { button: 'signup' },
+  org_id: 'org_abc',
+  team_id: 'team_xyz',
+  client_id: 'client_def',
+  project_id: 'proj_ghi'
+)
+```
+
+For complete multi-tenancy documentation, see [SDK_MULTI_TENANCY_TRACKING.md](../../SDK_MULTI_TENANCY_TRACKING.md)
+
+---
+
+### 4. Use Growth OS Features
 
 ```ruby
 # Ask analytics questions

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hangarx
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - HangarX Team