thinkingdata-ruby 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8675f2f2b9e9e65ef523eb61d868ab087a048105
-  data.tar.gz: a469f38692b16bcff8d1564b954a8691b3161cbf
+  metadata.gz: af3bee9acd623d7588b142a62e6ecef998c359c5
+  data.tar.gz: d9f7170bfc7dc600a58fcafbbfba45f92049f6d0
 SHA512:
-  metadata.gz: 48b4d1a412fe55788a7be4a5bbb357ff6613669126ce03799b4a999bb647135266b363aef32ed002163bbb551b82b675199b10e3f6ceeceb8b0abdc61276f6c4
-  data.tar.gz: 407c50cf1a0e731ca71b3c786d645cf389c16fa5bc82a13e9e708c5b718eab3edbf1a949aa229300580d4ec5e7acf0f80436660cfbd955d35a5b89e8726e784c
+  metadata.gz: 6adee954d6aee35f30ed2a97074ce00500a71b4c02f3b4c1dded0ca44bcfc0e1636a0a564b49b4640114eae5d5a34c978630a8247d59bc6d0547f47deacd2ba6
+  data.tar.gz: d9052f017aae1f57252b7a15abd921f4e23d026c6010bba6d868b39f638a63f782a6a47c1f2faaa46352da11372aae62769601c65e53cde3895ec8d12cbd3be6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+**v1.1.0** (2020/02/11)
+- 数据类型支持array类型
+- 新增 user_append 接口，支持用户的数组类型的属性追加
+- BatchConsumer 性能优化：支持选择是否压缩；移除 Base64 编码
+- DebugConsumer 优化: 在服务端对数据进行更完备准确地校验
+
 **v1.0.0** (2019-11-20)
 - 支持三种模式的上报: DebugConsumer, BatchConsumer, LoggerConsumer.
 - 支持事件上报和用户属性上报.

data/demo/demo.rb

@@ -6,10 +6,9 @@ require 'time'
 
 if __FILE__ == $0
   # 替换 DEMO_APPID 为您项目的 APP ID
-  DEMO_APPID = 'b2a61feb9e56472c90c5bcb320dfb4ef'
+  DEMO_APPID = 'APPID'
   # 替换 SERVER_URL 为您项目的 URL
   SERVER_URL = 'https://sdk.tga.thinkinggame.cn'
-
   # 账号 ID
   DEMO_ACCOUNT_ID = 'ruby_demo_aid'
   # 访客 ID
@@ -18,24 +17,29 @@ if __FILE__ == $0
   # (可选) 定义一个错误处理器，当出现 Error 时会调用
   class MyErrorHandler < TDAnalytics::ErrorHandler
     def handle(error)
-        puts error
-        raise error
+      puts error
+      raise error
     end
   end
   my_error_handler = MyErrorHandler.new
 
   # 定义 consumer: consumer 实现了 add、flush、close 等接口，将经过 SDK 格式化的数据以不同的方式存储或者发送到接收端
   consumer = nil
-  case ARGV[0]
-  when '0'
+  $ARGV = 1
+  case $ARGV
+  when 0
     # LoggerConsumer，数据将写入本地文件(当前目录，按小时切分，前缀为 demolog)，需要配合 Logbus 上传数据到 TA 服务器
     consumer = TDAnalytics::LoggerConsumer.new '.', 'hourly', prefix: 'demolog'
-  when '1'
+  when 1
     # DebugConsumer，数据将被逐条同步的上报到 TA 服务器。出错时会返回详细的错误信息
     consumer = TDAnalytics::DebugConsumer.new(SERVER_URL, DEMO_APPID)
-  when '2'
+    # 如果不想上传到TA，只想校验数据格式，可以如下初始化
+    # consumer = TDAnalytics::DebugConsumer.new(SERVER_URL, DEMO_APPID,false)
+  when 2
     # BatchConsumer，数据将先存入缓冲区，达到指定条数时上报，默认为 20 条
-    consumer = TDAnalytics::BatchConsumer.new(SERVER_URL, DEMO_APPID, 3)
+    consumer = TDAnalytics::BatchConsumer.new(SERVER_URL, DEMO_APPID, 30)
+    #设置是否压缩数据，默认gzip压缩，内网可以这样设置
+    #consumer._set_compress(false)
   else
     # LoggerConsumer，数据将写入本地文件(当前目录，按天切分，前缀为 tda.log)，需要配合 Logbus 上传数据到 TA 服务器
     consumer = TDAnalytics::LoggerConsumer.new
@@ -46,10 +50,10 @@ if __FILE__ == $0
 
   # 定义公共属性
   super_properties = {
-    super_string: 'super_string',
-    super_int: 1,
-    super_bool: false,
-    super_date: Time.rfc2822("Thu, 26 Oct 2019 02:26:12 +0545") 
+      super_string: 'super_string',
+      super_int: 1,
+      super_bool: false,
+      super_date: Time.rfc2822("Thu, 26 Oct 2019 02:26:12 +0545")
   }
 
   # 设置公共事件属性，公共事件属性会添加到每个事件中
@@ -57,23 +61,24 @@ if __FILE__ == $0
 
   # 定义事件数据
   event = {
-	  # 事件名称 （必填)
-	  event_name: 'test_event',
-	  # 账号 ID （可选)
-	  account_id: DEMO_ACCOUNT_ID,
-	  # 访客 ID （可选)，账号 ID 和访客 ID 不可以都为空
-	  distinct_id: DEMO_DISTINCT_ID,
-	  # 事件时间 (可选) 如果不填，将以调用接口时的时间作为事件时间
-	  time: Time.now,
-	  # 事件 IP (可选) 当传入 IP 地址时，后台可以解析所在地
-	  ip: '202.38.64.1',
-	  # 事件属性 (可选)
-	  properties: {
-		  prop_date: Time.now,
-		  prop_double: 134.1,
-		  prop_string: 'hello world',
-      prop_bool: true,
-    },
+      # 事件名称 （必填)
+      event_name: 'test_event',
+      # 账号 ID （可选)
+      account_id: DEMO_ACCOUNT_ID,
+      # 访客 ID （可选)，账号 ID 和访客 ID 不可以都为空
+      distinct_id: DEMO_DISTINCT_ID,
+      # 事件时间 (可选) 如果不填，将以调用接口时的时间作为事件时间
+      time: Time.now,
+      # 事件 IP (可选) 当传入 IP 地址时，后台可以解析所在地
+      ip: '202.38.64.1',
+      # 事件属性 (可选)
+      properties: {
+          array: ["str1", "11", "22.22", "2020-02-11 17:02:52.415"],
+          prop_date: Time.now,
+          prop_double: 134.1,
+          prop_string: 'hello world',
+          prop_bool: true,
+      },
   }
 
   # 上报事件
@@ -84,31 +89,48 @@ if __FILE__ == $0
 
   # 定义用户属性数据
   user_data = {
-    # 账号 ID （可选)
-    account_id: DEMO_ACCOUNT_ID,
-    # 访客 ID （可选)，账号 ID 和访客 ID 不可以都为空
-    distinct_id: DEMO_DISTINCT_ID,
-    # 用户属性
-    properties: {
-      prop_date: Time.now,
-      prop_double: 134.12,
-      prop_string: 'hello',
-      prop_int: 666,
-    },
+      # 账号 ID （可选)
+      account_id: DEMO_ACCOUNT_ID,
+      # 访客 ID （可选)，账号 ID 和访客 ID 不可以都为空
+      distinct_id: DEMO_DISTINCT_ID,
+      # 用户属性
+      properties: {
+          array: ["str1", 11, 22.22],
+          prop_date: Time.now,
+          prop_double: 134.12,
+          prop_string: 'hello',
+          prop_int: 666,
+      },
   }
   # 设置用户属性, 覆盖同名属性
   ta.user_set(user_data)
 
+  #追加user的一个或者多个列表的属性
+  user_data_arr = {
+      # 账号 ID （可选)
+      account_id: DEMO_ACCOUNT_ID,
+      # 访客 ID （可选)，账号 ID 和访客 ID 不可以都为空
+      distinct_id: DEMO_DISTINCT_ID,
+      # 用户属性
+      properties: {
+          array: ["33", "44"],
+      },
+  }
+
+  ta.user_append(user_data_arr)
+
   # 设置用户属性，不会覆盖已经设置的同名属性
   user_data[:properties][:prop_int_new] = 800
   ta.user_set_once(user_data)
 
-  # 删除某个用户属性
-  # ta.user_unset(distinct_id: DEMO_DISTINCT_ID, property: :prop_string)
-
   # 累加用户属性
   ta.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])
+
+
   # 删除用户。此操作之前的事件数据不会被删除
   # ta.user_del(distinct_id: DEMO_DISTINCT_ID)
 

data/lib/thinkingdata-ruby/batch_consumer.rb

@@ -1,4 +1,3 @@
-require 'base64'
 require 'json'
 require 'net/http'
 
@@ -9,14 +8,19 @@ module TDAnalytics
     # 默认缓冲区大小
     MAX_LENGTH = 20
 
-    def initialize(server_url, app_id, max_buffer_length=MAX_LENGTH)
+    def initialize(server_url, app_id, max_buffer_length = MAX_LENGTH)
       @server_uri = URI.parse(server_url)
-      @server_uri.path = '/logagent'
+      @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
@@ -29,13 +33,17 @@ module TDAnalytics
     def flush
       begin
         @buffers.each_slice(@max_length) do |chunk|
-          wio = StringIO.new("w")
-          gzip_io = Zlib::GzipWriter.new(wio)
-          gzip_io.write(chunk.to_json)
-          gzip_io.close
-          data = Base64.encode64(wio.string).gsub("\n", '')
-
-          headers = {'Content-Type' => 'application/plaintext', 'appid' => @app_id}
+          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}
           request = CaseSensitivePost.new(@server_uri.request_uri, headers)
           request.body = data
 
@@ -44,7 +52,7 @@ module TDAnalytics
           rescue => e
             raise ConnectionError.new("Could not connect to TA server, with error \"#{e.message}\".")
           end
-    
+
           result = {}
           if response_code.to_i == 200
             begin
@@ -53,7 +61,7 @@ module TDAnalytics
               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
@@ -84,11 +92,11 @@ module TDAnalytics
       @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]
@@ -96,7 +104,7 @@ module TDAnalytics
         @header.delete(name.to_s)
       end
     end
-  
+
     def capitalize(name)
       name
     end

data/lib/thinkingdata-ruby/debug_consumer.rb

@@ -6,15 +6,16 @@ module TDAnalytics
   # DebugConsumer 会返回详细的报错信息，建议在集成阶段先使用 DebugConsumer 调试接口
   class DebugConsumer
 
-    def initialize(server_url, app_id)
+    def initialize(server_url, app_id, write_data = true)
       @server_uri = URI.parse(server_url)
-      @server_uri.path = '/sync_data'
+      @server_uri.path = '/data_debug'
       @app_id = app_id
+      @write_data = write_data
     end
 
     def add(message)
       puts message.to_json
-      form_data = {"data" => message.to_json, "appid" => @app_id, "debug" => 1}
+      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)
       rescue => e
@@ -30,9 +31,7 @@ module TDAnalytics
         end
       end
 
-      puts result
-
-      if result['code'] != 0
+      if result['errorLevel'] != 0
         raise ServerError.new("Could not write to TA, server responded with #{response_code} returning: '#{response_body}'")
       end
     end

data/lib/thinkingdata-ruby/tracker.rb

@@ -31,7 +31,7 @@ module TDAnalytics
     # ErrorHandler 的定义可以参考 thinkingdata-ruby/errors.rb
     #
     # uuid 如果为 true，每条数据都会被带上随机 UUID 作为 #uuid 属性的值上报，该值不会入库，仅仅用于后台做数据重复检测
-    def initialize(consumer, error_handler=nil, uuid: false)
+    def initialize(consumer, error_handler = nil, uuid: false)
       @error_handler = error_handler || ErrorHandler.new
       @consumer = consumer
       @super_properties = {}
@@ -67,7 +67,7 @@ module TDAnalytics
     #   time: （可选）Time 事件发生时间，如果不传默认为系统当前时间
     #   ip: (可选) 事件 IP，如果传入 IP 地址，后端可以通过 IP 地址解析事件发生地点
     #   skip_local_check: (可选) boolean 表示是否跳过本地检测
-    def track(event_name:nil, distinct_id:nil, account_id:nil, properties:{}, time:nil, ip:nil, skip_local_check: false)
+    def track(event_name: nil, distinct_id: nil, account_id: nil, properties: {}, time: nil, ip: nil, skip_local_check: false)
       begin
         _check_name event_name
         _check_id(distinct_id, account_id)
@@ -94,7 +94,7 @@ module TDAnalytics
     #   distinct_id: (可选) 访客 ID
     #   account_id: （可选) 账号ID distinct_id 和 account_id 不能同时为空
     #   properties: （可选) Hash 用户属性。支持四种类型的值：字符串、数值、Time、boolean
-    def user_set(distinct_id:nil, account_id:nil, properties:{}, ip:nil)
+    def user_set(distinct_id: nil, account_id: nil, properties: {}, ip: nil)
       begin
         _check_id(distinct_id, account_id)
         _check_properties(:user_set, properties)
@@ -104,15 +104,15 @@ module TDAnalytics
       end
 
       _internal_track(:user_set,
-        distinct_id: distinct_id,
-        account_id: account_id,
-        properties: properties,
-        ip: ip,
+                      distinct_id: distinct_id,
+                      account_id: account_id,
+                      properties: properties,
+                      ip: ip,
       )
     end
 
     # 设置用户属性. 如果有重名属性，则丢弃, 参数与 user_set 相同
-    def user_set_once(distinct_id:nil, account_id:nil, properties:{}, ip:nil)
+    def user_set_once(distinct_id: nil, account_id: nil, properties: {}, ip: nil)
       begin
         _check_id(distinct_id, account_id)
         _check_properties(:user_setOnce, properties)
@@ -122,15 +122,32 @@ module TDAnalytics
       end
 
       _internal_track(:user_setOnce,
-        distinct_id: distinct_id,
-        account_id: account_id,
-        properties: properties,
-        ip: ip,
+                      distinct_id: distinct_id,
+                      account_id: account_id,
+                      properties: properties,
+                      ip: ip,
       )
     end
 
+    # 追加用户的一个或多个列表类型的属性
+    def user_append(distinct_id: nil, account_id: nil, properties: {})
+      begin
+        _check_id(distinct_id, account_id)
+        _check_properties(:user_append, properties)
+      rescue TDAnalyticsError => e
+        @error_handler.handle(e)
+        return false
+      end
+
+      _internal_track(:user_append,
+                      distinct_id: distinct_id,
+                      account_id: account_id,
+                      properties: properties,
+                      )
+    end
+
     # 删除用户属性, property 可以传入需要删除的用户属性的 key 值，或者 key 值数组
-    def user_unset(distinct_id:nil, account_id:nil, property:nil)
+    def user_unset(distinct_id: nil, account_id: nil, property: nil)
       properties = {}
       if property.is_a?(Array)
         property.each do |k|
@@ -149,9 +166,9 @@ module TDAnalytics
       end
 
       _internal_track(:user_unset,
-        distinct_id: distinct_id,
-        account_id: account_id,
-        properties: properties,
+                      distinct_id: distinct_id,
+                      account_id: account_id,
+                      properties: properties,
       )
     end
 
@@ -159,7 +176,7 @@ module TDAnalytics
     #   distinct_id: (可选) 访客 ID
     #   account_id: （可选) 账号ID distinct_id 和 account_id 不能同时为空
     #   properties: （可选) Hash 数值类型的用户属性
-    def user_add(distinct_id:nil, account_id:nil, properties:{})
+    def user_add(distinct_id: nil, account_id: nil, properties: {})
       begin
         _check_id(distinct_id, account_id)
         _check_properties(:user_add, properties)
@@ -169,14 +186,14 @@ module TDAnalytics
       end
 
       _internal_track(:user_add,
-        distinct_id: distinct_id,
-        account_id: account_id,
-        properties: properties,
+                      distinct_id: distinct_id,
+                      account_id: account_id,
+                      properties: properties,
       )
     end
 
     # 删除用户，用户之前的事件数据不会被删除
-    def user_del(distinct_id:nil, account_id:nil)
+    def user_del(distinct_id: nil, account_id: nil)
       begin
         _check_id(distinct_id, account_id)
       rescue TDAnalyticsError => e
@@ -185,8 +202,8 @@ module TDAnalytics
       end
 
       _internal_track(:user_del,
-        distinct_id: distinct_id,
-        account_id: account_id,
+                      distinct_id: distinct_id,
+                      account_id: account_id,
       )
     end
 
@@ -219,7 +236,7 @@ module TDAnalytics
     private
 
     # 出现异常的时候返回 false, 否则 true
-    def _internal_track(type, properties:{}, event_name:nil, account_id:nil, distinct_id:nil, ip:nil, time:Time.now)
+    def _internal_track(type, properties: {}, event_name: nil, account_id: nil, distinct_id: nil, ip: nil, time: Time.now)
       if account_id == nil && distinct_id == nil
         raise IllegalParameterError.new('account id or distinct id must be provided.')
       end
@@ -231,22 +248,22 @@ module TDAnalytics
 
       # 格式化 Time 类型
       properties.each do |k, v|
-       if v.is_a?(Time)
-         properties[k] = _format_time(v)
-       end
+        if v.is_a?(Time)
+          properties[k] = _format_time(v)
+        end
       end
 
       data = {
-        '#type' => type,
-        '#time' => _format_time(time),
-        'properties' => properties,
+          '#type' => type,
+          '#time' => _format_time(time),
+          'properties' => properties,
       }
 
       data['#event_name'] = event_name if type == :track
       data['#account_id'] = account_id if account_id
       data['#distinct_id'] = distinct_id if distinct_id
       data['#ip'] = ip if ip
-      data['#uuid'] =  SecureRandom.uuid if @uuid
+      data['#uuid'] = SecureRandom.uuid if @uuid
 
       ret = true
       begin
@@ -286,13 +303,20 @@ module TDAnalytics
 
       properties.each do |k, v|
         _check_name k
-        unless v.is_a?(Integer) || v.is_a?(Float) || v.is_a?(Symbol) || v.is_a?(String) || v.is_a?(Time) || !!v == v
-          raise IllegalParameterError.new("The value of properties must be type in Integer, Float, Symbol, String, and Time")
+        unless v.is_a?(Integer) || v.is_a?(Float) || v.is_a?(Symbol) || v.is_a?(String) || v.is_a?(Time) || !!v == v || v.is_a?(Array)
+          raise IllegalParameterError.new("The value of properties must be type in Integer, Float, Symbol, String, Array,and Time")
         end
 
         if type == :user_add
           raise IllegalParameterError.new("Property value for user add must be numbers") unless v.is_a?(Integer) || v.is_a?(Float)
         end
+        if v.is_a?(Array)
+          v.each_index do |i|
+            if v[i].is_a?(Time)
+              v[i] = _format_time(v[i])
+            end
+          end
+        end
       end
       true
     end
@@ -302,11 +326,11 @@ module TDAnalytics
       raise IllegalParameterError.new("account id or distinct id must be provided.") if distinct_id.nil? && account_id.nil?
 
       unless distinct_id.nil?
-        raise IllegalParameterError.new("The length of distinct id should in (0, 64]")  if distinct_id.to_s.length < 1 || distinct_id.to_s.length > 64
+        raise IllegalParameterError.new("The length of distinct id should in (0, 64]") if distinct_id.to_s.length < 1 || distinct_id.to_s.length > 64
       end
 
       unless account_id.nil?
-        raise IllegalParameterError.new("The length of account id should in (0, 64]")  if account_id.to_s.length < 1 || account_id.to_s.length > 64
+        raise IllegalParameterError.new("The length of account id should in (0, 64]") if account_id.to_s.length < 1 || account_id.to_s.length > 64
       end
     end
   end

data/lib/thinkingdata-ruby/version.rb

@@ -1,3 +1,3 @@
 module TDAnalytics
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thinkingdata-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - ThinkingData
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-20 00:00:00.000000000 Z
+date: 2020-02-11 00:00:00.000000000 Z
 dependencies: []
 description: The official ThinkingData Analytics API for ruby
 email: sdk@thinkingdata.cn