analytics-ruby 2.2.5 → 2.4.0

data/lib/segment/analytics/logging.rb

@@ -2,16 +2,43 @@ require 'logger'
 
 module Segment
   class Analytics
+    # Wraps an existing logger and adds a prefix to all messages
+    class PrefixedLogger
+      def initialize(logger, prefix)
+        @logger = logger
+        @prefix = prefix
+      end
+
+      def debug(msg)
+        @logger.debug("#{@prefix} #{msg}")
+      end
+
+      def info(msg)
+        @logger.info("#{@prefix} #{msg}")
+      end
+
+      def warn(msg)
+        @logger.warn("#{@prefix} #{msg}")
+      end
+
+      def error(msg)
+        @logger.error("#{@prefix} #{msg}")
+      end
+    end
+
     module Logging
       class << self
         def logger
-          @logger ||= if defined?(Rails)
-                        Rails.logger
-                      else
-                        logger = Logger.new STDOUT
-                        logger.progname = 'Segment::Analytics'
-                        logger
-                      end
+          return @logger if @logger
+
+          base_logger = if defined?(Rails)
+                          Rails.logger
+                        else
+                          logger = Logger.new STDOUT
+                          logger.progname = 'Segment::Analytics'
+                          logger
+                        end
+          @logger = PrefixedLogger.new(base_logger, '[analytics-ruby]')
         end
 
         attr_writer :logger

data/lib/segment/analytics/message_batch.rb

@@ -1,9 +1,12 @@
+require 'forwardable'
 require 'segment/analytics/logging'
 
 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
@@ -15,11 +18,18 @@ module Segment
       end
 
       def <<(message)
-        if message.too_big?
+        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
           @messages << message
-          @json_size += message.json_size + 1 # One byte for the comma
+          @json_size += message_json_size + 1 # One byte for the comma
         end
       end
 
@@ -42,6 +52,10 @@ module Segment
         @messages.length >= @max_message_count
       end
 
+      def message_too_big?(message_json_size)
+        message_json_size > Defaults::Message::MAX_BYTES
+      end
+
       # We consider the max size here as just enough to leave room for one more
       # message of the largest size possible. This is a shortcut that allows us
       # to use a native Ruby `Queue` that doesn't allow peeking. The tradeoff

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,14 +32,18 @@ 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
           status_code, body = send_request(write_key, batch)
           error = JSON.parse(body)['error']
           should_retry = should_retry_request?(status_code, body)
+          logger.debug("Response status code: #{status_code}")
+          logger.debug("Response error: #{error}") if error
 
           [Response.new(status_code, error), should_retry]
         end
@@ -49,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)
@@ -90,6 +97,7 @@ module Segment
         end
 
         if should_retry && (retries_remaining > 1)
+          logger.debug("Retrying request, #{retries_remaining} retries left")
           sleep(@backoff_policy.next_interval.to_f / 1000)
           retry_with_backoff(retries_remaining - 1, &block)
         else
@@ -108,15 +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
-          # If `start` is not called, Ruby adds a 'Connection: close' header to
-          # all requests, preventing us from reusing a connection for multiple
-          # HTTP requests
-          @http.start unless @http.started?
-
+          @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.5'
+    VERSION = '2.4.0'
   end
 end

data/lib/segment/analytics/worker.rb

@@ -1,7 +1,6 @@
 require 'segment/analytics/defaults'
-require 'segment/analytics/message'
 require 'segment/analytics/message_batch'
-require 'segment/analytics/request'
+require 'segment/analytics/transport'
 require 'segment/analytics/utils'
 
 module Segment
@@ -9,6 +8,7 @@ module Segment
     class Worker
       include Segment::Analytics::Utils
       include Segment::Analytics::Defaults
+      include Segment::Analytics::Logging
 
       # public: Creates a new worker
       #
@@ -29,7 +29,7 @@ module Segment
         batch_size = options[:batch_size] || Defaults::MessageBatch::MAX_SIZE
         @batch = MessageBatch.new(batch_size)
         @lock = Mutex.new
-        @request = Request.new
+        @transport = Transport.new(options)
       end
 
       # public: Continuously runs the loop to check for new events
@@ -39,16 +39,16 @@ module Segment
           return if @queue.empty?
 
           @lock.synchronize do
-            until @batch.full? || @queue.empty?
-              @batch << Message.new(@queue.pop)
-            end
+            consume_message_from_queue! until @batch.full? || @queue.empty?
           end
 
-          res = @request.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.
@@ -56,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

data/lib/segment/analytics.rb

@@ -1,11 +1,13 @@
 require 'segment/analytics/version'
 require 'segment/analytics/defaults'
 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
@@ -17,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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: analytics-ruby
 version: !ruby/object:Gem::Version
-  version: 2.2.5
+  version: 2.4.0
 platform: ruby
 authors:
 - Segment.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-01 00:00:00.000000000 Z
+date: 2021-05-05 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:
@@ -81,33 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.1.11
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: 3.6.2
   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'
+        version: 3.6.2
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -143,40 +129,22 @@ 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.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
-- spec/helpers/runscope_client.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/message_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
@@ -189,15 +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: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Segment.io analytics library

data/Gemfile

@@ -1,2 +0,0 @@
-source 'http://rubygems.org'
-gemspec

data/History.md

@@ -1,222 +0,0 @@
-2.2.5 / 2018-05-01
-==================
-
-  * [Fix](https://github.com/segmentio/analytics-ruby/pull/158): Require `version` module first.
-
-2.2.4 / 2018-04-30
-==================
-
-  * Promote pre-release version to stable.
-
-2.2.4.pre / 2018-02-04
-======================
-
-  * [Fix](https://github.com/segmentio/analytics-ruby/pull/147): Prevent 'batch
-    size exceeded' errors by automatically batching
-    items according to size
-  * [Performance](https://github.com/segmentio/analytics-ruby/pull/149): Reuse
-    TCP connections
-  * [Improvement](https://github.com/segmentio/analytics-ruby/pull/145): Emit logs
-    when in-memory queue is full
-  * [Improvement](https://github.com/segmentio/analytics-ruby/pull/143): Emit logs
-    when messages exceed maximum allowed size
-  * [Improvement](https://github.com/segmentio/analytics-ruby/pull/134): Add
-    exponential backoff to retries
-  * [Improvement](https://github.com/segmentio/analytics-ruby/pull/132): Handle
-    HTTP status code failure appropriately
-
-2.2.3.pre / 2017-09-14
-==================
-
-  * [Fix](https://github.com/segmentio/analytics-ruby/pull/120): Override `respond_to_missing` instead of `respond_to?` to facilitate mock the library in tests.
-
-
-2.2.2 / 2016-08-03
-==================
-
-  * adding commander as dep (for CLI)
-
-2.2.1 / 2016-08-03
-==================
-
-  * add executables to spec
-
-2.2.0 / 2016-08-03
-==================
-
- * Adding an (experimental) CLI
-
-2.1.0 / 2016-06-17
-==================
-
- * Fix: Ensure error handler is called before Client#flush finishes.
- * Feature: Support setting a custom message ID.
-
-2.0.13 / 2015-09-15
-==================
-
- * readme: updated install docs
- * fix: page/screen to allow no name
- * git: ignore ruby version
- * travis-ci: remove old rubys
-
-2.0.12 / 2015-01-10
-==================
-
- * Fix batch being cleared and causing duplicates
-
-2.0.11 / 2014-09-22
-==================
-
- * fix: don't clear batch if request failed
-
-2.0.10 / 2014-09-22
-==================
-
- * Move timeout retry above output
-
-2.0.9 / 2014-09-22
-==================
-
- * Fix rescuing timeouts
-
-2.0.8 / 2014-09-11
-==================
-* fix: add 3 ms to timestamp
-
-2.0.7 / 2014-08-27
-==================
-* fix: include optional options hash in calls
-
-2.0.6 / 2014-08-12
-==================
-* fix: category param on #page and #screen
-
-2.0.5 / 2014-05-26
-==================
-* fix: datetime conversions
-
-2.0.4 / 2014-06-11
-==================
-* fix: isofying trait dates in #group
-
-2.0.3 / 2014-06-04
-==================
-* fix: undefined method `is_requesting?' for nil:NilClass when calling flush (#51)
-
-2.0.2 / 2014-05-30
-==================
-* fix: formatting ios dates
-* fix: respond_to? implementation
-* add: able to stub requests by setting STUB env var
-
-2.0.1 / 2014-05-15
-==================
-* add: namespace under Segment::Analytics
-* add: can create multiple instances with creator method (rather than
-    having a singleton)
-* add: logging with Logger instance or Rails.logger if available
-* add: able to stub requests so they just log and don't hit the server
-* fix: worker continues running across forked processes
-* fix: removed usage of ActiveSupport methods since its not a dependency
-* fix: sending data that matches segment's new api spec
-
-(there is no v2.0.0)
-
-1.1.0 / 2014-04-17
-==================
-* adding .initialized? by [@lumberj](https://github.com/lumberj)
-
-1.0.0 / 2014-03-12
-==================
-* removing faraday dependency
-
-0.6.0 / 2014-02-19
-==================
-* adding .group(), .page(), and .screen() calls
-* relaxing faraday dependency, fixes #31
-
-0.5.4 / 2013-12-31
-==================
-* Add `requestId` fields to all requests for tracing.
-
-0.5.3 / 2013-12-31
-==================
-* Allow the consumer thread to shut down so it won't remain live in hot deploy scenarios. This fixes the jruby memory leak by [@nirvdrum](https://github.com/nirvdrum)
-
-0.5.2 / 2013-12-02
-==================
-* adding `sleep` backoff between connection retries
-
-0.5.1 / 2013-11-22
-==================
-* adding retries for connection hangups
-
-0.5.0 / 2013-10-03
-==================
-* Removing global Analytics constant in favor of adding it to our config. NOTE: If you are upgrading from a previous version and want to continue using the `Analytics` namespace, you'll have to add `Analytics = AnalyticsRuby` to your config. Otherwise you WILL NOT be sending analytics data. See the [setup docs for more info](https://segment.io/libraries/ruby)
-
-0.4.0 / 2013-08-30
-==================
-* Adding support and tests for 1.8.7
-
-0.3.4 / 2013-08-26
-==================
-* Pass `Time` values as iso8601 timestamp strings
-
-0.3.3 / 2013-08-02
-==================
-* Allow init/track/identify/alias to accept strings as keys. by [@shipstar](https://github.com/shipstar)
-
-0.3.2 / 2013-05-28
-==================
-* Adding faraday timeout by [@yanchenyun](https://github.com/yangchenyun)
-
-0.3.1 / 2013-04-29
-==================
-* Adding check for properties to be a Hash
-
-0.3.0 / 2013-04-05
-==================
-* Adding alias call
-
-0.2.0 / 2013-03-21
-==================
-* Adding flush method
-
-0.1.4 / 2013-03-19
-==================
-* Adding ClassMethods for more extensibility by [arronmabrey](https://github.com/arronmabrey)
-
-0.1.3 / 2013-03-19
-==================
-* Fixing user_id.to_s semantics, reported by [arronmabrey](https://github.com/arronmabrey)
-* Reduced faraday requirements by [arronmabrey](https://github.com/arronmabrey)
-
-0.1.2 / 2013-03-11
-==================
-* Fixing thrown exception on non-initialized tracks thanks to [sbellity](https://github.com/sbellity)
-
-0.1.1 / 2013-02-11
-==================
-* Updating dependencies
-* Adding actual support for MultiJson 1.0
-
-0.1.0 / 2013-01-22
-==================
-* Updated docs to point at segment.io
-
-0.0.5 / 2013-01-21
-==================
-* Renaming of all the files for proper bundling usage
-
-0.0.4 / 2013-01-17
-==================
-* Updated readme and install instruction courtesy of [@zeke](https://github.com/zeke)
-* Removed typhoeus and reverted to default adapter
-* Removing session_id in favor of a single user_id
-
-0.0.3 / 2013-01-16
-==================
-* Rakefile and renaming courtesy of [@kiennt](https://github.com/kiennt)
-* Updated tests with mocks