snowplow-tracker 0.7.0.pre.alpha.2 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +35 -13
  3. data/lib/snowplow-tracker/emitters.rb +355 -147
  4. data/lib/snowplow-tracker/page.rb +60 -0
  5. data/lib/snowplow-tracker/payload.rb +30 -34
  6. data/lib/snowplow-tracker/self_describing_json.rb +92 -9
  7. data/lib/snowplow-tracker/subject.rb +282 -59
  8. data/lib/snowplow-tracker/timestamp.rb +95 -23
  9. data/lib/snowplow-tracker/tracker.rb +547 -242
  10. data/lib/snowplow-tracker/version.rb +33 -4
  11. data/lib/snowplow-tracker.rb +5 -5
  12. metadata +15 -16
  13. data/lib/snowplow-tracker/contracts.rb +0 -29
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ad40c4c474a4c9889f7ff7466ca04f81d3c95f72aecf868b1af1ec69a3663660
4
- data.tar.gz: 3582d4b6d7eef4e14aca871a94783f9f3a74aebf6532f6d9f1d5e978b0614933
3
+ metadata.gz: 23047d83eb7b5f22343e668d97e0885fbf1cacf684706b8bb83465e98fc78e40
4
+ data.tar.gz: edf65b28b3264412a3c11f2f0e9ee3a440647fbece99228ab450e9a01148b0f5
5
5
  SHA512:
6
- metadata.gz: f59a0ae6a7eb0f7134911c218124a01efa41d43ab33132d826a2aa12c1d42f6cba7fc1d952127c3a3058b86cc1ff7fa5332a450a3764ff4033e190ed360447e5
7
- data.tar.gz: 72294a5a7499a744f10c43c96739b2d7576d591a2d96ba98ae3ed09b95b7bd8f717858bedc99a647ff36f6afbc21fa5063b7e2f60c03dae614d276a0fcf2a914
6
+ metadata.gz: d996e91a98e1ce69d459dd91655ff052d578e0dfed0c41c69731d1f37b93dfa95ca50e11b82d43df78b599197f8e94b5f5ad6a7fad5f4f8498d886c1dfdeae95
7
+ data.tar.gz: 88053e746e569713d537bfbbd75cb61ec4e38bbf19a0e8f36de13d057450fec5ab4f3e5a13715b13df1dc8188791e6e9dc38d9aed27b47bcc99c415d2edc6df5
data/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  [![early-release]][tracker-classification]
4
4
  [![Gem Version](https://badge.fury.io/rb/snowplow-tracker.svg)](https://badge.fury.io/rb/snowplow-tracker)
5
- [![Build Status](https://travis-ci.org/snowplow/snowplow-ruby-tracker.png?branch=master)](https://travis-ci.org/snowplow/snowplow-ruby-tracker)
5
+ [![Build Status][gh-actions-image]][gh-actions]
6
6
  [![Code Climate](https://codeclimate.com/github/snowplow/snowplow-ruby-tracker.png)](https://codeclimate.com/github/snowplow/snowplow-ruby-tracker)
7
7
  [![Coverage Status](https://coveralls.io/repos/snowplow/snowplow-ruby-tracker/badge.png)](https://coveralls.io/r/snowplow/snowplow-ruby-tracker)
8
8
  [![License][license-image]][license]
@@ -11,8 +11,29 @@
11
11
 
12
12
  Add analytics to your Ruby and Rails apps and gems with the **[Snowplow][snowplow]** event tracker for **[Ruby][ruby]**.
13
13
 
14
+ Snowplow is a scalable open-source platform for rich, high quality, low-latency data collection. It is designed to collect high quality, complete behavioral data for enterprise business.
15
+
16
+ **To find out more, please check out the [Snowplow website][snowplow] and our [documentation][docs].**
17
+
14
18
  With this tracker you can collect event data from your **[Ruby][ruby]** applications, **[Ruby on Rails][rails]** web applications and **[Ruby gems][rubygems]**.
15
19
 
20
+ ## Quickstart
21
+
22
+ Add this gem to your Gemfile. It is compatible with Ruby versions 2.1 to 3.0+.
23
+
24
+ ```ruby
25
+ gem "snowplow-tracker", "~> 0.7.0"
26
+ ```
27
+
28
+ See our [demo app][demoapp] for an example of implementing the Ruby tracker in a Rails app.
29
+
30
+ ## Find out more
31
+
32
+ | Technical Docs | API Docs | Contributing |
33
+ | ------------------------------ | ----------------------- | ----------------------------------- |
34
+ | ![i1][techdocs-image] | ![i1][techdocs-image] | ![i4][contributing-image] |
35
+ | **[Technical Docs][techdocs]** | **[API Docs][apidocs]** | **[Contributing](Contributing.md)** |
36
+
16
37
  ## Maintainer Quickstart
17
38
 
18
39
  Clone this repo and navigate into the cloned folder. To run the tests locally, you will need [Docker][docker] installed.
@@ -24,7 +45,7 @@ docker run -v "$(pwd)":"/code" ruby-tracker
24
45
 
25
46
  The `-v` flag for `docker run` creates a bind mount for the project directory. This means that changes to the files will be automatically applied within the Docker image. However, if you modify the `Gemfile` or `snowplow-tracker.gemspec` files, the image must be rebuilt.
26
47
 
27
- Alternatively, test directly by installing Ruby 2.6+ and [Bundler][bundler]. Then run:
48
+ Alternatively, test directly by installing Ruby 2.1+ and [Bundler][bundler]. Then run:
28
49
 
29
50
  ```
30
51
  bundle install
@@ -35,16 +56,9 @@ rspec
35
56
 
36
57
  Feedback and contributions are welcome - if you have identified a bug, please log an issue on this repo. For all other feedback, discussion or questions please open a thread on our [Discourse forum][discourse].
37
58
 
38
- ## Find out more
39
-
40
- | Technical Docs | Contributing |
41
- | ------------------------------ | ----------------------------------- |
42
- | ![i1][techdocs-image] | ![i4][contributing-image] |
43
- | **[Technical Docs][techdocs]** | **[Contributing](Contributing.md)** |
44
-
45
59
  ## Copyright and license
46
60
 
47
- The Snowplow Ruby Tracker is copyright 2013-2016 Snowplow Analytics Ltd.
61
+ The Snowplow Ruby Tracker is copyright 2013-2021 Snowplow Analytics Ltd.
48
62
 
49
63
  Licensed under the **[Apache License, Version 2.0][license]** (the "License");
50
64
  you may not use this software except in compliance with the License.
@@ -57,15 +71,23 @@ limitations under the License.
57
71
 
58
72
  [license-image]: https://img.shields.io/badge/license-Apache--2-blue.svg?style=flat
59
73
  [license]: https://www.apache.org/licenses/LICENSE-2.0
74
+ [gh-actions]: https://github.com/snowplow/snowplow-ruby-tracker/actions
75
+ [gh-actions-image]: https://github.com/snowplow/snowplow-ruby-tracker/workflows/test.yml/badge.svg
76
+ [tracker-classification]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/tracker-maintenance-classification/
77
+ [early-release]: https://img.shields.io/static/v1?style=flat&label=Snowplow&message=Early%20Release&color=014477&labelColor=9ba0aa&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAAeFBMVEVMaXGXANeYANeXANZbAJmXANeUANSQAM+XANeMAMpaAJhZAJeZANiXANaXANaOAM2WANVnAKWXANZ9ALtmAKVaAJmXANZaAJlXAJZdAJxaAJlZAJdbAJlbAJmQAM+UANKZANhhAJ+EAL+BAL9oAKZnAKVjAKF1ALNBd8J1AAAAKHRSTlMAa1hWXyteBTQJIEwRgUh2JjJon21wcBgNfmc+JlOBQjwezWF2l5dXzkW3/wAAAHpJREFUeNokhQOCA1EAxTL85hi7dXv/E5YPCYBq5DeN4pcqV1XbtW/xTVMIMAZE0cBHEaZhBmIQwCFofeprPUHqjmD/+7peztd62dWQRkvrQayXkn01f/gWp2CrxfjY7rcZ5V7DEMDQgmEozFpZqLUYDsNwOqbnMLwPAJEwCopZxKttAAAAAElFTkSuQmCC
78
+
60
79
  [ruby]: https://www.ruby-lang.org/en/
61
80
  [rails]: https://rubyonrails.org/
62
81
  [rubygems]: https://rubygems.org/
63
82
  [docker]: https://www.docker.com/
64
83
  [bundler]: https://bundler.io/
65
- [snowplow]: httpd://snowplowanalytics.com
84
+
85
+ [snowplow]: https://snowplowanalytics.com
86
+ [docs]: https://docs.snowplowanalytics.com/
87
+ [demoapp]: https://github.com/snowplow-incubator/snowplow-ruby-tracker-examples
66
88
  [discourse]: https://discourse.snowplowanalytics.com
89
+
67
90
  [techdocs-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/techdocs.png
68
91
  [contributing-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/contributing.png
69
92
  [techdocs]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/ruby-tracker/
70
- [tracker-classification]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/tracker-maintenance-classification/
71
- [early-release]: https://img.shields.io/static/v1?style=flat&label=Snowplow&message=Early%20Release&color=014477&labelColor=9ba0aa&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAAeFBMVEVMaXGXANeYANeXANZbAJmXANeUANSQAM+XANeMAMpaAJhZAJeZANiXANaXANaOAM2WANVnAKWXANZ9ALtmAKVaAJmXANZaAJlXAJZdAJxaAJlZAJdbAJlbAJmQAM+UANKZANhhAJ+EAL+BAL9oAKZnAKVjAKF1ALNBd8J1AAAAKHRSTlMAa1hWXyteBTQJIEwRgUh2JjJon21wcBgNfmc+JlOBQjwezWF2l5dXzkW3/wAAAHpJREFUeNokhQOCA1EAxTL85hi7dXv/E5YPCYBq5DeN4pcqV1XbtW/xTVMIMAZE0cBHEaZhBmIQwCFofeprPUHqjmD/+7peztd62dWQRkvrQayXkn01f/gWp2CrxfjY7rcZ5V7DEMDQgmEozFpZqLUYDsNwOqbnMLwPAJEwCopZxKttAAAAAElFTkSuQmCC
93
+ [apidocs]: https://snowplow.github.io/snowplow-ruby-tracker/