boxcars 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e76c5930ad4510169e7b27bca16789e5e8b72f1627f8e05546fe6450a649416a
-  data.tar.gz: 7a3a1f3e8eb58674481f57e814b68d797135f5ea41856629bbbae9f17743e429
+  metadata.gz: 842e02d2d8d43ea2a989c5a0b5708022443cf532d7616ab4319a063705f808fa
+  data.tar.gz: 0c3349ae1dc50be9984bd440c520a74f2f972151338f1ff23aca5bc47d56837c
 SHA512:
-  metadata.gz: 0b660877e4644a88e4a024512be55b2eeb5ea5cae8fb72a66f117a7ebfca2eefce6f2cfc10587afd9083b03b40e38c0fb30ca56ffbd4ce6723c09f2bf886acdf
-  data.tar.gz: f17d7b1cc975749780feecf2dfca65056332e98bb6b2a3ef40cbe0663820ed66ee51f88776910590b8c27a8ec4fcfe586c188ee7126c99127e4dd410d4e7f8fb
+  metadata.gz: 68c3560e8e67c59f711c6433ba5950b48e5ecc0d955b039280399c81baf26361bb659eae89660f2180064b8a2ec7cf799bf0950b42cb5bc8c28b224fa6eb6c53
+  data.tar.gz: 9f2538a7659b6ab4f236f23fbecb0a594f0ad0778e82b4fc634a2179e355fb40fb5f9ec54f6b9df6cda558a93ca5d2522c950ed8fe454d800cea1db16f5b72ba

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boxcars (0.8.1)
+    boxcars (0.8.2)
       faraday-retry (~> 2.0)
       google_search_results (~> 2.2)
       gpt4all (~> 0.0.5)

data/README.md

@@ -351,17 +351,30 @@ Set up observability by configuring a backend:
 ```ruby
 # Using PostHog backend
 require 'boxcars/observability_backends/posthog_backend'
+require 'posthog'
+
+# Create a PostHog client with your desired configuration
+posthog_client = PostHog::Client.new(
+  api_key: ENV['POSTHOG_API_KEY'] || 'your_posthog_api_key',
+  host: 'https://app.posthog.com', # or your self-hosted instance
+  on_error: proc { |status, body| 
+    Rails.logger.warn "PostHog error: #{status} - #{body}" 
+  }
+)
 
 Boxcars.configure do |config|
-  config.observability_backend = Boxcars::PosthogBackend.new(
-    api_key: ENV['POSTHOG_API_KEY'] || 'your_posthog_api_key',
-    host: 'https://app.posthog.com' # or your self-hosted instance
-  )
+  config.observability_backend = Boxcars::PosthogBackend.new(client: posthog_client)
 end
 
 # Using multiple backends
 require 'boxcars/observability_backends/multi_backend'
-backend1 = Boxcars::PosthogBackend.new(api_key: ENV['POSTHOG_API_KEY'])
+
+# Create PostHog client
+posthog_client = PostHog::Client.new(
+  api_key: ENV['POSTHOG_API_KEY'],
+  host: 'https://app.posthog.com'
+)
+backend1 = Boxcars::PosthogBackend.new(client: posthog_client)
 backend2 = YourCustomBackend.new
 
 Boxcars.configure do |config|
@@ -440,14 +453,18 @@ The PostHog backend requires the `posthog-ruby` gem:
 gem 'posthog-ruby'
 
 # Configure the backend
+require 'posthog'
+
+posthog_client = PostHog::Client.new(
+  api_key: ENV['POSTHOG_API_KEY'],
+  host: 'https://app.posthog.com',
+  on_error: proc { |status, body| 
+    Rails.logger.warn "PostHog error: #{status} - #{body}" 
+  }
+)
+
 Boxcars.configure do |config|
-  config.observability_backend = Boxcars::PosthogBackend.new(
-    api_key: ENV['POSTHOG_API_KEY'],
-    host: 'https://app.posthog.com',
-    on_error: proc { |status, body| 
-      Rails.logger.warn "PostHog error: #{status} - #{body}" 
-    }
-  )
+  config.observability_backend = Boxcars::PosthogBackend.new(client: posthog_client)
 end
 ```
 

data/lib/boxcars/observability_backends/posthog_backend.rb

@@ -9,10 +9,13 @@ module Boxcars
   #
   # Example Usage:
   #   require 'boxcars/observability_backends/posthog_backend'
-  #   Boxcars::Observability.backend = Boxcars::PosthogBackend.new(
+  #   require 'posthog'
+  #
+  #   client = PostHog::Client.new(
   #     api_key: 'YOUR_POSTHOG_API_KEY',
   #     host: 'https://app.posthog.com' # or your self-hosted instance
   #   )
+  #   Boxcars::Observability.backend = Boxcars::PosthogBackend.new(client: client)
   #
   #   # To track user-specific events, ensure :user_id is present in properties
   #   Boxcars::Observability.track(
@@ -23,32 +26,18 @@ module Boxcars
     include Boxcars::ObservabilityBackend
 
     # Initializes the PosthogBackend.
-    # Configures the PostHog client with the provided API key and host.
+    # Accepts a pre-configured PostHog client instance.
     #
-    # @param api_key [String] Your PostHog project API key.
-    # @param host [String] The PostHog API host. Defaults to 'https://app.posthog.com'.
-    # @param _personal_api_key [String, nil] Optional: A personal API key for server-side operations if needed.
-    # @param on_error [Proc, nil] Optional: A lambda/proc to call when an error occurs during event capture.
-    #   It receives the error code and error body as arguments.
-    #   Defaults to a proc that logs the error to stderr.
+    # @param client [PostHog::Client] A configured PostHog client instance.
     # @raise [LoadError] if the 'posthog-ruby' gem is not available.
-    def initialize(api_key:, host: 'https://app.posthog.com', _personal_api_key: nil, on_error: nil)
+    def initialize(client:)
       begin
         require 'posthog'
       rescue LoadError
         raise LoadError, "The 'posthog-ruby' gem is required to use PosthogBackend. Please add it to your Gemfile."
       end
 
-      @on_error_proc = on_error || proc do |status, body|
-        Boxcars.error("PostHog error: Status #{status}, Body: #{body}", :red)
-      end
-
-      # The posthog-ruby gem uses a simpler API
-      @posthog_client = PostHog::Client.new(
-        api_key:,
-        host:,
-        on_error: @on_error_proc
-      )
+      @posthog_client = client
     end
 
     # Tracks an event with PostHog.

data/lib/boxcars/version.rb

@@ -2,5 +2,5 @@
 
 module Boxcars
   # The current version of the gem.
-  VERSION = "0.8.1"
+  VERSION = "0.8.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boxcars
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Francis Sullivan