user_trackers 0.0.1 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45254bd500709a6f99312f7c71f347d032fae676
-  data.tar.gz: daf9b64ed846830ee912a80ab06ef2370ec8de56
+  metadata.gz: bfe6207e035cb0d31d361fc360d07d94ec143547
+  data.tar.gz: a07c0bd5fa054535613897abf0d8c8328d209637
 SHA512:
-  metadata.gz: f7ac6a9f98d9b621d100a0513a6a2455557ba1959ca87ebc36a82435e3de93a1be8c85d320461bcce8d89c2debda286400fc18efc9146a9b1c938cb0ede3d191
-  data.tar.gz: 47809b292fe84f0d4e8c632ed7e5f17c1f0eff2fc7c1ee6025e18ffc9c9a1e461e33716209479283a25bb00acebf4755e67db900e0d025b3d5e05d0bc4754360
+  metadata.gz: 66cee611f10f450cf1b2f73259de9eb692f7887fbd8ab251dd3d6e4e4ecb93bdf1c30dbf6e90d09ef1ea2843b26b579fb78c3802b8f32dcfb748ee2e045b56c9
+  data.tar.gz: c06321d42df1a6514289e7478a0a960298e04f52b3f9cd5afcf968f6d0684327662876ce4c53ba00e05fc12d0e45e894b79943b9cf9bf362591f8142bad639af

data/lib/generators/templates/configure_intercom.rb

@@ -0,0 +1,22 @@
+UserTrackers.configure_intercom do |config|
+  def config.user_attributes(user_id, event_name, event_attributes = {}, anonymous_id)
+    user = User.find(user_id)
+    {
+      user_id: user_id,
+      email: user.email,
+      name: user.full_name,
+      phone: user.phone_number
+    }
+  end
+
+  def config.event_attributes(user_id, event_name, event_attributes = {}, anonymous_id)
+    user = User.find(user_id)
+    {
+      user_id: user_id,
+      event_name: event_name,
+      email: user.email,
+      created_at: Time.now.to_i,
+      metadata: event_attributes&.first(5).to_h || {}
+    }
+  end
+end

data/lib/generators/templates/configure_mixpanel.rb

@@ -0,0 +1,14 @@
+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, 
+    }
+  end
+
+  def config.event_attributes(user_id, event_name, event_attributes = {}, anonymous_id)
+    event_attributes
+  end
+end

data/lib/generators/templates/configure_slack.rb

@@ -0,0 +1,15 @@
+UserTrackers.configure_slack do |config|
+  def config.message_for_event(user_id, event_name, event_attributes = {}, anonymous_id)
+    user = User.find(user_id) if user_id.present?
+    user_name = user.present? ? user.full_name : "An anonymous person with id #{anonymous_id || ''}"
+
+    case event_name
+    when event_name == 'user_registered' || event_name == 'user_updated_info'
+      messages = ["A user #{user.full_name} (#{user.email}) either registered or updated their info."]
+      messages << ["They are being connected with anonymous_id #{anonymous_id}."] if anonymous_id
+      messages.join(" ")
+    else
+      "*#{user_name}* performed event `#{event_name}`. Associated data: `#{event_attributes}`"
+    end
+  end
+end

data/lib/generators/user_trackers/install_generator.rb

@@ -3,16 +3,18 @@ module UserTrackers
     source_root File.expand_path('../templates', __dir__)
 
     def create_configuration_files
-      copy_file "user_trackers.rb", "config/initializers/user_trackers.rb"
+      UserTrackers.trackers.each do |tracker|
+        copy_file "configure_#{tracker}.rb", "config/initializers/user_trackers/configure_#{tracker}.rb"
+      end
       copy_file "user_trackers.yml", "config/user_trackers.yml"
     end
 
     def generate_model
       invoke "active_record:model", ['UserEvent', [
-        "user_id:integer:index", 
+        "user_id:string:index", 
+        "anonymous_id:string",
         "event_name:string:index",
-        "event_details:json",
-        "anonymous_id:integer"
+        "event_attributes:json"
       ]], migration: true
     end
   end 

data/lib/user_trackers.rb

@@ -1,54 +1,84 @@
+require 'sidekiq'
+require 'resque'
+require 'mixpanel-ruby'
+require 'intercom'
+require 'uuid'
+require 'slack-ruby-client'
+
 require "user_trackers/configuration"
 require "user_trackers/mixpanel_tracker"
 require "user_trackers/intercom_tracker"
 require "user_trackers/slack_tracker"
-
-require 'mixpanel-ruby'
-require 'intercom'
-require 'slack-ruby-client'
+require "user_trackers/workers/sidekiq_worker"
+require "user_trackers/workers/resque_worker"
 
 module UserTrackers
-
   class << self
     attr_accessor :options
   end
 
+  TRACKERS = ['mixpanel','intercom','slack']
+  def self.trackers
+    TRACKERS
+  end
+
   def self.options
     @options ||= Configuration.get_yml_options
   end
   
-  def self.configure_mixpanel
-    yield(MixpanelTracker)
-  end
-
-  def self.configure_slack
-    yield(SlackTracker)
-  end
-
-  def self.configure_intercom
-    yield(IntercomTracker)
-  end
-
   def self.ignore_event?(event_name, tracker = nil)
-    ignore_events = tracker ? options[Rails.env.to_sym][tracker][:ignore_events] : options[Rails.env.to_sym][:ignore_events]
+    ignore_events = tracker ? options[Rails.env.to_sym][tracker][:ignore_events] || [] : options[Rails.env.to_sym][:ignore_events] || []
     ignore_events.include?(event_name) || ignore_events.include?('*')
   end
 
-  def self.track(user_id, event_name, event_attributes = {}, anonymous_id = nil)
-    if(!ignore_event? (event_name))
-      if(!ignore_event?(event_name, :db))
-        UserEvent.create(user_id: user_id, event_name: event_name, event_details: event_attributes, anonymous_id: anonymous_id) 
-      end
-      if(!ignore_event?(event_name, :mixpanel))
-        MixpanelTracker.track(user_id, event_name, event_attributes, anonymous_id)
+  def self._track(params)
+    if !ignore_event? params['event_name']
+      if !options[Rails.env.to_sym][:db] || !ignore_event?(params['event_name'], :db)
+        UserEvent.create(
+          anonymous_id: params['anonymous_id'],
+          event_name:'logged_in_as', 
+          event_attributes:{ user_id: params['user_id'] }
+        )  if params['user_logged_in']
+        UserEvent.create(params.except('user_logged_in')) 
       end
-      if(!ignore_event?(event_name, :intercom))
-        IntercomTracker.track(user_id, event_name, event_attributes, anonymous_id)
+      trackers.each do |tracker|
+        if options[Rails.env.to_sym][tracker.to_sym]
+          if !ignore_event?(params['event_name'], tracker.to_sym)
+            eval("#{tracker.capitalize}Tracker.track(params)")
+          end
+        end
       end
-      if(!ignore_event?(event_name, :slack))
-        SlackTracker.track(user_id, event_name, event_attributes, anonymous_id)
+    end
+  end
+
+  def self.track(params, session = nil)
+    if session
+      if params[:user_id] && session['anonymous_id']
+        params[:user_logged_in] = true
+        params[:anonymous_id] = session['anonymous_id']
+        session.delete('anonymous_id')
+      elsif !params[:user_id]
+        session['anonymous_id'] ||= UUID.new.generate
+        params[:anonymous_id] = session['anonymous_id']
       end
     end
+    params[:anonymous_id] ||= UUID.new.generate
+
+    # for usage with sidekiq and resque
+    params = params.as_json
+
+    if options[Rails.env.to_sym][:queue_adapter] == 'sidekiq'
+      SidekiqWorker.perform_async(params) 
+    elsif options[Rails.env.to_sym][:queue_adapter] == 'resque'
+      Resque.enqueue(RescueWorker, params)
+    else 
+      _track(params)
+    end
   end
+end
 
+UserTrackers.trackers.each do |tracker|
+  UserTrackers.module_eval("def self.configure_#{tracker}
+    yield(#{tracker.capitalize}Tracker)
+  end")
 end

data/lib/user_trackers/intercom_tracker.rb

@@ -9,9 +9,36 @@ module UserTrackers
       @client ||= Intercom::Client.new(token: opts[Rails.env.to_sym][:intercom][:token])
     end
   
-    def self.track(user_id, event_name, event_attributes = {}, anonymous_id = nil)
-      client.users.create(user_attributes(user_id, event_name, event_attributes, anonymous_id))
-      client.events.create(event_attributes(user_id, event_name, event_attributes, anonymous_id))
+    def self.track(params)
+      user_id, event_name, event_attributes, anonymous_id, user_logged_in = params.values_at('user_id', 'event_name', 'event_attributes', 'anonymous_id', 'user_logged_in')
+      user_id = user_id.to_s if user_id
+      if user_id
+        client.users.create(user_attributes(user_id, event_name, event_attributes, anonymous_id))
+        client.events.create(event_attributes(user_id, event_name, event_attributes, anonymous_id))
+        if user_logged_in
+          contact_list = client.contacts.find(email: anonymous_id)
+          if !contact_list.contacts.empty?
+            contact_list.contacts.each do |contact|
+              lead = client.contacts.find(id: contact['id'])
+              client.contacts.convert(lead, Intercom::User.new(user_id: user_id))
+            end
+          end
+        end
+      else
+        contact_list = client.contacts.find(email: anonymous_id)
+        if contact_list.contacts.empty?
+          contact = client.contacts.create(email: anonymous_id)
+          id = contact.id
+        else
+          id = contact_list.contacts.first['id']
+        end
+        client.events.create( {
+          id: id,
+          event_name: event_name || "undefined_event",
+          created_at: Time.now.to_i,
+          metadata: event_attributes&.first(5).to_h || {},
+        })
+      end
     end
   end
 end

data/lib/user_trackers/mixpanel_tracker.rb

@@ -9,13 +9,15 @@ module UserTrackers
       @client ||= Mixpanel::Tracker.new(opts[Rails.env.to_sym][:mixpanel][:token])
     end
   
-    def self.track(user_id, event_name, event_attributes = {}, anonymous_id = nil)
-      client.people.set(user_id, user_attributes(user_id, event_name, event_attributes, anonymous_id))
+    def self.track(params)
+      user_id, event_name, event_attributes, anonymous_id, user_logged_in = params.values_at('user_id', 'event_name', 'event_attributes', 'anonymous_id', 'user_logged_in')
+      client.alias(user_id, anonymous_id) if user_logged_in
+      client.people.set(user_id, user_attributes(user_id, event_name, event_attributes, anonymous_id)) if user_id
       client.track(
         user_id || anonymous_id, 
-        event_name || "", 
+        event_name || "undefined_event", 
         event_attributes(user_id, event_name, event_attributes, anonymous_id) || {}
-      ) 
+      )
     end
   end
 end

data/lib/user_trackers/slack_tracker.rb

@@ -17,7 +17,14 @@ module UserTrackers
       @client
     end
   
-    def self.track(user_id, event_name, event_attributes = {}, anonymous_id = nil)
+    def self.track(params)
+      user_id, event_name, event_attributes, anonymous_id, user_logged_in = params.values_at('user_id', 'event_name', 'event_attributes', 'anonymous_id', 'user_logged_in')
+      if user_logged_in
+        client.chat_postMessage(
+          channel: @activity_channel,
+          text: "An anonymous person with id *#{anonymous_id}* `logged in as` user with id *#{user_id}*"
+        )
+      end
       client.chat_postMessage(
         channel: @activity_channel,
         text: message_for_event(user_id, event_name, event_attributes, anonymous_id)

data/lib/user_trackers/workers/resque_worker.rb

@@ -0,0 +1,11 @@
+module UserTrackers
+  class RescueWorker
+    @queue = :user_events_queue
+
+    def self.perform(params)
+      UserTrackers._track(params)
+    end
+  end
+end
+
+

data/lib/user_trackers/workers/sidekiq_worker.rb

@@ -0,0 +1,9 @@
+module UserTrackers
+  class SidekiqWorker
+    include Sidekiq::Worker
+
+    def perform(params)
+      UserTrackers._track(params)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: user_trackers
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.10
 platform: ruby
 authors:
 - Camilo Barraza
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mixpanel-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: user trackers gem
 email: cbarraza11@gmail.com
 executables: []
@@ -103,13 +145,17 @@ files:
 - README.md
 - bin/console
 - bin/setup
-- lib/generators/templates/user_trackers.rb
+- lib/generators/templates/configure_intercom.rb
+- lib/generators/templates/configure_mixpanel.rb
+- lib/generators/templates/configure_slack.rb
 - lib/generators/user_trackers/install_generator.rb
 - lib/user_trackers.rb
 - lib/user_trackers/configuration.rb
 - lib/user_trackers/intercom_tracker.rb
 - lib/user_trackers/mixpanel_tracker.rb
 - lib/user_trackers/slack_tracker.rb
+- lib/user_trackers/workers/resque_worker.rb
+- lib/user_trackers/workers/sidekiq_worker.rb
 homepage: https://rubygems.org/gems/user_trackers
 licenses:
 - MIT

data/lib/generators/templates/user_trackers.rb

@@ -1,2 +0,0 @@
-
-#coletera mix