remark_analytics 1.0.0 → 1.0.1
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.
- checksums.yaml +4 -4
- data/README.md +38 -20
- data/lib/remark_analytics/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e1702e8faba069627dd5a47d1d921341562bcb2e89033b751ae07298c55538b5
|
|
4
|
+
data.tar.gz: a7d5e138c5fa42dd65071b5f71c63c07d6f630675099dba3bb3ddab9caa91fc6
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2a8fa7aaffbf6cb4244e10a7b945c4d98d56ead736eaf35b54cf00e4d1a24939cab5b0395fdabab45d4b26a02c2901c366f3beb015b5a29a38d2c127472d1188
|
|
7
|
+
data.tar.gz: '038e96e6787e4976f1b88d13e20a2a7841d9b13798104c446dabcd9a35709b7e7423badf0998cc3ce368859787bea23f8470adcc25349f16e4522fe323692302'
|
data/README.md
CHANGED
|
@@ -1,29 +1,47 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ReMark Analytics
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Welcome to the readme of ReMark Analytics. This library is used to emit events
|
|
4
|
+
from Ruby applications to the ReMark Analytics API in order for ReMark's Data Analytics team to do magic with the built up data set.
|
|
4
5
|
|
|
5
|
-
|
|
6
|
+
## Installation
|
|
6
7
|
|
|
7
|
-
|
|
8
|
-
* Version
|
|
9
|
-
* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo)
|
|
8
|
+
Add this line to your application's Gemfile:
|
|
10
9
|
|
|
11
|
-
|
|
10
|
+
```ruby
|
|
11
|
+
gem 'remark_analytics'
|
|
12
|
+
```
|
|
12
13
|
|
|
13
|
-
|
|
14
|
-
* Configuration
|
|
15
|
-
* Dependencies
|
|
16
|
-
* Database configuration
|
|
17
|
-
* How to run tests
|
|
18
|
-
* Deployment instructions
|
|
14
|
+
And then execute:
|
|
19
15
|
|
|
20
|
-
|
|
16
|
+
$ bundle install
|
|
21
17
|
|
|
22
|
-
|
|
23
|
-
* Code review
|
|
24
|
-
* Other guidelines
|
|
18
|
+
Or install it yourself as:
|
|
25
19
|
|
|
26
|
-
|
|
20
|
+
$ gem install remark_analytics
|
|
27
21
|
|
|
28
|
-
|
|
29
|
-
|
|
22
|
+
## Configuration
|
|
23
|
+
Make sure the following keys and their values become available in your application's Rails.application.secrets
|
|
24
|
+
|
|
25
|
+
- **REMARK_ANALYTICS_URL** (the url of the application to post to (within the velogica cluster)
|
|
26
|
+
- **REMARK_ANALYTICS_USERNAME** (the Basic Authentication user name)
|
|
27
|
+
- **REMARK_ANALYTICS_PASSWORD** (the Basic Authentication user password)
|
|
28
|
+
- **REMARK_ANALYTICS_TENANT_NAME** (the name of the tenant/client)
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
## Usage
|
|
32
|
+
|
|
33
|
+
Examples:
|
|
34
|
+
|
|
35
|
+
```ruby
|
|
36
|
+
# You can register an event from everywhere in the code with
|
|
37
|
+
RemarkAnalytics::Event.emit({
|
|
38
|
+
name: 'event_name_that_is_easy_to_understand',
|
|
39
|
+
resource_id: resource.id,
|
|
40
|
+
resource_type: 'Dossier',
|
|
41
|
+
data: {
|
|
42
|
+
outcome: resource.outcome,
|
|
43
|
+
by_system: resource.by_system,
|
|
44
|
+
other_attribute: 'some value'
|
|
45
|
+
}
|
|
46
|
+
})
|
|
47
|
+
```
|