ab-experiments-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88e2708c8ce521f4e13827e5e0a2867d7588ca6f
+  data.tar.gz: b2d2bec56ea3e8ce3a95a1d99548e0d82098680f
+SHA512:
+  metadata.gz: 2cf30639a2b23579e2d716511fbad119f2ffdff62725303ba39e7472409959c43d6ec58ee06edc56bf278c234a8ca2ef2cb0f32de150681eac20b9ad158e8407
+  data.tar.gz: fbcaf5f00622ab95f81babd62f95019338de2687c82b84ed6ae29b535cfade604810b4b5f8e296d6d609be2fbb3693add1dccba32acd49b4ab2745b54edea296

data/Gemfile

@@ -0,0 +1,26 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in ab_experiments_rails.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]
+
+group :development, :test do
+  gem 'jquery-rails', '~> 4.0.3'
+end
+
+group :test do
+  gem 'capybara', '2.12.0'
+  gem 'minitest-rails-capybara'
+  gem 'pry'
+  gem 'selenium-webdriver', '2.53.4'
+  gem 'mocha'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 
+
+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,92 @@
+The ab-experiments-rails is wrap for [google ab experiments](https://developers.google.com/analytics/solutions/experiments-client-side). Work with partials instead of javascript fighting.
+
+## Instalation
+Add gem to your gemfile.
+```
+gem 'ab-experiments-rails', git: 'https://github.com/hlidacky/ab-experiments-rails'
+```
+Run bundle.
+```
+bundle
+```
+Run generator.
+```
+rails generate ab_experiments_rails
+```
+Put this content into head tag before google analytics load. (usually application layout file)
+```
+<%# load before google analytics %>
+<%= yield :google_ab %>
+```
+
+## Create your first ab test
+
+Let's apply ab testing on file like this app/views/pages/landing_page.html.erb
+
+```html
+<h1>Welcome and buy our services</h1>
+<button>
+  Registration...
+</button>
+```
+
+Copy and paste this file app/views/ab_experiments_rails/_example.html.erb
+into landing_page.html.erb and modify it like this
+
+
+```ruby
+<%
+  settings = AbExperimentsRails::Settings.new({
+    test_name: :landing_page_test, # your choice
+    experiment_id: 'EXPERIMENT_ID', # copy/paste from google ab experiments
+    experiment_enabled: true, # on/off your experiment. display only original content when false
+    show_delay: 0.3 # flickering prevention if google choose variant. you can increase or decrease this number (seconds)
+  })
+%>
+<div class="<%= "#{settings.original_class}" %> google_ab_show_later">
+  <h1>Welcome and buy our services</h1>
+  <button>
+    Registration...
+  </button>
+</div>
+<% if settings.experiment_enabled? %>
+  <div class="<%= "#{settings.variant_class} "%> google_ab_hidden">
+    <h1>Welcome and buy our services for half prices</h1>
+    <button>
+      Registration...
+    </button>
+  </div>
+  <%= render "ab_experiments_rails/header_content", settings: settings %>
+<% end %>
+```
+
+Don't forget setup experiment id from your google analytics.
+Your ab test is done!
+
+## How to force display test variant
+
+You can pass parameter into url to display test variant.
+
+If url of your page is
+```
+www.example.com/landing_page
+```
+
+You can force display original
+```
+www.example.com/landing_page?landing_page_test_ab=0
+```
+or variant
+```
+www.example.com/landing_page?landing_page_test_ab=1
+```
+This is useful for development
+
+
+
+
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AbExperimentsRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/ab_experiments_rails.gemspec

@@ -0,0 +1,23 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "ab_experiments_rails"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "ab-experiments-rails"
+  s.version     = AbExperimentsRails::VERSION
+  s.authors     = ["Ondrej Mudroncik"]
+  s.email       = ["gems@hlidacky.cz"]
+  s.homepage    = "https://github.com/hlidacky/ab-experiments-rails"
+  s.summary     = "Google ab experiments wrap"
+  s.description = "The ab-experiments-rails is wrap for google ab experiments. Work with partials instead of javascript fighting."
+  s.license     = "MIT"
+
+  s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.md", "Gemfile", "ab_experiments_rails.gemspec"]
+  s.test_files = Dir["test/**/*"]
+
+  s.add_dependency "rails", "~> 4.2.7.1"
+
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "sqlite3"
+end

data/app/views/ab_experiments_rails/_example.html.erb

@@ -0,0 +1,17 @@
+<%
+  settings = AbExperimentsRails::Settings.new({
+    test_name: :landing_page_test, # your choice
+    experiment_id: 'EXPERIMENT_ID', # copy/paste from google ab experiments
+    experiment_enabled: true, # on/off your experiment. display only original content when false
+    show_delay: 0.3 # flickering prevention if google choose variant. you can increase or decrease this number (seconds)
+  })
+%>
+<div class="<%= "#{settings.original_class}" %> google_ab_show_later">
+  <% # original content... %>
+</div>
+<% if settings.experiment_enabled? %>
+  <div class="<%= "#{settings.variant_class} "%> google_ab_hidden">
+    <% # variant content... %>
+  </div>
+  <%= render "ab_experiments_rails/header_content", settings: settings %>
+<% end %>

data/app/views/ab_experiments_rails/_header_content.html.erb

@@ -0,0 +1,52 @@
+<%# https://developers.google.com/analytics/solutions/experiments-client-side  %>
+<%# The easiest way to do this is to place the default tracking code for either ga.js or analytics.js after the JavaScript that loads the Content Experiments JavaScript client and calls the chooseVariation method. %>
+<%# that means that google_ab needs to after javascript load but before analytics javascript %>
+
+<% content_for :google_ab do %>
+  <style>
+    .google_ab_hidden {
+      display: none !important;
+    }
+    @keyframes google_ab_show_later_animation {
+        from {opacity: 0;}
+        to {opacity: 1;}
+    }
+    .google_ab_show_later {
+      opacity: 1;
+      animation-name: google_ab_show_later_animation;
+      animation-duration: <%= "#{settings.show_delay}s" %>;
+      animation-timing-function: steps(1);
+      -webkit-animation-timing-function: steps(1);
+    }
+  </style>
+
+  <script src="<%= settings.url %>"></script>
+  <script>
+    var chosenVariation = cxApi.chooseVariation();
+  </script>
+
+  <% # Force display original / variant %>
+  <% if params["#{settings.force_param_name}".to_sym].present? %>
+    <% if params["#{settings.force_param_name}".to_sym].to_s == '1' %>
+      <script>chosenVariation = 1</script>
+    <% else %>
+      <script>chosenVariation = 0</script>
+    <% end %>
+  <% end %>
+
+  <script>
+      var pageVariations = [
+        function() {
+          // Original is always visible
+        },
+        function() {
+          $('.<%= settings.original_class %>').hide();
+          $('.<%= settings.variant_class %>').removeClass('google_ab_hidden');
+          $('.<%= settings.variant_class %>').show();
+        }
+      ];
+      $(document).on('ready', function () {
+        pageVariations[chosenVariation].call();
+      });
+  </script>
+<% end %>

data/lib/ab_experiments_rails.rb

@@ -0,0 +1,6 @@
+# Maintain your gem's version:
+require "ab_experiments_rails/version"
+require 'ab_experiments_rails/settings'
+
+module AbExperimentsRails
+end

data/lib/ab_experiments_rails/settings.rb

@@ -0,0 +1,35 @@
+module AbExperimentsRails
+  class Settings
+    attr_accessor :show_delay
+    attr_accessor :test_name
+    attr_accessor :experiment_id
+    attr_accessor :experiment_enabled
+
+    def initialize(options = {})
+      self.show_delay = options[:show_delay]
+      self.test_name = options[:test_name]
+      self.experiment_id = options[:experiment_id]
+      self.experiment_enabled = options[:experiment_enabled]
+    end
+
+    def url
+      "//www.google-analytics.com/cx/api.js?experiment=#{experiment_id}"
+    end
+
+    def original_class
+      "#{test_name}_original"
+    end
+
+    def variant_class
+      "#{test_name}_variant"
+    end
+
+    def experiment_enabled?
+      experiment_enabled == true
+    end
+
+    def force_param_name
+      "#{test_name}_ab"
+    end
+  end
+end

data/lib/ab_experiments_rails/version.rb

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

data/lib/generators/ab_experiments_rails_generator.rb

@@ -0,0 +1,9 @@
+class AbExperimentsRailsGenerator < Rails::Generators::Base
+  source_root File.expand_path('..', __FILE__)
+
+  def copy_header
+  	copy_file '../../app/views/ab_experiments_rails/_header_content.html.erb', 'app/views/ab_experiments_rails/_header_content.html.erb'
+    copy_file '../../app/views/ab_experiments_rails/_example.html.erb', 'app/views/ab_experiments_rails/_example.html.erb'
+  end
+
+end

data/lib/tasks/ab_experiments_rails_tasks.rake

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

data/test/ab_experiments_rails_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class AbExperimentsRailsTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, AbExperimentsRails
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/controllers/pages_controller.rb

@@ -0,0 +1,4 @@
+class PagesController < ApplicationController
+  def landing_page
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/ab_experiments_rails/_header_content.html.erb

@@ -0,0 +1,52 @@
+<%# https://developers.google.com/analytics/solutions/experiments-client-side  %>
+<%# The easiest way to do this is to place the default tracking code for either ga.js or analytics.js after the JavaScript that loads the Content Experiments JavaScript client and calls the chooseVariation method. %>
+<%# that means that google_ab needs to after javascript load but before analytics javascript %>
+
+<% content_for :google_ab do %>
+  <style>
+    .google_ab_hidden {
+      display: none !important;
+    }
+    @keyframes google_ab_show_later_animation {
+        from {opacity: 0;}
+        to {opacity: 1;}
+    }
+    .google_ab_show_later {
+      opacity: 1;
+      animation-name: google_ab_show_later_animation;
+      animation-duration: <%= "#{settings.show_delay}s" %>;
+      animation-timing-function: steps(1);
+      -webkit-animation-timing-function: steps(1);
+    }
+  </style>
+
+  <script src="<%= settings.url %>"></script>
+  <script>
+    var chosenVariation = cxApi.chooseVariation();
+  </script>
+
+  <% # Force display original / variant %>
+  <% if params["#{settings.force_param_name}".to_sym].present? %>
+    <% if params["#{settings.force_param_name}".to_sym].to_s == '1' %>
+      <script>chosenVariation = 1</script>
+    <% else %>
+      <script>chosenVariation = 0</script>
+    <% end %>
+  <% end %>
+
+  <script>
+      var pageVariations = [
+        function() {
+          // Original is always visible
+        },
+        function() {
+          $('.<%= settings.original_class %>').hide();
+          $('.<%= settings.variant_class %>').removeClass('google_ab_hidden');
+          $('.<%= settings.variant_class %>').show();
+        }
+      ];
+      $(document).on('ready', function () {
+        pageVariations[chosenVariation].call();
+      });
+  </script>
+<% end %>