analytics-ruby 2.2.6.pre → 2.3.0

data/lib/segment/analytics/field_parser.rb

@@ -0,0 +1,192 @@
+module Segment
+  class Analytics
+    # Handles parsing fields according to the Segment Spec
+    #
+    # @see https://segment.com/docs/spec/
+    class FieldParser
+      class << self
+        include Segment::Analytics::Utils
+
+        # In addition to the common fields, track accepts:
+        #
+        # - "event"
+        # - "properties"
+        def parse_for_track(fields)
+          common = parse_common_fields(fields)
+
+          event = fields[:event]
+          properties = fields[:properties] || {}
+
+          check_presence!(event, 'event')
+          check_is_hash!(properties, 'properties')
+
+          isoify_dates! properties
+
+          common.merge({
+            :type => 'track',
+            :event => event.to_s,
+            :properties => properties
+          })
+        end
+
+        # In addition to the common fields, identify accepts:
+        #
+        # - "traits"
+        def parse_for_identify(fields)
+          common = parse_common_fields(fields)
+
+          traits = fields[:traits] || {}
+          check_is_hash!(traits, 'traits')
+          isoify_dates! traits
+
+          common.merge({
+            :type => 'identify',
+            :traits => traits
+          })
+        end
+
+        # In addition to the common fields, alias accepts:
+        #
+        # - "previous_id"
+        def parse_for_alias(fields)
+          common = parse_common_fields(fields)
+
+          previous_id = fields[:previous_id]
+          check_presence!(previous_id, 'previous_id')
+
+          common.merge({
+            :type => 'alias',
+            :previousId => previous_id
+          })
+        end
+
+        # In addition to the common fields, group accepts:
+        #
+        # - "group_id"
+        # - "traits"
+        def parse_for_group(fields)
+          common = parse_common_fields(fields)
+
+          group_id = fields[:group_id]
+          traits = fields[:traits] || {}
+
+          check_presence!(group_id, 'group_id')
+          check_is_hash!(traits, 'traits')
+
+          isoify_dates! traits
+
+          common.merge({
+            :type => 'group',
+            :groupId => group_id,
+            :traits => traits
+          })
+        end
+
+        # In addition to the common fields, page accepts:
+        #
+        # - "name"
+        # - "properties"
+        def parse_for_page(fields)
+          common = parse_common_fields(fields)
+
+          name = fields[:name] || ''
+          properties = fields[:properties] || {}
+
+          check_is_hash!(properties, 'properties')
+
+          isoify_dates! properties
+
+          common.merge({
+            :type => 'page',
+            :name => name.to_s,
+            :properties => properties
+          })
+        end
+
+        # In addition to the common fields, screen accepts:
+        #
+        # - "name"
+        # - "properties"
+        # - "category" (Not in spec, retained for backward compatibility"
+        def parse_for_screen(fields)
+          common = parse_common_fields(fields)
+
+          name = fields[:name]
+          properties = fields[:properties] || {}
+          category = fields[:category]
+
+          check_presence!(name, 'name')
+          check_is_hash!(properties, 'properties')
+
+          isoify_dates! properties
+
+          parsed = common.merge({
+            :type => 'screen',
+            :name => name,
+            :properties => properties
+          })
+
+          parsed[:category] = category if category
+
+          parsed
+        end
+
+        private
+
+        def parse_common_fields(fields)
+          timestamp = fields[:timestamp] || Time.new
+          message_id = fields[:message_id].to_s if fields[:message_id]
+          context = fields[:context] || {}
+
+          check_user_id! fields
+          check_timestamp! timestamp
+
+          add_context! context
+
+          parsed = {
+            :context => context,
+            :messageId => message_id,
+            :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)
+          unless fields[:user_id] || fields[:anonymous_id]
+            raise ArgumentError, 'Must supply either user_id or anonymous_id'
+          end
+        end
+
+        def check_timestamp!(timestamp)
+          raise ArgumentError, 'Timestamp must be a Time' unless timestamp.is_a? Time
+        end
+
+        def add_context!(context)
+          context[:library] = { :name => 'analytics-ruby', :version => Segment::Analytics::VERSION.to_s }
+        end
+
+        # private: Ensures that a string is non-empty
+        #
+        # obj    - String|Number that must be non-blank
+        # name   - Name of the validated value
+        def check_presence!(obj, name)
+          if obj.nil? || (obj.is_a?(String) && obj.empty?)
+            raise ArgumentError, "#{name} must be given"
+          end
+        end
+
+        def check_is_hash!(obj, name)
+          raise ArgumentError, "#{name} must be a Hash" unless obj.is_a? Hash
+        end
+      end
+    end
+  end
+end

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/{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
@@ -53,12 +51,17 @@ module Segment
         if exception
           logger.error(exception.message)
           exception.backtrace.each { |line| logger.error(line) }
-          Response.new(-1, "Connection error: #{exception}")
+          Response.new(-1, exception.to_s)
         else
           last_response
         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.6.pre'
+    VERSION = '2.3.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
       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.6.pre
+  version: 2.3.0
 platform: ruby
 authors:
 - Segment.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-29 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -17,7 +17,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.4'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -80,34 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.1.11
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-- !ruby/object:Gem::Dependency
-  name: pmap
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -157,42 +129,21 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
-- History.md
-- Makefile
-- README.md
-- RELEASING.md
-- Rakefile
-- analytics-ruby.gemspec
 - bin/analytics
-- codecov.yml
 - lib/analytics-ruby.rb
 - lib/segment.rb
 - lib/segment/analytics.rb
 - lib/segment/analytics/backoff_policy.rb
 - lib/segment/analytics/client.rb
 - lib/segment/analytics/defaults.rb
+- 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/transport.rb
 - lib/segment/analytics/utils.rb
 - lib/segment/analytics/version.rb
 - lib/segment/analytics/worker.rb
-- spec/helpers/runscope_client.rb
-- spec/isolated/json_example.rb
-- spec/isolated/with_active_support.rb
-- spec/isolated/with_active_support_and_oj.rb
-- spec/isolated/with_oj.rb
-- spec/segment/analytics/backoff_policy_spec.rb
-- spec/segment/analytics/client_spec.rb
-- spec/segment/analytics/e2e_spec.rb
-- spec/segment/analytics/message_batch_spec.rb
-- spec/segment/analytics/request_spec.rb
-- spec/segment/analytics/response_spec.rb
-- spec/segment/analytics/worker_spec.rb
-- spec/segment/analytics_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/segmentio/analytics-ruby
 licenses:
 - MIT
@@ -205,15 +156,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: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Segment.io analytics library