Release v1.0.2

Author: sborsje

CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.0.1] - 2025-12-04
-
+## [1.0.2] - 2025-12-04
 
+Updated examples in the README
 

README.md

@@ -31,24 +31,21 @@ client = Klime::Client.new(
   write_key: 'your-write-key'
 )
 
-# Track an event
-client.track('Button Clicked', {
-  button_name: 'Sign up',
-  plan: 'pro'
-})
-
 # Identify a user
 client.identify('user_123', {
   email: '[email protected]',
   name: 'Stefan'
 })
 
-# Group a user with an organization
-client.group('org_456', {
-  name: 'Acme Inc',
-  plan: 'enterprise'
+# Track an event
+client.track('Button Clicked', {
+  button_name: 'Sign up',
+  plan: 'pro'
 }, user_id: 'user_123')
 
+# Associate a user with a group
+client.group('org_456', user_id: 'user_123')
+
 # Shutdown gracefully
 client.shutdown
 ```
@@ -74,16 +71,16 @@ Klime::Client.new(
 
 #### `track(event_name, properties = nil, user_id: nil, group_id: nil, ip: nil)`
 
-Track a user event.
+Track a user event. A `user_id` is required for events to be useful in Klime.
 
 ```ruby
-# Simple usage
+# Basic usage
 client.track('Button Clicked', {
   button_name: 'Sign up',
   plan: 'pro'
-})
+}, user_id: 'user_123')
 
-# With user context and IP
+# With group context and IP
 client.track('Button Clicked', {
   button_name: 'Sign up',
   plan: 'pro'
@@ -103,20 +100,22 @@ client.identify('user_123', {
 
 #### `group(group_id, traits = nil, user_id: nil, ip: nil)`
 
-Associate a user with a group and set group traits.
+Register a group or associate a user with a group.
+
+**Without `user_id`**: Register or update group metadata. Use this when you want to set or update properties on a group (e.g., company name, plan, industry).
 
 ```ruby
-# Simple usage
 client.group('org_456', {
   name: 'Acme Inc',
-  plan: 'enterprise'
+  plan: 'enterprise',
+  industry: 'Technology'
 })
+```
 
-# With user ID and IP
-client.group('org_456', {
-  name: 'Acme Inc',
-  plan: 'enterprise'
-}, user_id: 'user_123', ip: '192.168.1.1')
+**With `user_id`**: Associate a user with a group. Use this to link users to their organization. Keep it simple—no traits needed.
+
+```ruby
+client.group('org_456', user_id: 'user_123')
 ```
 
 #### `flush`
@@ -234,12 +233,13 @@ class KlimeMiddleware
   def call(env)
     status, headers, response = @app.call(env)
 
-    # Track page views
-    if env['REQUEST_METHOD'] == 'GET' && status == 200
+    # Track page views for authenticated users
+    user_id = env['rack.session']&.dig('user_id')
+    if user_id && env['REQUEST_METHOD'] == 'GET' && status == 200
       @client.track('Page View', {
         path: env['PATH_INFO'],
         method: env['REQUEST_METHOD']
-      }, ip: env['REMOTE_ADDR'])
+      }, user_id: user_id, ip: env['REMOTE_ADDR'])
     end
 
     [status, headers, response]

klime.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "klime"
-  spec.version       = "1.0.1"
+  spec.version       = "1.0.2"
   spec.authors       = ["Klime"]
   spec.email         = ["[email protected]"]
 

lib/klime/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Klime
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end