caboose-cms 0.3.20 → 0.3.22

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODg5MTMwYTQ4MmM5MDgwYzE4YTNhOTVkOTJmNjU1YjU4MmU0YmFkNg==
+    MzhlOGU4ZDRlZmYxZGIzODk0Zjk0NDhhM2IwYjM2ZTViMjlmZTA2ZA==
   data.tar.gz: !binary |-
-    ZmQ3YzA1ZjU2ZGEwOTYyNWRiMjkxZWFhYzU5MDlkYjZhNmIxNGQzMw==
+    OWUwZmM5MjdkNmEwNWJkMWIzYjlkN2Q4NTBiMjliZmNkNDM5MzZiNQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NTIxZjMzNTBmMmJmOTE0NzdiNmQ4ZmIyZGVlMGRlZDQyNGQxOWEzNzAxZDA3
-    ZTE1YTI4OGEzMmYwNGJjMzNkMGJkMjgyMzQwZDU3Njg2MTliNTdmOTZlMWFj
-    OTU5MWYwY2M1MTY4ZDQ1NTgzMjU3MGZjNzc4OGViM2ZhNzdjNzI=
+    YjNhYjE1MzU1ZmU4NTQzOWFjMDY5ZmVjM2UwY2NhMzFmNDViMjE0ZTBhY2Ux
+    NDA1ODFiMGQyZGMzNWQ1MTcxZjMxMGI1MjAzZDliYjNlYzdlNWE4YTY4Yzc0
+    OTRmMzkwMmFkODcxYmVkM2I5MzAzMmI1YWU2NDI3NDQwZjJmYWU=
   data.tar.gz: !binary |-
-    MmRmZWE4OGM0MTMzZmIyYzQwZmViMDVjYjJjMTExMWNiNWRlZGExZTI4YTgx
-    NjNjYzgyODllMmYwZDMxY2ZhMTE4ZWY2NmU5YTcxNjMyNmI2NzQyNmQ2Nzc1
-    ODIzN2VjYjQ0MThlYzdiNTg5M2ZkZjJhYmVjOTE4N2NjNTM5NGE=
+    ZmQ2YTQ4N2Q4M2U3MGJkYWYwNmNhYjczZDU4YTEzZmYwODM2NDBhN2RlMDRm
+    NDBkMGU4ZGJiZDAxMjI2NWRkMGQzMjc2ZTVkOTQ5YTNiYWFkNTMwNjMyNmE5
+    MTg5N2M5Yjc4ZjY3Yjg3Y2FhOTkwMTY5M2Q3NGIxM2UyM2Q1N2Y=

data/app/controllers/caboose/ab_options_controller.rb

@@ -0,0 +1,57 @@
+module Caboose
+  class AbOptionsController < ApplicationController
+    layout 'caboose/admin'
+
+    # GET /admin/ab_variants/:variant_id/options
+    def admin_index
+      return unless user_is_allowed_to 'view', 'ab_variants'
+      v = AbVariant.find(params[:variant_id])
+      render :json => v.ab_options
+    end
+
+    # POST admin/ab-variants/:variant_id/options'
+    def admin_create
+      return unless user_is_allowed_to 'edit','ab_variants'
+      
+      resp = StdClass.new({
+        'error' => nil,
+        'redirect' => nil
+      })
+      
+      opt = AbOption.create(
+        :ab_variant_id => params[:variant_id],
+        :text => params[:text]
+      )      
+      resp.redirect = "/admin/ab-variants/#{params[:variant_id]}"      
+      render :json => resp
+    end
+
+    # PUT /admin/ab_options/:id
+    def admin_update
+      return unless user_is_allowed_to 'edit', 'ab_variants'
+
+      resp = StdClass.new
+      opt = AbOption.find(params[:id])
+
+      save = true
+      params.each do |k,v|
+        case k
+          when 'text'
+            opt.text = v
+            break
+        end
+      end      
+
+      resp.success = save && opt.save      
+      render :json => resp
+    end
+
+    # DELETE /admin/ab_options/:id
+    def admin_delete
+      return unless user_is_allowed_to 'delete', 'ab_variants'      
+      AbOption.find(params[:id]).destroy                  
+      render :json => true
+    end
+
+  end
+end

data/app/controllers/caboose/ab_variants_controller.rb

@@ -0,0 +1,88 @@
+module Caboose
+  class AbVariantsController < ApplicationController
+    layout 'caboose/admin'
+
+    def before_action
+      @page = Page.page_with_uri('/admin')
+    end
+
+    # GET /admin/ab_variants
+    def admin_index
+      return unless user_is_allowed_to 'view', 'ab_variants'
+
+      @gen = PageBarGenerator.new(params, {'name' => '', 'analytics_name' => ''}, {
+        'model' => 'Caboose::AbVariant',
+        'sort'  => 'name',
+        'desc'  => 'false',
+        'base_url' => '/admin/ab-variants'
+      })
+      @variants = @gen.items
+    end
+
+    # GET /admin/ab_variants/new
+    def admin_new
+      return unless user_is_allowed_to 'add', 'ab_variants'
+      @variant = AbVariant.new
+    end
+
+    # GET /admin/ab_variants/:id
+    def admin_edit
+      return unless user_is_allowed_to 'edit', 'ab_variants'
+      @variant = AbVariant.find(params[:id])
+    end
+
+    # POST /admin/ab-variants
+    def admin_create
+      return unless user_is_allowed_to 'edit', 'ab_variants'
+
+      resp = StdClass.new({
+        'error' => nil,
+        'redirect' => nil
+      })
+
+      variant = AbVariant.new
+      variant.name = params[:name]
+      variant.analytics_name = params[:name].gsub(' ', '_').downcase
+
+      if (variant.name.length == 0)
+        resp.error = "A name is required."
+      elsif variant.save
+        resp.redirect = "/admin/ab-variants/#{variant.id}"
+      end
+      
+      render json: resp
+    end
+
+    # PUT /admin/ab_variants/:id
+    def admin_update
+      return unless user_is_allowed_to 'edit', 'ab_variants'
+
+      resp = StdClass.new
+      variant = AbVariant.find(params[:id])
+
+      save = true
+      params.each do |k,v|
+        case k
+          when 'name'
+            variant.name = v
+            break
+          when 'analytics_name'
+            variant.analytics_name = v
+            break
+        end
+      end
+
+      resp.success = save && variant.save
+      render :json => resp
+    end
+
+    # DELETE /admin/ab_variants/:id
+    def admin_destroy
+      return unless user_is_allowed_to 'delete', 'ab_variants'      
+      AbVariants.find(params[:id]).destroy
+      resp = StdClass.new('redirect' => '/admin/ab-variants')
+      render :json => resp
+    end
+
+  end
+end

data/app/controllers/caboose/application_controller.rb

@@ -13,6 +13,7 @@ module Caboose
       @page = Page.page_with_uri(request.fullpath)
       
       session['use_redirect_urls'] = true if session['use_redirect_urls'].nil?
+      assign_ab_variants      
       
       @crumb_trail  = Caboose::Page.crumb_trail(@page)
 		  @subnav       = {}
@@ -23,10 +24,10 @@ module Caboose
       
       # Sets an instance variable of the logged in user
       @logged_in_user = logged_in_user
-      
+
       before_action
     end
-    
+
     # Parses any parameters in the URL and adds them to the params
     def parse_url_params      
       return if !Caboose.use_url_params      
@@ -96,6 +97,8 @@ module Caboose
       return session["app_user"]
     end
     
+    # DEPRECATED: Use user_is_allowed_to(action, resource)
+    #
     # Checks to see if a user has permission to perform the given action 
     # on the given resource.
     # Redirects to login if not logged in.
@@ -115,7 +118,31 @@ module Caboose
       
       return true    
     end
-    
+
+    # Checks to see if a user has permission
+    # to perform action on resource
+    #
+    # Redirects to login if not logged in
+    # Redirects to error page with message if not allowed
+    #
+    # useful for creating super-readable code, for example:
+    #   > return unless user_is_allowed_to 'edit', 'pages'
+    # Even your mom could read that code.
+    def user_is_allowed_to(action, resource)
+      unless logged_in?
+        redirect_to "/login?return_url=" + URI.encode(request.fullpath)
+        return false
+      end
+
+      @user = logged_in_user
+      unless @user.is_allowed(resource, action)
+        @error = "You don't have permission to #{action} #{resource}"
+        render :template => "caboose/extras/error"
+        return false
+      end
+      return true
+    end
+
     # Redirects to login if not logged in.
     def verify_logged_in
       if (!logged_in?)
@@ -147,5 +174,44 @@ module Caboose
         return "" if v.nil?    
       return v.val
     end
+    
+    #===========================================================================
+    # AB Testing
+    #===========================================================================
+    
+    # Sets the ab_variants for the user's session
+    def assign_ab_variants
+      return if session['ab_variants']
+            
+      h = {}
+      arr = []
+      AbVariant.find_each do |var|
+        next if var.ab_options.nil? || var.ab_options.count == 0
+        i = rand(var.ab_options.count)
+        h[var.analytics_name] = var.ab_options[i].text
+        arr << "#{var.analytics_name}=#{i+1}"
+      end
+      session['ab_variants'] = h
+      session['ab_variants_analytics_string'] = "|#{arr.join('|')}|"
+    end
+
+    # Get the variant option text for the given variant name.     
+    def ab_option_for(analytics_name)
+      assign_ab_variants if session['ab_variants'].nil?
+      return session['ab_variants'][analytics_name] if !session['ab_variants'][analytics_name].nil?
+
+      # Otherwise, add the new variant to the session
+      var = AbVariant.find(:analytics_name => analytics_name).first
+      i = rand(var.ab_options.count)        
+      session['ab_variants'][var.analytics_name] = var.ab_options[i].text      
+      session['ab_variants_analytics_string'] << "#{var.analytics_name}=#{i+1}|"
+    end
+    
+    # Gets the string to be sent to google analytics
+    def analytics_string
+      assign_ab_variants if session['ab_variants_analytics_string'].nil?
+      return "#{session['ab_variants_analytics_string']}"
+    end      
+      
   end
 end

data/app/helpers/caboose/pages_helper.rb

@@ -20,5 +20,10 @@ module Caboose
       return str
     end
     
+    def ab_variants_analytics_code
+      str = session['ab_variants_analytics_string']
+      return "var _gaq = _gaq || [];\n_gaq.push(['_setCustomVar', 1, 'caboose_ab_variants', #{Caboose.json(str)}]);"            
+    end
+    
   end
 end

data/app/models/caboose/ab_option.rb

@@ -0,0 +1,7 @@
+class Caboose::AbOption < ActiveRecord::Base
+
+  self.table_name = "ab_options"
+  belongs_to :ab_variant
+  attr_accessible :text, :ab_variant_id
+
+end

data/app/models/caboose/ab_variant.rb

@@ -0,0 +1,22 @@
+# Class for A-B testing variants. A variant is a set of changes
+# to the same element on a page. For example, a variant can be used
+# to change the button text, or images displayed, or even more
+# complicated behavior
+class Caboose::AbVariant < ActiveRecord::Base
+  self.table_name = "ab_variants"
+  
+  has_many :ab_options, :order => 'id', :dependent => :destroy
+  attr_accessible :name, :analytics_name
+
+  def get_session_option
+    return "" unless self.ab_options
+    opt = self.ab_options.sample
+    return {text: opt.text, id: opt.id}
+  end
+  
+  #def random_option
+  #  return nil self.ab_options.nil? || self.ab_options.count == 0
+  #  return self.ab_options.sample    
+  #end
+
+end

data/app/models/caboose/core_plugin.rb

@@ -20,12 +20,13 @@ class Caboose::CorePlugin < Caboose::CaboosePlugin
       'text' => 'Settings',
       'children' => []
     }
-    
+        
     item['children'] << { 'id' => 'users'        , 'text' => 'Users'            , 'href' => '/admin/users'            , 'modal' => false } if user.is_allowed('users'          , 'view')
     item['children'] << { 'id' => 'roles'        , 'text' => 'Roles'            , 'href' => '/admin/roles'            , 'modal' => false } if user.is_allowed('roles'          , 'view')
     item['children'] << { 'id' => 'permissions'  , 'text' => 'Permissions'      , 'href' => '/admin/permissions'      , 'modal' => false } if user.is_allowed('permissions'    , 'view')
+    item['children'] << { 'id' => 'blocktypes'   , 'text' => 'AB Test Variants' , 'href' => '/admin/ab-variants'      , 'modal' => false } if user.is_allowed('abvariants'     , 'view')
     item['children'] << { 'id' => 'variables'    , 'text' => 'Variables'        , 'href' => '/admin/settings'         , 'modal' => false } if user.is_allowed('settings'       , 'view')
-    item['children'] << { 'id' => 'blocktypes'   , 'text' => 'Page Block Types' , 'href' => '/admin/page-block-types' , 'modal' => false } if user.is_allowed('pageblocktypes' , 'view')
+    item['children'] << { 'id' => 'blocktypes'   , 'text' => 'Page Block Types' , 'href' => '/admin/page-block-types' , 'modal' => false } if user.is_allowed('pageblocktypes' , 'view')    
         
     nav << item if item['children'].count > 0
     
@@ -39,6 +40,9 @@ class Caboose::CorePlugin < Caboose::CaboosePlugin
     item['children'] << { 'id' => 'posts'        , 'text' => 'Posts'       , 'href' => '/admin/posts'        , 'modal' => false } if user.is_allowed('posts'       , 'view')
     
     nav << item if item['children'].count > 0    
+    if user.is_allowed('ab-variants','view')
+      nav << { 'id' => 'ab_variants', 'text' => 'AB Testing', 'href' => '/admin/ab-variants', 'modal' => false }
+    end
     return nav
   end
   

data/app/models/caboose/schema.rb

@@ -143,6 +143,14 @@ class Caboose::Schema < Caboose::Utilities::Schema
         [ :page_id , :integer  ],
         [ :action  , :string   ]
       ],
+      Caboose::AbVariant => [
+        [ :name           , :string ],
+        [ :analytics_name , :string ],
+      ],
+      Caboose::AbOption => [
+        [ :text          , :string  ],
+        [ :ab_variant_id , :integer ]
+      ],
       Caboose::DatabaseSession => [
         [ :session_id  , :string   , :null => false ],
         [ :data        , :text                      ],

data/app/models/caboose/utilities/schema.rb

@@ -45,11 +45,17 @@ class Caboose::Utilities::Schema
     c = ActiveRecord::Base.connection
     self.schema.each do |model, columns|
       tbl = model.table_name
-      #puts "Creating table #{tbl}..."
+      puts "Creating table #{tbl}..."
       c.create_table tbl if !c.table_exists?(tbl)
       columns.each do |col|
-        #puts "Creating column #{tbl}.#{col[0]}..."                 
+        puts "Creating column #{tbl}.#{col[0]}..."
         
+        # Special case for attachments
+        if col[1] == :attachment          
+          c.add_attachment tbl, col[1] if !c.column_exists?(tbl, "#{col[1]}_file_size")            
+          next
+        end
+                
         # Skip if the column exists with the proper data type
         next if c.column_exists?(tbl, col[0], col[1])
         

data/app/views/caboose/ab_variants/admin_edit.html.erb

@@ -0,0 +1,99 @@
+<h1>Editing AB Test Variant</h1>
+
+<div id="abvariant_<%= @variant.id %>_name"></div>
+<div id="abvariant_<%= @variant.id %>_analytics_name"></div>
+
+<p>Google analytics search term: <code>caboose_ab_variants="*|<%= @variant.analytics_name %>=1|*"</code></p>
+<h2>Options</h2>
+<% if @variant.ab_options && @variant.ab_options.count > 0 %>  
+  <table>
+  <% @variant.ab_options.each do |opt| %>
+    <tr>
+      <td><div id="aboption_<%= opt.id %>_text"></div></td>
+      <td><input type='button' value='Delete' onclick="delete_option(<%= opt.id %>);" /></td>
+    </tr>
+  <% end %>
+  </table>
+<% else %>
+  <p>This variant doesn't have any options.</p>
+<% end %>
+
+<div id="message"></div>
+<p>
+<input type='button' value='Back' onclick="window.location='/admin/ab-variants';" >
+<input type='button' value='Add New Option' onclick="add_option();" >
+</p>
+
+<% content_for :caboose_js do %>
+<%= javascript_include_tag "caboose/model/all" %>
+<script type="text/javascript">
+
+function delete_option(option_id, confirm) 
+{
+  if (!confirm)
+  {
+    var p = $('<p/>').addClass('note warning')
+      .append("Are you sure you want to delete the option? ")
+      .append($('<input/>').attr('type','button').val('Yes').click(function() { delete_option(option_id, true); })).append(' ')
+      .append($('<input/>').attr('type','button').val('No').click(function() { $('#message').empty(); }));      
+    $('#message').empty().append(p);
+    return;
+  }  
+  $('#message').empty().html($('<p/>').addClass('loading').html("Deleting option..."));
+  $.ajax({
+    url: '/admin/ab-options/' + option_id,
+    type: 'delete',    
+    success: function(resp) {
+      if (resp.error) $('#message').html("<p class='note error'>" + resp.error + "</p>");
+      else window.location.reload(true);
+    }
+  });
+}
+
+function add_option() {
+  $('#message').html("<p class='loading'>Adding new A/B Option...</p>");
+  $.ajax({
+    url: '/admin/ab-variants/<%= @variant.id %>/options',
+    type: 'post',
+    data: {
+      text: ""
+    },
+    success: function(resp) {
+      if (resp.error) $('#message').html("<p class='note error'>" + resp.error + "</p>");
+      if (resp.redirect) window.location.reload(true);
+    }
+  });
+}
+
+$(document).ready(function() {
+
+  m = new ModelBinder({
+    name: 'abvariant',
+    id: <%= @variant.id %>,
+    update_url: '/admin/ab-variants/<%= @variant.id %>',
+    authenticity_token: '<%= form_authenticity_token %>',
+    attributes: [
+      { name: 'name'           , nice_name: 'Variant Name'          , type: 'text', value: <%= raw Caboose.json(@variant.name) %>           , width: 800 },
+      { name: 'analytics_name' , nice_name: 'Google Analytics Name' , type: 'text', value: <%= raw Caboose.json(@variant.analytics_name) %> , width: 800 }      
+    ]
+  });
+
+  <% if @variant.ab_options && @variant.ab_options.count > 0 %>
+    <% i = 1 %>
+    <% @variant.ab_options.each do |opt| %>
+      m = new ModelBinder({
+        name: 'aboption',
+        id: <%= opt.id %>,
+        update_url: '/admin/ab-options/<%= opt.id %>',
+        authenticity_token: '<%= form_authenticity_token %>',
+        attributes: [
+          { name: 'text', nice_name: 'Option <%= i %>', type: 'text', value: <%= raw Caboose.json(opt.text) %> , width: 800 }            
+        ]
+      });
+      <% i = i + 1 %>
+    <% end %>
+  <% end %>
+});
+
+</script>
+<% end %>

data/app/views/caboose/ab_variants/admin_index.html.erb

@@ -0,0 +1,17 @@
+<h1>A/B Test Variants</h1>
+
+<p><a href='/admin/ab-variants/new'>New Variant</a></p>
+<% if (@variants.count > 0) %>
+  <table class='data'>
+    <tr><%= raw @gen.sortable_table_headings({'name' => 'Variant Name', 'analytics_name' => 'Analytics Name'}) %></tr>
+    <% @variants.each do |v| %>
+      <tr onclick="window.location='/admin/ab-variants/<%= v.id %>';">
+        <td><%= v.name %></td>
+        <td><%= v.analytics_name %></td>
+      </tr>
+    <% end %>
+  </table>
+  <p><%= raw @gen.generate %></p>
+<% else %>
+  <p>No A/B variants found.</p>
+<% end %>

data/app/views/caboose/ab_variants/admin_new.html.erb

@@ -0,0 +1,36 @@
+<h1>New AB Test</h1>
+
+<form action='/admin/ab-variants' method='post' id='ab_variant_form'>
+  <input type='hidden' name='authenticity_token' value='<%=form_authenticity_token %>'>
+  <p><input type='text' name='name' id='name' placeholder='AB Variant Name' style='width: 500px;'></p>
+  <div id='message'></div>
+  <p>
+  <input type='button' value='< Back' onclick="window.location='/admin/ab-variants';">
+  <input type='submit' value='Add New A/B Variant' onclick="add_ab_variant(); return false;">
+  </p>
+</form>
+
+<% content_for :caboose_js do %>
+<script type='text/javascript'>
+
+function add_ab_variant() 
+{
+  $('#message').html("<p class='loading'>Adding A/B Variant...</p>");
+  $.ajax({
+    url: '/admin/ab-variants',
+    type: 'post',
+    data: $('#ab_variant_form').serialize(),
+    success: function(resp) {
+      if (resp.error) $('#message').html("<p class='note error'>" + resp.error + "</p>");
+      if (resp.redirect) window.location = resp.redirect;
+    }
+  });
+}
+
+var modal = false;
+$(window).load(function() {
+  modal = new CabooseModal(800);
+});
+
+</script>
+<% end %>

data/config/routes.rb

@@ -115,6 +115,18 @@ Caboose::Engine.routes.draw do
   get     "admin/posts"                           => "posts#admin_index"
   post    "admin/posts"                           => "posts#admin_add"  
   delete  "admin/posts/:id"                       => "posts#admin_delete"
+
+  get     "admin/ab-variants"                     => "ab_variants#admin_index"
+  get     "admin/ab-variants/new"                 => "ab_variants#admin_new"
+  get     "admin/ab-variants/:id"                 => "ab_variants#admin_edit"
+  put     "admin/ab-variants/:id"                 => "ab_variants#admin_update"
+  post    "admin/ab-variants"                     => "ab_variants#admin_create"  
+  delete  "admin/ab-variants/:id"                 => "ab_variants#admin_delete"
+  
+  get     "admin/ab-variants/:variant_id/options" => "ab_options#admin_index"    
+  put     "admin/ab-options/:id"                  => "ab_options#admin_update"
+  post    "admin/ab-variants/:variant_id/options" => "ab_options#admin_create"
+  delete  "admin/ab-options/:id"                  => "ab_options#admin_delete"
   
   match '*path' => 'pages#show'
   root :to => 'pages#show'

data/lib/caboose/version.rb

@@ -1,3 +1,3 @@
 module Caboose
-  VERSION = '0.3.20'
+  VERSION = '0.3.22'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caboose-cms
 version: !ruby/object:Gem::Version
-  version: 0.3.20
+  version: 0.3.22
 platform: ruby
 authors:
 - William Barry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-17 00:00:00.000000000 Z
+date: 2014-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -166,6 +166,8 @@ files:
 - app/assets/stylesheets/caboose/station_modal.css
 - app/assets/stylesheets/caboose/station_sidebar.css
 - app/assets/stylesheets/caboose/tinymce.css
+- app/controllers/caboose/ab_options_controller.rb
+- app/controllers/caboose/ab_variants_controller.rb
 - app/controllers/caboose/admin_controller.rb
 - app/controllers/caboose/application_controller.rb
 - app/controllers/caboose/login_controller.rb
@@ -186,6 +188,8 @@ files:
 - app/helpers/caboose/pages_helper.rb
 - app/helpers/caboose/permissions_helper.rb
 - app/helpers/caboose/products_helper.rb
+- app/models/caboose/ab_option.rb
+- app/models/caboose/ab_variant.rb
 - app/models/caboose/approval_request.rb
 - app/models/caboose/asset.rb
 - app/models/caboose/authenticator.rb
@@ -221,6 +225,9 @@ files:
 - app/models/caboose/std_class.rb
 - app/models/caboose/user.rb
 - app/models/caboose/utilities/schema.rb
+- app/views/caboose/ab_variants/admin_edit.html.erb
+- app/views/caboose/ab_variants/admin_index.html.erb
+- app/views/caboose/ab_variants/admin_new.html.erb
 - app/views/caboose/admin/index.html.erb
 - app/views/caboose/application/show.html.erb
 - app/views/caboose/extras/error.html.erb