rudder-sdk-ruby 0.0.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcce6b53dd45a0b6b4f19fbd9de5e96bf2d10ff1747d105aa734407dff704b6e
-  data.tar.gz: 65b3a4d75753ff880fb48bf02a398176ccd7aa04b889b90c84ea65e36d55272a
+  metadata.gz: 3b095c62f2f1876eac8bece177cbc292ed6686ea13d6ba6988b7e8d5cdf17ef7
+  data.tar.gz: 8e5a23ec4064547130a6e9ed4c349a5278b51fca95cbe48d9df033696252e6a8
 SHA512:
-  metadata.gz: c4e727dd53858f6b413278088447181fb184bd5d5ed7d7b9b129b07a20073e73c44cb0e26a4792bacaedb3349af3859403264a5ee5fee96cb61b704341c93a79
-  data.tar.gz: 1ee11c6663d4edf1ac1237c4a2aa5872b7f4da009467bdc93fd0c2cde9d7083f6cdb499d73b6290cf4edb212dd9e93154ce7f80d45bee9bfe75b6372c84a81f6
+  metadata.gz: 4022a4715a1081a836001135496fc7770eaa734fd760607230eef3668d438ee8adad94b91e7e78fbf31051328d1ae3507a3b9221b6c6d7d8bd4a4165f5290ca9
+  data.tar.gz: fb34b8f93df5589eb0cabecd6b22b61e15092df4c661bd244d864978ffc4e816baa311d97d41ed9dbbbadcfe0950b7a8f81704d6fd4594cccbd970cff9afd60d

data/bin/analytics_rudder.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+# !/usr/bin/env ruby
+
+require 'rudder/analytics'
+require 'rubygems'
+require 'commander/import'
+require 'time'
+require 'json'
+require 'yaml'
+
+program :name, 'simulator.rb'
+program :version, '0.0.1'
+program :description, 'scripting simulator'
+
+def json_hash(str)
+  return JSON.parse(str) if str
+end
+
+# Run in dev with ruby -ilib bin/analytics_rudder.rb --writeKey=<write_key> --dataPlaneUrl=<data_plane_url>
+# --type=track --userId=123456 --event=Test --properties={\"key_1\" => \"value_1\"} --trace
+
+default_command :send
+
+command :send do |c|
+  c.description = 'send a Rudder message'
+
+  c.option '--writeKey=<writeKey>', String, 'the Rudder writeKey'
+  c.option '--dataPlaneUrl=<dataPlaneUrl>', String, 'the Rudder data plane URL'
+  c.option '--type=<type>', String, 'The Rudder message type'
+
+  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)'
+
+  c.option '--name=<name>', 'name of the screen or page to send with the message'
+
+  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 |_, options|
+    Analytics = Rudder::Analytics.new({
+      :write_key => options.writeKey,
+      :data_plane_url => options.dataPlaneUrl,
+      :on_error => proc { |_status, msg| print msg }
+    })
+
+    case options.type
+    when 'track'
+      Analytics.track({
+        :user_id => options.userId,
+        :event => options.event,
+        :anonymous_id => options.anonymousId,
+        :properties => json_hash(options.properties),
+        :context => json_hash(options.context),
+        :integrations => json_hash(options.integrations)
+      })
+    when 'page'
+      Analytics.page({
+        :user_id => options.userId,
+        :anonymous_id => options.anonymousId,
+        :name => options.name,
+        :properties => json_hash(options.properties),
+        :context => json_hash(options.context),
+        :integrations => json_hash(options.integrations)
+      })
+    when 'screen'
+      Analytics.screen({
+        :user_id => options.userId,
+        :anonymous_id => options.anonymousId,
+        :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),
+        :integrations => json_hash(options.integrations)
+      })
+    when 'group'
+      Analytics.group({
+        :user_id => options.userId,
+        :anonymous_id => options.anonymousId,
+        :group_id => options.groupId,
+        :traits => json_hash(options.traits),
+        :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}"
+    end
+    Analytics.flush
+  end
+end

data/lib/rudder/analytics/client.rb

@@ -8,6 +8,8 @@ require 'rudder/analytics/logging'
 require 'rudder/analytics/utils'
 require 'rudder/analytics/worker'
 require 'rudder/analytics/defaults'
+require 'rudder/analytics/configuration'
+require 'rudder/analytics/test_queue'
 require 'net/http'
 
 module Rudder
@@ -23,23 +25,11 @@ module Rudder
       #   remain queued.
       # @option opts [Proc] :on_error Handles error calls from the API.
       def initialize(opts = {})
-        symbolize_keys!(opts)
-
+        @config = Configuration.new(opts)
         @queue = Queue.new
-        @write_key = opts[:write_key]
-        @data_plane_url = opts[:data_plane_url]
-        @max_queue_size = opts[:max_queue_size] || Defaults::Queue::MAX_SIZE
         @worker_mutex = Mutex.new
-        @worker = Worker.new(@queue, @data_plane_url, @write_key, opts)
+        @worker = Worker.new(@queue, @config)
         @worker_thread = nil
-
-        uri = URI(opts[:data_plane_url])
-
-        @host = uri.host
-        @port = uri.port
-
-        check_write_key!
-
         at_exit { @worker_thread && @worker_thread[:should_exit] = true }
       end
 
@@ -155,6 +145,12 @@ module Rudder
         @queue.length
       end
 
+      def test_queue
+        raise 'Test queue only available when setting :test to true.' unless @config.test
+
+        @test_queue ||= TestQueue.new
+      end
+
       private
 
       # private: Enqueues the action.
@@ -165,25 +161,33 @@ module Rudder
         # add our request id for tracing purposes
         action[:messageId] ||= uid
 
-        if @queue.length < @max_queue_size
+        if @config.test
+          test_queue << action
+          return true
+        end
+
+        if @queue.length < @config.max_queue_size
           @queue << action
           ensure_worker_running
 
           true
         else
           logger.warn(
-            'Queue is full, dropping events. The :max_queue_size ' \
-            'configuration parameter can be increased to prevent this from ' \
-            'happening.'
+            'Queue is full, dropping events. The :max_queue_size configuration parameter can be increased to prevent this from happening.'
           )
           false
         end
       end
 
       # private: Checks that the write_key is properly initialized
-      def check_write_key!
-        raise ArgumentError, 'Write key must be initialized' if @write_key.nil?
-      end
+      # def check_write_key!
+      #   raise ArgumentError, 'Write key must be initialized' if @write_key.nil?
+      # end
+
+      # private: Checks that the data_plane_url is properly initialized
+      # def check_data_plane_url!
+      #   raise ArgumentError, 'Data plane url must be initialized' if @data_plane_url.nil?
+      # end
 
       def ensure_worker_running
         return if worker_running?

data/lib/rudder/analytics/configuration.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'rudder/analytics/utils'
+
+module Rudder
+  class Analytics
+    class Configuration
+      include Rudder::Analytics::Utils
+
+      attr_reader :write_key, :data_plane_url, :on_error, :stub, :gzip, :ssl, :batch_size, :test, :max_queue_size, :backoff_policy, :retries
+
+      def initialize(settings = {})
+        symbolized_settings = symbolize_keys(settings)
+
+        @test = symbolized_settings[:test]
+        @write_key = symbolized_settings[:write_key]
+        @data_plane_url = symbolized_settings[:data_plane_url]
+        @max_queue_size = symbolized_settings[:max_queue_size] || Defaults::Queue::MAX_SIZE
+        @ssl = symbolized_settings[:ssl]
+        @on_error = symbolized_settings[:on_error] || proc { |status, error| }
+        @stub = symbolized_settings[:stub]
+        @batch_size = symbolized_settings[:batch_size] || Defaults::MessageBatch::MAX_SIZE
+        @gzip = symbolized_settings[:gzip]
+        @backoff_policy = symbolized_settings[:backoff_policy]
+        @retries = symbolized_settings[:retries]
+        raise ArgumentError, 'Missing required option :write_key' \
+          unless @write_key
+        raise ArgumentError, 'Data plane url must be initialized' \
+          unless @data_plane_url
+      end
+    end
+  end
+end

data/lib/rudder/analytics/defaults.rb

@@ -7,11 +7,9 @@ module Rudder
         HOST = 'localhost'
         PORT = 8080
         PATH = '/v1/batch'
-        DATA_PLANE_URL = 'http://localhost:8080/v1/batch'
-        SSL = false
         HEADERS = { 'Accept' => 'application/json',
                     'Content-Type' => 'application/json',
-                    'User-Agent' => "rudderanalytics-ruby/#{Analytics::VERSION}" }
+                    'Content-Encoding' => 'gzip' }
         RETRIES = 10
       end
 

data/lib/rudder/analytics/field_parser.rb

@@ -2,10 +2,10 @@
 
 module Rudder
   class Analytics
-    # Handles parsing fields according to the Segment Spec
+    # Handles parsing fields according to the RudderStack Spec
     #
-    # @see https://segment.com/docs/spec/
-    class FieldParser
+    # @see https://www.rudderstack.com/docs/event-spec/standard-events/
+    class FieldParser # rubocop:disable Metrics/ClassLength
       class << self
         include Rudder::Analytics::Utils
 
@@ -17,17 +17,11 @@ module Rudder
           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
+            :event => event.to_s
           })
         end
 
@@ -37,13 +31,18 @@ module Rudder
         def parse_for_identify(fields)
           common = parse_common_fields(fields)
 
-          traits = fields[:traits] || {}
-          check_is_hash!(traits, 'traits')
-          isoify_dates! traits
+          # add the traits if present
+          if fields[:traits]
+            traits = fields[:traits]
+            context = common[:context].merge({ :traits => traits })
+
+            common = common.merge({
+              :context => context
+            })
+          end
 
           common.merge({
-            :type => 'identify',
-            :traits => traits
+            :type => 'identify'
           })
         end
 
@@ -55,6 +54,7 @@ module Rudder
 
           previous_id = fields[:previous_id]
           check_presence!(previous_id, 'previous_id')
+          check_string(previous_id, 'previous_id')
 
           common.merge({
             :type => 'alias',
@@ -70,17 +70,12 @@ module Rudder
           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
+          check_string(group_id, 'group_id')
 
           common.merge({
             :type => 'group',
-            :groupId => group_id,
-            :traits => traits
+            :groupId => group_id
           })
         end
 
@@ -92,15 +87,13 @@ module Rudder
           common = parse_common_fields(fields)
 
           name = fields[:name] || ''
-          properties = fields[:properties] || {}
-
-          check_is_hash!(properties, 'properties')
-
-          isoify_dates! properties
+          properties = common[:properties] || {}
+          properties = properties.merge({ :name => name })
 
           common.merge({
             :type => 'page',
-            :name => name.to_s,
+            :name => name,
+            :event => name,
             :properties => properties
           })
         end
@@ -109,22 +102,21 @@ module Rudder
         #
         # - "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] || {}
+          properties = common[:properties] || {}
+          properties = properties.merge({ :name => name })
+
           category = fields[:category]
 
           check_presence!(name, 'name')
-          check_is_hash!(properties, 'properties')
-
-          isoify_dates! properties
 
           parsed = common.merge({
             :type => 'screen',
             :name => name,
+            :event => name,
             :properties => properties
           })
 
@@ -135,40 +127,68 @@ module Rudder
 
         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] || {}
-
+        def parse_common_fields(fields) # rubocop:disable Metrics/AbcSize Metrics/CyclomaticComplexity Metrics/PerceivedComplexity
           check_user_id! fields
+
+          current_time = Time.now.utc
+          timestamp = fields[:timestamp] || current_time
           check_timestamp! timestamp
 
+          context = fields[:context] || {}
+          delete_library_from_context! context
           add_context! context
 
           parsed = {
             :context => context,
-            :messageId => message_id,
-            :timestamp => datetime_in_iso8601(timestamp)
+            :integrations => fields[:integrations] || { :All => true },
+            :timestamp => datetime_in_iso8601(timestamp),
+            :sentAt => datetime_in_iso8601(current_time),
+            :messageId => fields[:message_id] || uid,
+            :channel => 'server'
           }
 
-          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]
-
+          # add the userId if present
+          if fields[:user_id]
+            check_string(fields[:user_id], 'user_id')
+            parsed = parsed.merge({ :userId => fields[:user_id] })
+          end
+          # add the anonymousId if present
+          if fields[:anonymous_id]
+            check_string(fields[:anonymous_id], 'anonymous_id')
+            parsed = parsed.merge({ :anonymousId => fields[:anonymous_id] })
+          end
+          # add the properties if present
+          if fields[:properties]
+            properties = fields[:properties]
+            check_is_hash!(properties, 'properties')
+            isoify_dates! properties
+            parsed = parsed.merge({ :properties => properties })
+          end
+          # add the traits if present
+          if fields[:traits]
+            traits = fields[:traits]
+            check_is_hash!(traits, 'traits')
+            isoify_dates! traits
+            parsed = parsed.merge({ :traits => traits })
+          end
           parsed
         end
 
         def check_user_id!(fields)
-          raise ArgumentError, 'Must supply either user_id or anonymous_id' unless fields[:user_id] || fields[:anonymous_id]
+          return unless blank?(fields[:user_id])
+          return unless blank?(fields[:anonymous_id])
+
+          raise ArgumentError, 'Must supply either user_id or anonymous_id'
         end
 
         def check_timestamp!(timestamp)
           raise ArgumentError, 'Timestamp must be a Time' unless timestamp.is_a? Time
         end
 
+        def delete_library_from_context!(context)
+          context.delete(:library) if context # rubocop:disable Style/SafeNavigation
+        end
+
         def add_context!(context)
           context[:library] = { :name => 'rudderanalytics-ruby', :version => Rudder::Analytics::VERSION.to_s }
         end
@@ -178,7 +198,11 @@ module Rudder
         # obj    - String|Number that must be non-blank
         # name   - Name of the validated value
         def check_presence!(obj, name)
-          raise ArgumentError, "#{name} must be given" if obj.nil? || (obj.is_a?(String) && obj.empty?)
+          raise ArgumentError, "#{name} must be given" if blank?(obj)
+        end
+
+        def blank?(obj)
+          obj.nil? || (obj.is_a?(String) && obj.empty?)
         end
 
         def check_is_hash!(obj, name)

data/lib/rudder/analytics/test_queue.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Rudder
+  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/rudder/analytics/{request.rb → transport.rb}

@@ -10,48 +10,38 @@ require 'net/https'
 require 'json'
 require 'pry'
 require 'uri'
+require 'zlib'
 
 module Rudder
   class Analytics
-    class Request
+    class Transport
       include Rudder::Analytics::Defaults::Request
       include Rudder::Analytics::Utils
       include Rudder::Analytics::Logging
 
-      # public: Creates a new request object to send analytics batch
-      #
-      def initialize(options = {})
-        options[:host] ||= HOST
-        options[:port] ||= PORT
-        options[:ssl] ||= SSL
-        @headers = options[:headers] || HEADERS
-        @path = options[:path] || PATH
-        @retries = options[:retries] || RETRIES
-        @backoff_policy =
-          options[:backoff_policy] || Rudder::Analytics::BackoffPolicy.new
-
-        uri = URI(options[:data_plane_url] || DATA_PLANE_URL)
-        # printf("************\n")
-        # printf("************\n")
-        # printf(options[:data_plane_url] || DATA_PLANE_URL)
-        # printf("\n************\n")
-        # printf(uri.host)
-        # printf("\n************\n")
-        # printf(uri.port.to_s)
-        # printf("************\n")
+      attr_reader :stub
+
+      def initialize(config)
+        @stub = config.stub || false
+        @path = PATH
+        @retries = config.retries || RETRIES
+        @backoff_policy = config.backoff_policy || Rudder::Analytics::BackoffPolicy.new
+
+        uri = URI(config.data_plane_url)
 
         http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = options[:ssl]
+        http.use_ssl = config.ssl || true
         http.read_timeout = 8
         http.open_timeout = 4
 
         @http = http
+        @gzip = config.gzip.nil? ? true : config.gzip
       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
@@ -81,6 +71,11 @@ module Rudder
         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)
@@ -126,32 +121,34 @@ module Rudder
 
       # Sends a request for the batch, returns [status_code, body]
       def send_request(write_key, batch)
-        payload = JSON.generate(
-          :sentAt => datetime_in_iso8601(Time.now),
-          :batch => batch
-        )
-        request = Net::HTTP::Post.new(@path, @headers)
-        request.basic_auth(write_key, nil)
-
-        if self.class.stub
+        if stub
           logger.debug "stubbed request to #{@path}: " \
             "write key = #{write_key}, batch = #{JSON.generate(batch)}"
 
           [200, '{}']
         else
-          puts payload
+          payload = {
+            :batch => batch
+          }
+
+          headers = HEADERS
+
+          if @gzip
+            gzip = Zlib::GzipWriter.new(StringIO.new)
+            gzip << payload.to_json
+            payload = gzip.close.string
+          else
+            headers.delete('Content-Encoding')
+            payload = JSON.generate(payload)
+          end
+
+          request = Net::HTTP::Post.new(@path, headers)
+          request.basic_auth(write_key, nil)
+          @http.start unless @http.started? # Maintain a persistent connection
           response = @http.request(request, payload)
           [response.code.to_i, response.body]
         end
       end
-
-      class << self
-        attr_writer :stub
-
-        def stub
-          @stub || ENV['STUB']
-        end
-      end
     end
   end
 end

data/lib/rudder/analytics/utils.rb

@@ -10,9 +10,7 @@ module Rudder
       # public: Return a new hash with keys converted from strings to symbols
       #
       def symbolize_keys(hash)
-        hash.each_with_object({}) do |(k, v), memo|
-          memo[k.to_sym] = v
-        end
+        hash.transform_keys(&:to_sym)
       end
 
       # public: Convert hash keys from strings to symbols in place
@@ -50,7 +48,7 @@ module Rudder
         arr = SecureRandom.random_bytes(16).unpack('NnnnnN')
         arr[2] = (arr[2] & 0x0fff) | 0x4000
         arr[3] = (arr[3] & 0x3fff) | 0x8000
-        '%08x-%04x-%04x-%04x-%04x%08x' % arr
+        '%08x-%04x-%04x-%04x-%04x%08x' % arr # rubocop:disable Style/FormatStringToken
       end
 
       def datetime_in_iso8601(datetime)
@@ -66,10 +64,8 @@ module Rudder
         end
       end
 
-      def time_in_iso8601(time, fraction_digits = 3)
-        fraction = (('.%06i' % time.usec)[0, fraction_digits + 1] if fraction_digits > 0)
-
-        "#{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.%3N')}#{formatted_offset(time, true, 'Z')}"
       end
 
       def date_in_iso8601(date)
@@ -81,7 +77,11 @@ module Rudder
       end
 
       def seconds_to_utc_offset(seconds, colon = true)
-        (colon ? UTC_OFFSET_WITH_COLON : UTC_OFFSET_WITHOUT_COLON) % [(seconds < 0 ? '-' : '+'), (seconds.abs / 3600), ((seconds.abs % 3600) / 60)]
+        (colon ? UTC_OFFSET_WITH_COLON : UTC_OFFSET_WITHOUT_COLON) % [(seconds.negative? ? '-' : '+'), (seconds.abs / 3600), ((seconds.abs % 3600) / 60)]
+      end
+
+      def check_string(obj, name)
+        raise ArgumentError, "#{name} must be a String" unless obj.is_a? String
       end
 
       UTC_OFFSET_WITH_COLON = '%s%02d:%02d'

data/lib/rudder/analytics/version.rb

@@ -2,6 +2,6 @@
 
 module Rudder
   class Analytics
-    VERSION = '0.0.5'
+    VERSION = '2.0.0'
   end
 end

data/lib/rudder/analytics/worker.rb

@@ -2,7 +2,7 @@
 
 require 'rudder/analytics/defaults'
 require 'rudder/analytics/message_batch'
-require 'rudder/analytics/request'
+require 'rudder/analytics/transport'
 require 'rudder/analytics/utils'
 
 module Rudder
@@ -23,16 +23,15 @@ module Rudder
       #           batch_size - Fixnum of how many items to send in a batch
       #           on_error   - Proc of what to do on an error
       #
-      def initialize(queue, data_plane_url, write_key, options = {})
-        symbolize_keys! options
+      def initialize(queue, config)
         @queue = queue
-        @data_plane_url = data_plane_url
-        @write_key = write_key
-        @ssl = options[:ssl]
-        @on_error = options[:on_error] || proc { |status, error| }
-        batch_size = options[:batch_size] || Defaults::MessageBatch::MAX_SIZE
-        @batch = MessageBatch.new(batch_size)
+        @data_plane_url = config.data_plane_url
+        @write_key = config.write_key
+        @ssl = config.ssl
+        @on_error = config.on_error
+        @batch = MessageBatch.new(config.batch_size)
         @lock = Mutex.new
+        @transport = Transport.new(config)
       end
 
       # public: Continuously runs the loop to check for new events
@@ -45,11 +44,14 @@ module Rudder
             consume_message_from_queue! until @batch.full? || @queue.empty?
           end
 
-          res = Request.new(:data_plane_url => @data_plane_url, :ssl => @ssl).post @write_key, @batch
+          # res = Request.new(:data_plane_url => @data_plane_url, :ssl => @ssl).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.

data/lib/rudder/analytics.rb

@@ -6,7 +6,7 @@ require 'rudder/analytics/utils'
 require 'rudder/analytics/field_parser'
 require 'rudder/analytics/client'
 require 'rudder/analytics/worker'
-require 'rudder/analytics/request'
+require 'rudder/analytics/transport'
 require 'rudder/analytics/response'
 require 'rudder/analytics/logging'
 
@@ -20,7 +20,6 @@ module Rudder
     # @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)
       @client = Rudder::Analytics::Client.new options
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rudder-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 2.0.0
 platform: ruby
 authors:
 - Rudder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-10 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -137,24 +137,26 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.1.4
 description: The Rudder ruby analytics library
-email: soumya@rudderlabs.com
+email: arnab@rudderstack.com
 executables:
-- analytics-rudder.rb
+- analytics_rudder.rb
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/analytics-rudder.rb
+- bin/analytics_rudder.rb
 - lib/rudder-sdk-ruby.rb
 - lib/rudder.rb
 - lib/rudder/analytics.rb
 - lib/rudder/analytics/backoff_policy.rb
 - lib/rudder/analytics/client.rb
+- lib/rudder/analytics/configuration.rb
 - lib/rudder/analytics/defaults.rb
 - lib/rudder/analytics/field_parser.rb
 - lib/rudder/analytics/logging.rb
 - lib/rudder/analytics/message_batch.rb
-- lib/rudder/analytics/request.rb
 - lib/rudder/analytics/response.rb
+- lib/rudder/analytics/test_queue.rb
+- lib/rudder/analytics/transport.rb
 - lib/rudder/analytics/utils.rb
 - lib/rudder/analytics/version.rb
 - lib/rudder/analytics/worker.rb
@@ -177,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Rudder analytics library

data/bin/analytics-rudder.rb

@@ -1,111 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rudder/analytics'
-require 'rubygems'
-require 'commander/import'
-require 'time'
-require 'json'
-
-program :name, 'simulator.rb'
-program :version, '0.0.1'
-program :description, 'scripting simulator'
-
-def json_hash(str)
-  if str
-    return JSON.parse(str)
-  end
-end
-
-# analytics -method=<method> -segment-write-key=<segmentWriteKey> [options]
-# Run in dev with ruby -ilib bin/analytics -method=<method> -segment-write-key=<segmentWriteKey> [options] 
-
-default_command :send
-
-command :send do |c|
-  c.description = 'send a segment message'
-
-  c.option '--writeKey=<writeKey>', String, 'the Rudder writeKey'
-  c.option '--dataPlaneUrl=<dataPlaneUrl>', String, 'the Rudder data plane URL'
-  c.option '--type=<type>', String, 'The Segment message type'
-
-  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)'
-
-  c.option '--name=<name>', 'name of the screen or page to send with the message'
-
-  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 = Rudder::Analytics.new({
-      write_key: options.writeKey,
-      data_plane_url: options.dataPlaneUrl,
-      on_error: Proc.new { |status, msg| print msg }
-    })
-
-    case options.type
-    when "track"
-      Analytics.track({
-        user_id: options.userId,
-        event: options.event,
-        anonymous_id: options.anonymousId,
-        properties: json_hash(options.properties),
-        context: json_hash(options.context),
-        integrations: json_hash(options.integrations)
-      })
-    when "page"
-      Analytics.page({
-        user_id: options.userId,
-        anonymous_id: options.anonymousId,
-        name: options.name,
-        properties: json_hash(options.properties),
-        context: json_hash(options.context),
-        integrations: json_hash(options.integrations)
-      })
-    when "screen"
-      Analytics.screen({
-        user_id: options.userId,
-        anonymous_id: options.anonymousId,
-        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),
-        integrations: json_hash(options.integrations)
-      })
-    when "group"
-      Analytics.group({
-        user_id: options.userId,
-        anonymous_id: options.anonymousId,
-        group_id: options.groupId,
-        traits: json_hash(options.traits),
-        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}"
-    end
-    Analytics.flush
-  end
-end