track_me 0.0.1

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## Version 0.0.1
+
+- initial release

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trackme.gemspec
+gemspec
+
+gem 'rake'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jim Ruther Nill
+
+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,47 @@
+# TrackMe
+
+This is a gem that allows you to easily add javascript based metric systems like kissmetrics and mixpanel to your application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'track_me'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install track_me
+
+After installing the gem, you need to run the generator that will install a few files.
+
+    $ rails g track_me:install
+
+## Usage
+
+In your controllers, call trackme and pass in the name of the action and the string that will be used to describe the action.  You can also pass in a hash with a key called 'object' which will be used for sending the details of the object.
+
+```ruby
+class CommentsController < ActionController::Base
+  trackme index: ['Visited the comments index page'],
+         create: ['Created a comment', object: 'comment']
+
+  def index
+  end
+
+  def create
+    @comment = ...
+  end
+end
+```
+
+## 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

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/generators/track_me/install/install_generator.rb

@@ -0,0 +1,22 @@
+module TrackMe
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    def copy_files
+      copy_file '_js.html.haml', 'app/views/track_me/_js.html.haml'
+      copy_file '_mixpanel.html.haml', 'app/views/track_me/_mixpanel.html.haml'
+      copy_file '_kissmetrics.html.haml', 'app/views/track_me/_kissmetrics.html.haml'
+      copy_file 'track_me.rb', 'config/initializers/track_me.rb'
+
+      say "\n"
+      say 'Please dont forget to add the js file to the head section of your html templates', :green
+      say "\n"
+      say "  = render 'track_me/js' if Rails.env.production?", :green
+      say "\n"
+      say 'and the call to include on application controller', :green
+      say "\n"
+      say "  include TrackMe", :green
+      say "\n"
+    end
+  end
+end

data/lib/generators/track_me/install/templates/_js.html.haml

@@ -0,0 +1,3 @@
+- if @trackme_string
+  = render 'track_me/mixpanel' if ENABLED_METRICS.include?('mixpanel')
+  = render 'track_me/kissmetrics' if ENABLED_METRICS.include?('kissmetrics')

data/lib/generators/track_me/install/templates/_kissmetrics.html.haml

@@ -0,0 +1,21 @@
+:javascript
+  // Initialize Kissmetrics
+  var _kmq = _kmq || [];
+  var _kmk = _kmk || '#{KISSMETRICS_ID}';
+
+  function _kms(u){
+    setTimeout(function(){
+      var d = document, f = d.getElementsByTagName('script')[0],
+      s = d.createElement('script');
+      s.type = 'text/javascript'; s.async = true; s.src = u;
+      f.parentNode.insertBefore(s, f);
+    }, 1);
+  }
+  _kms('//i.kissmetrics.com/i.js');
+  _kms('//doug1izaerwt3.cloudfront.net/' + _kmk + '.1.js');
+
+  // Identify current user
+  _kmq.push(['identify', '#{current_user.email}']);
+
+  // Track event
+  _kmq.push(['record', '#{escape_javascript @track_string}']);

data/lib/generators/track_me/install/templates/_mixpanel.html.haml

@@ -0,0 +1,11 @@
+:javascript
+  // Initialize Mixpanel
+  (function(c,a){window.mixpanel=a;var b,d,h,e;b=c.createElement("script");b.type="text/javascript";b.async=!0;b.src=("https:"===c.location.protocol?"https:":"http:")+'//cdn.mxpnl.com/libs/mixpanel-2.0.min.js';d=c.getElementsByTagName("script")[0];d.parentNode.insertBefore(b,d);a._i=[];a.init=function(b,c,f){function d(a,b){var c=b.split(".");2==c.length&&(a=a[c[0]],b=c[1]);a[b]=function(){a.push([b].concat(Array.prototype.slice.call(arguments,0)))}}var g=a;"undefined"!==typeof f? g=a[f]=[]:f="mixpanel";g.people=g.people||[];h="disable track track_pageview track_links track_forms register register_once unregister identify name_tag set_config people.set people.increment".split(" ");for(e=0;e<h.length;e++)d(g,h[e]);a._i.push([b,c,f])};a.__SV=1.1})(document,window.mixpanel||[]);
+  mixpanel.init("#{MIXPANEL_ID}");
+
+- if @trackme_object
+  :javascript
+    mixpanel.track('#{escape_javascript @trackme_string}', #{@trackme_object.to_json});
+- else
+  :javascript
+    mixpanel.track('#{escape_javascript @trackme_string}');

data/lib/generators/track_me/install/templates/track_me.rb

@@ -0,0 +1,10 @@
+# Supported metrics
+#  == mixpanel
+#  == kissmetrics
+
+ENABLED_METRICS = %w[mixpanel]
+
+# Set the IDs for each metric. Goes by the pattern
+# <METRIC_NAME>_ID
+# MIXPANEL_ID = '12345'
+# KISSMETRICS_ID = 'ABCDE'

data/lib/track_me/version.rb

@@ -0,0 +1,3 @@
+module TrackMe
+  VERSION = '0.0.1'
+end

data/lib/track_me.rb

@@ -0,0 +1,32 @@
+require "track_me/version"
+
+module TrackMe
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def trackme(actions)
+      @trackme_actions = actions
+
+      before_filter :set_trackme_actions
+
+      include TrackMe::InstanceMethods
+    end
+
+    def trackme_actions
+      @trackme_actions
+    end
+  end
+
+  module InstanceMethods
+    def set_trackme_actions
+      @trackme_string, opts = self.class.trackme_actions[params[:action].to_sym]
+
+      if opts && opts[:object]
+        obj = instance_variable_get "@#{opts[:object]}"
+        @trackme_object = obj.attributes.except('created_at', 'updated_at', 'delta') if obj
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'track_me'
+require 'action_controller'

data/spec/track_me_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+class FooController < ActionController::Base
+  include TrackMe
+end
+
+describe FooController do
+  before :each do
+    @foo = FooController.new
+    @foo.class.trackme index: ['My first tracked action']
+  end
+
+  describe 'trackme' do
+    it 'should set @trackme_actions which caches the options passed to #trackme' do
+      @foo.class.instance_variable_get('@trackme_actions')[:index].should == ['My first tracked action']
+    end
+  end
+end

data/track_me.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'track_me/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "track_me"
+  gem.version       = TrackMe::VERSION
+  gem.authors       = ["Jim Ruther Nill"]
+  gem.email         = ["jim@netengine.com.au"]
+  gem.description   = %q{Easy way to add a metric system using javascript and known metric saas}
+  gem.summary       = %q{Easily add multiple metric systems}
+  gem.homepage      = "https://github.com/jvnill/track_me"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'actionpack'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: track_me
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jim Ruther Nill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easy way to add a metric system using javascript and known metric saas
+email:
+- jim@netengine.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/track_me/install/install_generator.rb
+- lib/generators/track_me/install/templates/_js.html.haml
+- lib/generators/track_me/install/templates/_kissmetrics.html.haml
+- lib/generators/track_me/install/templates/_mixpanel.html.haml
+- lib/generators/track_me/install/templates/track_me.rb
+- lib/track_me.rb
+- lib/track_me/version.rb
+- spec/spec_helper.rb
+- spec/track_me_spec.rb
+- track_me.gemspec
+homepage: https://github.com/jvnill/track_me
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Easily add multiple metric systems
+test_files:
+- spec/spec_helper.rb
+- spec/track_me_spec.rb