snowplow-tracker 0.6.1 → 0.7.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 +56 -37
  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 -17
  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: 23047d83eb7b5f22343e668d97e0885fbf1cacf684706b8bb83465e98fc78e40
4
+ data.tar.gz: edf65b28b3264412a3c11f2f0e9ee3a440647fbece99228ab450e9a01148b0f5
5
5
  SHA512:
6
- metadata.gz: 31972b3c6ab6eafcb3e52e55a601ddbd32f8ec3e30ccbf9c906668d91f6b1d552baedbcc3a9d67b087381bc770d2d9c6edb04d7e0fcf1363f18e32fa4d23fe11
7
- data.tar.gz: d9834146473868f531b9dcf6f07f7ffe3735034c55b392825da3c47e0874569c561dd99885761343f312cc40726449158c5061432e1282dd6f7a55fd85301365
6
+ metadata.gz: d996e91a98e1ce69d459dd91655ff052d578e0dfed0c41c69731d1f37b93dfa95ca50e11b82d43df78b599197f8e94b5f5ad6a7fad5f4f8498d886c1dfdeae95
7
+ data.tar.gz: 88053e746e569713d537bfbbd75cb61ec4e38bbf19a0e8f36de13d057450fec5ab4f3e5a13715b13df1dc8188791e6e9dc38d9aed27b47bcc99c415d2edc6df5
data/README.md CHANGED
@@ -1,48 +1,66 @@
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 and Rails apps and gems 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.
15
+
16
+ **To find out more, please check out the [Snowplow website][snowplow] and our [documentation][docs].**
11
17
 
12
- With this tracker you can collect event data from your **[Ruby] [ruby]** applications, **[Ruby on Rails] [rails]** web applications and **[Ruby gems] [rubygems]**.
18
+ With this tracker you can collect event data from your **[Ruby][ruby]** applications, **[Ruby on Rails][rails]** web applications and **[Ruby gems][rubygems]**.
13
19
 
14
20
  ## Quickstart
15
21
 
16
- Assuming git, **[Vagrant] [vagrant-install]** and **[VirtualBox] [virtualbox-install]** installed:
22
+ Add this gem to your Gemfile. It is compatible with Ruby versions 2.1 to 3.0+.
17
23
 
18
- ```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
24
+ ```ruby
25
+ gem "snowplow-tracker", "~> 0.7.0"
26
26
  ```
27
27
 
28
- ## Publishing
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
+
37
+ ## Maintainer Quickstart
38
+
39
+ Clone this repo and navigate into the cloned folder. To run the tests locally, you will need [Docker][docker] installed.
29
40
 
30
41
  ```bash
31
- host$ vagrant push
42
+ docker build . -t ruby-tracker
43
+ docker run -v "$(pwd)":"/code" ruby-tracker
32
44
  ```
33
45
 
34
- ## Find out more
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.
47
+
48
+ Alternatively, test directly by installing Ruby 2.1+ and [Bundler][bundler]. Then run:
49
+
50
+ ```
51
+ bundle install
52
+ rspec
53
+ ```
54
+
55
+ ## Contributing
35
56
 
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]** |
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].
40
58
 
41
59
  ## Copyright and license
42
60
 
43
- The Snowplow Ruby Tracker is copyright 2013-2016 Snowplow Analytics Ltd.
61
+ The Snowplow Ruby Tracker is copyright 2013-2021 Snowplow Analytics Ltd.
44
62
 
45
- Licensed under the **[Apache License, Version 2.0] [license]** (the "License");
63
+ Licensed under the **[Apache License, Version 2.0][license]** (the "License");
46
64
  you may not use this software except in compliance with the License.
47
65
 
48
66
  Unless required by applicable law or agreed to in writing, software
@@ -51,24 +69,25 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
51
69
  See the License for the specific language governing permissions and
52
70
  limitations under the License.
53
71
 
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
72
+ [license-image]: https://img.shields.io/badge/license-Apache--2-blue.svg?style=flat
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
56
78
 
57
79
  [ruby]: https://www.ruby-lang.org/en/
58
- [rails]: http://rubyonrails.org/
80
+ [rails]: https://rubyonrails.org/
59
81
  [rubygems]: https://rubygems.org/
82
+ [docker]: https://www.docker.com/
83
+ [bundler]: https://bundler.io/
60
84
 
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
85
+ [snowplow]: https://snowplowanalytics.com
86
+ [docs]: https://docs.snowplowanalytics.com/
87
+ [demoapp]: https://github.com/snowplow-incubator/snowplow-ruby-tracker-examples
88
+ [discourse]: https://discourse.snowplowanalytics.com
65
89
 
66
90
  [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
91
  [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
92
+ [techdocs]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/ruby-tracker/
93
+ [apidocs]: https://snowplow.github.io/snowplow-ruby-tracker/