analytics-ruby 2.2.7 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c8742471c22e19783a69dee3403ddbd1ac2785b7bbd9608840432e34f4d50a5
-  data.tar.gz: dad6dfe750ebf0746e2228cd29551afc23e4ce38d40c7df00184994e6d16db8b
+  metadata.gz: 51f3f02afed05c9c8461b454e0a3067962a75b8efde0930db0098eebf4a62829
+  data.tar.gz: e7d486d6c6186535e9a005c4d950e6e29d2dd9937f9b6da625191d786f76846a
 SHA512:
-  metadata.gz: c5d305d7a968088a3ef5488faa360ce06ad6d97072bde0d6b068aae11bcb1824814f87fe1a18e8f09a231cbe34be2954b4565605cdb8a6b8e0d370ee56a6b492
-  data.tar.gz: 154b45294bff8f12f2dd8bc338742889d11017983f5e516cca36e9446bbb3c0e6aa61ac35252aaf20ba39ececa96a58c264990f9a1dece39d6d5b39435ab1ad3
+  metadata.gz: c2ce09d450de65620eb99f9fae86aa5ce57709d53aa4a93c73c2d3db0b173afad532383a50fe4dcb953df72171b731a263ff7308aed79b646a25bc202c555e4d
+  data.tar.gz: b3625484ebca6117ae79fc42f03a595dff861b8c5ca02a6ef12ea9e933229c1479dad40b4db1d85e61ddf585c7c5a072d68e9cd21ced6b2482db338f45073707

data/bin/analytics

@@ -29,6 +29,7 @@ command :send do |c|
   c.option '--userId=<userId>', String, 'the user id to send the event as'
   c.option '--anonymousId=<anonymousId>', String, 'the anonymous user id to send the event as'
   c.option '--context=<context>', 'additional context for the event (JSON-encoded)'
+  c.option '--integrations=<integrations>', 'additional integrations for the event (JSON-encoded)'
 
   c.option '--event=<event>', String, 'the event name to send with the event'
   c.option '--properties=<properties>', 'the event properties to send (JSON-encoded)'
@@ -38,6 +39,7 @@ command :send do |c|
   c.option '--traits=<traits>', 'the identify/group traits to send (JSON-encoded)'
 
   c.option '--groupId=<groupId>', String, 'the group id'
+  c.option '--previousId=<previousId>', String, 'the previous id'
 
   c.action do |args, options|
     Analytics = Segment::Analytics.new({
@@ -52,7 +54,8 @@ command :send do |c|
         event: options.event,
         anonymous_id: options.anonymousId,
         properties: json_hash(options.properties),
-        context: json_hash(options.context)
+        context: json_hash(options.context),
+        integrations: json_hash(options.integrations)
       })
     when "page"
       Analytics.page({
@@ -60,22 +63,25 @@ command :send do |c|
         anonymous_id: options.anonymousId,
         name: options.name,
         properties: json_hash(options.properties),
-        context: json_hash(options.context)
+        context: json_hash(options.context),
+        integrations: json_hash(options.integrations)
       })
     when "screen"
       Analytics.screen({
         user_id: options.userId,
         anonymous_id: options.anonymousId,
-        name: option.name,
-        traits: json_hash(options.traits),
-        properties: json_hash(option.properties)
+        name: options.name,
+        properties: json_hash(options.properties),
+        context: json_hash(options.context),
+        integrations: json_hash(options.integrations)
       })
     when "identify"
       Analytics.identify({
         user_id: options.userId,
         anonymous_id: options.anonymousId,
         traits: json_hash(options.traits),
-        context: json_hash(options.context)
+        context: json_hash(options.context),
+        integrations: json_hash(options.integrations)
       })
     when "group"
       Analytics.group({
@@ -83,7 +89,16 @@ command :send do |c|
         anonymous_id: options.anonymousId,
         group_id: options.groupId,
         traits: json_hash(options.traits),
-        context: json_hash(options.context)
+        context: json_hash(options.context),
+        integrations: json_hash(options.integrations)
+      })
+    when "alias"
+      Analytics.alias({
+        previous_id: options.previousId,
+        user_id: options.userId,
+        anonymous_id: options.anonymousId,
+        context: json_hash(options.context),
+        integrations: json_hash(options.integrations)
       })
     else
       raise "Invalid Message Type #{options.type}"

data/lib/segment/analytics.rb

@@ -4,9 +4,10 @@ require 'segment/analytics/utils'
 require 'segment/analytics/field_parser'
 require 'segment/analytics/client'
 require 'segment/analytics/worker'
-require 'segment/analytics/request'
+require 'segment/analytics/transport'
 require 'segment/analytics/response'
 require 'segment/analytics/logging'
+require 'segment/analytics/test_queue'
 
 module Segment
   class Analytics
@@ -18,7 +19,7 @@ module Segment
     # @option options [Boolean] :stub (false) If true, requests don't hit the
     #   server and are stubbed to be successful.
     def initialize(options = {})
-      Request.stub = options[:stub] if options.has_key?(:stub)
+      Transport.stub = options[:stub] if options.has_key?(:stub)
       @client = Segment::Analytics::Client.new options
     end
 

data/lib/segment/analytics/client.rb

@@ -21,10 +21,12 @@ module Segment
         symbolize_keys!(opts)
 
         @queue = Queue.new
+        @test = opts[:test]
         @write_key = opts[:write_key]
         @max_queue_size = opts[:max_queue_size] || Defaults::Queue::MAX_SIZE
         @worker_mutex = Mutex.new
         @worker = Worker.new(@queue, @write_key, opts)
+        @worker_thread = nil
 
         check_write_key!
 
@@ -142,6 +144,14 @@ module Segment
         @queue.length
       end
 
+      def test_queue
+        unless @test
+          raise 'Test queue only available when setting :test to true.'
+        end
+
+        @test_queue ||= TestQueue.new
+      end
+
       private
 
       # private: Enqueues the action.
@@ -151,6 +161,8 @@ module Segment
         # add our request id for tracing purposes
         action[:messageId] ||= uid
 
+        test_queue << action if @test
+
         if @queue.length < @max_queue_size
           @queue << action
           ensure_worker_running

data/lib/segment/analytics/field_parser.rb

@@ -120,12 +120,15 @@ module Segment
 
           isoify_dates! properties
 
-          common.merge({
+          parsed = common.merge({
             :type => 'screen',
             :name => name,
-            :properties => properties,
-            :category => category
+            :properties => properties
           })
+
+          parsed[:category] = category if category
+
+          parsed
         end
 
         private
@@ -140,15 +143,20 @@ module Segment
 
           add_context! context
 
-          {
-            :anonymousId => fields[:anonymous_id],
+          parsed = {
             :context => context,
-            :integrations => fields[:integrations],
             :messageId => message_id,
-            :timestamp => datetime_in_iso8601(timestamp),
-            :userId => fields[:user_id],
-            :options => fields[:options] # Not in spec, retained for backward compatibility
+            :timestamp => datetime_in_iso8601(timestamp)
           }
+
+          parsed[:userId] = fields[:user_id] if fields[:user_id]
+          parsed[:anonymousId] = fields[:anonymous_id] if fields[:anonymous_id]
+          parsed[:integrations] = fields[:integrations] if fields[:integrations]
+
+          # Not in spec, retained for backward compatibility
+          parsed[:options] = fields[:options] if fields[:options]
+
+          parsed
         end
 
         def check_user_id!(fields)

data/lib/segment/analytics/message_batch.rb

@@ -5,6 +5,8 @@ module Segment
   class Analytics
     # A batch of `Message`s to be sent to the API
     class MessageBatch
+      class JSONGenerationError < StandardError; end
+
       extend Forwardable
       include Segment::Analytics::Logging
       include Segment::Analytics::Defaults::MessageBatch
@@ -16,8 +18,13 @@ module Segment
       end
 
       def <<(message)
-        message_json_size = message.to_json.bytesize
+        begin
+          message_json = message.to_json
+        rescue StandardError => e
+          raise JSONGenerationError, "Serialization error: #{e}"
+        end
 
+        message_json_size = message_json.bytesize
         if message_too_big?(message_json_size)
           logger.error('a message exceeded the maximum allowed size')
         else

data/lib/segment/analytics/test_queue.rb

@@ -0,0 +1,56 @@
+module Segment
+  class Analytics
+    class TestQueue
+      attr_reader :messages
+
+      def initialize
+        reset!
+      end
+
+      def [](key)
+        all[key]
+      end
+
+      def count
+        all.count
+      end
+
+      def <<(message)
+        all << message
+        send(message[:type]) << message
+      end
+
+      def alias
+        messages[:alias] ||= []
+      end
+
+      def all
+        messages[:all] ||= []
+      end
+
+      def group
+        messages[:group] ||= []
+      end
+
+      def identify
+        messages[:identify] ||= []
+      end
+
+      def page
+        messages[:page] ||= []
+      end
+
+      def screen
+        messages[:screen] ||= []
+      end
+
+      def track
+        messages[:track] ||= []
+      end
+
+      def reset!
+        @messages = {}
+      end
+    end
+  end
+end

data/lib/segment/analytics/{request.rb → transport.rb}

@@ -9,13 +9,11 @@ require 'json'
 
 module Segment
   class Analytics
-    class Request
+    class Transport
       include Segment::Analytics::Defaults::Request
       include Segment::Analytics::Utils
       include Segment::Analytics::Logging
 
-      # public: Creates a new request object to send analytics batch
-      #
       def initialize(options = {})
         options[:host] ||= HOST
         options[:port] ||= PORT
@@ -34,10 +32,10 @@ module Segment
         @http = http
       end
 
-      # public: Posts the write key and batch of messages to the API.
+      # Sends a batch of messages to the API
       #
-      # returns - Response of the status and error if it exists
-      def post(write_key, batch)
+      # @return [Response] API response
+      def send(write_key, batch)
         logger.debug("Sending request for #{batch.length} items")
 
         last_response, exception = retry_with_backoff(@retries) do
@@ -59,6 +57,11 @@ module Segment
         end
       end
 
+      # Closes a persistent connection if it exists
+      def shutdown
+        @http.finish if @http.started?
+      end
+
       private
 
       def should_retry_request?(status_code, body)
@@ -113,10 +116,11 @@ module Segment
 
         if self.class.stub
           logger.debug "stubbed request to #{@path}: " \
-            "write key = #{write_key}, batch = JSON.generate(#{batch})"
+            "write key = #{write_key}, batch = #{JSON.generate(batch)}"
 
           [200, '{}']
         else
+          @http.start unless @http.started? # Maintain a persistent connection
           response = @http.request(request, payload)
           [response.code.to_i, response.body]
         end

data/lib/segment/analytics/utils.rb

@@ -64,12 +64,8 @@ module Segment
         end
       end
 
-      def time_in_iso8601(time, fraction_digits = 3)
-        fraction = if fraction_digits > 0
-                     ('.%06i' % time.usec)[0, fraction_digits + 1]
-                   end
-
-        "#{time.strftime('%Y-%m-%dT%H:%M:%S')}#{fraction}#{formatted_offset(time, true, 'Z')}"
+      def time_in_iso8601(time)
+        "#{time.strftime('%Y-%m-%dT%H:%M:%S.%6N')}#{formatted_offset(time, true, 'Z')}"
       end
 
       def date_in_iso8601(date)

data/lib/segment/analytics/version.rb

@@ -1,5 +1,5 @@
 module Segment
   class Analytics
-    VERSION = '2.2.7'
+    VERSION = '2.4.0'
   end
 end

data/lib/segment/analytics/worker.rb

@@ -1,6 +1,6 @@
 require 'segment/analytics/defaults'
 require 'segment/analytics/message_batch'
-require 'segment/analytics/request'
+require 'segment/analytics/transport'
 require 'segment/analytics/utils'
 
 module Segment
@@ -29,6 +29,7 @@ module Segment
         batch_size = options[:batch_size] || Defaults::MessageBatch::MAX_SIZE
         @batch = MessageBatch.new(batch_size)
         @lock = Mutex.new
+        @transport = Transport.new(options)
       end
 
       # public: Continuously runs the loop to check for new events
@@ -38,15 +39,16 @@ module Segment
           return if @queue.empty?
 
           @lock.synchronize do
-            @batch << @queue.pop until @batch.full? || @queue.empty?
+            consume_message_from_queue! until @batch.full? || @queue.empty?
           end
 
-          res = Request.new.post @write_key, @batch
-
+          res = @transport.send @write_key, @batch
           @on_error.call(res.status, res.error) unless res.status == 200
 
           @lock.synchronize { @batch.clear }
         end
+      ensure
+        @transport.shutdown
       end
 
       # public: Check whether we have outstanding requests.
@@ -54,6 +56,14 @@ module Segment
       def is_requesting?
         @lock.synchronize { !@batch.empty? }
       end
+
+      private
+
+      def consume_message_from_queue!
+        @batch << @queue.pop
+      rescue MessageBatch::JSONGenerationError => e
+        @on_error.call(-1, e.to_s)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: analytics-ruby
 version: !ruby/object:Gem::Version
-  version: 2.2.7
+  version: 2.4.0
 platform: ruby
 authors:
 - Segment.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-10 00:00:00.000000000 Z
+date: 2021-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -139,8 +139,9 @@ files:
 - lib/segment/analytics/field_parser.rb
 - lib/segment/analytics/logging.rb
 - lib/segment/analytics/message_batch.rb
-- lib/segment/analytics/request.rb
 - lib/segment/analytics/response.rb
+- lib/segment/analytics/test_queue.rb
+- lib/segment/analytics/transport.rb
 - lib/segment/analytics/utils.rb
 - lib/segment/analytics/version.rb
 - lib/segment/analytics/worker.rb
@@ -156,14 +157,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Segment.io analytics library