rudder_analytics_sync 1.0.7 → 2.0.1

data/lib/rudder_analytics_sync/batch.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+require 'rudder_analytics_sync/constants'
+
 module RudderAnalyticsSync
   class Batch
     include RudderAnalyticsSync::Utils
+    include RudderAnalyticsSync::Constants
 
-    attr_reader :client, :payload
+    attr_reader :client, :payload, :batch_context, :batch_integrations
 
     def self.deserialize(client, payload)
       new(client, symbolize_keys(payload))
@@ -40,11 +43,14 @@ module RudderAnalyticsSync
     end
 
     def context=(context)
-      payload[:context] = context
+      if context # rubocop:disable Style/SafeNavigation
+        context.delete(:library)
+      end
+      @batch_context = context
     end
 
     def integrations=(integrations)
-      payload[:integrations] = integrations
+      @batch_integrations = integrations
     end
 
     def serialize
@@ -56,17 +62,25 @@ module RudderAnalyticsSync
         raise ArgumentError, 'A batch must contain at least one action'
       end
 
+      if payload[:batch].inspect.length > MAX_BATCH_SIZE
+        raise ArgumentError, 'Max batch size is 500 KB'
+      end
+
       Request.new(client).post('/v1/batch', payload)
     end
 
     private
 
-    def add(operation_class, options, action)
+    def add(operation_class, options, action) # rubocop:disable Metrics/AbcSize
       operation = operation_class.new(client, symbolize_keys(options))
       operation_payload = operation.build_payload
-      operation_payload[:context] = operation_payload[:context].merge(payload[:context] || {})
-      operation_payload[:integrations] = payload[:integrations] || operation_payload[:integrations]
+      operation_payload[:context] = operation_payload[:context].merge(batch_context || {})
+      operation_payload[:integrations] = batch_integrations || operation_payload[:integrations]
       operation_payload[:type] = action
+      if operation_payload.inspect.length > MAX_MESSAGE_SIZE
+        raise ArgumentError, 'Max message size is 32 KB'
+      end
+
       payload[:batch] << operation_payload
     end
   end

data/lib/rudder_analytics_sync/client.rb

@@ -22,6 +22,7 @@ module RudderAnalyticsSync
     # @option :context [Hash]
     # @option :integrations [Hash]
     # @option :timestamp [#iso8601] (Time.now)
+    # @option :message_id
     def identify(options)
       Operations::Identify.new(self, symbolize_keys(options)).call
     end
@@ -34,6 +35,7 @@ module RudderAnalyticsSync
     # @option :context [Hash]
     # @option :integrations [Hash]
     # @option :timestamp [#iso8601] (Time.now)
+    # @option :message_id
     def track(options)
       Operations::Track.new(self, symbolize_keys(options)).call
     end
@@ -46,10 +48,24 @@ module RudderAnalyticsSync
     # @option :context [Hash]
     # @option :integrations [Hash]
     # @option :timestamp [#iso8601] (Time.now)
+    # @option :message_id
     def page(options)
       Operations::Page.new(self, symbolize_keys(options)).call
     end
 
+    # @param [Hash] options
+    # @option :user_id
+    # @option :anonymous_id
+    # @option :name [String]
+    # @option :properties [Hash]
+    # @option :context [Hash]
+    # @option :integrations [Hash]
+    # @option :timestamp [#iso8601] (Time.now)
+    # @option :message_id
+    def screen(options)
+      Operations::Screen.new(self, symbolize_keys(options)).call
+    end
+
     # @param [Hash] options
     # @option :user_id
     # @option :anonymous_id
@@ -58,6 +74,7 @@ module RudderAnalyticsSync
     # @option :context [Hash]
     # @option :integrations [Hash]
     # @option :timestamp [#iso8601] (Time.now)
+    # @option :message_id
     def group(options)
       Operations::Group.new(self, symbolize_keys(options)).call
     end
@@ -70,6 +87,7 @@ module RudderAnalyticsSync
     # @option :context [Hash]
     # @option :integrations [Hash]
     # @option :timestamp [#iso8601] (Time.now)
+    # @option :message_id
     def alias(options)
       Operations::Alias.new(self, symbolize_keys(options)).call
     end

data/lib/rudder_analytics_sync/configuration.rb

@@ -6,8 +6,7 @@ module RudderAnalyticsSync
   class Configuration
     include RudderAnalyticsSync::Utils
     include RudderAnalyticsSync::Logging
-
-    attr_reader :write_key, :data_plane_url, :on_error, :stub, :logger, :http_options
+    attr_reader :write_key, :data_plane_url, :on_error, :stub, :logger, :http_options, :gzip
 
     def initialize(settings = {})
       symbolized_settings = symbolize_keys(settings)
@@ -18,6 +17,7 @@ module RudderAnalyticsSync
       @logger = default_logger(symbolized_settings[:logger])
       @http_options = { use_ssl: true }
                       .merge(symbolized_settings[:http_options] || {})
+      @gzip = symbolized_settings[:gzip]
       raise ArgumentError, 'Missing required option :write_key' \
         unless @write_key
     end

data/lib/rudder_analytics_sync/constants.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RudderAnalyticsSync
+  module Constants
+    MAX_BATCH_SIZE = 500_000 # ~500 KB
+    MAX_MESSAGE_SIZE = 32_000  # ~32 KB
+    BASE_URL = 'https://hosted.rudderlabs.com'
+
+    DEFAULT_HEADERS = {
+      'Content-Type' => 'application/json',
+      'accept' => 'application/json'
+    }.freeze
+
+    DEFAULT_CONTEXT = {
+      library: {
+        name: 'rudder-sdk-ruby-sync',
+        version: RudderAnalyticsSync::VERSION
+      }
+    }.freeze
+  end
+end

data/lib/rudder_analytics_sync/logging.rb

@@ -8,7 +8,7 @@ module RudderAnalyticsSync
     end
 
     def default_logger(logger_option)
-      logger_option || Logger.new(STDOUT)
+      logger_option || Logger.new($stdout)
     end
   end
 end

data/lib/rudder_analytics_sync/operations/alias.rb

@@ -4,7 +4,14 @@ module RudderAnalyticsSync
   module Operations
     class Alias < Operation
       def call
-        request.post('/v1/alias', build_payload)
+        batch = build_payload.merge(
+          type: 'alias'
+        )
+        if batch.inspect.length > MAX_MESSAGE_SIZE
+          raise ArgumentError, 'Max message size is 32 KB'
+        end
+
+        request.post('/v1/batch', { 'batch' => [batch] })
       end
 
       def build_payload

data/lib/rudder_analytics_sync/operations/group.rb

@@ -4,7 +4,14 @@ module RudderAnalyticsSync
   module Operations
     class Group < Operation
       def call
-        request.post('/v1/group', build_payload)
+        batch = build_payload.merge(
+          type: 'group'
+        )
+        if batch.inspect.length > MAX_MESSAGE_SIZE
+          raise ArgumentError, 'Max message size is 32 KB'
+        end
+
+        request.post('/v1/batch', { 'batch' => [batch] })
       end
 
       def build_payload

data/lib/rudder_analytics_sync/operations/identify.rb

@@ -4,14 +4,24 @@ module RudderAnalyticsSync
   module Operations
     class Identify < Operation
       def call
-        request.post('/v1/identify', build_payload)
+        batch = build_payload.merge(
+          type: 'identify'
+        )
+        if batch.inspect.length > MAX_MESSAGE_SIZE
+          raise ArgumentError, 'Max message size is 32 KB'
+        end
+
+        request.post('/v1/batch', { 'batch' => [batch] })
       end
 
       def build_payload
-        merged_payload = base_payload.merge(
-          traits: options[:traits] && isoify_dates!(options[:traits])
-        )
-        merged_payload[:context][:traits] = merged_payload[:context][:traits].merge(options[:traits] || {})
+        merged_payload = base_payload
+        if options[:traits]
+          merged_payload = merged_payload.merge(
+            traits: options[:traits] && isoify_dates!(options[:traits])
+          )
+          merged_payload[:context][:traits] = options[:traits] && isoify_dates!(options[:traits])
+        end
         merged_payload
       end
     end

data/lib/rudder_analytics_sync/operations/operation.rb

@@ -1,28 +1,27 @@
 # frozen_string_literal: true
 
 require 'rudder_analytics_sync/utils'
+require 'rudder_analytics_sync/constants'
 
 module RudderAnalyticsSync
   module Operations
     class Operation
       include RudderAnalyticsSync::Utils
-
-      DEFAULT_CONTEXT = {
-        library: {
-          name: 'rudder-sdk-ruby-sync',
-          version: RudderAnalyticsSync::VERSION
-        },
-        traits: {
-
-        }
-      }.freeze
+      include RudderAnalyticsSync::Constants
 
       def initialize(client, options = {})
         @options = options
-        @context = DEFAULT_CONTEXT.merge(options[:context].to_h)
+        @context = make_context(options[:context])
         @request = Request.new(client)
       end
 
+      def make_context(option_context)
+        if option_context # rubocop:disable Style/SafeNavigation
+          option_context.delete(:library)
+        end
+        DEFAULT_CONTEXT.merge(option_context.to_h)
+      end
+
       def call
         raise 'Must be implemented in a subclass'
       end
@@ -31,7 +30,7 @@ module RudderAnalyticsSync
 
       attr_reader :options, :request, :context
 
-      def base_payload
+      def base_payload # rubocop:disable Metrics/AbcSize
         check_identity!
         current_time = Time.now.utc
 
@@ -40,18 +39,23 @@ module RudderAnalyticsSync
           integrations: options[:integrations] || { All: true },
           timestamp: maybe_datetime_in_iso8601(options[:timestamp] || Time.now.utc),
           sentAt: maybe_datetime_in_iso8601(current_time),
-          messageId: uid(),
-          properties: options[:properties] || {}
+          messageId: options[:message_id] || uid,
+          channel: 'server'
         }
 
+        # add the properties if present
+        if options[:properties]
+          payload = payload.merge({ properties: options[:properties] })
+        end
+
         # add the userId if present
-        if (options[:user_id])
-            payload = payload.merge({userId: options[:user_id]})
+        if options[:user_id]
+          payload = payload.merge({ userId: options[:user_id] })
         end
 
         # add the anonymousId if present
-        if (options[:anonymous_id])
-            payload = payload.merge({anonymousId: options[:anonymous_id]})
+        if options[:anonymous_id]
+          payload = payload.merge({ anonymousId: options[:anonymous_id] })
         end
         payload
       end

data/lib/rudder_analytics_sync/operations/page.rb

@@ -4,7 +4,14 @@ module RudderAnalyticsSync
   module Operations
     class Page < Operation
       def call
-        request.post('/v1/page', build_payload)
+        batch = build_payload.merge(
+          type: 'page'
+        )
+        if batch.inspect.length > MAX_MESSAGE_SIZE
+          raise ArgumentError, 'Max message size is 32 KB'
+        end
+
+        request.post('/v1/batch', { 'batch' => [batch] })
       end
 
       def build_payload

data/lib/rudder_analytics_sync/operations/screen.rb

@@ -4,7 +4,14 @@ module RudderAnalyticsSync
   module Operations
     class Screen < Operation
       def call
-        request.post('/v1/screen', build_payload)
+        batch = build_payload.merge(
+          type: 'screen'
+        )
+        if batch.inspect.length > MAX_MESSAGE_SIZE
+          raise ArgumentError, 'Max message size is 32 KB'
+        end
+
+        request.post('/v1/batch', { 'batch' => [batch] })
       end
 
       def build_payload
@@ -13,7 +20,7 @@ module RudderAnalyticsSync
         base_payload.merge(
           name: options[:name],
           event: options[:name],
-          properties: properties.merge({name: options[:name]})
+          properties: properties.merge({ name: options[:name] })
         )
       end
     end

data/lib/rudder_analytics_sync/operations/track.rb

@@ -4,18 +4,26 @@ module RudderAnalyticsSync
   module Operations
     class Track < Operation
       def call
-        request.post('/v1/track', build_payload)
+        batch = build_payload.merge(
+          type: 'track'
+        )
+        if batch.inspect.length > MAX_MESSAGE_SIZE
+          raise ArgumentError, 'Max message size is 32 KB'
+        end
+
+        request.post('/v1/batch', { 'batch' => [batch] })
       end
 
       def build_payload
-        raise ArgumentError, 'event name must be present' \
-          unless options[:event]
+        raise ArgumentError, 'event name must be present' unless options[:event]
 
         properties = options[:properties] && isoify_dates!(options[:properties])
 
+        if properties
+          base_payload[:properties] = properties
+        end
         base_payload.merge(
-          event: options[:event],
-          properties: properties || {}
+          event: options[:event]
         )
       end
     end

data/lib/rudder_analytics_sync/request.rb

@@ -1,38 +1,49 @@
 # frozen_string_literal: true
 
+require 'rudder_analytics_sync/constants'
+require 'rudder_analytics_sync/logging'
+require('zlib')
+
 module RudderAnalyticsSync
   class Request
-    BASE_URL = 'https://hosted.rudderlabs.com'
-    DEFAULT_HEADERS = {
-      'Content-Type' => 'application/json',
-      'accept' => 'application/json'
-    }.freeze
+    include RudderAnalyticsSync::Logging
+    include RudderAnalyticsSync::Constants
 
-    attr_reader :write_key, :data_plane_url, :error_handler, :stub, :logger, :http_options
+    attr_reader :write_key, :data_plane_url, :error_handler, :stub, :logger, :http_options, :gzip
 
-    def initialize(client)
+    def initialize(client) # rubocop:disable Metrics/AbcSize
       @write_key = client.config.write_key
       @data_plane_url = client.config.data_plane_url || BASE_URL
       @error_handler = client.config.on_error
       @stub = client.config.stub
       @logger = client.config.logger
       @http_options = client.config.http_options
+      @gzip = client.config.gzip.nil? ? true : client.config.gzip
     end
 
-    def post(path, payload, headers: DEFAULT_HEADERS) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def post(path, payload, headers: DEFAULT_HEADERS) # rubocop:disable Metrics/AbcSize
       response = nil
       status_code = nil
       response_body = nil
 
       uri = URI(data_plane_url)
-      payload = JSON.generate(payload)
       if stub
         logger.debug "stubbed request to \
         #{path}: write key = #{write_key}, \
-        payload = #{payload}"
+        payload = #{JSON.generate(payload)}"
 
         { status: 200, error: nil }
       else
+        if gzip
+          headers = headers.merge(
+            'Content-Encoding': 'gzip'
+          )
+          gzip = Zlib::GzipWriter.new(StringIO.new)
+          gzip << payload.to_json
+          payload = gzip.close.string
+        else
+          payload = JSON.generate(payload)
+        end
         Net::HTTP.start(uri.host, uri.port, :ENV, http_options) do |http|
           request = Net::HTTP::Post.new(path, headers)
           request.basic_auth write_key, nil

data/lib/rudder_analytics_sync/utils.rb

@@ -9,9 +9,7 @@ module RudderAnalyticsSync
     end
 
     def symbolize_keys(hash)
-      hash.each_with_object({}) do |(key, value), result|
-        result[key.to_sym] = value
-      end
+      hash.transform_keys(&:to_sym)
     end
 
     # public: Converts all the date values in the into iso8601 strings in place
@@ -24,35 +22,35 @@ module RudderAnalyticsSync
     #         strings
     #
     def isoify_dates(hash)
-      hash.each_with_object({}) do |(k, v), memo|
-        memo[k] = maybe_datetime_in_iso8601(v)
+      hash.transform_values do |v|
+        maybe_datetime_in_iso8601(v)
       end
     end
 
     # public: Returns a uid string
     #
     def uid
-        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
+      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 # rubocop:disable Style/FormatString
     end
 
     def maybe_datetime_in_iso8601(datetime)
       case datetime
-        when Time
-          time_in_iso8601 datetime
-        when DateTime
-          time_in_iso8601 datetime.to_time
-        when Date
-          date_in_iso8601 datetime
-        else
-          datetime
+      when Time
+        time_in_iso8601 datetime
+      when DateTime
+        time_in_iso8601 datetime.to_time
+      when Date
+        date_in_iso8601 datetime
+      else
+        datetime
       end
     end
 
     def time_in_iso8601(time, fraction_digits = 3)
-      fraction = (('.%06i' % time.usec)[0, fraction_digits + 1] if fraction_digits > 0)
+      fraction = (format('.%06i', time.usec)[0, fraction_digits + 1] if fraction_digits.positive?)
 
       "#{time.strftime('%Y-%m-%dT%H:%M:%S')}#{fraction}#{formatted_offset(time, true, 'Z')}"
     end
@@ -61,12 +59,18 @@ module RudderAnalyticsSync
       date.strftime('%F')
     end
 
-    def formatted_offset(time, colon = true, alternate_utc_string = nil)
-      time.utc? && alternate_utc_string || seconds_to_utc_offset(time.utc_offset, colon)
+    def formatted_offset(time, colon = true, alternate_utc_string = nil) # rubocop:disable Style/OptionalBooleanParameter
+      (time.utc? && alternate_utc_string) || seconds_to_utc_offset(time.utc_offset, colon)
+    end
+
+    def seconds_to_utc_offset(seconds, colon = true) # rubocop:disable Style/OptionalBooleanParameter
+      format((colon ? UTC_OFFSET_WITH_COLON : UTC_OFFSET_WITHOUT_COLON), (seconds.negative? ? '-' : '+'), (seconds.abs / 3600), ((seconds.abs % 3600) / 60))
     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)]
+    def valid_date?(string)
+      !!(string.match(/\d{4}-\d{2}-\d{2}/) && Date.strptime(string, '%Y-%m-%d'))
+    rescue ArgumentError
+      false
     end
 
     UTC_OFFSET_WITH_COLON = '%s%02d:%02d'

data/lib/rudder_analytics_sync/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RudderAnalyticsSync
-  VERSION = '1.0.7'
+  VERSION = '2.0.1'
 end

data/rudder_analytics_sync.gemspec

@@ -24,7 +24,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '>= 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '0.75.0'
-  spec.add_development_dependency 'timecop', '~> 0.8.0'
+  spec.add_development_dependency 'rubocop', '1.23.0'
+  spec.add_development_dependency 'timecop', '~> 0.9.5'
   spec.add_development_dependency 'webmock', '~> 3.7'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rudder_analytics_sync
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 2.0.1
 platform: ruby
 authors:
 - RudderStack
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-12 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 1.23.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 1.23.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.5
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -118,16 +118,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/pull_request_template.md"
+- ".github/workflows/build-and-quality-checks.yml"
+- ".github/workflows/check-pr-title.yml"
+- ".github/workflows/notion-pr-sync.yml"
+- ".github/workflows/slack-notify.yml"
 - ".gitignore"
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
-- CHANGELOG.md
+- CODEOWNERS
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- SECURITY.md
 - bin/console
 - bin/setup
 - example/example.rb
@@ -135,6 +141,7 @@ files:
 - lib/rudder_analytics_sync/batch.rb
 - lib/rudder_analytics_sync/client.rb
 - lib/rudder_analytics_sync/configuration.rb
+- lib/rudder_analytics_sync/constants.rb
 - lib/rudder_analytics_sync/logging.rb
 - lib/rudder_analytics_sync/operations.rb
 - lib/rudder_analytics_sync/operations/alias.rb
@@ -151,7 +158,8 @@ files:
 homepage: https://github.com/rudderlabs/rudder-sdk-ruby-sync
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -167,7 +175,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: Privacy and Security focused Segment-alternative. Ruby SDK (sync)

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7