snowplow-tracker 0.6.1 → 0.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (13) hide show
  1. checksums.yaml +5 -5
  2. data/README.md +58 -36
  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 +11 -33
  13. data/lib/snowplow-tracker/contracts.rb +0 -29
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 7791ce01bb9fb13236a7640831d408c1e2a79b4a
4
- data.tar.gz: 214c62d81fadb5a24aab0672f9e8ff2c8518fbb4
2
+ SHA256:
3
+ metadata.gz: 828096deb0a370f527d14f17e2e48eb1481428b5cdc1b2897235b539be64f327
4
+ data.tar.gz: e0b5b026cfad092a2c4269876bc0b7e5d240ba5ec8b18b67b8a1e97d7c127a93
5
5
  SHA512:
6
- metadata.gz: 31972b3c6ab6eafcb3e52e55a601ddbd32f8ec3e30ccbf9c906668d91f6b1d552baedbcc3a9d67b087381bc770d2d9c6edb04d7e0fcf1363f18e32fa4d23fe11
7
- data.tar.gz: d9834146473868f531b9dcf6f07f7ffe3735034c55b392825da3c47e0874569c561dd99885761343f312cc40726449158c5061432e1282dd6f7a55fd85301365
6
+ metadata.gz: b75d45c5b03f55398ab27a9945d9ddbe91340348d803e8be8d4c74b108f39931cd7a7e17a661a818ffd9e3d81aac71bdf3a8d5486c397881a741bfc5e1b881b0
7
+ data.tar.gz: 650468a842f96ab6951aa54bc374115ee0dc3a466b6f15807c8a0e8fb1e86127b630ee226f8c0ba49b3316ae20d342c24c6211810e2c2eac65791d7f4fa9f478
data/README.md CHANGED
@@ -1,48 +1,69 @@
1
- # Ruby Analytics for Snowplow
2
- [![Gem Version](https://badge.fury.io/rb/snowplow-tracker.svg)](http://badge.fury.io/rb/snowplow-tracker)
3
- [![Build Status](https://travis-ci.org/snowplow/snowplow-ruby-tracker.png?branch=master)](https://travis-ci.org/snowplow/snowplow-ruby-tracker)
1
+ # Ruby Analytics for Snowplow
2
+
3
+ [![early-release]][tracker-classification]
4
+ [![Gem Version](https://badge.fury.io/rb/snowplow-tracker.svg)](https://badge.fury.io/rb/snowplow-tracker)
5
+ [![Build Status][gh-actions-image]][gh-actions]
4
6
  [![Code Climate](https://codeclimate.com/github/snowplow/snowplow-ruby-tracker.png)](https://codeclimate.com/github/snowplow/snowplow-ruby-tracker)
5
7
  [![Coverage Status](https://coveralls.io/repos/snowplow/snowplow-ruby-tracker/badge.png)](https://coveralls.io/r/snowplow/snowplow-ruby-tracker)
6
8
  [![License][license-image]][license]
7
9
 
8
10
  ## Overview
9
11
 
10
- 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
+
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.
11
15
 
12
- With this tracker you can collect event data from your **[Ruby] [ruby]** applications, **[Ruby on Rails] [rails]** web applications and **[Ruby gems] [rubygems]**.
16
+ **To find out more, please check out the [Snowplow website][snowplow] and our [documentation][docs].**
13
17
 
14
18
  ## Quickstart
15
19
 
16
- Assuming git, **[Vagrant] [vagrant-install]** and **[VirtualBox] [virtualbox-install]** installed:
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)** |
34
+
35
+ ## Maintainer Quickstart
36
+
37
+ Clone this repo and navigate into the cloned folder. To run the tests locally, you will need [Docker][docker] installed.
17
38
 
18
39
  ```bash
19
- host$ git clone https://github.com/snowplow/snowplow-ruby-tracker.git
20
- host$ cd snowplow-ruby-tracker
21
- host$ vagrant up && vagrant ssh
22
- guest$ cd /vagrant
23
- guest$ gem install bundler
24
- guest$ bundle install
25
- guest$ rspec
40
+ docker build . -t ruby-tracker
41
+ docker run -v "$(pwd)":"/code" ruby-tracker
26
42
  ```
27
43
 
28
- ## Publishing
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.
45
+
46
+ Alternatively, test directly by installing Ruby 2.1+ and [Bundler][bundler]. Then run:
29
47
 
30
48
  ```bash
31
- host$ vagrant push
49
+ bundle install
50
+ rspec
32
51
  ```
33
52
 
34
- ## Find out more
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
+
58
+ ## Contributing
35
59
 
36
- | Technical Docs | Setup Guide | Roadmap | Contributing |
37
- |---------------------------------|---------------------------|-------------------------|-----------------------------------|
38
- | ![i1] [techdocs-image] | ![i2] [setup-image] | ![i3] [roadmap-image] | ![i4] [contributing-image] |
39
- | **[Technical Docs] [techdocs]** | **[Setup Guide] [setup]** | **[Roadmap] [roadmap]** | **[Contributing] [contributing]** |
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].
40
61
 
41
62
  ## Copyright and license
42
63
 
43
- The Snowplow Ruby Tracker is copyright 2013-2016 Snowplow Analytics Ltd.
64
+ The Snowplow Ruby Tracker is copyright 2013-2021 Snowplow Analytics Ltd.
44
65
 
45
- Licensed under the **[Apache License, Version 2.0] [license]** (the "License");
66
+ Licensed under the **[Apache License, Version 2.0][license]** (the "License");
46
67
  you may not use this software except in compliance with the License.
47
68
 
48
69
  Unless required by applicable law or agreed to in writing, software
@@ -51,24 +72,25 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
51
72
  See the License for the specific language governing permissions and
52
73
  limitations under the License.
53
74
 
54
- [license-image]: http://img.shields.io/badge/license-Apache--2-blue.svg?style=flat
55
- [license]: http://www.apache.org/licenses/LICENSE-2.0
75
+ [license-image]: https://img.shields.io/badge/license-Apache--2-blue.svg?style=flat
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
56
81
 
57
82
  [ruby]: https://www.ruby-lang.org/en/
58
- [rails]: http://rubyonrails.org/
83
+ [rails]: https://rubyonrails.org/
59
84
  [rubygems]: https://rubygems.org/
85
+ [docker]: https://www.docker.com/
86
+ [bundler]: https://bundler.io/
60
87
 
61
- [snowplow]: http://snowplowanalytics.com
62
-
63
- [vagrant-install]: http://docs.vagrantup.com/v2/installation/index.html
64
- [virtualbox-install]: https://www.virtualbox.org/wiki/Downloads
88
+ [snowplow]: https://snowplowanalytics.com
89
+ [docs]: https://docs.snowplowanalytics.com/
90
+ [demoapp]: https://github.com/snowplow-incubator/snowplow-ruby-tracker-examples
91
+ [discourse]: https://discourse.snowplowanalytics.com
65
92
 
66
93
  [techdocs-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/techdocs.png
67
- [setup-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/setup.png
68
- [roadmap-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/roadmap.png
69
94
  [contributing-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/contributing.png
70
-
71
- [techdocs]: https://github.com/snowplow/snowplow/wiki/Ruby-Tracker
72
- [setup]: https://github.com/snowplow/snowplow/wiki/Ruby-Tracker-Setup
73
- [roadmap]: https://github.com/snowplow/snowplow/wiki/Ruby-Tracker-Roadmap
74
- [contributing]: https://github.com/snowplow/snowplow/wiki/Ruby-Tracker-Contributing
95
+ [techdocs]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/ruby-tracker/
96
+ [apidocs]: https://snowplow.github.io/snowplow-ruby-tracker/