sensors_analytics_sdk 1.6.1 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 58f812db59e708e593a3d3b06ceaae88e8181245
-  data.tar.gz: 40e304ea9777aff07e886da877b987bbb2b396f5
+SHA256:
+  metadata.gz: 88129c2e214d749e7a6254f9fd817045a5855c5f5cfa4fe12ae56b5c64bdf693
+  data.tar.gz: 6fd2c123258460a9ca6190c958762e417d6c8a6165d0d136365b130095eaae0c
 SHA512:
-  metadata.gz: 00a055c0f04b8d9aa89df60354b9a643ac62d4623cfaa01469179f04ef6e4104f788e9bd17ca922577f2b77f5fcd25828c5ff55b1e3a3fcdb0c14bb8ce0d42f9
-  data.tar.gz: 4126b6b54f1e52e757c501443e0643aea975ca36f7bcee09972bba092aed9d704813e4a695c5ebad00cba5869b8e0dcf2a0024ff85cced69eecd26bd75c74940
+  metadata.gz: 98a9adb753889f1bf6cb645983b69dcaf893b64ae5ac4c70847c747dea5720aa1d64ce46eda49bca019d785c1c304fb601976ebb456381295b62f5383f30bef0
+  data.tar.gz: 28071c9b37514fe401352995361841f24a83e017bd8e5d7b33128ea08b8a8bebde16118ee42ba197e825065a23d4a8a6370465a8d67b701b23ae3a12a245f987

data/.gitignore

@@ -34,3 +34,5 @@ build/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+.DS_Store

data/README.md

@@ -1,45 +1,47 @@
-# Sensors Analytics
+![logo](https://opensource.sensorsdata.cn/wp-content/uploads/logo.png)
 
-This is the official Ruby SDK for Sensors Analytics.
+## 神策简介
 
-## Easy Installation
+[**神策数据**](https://www.sensorsdata.cn/)
+（Sensors Data），隶属于神策网络科技（北京）有限公司，是一家专业的大数据分析服务公司，大数据分析行业开拓者，为客户提供深度用户行为分析平台、以及专业的咨询服务和行业解决方案，致力于帮助客户实现数据驱动。神策数据立足大数据及用户行为分析的技术与实践前沿，业务现已覆盖以互联网、金融、零售快消、高科技、制造等为代表的十多个主要行业、并可支持企业多个职能部门。公司总部在北京，并在上海、深圳、合肥、武汉等地拥有本地化的服务团队，覆盖东区及南区市场；公司拥有专业的服务团队，为客户提供一对一的客户服务。公司在大数据领域积累的核心关键技术，包括在海量数据采集、存储、清洗、分析挖掘、可视化、智能应用、安全与隐私保护等领域。 [**More**](https://www.sensorsdata.cn/about/aboutus.html)
 
-You can get Sensors Analytics SDK using gem.
-Add below to you `Gemfile`
+## SDK 简介
 
-```
-  gem 'sensors_analytics_sdk'
-```
+SensorsAnalytics SDK 是国内第一家开源商用版用户行为采集 SDK，目前支持代码埋点、全埋点、App 点击图、可视化全埋点等。目前已累计有 1500 多家付费客户，2500+ 的 App 集成使用，作为 App 数据采集利器，致力于帮助客户挖掘更多的商业价值，为其精准运营和业务支撑提供了可靠的数据来源。其采集全面而灵活、性能良好，并一直保持稳定的迭代，经受住了时间和客户的考验。
 
-Or execute `gem install` as below.
+## 集成文档
 
-```
-  gem install sensors_analytics_sdk
-```
+请参考神策官网 [Ruby SDK 集成文档](http://www.sensorsdata.cn/manual/ruby_sdk.html)。
 
-Once the SDK is successfully installed, use the Sensors Analytics SDK likes:
+## 贡献
 
-```ruby
-  require 'sensors_analytics_sdk'
+* 1.  在您的 GitHub 账户下 fork sa-sdk-ruby 开源项目；
+* 2.  根据您的需求在本地 clone 一份 sa-sdk-ruby 源码；
+* 3.  您修改或者新增功能后，push 到您 fork 的远程分支；
+* 4.  创建 pull request，向 sa-sdk-ruby 官方开发分支提交合入请求；
+* 5.  神策 SDK 研发团队会及时 review 代码，测试通过后合入。
 
-  SA_URL = 'http://sa_host.com:8006/sa?token=xxx'
+## 讨论
 
-  consumer = SensorsAnalytics::DefaultConsumer.new(SA_URL)
-  sa = SensorsAnalytics::SensorsAnalytics.new(consumer)
+| 扫码加入神策数据开源社区 QQ 群<br>群号：785122381 | 扫码加入神策数据开源社区微信群 |
+| ------ | ------ |
+|![ QQ 讨论群](https://opensource.sensorsdata.cn/wp-content/uploads/ContentCommonPic_1.png) | ![ 微信讨论群 ](https://opensource.sensorsdata.cn/wp-content/uploads/ContentCommonPic_2.png) |
 
-  distinct_id = "ABCDEF123456"
-  sa.track(distinct_id, "UserLogin", {"Source" : "HomePage"})
-```
+## 公众号
 
-Http keepalive is supported now. Add gem `net-http-persistent` to your `Gemfile`. Then it will use http keepalive by default.
+| 扫码关注<br>神策数据开源社区 | 扫码关注<br>神策数据开源社区服务号 |
+| ------ | ------ |
+|![ 微信订阅号 ](https://opensource.sensorsdata.cn/wp-content/uploads/ContentCommonPic_3.png) | ![ 微信服务号 ](https://opensource.sensorsdata.cn/wp-content/uploads/ContentCommonPic_4.png) |
 
-## To learn more
+## 新书推荐
 
-See our [full manual](http://www.sensorsdata.cn/manual/ruby_sdk.html)
+| 《数据驱动：从方法到实践》 | 《Android 全埋点解决方案》 | 《iOS 全埋点解决方案》
+| ------ | ------ | ------ |
+| [![《数据驱动：从方法到实践》](https://opensource.sensorsdata.cn/wp-content/uploads/data_driven_book_1.jpg)](https://item.jd.com/12322322.html) | [![《Android 全埋点解决方案》](https://opensource.sensorsdata.cn/wp-content/uploads/Android-全埋点thumbnail_1.png)](https://item.jd.com/12574672.html) | [![《iOS 全埋点解决方案》](https://opensource.sensorsdata.cn/wp-content/uploads/iOS-全埋点thumbnail_1.png)](https://item.jd.com/12867068.html)
 
 ## License
 
-Copyright 2015－2019 Sensors Data Inc.
+Copyright 2015－2020 Sensors Data Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/lib/sensors_analytics/client.rb

@@ -100,6 +100,16 @@ module SensorsAnalytics
       _track_event(:profile_unset, distinct_id, distinct_id, nil, property_hash)
     end
 
+    # 上报 item 数据
+    def item_set(item_type, item_id, properties)
+      _track_item(:item_set, item_type, item_id, properties)
+    end
+
+    # 删除 item 数据
+    def item_delete(item_type, item_id)
+      _track_item(:item_delete, item_type, item_id, {})
+    end
+
     private
 
     def _track_event(event_type, distinct_id, origin_distinct_id, event_name, properties)
@@ -151,6 +161,48 @@ module SensorsAnalytics
       @consumer.send(event)
     end
 
+    def _track_item(event_type, item_type, item_id, properties)
+      _assert_key_with_regex(:item_type, item_type)
+      _assert_key(:item_id, item_id)
+
+      if event_type == :item_set
+        _assert_properties(event_type, properties)
+      end
+
+      # 从事件属性中获取时间配置
+      event_time = _extract_time_from_properties(properties)
+      properties.delete(:$time)
+      properties.delete("$time")
+
+      lib_properties = _get_lib_properties
+
+      # event_type 有 item_set 和 item_delete 两种
+      event = {
+        type: event_type,
+        time: event_time,
+        item_id: item_id,
+        item_type: item_type,
+        lib: lib_properties,
+      }
+
+      if event_type == :item_set
+        # item_set 有 properties 属性
+        item_properties = {}
+
+        properties.each do |key, value|
+          if value.is_a?(Time)
+            item_properties[key] = value.strftime("%Y-%m-%d %H:%M:%S.#{(value.to_f * 1000.0).to_i % 1000}")
+          else
+            item_properties[key] = value
+          end
+        end
+
+        event[:properties] = item_properties
+      end
+
+      @consumer.send(event)
+    end
+
     def _extract_time_from_properties(properties)
       properties.each do |key, value|
         if (key == :$time || key == "$time") && value.is_a?(Time)
@@ -252,11 +304,11 @@ module SensorsAnalytics
         # profile_append 的属性必须为数组类型，且数组元素必须为字符串
         if event_type == :profile_append
           unless value.is_a?(Array)
-            raise IllegalDataError.new("The properties value of PROFILE INCREMENT must be an instance of Array[String].")
+            raise IllegalDataError.new("The properties value of PROFILE APPEND must be an instance of Array[String].")
           end
           value.each do |element|
             unless element.is_a?(String) || element.is_a?(Symbol)
-              raise IllegalDataError.new("The properties value of PROFILE INCREMENT must be an instance of Array[String].")
+              raise IllegalDataError.new("The properties value of PROFILE APPEND must be an instance of Array[String].")
             end
           end
         end

data/lib/sensors_analytics/version.rb

@@ -1,4 +1,4 @@
 
 module SensorsAnalytics
-  VERSION = '1.6.1'
+  VERSION = '1.6.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensors_analytics_sdk
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.6.2
 platform: ruby
 authors:
 - Yuhan ZOU
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-07 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,8 +107,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: SensorsAnalyticsSDK