backbone-mixpanel 0.2.0

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# 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
+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

data/spec/vendor/assets/javascripts/backbone-mixpanel_spec.js

@@ -0,0 +1,232 @@
+describe("Backbone.Mixpanel", function () {
+  var bbm, options;
+
+  var initialize = function() {
+    bbm = Backbone.Mixpanel.init(options);
+  };
+
+  beforeEach(function () {
+    window.mixpanel = jasmine.createSpyObj("mixpanel", ["init", "track", "register", "name_tag"]);
+
+    options = { token: "abc123",  customData: ['id', 'desc']};
+  });
+
+  describe(".initialize", function () {
+    beforeEach(function () {
+      options = {
+        token: "abc123",
+        userInfo: { id: 45, paid: true },
+        nameTag: "Foo-Bar"
+      };
+
+      initialize();
+    });
+
+    it("should initialize the mixpanel js", function () {
+      expect(mixpanel.init).toHaveBeenCalledWith("abc123");
+    });
+
+    it("should set the user information", function () {
+      expect(mixpanel.register).toHaveBeenCalledWith({ id: 45, paid: true });
+    });
+
+    it("should set a name tag", function () {
+      expect(mixpanel.name_tag).toHaveBeenCalledWith("Foo-Bar");
+    });
+
+    describe("when mixpanel is not defined", function () {
+      beforeEach(function () {
+        window.mixpanel = undefined;
+      });
+
+      it("should not error", function () {
+        expect(function() { initialize() }).not.toThrow();
+      });
+    });
+
+    describe("when not given a token", function () {
+      var message;
+
+      beforeEach(function () {
+        message = "Backbone.Mixpanel.init requires the mixpanel token from your account.";
+
+        delete options.token;
+      });
+
+      it("should error", function () {
+        expect(function() { initialize() }).toThrow(message);
+      });
+    });
+  });
+
+  describe("#wrapEvent", function () {
+    var func, wrapped, event;
+
+    beforeEach(function () {
+      initialize();
+
+      spyOn(bbm, "trackEvent");
+      func = jasmine.createSpy("Function");
+
+      wrapped = bbm.wrapEvent(func, "the default value");
+      event = jasmine.createSpy("Event");
+    });
+
+    describe("when not given a function", function () {
+      it("should error", function () {
+         expect(function() { bbm.wrapEvent() }).toThrow("Wrapping requires a function to wrap");
+      });
+    });
+
+    describe("when not given a default value", function () {
+      it("should error", function () {
+         expect(function() { bbm.wrapEvent(func) }).toThrow("Wrapping requires a default description");
+      });
+    });
+
+    it("should return a function that wraps the original function", function () {
+      wrapped({});
+      expect(func).toHaveBeenCalled();
+    });
+
+    it("should track the event", function () {
+      wrapped({});
+      expect(bbm.trackEvent).toHaveBeenCalled();
+    });
+
+    describe("for the description", function () {
+      describe("when the event's target has a data attribute", function () {
+        beforeEach(function () {
+          event.currentTarget = '<div data-event="Foo Event :)"></div>';
+
+          wrapped(event);
+        });
+
+        it("should log the event text", function () {
+          expect(bbm.trackEvent).toHaveBeenCalledWith("Foo Event :)", {});
+        });
+      });
+
+      describe("when the event's target does not have a data attribute", function () {
+        beforeEach(function () {
+          event.currentTarget = '<div data-invalid=":/"></div>';
+
+          wrapped(event);
+        });
+
+        it("should log the default description", function () {
+          expect(bbm.trackEvent).toHaveBeenCalledWith("the default value", {});
+        });
+      });
+    });
+
+    describe("for the additional data", function () {
+      describe("when the event's target has a metadata attribute", function () {
+        beforeEach(function () {
+          event.currentTarget = '<div data-id="THE ID"></div>';
+
+          wrapped(event);
+        });
+
+        it("should log custom id", function () {
+          expect(bbm.trackEvent.mostRecentCall.args[1].id).toEqual("THE ID");
+        });
+
+        describe("when the event's target has multiple metadata attributes", function () {
+          beforeEach(function () {
+            event.currentTarget = '<div data-id="12" data-desc="A Description!"></div>';
+
+            wrapped(event);
+          });
+
+          it("should log custom attributes", function () {
+            expect(bbm.trackEvent.mostRecentCall.args[1].id).toEqual(12);
+            expect(bbm.trackEvent.mostRecentCall.args[1].desc).toEqual("A Description!");
+          });
+        });
+      });
+    });
+  });
+
+  describe("#trackEvent", function () {
+    beforeEach(function () {
+      initialize();
+    });
+
+    it("should track the given string", function () {
+      bbm.trackEvent("Some Text");
+
+      expect(mixpanel.track).toHaveBeenCalledWith("Some Text", {});
+    });
+
+    it("should track the default extra information", function () {
+      bbm.trackEvent(null);
+
+      expect(mixpanel.track).toHaveBeenCalledWith(null, {});
+    });
+
+    it("should track the extra information", function () {
+      bbm.trackEvent(null, {extra: 'info', key: 'value'});
+
+      expect(mixpanel.track).toHaveBeenCalledWith(null, {extra: 'info', key: 'value'});
+    });
+  });
+
+  describe("#delegateEvents", function () {
+    var view,
+        delegate = function() {
+          bbm.delegateEvents.call(view);
+        };
+
+    beforeEach(function () {
+      initialize();
+    });
+
+    describe("when the view has no events", function () {
+      beforeEach(function () {
+        view = {};
+      });
+
+      it("should not error", function () {
+        expect(function() { delegate() }).not.toThrow();
+      });
+    });
+
+    describe("when the view has an events hash", function () {
+      beforeEach(function () {
+        view = {
+          $el: { on: function() {} },
+          undelegateEvents: function() {},
+          events: {
+            "click .some-class": "clickSomeClass"
+          }
+        };
+      });
+
+      it("should error (no method on the view)", function () {
+        expect(function() { delegate() }).toThrow("Method \"clickSomeClass\" does not exist");
+      });
+
+      describe("when the method exists", function () {
+        var method;
+
+        beforeEach(function () {
+          spyOn(bbm, 'wrapEvent').andCallThrough();
+
+          method = function() { return "hey" };
+          view.clickSomeClass = method;
+        });
+
+        it("should not error", function () {
+          expect(function() { delegate() }).not.toThrow();
+        });
+
+        it("should wrap the error", function () {
+          delegate();
+
+          expect(bbm.wrapEvent).toHaveBeenCalledWith(method);
+        });
+      });
+    });
+  });
+});

data/vendor/assets/javascripts/backbone-mixpanel.js

@@ -0,0 +1,105 @@
+Backbone.View.originalDelegateEvents = Backbone.View.prototype.delegateEvents;
+
+Backbone.Mixpanel = (function() {
+  var self = {},
+      defaultOptions = {
+        token: null,
+        enabled: false,
+        eventDataAttr: 'event',
+        customData: [],
+        userInfo: {},
+        nameTag: ''
+      },
+      options = {};
+
+  // setup the Mixpanel environment
+  self.init = function(opts) {
+    _.extend(options, defaultOptions, opts || {});
+
+    if(!options.token) {
+      throw new Error("Backbone.Mixpanel.init requires the mixpanel token from your account.");
+    }
+
+    initialize();
+
+    return self;
+  };
+
+  // Returns a function that tracks to mixpanel and calls the original method
+  //   method - (required) The method to handle an DOM event after tracking
+  self.wrapEvent = function(method, defaultDescription) {
+    if(!_.isFunction(method)) throw new Error("Wrapping requires a function to wrap");
+    if(!defaultDescription) throw new Error("Wrapping requires a default description");
+
+    return function(event) {
+      var data = {},
+          $target = $(event.currentTarget),
+          description = $target.data(options.eventDataAttr) || defaultDescription;
+
+      _(options.customData).each(function(key) {
+        var item = $target.data(key);
+
+        if(item) data[key] = item;
+      });
+
+      self.trackEvent(description, data);
+
+      method.apply(this, arguments);
+    }
+  };
+
+  // Track events to mixpanel when enabled and mixpanel is available
+  //   desc - (required) The description of the event
+  //   data - (optional) Any additional data included in the event
+  self.trackEvent = function(desc, data) {
+    data || (data = {});
+
+    // where the magic happens.
+    mixpanel.track(desc, data);
+  };
+
+  self.delegateEvents = function(events) {
+    if (!(events || (events = _.result(this, 'events')))) return;
+
+    for(var key in events) {
+      var method = events[key];
+      if(!_.isFunction(method)) method = this[method];
+      if(!method) throw new Error('Method "' + events[key] + '" does not exist');
+
+      var wr = self.wrapEvent(method, key);
+      events[key] = wr;
+
+      Backbone.View.originalDelegateEvents.call(this, events);
+    }
+  };
+
+  // Replace the delegateEvents function so that we can wrap each of the event
+  //  handlers given via the events hash/function
+  Backbone.View.prototype.delegateEvents = self.delegateEvents;
+
+  return self;
+
+  // Setup the Mixpanel Javascript and initialize it with the Mixpanel token.
+  function initialize() {
+    window.mixpanel || (window.mixpanel = []);
+
+    var noop = function() {};
+
+    // Register the functions that we use internally to do nothing
+    if(!options.enabled) {
+      _.defaults(window.mixpanel, { init: noop, register: noop, name_tag: noop, track: noop });
+    }
+
+    if(options.enabled) loadMixpanel();
+
+    mixpanel.init(options.token);
+    mixpanel.register(options.userInfo);
+    mixpanel.name_tag(options.nameTag);
+  }
+
+  function loadMixpanel() {
+    (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.2.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','alias','name_tag','set_config','people.set','people.increment','people.track_charge','people.append'];for(e=0;e<h.length;e++)d(g,h[e]);a._i.push([b,c,f])};a.__SV=1.2;
+    })(document,window.mixpanel);
+  }
+}());

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: backbone-mixpanel
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Brian Norton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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'
+description: ''
+email:
+- brian.nort@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- backbone-mixpanel.gemspec
+- lib/backbone-mixpanel.rb
+- lib/backbone-mixpanel/engine.rb
+- lib/backbone-mixpanel/version.rb
+- spec/SpecRunner.html
+- spec/lib/jasmine-1.3.1/MIT.LICENSE
+- spec/lib/jasmine-1.3.1/jasmine-html.js
+- spec/lib/jasmine-1.3.1/jasmine.css
+- spec/lib/jasmine-1.3.1/jasmine.js
+- spec/lib/javascripts/backbone.js
+- spec/lib/javascripts/jquery.js
+- spec/lib/javascripts/underscore.js
+- spec/spec_helper.rb
+- spec/vendor/assets/javascripts/backbone-mixpanel_spec.js
+- vendor/assets/javascripts/backbone-mixpanel.js
+homepage: ''
+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.25
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/SpecRunner.html
+- spec/lib/jasmine-1.3.1/MIT.LICENSE
+- spec/lib/jasmine-1.3.1/jasmine-html.js
+- spec/lib/jasmine-1.3.1/jasmine.css
+- spec/lib/jasmine-1.3.1/jasmine.js
+- spec/lib/javascripts/backbone.js
+- spec/lib/javascripts/jquery.js
+- spec/lib/javascripts/underscore.js
+- spec/spec_helper.rb
+- spec/vendor/assets/javascripts/backbone-mixpanel_spec.js
+has_rdoc: