exvo-metrics 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ea8d1df1bf7a8409baaea2073ca5e6397624c2b
+  data.tar.gz: 5adae841e1f74b2b99f29625f99cdf66c3058e06
+SHA512:
+  metadata.gz: 11876d600ac2f06d9ce2dc00094454e3739ba50ef7b3f8555fe525be283b6c5e724460ccbe9e24990d6b7fb84a138d1da18e8c6b59e79ba0745cd65f82988288
+  data.tar.gz: 17cdd0a918c532a9b17d83b1ae02d37a99b6ad48eeec8d401fcef15a74a4b73ca1307d3fab8a9b42efa9dfe7bbde5fb4b595fdea4c2ec0ab9b0bd30b02036546

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in exvo-metrics.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright © 2013 Exvo.com Development BV
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# Exvo::Metrics
+
+Wrapper class/gem for the Mixpanel metrics system. It is configured to be used together with the `Mixpanel::Middleware` Rack middleware so that the tracking requests are sent asynchronously via client-side Javascript to the Mixpanel site.
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'exvo-metrics'
+```
+
+
+Then execute:
+
+```bash
+$ bundle
+```
+
+
+In your `ApplicationController`:
+
+```ruby
+def metrics
+  @metrics ||= Exvo::Metrics.new(current_user, request)
+end
+```
+
+
+In `config/environments/production.rb`:
+
+```ruby
+config.middleware.use "Mixpanel::Middleware", ENV['MIXPANEL_API_TOKEN'], { persist: true }
+```
+
+You can also add the above line to any environemnt you want (staging, development, etc.).
+
+Remember to set the `ENV['MIXPANEL_API_TOKEN']` as well!
+
+
+
+## Usage
+
+Add the following tracking code in one of your controllers:
+
+```ruby
+ metrics.track 'Profile update'
+```
+
+
+You can also pass some custom params, which will be visible in the Mixpanel dashboard:
+
+```ruby
+ metrics.track 'Profile update', Type: 'Normal flow'
+```
+
+
+If there is a situation, where `current_user` might be nil (as is the case during sign up process), you ca explicitly identify such user after you have a user record created in the database:
+
+```ruby
+ metrics.identify(user)
+ metrics.track 'Sign un'
+```
+
+
+
+## Caveats
+
+Since the actual tracking is happening via client-side javascript calls, there might be a situation, when you track something in the controller, but after that there is a redirect to another website. In such situation the metric might not be recorded properly (it is usually the case with Exvo-Auth and signing in).
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+
+Copyright © 2013 Exvo.com Development BV, released under the MIT license

data/Rakefile

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

data/exvo-metrics.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exvo/metrics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "exvo-metrics"
+  spec.version       = Exvo::Metrics::VERSION
+  spec.authors       = ["Paweł Gościcki"]
+  spec.email         = ["pawel.goscicki@gmail.com"]
+  spec.description   = "Metrics wrapper for Exvo apps."
+  spec.summary       = "Wrapper gem for tracking usage metrics in Exvo apps."
+  spec.homepage      = "https://github.com/Exvo/exvo-metrics"
+  spec.license       = "MIT"
+
+  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_dependency 'mixpanel'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'rb-fsevent'
+  spec.add_development_dependency 'rb-inotify'
+end

data/lib/exvo/dummy_metrics.rb

@@ -0,0 +1,7 @@
+module Exvo
+  class DummyMetrics
+    def method_missing(method, *args, &block)
+      true
+    end
+  end
+end

data/lib/exvo/metrics/version.rb

@@ -0,0 +1,5 @@
+module Exvo
+  class Metrics
+    VERSION = "0.0.1"
+  end
+end

data/lib/exvo/metrics.rb

@@ -0,0 +1,74 @@
+require 'exvo/metrics/version'
+require 'exvo/dummy_metrics'
+require 'mixpanel'
+
+module Exvo
+
+  class Metrics
+
+    def initialize(user, request)
+      @user, @request = user, request
+    end
+
+    def identify(user)
+      @user = user
+      append_identification
+    end
+
+    def track(event_name, properties = {})
+      append_identification unless identified?
+      metrics_platform.append_track(event_name, properties)
+    end
+
+    def method_missing(method, *args, &block)
+      metrics_platform.public_send(method, *args, &block)
+    end
+
+    private
+
+    def metrics_platform
+      @metrics_platform ||=
+        if defined?(Rails) && Rails.application.config.middleware.include?("Mixpanel::Middleware")
+          Mixpanel::Tracker.new(ENV['MIXPANEL_API_TOKEN'], { env: @request.env, persist: true })
+        else
+          Exvo::DummyMetrics.new
+        end
+    end
+
+    def identified?
+      @identified
+    end
+
+    def append_identification
+      # identify the user
+      metrics_platform.append_identify(@user.nickname)
+
+      # name this user in Stream view
+      metrics_platform.append("name_tag", @user.nickname)
+
+      # set properties of this user
+      metrics_platform.append_set(user_properties)
+
+      mark_as_identified
+    end
+
+    def user_properties
+      {
+        id: @user.id,
+        email: @user.email,
+        first_name: @user.first_name,
+        last_name: @user.last_name,
+        username: @user.nickname,
+        theme: @user.theme,
+        country_code: @user.country_code,
+        created: @user.created_at
+      }
+    end
+
+    def mark_as_identified
+      @identified = true
+    end
+
+  end
+
+end

data/spec/exvo/dummy_metrics_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Exvo::DummyMetrics do
+
+  let(:dummy) { Exvo::DummyMetrics.new }
+
+  it 'responds true to any method' do
+    dummy.track('Sign up').should be_true
+  end
+
+  it 'responds true to any method with any params' do
+    dummy.track('Sign up', Type: 'via Facebook').should be_true
+  end
+
+end

data/spec/exvo/metrics_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Exvo::Metrics do
+
+  let(:user) { OpenStruct.new({ nickname: 'Pawel' }) }
+  let(:request) { OpenStruct.new(env: { RAILS_ENV: 'test' }) }
+
+  let(:metrics) { Exvo::Metrics.new(user, request) }
+  let(:metrics_platform) { double }
+
+  before do
+    Exvo::Metrics.any_instance.stub(:metrics_platform) { metrics_platform }
+  end
+
+  describe '#identify' do
+
+    it 'identifies the user in the metrics platform' do
+      metrics_platform.should_receive(:append_identify).with(user.nickname)
+      metrics_platform.should_receive(:append).with('name_tag', user.nickname)
+      metrics_platform.should_receive(:append_set)
+      metrics.identify(user)
+
+      metrics.should be_identified
+    end
+
+  end
+
+  describe '#track' do
+
+    before do
+      metrics.stub(:identified?) { true }
+    end
+
+    it 'send tracking request' do
+      metrics_platform.should_receive(:append_track)
+      metrics.track('Sign in')
+    end
+
+  end
+
+  it 'forwards all other methods to the metrics platform' do
+    metrics_platform.should_receive(:set_once).with('id')
+    metrics.set_once('id')
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'exvo/metrics'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: exvo-metrics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paweł Gościcki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mixpanel
+  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: 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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: guard-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'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  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'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  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: Metrics wrapper for Exvo apps.
+email:
+- pawel.goscicki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exvo-metrics.gemspec
+- lib/exvo/dummy_metrics.rb
+- lib/exvo/metrics.rb
+- lib/exvo/metrics/version.rb
+- spec/exvo/dummy_metrics_spec.rb
+- spec/exvo/metrics_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Exvo/exvo-metrics
+licenses:
+- MIT
+metadata: {}
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Wrapper gem for tracking usage metrics in Exvo apps.
+test_files:
+- spec/exvo/dummy_metrics_spec.rb
+- spec/exvo/metrics_spec.rb
+- spec/spec_helper.rb