user_trackers 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6999e1efabe76b22187d7d5d24bb6e084d47f071
-  data.tar.gz: e1ce1105f8d3b2ce35c29ecbe7de69d0dff0f706
+  metadata.gz: f922bacf9b960c0a4d35e77c06f3eb51dcfac107
+  data.tar.gz: 530878cf7a14eb7df626f0a217504191ac71b9e9
 SHA512:
-  metadata.gz: e395186471d0f9aed09151479774adeb0379e2874bbe254b28b7816dc62c48a1e93fe82a819356c3fb686e75773329bf101c000e7e742b9e148535963edc050d
-  data.tar.gz: 56ea33dc1ea15a7c89b6ef55eeea83987fd8708aa6922017acc283d4817ef04e2d93b2e14a29698369258788ccf2e466852cffe832e2adcb47953514c91e93ca
+  metadata.gz: 16e32450d1be03d673810b4e81e189ff8d910333958022b8565e86064b80409ddd2497c38d63b8bae8766a3ce93a7435510f13d5db21ccb1eeb2e8778d4ad83f
+  data.tar.gz: 3caa4d26b30b57c3026eeaf143546c606bd5a4703478aca7a1f8909399b79d3707c4a08e7df65d4554e3098ead3f30be023ef980801194b8458518202c468583

data/README.md

@@ -1,43 +1,143 @@
-# UserTrackers
+# User trackers 
+
+user_trackers is a ruby gem for tracking user's activity on a ruby on rails app using [Mixpanel](https://github.com/mixpanel/mixpanel-ruby), [Intercom](https://github.com/intercom/intercom-ruby), [Slack](https://github.com/slack-ruby/slack-ruby-client) and app's database. 
+
+If desired, the gem may track **guest users** and associate their activity to authenticated users when used with **cookies**. The gem can be executed using [sidekiq](https://github.com/mperham/sidekiq)  or [resque](https://github.com/resque/resque).
+
+# Installation
+
+Add the following line to your Gemfile:
+
+    gem 'user_trackers'
+
+Then run `bundle install`
+
+Next, run the generator:
+
+    rails generate user_trackers:install
+
+The generator will create:
+
+- Configuration files in **config/initializers/user_trackers/**
+- Configuration file **config/user_trackers.yml**
+- `UserEvent` model and associated migration file
+
+After running the generator you need to run the migration associated to `UserEvent`
+
+    rails db:migrate
+
+# Editing configuration files
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/user_trackers`. To experiment with that code, run `bin/console` for an interactive prompt.
+## YML file
 
-TODO: Delete this and the text above, and describe your gem
+API Tokens related to [Mixpanel](https://github.com/mixpanel/mixpanel-ruby), [Intercom](https://github.com/intercom/intercom-ruby) and [Slack](https://github.com/slack-ruby/slack-ruby-client) may be set considering **development**, **test** and **production** rails environments.
 
-## Installation
+**user_trackers.yml** provides the following options:
 
-Add this line to your application's Gemfile:
+    development:
+      ignore_events: ['ignored_event_name']
+      # queue_adapter: sidekiq
+      mixpanel:
+        token: <%= ENV["DEV_MIXPANEL_TOKEN"] %>
+        ignore_events: []
+      intercom:
+        token: <%= ENV['DEV_INTERCOM_TOKEN'] %>
+        ignore_events: []
+      slack:
+        token: <%= ENV['DEV_SLACK_TOKEN'] %>
+        activity_channel: <%= ENV['DEV_SLACK_ACTIVITY_CHANNEL'] %>
+        ignore_events: []
+      db:
+        ignore_events: []
+    
+    production:
+      ignore_events: ['ignored_event_name']
+      queue_adapter: resque
+      mixpanel:
+        token: <%= ENV["MIXPANEL_TOKEN"] %>
+      intercom:
+        token: <%= ENV['INTERCOM_TOKEN'] %>
+        ignore_events: ['test_event']
+      slack:
+        token: <%= ENV['SLACK_TOKEN'] %>
+        activity_channel: <%= ENV['SLACK_ACTIVITY_CHANNEL'] %>
+        ignore_events: []
+      db:
+        ignore_events: []
+    
+    test:
+      ignore_events: ['ignored_event_name']
+      mixpanel:
+        token: <%= ENV["TEST_MIXPANEL_TOKEN"] %>
+        ignore_events: []
+      intercom:
+        token: <%= ENV['TEST_INTERCOM_TOKEN'] %>
+        ignore_events: []
+      slack:
+        token: <%= ENV['TEST_SLACK_TOKEN'] %>
+        activity_channel: <%= ENV['TEST_SLACK_ACTIVITY_CHANNEL'] %>
+        ignore_events: []
+      db:
+        ignore_events: []
 
-```ruby
-gem 'user_trackers'
-```
+You may ignore events per environment or per tracker. For running trackers on a background job, specify a `queue_adapter` option with a value of `resque` or `sidekiq` 
 
-And then execute:
+## Configuration files for trackers
 
-    $ bundle
+ 
 
-Or install it yourself as:
+**config/initializers/user_trackers/** will contain configuration files with blocks for customizing `user` and `event` attributes according to your app's datamodel. Configuration blocks will have this form:
 
-    $ gem install user_trackers
+    UserTrackers.configure_mixpanel do |config|
+      def config.user_attributes(user_id, event_name, event_attributes = {}, anonymous_id)
+        user = User.find(user_id)
+        {
+          '$first_name': user.first_name,
+          '$last_name': user.last_name,
+          '$email': user.email, 
+          '$test': 'test_value2' 
+        }
+      end
+    
+      def config.event_attributes(user_id, event_name, event_attributes = {}, anonymous_id)
+        event_attributes
+      end
+    end
 
-## Usage
+# Usage
 
-TODO: Write usage instructions here
+You may call `UserTrackers.track` in your rails app or use clients related to each of the gem's trackers.
 
-## Development
+## Track method
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+The track method must be called with a **hash** as a parameter and may be called with an optional parameter that should be related to rails' `session` 
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/user_trackers. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the UserTrackers project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/user_trackers/blob/master/CODE_OF_CONDUCT.md).
+**Example:**
+
+    UserTrackers.track({
+    	user_id:9, 
+    	event_name:'publish_post', 
+    	event_attributes:{ title:'Post title', description:'new post'} 
+    }, 
+    session
+  )
+
+You may call the track method with or without a `user_id` parameter. An `anonymous_id` will be generated in case no `user_id` is specified.
+
+If `session` is specified then the gem will use cookies to track **guest users**.
+
+## Tracker clients
+
+You may also use the gem calling methods related to [Mixpanel](https://github.com/mixpanel/mixpanel-ruby), [Intercom](https://github.com/intercom/intercom-ruby) and [Slack](https://github.com/slack-ruby/slack-ruby-client) gems.
+
+**Mixpanel Example:**
+
+    UserTrackers::MixpanelTracker.client.track('User1', 'A Mixpanel Event')
+
+**Intercom Example:**
+
+    UserTrackers::IntercomTracker.client.users.find(email: "bob@example.com")
+
+**Slack Example:**
+
+    UserTrackers::SlackTracker.client.chat_postMessage(channel: '#general', text: 'Hello World', as_user: true)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: user_trackers
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Camilo Barraza
@@ -161,7 +161,7 @@ homepage:
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/camilo-barraza/user_trackers
+  source_code_uri: https://github.com/flatironsdevelopment/user_trackers
 post_install_message: 
 rdoc_options: []
 require_paths: