cekat-event-sdk 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2916e118d56407e2f21b5e4520936221b46bc3d46a5744e24c1612f8b755a2ca
-  data.tar.gz: 206f9d1eb0068e404d1f1b510c767be62889b8de15877dace4b73320f3b9d05b
+  metadata.gz: 7f9238be53f82b0d930ef3504555edaac544bf5743094a78cbcea5d8c470f4a6
+  data.tar.gz: 6f7f015e3391ad9782cfd0067208a5eda7250b19b030be4e5d67ef5b309cd124
 SHA512:
-  metadata.gz: f33ec335fe1a10dcd10272a112ce49f80e2253dc786c9d8aeb1b7c51fb7df260ec9195fee184a6e4fafa2b7870d9c04744d1856cf6f2badeb5c3c9aee4d21700
-  data.tar.gz: b305914695eaaf96983c1b2ced8f4f5c78ead1d9b27f52b58c9afc0b330c21499e1de0ed240349e3736f8853ad3a7b195e44e81a6a8bd74ee6eb77a3809962c5
+  metadata.gz: 457d2f820006ad24fb3fd5420765dd4b16d96d3970051cddcb278268d70c240290ceeba17e8b9dfa08d7df36adf2e63e4457f9e97a153f0469a130d5cb0b0e95
+  data.tar.gz: afd34ab171c2eec29a7e312360dee784108feeac0617e9c63628ced136b83914f6e063afd046201c80ecebe9cfc08035c32796998534d5430822a9020e27ed81

data/README.md

@@ -20,11 +20,12 @@ CEKAT = CekatEventSdk::Client.new(access_token: ENV.fetch("CEKAT_ACCESS_TOKEN"))
 CEKAT.user_registration(email: "person@example.com", contact_name: "Person")
 CEKAT.user_login(phone_number: "+628123456789")
 CEKAT.order_created(email: "person@example.com", properties: { order_id: "o-1" })
+CEKAT.form_submitted(email: "person@example.com", properties: { form_id: "contact" })
 CEKAT.order_paid(email: "person@example.com", properties: { order_id: "o-1" }, amount: 125_000, currency: "IDR")
 ack = CEKAT.custom_event("wishlist_updated", email: "person@example.com")
 ```
 
-Every event method also accepts a `CekatEventSdk::EventInput` or a Hash instead of keyword attributes. `order_paid` additionally requires a finite `amount:` (Integer, Float, BigDecimal, or Rational) and a nonblank `currency:`, sent as the `amount` and `currency` properties; do not also put those keys in `properties`.
+`form_submitted` sends the common `form_submitted` event (`is_common: true`). Every event method also accepts a `CekatEventSdk::EventInput` or a Hash instead of keyword attributes. `order_paid` additionally requires a finite `amount:` (Integer, Float, BigDecimal, or Rational) and a nonblank `currency:`, sent as the `amount` and `currency` properties; do not also put those keys in `properties`.
 
 An `Acknowledgement` means Cekat accepted the event for **asynchronous processing**. It does not confirm durable storage, identity resolution, delivery completion, or analytics availability.
 
@@ -72,6 +73,18 @@ end
 
 The visitor scope lives in fiber storage (`Fiber[]`), so it is isolated per request under threaded servers (Puma) and fiber-based servers (Falcon). Every scope restores the previous visitor when it ends, including when it raises, so long-running workers never leak a visitor ID between requests. Threads and fibers started inside a request begin with a copy of its scope. The scope ends when the middleware returns, so events emitted while a streaming response body is iterated must pass `visitor_id:` explicitly.
 
+## Stripe metadata composition
+
+Use the helper with the merchant's Stripe client; it does not create a Stripe request or send a Cekat event.
+
+```ruby
+metadata = CekatEventSdk::Stripe.merge_metadata(merchant_metadata, CekatEventSdk::Stripe.metadata_from_current_visitor["cekat_" + "visitor_id"])
+# stripe.payment_intents.create(amount: 1200, currency: "usd", metadata: metadata)
+# stripe.checkout.sessions.create(mode: "payment", metadata: metadata, payment_intent_data: { metadata: metadata })
+```
+
+Only a trimmed 1–128 character `[A-Za-z0-9_-]` visitor becomes the Stripe visitor metadata entry. Merge returns a fresh hash, preserving merchant keys and leaving invalid or absent visitor input unchanged.
+
 ## Keep tracking off the request's critical path
 
 Calls are synchronous, so each event adds its round-trip to the request. To send in the background, capture the visitor ID while the request scope is active and pass it explicitly:
@@ -119,7 +132,7 @@ Transport failures, timeouts, and HTTP 429, 500, 502, 503, and 504 are retried,
 ## Configuration
 
 ```ruby
-CekatEventSdk::Client.new(access_token: token, base_url: "https://server.cekat.ai", timeout: 3, retry_count: 2)
+CekatEventSdk::Client.new(access_token: token, base_url: "https://t.cekat.ai", timeout: 3, retry_count: 2)
 ```
 
 `base_url` must be an absolute HTTP(S) origin without credentials, path, query, or fragment; the SDK always posts to `/api/events/ingest`. Requests send `User-Agent: cekat-event-sdk-ruby/<version>`.
@@ -132,7 +145,7 @@ The Net::HTTP transport opens a fresh connection per attempt, never follows redi
 bundle install
 bundle exec rake            # core, Rack, and Rails specs plus RuboCop
 RAILS_VERSION="~> 8.0.0" RACK_VERSION="~> 2.2" bundle update && bundle exec rake spec
-./scripts/package --version 0.1.0 --output /absolute/empty-directory
+./scripts/package --version 0.3.0 --output /absolute/empty-directory
 ```
 
 `scripts/package` runs the specs, RuboCop, and `bundle-audit`, then builds the gem and a SHA-256 `manifest.json`. It never pushes, signs, or tags; releases to RubyGems run from the repository's `release-ruby.yml` workflow when a `ruby/vX.Y.Z` tag is pushed. `scripts/conformance` runs the shared conformance fixtures (see `conformance/README.md`); the three caller-cancellation cases are reported as `not_applicable` for Ruby.

data/lib/cekat_event_sdk/client.rb

@@ -48,6 +48,10 @@ module CekatEventSdk
       track("order_created", true, event_from(event, attributes))
     end
 
+    def form_submitted(event = nil, **attributes)
+      track("form_submitted", true, event_from(event, attributes))
+    end
+
     # The required finite amount and nonblank currency are sent as the "amount" and "currency"
     # properties; the event's properties must not already contain either key.
     def order_paid(event = nil, amount:, currency:, **attributes)

data/lib/cekat_event_sdk/stripe.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module CekatEventSdk
+  # Builds Stripe metadata for optional Cekat visitor correlation.
+  module Stripe
+    VISITOR_METADATA_KEY = "cekat_visitor_id"
+
+    module_function
+
+    def metadata_for_visitor(visitor_id)
+      normalized = valid_visitor_id(visitor_id)
+      normalized.nil? ? {} : { VISITOR_METADATA_KEY => normalized }
+    end
+
+    def metadata_from_current_visitor
+      metadata_for_visitor(VisitorContext.current_visitor_id)
+    end
+
+    def merge_metadata(metadata, visitor_id)
+      merged = metadata.dup
+      normalized = valid_visitor_id(visitor_id)
+      merged[VISITOR_METADATA_KEY] = normalized unless normalized.nil?
+      merged
+    end
+
+    def valid_visitor_id(visitor_id)
+      return nil unless visitor_id.is_a?(String)
+
+      normalized = visitor_id.strip
+      return nil unless normalized.match?(/\A[A-Za-z0-9_-]{1,128}\z/)
+
+      normalized
+    end
+    private_class_method :valid_visitor_id
+  end
+end

data/lib/cekat_event_sdk/version.rb

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

data/lib/cekat_event_sdk.rb

@@ -4,7 +4,7 @@ require_relative "cekat_event_sdk/version"
 
 # Cekat event SDK: submit identity-bearing events and correlate them with the browser visitor.
 module CekatEventSdk
-  DEFAULT_BASE_URL = "https://server.cekat.ai"
+  DEFAULT_BASE_URL = "https://t.cekat.ai"
   INGEST_PATH = "/api/events/ingest"
   VISITOR_HEADER = "X-Cekat-Visitor-ID"
   VISITOR_COOKIE = "_cekat_visitor_id"
@@ -16,6 +16,7 @@ require_relative "cekat_event_sdk/event_input"
 require_relative "cekat_event_sdk/acknowledgement"
 require_relative "cekat_event_sdk/visitor_id_resolver"
 require_relative "cekat_event_sdk/visitor_context"
+require_relative "cekat_event_sdk/stripe"
 require_relative "cekat_event_sdk/payload_builder"
 require_relative "cekat_event_sdk/retry_policy"
 require_relative "cekat_event_sdk/transport"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cekat-event-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Cekat
@@ -29,6 +29,7 @@ files:
 - lib/cekat_event_sdk/rails.rb
 - lib/cekat_event_sdk/response_decoder.rb
 - lib/cekat_event_sdk/retry_policy.rb
+- lib/cekat_event_sdk/stripe.rb
 - lib/cekat_event_sdk/transport.rb
 - lib/cekat_event_sdk/version.rb
 - lib/cekat_event_sdk/visitor_context.rb