thinkingdata-ruby 1.2.0 → 2.0.0

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

@@ -1,120 +1,142 @@
-require 'json'
-require 'net/http'
-
-module TDAnalytics
-  # BatchConsumer 批量同步的发送数据.
-  # 有数据时，首先会加入本地缓冲区，当条数到达上限后会发起上报
-  class BatchConsumer
-    # 默认缓冲区大小
-    DEFAULT_LENGTH = 20
-    MAX_LENGTH = 2000
-
-    def initialize(server_url, app_id, max_buffer_length = DEFAULT_LENGTH)
-      @server_uri = URI.parse(server_url)
-      @server_uri.path = '/sync_server'
-      @app_id = app_id
-      @compress = true
-      @max_length = [max_buffer_length, MAX_LENGTH].min
-      @buffers = []
-    end
-
-    def _set_compress(compress)
-      @compress = compress
-    end
-
-    def add(message)
-      @buffers << message
-      flush if @buffers.length >= @max_length
-    end
-
-    def close
-      flush
-    end
-
-    def flush
-      begin
-        @buffers.each_slice(@max_length) do |chunk|
-          if @compress
-            wio = StringIO.new("w")
-            gzip_io = Zlib::GzipWriter.new(wio)
-            gzip_io.write(chunk.to_json)
-            gzip_io.close
-            data = wio.string
-          else
-            data = chunk.to_json
-          end
-          compress_type = @compress ? 'gzip' : 'none'
-          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,
-                     'TA_Integration-Extra'=>'batch'}
-          request = CaseSensitivePost.new(@server_uri.request_uri, headers)
-          request.body = data
-
-          begin
-            response_code, response_body = _request(@server_uri, request)
-          rescue => e
-            raise ConnectionError.new("Could not connect to TA server, with error \"#{e.message}\".")
-          end
-
-          result = {}
-          if response_code.to_i == 200
-            begin
-              result = JSON.parse(response_body.to_s)
-            rescue JSON::JSONError
-              raise ServerError.new("Could not interpret TA 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}'")
-          end
-        end
-      rescue
-        raise
-      end
-      @buffers = []
-    end
-
-    private
-    def _request(uri, request)
-      client = Net::HTTP.new(uri.host, uri.port)
-      client.use_ssl = uri.scheme === 'https' ? true : false
-      client.open_timeout = 10
-      client.continue_timeout = 10
-      client.read_timeout = 10
-      client.ssl_timeout = 10
-
-      response = client.request(request)
-      [response.code, response.body]
-    end
-  end
-
-  # 内部使用，为了兼容老版本服务端，将 Header 名称限定为小写
-  class CaseSensitivePost < Net::HTTP::Post
-    def initialize_http_header(headers)
-      @header = {}
-      headers.each{|k,v| @header[k.to_s] = [v] }
-    end
-
-    def [](name)
-      @header[name.to_s]
-    end
-
-    def []=(name, val)
-      if val
-        @header[name.to_s] = [val]
-      else
-        @header.delete(name.to_s)
-      end
-    end
-
-    def capitalize(name)
-      name
-    end
-  end
-
-end
+require 'json'
+require 'net/http'
+require 'stringio'
+
+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'
+      @app_id = app_id
+      @compress = true
+      @max_length = [max_buffer_length, MAX_LENGTH].min
+      @buffers = []
+      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)
+      TDLog.info("Enqueue data to buffer. buffer size: #{@buffers.length}, data: #{message}")
+      @buffers << message
+      flush if @buffers.length >= @max_length
+    end
+
+    def close
+      flush
+      TDLog.info("TDBatchConsumer close.")
+    end
+
+    def flush
+      TDLog.info("TDBatchConsumer flush data.")
+      begin
+        @buffers.each_slice(@max_length) do |chunk|
+          if @compress
+            wio = StringIO.new("w")
+            gzip_io = Zlib::GzipWriter.new(wio)
+            gzip_io.write(chunk.to_json)
+            gzip_io.close
+            data = wio.string
+          else
+            data = chunk.to_json
+          end
+          compress_type = @compress ? 'gzip' : 'none'
+          headers = {'Content-Type' => 'application/plaintext',
+                     'appid' => @app_id,
+                     'compress' => compress_type,
+                     'TE-Integration-Type'=>'Ruby',
+                     'TE-Integration-Version'=>ThinkingData::VERSION,
+                     'TE-Integration-Count'=>@buffers.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 TE server, with error \"#{e.message}\".")
+          end
+
+          result = {}
+          if response_code.to_i == 200
+            begin
+              result = JSON.parse(response_body.to_s)
+            rescue JSON::JSONError
+              raise ServerError.new("Could not interpret TE server response: '#{response_body}'")
+            end
+          end
+
+          if result['code'] != 0
+            raise ServerError.new("Could not write to TE, server responded with #{response_code} returning: '#{response_body}'")
+          end
+        end
+      rescue
+        raise
+      end
+      @buffers = []
+    end
+
+    private
+    def _request(uri, request)
+      client = Net::HTTP.new(uri.host, uri.port)
+      client.use_ssl = uri.scheme === 'https' ? true : false
+      client.open_timeout = 10
+      client.continue_timeout = 10
+      client.read_timeout = 10
+      client.ssl_timeout = 10
+
+      response = client.request(request)
+      [response.code, response.body]
+    end
+  end
+
+  ##
+  # Private class. Send data tools
+  class CaseSensitivePost < Net::HTTP::Post
+    def initialize_http_header(headers)
+      @header = {}
+      headers.each{|k,v| @header[k.to_s] = [v] }
+    end
+
+    def [](name)
+      @header[name.to_s]
+    end
+
+    def []=(name, val)
+      if val
+        @header[name.to_s] = [val]
+      else
+        @header.delete(name.to_s)
+      end
+    end
+
+    def capitalize(name)
+      name
+    end
+  end
+
+end

data/lib/thinkingdata-ruby/td_debug_consumer.rb

@@ -0,0 +1,73 @@
+require 'json'
+require 'net/http'
+
+module ThinkingData
+  ##
+  # The data is reported one by one, and when an error occurs, the log will be printed on the console.
+  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)
+      msg_json_str = message.to_json
+      TDLog.info("Send data, request: #{msg_json_str}")
+      headers =  {
+          'TE-Integration-Type'=>'Ruby',
+          'TE-Integration-Version'=>ThinkingData::VERSION,
+          'TE-Integration-Count'=>'1',
+          'TA_Integration-Extra'=>'debug'
+      }
+      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 TE server, with error \"#{e.message}\".")
+      end
+
+      result = {}
+      if response_code.to_i == 200
+        begin
+          result = JSON.parse(response_body.to_s)
+        rescue JSON::JSONError
+          raise ServerError.new("Could not interpret TE server response: '#{response_body}'")
+        end
+      end
+
+      if result['errorLevel'] != 0
+        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.set_form_data(form_data)
+
+      client = Net::HTTP.new(uri.host, uri.port)
+      client.use_ssl = uri.scheme === 'https' ? true : false
+      client.open_timeout = 10
+      client.continue_timeout = 10
+      client.read_timeout = 10
+      client.ssl_timeout = 10
+
+      response = client.request(request)
+      [response.code, response.body]
+    end
+  end
+
+end

data/lib/thinkingdata-ruby/td_errors.rb

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

data/lib/thinkingdata-ruby/td_logger_consumer.rb

@@ -0,0 +1,77 @@
+require 'logger'
+require 'thinkingdata-ruby/td_errors'
+
+module ThinkingData
+
+  ##
+  # Dismantle the header and save it under another name
+  class HeadlessLogger < Logger
+    def initialize(logdev, shift_age = 0, shift_size = 1048576)
+      super(nil)
+      if logdev
+        @logdev = HeadlessLogger::LogDevice.new(logdev, shift_age: shift_age, shift_size: shift_size)
+      end
+    end
+
+    class LogDevice < ::Logger::LogDevice
+      def add_log_header(file); end
+    end
+  end
+
+  ##
+  # 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'
+        @suffix_mode = '%Y-%m-%d-%H'
+      when 'daily'
+        @suffix_mode = '%Y-%m-%d'
+      else
+        raise IllegalParameterError.new("#{mode} is unsupported for LoggerConsumer. Replaced it by daily or hourly")
+      end
+
+      raise IllegalParameterError.new("prefix couldn't be empty") if prefix.nil? || prefix.length == 0
+
+      @current_suffix = Time.now.strftime(@suffix_mode)
+      @log_path = log_path
+      @full_prefix = "#{log_path}/#{prefix}"
+      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
+      end
+      msg_json_str = msg.to_json
+      TDLog.info("Write data to file: #{msg_json_str}")
+      @logger.info(msg_json_str)
+    end
+  
+    def close
+      @logger.close
+      TDLog.info("TDLoggerConsumer close.")
+    end
+
+    private
+
+    def _reset
+      Dir::mkdir(@log_path) unless Dir::exist?(@log_path)
+      @logger = HeadlessLogger.new("#{@full_prefix}.#{@current_suffix}")
+      @logger.level = HeadlessLogger::INFO
+      @logger.formatter = proc do |severity, datetime, progname, msg|
+        "#{msg}\n"
+      end
+    end
+
+  end
+end

data/lib/thinkingdata-ruby/td_version.rb

@@ -0,0 +1,3 @@
+module ThinkingData
+  VERSION = '2.0.0'
+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,16 +1,16 @@
-require File.join(File.dirname(__FILE__), 'lib/thinkingdata-ruby/version.rb')
-
-spec = Gem::Specification.new do |spec|
-  spec.name = 'thinkingdata-ruby'
-  spec.version = TDAnalytics::VERSION
-  spec.files = Dir.glob(`git ls-files`.split("\n"))
-  spec.require_paths = ['lib']
-  spec.summary = 'Official ThinkingData Analytics API for ruby'
-  spec.description = 'The official ThinkingData Analytics API for ruby'
-  spec.authors = [ 'ThinkingData' ]
-  spec.email = 'sdk@thinkingdata.cn'
-  spec.homepage = 'https://github.com/ThinkingDataAnalytics/ruby-sdk'
-  spec.license = 'Apache-2.0'
-
-  spec.required_ruby_version = '>= 2.0.0'
-end
+require File.join(File.dirname(__FILE__), 'lib/thinkingdata-ruby/td_version.rb')
+
+spec = Gem::Specification.new do |spec|
+  spec.name = 'thinkingdata-ruby'
+  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'
+  spec.description = 'The official ThinkingData Analytics API for ruby'
+  spec.authors = [ 'ThinkingData' ]
+  spec.email = 'sdk@thinkingdata.cn'
+  spec.homepage = 'https://github.com/ThinkingDataAnalytics/ruby-sdk'
+  spec.license = 'Apache-2.0'
+
+  spec.required_ruby_version = '>= 2.0.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thinkingdata-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - ThinkingData
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-28 00:00:00.000000000 Z
+date: 2023-10-26 00:00:00.000000000 Z
 dependencies: []
 description: The official ThinkingData Analytics API for ruby
 email: sdk@thinkingdata.cn
@@ -16,24 +16,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - 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:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -48,8 +49,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: Official ThinkingData Analytics API for ruby
 test_files: []

data/lib/thinkingdata-ruby/debug_consumer.rb

@@ -1,61 +0,0 @@
-require 'json'
-require 'net/http'
-
-module TDAnalytics
-  # DebugConsumer 逐条、同步地向服务端上报数据
-  # DebugConsumer 会返回详细的报错信息，建议在集成阶段先使用 DebugConsumer 调试接口
-  class DebugConsumer
-
-    def initialize(server_url, app_id, write_data = true)
-      @server_uri = URI.parse(server_url)
-      @server_uri.path = '/data_debug'
-      @app_id = app_id
-      @write_data = write_data
-    end
-
-    def add(message)
-      puts message.to_json
-      headers =  {
-          'TA-Integration-Type'=>'Ruby',
-          'TA-Integration-Version'=>TDAnalytics::VERSION,
-          'TA-Integration-Count'=>'1',
-          'TA_Integration-Extra'=>'debug'
-      }
-      form_data = {"data" => message.to_json, "appid" => @app_id, "dryRun" => @write_data ? "0" : "1", "source" => "server"}
-      begin
-        response_code, response_body = request(@server_uri, form_data,headers)
-      rescue => e
-        raise ConnectionError.new("Could not connect to TA server, with error \"#{e.message}\".")
-      end
-
-      result = {}
-      if response_code.to_i == 200
-        begin
-          result = JSON.parse(response_body.to_s)
-        rescue JSON::JSONError
-          raise ServerError.new("Could not interpret TA 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}'")
-      end
-    end
-
-    def request(uri, form_data,headers)
-      request = Net::HTTP::Post.new(uri.request_uri,headers)
-      request.set_form_data(form_data)
-
-      client = Net::HTTP.new(uri.host, uri.port)
-      client.use_ssl = uri.scheme === 'https' ? true : false
-      client.open_timeout = 10
-      client.continue_timeout = 10
-      client.read_timeout = 10
-      client.ssl_timeout = 10
-
-      response = client.request(request)
-      [response.code, response.body]
-    end
-  end
-
-end

data/lib/thinkingdata-ruby/errors.rb

@@ -1,35 +0,0 @@
-module TDAnalytics
-
-  # TD Analytics SDK 的错误
-  TDAnalyticsError = Class.new(StandardError)
-
-  # 参数不合法
-  IllegalParameterError = Class.new(TDAnalyticsError)
-  
-  # 网络连接错误
-  ConnectionError = Class.new(TDAnalyticsError)
-  
-  # 服务器返回错误
-  ServerError = Class.new(TDAnalyticsError)
-
-
-  # 默认情况下，所有异常都不会被抛出。如果希望自己处理异常，可以实现继承自 ErrorHandler 的
-  # 错误处理类，并在初始化 SDK 的时候作为参数传入.
-  # 例如: 
-  #    class MyErrorHandler < TDAnalytics::ErrorHandler
-  #      def handle(error)
-  #          puts error
-  #          raise error
-  #      end
-  #    end
-  #
-  #    my_error_handler = MyErrorHandler.new
-  #    tracker = TDAnalytics::Tracker.new(consumer, my_error_handler)
-  class ErrorHandler
-
-    # Override #handle to customize error handling
-    def handle(error)
-      false
-    end
-  end
-end