opawesome 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Alex Rehberg
+
+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.rdoc

@@ -0,0 +1,3 @@
+= Opawesome
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,39 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Opawesome'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/assets/javascripts/opawesome/cookies.js

@@ -0,0 +1,141 @@
+/*!
+ * Cookies.js - 0.3.1
+ * Wednesday, April 24 2013 @ 2:28 AM EST
+ *
+ * Copyright (c) 2013, Scott Hamper
+ * Licensed under the MIT license,
+ * http://www.opensource.org/licenses/MIT
+ */
+(function (undefined) {
+    'use strict';
+
+    var Cookies = function (key, value, options) {
+        return arguments.length === 1 ?
+            Cookies.get(key) : Cookies.set(key, value, options);
+    };
+
+    // Allows for setter injection in unit tests
+    Cookies._document = document;
+    Cookies._navigator = navigator;
+
+    Cookies.defaults = {
+        path: '/'
+    };
+
+    Cookies.get = function (key) {
+        if (Cookies._cachedDocumentCookie !== Cookies._document.cookie) {
+            Cookies._renewCache();
+        }
+
+        return Cookies._cache[key];
+    };
+
+    Cookies.set = function (key, value, options) {
+        options = Cookies._getExtendedOptions(options);
+        options.expires = Cookies._getExpiresDate(value === undefined ? -1 : options.expires);
+
+        Cookies._document.cookie = Cookies._generateCookieString(key, value, options);
+
+        return Cookies;
+    };
+
+    Cookies.expire = function (key, options) {
+        return Cookies.set(key, undefined, options);
+    };
+
+    Cookies._getExtendedOptions = function (options) {
+        return {
+            path: options && options.path || Cookies.defaults.path,
+            domain: options && options.domain || Cookies.defaults.domain,
+            expires: options && options.expires || Cookies.defaults.expires,
+            secure: options && options.secure !== undefined ?  options.secure : Cookies.defaults.secure
+        };
+    };
+
+    Cookies._isValidDate = function (date) {
+        return Object.prototype.toString.call(date) === '[object Date]' && !isNaN(date.getTime());
+    };
+
+    Cookies._getExpiresDate = function (expires, now) {
+        now = now || new Date();
+        switch (typeof expires) {
+            case 'number': expires = new Date(now.getTime() + expires * 1000); break;
+            case 'string': expires = new Date(expires); break;
+        }
+
+        if (expires && !Cookies._isValidDate(expires)) {
+            throw new Error('`expires` parameter cannot be converted to a valid Date instance');
+        }
+
+        return expires;
+    };
+
+    Cookies._generateCookieString = function (key, value, options) {
+        key = encodeURIComponent(key);
+        value = (value + '').replace(/[^!#$&-+\--:<-\[\]-~]/g, encodeURIComponent);
+        options = options || {};
+
+        var cookieString = key + '=' + value;
+        cookieString += options.path ? ';path=' + options.path : '';
+        cookieString += options.domain ? ';domain=' + options.domain : '';
+        cookieString += options.expires ? ';expires=' + options.expires.toGMTString() : '';
+        cookieString += options.secure ? ';secure' : '';
+
+        return cookieString;
+    };
+
+    Cookies._getCookieObjectFromString = function (documentCookie) {
+        var cookieObject = {};
+        var cookiesArray = documentCookie ? documentCookie.split('; ') : [];
+
+        for (var i = 0; i < cookiesArray.length; i++) {
+            var cookieKvp = Cookies._getKeyValuePairFromCookieString(cookiesArray[i]);
+
+            if (cookieObject[cookieKvp.key] === undefined) {
+                cookieObject[cookieKvp.key] = cookieKvp.value;
+            }
+        }
+
+        return cookieObject;
+    };
+
+    Cookies._getKeyValuePairFromCookieString = function (cookieString) {
+        // "=" is a valid character in a cookie value according to RFC6265, so cannot `split('=')`
+        var separatorIndex = cookieString.indexOf('=');
+
+        // IE omits the "=" when the cookie value is an empty string
+        separatorIndex = separatorIndex < 0 ? cookieString.length : separatorIndex;
+
+        return {
+            key: decodeURIComponent(cookieString.substr(0, separatorIndex)),
+            value: decodeURIComponent(cookieString.substr(separatorIndex + 1))
+        };
+    };
+
+    Cookies._renewCache = function () {
+        Cookies._cache = Cookies._getCookieObjectFromString(Cookies._document.cookie);
+        Cookies._cachedDocumentCookie = Cookies._document.cookie;
+    };
+
+    Cookies._areEnabled = function () {
+        return Cookies._navigator.cookieEnabled ||
+            Cookies.set('cookies.js', 1).get('cookies.js') === '1';
+    };
+
+    Cookies.enabled = Cookies._areEnabled();
+
+    // AMD support
+    if (typeof define === 'function' && define.amd) {
+        define(function () { return Cookies; });
+    // CommonJS and Node.js module support.
+    } else if (typeof exports !== 'undefined') {
+        // Support Node.js specific `module.exports` (which can be a function)
+        if (typeof module !== 'undefined' && module.exports) {
+            exports = module.exports = Cookies;
+        }
+        // But always support CommonJS module 1.1.1 spec (`exports` cannot be a function)
+        exports.Cookies = Cookies;
+    } else {
+        window.Cookies = Cookies;
+    }
+})();

data/app/assets/javascripts/opawesome.js

@@ -0,0 +1,36 @@
+//= require 'opawesome/cookies'
+
+OptimizatonTestForm = {
+  setup: function(){
+    $('.edit_test').on('click', '.remove_option', this.remove_attribute);
+    $('.edit_test').on('click', '.add_fields', this.add_attribute);
+  },
+
+  remove_attribute: function(event){
+    $(this).prev('input[type=hidden]').val('1');
+    $(this).closest('.input').hide();
+    event.preventDefault();
+  },
+
+  add_attribute: function(event){
+    time = new Date().getTime()
+    regexp = new RegExp($(this).data('id'), 'g')
+    $(this).before($(this).data('fields').replace(regexp, time))
+    event.preventDefault()
+  }
+}
+
+OptimizationTracker = {
+  create_session: function(){
+    if(Cookies('opt_valid_session') === undefined) {
+      $.post('/opawesome/sessions', function(data) {
+        // optimization tracking started successfully (we're not doing anything special here yet)
+      });
+    }
+  }
+}
+
+$(document).ready(function(){
+  OptimizatonTestForm.setup();
+  OptimizationTracker.create_session();
+});

data/app/controllers/opawesome/sessions_controller.rb

@@ -0,0 +1,16 @@
+class Opawesome::SessionsController < ApplicationController
+  def create
+    # check for existing option cookies
+    unless cookies[:opaw_valid_session]
+      cookies.each do |k, v|
+        if k[0..4] == 'opaw_' && k != 'opaw_valid_session' && k != 'opaw_ignore'
+          option = Opawesome::TestOption.where(id: v).first
+          option.select! unless option.nil?
+        end
+      end
+    end
+
+    cookies[:opaw_valid_session] = true
+    render nothing: true, status: 200
+  end
+end

data/app/controllers/opawesome/tests_controller.rb

@@ -0,0 +1,31 @@
+class Opawesome::TestsController < ApplicationController
+  def index
+    @tests = Opawesome::Test.order('created_at DESC').all
+  end
+
+  def show
+    @test = Opawesome::Test.find(params[:id])
+    @test_options = @test.options.sort_by {|option| option.conversion_rate }
+    @test_options.reverse!
+  end
+
+  def edit
+    @test = Opawesome::Test.find(params[:id])
+  end
+
+  def update
+    @test = Opawesome::Test.find(params[:id])
+
+    if @test.update_attributes(params[:opawesome_test])
+      redirect_to opawesome_test_path(@test)
+    else
+      render :edit
+    end
+  end
+
+  def destroy
+    @test = Opawesome::Test.find(params[:id])
+    @test.destroy
+    redirect_to opawesome_tests_path
+  end
+end

data/app/helpers/opawesome/sessions_helper.rb

@@ -0,0 +1,2 @@
+module Opawesome::SessionsHelper
+end

data/app/helpers/opawesome/tracker_helper.rb

@@ -0,0 +1,56 @@
+# TODO: make this less of an ugly mess
+
+module Opawesome::TrackerHelper
+  def opaw_select(key, default)
+    if cookies["opaw_#{key}"]
+      option = Opawesome::TestOption.where(id: cookies["opaw_#{key}"]).first
+
+      if option.nil?
+        cookies["opaw_#{key}"] = nil
+      else
+        return option.value
+      end
+    end
+
+    test = Opawesome::Test.where(key: key).first_or_initialize
+
+    # set up defaults if the test is new
+    if test.new_record?
+      test.name = test.key.to_s.humanize
+      test.save!
+      Opawesome::TestOption.create!(test_id: test.id, value: default, conversion_count: 0, selection_count: 0)
+    end
+
+    if cookies[:opaw_ignore]
+      test.best_option.value
+    else
+      # select an option and save it in the user's cookies
+      option = test.select_option
+
+      option.select! unless cookies[:opaw_valid_session].nil?
+
+      cookies.permanent["opaw_#{key}"] = option.id
+      option.value
+    end
+  end
+
+  def opaw_convert!(key)
+    return if cookies[:opaw_ignore]
+
+    if cookies["opaw_#{key}"]
+      option = Opawesome::TestOption.where(id: cookies["opaw_#{key}"]).first
+
+      if option.nil?
+        cookies["opaw_#{key}"] = nil
+      else
+        option.convert! if cookies[:opaw_valid_session]
+      end
+    end
+  end
+
+  def check_opaw_ignore
+    if params[:opaw_ignore]
+      cookies.permanent[:opaw_ignore] = true
+    end
+  end
+end

data/app/models/opawesome/test.rb

@@ -0,0 +1,47 @@
+class Opawesome::Test < ActiveRecord::Base
+  attr_accessible :key, :name, :options_attributes
+
+  has_many :options, class_name: Opawesome::TestOption
+
+  accepts_nested_attributes_for :options, allow_destroy: true
+
+  validates :key, presence: true, uniqueness: true
+
+  def selection_count
+    options.map(&:selection_count).reduce(:+)
+  end
+
+  def conversion_count
+    options.map(&:conversion_count).reduce(:+)
+  end
+
+  def best_option
+    best_option = options.first
+
+    options.each do |option|
+      if option.conversion_rate > best_option.conversion_rate
+        best_option = option
+      end
+    end
+
+    best_option
+  end
+
+  # TODO: Break this out in to an OptionSelector class so we can support different selection strategies
+  def select_option
+    # round robbin until each option has at least 20 conversions, which gives us a good base to start from
+    options.shuffle.each do |option|
+      return option if option.conversion_count < 20
+    end
+
+    # use the best performing option most of the time, but try others as well
+    epsilon = 0.1
+    random = Random.rand
+
+    if random < epsilon
+      options.sample
+    else
+      best_option
+    end
+  end
+end

data/app/models/opawesome/test_option.rb

@@ -0,0 +1,19 @@
+class Opawesome::TestOption < ActiveRecord::Base
+  attr_accessible :test_id, :value, :conversion_count, :selection_count
+
+  belongs_to :test, class_name: Opawesome::Test
+
+  def conversion_rate
+    (selection_count == 0 or conversion_count == 0) ? 0 : (conversion_count.to_f / selection_count.to_f * 100.0)
+  end
+
+  def select!
+    self.selection_count += 1
+    save!
+  end
+
+  def convert!
+    self.conversion_count += 1
+    save!
+  end
+end

data/app/models/opawesome.rb

@@ -0,0 +1,5 @@
+module Opawesome
+  def self.table_name_prefix
+    'opawesome_'
+  end
+end

data/app/views/opawesome/tests/_option_fields.html.erb

@@ -0,0 +1,5 @@
+<div class="input">
+  <%= f.text_field :value %>
+  <%= f.hidden_field :_destroy %>
+  <%= link_to "Remove", '#', class: "remove_option" %>
+</div>

data/app/views/opawesome/tests/edit.html.erb

@@ -0,0 +1,30 @@
+<h1>Edit Test</h1>
+
+<%= form_for @test, html: {class: 'edit_test'} do |f| %>
+  <div class="input">
+    <%= f.label :name, 'Name' %>
+    <%= f.text_field :name %>
+  </div>
+
+  <h2>Test Options</h2>
+  <p><strong>NOTE:</strong> only edit options to fix typos, if you want to remove an option and add a new one, fully remove the option you want to get rid of and then create a new option. If you don't do this, the conversion stats from the old option will be used.</p>
+  <%= f.fields_for :options do |builder| %>
+    <%= render 'option_fields', f: builder %>
+  <% end %>
+  <%=
+    new_object = Opawesome::TestOption.new
+    id = new_object.object_id
+    fields = f.fields_for(:options, new_object, child_index: id) do |builder|
+      render "option_fields", f: builder
+    end
+    link_to("New Test Option", '#', class: "add_fields btn", data: {id: id, fields: fields.gsub("\n", "")})
+  %>
+
+  <div class="input">
+    <% if @test.new_record? %>
+      <%= f.submit "Create Test", class: 'btn' %>
+    <% else %>
+      <%= f.submit "Update Test", class: 'btn' %>
+    <% end %>
+  </div>
+<% end %>

data/app/views/opawesome/tests/index.html.erb

@@ -0,0 +1,11 @@
+<h1>Opawesome Tests</h1>
+<p>Viewing all tests</p>
+
+<table cellspacing="3" class="admin_dashboard_table">
+  <% @tests.each do |test| %>
+    <tr>
+      <td><%= link_to test.name, opawesome_test_path(test) %></td>
+      <td><%= link_to "Edit", edit_opawesome_test_path(test) %></td>
+    </tr>
+  <% end %>
+</table>

data/app/views/opawesome/tests/show.html.erb

@@ -0,0 +1,33 @@
+<h1><%= @test.name %></h1>
+<p><%= link_to "Edit test and options", edit_opawesome_test_path(@test), class: 'btn' %></p>
+
+<h2>Test options</h2>
+<table>
+  <thead>
+    <tr>
+      <th>Value</th>
+      <th>Selection Count</th>
+      <th>Conversion Count</th>
+      <th>Conversion Rate</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @test_options.each do |option| %>
+      <% if @test.best_option == option %>
+        <tr>
+          <td><strong><%= option.value %></strong></td>
+          <td><strong><%= option.selection_count %></strong></td>
+          <td><strong><%= option.conversion_count %></strong></td>
+          <td><strong><%= option.conversion_rate.round(2) %>%</strong></td>
+        </tr>
+      <% else %>
+        <tr>
+          <td><%= option.value %></td>
+          <td><%= option.selection_count %></td>
+          <td><%= option.conversion_count %></td>
+          <td><%= option.conversion_rate.round(2) %>%</td>
+        </tr>
+      <% end %>
+    <% end %>
+  </tbody>
+</table>

data/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do
+  namespace :opawesome do
+    resources :sessions
+    resources :tests
+  end
+end

data/db/migrate/20130519180140_create_opawesome_tests.rb

@@ -0,0 +1,13 @@
+class CreateOpawesomeTests < ActiveRecord::Migration
+  def change
+    create_table :opawesome_tests do |t|
+      t.string :key
+      t.string :name
+
+      t.timestamps
+    end
+
+    add_index :opawesome_tests, :key
+  end
+end
+

data/db/migrate/20130519180402_create_opawesome_test_options.rb

@@ -0,0 +1,12 @@
+class CreateOpawesomeTestOptions < ActiveRecord::Migration
+  def change
+    create_table :opawesome_test_options do |t|
+      t.integer :test_id
+      t.integer :conversion_count, default: 0
+      t.integer :selection_count, default: 0
+      t.string :value
+
+      t.timestamps
+    end
+  end
+end

data/lib/opawesome/engine.rb

@@ -0,0 +1,14 @@
+module Opawesome
+  class Engine < ::Rails::Engine
+    initializer "opawesome.tracking_methods" do |app|
+      ActionController::Base.send :include, Opawesome::TrackerHelper
+    end
+
+    config.generators do |g|
+      g.test_framework      :rspec,        fixture: false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/opawesome/version.rb

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

data/lib/opawesome.rb

@@ -0,0 +1,7 @@
+require "opawesome/engine"
+
+module Opawesome
+  def self.table_name_prefix
+    'opawesome_'
+  end
+end

data/lib/tasks/opawesome_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :opawesome do
+#   # Task goes here
+# end

data/spec/controllers/opawesome/sessions_controller_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Opawesome::SessionsController do
+  describe "POST 'create'" do
+    it "should respond with an empty success response" do
+      post :create
+      response.should be_successful
+    end
+
+    it "should create a valid optimization session cookie" do
+      post :create
+      cookies[:opaw_valid_session].should eq(true)
+    end
+
+    context "when there are existing test option ids" do
+      before do
+        @test_option = mock_model Opawesome::TestOption, select!: true
+        Opawesome::TestOption.stub(:where){ Opawesome::TestOption }
+        Opawesome::TestOption.stub(:first){ @test_option }
+        cookies[:opaw_test] = @test_option.id
+      end
+
+      it "should find the test option" do
+        Opawesome::TestOption.should_receive(:where).with(hash_including(id: @test_option.id))
+        post :create
+      end
+
+      it "should select the option" do
+        @test_option.should_receive(:select!)
+        post :create
+      end
+
+      context "when the session has already been validated" do
+        before do
+          cookies[:opaw_valid_session] = true
+        end
+
+        it "should not find the test option" do
+          Opawesome::TestOption.should_not_receive(:where)
+          post :create
+        end
+
+        it "should not select the option" do
+          @test_option.should_not_receive(:select!)
+          post :create
+        end
+      end
+    end
+  end
+end