sensors_analytics_sdk 1.5.3 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b99ecbef9d60ba74901058b45579148c0fcfb28
-  data.tar.gz: 8575e4e46d12bc8465ad9a8ed2313d77b9e725d0
+  metadata.gz: d40c4fa635531398cfe72f8b8f2fe7cd30d1c3eb
+  data.tar.gz: 7333f0802458dc4275bd2d8a29a67501be214be2
 SHA512:
-  metadata.gz: cbfabe6112d4d03cbe3b768af27a429db2e3abb22292169d49b072ef7900cc6d52f18fb425f3719b7e26bf3443ac76cc07ae7329b82dbdab1b8b728c0d59254a
-  data.tar.gz: 11a5eac240c5530d95fae2d429e9cb30972f17c1bca2f6fd9e5c429b85e51e5db6089b5197cd4be4d26bfae04fd633367e3fb1462f84cb8d7c6082fc16980584
+  metadata.gz: e5b2b9f8c59ef2423834bea5968e963afa307e0c4802a6cfdfcb604d0bcd9152dd9446a40bd4350740aff88866218c4f1e5b18fcb5bb69f54ba5f9a4b69faa6c
+  data.tar.gz: 09e9ce21236e6d2d4ae60f61e62b2ef5a3a0e17f170dec4f402f5f67f5b585a852e212a07cedabbb3d5119cae7bc94c290be314328bd69df785a1b77115f5a31

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.1

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'net-http-persistent'

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    sensors_analytics_sdk (1.6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    connection_pool (2.2.1)
+    metaclass (0.0.4)
+    minitest (5.10.1)
+    mocha (1.2.1)
+      metaclass (~> 0.0.1)
+    net-http-persistent (3.0.0)
+      connection_pool (~> 2.2)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  minitest (~> 5.0)
+  mocha
+  net-http-persistent
+  rake (~> 10.0)
+  sensors_analytics_sdk!
+
+BUNDLED WITH
+   1.13.7

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,39 @@
+# Sensors Analytics
+
+This is the official Ruby SDK for Sensors Analytics.
+
+## Easy Installation
+
+You can get Sensors Analytics SDK using gem.
+Add below to you `Gemfile`
+
+```
+  gem 'sensors_analytics_sdk'
+```
+
+Or execute `gem install` as below.
+
+```
+  gem install sensors_analytics_sdk
+```
+
+Once the SDK is successfully installed, use the Sensors Analytics SDK likes:
+
+```ruby
+  require 'sensors_analytics_sdk'
+
+  SA_URL = 'http://sa_host.com:8006/sa?token=xxx'
+
+  consumer = SensorsAnalytics::DefaultConsumer.new(SA_URL)
+  sa = SensorsAnalytics::SensorsAnalytics.new(consumer)
+
+  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.
+
+## To learn more
+
+See our [full manual](http://www.sensorsdata.cn/manual/ruby_sdk.html)
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/changeslog.md

@@ -0,0 +1,6 @@
+
+## v1.6.0
+
+* 重新组织 gem 文件，使之遵循 gem 惯例规范
+* 增加自动化单元测试，重构代码
+* 支持 http keepalive

data/examples/demo.rb

@@ -0,0 +1,129 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'sensors_analytics_sdk'
+
+DISTINCT_ID = 'abcdefg'
+
+# TODO use your sa host
+SA_URL = 'http://sa_host.com:8006/sa?token=xxx'
+
+def debug_mode_demo
+  begin
+    SensorsAnalytics::DebugConsumer.new(SA_URL, false)
+  rescue => e
+    puts "Expected excaption: '#{e.message}'"
+  end
+
+  consumer = SensorsAnalytics::DebugConsumer.new(SA_URL, false)
+  sa = SensorsAnalytics::SensorsAnalytics.new(consumer)
+
+  begin
+    properties = {
+        "sex" => "male",
+        "age" => 123,
+        "$time" => Time.now,
+        "event_time" => Time.now
+    }
+    # expects 'valid message...'
+    sa.track(DISTINCT_ID, "RubyDemoStart", properties)
+  rescue => e
+    puts "Unexpected exception: '#{e.message}'"
+  end
+
+  consumer = SensorsAnalytics::DebugConsumer.new(SA_URL, true)
+  sa = SensorsAnalytics::SensorsAnalytics.new(consumer)
+
+  begin
+    properties = {
+        "sex" => "male",
+        "age" => 123
+    }
+    # expects 'valid message...'
+    sa.track(DISTINCT_ID, "RubyDemoStart", properties)
+  rescue => e
+    puts "Unexpected exception: '#{e.message}'"
+  end
+
+  begin
+    properties = {
+        "age" => "123"
+    }
+    # expects 'invalid message...'
+    sa.track(DISTINCT_ID, "RubyDemoStart", properties)
+  rescue => e
+    puts "Expected exception: '#{e.message}'"
+  end
+
+  begin
+    sa.profile_set(DISTINCT_ID, {"sex" => "male", "age" => 123})
+    sa.profile_increment(DISTINCT_ID, {"age" => 10})
+    sa.profile_set_once(DISTINCT_ID, {"sex" => "female"})
+    sa.profile_append(DISTINCT_ID, {"songs" => ["aaa", "bbb"]})
+    sa.profile_unset(DISTINCT_ID, ["songs", "sex"])
+  rescue => e
+    puts "Unexpected exception: '#{e.message}'"
+  end
+
+end
+
+def default_consumer_demo
+  consumer = SensorsAnalytics::DefaultConsumer.new(SA_URL)
+  sa = SensorsAnalytics::SensorsAnalytics.new(consumer)
+
+  begin
+    sa.track(DISTINCT_ID, "RubyDemoStart", {"sex" => "male", "age" => 123})
+  rescue => e
+    puts "Unexpected exception: '#{e.message}'"
+  end
+
+  begin
+    sa.track("", "RubyDemoStart")
+  rescue => e
+    puts "Expected exception: '#{e.message}'"
+  end
+
+  begin
+    sa.track(DISTINCT_ID, "event")
+  rescue => e
+    puts "Expected exception: '#{e.message}'"
+  end
+
+  begin
+    sa.track(DISTINCT_ID, "RubyDemoStart", {"id" => "123"})
+  rescue => e
+    puts "Expected exception: '#{e.message}'"
+  end
+
+  consumer = SensorsAnalytics::DefaultConsumer.new("http://www.baidu.com")
+  sa = SensorsAnalytics::SensorsAnalytics.new(consumer)
+
+  begin
+    sa.track(DISTINCT_ID, "RubyDemoStart")
+  rescue => e
+    puts "Expected exception: '#{e.message}'"
+  end
+end
+
+def batch_consumer_demo
+  consumer = SensorsAnalytics::BatchConsumer.new(SA_URL, 10)
+  sa = SensorsAnalytics::SensorsAnalytics.new(consumer)
+
+  begin
+    for i in 0..15
+      sa.track(DISTINCT_ID, "RubyDemoStart", {"sex" => "male", "age" => 123, "sort" => i})
+    end
+    # consumer 的 flush_bulk 设为10，因此 consumer 会批量发送10条 events，剩余5条，手动调用 consumer.flush 发送
+    consumer.flush
+  rescue => e
+    puts "Unexpected exception: '#{e.message}'"
+  end
+end
+
+if __FILE__ == $0
+  # Debug 模式
+  debug_mode_demo
+  # 普通模式
+  default_consumer_demo
+  # 批量同步发送模式
+  batch_consumer_demo
+end
+