thinkingdata-ruby 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: af3bee9acd623d7588b142a62e6ecef998c359c5
-  data.tar.gz: d9f7170bfc7dc600a58fcafbbfba45f92049f6d0
+SHA256:
+  metadata.gz: 3885c858dfa78a2f34e1803351c1f3b20ed9f67378d7cf3033c0e840e3f9c60a
+  data.tar.gz: c0c954d2974d3000f708dd2ff6340a0799dd8a5c0aac84832c9b7fd245550381
 SHA512:
-  metadata.gz: 6adee954d6aee35f30ed2a97074ce00500a71b4c02f3b4c1dded0ca44bcfc0e1636a0a564b49b4640114eae5d5a34c978630a8247d59bc6d0547f47deacd2ba6
-  data.tar.gz: d9052f017aae1f57252b7a15abd921f4e23d026c6010bba6d868b39f638a63f782a6a47c1f2faaa46352da11372aae62769601c65e53cde3895ec8d12cbd3be6
+  metadata.gz: 9505c957f69a7270ed77b4b8a5a84828c5976aefebcea9635b4a4563182c134b102c75a7c2a3bc0ff55131465d3b588a3a878c9587a371303f61ae2ab0f257d8
+  data.tar.gz: 2bb4637c114d94bdf36f210588226d7bb8c7306377f6500d0b3b530f92e22ef7c3776b0ee48230bb4fc1e9bfe4bccfcd2e19c4b73c7861d1bd275d3a37e02f02

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+**1.2.0** (2020/08/28)
+- 新增track_update接口，支持可更新事件
+- 新增track_overwrite接口，支持可重写事件
+
 **v1.1.0** (2020/02/11)
 - 数据类型支持array类型
 - 新增 user_append 接口，支持用户的数组类型的属性追加

data/lib/thinkingdata-ruby/batch_consumer.rb

@@ -6,9 +6,10 @@ module TDAnalytics
   # 有数据时，首先会加入本地缓冲区，当条数到达上限后会发起上报
   class BatchConsumer
     # 默认缓冲区大小
-    MAX_LENGTH = 20
+    DEFAULT_LENGTH = 20
+    MAX_LENGTH = 2000
 
-    def initialize(server_url, app_id, max_buffer_length = MAX_LENGTH)
+    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
@@ -43,7 +44,13 @@ module TDAnalytics
             data = chunk.to_json
           end
           compress_type = @compress ? 'gzip' : 'none'
-          headers = {'Content-Type' => 'application/plaintext', 'appid' => @app_id, 'compress' => compress_type}
+          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
 

data/lib/thinkingdata-ruby/debug_consumer.rb

@@ -15,9 +15,15 @@ module TDAnalytics
 
     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)
+        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
@@ -36,8 +42,8 @@ module TDAnalytics
       end
     end
 
-    def request(uri, form_data)
-      request = Net::HTTP::Post.new(uri.request_uri)
+    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)

data/lib/thinkingdata-ruby/tracker.rb

@@ -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,first_check_id:nil, skip_local_check: false)
       begin
         _check_name event_name
         _check_id(distinct_id, account_id)
@@ -85,11 +85,80 @@ module TDAnalytics
       data[:account_id] = account_id if account_id
       data[:time] = time if time
       data[:ip] = ip if ip
+      data[:first_check_id] = first_check_id if first_check_id
       data[:properties] = properties
 
       _internal_track(:track, data)
     end
 
+    #   上报事件数据可进行更新. 每个事件都包含一个事件名和事件ID以及 Hash 对象的时间属性. 其参数说明如下:
+    #   event_name: (必须) 事件名 必须是英文字母开头，可以包含字母、数字和 _, 长度不超过 50 个字符.
+    #   event_id:(必须) event_name + event_id 会作为一条事件的唯一键
+    #   distinct_id: (可选) 访客 ID
+    #   account_id: （可选) 账号ID distinct_id 和 account_id 不能同时为空
+    #   properties: （可选) Hash 事件属性。支持四种类型的值：字符串、数值、Time、boolean
+    #   time: （可选）Time 事件发生时间，如果不传默认为系统当前时间
+    #   ip: (可选) 事件 IP，如果传入 IP 地址，后端可以通过 IP 地址解析事件发生地点
+    #   skip_local_check: (可选) boolean 表示是否跳过本地检测
+    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
+        _check_event_id event_id
+        _check_id(distinct_id, account_id)
+        unless skip_local_check
+          _check_properties(:track_overwrite, properties)
+        end
+      rescue TDAnalyticsError => e
+        @error_handler.handle(e)
+        return false
+      end
+
+      data = {}
+      data[:event_name] = event_name
+      data[:event_id] = event_id
+      data[:distinct_id] = distinct_id if distinct_id
+      data[:account_id] = account_id if account_id
+      data[:time] = time if time
+      data[:ip] = ip if ip
+      data[:properties] = properties
+      _internal_track(:track_overwrite, data)
+    end
+
+
+
+    #   上报事件数据可进行覆盖. 每个事件都包含一个事件名和事件ID以及 Hash 对象的时间属性. 其参数说明如下:
+    #   event_name: (必须) 事件名 必须是英文字母开头，可以包含字母、数字和 _, 长度不超过 50 个字符.
+    #   event_id:(必须) event_name + event_id 会作为一条事件的唯一键
+    #   distinct_id: (可选) 访客 ID
+    #   account_id: （可选) 账号ID distinct_id 和 account_id 不能同时为空
+    #   properties: （可选) Hash 事件属性。支持四种类型的值：字符串、数值、Time、boolean
+    #   time: （可选）Time 事件发生时间，如果不传默认为系统当前时间
+    #   ip: (可选) 事件 IP，如果传入 IP 地址，后端可以通过 IP 地址解析事件发生地点
+    #   skip_local_check: (可选) boolean 表示是否跳过本地检测
+    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
+        _check_event_id event_id
+        _check_id(distinct_id, account_id)
+        unless skip_local_check
+          _check_properties(:track_update, properties)
+        end
+      rescue TDAnalyticsError => e
+        @error_handler.handle(e)
+        return false
+      end
+
+      data = {}
+      data[:event_name] = event_name
+      data[:event_id] = event_id
+      data[:distinct_id] = distinct_id if distinct_id
+      data[:account_id] = account_id if account_id
+      data[:time] = time if time
+      data[:ip] = ip if ip
+      data[:properties] = properties
+      _internal_track(:track_update, data)
+    end
+
     # 设置用户属性. 如果出现同名属性，则会覆盖之前的值.
     #   distinct_id: (可选) 访客 ID
     #   account_id: （可选) 账号ID distinct_id 和 account_id 不能同时为空
@@ -236,13 +305,13 @@ 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, event_id:nil, account_id: nil, distinct_id: nil, ip: nil,first_check_id: nil, time: Time.now)
       if account_id == nil && distinct_id == nil
         raise IllegalParameterError.new('account id or distinct id must be provided.')
       end
 
-      if type == :track
-        raise IllegalParameterError.new('event name is empty for track') if event_name == nil
+      if type == :track || type == :track_update || type == :track_overwrite
+        raise IllegalParameterError.new('event name is empty') if event_name == nil
         properties = {'#zone_offset': time.utc_offset / 3600.0}.merge(LIB_PROPERTIES).merge(@super_properties).merge(properties)
       end
 
@@ -259,10 +328,12 @@ module TDAnalytics
           'properties' => properties,
       }
 
-      data['#event_name'] = event_name if type == :track
+      data['#event_name'] = event_name if (type == :track || type == :track_update || :track_overwrite)
+      data['#event_id'] = event_id if (type == :track_update || type == :track_overwrite)
       data['#account_id'] = account_id if account_id
       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
 
       ret = true
@@ -281,6 +352,11 @@ module TDAnalytics
       time.strftime("%Y-%m-%d %H:%M:%S.#{((time.to_f * 1000.0).to_i % 1000).to_s.rjust(3, "0")}")
     end
 
+    def _check_event_id(event_id)
+      raise IllegalParameterError.new("the event_id or property cannot be nil") if event_id.nil?
+      true
+    end
+
     # 属性名或者事件名检查
     def _check_name(name)
       raise IllegalParameterError.new("the name of event or property cannot be nil") if name.nil?
@@ -288,10 +364,6 @@ module TDAnalytics
       unless name.instance_of?(String) || name.instance_of?(Symbol)
         raise IllegalParameterError.new("#{name} is invalid. It must be String or Symbol")
       end
-
-      unless name =~ /^[a-zA-Z][a-zA-Z0-9_]{1,49}$/
-        raise IllegalParameterError.new("#{name} is invalid. It must be string starts with letters and contains letters, numbers, and _ with max length of 50")
-      end
       true
     end
 
@@ -303,6 +375,7 @@ module TDAnalytics
 
       properties.each do |k, v|
         _check_name k
+        next if v.nil?
         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
@@ -324,14 +397,6 @@ module TDAnalytics
     # 检查用户 ID 合法性
     def _check_id(distinct_id, account_id)
       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
-      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
-      end
     end
   end
 end

data/lib/thinkingdata-ruby/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thinkingdata-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - ThinkingData
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-11 00:00:00.000000000 Z
+date: 2020-08-28 00:00:00.000000000 Z
 dependencies: []
 description: The official ThinkingData Analytics API for ruby
 email: sdk@thinkingdata.cn
@@ -48,8 +48,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Official ThinkingData Analytics API for ruby