thinkingdata-ruby 1.2.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdd6d7eb248bfbddc35fdc947a9323ff6a1a16d10c2e396b5cd3f80dd272f866
-  data.tar.gz: e6ee651f3d35226a5f640f0c57868964abe0eba5841335249b262a81b264a018
+  metadata.gz: ba7de0dac467fe8c90747854c7701e0af035463b9b48b4708308e4c28d242c90
+  data.tar.gz: fa29bd005cbe4b32cceecd85d726e79b7b0e0fb4e51346b649f25d7b44affcca
 SHA512:
-  metadata.gz: 442a30338ce592df0f6c9e3dd505255390e8797d405326009064531f45637bd2c86f1bbca10efd14a8e6dd8b12ebbfe183be0795c8e029fcec19362627024033
-  data.tar.gz: 605e8773859e0147486ed023c7ab187cd308aaf4e810cc1f633d9e72810cbadfd01fe19b45bebd1042e8741b1ac0e791d8662c36c5097e6d94694d5b051d0a0d
+  metadata.gz: e73fadf565e9143fd67ad1c99e1472ee027d7eda707a4b2452705b620d05d1f223b71e99d61b84c0bbb353792f2f1f62212c7d2c04e670c736ee5e94db74291e
+  data.tar.gz: 39fce15278418ba6d92dface6276acee8760953954ff5521fb115f91c81bf83807e063e7caf6a59db0fd8e388407f74a7a0748d02b99086d3de91c8f2b0ffd31

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+### v2.0.1
+**Date:** 2026/05/13
+
+**Notes:**
+
+* Supports multi-threaded invocation
+
+### v2.0.0
+**Date:** 2023/09/20
+
+**Notes:**
+
+* Modified module name, incompatible with older versions
+
 ### v1.2.1
 **Date:** 2023/03/20
 
@@ -6,7 +20,6 @@
 * Compatible ruby 3
 * Supports a different '#app_id' for each event
 
-
 ### v1.2.0
 **Date:** 2020/08/28
 

data/README.md

@@ -1,5 +1,6 @@
 # ThinkingData SDK for Ruby
-![output](https://user-images.githubusercontent.com/53337625/205621683-ed9b97ef-6a52-4903-a2c0-a955dddebb7d.png)
+
+<img src="https://user-images.githubusercontent.com/53337625/205621683-ed9b97ef-6a52-4903-a2c0-a955dddebb7d.png" alt="logo" width="50%"/>
 
 This is the [ThinkingData](https://www.thinkingdata.cn)™ SDK for Ruby. Documentation is available on our help center in the following languages:
 

data/demo/demo.rb

@@ -4,38 +4,38 @@ require 'thinkingdata-ruby'
 require 'time'
 
 if __FILE__ == $0
-  DEMO_APPID = 'app id'
-  SERVER_URL = 'server url'
-  DEMO_ACCOUNT_ID = '123'
-  DEMO_DISTINCT_ID = 'aaa'
 
-  class MyErrorHandler < TDAnalytics::ErrorHandler
+  class MyErrorHandler < ThinkingData::TDErrorHandler
     def handle(error)
       puts error
       raise error
     end
   end
-  my_error_handler = MyErrorHandler.new
 
-  TDAnalytics::set_stringent(false)
-  TDAnalytics::set_enable_log(true)
-
-  consumer = nil
-  $ARGV = 0
-  case $ARGV
-  when 0
-    consumer = TDAnalytics::LoggerConsumer.new './log', 'hourly'
-  when 1
-    consumer = TDAnalytics::DebugConsumer.new(SERVER_URL, DEMO_APPID, device_id: "123456789")
-    # consumer = TDAnalytics::DebugConsumer.new(SERVER_URL, DEMO_APPID,false)
-  when 2
-    consumer = TDAnalytics::BatchConsumer.new(SERVER_URL, DEMO_APPID, 30)
-    #consumer._set_compress(false)
-  else
-    consumer = TDAnalytics::LoggerConsumer.new
+  def logger_consumer
+    ThinkingData::TDLoggerConsumer.new('./log', 'hourly')
+  end
+
+  def debug_consumer
+    ThinkingData::TDDebugConsumer.new("serverUrl", "appId", device_id: "123456789")
+  end
+
+  def batch_consumer
+    consumer = ThinkingData::TDBatchConsumer.new("serverUrl", "appId", 50)
+    consumer._set_compress(false)
+    consumer
   end
 
-  ta = TDAnalytics::Tracker.new(consumer, my_error_handler, uuid: true)
+  ThinkingData::set_stringent(false)
+  ThinkingData::set_enable_log(true)
+  my_error_handler = MyErrorHandler.new
+
+  td_sdk = ThinkingData::TDAnalytics.new(logger_consumer, my_error_handler, uuid: false)
+  # td_sdk = ThinkingData::TDAnalytics.new(debug_consumer, my_error_handler, uuid: true)
+  # td_sdk = ThinkingData::TDAnalytics.new(batch_consumer, my_error_handler, uuid: true)
+
+  DEMO_ACCOUNT_ID = '123'
+  DEMO_DISTINCT_ID = 'aaa'
 
   super_properties = {
       super_string: 'super_string',
@@ -45,7 +45,7 @@ if __FILE__ == $0
       '#app_id': "123123123123123"
   }
 
-  ta.set_super_properties(super_properties)
+  td_sdk.set_super_properties(super_properties)
 
   properties = {
     array: ["str1", "11", Time.now, "2020-02-11 17:02:52.415"],
@@ -54,19 +54,18 @@ if __FILE__ == $0
     prop_string: 'hello world',
     prop_bool: true,
     '#ip': '123.123.123.123',
-    '#uuid': 'aaabbbccc',
   }
 
-  ta.set_dynamic_super_properties do
+  td_sdk.set_dynamic_super_properties do
     {:dynamic_time => Time.now}
   end
 
-  ta.track(event_name: 'test_event', distinct_id: DEMO_DISTINCT_ID, account_id: DEMO_ACCOUNT_ID, properties: properties)
+  td_sdk.track(event_name: 'test_event', distinct_id: DEMO_DISTINCT_ID, account_id: DEMO_ACCOUNT_ID, properties: properties)
 
-  ta.clear_dynamic_super_properties
-  ta.clear_super_properties
+  td_sdk.clear_dynamic_super_properties
+  td_sdk.clear_super_properties
 
-  ta.track(event_name: 'test_event', distinct_id: DEMO_DISTINCT_ID, account_id: DEMO_ACCOUNT_ID, properties: properties)
+  td_sdk.track(event_name: 'test_event', distinct_id: DEMO_DISTINCT_ID, account_id: DEMO_ACCOUNT_ID, properties: properties)
 
   user_data = {
     array: ["str1", 11, 22.22],
@@ -75,31 +74,31 @@ if __FILE__ == $0
     prop_string: 'hello',
     prop_int: 666,
   }
-  ta.user_set(distinct_id: DEMO_DISTINCT_ID, account_id: DEMO_ACCOUNT_ID, properties: user_data)
+  td_sdk.user_set(distinct_id: DEMO_DISTINCT_ID, account_id: DEMO_ACCOUNT_ID, properties: user_data)
 
   user_append_data = {
     array: %w[33 44]
   }
-  ta.user_append(distinct_id: DEMO_DISTINCT_ID, account_id: DEMO_ACCOUNT_ID, properties: user_append_data)
+  td_sdk.user_append(distinct_id: DEMO_DISTINCT_ID, account_id: DEMO_ACCOUNT_ID, properties: user_append_data)
 
   user_uniq_append_data = {
     array: %w[44 55]
   }
-  ta.user_uniq_append(distinct_id: DEMO_DISTINCT_ID, account_id: DEMO_ACCOUNT_ID, properties: user_uniq_append_data)
+  td_sdk.user_uniq_append(distinct_id: DEMO_DISTINCT_ID, account_id: DEMO_ACCOUNT_ID, properties: user_uniq_append_data)
 
   user_set_once_data = {
     prop_int_new: 888,
   }
-  ta.user_set_once(distinct_id: DEMO_DISTINCT_ID, account_id: DEMO_ACCOUNT_ID, properties: user_set_once_data)
+  td_sdk.user_set_once(distinct_id: DEMO_DISTINCT_ID, account_id: DEMO_ACCOUNT_ID, properties: user_set_once_data)
 
-  ta.user_add(distinct_id: DEMO_DISTINCT_ID, properties: {prop_int: 10, prop_double: 15.88})
+  td_sdk.user_add(distinct_id: DEMO_DISTINCT_ID, properties: {prop_int: 10, prop_double: 15.88})
 
-  ta.user_unset(distinct_id: DEMO_DISTINCT_ID, property: [:prop_string, :prop_int])
+  td_sdk.user_unset(distinct_id: DEMO_DISTINCT_ID, property: [:prop_string, :prop_int])
 
-  ta.user_del(distinct_id: DEMO_DISTINCT_ID)
+  td_sdk.user_del(distinct_id: DEMO_DISTINCT_ID)
 
-  ta.flush
+  td_sdk.flush
 
-  ta.close
+  td_sdk.close
 end
 

data/lib/thinkingdata-ruby/{tracker.rb → td_analytics.rb}

@@ -1,11 +1,16 @@
 require 'securerandom'
-require 'thinkingdata-ruby/errors'
-require 'thinkingdata-ruby/version'
+require 'thinkingdata-ruby/td_errors'
+require 'thinkingdata-ruby/td_version'
 
-module TDAnalytics
+##
+# ThinkingData module
+module ThinkingData
   @is_enable_log = false
   @is_stringent = false
 
+  ##
+  # Enable SDK log or not
+  # @param enable [Boolean] true or false
   def self.set_enable_log(enable)
     unless [true, false].include? enable
       enable = false
@@ -13,10 +18,16 @@ module TDAnalytics
     @is_enable_log = enable
   end
 
+  ##
+  # Get log status
+  # @return [Boolean] enable or not
   def self.get_enable_log
     @is_enable_log
   end
 
+  ##
+  # Check or not parameter
+  # @param enable [Boolean] check or not
   def self.set_stringent(enable)
     unless [true, false].include? enable
       enable = false
@@ -24,53 +35,81 @@ module TDAnalytics
     @is_stringent = enable
   end
 
+  ##
+  # Get parameter check status of SDK
+  # @return [Boolean] check or not
   def self.get_stringent
     @is_stringent
   end
 
-  class Tracker
+  ##
+  # Analytics class。 Provides the function of tracking data
+  class TDAnalytics
     LIB_PROPERTIES = {
       '#lib' => 'ruby',
-      '#lib_version' => TDAnalytics::VERSION,
+      '#lib_version' => ThinkingData::VERSION,
     }
 
-    @@dynamic_block = nil
+    @dynamic_block = nil
 
+    ##
+    # Init function
+    #   @param consumer [consumer] data consumer: TDLoggerConsumer | TDDebugConsumer | TDBatchConsumer
+    #   @param error_handler [TDErrorHandler] custom error handler, process SDK error. It could be nil
+    #   @param uuid [Boolean] Whether to automatically add uuid
     def initialize(consumer, error_handler = nil, uuid: false)
-      @error_handler = error_handler || ErrorHandler.new
+      @error_handler = error_handler || TDErrorHandler.new
       @consumer = consumer
       @super_properties = {}
-      @uuid = uuid
+      @uuid_enable = uuid
+      @mutex = Mutex.new
+      TDLog.info("SDK init success.")
     end
 
-    # set common properties
+    ##
+    # Set common properties
     def set_super_properties(properties, skip_local_check = false)
-      unless TDAnalytics::get_stringent == false || skip_local_check || _check_properties(:track, properties)
-        @error_handler.handle(IllegalParameterError.new("Invalid super properties"))
-        return false
-      end
-      properties.each do |k, v|
-        if v.is_a?(Time)
-          @super_properties[k] = _format_time(v)
-        else
-          @super_properties[k] = v
+      @mutex.synchronize do
+        unless ThinkingData::get_stringent == false || skip_local_check || _check_properties(:track, properties)
+          @error_handler.handle(IllegalParameterError.new("Invalid super properties"))
+          return false
+        end
+        properties.each do |k, v|
+          if v.is_a?(Time)
+            @super_properties[k] = _format_time(v)
+          else
+            @super_properties[k] = v
+          end
         end
       end
     end
 
+    ##
+    # Clear super properties
     def clear_super_properties
-      @super_properties = {}
+      @mutex.synchronize do
+        @super_properties = {}
+      end
     end
 
+    ##
+    # Set dynamic super properties
     def set_dynamic_super_properties(&block)
-      @@dynamic_block = block
+      @mutex.synchronize do
+        @dynamic_block = block
+      end
     end
 
+    ##
+    # Clear dynamic super properties
     def clear_dynamic_super_properties
-      @@dynamic_block = nil
+      @mutex.synchronize do
+        @dynamic_block = nil
+      end
     end
 
-    # report ordinary event
+    ##
+    # Report ordinary event
     #   event_name: (require) A string of 50 letters and digits that starts with '#' or a letter
     #   distinct_id: (optional) distinct ID
     #   account_id: (optional) account ID. distinct_id, account_id can't both be empty.
@@ -94,7 +133,16 @@ module TDAnalytics
       _internal_track(:track, event_name: event_name, distinct_id: distinct_id, account_id: account_id, properties: properties, time: time, ip: ip, first_check_id: first_check_id)
     end
 
-    # report overridable event
+    ##
+    # Report overridable event
+    #   event_name: (require) A string of 50 letters and digits that starts with '#' or a letter
+    #   event_id: (require) string
+    #   distinct_id: (optional) distinct ID
+    #   account_id: (optional) account ID. distinct_id, account_id can't both be empty.
+    #   properties: （optional) string、number、Time、boolean
+    #   time: （optional）Time
+    #   ip: (optional) ip
+    #   skip_local_check: (optional) check data or not
     def track_overwrite(event_name: nil,event_id: nil, distinct_id: nil, account_id: nil, properties: {}, time: nil, ip: nil, skip_local_check: false)
       begin
         _check_name event_name
@@ -111,7 +159,16 @@ module TDAnalytics
       _internal_track(:track_overwrite, event_name: event_name, event_id: event_id, distinct_id: distinct_id, account_id: account_id, properties: properties, time: time, ip: ip)
     end
 
-    # report updatable event
+    ##
+    # Report updatable event
+    #   event_name: (require) A string of 50 letters and digits that starts with '#' or a letter
+    #   event_id: (require) string
+    #   distinct_id: (optional) distinct ID
+    #   account_id: (optional) account ID. distinct_id, account_id can't both be empty.
+    #   properties: （optional) string、number、Time、boolean
+    #   time: （optional）Time
+    #   ip: (optional) ip
+    #   skip_local_check: (optional) check data or not
     def track_update(event_name: nil,event_id: nil, distinct_id: nil, account_id: nil, properties: {}, time: nil, ip: nil, skip_local_check: false)
       begin
         _check_name event_name
@@ -128,7 +185,12 @@ module TDAnalytics
       _internal_track(:track_update, event_name: event_name, event_id: event_id, distinct_id: distinct_id, account_id: account_id, properties: properties, time: time, ip: ip)
     end
 
-    # set user properties. would overwrite existing names.
+    ##
+    # Set user properties. would overwrite existing names
+    #   distinct_id: (optional) distinct ID
+    #   account_id: (optional) account ID. distinct_id, account_id can't both be empty.
+    #   properties: （optional) string、number、Time、boolean
+    #   ip: (optional) ip
     def user_set(distinct_id: nil, account_id: nil, properties: {}, ip: nil)
       begin
         _check_id(distinct_id, account_id)
@@ -141,7 +203,12 @@ module TDAnalytics
       _internal_track(:user_set, distinct_id: distinct_id, account_id: account_id, properties: properties, ip: ip)
     end
 
-    # set user properties, If such property had been set before, this message would be neglected.
+    ##
+    # Set user properties, If such property had been set before, this message would be neglected
+    #   distinct_id: (optional) distinct ID
+    #   account_id: (optional) account ID. distinct_id, account_id can't both be empty.
+    #   properties: （optional) string、number、Time、boolean
+    #   ip: (optional) ip
     def user_set_once(distinct_id: nil, account_id: nil, properties: {}, ip: nil)
       begin
         _check_id(distinct_id, account_id)
@@ -159,7 +226,11 @@ module TDAnalytics
       )
     end
 
-    # to add user properties of array type.
+    ##
+    # To append user properties of array type
+    #   distinct_id: (optional) distinct ID
+    #   account_id: (optional) account ID. distinct_id, account_id can't both be empty.
+    #   properties: （optional) string、number、Time、boolean
     def user_append(distinct_id: nil, account_id: nil, properties: {})
       begin
         _check_id(distinct_id, account_id)
@@ -176,6 +247,11 @@ module TDAnalytics
                       )
     end
 
+    ##
+    # To append user properties of array type. It filters out duplicate values
+    #   distinct_id: (optional) distinct ID
+    #   account_id: (optional) account ID. distinct_id, account_id can't both be empty.
+    #   properties: （optional) string、number、Time、boolean
     def user_uniq_append(distinct_id: nil, account_id: nil, properties: {})
       begin
         _check_id(distinct_id, account_id)
@@ -192,7 +268,11 @@ module TDAnalytics
                       )
     end
 
-    # clear the user properties of users.
+    ##
+    # Clear the user properties of users
+    #   distinct_id: (optional) distinct ID
+    #   account_id: (optional) account ID. distinct_id, account_id can't both be empty.
+    #   properties: （optional) string、number、Time、boolean
     def user_unset(distinct_id: nil, account_id: nil, property: nil)
       properties = {}
       if property.is_a?(Array)
@@ -218,7 +298,11 @@ module TDAnalytics
       )
     end
 
-    # to accumulate operations against the property.
+    ##
+    # To accumulate operations against the property
+    #   distinct_id: (optional) distinct ID
+    #   account_id: (optional) account ID. distinct_id, account_id can't both be empty.
+    #   properties: （optional) string、number、Time、boolean
     def user_add(distinct_id: nil, account_id: nil, properties: {})
       begin
         _check_id(distinct_id, account_id)
@@ -235,7 +319,10 @@ module TDAnalytics
       )
     end
 
-    # delete a user, This operation cannot be undone.
+    ##
+    # Delete a user, This operation cannot be undone
+    #   distinct_id: (optional) distinct ID
+    #   account_id: (optional) account ID. distinct_id, account_id can't both be empty.
     def user_del(distinct_id: nil, account_id: nil)
       begin
         _check_id(distinct_id, account_id)
@@ -250,8 +337,10 @@ module TDAnalytics
       )
     end
 
-    # report data immediately.
+    ##
+    # Report data immediately
     def flush
+      TDLog.info("SDK flush data.")
       return true unless defined? @consumer.flush
       ret = true
       begin
@@ -263,25 +352,35 @@ module TDAnalytics
       ret
     end
 
+    ##
     # Close and exit sdk
     def close
       return true unless defined? @consumer.close
       ret = true
+      # Consumer 自身已有锁保护，无需在此加锁
       begin
         @consumer.close
       rescue TDAnalyticsError => e
         @error_handler.handle(e)
         ret = false
       end
+
+      TDLog.info("SDK close.")
+
       ret
     end
 
     private
 
     def _internal_track(type, properties: {}, event_name: nil, event_id:nil, account_id: nil, distinct_id: nil, ip: nil,first_check_id: nil, time: nil)
+      ret = true
+
+      # 只在访问共享状态时加锁
       if type == :track || type == :track_update || type == :track_overwrite
-        dynamic_properties = @@dynamic_block.respond_to?(:call) ? @@dynamic_block.call : {}
-        properties = LIB_PROPERTIES.merge(@super_properties).merge(dynamic_properties).merge(properties)
+        @mutex.synchronize do
+          dynamic_properties = @dynamic_block.respond_to?(:call) ? @dynamic_block.call : {}
+          properties = LIB_PROPERTIES.merge(@super_properties).merge(dynamic_properties).merge(properties)
+        end
       end
 
       data = {
@@ -310,9 +409,8 @@ module TDAnalytics
       data['#distinct_id'] = distinct_id if distinct_id
       data['#ip'] = ip if ip
       data['#first_check_id'] = first_check_id if first_check_id
-      data[:'#uuid'] = SecureRandom.uuid if @uuid and data[:'#uuid'] == nil
+      data[:'#uuid'] = SecureRandom.uuid if @uuid_enable and data[:'#uuid'] == nil
 
-      ret = true
       begin
         @consumer.add(data)
       rescue TDAnalyticsError => e
@@ -328,7 +426,7 @@ module TDAnalytics
     end
 
     def _check_event_id(event_id)
-      if TDAnalytics::get_stringent == false
+      if ThinkingData::get_stringent == false
         return true
       end
 
@@ -337,7 +435,7 @@ module TDAnalytics
     end
 
     def _check_name(name)
-      if TDAnalytics::get_stringent == false
+      if ThinkingData::get_stringent == false
         return true
       end
 
@@ -350,7 +448,7 @@ module TDAnalytics
     end
 
     def _check_properties(type, properties)
-      if TDAnalytics::get_stringent == false
+      if ThinkingData::get_stringent == false
         return true
       end
 
@@ -380,7 +478,7 @@ module TDAnalytics
     end
 
     def _check_id(distinct_id, account_id)
-      if TDAnalytics::get_stringent == false
+      if ThinkingData::get_stringent == false
         return true
       end
 
@@ -398,10 +496,12 @@ module TDAnalytics
     end
   end
 
-  class TELog
+  ##
+  # SDK log module
+  class TDLog
     def self.info(*msg)
-      if TDAnalytics::get_enable_log
-        print("[ThinkingEngine][#{Time.now}][info]-")
+      if ThinkingData::get_enable_log
+        print("[ThinkingData][#{Time.now}] ")
         puts(msg)
       end
     end

data/lib/thinkingdata-ruby/{batch_consumer.rb → td_batch_consumer.rb}

@@ -1,13 +1,18 @@
 require 'json'
 require 'net/http'
+require 'stringio'
 
-module TDAnalytics
-  class BatchConsumer
+module ThinkingData
+  ##
+  # Upload data by http
+  class TDBatchConsumer
 
     # buffer count
     DEFAULT_LENGTH = 20
     MAX_LENGTH = 2000
 
+    ##
+    # Init batch consumer
     def initialize(server_url, app_id, max_buffer_length = DEFAULT_LENGTH)
       @server_uri = URI.parse(server_url)
       @server_uri.path = '/sync_server'
@@ -15,24 +20,52 @@ module TDAnalytics
       @compress = true
       @max_length = [max_buffer_length, MAX_LENGTH].min
       @buffers = []
+      @mutex = Mutex.new
+      TDLog.info("TDBatchConsumer init success. ServerUrl: #{server_url}, appId: #{app_id}")
     end
 
+    ##
+    # http request compress
+    # @param compress [Boolean] compress or not
+    # @deprecated please use: set_compress
     def _set_compress(compress)
       @compress = compress
     end
 
+    ##
+    # http request compress
+    # @param compress [Boolean] compress or not
+    def set_compress(compress)
+      @compress = compress
+    end
+
     def add(message)
-      @buffers << message
-      flush if @buffers.length >= @max_length
+      TDLog.info("Enqueue data to buffer. buffer size: #{@buffers.length}, data: #{message}")
+      need_flush = false
+      @mutex.synchronize do
+        @buffers << message
+        need_flush = @buffers.length >= @max_length
+      end
+      flush if need_flush
     end
 
     def close
       flush
+      TDLog.info("TDBatchConsumer close.")
     end
 
     def flush
+      TDLog.info("TDBatchConsumer flush data.")
+      data_to_send = nil
+      @mutex.synchronize do
+        data_to_send = @buffers.dup
+        @buffers = []
+      end
+
+      return if data_to_send.empty?
+
       begin
-        @buffers.each_slice(@max_length) do |chunk|
+        data_to_send.each_slice(@max_length) do |chunk|
           if @compress
             wio = StringIO.new("w")
             gzip_io = Zlib::GzipWriter.new(wio)
@@ -46,17 +79,19 @@ module TDAnalytics
           headers = {'Content-Type' => 'application/plaintext',
                      'appid' => @app_id,
                      'compress' => compress_type,
-                     'TA-Integration-Type'=>'Ruby',
-                     'TA-Integration-Version'=>TDAnalytics::VERSION,
-                     'TA-Integration-Count'=>@buffers.count,
+                     'TE-Integration-Type'=>'Ruby',
+                     'TE-Integration-Version'=>ThinkingData::VERSION,
+                     'TE-Integration-Count'=>data_to_send.count,
                      'TA_Integration-Extra'=>'batch'}
           request = CaseSensitivePost.new(@server_uri.request_uri, headers)
           request.body = data
 
+          TDLog.info("Send data, request: #{data}")
           begin
             response_code, response_body = _request(@server_uri, request)
+            TDLog.info("Send data, response: #{response_body}")
           rescue => e
-            raise ConnectionError.new("Could not connect to TA server, with error \"#{e.message}\".")
+            raise ConnectionError.new("Could not connect to TE server, with error \"#{e.message}\".")
           end
 
           result = {}
@@ -64,18 +99,17 @@ module TDAnalytics
             begin
               result = JSON.parse(response_body.to_s)
             rescue JSON::JSONError
-              raise ServerError.new("Could not interpret TA server response: '#{response_body}'")
+              raise ServerError.new("Could not interpret TE server response: '#{response_body}'")
             end
           end
 
           if result['code'] != 0
-            raise ServerError.new("Could not write to TA, server responded with #{response_code} returning: '#{response_body}'")
+            raise ServerError.new("Could not write to TE, server responded with #{response_code} returning: '#{response_body}'")
           end
         end
       rescue
         raise
       end
-      @buffers = []
     end
 
     private
@@ -92,6 +126,8 @@ module TDAnalytics
     end
   end
 
+  ##
+  # Private class. Send data tools
   class CaseSensitivePost < Net::HTTP::Post
     def initialize_http_header(headers)
       @header = {}

data/lib/thinkingdata-ruby/{debug_consumer.rb → td_debug_consumer.rb}

@@ -1,37 +1,43 @@
 require 'json'
 require 'net/http'
 
-module TDAnalytics
+module ThinkingData
+  ##
   # The data is reported one by one, and when an error occurs, the log will be printed on the console.
-  class DebugConsumer
-
-    def test
-
-    end
+  class TDDebugConsumer
 
+    ##
+    # Init debug consumer
+    #   @param server_url: server url
+    #   @param app_id: app id
+    #   @param write_data: is write data to TE
+    #   @param device_id: device id
     def initialize(server_url, app_id, write_data = true, device_id: nil)
       @server_uri = URI.parse(server_url)
       @server_uri.path = '/data_debug'
       @app_id = app_id
       @write_data = write_data
       @device_id = device_id
+      TDLog.info("TDDebugConsumer init success. ServerUrl: #{server_url}, appId: #{app_id}, deviceId: #{device_id}")
     end
 
     def add(message)
-      puts message.to_json
+      msg_json_str = message.to_json
+      TDLog.info("Send data, request: #{msg_json_str}")
       headers =  {
-          'TA-Integration-Type'=>'Ruby',
-          'TA-Integration-Version'=>TDAnalytics::VERSION,
-          'TA-Integration-Count'=>'1',
+          'TE-Integration-Type'=>'Ruby',
+          'TE-Integration-Version'=>ThinkingData::VERSION,
+          'TE-Integration-Count'=>'1',
           'TA_Integration-Extra'=>'debug'
       }
-      form_data = {"data" => message.to_json, "appid" => @app_id, "dryRun" => @write_data ? "0" : "1", "source" => "server"}
+      form_data = {"data" => msg_json_str, "appid" => @app_id, "dryRun" => @write_data ? "0" : "1", "source" => "server"}
       @device_id.is_a?(String) ? form_data["deviceId"] = @device_id : nil
 
       begin
         response_code, response_body = request(@server_uri, form_data,headers)
+        TDLog.info("Send data, response: #{response_body}")
       rescue => e
-        raise ConnectionError.new("Could not connect to TA server, with error \"#{e.message}\".")
+        raise ConnectionError.new("Could not connect to TE server, with error \"#{e.message}\".")
       end
 
       result = {}
@@ -39,17 +45,17 @@ module TDAnalytics
         begin
           result = JSON.parse(response_body.to_s)
         rescue JSON::JSONError
-          raise ServerError.new("Could not interpret TA server response: '#{response_body}'")
+          raise ServerError.new("Could not interpret TE server response: '#{response_body}'")
         end
       end
 
       if result['errorLevel'] != 0
-        raise ServerError.new("Could not write to TA, server responded with #{response_code} returning: '#{response_body}'")
+        raise ServerError.new("Could not write to TE, server responded with #{response_code} returning: '#{response_body}'")
       end
     end
 
     def request(uri, form_data,headers)
-      request = Net::HTTP::Post.new(uri.request_uri,headers)
+      request = Net::HTTP::Post.new(uri.request_uri, headers)
       request.set_form_data(form_data)
 
       client = Net::HTTP.new(uri.host, uri.port)

data/lib/thinkingdata-ruby/{errors.rb → td_errors.rb}

@@ -1,17 +1,25 @@
-module TDAnalytics
-
+module ThinkingData
+  ##
+  # SDK error
   TDAnalyticsError = Class.new(StandardError)
 
+  ##
+  # SDK error: illegal parameter
   IllegalParameterError = Class.new(TDAnalyticsError)
-  
+
+  ##
+  # SDK error: connection error
   ConnectionError = Class.new(TDAnalyticsError)
-  
-  ServerError = Class.new(TDAnalyticsError)
 
+  ##
+  # SDK error: server error
+  ServerError = Class.new(TDAnalyticsError)
 
-  # use example:
+  ##
+  # Error handler
   #
-  #    class MyErrorHandler < TDAnalytics::ErrorHandler
+  # e.g.
+  #    class MyErrorHandler < ThinkingData::ErrorHandler
   #      def handle(error)
   #          puts error
   #          raise error
@@ -19,9 +27,9 @@ module TDAnalytics
   #    end
   #
   #    my_error_handler = MyErrorHandler.new
-  #    tracker = TDAnalytics::Tracker.new(consumer, my_error_handler)
-  class ErrorHandler
-
+  #    tracker = ThinkingData::TDAnalytics.new(consumer, my_error_handler)
+  class TDErrorHandler
+    ##
     # Override #handle to customize error handling
     def handle(error)
       false

data/lib/thinkingdata-ruby/{logger_consumer.rb → td_logger_consumer.rb}

@@ -1,12 +1,13 @@
 require 'logger'
-require 'thinkingdata-ruby/errors'
+require 'thinkingdata-ruby/td_errors'
 
-module TDAnalytics
+module ThinkingData
 
-  # dismantle the header and save it under another name
+  ##
+  # Dismantle the header and save it under another name
   class HeadlessLogger < Logger
     def initialize(logdev, shift_age = 0, shift_size = 1048576)
-      super(nil )
+      super(nil)
       if logdev
         @logdev = HeadlessLogger::LogDevice.new(logdev, shift_age: shift_age, shift_size: shift_size)
       end
@@ -17,9 +18,15 @@ module TDAnalytics
     end
   end
 
-  # write data to file, it works with LogBus
-  class LoggerConsumer
+  ##
+  # Write data to file, it works with LogBus
+  class TDLoggerConsumer
 
+    ##
+    # Init logger consumer
+    #   @param log_path: log file's path
+    #   @param mode: file rotate mode
+    #   @param prefix: file prefix
     def initialize(log_path='.', mode='daily', prefix:'te.log')
       case mode
       when 'hourly'
@@ -35,20 +42,34 @@ module TDAnalytics
       @current_suffix = Time.now.strftime(@suffix_mode)
       @log_path = log_path
       @full_prefix = "#{log_path}/#{prefix}"
+      @mutex = Mutex.new
+      TDLog.info("TDLoggerConsumer init success. LogPath: #{log_path}")
       _reset
     end
 
     def add(msg)
-      unless Time.now.strftime(@suffix_mode) == @current_suffix
-        @logger.close
-        @current_suffix = Time.now.strftime(@suffix_mode)
-        _reset
+      @mutex.synchronize do
+        unless Time.now.strftime(@suffix_mode) == @current_suffix
+          @logger.close
+          @current_suffix = Time.now.strftime(@suffix_mode)
+          _reset
+        end
+        msg_json_str = msg.to_json
+        TDLog.info("Write data to file: #{msg_json_str}")
+        @logger.info(msg_json_str)
       end
-      @logger.info(msg.to_json)
     end
   
+    def flush
+      # Logger writes immediately on each call, no explicit flush needed
+      TDLog.info("TDLoggerConsumer flush.")
+    end
+
     def close
-      @logger.close
+      @mutex.synchronize do
+        @logger.close
+      end
+      TDLog.info("TDLoggerConsumer close.")
     end
 
     private

data/lib/thinkingdata-ruby/td_version.rb

@@ -0,0 +1,3 @@
+module ThinkingData
+  VERSION = '2.0.1'
+end

data/lib/thinkingdata-ruby.rb

@@ -1,5 +1,5 @@
-require 'thinkingdata-ruby/logger_consumer'
-require 'thinkingdata-ruby/debug_consumer'
-require 'thinkingdata-ruby/batch_consumer'
-require 'thinkingdata-ruby/tracker'
-require 'thinkingdata-ruby/errors'
+require 'thinkingdata-ruby/td_logger_consumer'
+require 'thinkingdata-ruby/td_debug_consumer'
+require 'thinkingdata-ruby/td_batch_consumer'
+require 'thinkingdata-ruby/td_analytics'
+require 'thinkingdata-ruby/td_errors'

data/thinkingdata-ruby.gemspec

@@ -1,8 +1,8 @@
-require File.join(File.dirname(__FILE__), 'lib/thinkingdata-ruby/version.rb')
+require File.join(File.dirname(__FILE__), 'lib/thinkingdata-ruby/td_version.rb')
 
 spec = Gem::Specification.new do |spec|
   spec.name = 'thinkingdata-ruby'
-  spec.version = TDAnalytics::VERSION
+  spec.version = ThinkingData::VERSION
   spec.files = Dir.glob(`git ls-files`.split("\n"))
   spec.require_paths = ['lib']
   spec.summary = 'Official ThinkingData Analytics API for ruby'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thinkingdata-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.1
 platform: ruby
 authors:
 - ThinkingData
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-21 00:00:00.000000000 Z
+date: 2026-05-14 00:00:00.000000000 Z
 dependencies: []
 description: The official ThinkingData Analytics API for ruby
 email: sdk@thinkingdata.cn
@@ -23,12 +23,12 @@ files:
 - README.md
 - demo/demo.rb
 - lib/thinkingdata-ruby.rb
-- lib/thinkingdata-ruby/batch_consumer.rb
-- lib/thinkingdata-ruby/debug_consumer.rb
-- lib/thinkingdata-ruby/errors.rb
-- lib/thinkingdata-ruby/logger_consumer.rb
-- lib/thinkingdata-ruby/tracker.rb
-- lib/thinkingdata-ruby/version.rb
+- lib/thinkingdata-ruby/td_analytics.rb
+- lib/thinkingdata-ruby/td_batch_consumer.rb
+- lib/thinkingdata-ruby/td_debug_consumer.rb
+- lib/thinkingdata-ruby/td_errors.rb
+- lib/thinkingdata-ruby/td_logger_consumer.rb
+- lib/thinkingdata-ruby/td_version.rb
 - thinkingdata-ruby.gemspec
 homepage: https://github.com/ThinkingDataAnalytics/ruby-sdk
 licenses:
@@ -49,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Official ThinkingData Analytics API for ruby

data/lib/thinkingdata-ruby/version.rb

@@ -1,3 +0,0 @@
-module TDAnalytics
-  VERSION = '1.2.1'
-end