ab_panel 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 ab_panel.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Wouter de Vos
+
+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,94 @@
+# AbPanel
+
+Run A/B test experiments on your Rails 3+ site using Mixpanel as a backend.
+
+Create a config file with one or more experiments and conditions.
+
+In `config/ab_panel.yml`
+
+```yaml
+my_experiment:
+  - condition_b
+  - condition_c
+```
+
+Note that this will create 3 conditions:
+
+  1. Original condition (control condition)
+  2. Condition B
+  3. Condition C
+
+You can add as many experiments and conditions as you want. Every visitor
+will be assigned randomly to one condition for each scenario for as long as
+their session remains active.
+
+In your application controller:
+
+```ruby
+class ApplicationController < ActionController::Base
+  initialize_ab_panel!
+end
+```
+
+Then track any event you want from your controller:
+
+```ruby
+class CoursesController < ApplicationController
+  track_action '[visits] Booking form', { :only => :book_now,  :course => :id }
+
+  # controller code here
+end
+```
+
+Use conditions based on experiments and conditions throughout your code, e.g. in your views:
+
+```erb
+<% if AbPanel.my_experiment.condition_b? %>
+  <p>Hi there, you are in Condition B in my experiment.</p>
+<% else %>
+  <p>Hi there, you are either in the Original condition or in Condition C in my experiment.</p>
+
+  <% if AbPanel.my_experiment.condition_c? %>
+    <p>Ah, you're in C.</p>
+  <% end %>
+<% end %>
+```
+
+Or in your controller:
+
+```ruby
+case AbPanel.my_experiment.condition
+when 'condition_b'
+  render 'my_experiment/condition_b'
+when 'condition_c'
+  render 'my_experiment/condition_c'
+else
+  render 'index'
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ab_panel'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ab_panel
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 @@
+require "bundler/gem_tasks"

data/ab_panel.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ab_panel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ab_panel"
+  spec.version       = AbPanel::VERSION
+  spec.authors       = ["Wouter de Vos"]
+  spec.email         = ["wouter@springest.com"]
+  spec.description   = %q{Run A/B test experiments on your Rails 3+ site using Mixpanel as a backend.}
+  spec.summary       = %q{Run A/B test experiments on your Rails 3+ site using Mixpanel as a backend.}
+  spec.homepage      = "https://github.com/Springest/ab_panel"
+  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 "rails", '~> 3.2'
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "fakeweb"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency "mixpanel"
+end

data/lib/ab_panel/config.rb

@@ -0,0 +1,25 @@
+require 'ostruct'
+
+module AbPanel
+  class Config
+    def initialize
+      OpenStruct.new settings
+    end
+
+    def experiments
+      settings.keys.map(&:to_sym)
+    end
+
+    def scenarios(experiment)
+      raise ArgumentError.new( "Fatal: Experiment config not found for #{experiment}" ) unless experiments.include? experiment.to_sym
+      ( settings[experiment.to_sym].map(&:to_sym) + [:original] ).uniq
+    end
+
+
+    def settings
+      @settings ||= YAML.load(
+        ERB.new(File.read(File.join(Rails.root, 'config', 'ab_panel.yml'))).result)
+        .symbolize_keys
+    end
+  end
+end

data/lib/ab_panel/controller_additions.rb

@@ -0,0 +1,106 @@
+module AbPanel
+  module ControllerAdditions
+    extend ActiveSupport::Concern
+
+    # This sets a unique id for this user.
+    #
+    # You could override this in your ApplicationController to use your
+    # own implementation, e.g.:
+    #
+    #   `current_user.id` for logged in users.
+    def ab_panel_id
+      session[:ab_panel_id] ||=
+        (0..4).map { |i| i.even? ? ('A'..'Z').to_a[rand(26)] : rand(10) }.join
+    end
+
+    # Sets the environment hash for every request.
+    #
+    # Experiment conditions and unique user id are preserved
+    # in the user's session.
+    #
+    # You could override this to match your own env.
+    def ab_panel_env
+      {
+        'REMOTE_ADDR'          => request['REMOTE_ADDR'],
+        'HTTP_X_FORWARDED_FOR' => request['HTTP_X_FORWARDED_FOR'],
+        'rack.session'         => request['rack.session'],
+        'rails.env'            => Rails.env
+      }
+    end
+
+    module ClassMethods
+      # Initializes AbPanel's environment.
+      #
+      # Typically, this would go in the ApplicationController.
+      #
+      #   class ApplicationController < ActionController::Base
+      #     initialize_ab_panel!
+      #   end
+      #
+      # This makes sure an ab_panel session is re-initialized on every
+      # request. Experiment conditions and unique user id are preserved
+      # in the user's session.
+      def initialize_ab_panel!
+        self.before_filter(options.slice(:only, :except)) do |controller|
+          # Persist the conditions.
+          AbPanel.conditions = controller.session['ab_panel_conditions']
+
+          {
+            'mixpanel_events' => controller.request['mixpanel_events'],
+            'ab_panel_id'     => controller.ab_panel_id
+          }.merge(controller.ab_panel_env).each do |key, val|
+            AbPanel.env_set key, val
+          end
+        end
+      end
+
+      # Track controller actions visits.
+      #
+      # name       - The name of the event in Mixpanel.
+      # properties - The properties to be associated with the event.
+      #
+      # Example:
+      #
+      #   track_action '[visits] Booking form', { :only => :book_now,  :course => :id }
+      #
+      # This will track the event with the given name on CoursesController#book_now
+      # and assign an options hash:
+      #
+      #   { 'course_id' => @course.id }
+      def track_visit(name, properties={})
+        self.after_filter(options.slice(:only, :except)) do |controller|
+          options = {
+            distinct_id: ab_panel_id,
+            time:        Time.now,
+            time_utc:    Time.now.utc
+          }
+
+          properties.each do |key, val|
+            if controller.respond_to?(key)
+              inst = controller.send(key)
+            elsif controller.instance_variable_defined?("@#{key}")
+              inst = controller.instance_variable_get("@#{key}")
+            else
+              options[key] = val
+              next
+            end
+
+            val = *val
+
+            val.each do |m|
+              options["#{key}_#{m}"] = inst.send(m)
+            end
+          end
+        end
+
+        AbPanel.track name, options
+      end
+    end
+  end
+end
+
+if defined? ActionController::Base
+  ActionController::Base.class_eval do
+    include AbPanel::ControllerAdditions
+  end
+end

data/lib/ab_panel/mixpanel.rb

@@ -0,0 +1,49 @@
+require 'mixpanel'
+
+module AbPanel
+  module Mixpanel
+    class Tracker < ::Mixpanel::Tracker
+      def initialize(options={})
+        @tracker = ::Mixpanel::Tracker.new Config.token, ab_panel_options.merge(options)
+      end
+
+      def ab_panel_options
+        {
+          api_key: Config.api_key,
+          env:     AbPanel.env
+        }
+      end
+
+      def track(event_name, properties, options={})
+        if defined?(Resque)
+          Resque.enqueue ResqueTracker, event_name, properties, options
+        else
+          @tracker.track event_name, properties, options
+        end
+      end
+    end
+
+    class ResqueTracker
+      @queue = :ab_panel
+
+      def self.perform(event_name, properties, options={})
+        Tracker.new.track(event_name, properties, options)
+      end
+    end
+
+    class Config
+      def self.api_key
+        config['api_key']
+      end
+
+      def self.token
+        config['token']
+      end
+
+      def self.config
+        @settings ||= YAML.load(
+          ERB.new(File.read(File.join(Rails.root, 'config', 'mixpanel.yml'))).result)
+      end
+    end
+  end
+end

data/lib/ab_panel/version.rb

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

data/lib/ab_panel.rb

@@ -0,0 +1,77 @@
+puts "Ab Panel."
+
+Dir[File.expand_path(File.join(
+  File.dirname(__FILE__),'ab_panel','**','*.rb'))]
+    .each {|f| require f}
+
+module AbPanel
+  class << self
+
+    # Track event in Mixpanel backend.
+    def track(event_name, properties, options={})
+      tracker.track event_name, properties, options
+    end
+
+    def conditions
+      @conditions ||= assign_conditions!
+    end
+
+    # Set the experiment's conditions.
+    #
+    # This is used to persist conditions from
+    # the session.
+    def conditions=(custom_conditions)
+      @conditions = custom_conditions || conditions
+    end
+
+    def experiments
+      config.experiments
+    end
+
+    def scenarios(experiment)
+      config.scenarios experiment
+    end
+
+    def env_set key, val
+      env[key] = val
+    end
+
+    def env
+      @env ||= {
+        'conditions'           => conditions
+      }
+    end
+
+    private # ----------------------------------------------------------------------------
+
+    def assign_conditions!
+      cs = {}
+
+      experiments.each do |experiment|
+        cs[experiment] ||= {}
+
+        scenarios(experiment).each do |scenario|
+          cs[experiment]["#{scenario}?"] = false
+        end
+
+        selected = scenarios(experiment)[rand(scenarios(experiment).size)]
+
+        cs[experiment]["#{selected}?"] = true
+
+        cs[experiment][:condition] = selected
+
+        cs[experiment] = OpenStruct.new cs[experiment]
+      end
+
+      OpenStruct.new cs
+    end
+
+    def tracker
+      @tracker ||= Mixpanel::Tracker.new
+    end
+
+    def config
+      @config ||= Config.new
+    end
+  end
+end

data/spec/ab_panel/controller_additions_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+class Controller
+  include AbPanel::ControllerAdditions
+
+  def session
+    @session ||= {}
+  end
+end
+
+describe AbPanel::ControllerAdditions do
+  let(:controller) { Controller.new }
+
+  describe "#ab_panel_id" do
+    subject { controller.ab_panel_id }
+
+    it { should match /^([A-Z]|[0-9])([A-Z]|[0-9])([A-Z]|[0-9])([A-Z]|[0-9])([A-Z]|[0-9])$/ }
+  end
+end

data/spec/ab_panel_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe AbPanel do
+  describe ".experiments" do
+    subject { AbPanel.experiments }
+
+    it { should =~ %w(experiment1 experiment2).map(&:to_sym) }
+  end
+
+  describe ".scenarios" do
+    subject { AbPanel.scenarios(experiment) }
+
+    let(:experiment) { AbPanel.experiments.first }
+
+    it { should =~ %w( scenario1 scenario2 scenario3 original ).map(&:to_sym) }
+
+    describe "With an unexisting experiment" do
+      let(:experiment) { :does_not_exist }
+
+      it 'should throw an ArgumentError' do
+        expect { subject }.to raise_exception ArgumentError
+      end
+    end
+  end
+
+  describe ".conditions" do
+    subject { AbPanel.conditions.experiment1 }
+
+    it { should respond_to :scenario1? }
+    it { should respond_to :original? }
+
+    describe 'uniqueness' do
+      let(:conditions) do
+        [
+          subject.scenario1?,
+          subject.scenario2?,
+          subject.scenario3?,
+          subject.original?
+        ]
+      end
+
+      it { conditions.any?.should be true }
+      it { conditions.all?.should be false }
+      it { conditions.select{|c| c}.size.should be 1 }
+      it { conditions.reject{|c| c}.size.should be 3 }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+puts "Spec Helper."
+require 'rubygems'
+require 'active_support/all'
+
+require File.join(File.dirname(__FILE__), "../lib", "ab_panel")
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+

data/spec/support/fakeweb.rb

@@ -0,0 +1,5 @@
+# Fakeweb
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+FakeWeb.register_uri(:any, /http:\/\/api\.mixpanel\.com.*/, :body => "1")

data/spec/support/files/config/ab_panel.yml

@@ -0,0 +1,9 @@
+experiment1:
+  - scenario1
+  - scenario2
+  - scenario3
+
+experiment2:
+  - scenario4
+  - scenario5
+

data/spec/support/rails.rb

@@ -0,0 +1,8 @@
+require 'rails'
+
+RSpec.configure do |c|
+  c.before do
+    Rails.stub(:root) { File.expand_path( '../files', __FILE__ ) }
+    Rails.stub(:env) { 'test' }
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: ab_panel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Wouter de Vos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-02 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: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !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: fakeweb
+  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: Run A/B test experiments on your Rails 3+ site using Mixpanel as a backend.
+email:
+- wouter@springest.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ab_panel.gemspec
+- lib/ab_panel.rb
+- lib/ab_panel/config.rb
+- lib/ab_panel/controller_additions.rb
+- lib/ab_panel/mixpanel.rb
+- lib/ab_panel/version.rb
+- spec/ab_panel/controller_additions_spec.rb
+- spec/ab_panel_spec.rb
+- spec/spec_helper.rb
+- spec/support/fakeweb.rb
+- spec/support/files/config/ab_panel.yml
+- spec/support/rails.rb
+homepage: https://github.com/Springest/ab_panel
+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'
+      segments:
+      - 0
+      hash: -2064797611624218648
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2064797611624218648
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Run A/B test experiments on your Rails 3+ site using Mixpanel as a backend.
+test_files:
+- spec/ab_panel/controller_additions_spec.rb
+- spec/ab_panel_spec.rb
+- spec/spec_helper.rb
+- spec/support/fakeweb.rb
+- spec/support/files/config/ab_panel.yml
+- spec/support/rails.rb