lita-mixpanel 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4350d8ac4092933f474c9d3e7443299175cc3dfa
+  data.tar.gz: 2c523417c98b9c5b195531d1a11470c36bf43d20
+SHA512:
+  metadata.gz: f94824cdcab78fb0c7238445dbc6afb6ae6d49f4e1ea3952c9b8e340a6e797f5d967665881921cdaa62707afc638cff432ed04615c37b00f1819a15023e41569
+  data.tar.gz: 6b1637ec37d0451f0c687c1e7b4ff9056ef066172dea566346714ea6bda9503b384606b2a5e7a161189c7920d50b0fe2ea6334e97a2327a1eb971737a584a2f5

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,47 @@
+# lita-mixpanel
+
+**lita-mixpanel** is a handler for [Lita](https://github.com/jimmycuadra/lita) that provides current KPI information from mixpanel
+
+## Installation
+
+Add lita-mixpanel to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-mixpanel"
+```
+
+
+## Configuration
+
+This plugin requires a working mixpanel account & api_key & api_secret. FUNNEL_ID can be obtained from the mixpanel dashboard (see id url). FUNNEL_NAME is arbitrary and for display purpuses only.
+
+``` ruby
+  config.handlers.mixpanel.api_key = 'MIXPANEL_API_KEY'
+  config.handlers.mixpanel.api_secret = 'MIXPANEL_API_SECRET'
+  config.handlers.mixpanel.funnels = {
+    "FUNNEL_ID" =>"FUNNEL_NAME",
+  }
+```
+
+## Usage
+
+```
+Lita: mixpanel funnels
+
+---
+Funnel performance for: FUNNEL_NAME
+2015-06-12 CR=2.26%   8/354
+2015-06-13 CR=3.88%   19/490
+2015-06-14 CR=2.61%   17/651
+2015-06-15 CR=2.61%   21/804
+2015-06-16 CR=4.58%   28/611
+2015-06-17 CR=2.44%   11/450
+2015-06-18 CR=4.49%   12/267
+2015-06-19 CR=0.00%   0/13 <- today
+--------------------
+TOTAL      CR=3.19%   116/3640
+```
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/lita-mixpanel.rb

@@ -0,0 +1,12 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/handlers/mixpanel"
+
+Lita::Handlers::Mixpanel.template_root File.expand_path(
+  File.join("..", "..", "templates"),
+ __FILE__
+)

data/lib/lita/handlers/mixpanel.rb

@@ -0,0 +1,49 @@
+require 'mixpanel_stats'
+
+module Lita
+  module Handlers
+    class Mixpanel < Handler
+
+      def self.default_config(config)
+        config.api_key = nil
+        config.api_secret = nil
+        config.funnels = nil
+      end
+
+      route %r{(mixpanel)}i,
+        :funnels_stats,
+        command: true,
+        help: {
+          "mixpanel funnels" => "gets recent funnels performance from mixpanel"}
+
+      def funnels_stats(response)
+        (funnels || []).each do |id, name|
+          funnel_stats = generate_funnel_stats(id)
+          msg = "Funnel performance for: #{name}\n"
+          msg << funnel_stats
+          response.reply "/code " + msg
+        end
+      end
+
+      def generate_funnel_stats(funnel_id)
+        to = Date.today
+        from = Date.today - 7
+        mixpanel.funnel_chart(funnel_id, from, to)
+      end
+
+      def mixpanel
+        @mixpanel ||= MixpanelStats.new(
+          Lita.config.handlers.mixpanel.api_key,
+          Lita.config.handlers.mixpanel.api_secret,
+        )
+      end
+
+      def funnels
+        Lita.config.handlers.mixpanel.funnels
+      end
+
+    end
+
+    Lita.register_handler(Mixpanel)
+  end
+end

data/lib/mixpanel_stats.rb

@@ -0,0 +1,107 @@
+require 'mixpanel_client'
+
+class MixpanelStats
+  def initialize(key, secret)
+    @key, @secret = key, secret
+  end
+
+  def funnel_chart(funnel_id, from, to)
+    chart_data = funnel_data(funnel_id, from, to)
+    chart = FunnelChart.new(chart_data)
+    chart.to_s
+  end
+  protected
+
+  def funnel_data(funnel_id, from, to)
+    from = from.iso8601 if from.is_a?(Date)
+    to = to.iso8601 if to.is_a?(Date)
+
+    client.request("funnels/",
+                   funnel_id: funnel_id,
+                   from_date: from,
+                   to_date: to,
+                  )
+  end
+
+  def client
+    @client ||= Mixpanel::Client.new(
+      api_key: @key,
+      api_secret: @secret
+    )
+  end
+end
+
+class FunnelChart
+
+  # data example:
+  # {"meta"=>{"dates"=>["2015-05-17"]},
+  #  "data"=>{
+  #   "2015-05-17"=>
+  # {"steps"=>[
+  #   {"count"=>579,
+  #    "step_conv_ratio"=>1,
+  #    "goal"=>"Landing page view",
+  #    "overall_conv_ratio"=>1,
+  #    "avg_time"=>nil,
+  #    "event"=>"Landing page view"},
+  #    {"count"=>9,
+  #     "step_conv_ratio"=>0.015544041450777202,
+  #     "goal"=>"Download page view",
+  #     "overall_conv_ratio"=>0.015544041450777202,
+  #     "avg_time"=>211, "event"=>"Download page view"
+  # }
+  # ],
+  #   "analysis"=>{
+  #   "completion"=>9,
+  #   "starting_amount"=>579,
+  #   "steps"=>2,
+  #   "worst"=>1}
+  # }}}
+  def initialize(mixpanel_data)
+    @dates = mixpanel_data['meta']['dates']
+    @data = mixpanel_data['data']
+  end
+
+  def to_s
+    stats = []
+    parts = @dates.map do |date|
+      stat = date_stats(date)
+      stats << stat
+      line = format_line(date, stat)
+      line << " <- today" if date == Date.today.iso8601
+      line
+    end
+    parts << "-"*20
+    parts << format_line("TOTAL     ", calc_totals(stats))
+    parts.join("\n")
+  end
+
+  def calc_totals(stats)
+    total_completion, total_start = 0,0,0
+    stats.each do |_, completion, start|
+      total_completion += completion
+      total_start += start
+    end
+    total_cr = total_completion.to_f/total_start.to_f
+    return [total_cr, total_completion, total_start]
+  end
+
+  def date_stats(date)
+    stats = @data[date]
+    analysis = stats['analysis']
+    start = analysis['starting_amount']
+    completion = analysis['completion']
+    cr = completion.to_f / start.to_f
+    [cr, completion, start]
+  end
+
+  def format_line(title, stats)
+    cr, completion, start = stats
+    "#{title} CR=#{percent(cr)}   #{completion}/#{start}"
+  end
+
+  def percent(float)
+    "%.2f%" %  (float * 100)
+  end
+
+end

data/lita-mixpanel.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-mixpanel"
+  spec.version       = "0.2.0"
+  spec.authors       = ["Eugen Martin"]
+  spec.email         = ["eugeniusmartinus@gmail.com"]
+  spec.description   = "a mixpanl plugin for lita chat-bot"
+  spec.summary       = "Is a handler for [Lita](https://github.com/jimmycuadra/lita) that provides current KPI information from mixpanel"
+  spec.homepage      = "https://github.com/olgen/lita-mixpanel"
+  spec.license       = "http://opensource.org/licenses/MIT"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "lita", ">= 4.4"
+  spec.add_runtime_dependency "mixpanel_client", ">= 4.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    handlers:
+      mixpanel:

data/spec/lita/handlers/mixpanel_spec.rb

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+describe Lita::Handlers::Mixpanel, lita_handler: true do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "lita-mixpanel"
+require "lita/rspec"
+
+# A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
+# was generated with Lita 4, the compatibility mode should be left disabled.
+Lita.version_3_compatibility_mode = false

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: lita-mixpanel
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Eugen Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: mixpanel_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: a mixpanl plugin for lita chat-bot
+email:
+- eugeniusmartinus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/lita-mixpanel.rb
+- lib/lita/handlers/mixpanel.rb
+- lib/mixpanel_stats.rb
+- lita-mixpanel.gemspec
+- locales/en.yml
+- spec/lita/handlers/mixpanel_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/olgen/lita-mixpanel
+licenses:
+- http://opensource.org/licenses/MIT
+metadata:
+  lita_plugin_type: handler
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Is a handler for [Lita](https://github.com/jimmycuadra/lita) that provides
+  current KPI information from mixpanel
+test_files:
+- spec/lita/handlers/mixpanel_spec.rb
+- spec/spec_helper.rb