posthog-ruby 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be0160975e0d4abe505d4039ab4191fa4ccdffa99ceba59d739ad1304a5c7c6f
-  data.tar.gz: faa21af01aaaa6de4baa0e346b9565cd477d6163483bbaf27730b6bf4dd83bc5
+  metadata.gz: 4cc2c1e12c53fc80013ff8d49d082d1d35ad625fa0db972e53afbc205f595664
+  data.tar.gz: f95c1cb5502e0ae2d58e10b0575065fb797bbccd73d96098249a50ab6f60ee0a
 SHA512:
-  metadata.gz: e7596b4aed0d4b93a321a26aee5d3f74cf5b115ecf43b98387e1e3a48e52aa48199cfa8b3ca073080d6b1ba317e77ce6bf661b5b7e1e72aefd2f61820db1df17
-  data.tar.gz: 9e2a238eec77c66beb7c69d4bfc129aae81900f02bb73afeb602ba59f4763af817f9f971504d6ad3f6f6ea48c22403e821aa624d69fd079354b431b9af190b8b
+  metadata.gz: 8947ba953b888db638dff4ee913fa697eb80d0ac4e8796a705143278bae9aef67d7d966cdb6112309e2a51b5432fe340676036f2756bcbef885f801c929de13d
+  data.tar.gz: c95c85e49f02acd99043120ccc6b7889b30553da9d968cdc08f7bfe13e130bd5f42380a68714c712f0444777a24bfcb29e252a28ce319f01242a362c9ca2e4e0

data/lib/posthog/client.rb

@@ -4,7 +4,8 @@ require 'time'
 require 'posthog/defaults'
 require 'posthog/logging'
 require 'posthog/utils'
-require 'posthog/worker'
+require 'posthog/send_worker'
+require 'posthog/noop_worker'
 require 'posthog/feature_flags'
 
 class PostHog
@@ -15,7 +16,9 @@ class PostHog
     # @param [Hash] opts
     # @option opts [String] :api_key Your project's api_key
     # @option opts [FixNum] :max_queue_size Maximum number of calls to be
-    #   remain queued.
+    #   remain queued. Defaults to 10_000.
+    # @option opts [Bool] :test_mode +true+ if messages should remain
+    #   queued for testing. Defaults to +false+.
     # @option opts [Proc] :on_error Handles error calls from the API.
     def initialize(opts = {})
       symbolize_keys!(opts)
@@ -24,14 +27,18 @@ class PostHog
       @api_key = opts[:api_key]
       @max_queue_size = opts[:max_queue_size] || Defaults::Queue::MAX_SIZE
       @worker_mutex = Mutex.new
-      @worker = Worker.new(@queue, @api_key, opts)
+      @worker = if opts[:test_mode]
+        NoopWorker.new(@queue)
+      else
+        SendWorker.new(@queue, @api_key, opts)
+      end
       @worker_thread = nil
       @feature_flags_poller = nil
       @personal_api_key = nil
 
       check_api_key!
 
-      if opts[:personal_api_key].present?
+      if opts[:personal_api_key]
         @personal_api_key = opts[:personal_api_key]
         @feature_flags_poller =
           FeatureFlagsPoller.new(
@@ -45,7 +52,7 @@ class PostHog
       at_exit { @worker_thread && @worker_thread[:should_exit] = true }
     end
 
-    # Synchronously waits until the worker has flushed the queue.
+    # Synchronously waits until the worker has cleared the queue.
     #
     # Use only for scripts which are not long-running, and will specifically
     # exit
@@ -56,6 +63,13 @@ class PostHog
       end
     end
 
+    # Clears the queue without waiting.
+    #
+    # Use only in test mode
+    def clear
+      @queue.clear
+    end
+
     # @!macro common_attrs
     #   @option attrs [String] :message_id ID that uniquely
     #     identifies a message across the API. (optional)
@@ -96,6 +110,11 @@ class PostHog
       enqueue(FieldParser.parse_for_alias(attrs))
     end
 
+    # @return [Hash] pops the last message from the queue
+    def dequeue_last_message
+      @queue.pop
+    end
+
     # @return [Fixnum] number of messages in the queue
     def queued_messages
       @queue.length

data/lib/posthog/field_parser.rb

@@ -54,7 +54,7 @@ class PostHog
       def parse_for_alias(fields)
         common = parse_common_fields(fields)
 
-        distinct_id = common[:distinct_id] # must move to properties...
+        distinct_id = common[:distinct_id] # must both be set and move to properties
 
         alias_field = fields[:alias]
         check_presence! alias_field, 'alias'
@@ -63,7 +63,7 @@ class PostHog
           {
             type: 'alias',
             event: '$create_alias',
-            distinct_id: nil,
+            distinct_id: distinct_id,
             properties:
               { distinct_id: distinct_id, alias: alias_field }.merge(
                 common[:properties] || {}

data/lib/posthog/noop_worker.rb

@@ -0,0 +1,16 @@
+# A worker that doesn't consume jobs
+class PostHog
+  class NoopWorker
+    def initialize(queue)
+      @queue = queue
+    end
+
+    def run
+      # Does nothing
+    end
+
+    def is_requesting?
+      false
+    end
+  end
+end

data/lib/posthog/{worker.rb → send_worker.rb}

@@ -4,7 +4,7 @@ require 'posthog/transport'
 require 'posthog/utils'
 
 class PostHog
-  class Worker
+  class SendWorker
     include PostHog::Utils
     include PostHog::Defaults
     include PostHog::Logging

data/lib/posthog/version.rb

@@ -1,3 +1,3 @@
 class PostHog
-  VERSION = '1.2.2'
+  VERSION = '1.3.0'
 end

data/lib/posthog.rb

@@ -3,7 +3,7 @@ require 'posthog/defaults'
 require 'posthog/utils'
 require 'posthog/field_parser'
 require 'posthog/client'
-require 'posthog/worker'
+require 'posthog/send_worker'
 require 'posthog/transport'
 require 'posthog/response'
 require 'posthog/logging'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: posthog-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - ''
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2022-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -153,16 +153,17 @@ files:
 - lib/posthog/field_parser.rb
 - lib/posthog/logging.rb
 - lib/posthog/message_batch.rb
+- lib/posthog/noop_worker.rb
 - lib/posthog/response.rb
+- lib/posthog/send_worker.rb
 - lib/posthog/transport.rb
 - lib/posthog/utils.rb
 - lib/posthog/version.rb
-- lib/posthog/worker.rb
 homepage: https://github.com/PostHog/posthog-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -177,8 +178,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: PostHog library
 test_files: []