mix_tape 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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Omar Sahyoun
+
+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,83 @@
+# MixTape
+
+## The Problem
+
+Littering controllers with MixPanel events with large param payloads isn't a nice thing to do.
+
+`MixTape` tries to help by creating a DSL for specifying your events in advance, and keeping them in a single file.
+
+## Defining your Events
+
+    MixTape::Builder.definition do
+
+      button_click "Log number of times user clicks button" do |user, button|
+        {
+          user_name:   user.username,
+          distinct_id: user.id,
+          button_id:   button.id,
+          button_page: button.page
+        }
+      end
+
+      checks_mail "User just checked their mail" do |user, inbox|
+        {
+          distinct_id: user.id,
+          user_name:    user.username,
+          user_id:      user.id,
+          unread_count: inbox.count
+        }
+      end
+
+      user_invites_friend "User has invited a friend" do |user, friend|
+        {
+          distinct_id: user.id,
+          user_name:    user.username,
+          user_id:      user.id,
+          friend_name:  friend.name
+        }
+      end
+    end
+
+
+To track a defined event:
+
+    MixTape.track_user_invites_friend(user, friend)
+
+To update an existing event object:
+
+    MixTape.set_user_invites_friend(user, friend)
+
+## Available Events
+
+To view defined events:
+
+    rake mix_tape:events
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mix_tape'
+
+Don't forget to set your MixPanel API token:
+
+    MixTape.config do |config|
+      config.token =  '12345'
+    end
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mix_tape
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+Dir["lib/tasks/*.rake"].each { |ext| load ext }

data/lib/mix_tape/builder.rb

@@ -0,0 +1,32 @@
+module MixTape
+  module Builder
+    extend self
+
+    ## Store definitions in array, so we can generate documenation.
+    @@mix_tape = []
+
+    def mix_tape
+      @@mix_tape
+    end
+
+    def definition(&block)
+      block.arity < 1 ? self.instance_eval(&block) : block.call(self) if block_given?
+    end
+
+    def define(name, desc = '', &block)
+      @@mix_tape << [name, desc]
+
+      MixTape.define_singleton_method("track_#{name}") do |*args|
+        MixTape.client.track name.to_s, yield(*args)
+      end
+
+      MixTape.define_singleton_method("set_#{name}") do |id, *args|
+        MixTape.client.set id, yield(*args)
+      end
+    end
+
+    def method_missing(key, *arguments, &block)
+      define(key, arguments.first, &block)
+    end
+  end
+end

data/lib/mix_tape/client.rb

@@ -0,0 +1,15 @@
+module MixTape
+
+  class << self
+    attr_accessor :token
+
+    def client
+      raise(ArgumentError, %{MixPanel token is undefined.}) if token.empty?
+      @client ||= Mixpanel::Tracker.new(token, async: true)
+    end
+
+    def config(&block)
+      instance_eval &block
+    end
+  end
+end

data/lib/mix_tape/version.rb

@@ -0,0 +1,3 @@
+module MixTape
+  VERSION = "0.0.1"
+end

data/lib/mix_tape.rb

@@ -0,0 +1,7 @@
+require "mixpanel"
+require "mix_tape/client"
+require "mix_tape/version"
+require "mix_tape/builder"
+
+module MixTape
+end

data/lib/tasks/documentation.rake

@@ -0,0 +1,12 @@
+require 'mix_tape'
+
+namespace :mix_tape do
+  desc "Generates list of defined events"
+  task :events do
+    MixTape::Builder.mix_tape.each do |event, desc|
+      puts "++ #{event} ++"
+      puts desc
+      puts
+    end
+  end
+end

data/mix_tape.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mix_tape/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mix_tape"
+  spec.version       = MixTape::VERSION
+  spec.authors       = ['Omar Sahyoun']
+  spec.email         = ['omar@quipper.com']
+  spec.description   = %q{Tidy up your mixpanel commits}
+  spec.summary       = %q{Tidy up your mixpanel commits}
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+
+  spec.add_dependency 'mixpanel'
+end

data/spec/lib/mix_tape/builder_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+MixTape::Builder.definition do
+
+  button_click "Log number of times user clicks button" do |user, button|
+    {
+      user_name:    user.username,
+      distinct_id:  user.id,
+      button_id:    button.id,
+      button_page:  button.page
+    }
+  end
+
+  checks_mail "When user checks mail" do |user, inbox|
+    {
+      user_name:    user.username,
+      user_id:      user.id,
+      unread_count: inbox.count
+    }
+  end
+end
+
+describe "Triggering Events" do
+  let(:user)   { double(username: 'Zeus', id: '1') }
+  let(:button) { double(id: '2', page: 'homepage') }
+  let(:client) { double('client') }
+
+  before do
+    MixTape.stub(:client){ client }
+  end
+
+  it "tracks" do
+    expected_properties =  { user_name: "Zeus", distinct_id: "1", button_id: "2", button_page: "homepage" }
+
+    client.should_receive(:track).with("button_click", expected_properties)
+    MixTape.track_button_click(user, button)
+  end
+
+  it "sets" do
+    expected_properties =  { user_name: "Zeus", distinct_id: "1", button_id: "2", button_page: "homepage" }
+
+    client.should_receive(:set).with("1", expected_properties)
+    MixTape.set_button_click(user.id, user, button)
+  end
+end

data/spec/lib/mix_tape/config_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe 'Configuraton' do
+  it "sets token" do
+    MixTape.config do |config|
+      config.token =  '1234'
+    end
+
+    expect(MixTape.token).to eq('1234')
+  end
+
+  it "raises when token not defined" do
+    MixTape.config{ |config|config.token = '' }
+
+    expect{
+      MixTape.client
+    }.to raise_error("MixPanel token is undefined.")
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require 'mix_tape'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.tty = true
+  config.formatter = :documentation # :progress, :html, :textmate
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: mix_tape
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Omar Sahyoun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: mixpanel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Tidy up your mixpanel commits
+email:
+- omar@quipper.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mix_tape.rb
+- lib/mix_tape/builder.rb
+- lib/mix_tape/client.rb
+- lib/mix_tape/version.rb
+- lib/tasks/documentation.rake
+- mix_tape.gemspec
+- spec/lib/mix_tape/builder_spec.rb
+- spec/lib/mix_tape/config_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.24
+signing_key: 
+specification_version: 3
+summary: Tidy up your mixpanel commits
+test_files:
+- spec/lib/mix_tape/builder_spec.rb
+- spec/lib/mix_tape/config_spec.rb
+- spec/spec_helper.rb