txlemetry-ruby 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9604f1e77490345c7ead375c8ddcef3af341ff63a0adad91e346bc0aea5320b9
+  data.tar.gz: e00630e949040fdff6934dee20dbb1192c7d1b4d31e2b0d7fa3ca12ae864bd91
+SHA512:
+  metadata.gz: c99192202aa60052535d08410efeb462909c03249c8b25062089214741ba01154e8a70c0845c9b789bd4c22dc87dc88193e524dc3542a4458bf9fa0e768398af
+  data.tar.gz: 977da1fdfe5d43f6f6ecf81785a806cf603c13fa952eaad667b7a44952aa6c4453551e5e8b7aad648afb64f1c8c28ecb2b104e4b8c2b350a017e5931012fbc08

data/LICENSE

@@ -0,0 +1,48 @@
+Copyright (c) 2025 PostHog (part of Hiberly Inc)
+
+Copyright (c) 2013 Segment Inc. friends@segment.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+Some files in this codebase contain code from getsentry/sentry-ruby.
+In such cases it is explicitly stated in the file header. This license only applies to the relevant code in such cases.
+
+The MIT License (MIT)
+
+Copyright (c) 2020 Sentry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/NOTICE

@@ -0,0 +1,5 @@
+Txlemetry ruby SDK sources
+Derived from https://github.com/PostHog/posthog-ruby, tag posthog-rails-v3.18.9, commit 820d4bfe8aa3fb3284c4fdf3fb356530340e1c7a.
+Original license files and author notices are retained.
+Public names, package identity, default hosts and distribution are maintained for Txlemetry.
+Candidate source migration and validation are in progress; no release has been published.

data/bin/txlemetry

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'txlemetry'
+require 'rubygems'
+require 'commander/import'
+require 'time'
+require 'json'
+
+program :name, 'txlemetry'
+program :version, '1.0.0'
+program :description, 'Txlemetry API'
+
+def json_hash(str)
+  JSON.parse(str) if str
+end
+
+command :capture do |c|
+  c.description = 'capture an event'
+
+  c.option '--api-key=<string>', String, 'The Txlemetry API Key'
+  c.option '--api-host=<url>',
+           String,
+           'The Txlemetry API URL host part (scheme+domain)'
+  c.option '--distinct-id=<distinct_id>',
+           String,
+           'The distinct id to send the event as'
+  c.option '--event=<event>', String, 'The event name to send with the event'
+  c.option '--properties=<properties>', 'The properties to send (JSON-encoded)'
+
+  c.action do |_args, options|
+    txlemetry =
+      Txlemetry::Client.new(
+        {
+          api_key: options.api_key,
+          api_host: options.api_host,
+          on_error: proc { |_status, msg| print msg }
+        }
+      )
+
+    txlemetry.capture(
+      {
+        distinct_id: options.distinct_id,
+        event: options.event,
+        properties: json_hash(options.properties)
+      }
+    )
+
+    txlemetry.flush
+  end
+end
+
+command :identify do |c|
+  c.description = 'identify the user'
+
+  c.option '--api-key=<api_key>', String, 'The Txlemetry API Key'
+  c.option '--api-host=<url>',
+           String,
+           'The Txlemetry API URL host part (scheme+domain)'
+  c.option '--distinct-id=<distinct_id>',
+           String,
+           'The distinct id to send the event as'
+  c.option '--properties=<properties>', 'The properties to send (JSON-encoded)'
+
+  c.action do |_args, options|
+    txlemetry =
+      Txlemetry::Client.new(
+        {
+          api_key: options.api_key,
+          api_host: options.api_host,
+          on_error: proc { |_status, msg| print msg }
+        }
+      )
+
+    txlemetry.identify(
+      {
+        distinct_id: options.distinct_id,
+        properties: json_hash(options.properties)
+      }
+    )
+
+    txlemetry.flush
+  end
+end
+
+command :alias do |c|
+  c.description = 'set an alias for a distinct id'
+
+  c.option '--api-key=<api_key>', String, 'The Txlemetry API Key'
+  c.option '--api-host=<url>',
+           String,
+           'The Txlemetry API URL host part (scheme+domain)'
+  c.option '--distinct-id=<distinct_id>', String, 'The distinct id'
+  c.option '--alias=<alias>', 'The alias to give to the distinct id'
+
+  c.action do |_args, options|
+    txlemetry =
+      Txlemetry::Client.new(
+        {
+          api_key: options.api_key,
+          api_host: options.api_host,
+          on_error: proc { |_status, msg| print msg }
+        }
+      )
+
+    txlemetry.alias({ distinct_id: options.distinct_id, alias: options.alias })
+
+    txlemetry.flush
+  end
+end

data/lib/txlemetry/backoff_policy.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'txlemetry/defaults'
+
+module Txlemetry
+  # Retry backoff policy used by the SDK transport.
+  #
+  # @api private
+  class BackoffPolicy
+    include Txlemetry::Defaults::BackoffPolicy
+
+    # @param opts [Hash]
+    # @option opts [Numeric] :min_timeout_ms The minimum backoff timeout
+    # @option opts [Numeric] :max_timeout_ms The maximum backoff timeout
+    # @option opts [Numeric] :multiplier The value to multiply the current
+    #   interval with for each retry attempt
+    # @option opts [Numeric] :randomization_factor The randomization factor
+    #   to use to create a range around the retry interval
+    def initialize(opts = {})
+      @min_timeout_ms = opts[:min_timeout_ms] || MIN_TIMEOUT_MS
+      @max_timeout_ms = opts[:max_timeout_ms] || MAX_TIMEOUT_MS
+      @multiplier = opts[:multiplier] || MULTIPLIER
+      @randomization_factor =
+        opts[:randomization_factor] || RANDOMIZATION_FACTOR
+
+      @attempts = 0
+    end
+
+    # @return [Numeric] the next backoff interval, in milliseconds.
+    def next_interval
+      interval = @min_timeout_ms * (@multiplier**@attempts)
+      interval = add_jitter(interval, @randomization_factor)
+
+      @attempts += 1
+
+      interval.clamp(@min_timeout_ms, @max_timeout_ms)
+    end
+
+    private
+
+    def add_jitter(base, randomization_factor)
+      random_number = rand
+      max_deviation = base * randomization_factor
+      deviation = random_number * max_deviation
+
+      random_number < 0.5 ? base - deviation : base + deviation
+    end
+  end
+end