snowplow-tracker 0.7.0.pre.alpha.0 → 0.8.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 +41 -16
  3. data/lib/snowplow-tracker/emitters.rb +339 -154
  4. data/lib/snowplow-tracker/page.rb +55 -0
  5. data/lib/snowplow-tracker/payload.rb +28 -39
  6. data/lib/snowplow-tracker/self_describing_json.rb +92 -9
  7. data/lib/snowplow-tracker/subject.rb +289 -68
  8. data/lib/snowplow-tracker/timestamp.rb +93 -25
  9. data/lib/snowplow-tracker/tracker.rb +521 -257
  10. data/lib/snowplow-tracker/version.rb +26 -4
  11. data/lib/snowplow-tracker.rb +5 -5
  12. metadata +12 -33
  13. data/lib/snowplow-tracker/contracts.rb +0 -29
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: debc2ab18310d2efcd5e57dc42e52a259876c2588b7e735183c07bba16c9ab3a
4
- data.tar.gz: 11a596a2e96673312deff3a8ecdc664792e71aac503af33c826583c2a14f8edc
3
+ metadata.gz: 828096deb0a370f527d14f17e2e48eb1481428b5cdc1b2897235b539be64f327
4
+ data.tar.gz: e0b5b026cfad092a2c4269876bc0b7e5d240ba5ec8b18b67b8a1e97d7c127a93
5
5
  SHA512:
6
- metadata.gz: d95205012540b049b857b97ecfb2ff055ee7f786c3c83c375d89f6743bb568cb3577185196a90ed6e17dab788dbe63c6fe2d226df28d2a6acddd4ae2f79e3938
7
- data.tar.gz: c09b603c6e633246b7e75e3b44dda70913b5476582cdab2bee87556a63780e8c1c1363e02342057d54c129d63632d9a921c62f6e26f880a237d87e77f06192ae
6
+ metadata.gz: b75d45c5b03f55398ab27a9945d9ddbe91340348d803e8be8d4c74b108f39931cd7a7e17a661a818ffd9e3d81aac71bdf3a8d5486c397881a741bfc5e1b881b0
7
+ data.tar.gz: 650468a842f96ab6951aa54bc374115ee0dc3a466b6f15807c8a0e8fb1e86127b630ee226f8c0ba49b3316ae20d342c24c6211810e2c2eac65791d7f4fa9f478
data/README.md CHANGED
@@ -2,16 +2,35 @@
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]
9
9
 
10
10
  ## Overview
11
11
 
12
- Add analytics to your Ruby and Rails apps and gems with the **[Snowplow][snowplow]** event tracker for **[Ruby][ruby]**.
12
+ Add analytics to your **[Ruby][ruby]** and **[Ruby on Rails][rails]** apps and **[gems][rubygems]** with the **[Snowplow][snowplow]** event tracker for **[Ruby][ruby]**.
13
13
 
14
- With this tracker you can collect event data from your **[Ruby][ruby]** applications, **[Ruby on Rails][rails]** web applications and **[Ruby gems][rubygems]**.
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
+
18
+ ## Quickstart
19
+
20
+ Add this gem to your Gemfile. It is compatible with Ruby versions 2.1 to 3.0+.
21
+
22
+ ```ruby
23
+ gem "snowplow-tracker", "~> 0.8.0"
24
+ ```
25
+
26
+ See our [demo app][demoapp] for an example of implementing the Ruby tracker in a Rails app.
27
+
28
+ ## Find out more
29
+
30
+ | Snowplow Docs | API Docs | Contributing |
31
+ | ------------------------------ | ----------------------- | ----------------------------------- |
32
+ | ![i1][techdocs-image] | ![i1][techdocs-image] | ![i4][contributing-image] |
33
+ | **[Snowplow Docs][techdocs]** | **[API Docs][apidocs]** | **[Contributing](Contributing.md)** |
15
34
 
16
35
  ## Maintainer Quickstart
17
36
 
@@ -24,27 +43,25 @@ docker run -v "$(pwd)":"/code" ruby-tracker
24
43
 
25
44
  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
45
 
27
- Alternatively, test directly by installing Ruby 2.6+ and [Bundler][bundler]. Then run:
46
+ Alternatively, test directly by installing Ruby 2.1+ and [Bundler][bundler]. Then run:
28
47
 
29
- ```
48
+ ```bash
30
49
  bundle install
31
50
  rspec
32
51
  ```
33
52
 
53
+ To generate documentation using YARD, make sure the YARD and redcarpet gems are installed locally. Then run:
54
+ ```bash
55
+ yard doc
56
+ ```
57
+
34
58
  ## Contributing
35
59
 
36
60
  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
61
 
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
62
  ## Copyright and license
46
63
 
47
- The Snowplow Ruby Tracker is copyright 2013-2016 Snowplow Analytics Ltd.
64
+ The Snowplow Ruby Tracker is copyright 2013-2021 Snowplow Analytics Ltd.
48
65
 
49
66
  Licensed under the **[Apache License, Version 2.0][license]** (the "License");
50
67
  you may not use this software except in compliance with the License.
@@ -57,15 +74,23 @@ limitations under the License.
57
74
 
58
75
  [license-image]: https://img.shields.io/badge/license-Apache--2-blue.svg?style=flat
59
76
  [license]: https://www.apache.org/licenses/LICENSE-2.0
77
+ [gh-actions]: https://github.com/snowplow/snowplow-ruby-tracker/actions
78
+ [gh-actions-image]: https://github.com/snowplow/snowplow-ruby-tracker/workflows/Test/badge.svg
79
+ [tracker-classification]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/tracker-maintenance-classification/
80
+ [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
81
+
60
82
  [ruby]: https://www.ruby-lang.org/en/
61
83
  [rails]: https://rubyonrails.org/
62
84
  [rubygems]: https://rubygems.org/
63
85
  [docker]: https://www.docker.com/
64
86
  [bundler]: https://bundler.io/
65
- [snowplow]: httpd://snowplowanalytics.com
87
+
88
+ [snowplow]: https://snowplowanalytics.com
89
+ [docs]: https://docs.snowplowanalytics.com/
90
+ [demoapp]: https://github.com/snowplow-incubator/snowplow-ruby-tracker-examples
66
91
  [discourse]: https://discourse.snowplowanalytics.com
92
+
67
93
  [techdocs-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/techdocs.png
68
94
  [contributing-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/contributing.png
69
95
  [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
96
+ [apidocs]: https://snowplow.github.io/snowplow-ruby-tracker/