Adding more metrics likes topic tags

Author: smasry

README.md

@@ -7,7 +7,9 @@ Emits user events to segment.io
 * User identify
 * User Track "Signed Up"
 * User Track "Post Created"
+* User Track "Post Liked"
 * User Track "Topic Created"
+* User Track "Topic Tag Created"
 * User Page View
 
 # Usage
@@ -20,22 +22,6 @@ Watch Tutorial Video: https://youtu.be/AKR3ki9Kj38
 
 In segment.io you will need a `ruby` source to receive the incoming events.
 
-To install using docker, add the following to your `app.yml` in the plugins section:
-
-    env:
-      SEGMENT_IO_KEY: xxx
-    hooks:
-      after_code:
-        - exec:
-            cd: $home/plugins
-            cmd:
-              - git clone https://github.com/kylewelsby/discourse-segment-io-plugin.git
-
-and rebuild your docker via
-
-    cd /var/discourse
-    ./launcher rebuild app
-
 # Contributing
 
 Please see [CONTRIBUTING.md](/CONTRIBUTING.md).

config/locales/server.en.yml

@@ -0,0 +1,4 @@
+en:
+  site_settings:
+    segment_io_enabled: "Is Segment IO enabled?"
+    segment_io_write_key: 'What is the segment io write key?'

config/settings.yml

@@ -0,0 +1,7 @@
+plugins:
+  segment_io_enabled:
+    default: false
+    client: false
+  segment_io_write_key:
+    default: ''
+    client: false

plugin.rb

@@ -6,22 +6,28 @@
 gem 'commander', '4.4.0' # , require: false # for analytics-ruby
 gem 'analytics-ruby', '2.2.2', require: false # 'segment/analytics'
 
+enabled_site_setting :segment_io_enabled
+
 after_initialize do
   require 'segment/analytics'
 
-  SEGMENT_IO_KEY = ENV['SEGMENT_IO_KEY']
-  unless SEGMENT_IO_KEY
-    raise StandardError, 'Segment.io WriteKey must be defined as an environment variable  `export SEGMENT_IO_KEY={YOUR_KEY_HERE}`'
+  class Analytics
+    def self.method_missing(method, *args)
+      return unless SiteSetting.segment_io_enabled
+      analytics = Segment::Analytics.new(
+        write_key: SiteSetting.segment_io_write_key
+      )
+      super(method, *args) unless analytics.respond_to?(method)
+      analytics.send(method, *args)
+      analytics.flush
+    end
   end
-  Analytics = Segment::Analytics.new(
-    write_key: SEGMENT_IO_KEY,
-    on_error: proc { |_status, msg| print msg }
-  )
 
   require_dependency 'jobs/base'
   module ::Jobs
     class EmitSegmentUserIdentify < Jobs::Base
       def execute(args)
+        return unless SiteSetting.segment_io_enabled?
         user = User.find_by_id(args[:user_id])
         user.emit_segment_user_identify if user
       end
@@ -36,14 +42,16 @@ def execute(args)
   class ::User
     after_create :emit_segment_user_identify
     after_create :emit_segment_user_created
+
     def emit_segment_user_identify
       Analytics.identify(
         user_id: id,
         traits: {
           name: name,
           username: username,
           email: email,
-          created_at: created_at
+          created_at: created_at,
+          internal: email.ends_with?('@pagerduty.com')
         },
         context: {
           ip: ip_address
@@ -62,6 +70,14 @@ def emit_segment_user_created
   require_dependency 'application_controller'
   class ::ApplicationController
     before_filter :emit_segment_user_tracker
+
+    SEGMENT_IO_EXCLUDES = {
+      'stylesheets' => :all,
+      'user_avatars' => :all,
+      'about' => ['live_post_counts'],
+      'topics' => ['timings']
+    }.freeze
+
     def emit_segment_user_tracker
       if current_user && !segment_common_controller_actions?
         Analytics.page(
@@ -79,7 +95,9 @@ def emit_segment_user_tracker
     end
 
     def segment_common_controller_actions?
-      controller_name == 'stylesheets' || controller_name == 'user_avatars' || (controller_name == 'about' && action_name == 'live_post_counts')
+      SEGMENT_IO_EXCLUDES.keys.include?(controller_name) &&
+      (SEGMENT_IO_EXCLUDES[controller_name] == :all ||
+       SEGMENT_IO_EXCLUDES[controller_name].include?(action_name) )
     end
   end
 
@@ -92,9 +110,11 @@ def emit_segment_post_created
         user_id: user_id,
         event: 'Post Created',
         properties: {
-          slug: topic.slug,
-          title: topic.title,
-          url: topic.url
+          topic_id: topic_id,
+          post_number: post_number,
+          created_at: created_at,
+          since_topic_created: (created_at - topic.created_at).to_i,
+          reply_to_post_number: reply_to_post_number
         }
       )
     end
@@ -116,4 +136,36 @@ def emit_segment_topic_created
       )
     end
   end
+
+  require_dependency 'topic_tag'
+  class ::TopicTag
+    after_create :emit_segment_topic_tagged
+
+    def emit_segment_topic_tagged
+      Analytics.track(
+        anonymous_id: -1,
+        event: 'Topic Tag Created',
+        properties: {
+          topic_id: topic_id,
+          tag_name: tag.name
+        }
+      )
+    end
+  end
+
+  require_dependency 'user_action'
+  class ::UserAction
+    after_create :emit_segment_post_liked, if: -> { self.action_type == UserAction::LIKE }
+
+    def emit_segment_post_liked
+      Analytics.track(
+        user_id: user_id,
+        event: 'Post Liked',
+        properties: {
+          post_id: target_post_id,
+          topic_id: target_topic_id
+        }
+      )
+    end
+  end
 end