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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 nate
+
+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,60 @@
+# SimpleAbs
+
+A super super simple way to do AB tests in Rails. 
+
+I made this because everything else seemed overly complicated. You don't need to install Redis or anything like that. 
+
+Definitely inspired by other AB testing libraris like AB Bingo from patio11. 
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_abs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_abs
+
+Create the migration to install the Alternatives table: 
+
+    rails g simple_abs
+
+Run the migrations: 
+
+    rake db:migrate
+
+
+## Usage
+
+You can use simple_abs to figure out an "alternative" to show your users. You can get ahold of an alternative from a View or from a Controller. 
+
+Here's an example where I might have a short and long version of a buy page. simple_abs will randomly pick which version this user should see.
+
+    def buy
+      @buy_page = ab_test("buy_page", ["short", "long"])
+
+      render template: 'site/buy', layout: 'write'
+    end
+
+If they've already seen one of the alternatives, simple_abs figures that out from the permanent cookies of the user. 
+
+Once your user converts you can call: 
+
+    converted!("buy_page")
+
+
+
+
+## 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/lib/generators/simple_abs/simple_abs_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class SimpleAbsGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.new.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/create_alternatives_table.rb'
+  end
+
+end

data/lib/generators/simple_abs/templates/migration.rb

@@ -0,0 +1,19 @@
+class CreateAlternativesTable < ActiveRecord::Migration
+  def self.up
+    create_table :alternatives, :force => true do |t|
+      t.string   "which"
+      t.integer  "participants", :default => 0
+      t.integer  "conversions",  :default => 0
+      t.text     "experiment"
+
+      t.timestamps
+    end
+
+    add_index :alternatives, :which
+
+  end
+
+  def self.down
+    drop_table :alternatives
+  end
+end

data/lib/simple_abs/version.rb

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

data/lib/simple_abs.rb

@@ -0,0 +1,63 @@
+require "simple_abs/version"
+
+module SimpleAbs
+
+  def is_bot?
+    agent = request.env["HTTP_USER_AGENT"]
+    matches = nil
+    matches = agent.match(/(facebook|postrank|voyager|twitterbot|googlebot|slurp|butterfly|pycurl|tweetmemebot|metauri|evrinid|reddit|digg)/mi) if agent
+    if (agent.nil? or matches)
+      return true
+    else
+      return false
+    end
+  end
+  
+  def ab_test(name, tests)
+    
+    if is_bot?
+      test_value = tests[rand(tests.size)]
+      return test_value
+    end
+    
+    if params[:test_value]
+      return params[:test_value]
+    end
+    
+    test_value = cookies[name]
+    
+    if test_value.blank? || !tests.include?(test_value)
+      test_value = tests[rand(tests.size)]
+      cookies.permanent[name] = test_value
+      
+      Alternative.find_or_create_by_experiment_and_which(name, test_value).increment!(:participants)
+    end
+    
+    return test_value
+  end
+  
+  def converted!(name)
+  
+    if !is_bot?
+      test_value = cookies[name]
+      if test_value && cookies[name.to_s + "_converted"].blank?
+        Alternative.find_or_create_by_experiment_and_which(name, test_value).increment!(:conversions)
+        cookies.permanent[name.to_s + "_converted"] = true
+      end
+    end
+  end
+
+
+  class Railtie < Rails::Railtie
+    initializer "simple_abs.initialize" do 
+      ActionView::Base.send :include, SimpleAbs
+      ActionController::Base.send :include, SimpleAbs
+    end
+  end
+
+  class Alternative < ActiveRecord::Base
+
+  end
+
+
+end

data/simple_abs.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_abs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_abs"
+  spec.version       = SimpleAbs::VERSION
+  spec.authors       = ["nate"]
+  spec.email         = ["nate@cityposh.com"]
+  spec.description   = %q{Really simple way to do AB tests in Rails}
+  spec.summary       = %q{Really simple way to do AB tests in Rails}
+  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"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: simple_abs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- nate
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-16 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'
+description: Really simple way to do AB tests in Rails
+email:
+- nate@cityposh.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/simple_abs/simple_abs_generator.rb
+- lib/generators/simple_abs/templates/migration.rb
+- lib/simple_abs.rb
+- lib/simple_abs/version.rb
+- simple_abs.gemspec
+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: Really simple way to do AB tests in Rails
+test_files: []