gace 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: daa51fe76dd40742233606f9f42522d7d25cbc0d
+  data.tar.gz: 8637b97fad5ebe838843c8e33b90eafb3cc1eef2
+SHA512:
+  metadata.gz: 39ec8cc47378d74b7d7254db905a281110e13705f1e60eebc41b406af1ba4b86fe57b0ac29c83be06ea82c35fec5b0ca060aff9bc5bf9a87599a9616ec29a9bb
+  data.tar.gz: 959ad4d43b34fbed2bc009d400636e6ff0819643419a767f9110d22e2ffcc20da8c0c8f796f16d1b6af7f2919d051266746b2a0d0884a526ea77192d38ad6484

data/.gitignore

@@ -0,0 +1,32 @@
+# documentation
+/.yardoc
+/_yardoc/
+/doc/
+
+# temp files
+/tmp/
+*.so
+*.o
+*.a
+mkmf.log
+
+# test files
+/coverage/
+/spec/reports/
+
+# OSX files
+.DS_Store
+
+# bundler files
+/pkg/
+/.bundle/
+/Gemfile.lock
+*.bundle
+
+# dummy app files
+log/*.log
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/CONTRIBUTING.md

@@ -0,0 +1,67 @@
+# Development Workflow
+
+## Resources
+* [Git Workflow Presentation](https://docs.google.com/presentation/d/1euOiki_e4OQ4jymGhS-o3xcET8-KZhDONUolDlOVT30/edit?usp=sharing)
+* [The Garage git extensions gem](https://github.com/thegarage/thegarage-gitx)
+
+## Step 1:  Create feature branch...
+
+```bash
+$ git start my-feature-branch
+```
+
+* The `start` command ensures your branch name is valid and your codebase is uptodate.
+* Use a descriptive branch name to help other developers (ex: fix-login-screen, api-refactor, payment-reconcile, etc)
+
+## Step 2: Implement the requested change...
+Use [Test Driven Development](http://en.wikipedia.org/wiki/Test-driven_development) to ensure that the feature has proper code coverage.
+
+* **RED** - Write tests for the desired behavior...
+* **GREEN** - Write just enough code to get the tests to pass...
+* **REFACTOR** - Cleanup for clarity and DRY-ness...
+
+
+### Development Protips™
+* Follow [best practices](http://robots.thoughtbot.com/post/48933156625/5-useful-tips-for-a-better-commit-message) for git commit messages to communicate your changes.
+* Add [ticket references to commits to automatically trigger product management workflows](http://help.sprint.ly/knowledgebase/articles/108139-available-scm-vcs-commands)
+* Only write the **minimal** amount of code necessary to accomplish the given task.
+* Ensure branch stays up-to-date with latest changes that are merged into master by using: `$ git update`
+* Changes that are not directly related to the current feature should be cherry-picked into their own branch and merged separately.
+
+### Testing Protips™
+* Every line of code should have associated unit tests.  If it's not tested, it's probably broken and you just don't know it yet...
+* Use [BetterSpecs.org](http://betterspecs.org/) as reference for writing readable and maintainable unit tests.
+
+
+## Step 3: Peer Review (aka Pull Request)...
+
+```
+$ git review
+```
+
+* Describe high level overview of the branch in pull request description.  Include links to relevant resources.
+* Record **artifacts** created by this feature (ex: screenshots of UI changes, screencasts of UX changes, logs from database migrations, etc)
+* Document **follow-up** items/tasks that need to be addressed post-release
+
+### Questions to ask...
+* Is there a simpler way to accomplish the task at hand?
+* Are we solving the problems of today and not over engineering for the problems of tomorrow?
+
+## Step 4: QA
+
+> With great power comes great responsibility…
+
+* You are responsible to test your changes locally and in production environments as necessary
+* Test changes in local development environment using the same process used by Continuous Integration with: `$ rake ci`
+* Smoketest all changes locally and in staging environment when appropriate with: `$ git integrate staging`
+
+## Step 5: Sign-off and release
+
+```
+$ git release
+```
+
+* Ensure that build is green before releasing branch
+* Pull requests must be signed off by team leads before release (preferrably via :shipit: emoji)
+
+## Step 5: Profit?

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gace.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 The Garage
+
+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,67 @@
+[![Build Status](https://travis-ci.org/thegarage/gace.svg?branch=master)](https://travis-ci.org/thegarage/gace)
+
+# GACE
+> Google Analytics Content Experiments + Rails = AWESOME
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gace'
+```
+
+Update your view layout to include the necessary javascript.
+**Make sure to include the javascript at the very top of your head element** (per Google Analytics installation instructions).
+
+```html
+<<!DOCTYPE html>
+<html>
+<head>
+  <%= gace_javascript_include %>
+</head>
+<body>
+</body>
+</html>
+```
+
+## Usage
+
+#### Setup experiment in Google Analytics
+Configure each variation with a different `gace_var` parameter value.
+
+example:
+* control: `http://mysite.com/signup`
+* variation one: `http://mysite.com/signup?gace_var=expensive`
+* variation two: `http://mysite.com/signup?gace_var=cheap`
+
+Make sure to record the newly created experiment ID.
+
+
+#### Configure the experiment within Rails
+```ruby
+class UsersController < ApplicationController
+  def show
+    define_experiment :test_pricing, '28391929-0'
+  end
+end
+```
+
+#### Create views for experiment variations
+
+1. Create a directory for the experiment: `app/experiments/EXPERIMENT_NAME` (ex: app/experiments/test_pricing)
+2. Create a directory for each experiment variation.  The directory name **must match** the `gace_var` parameter
+   used when setting up the experiment in Google Analytics.  (ex: `app/experiments/test_pricing/expensive` and `app/experiments/test_pricing/cheap`)
+3. Create any views/partials to be used for that variation.  Each directory should mirror structure used by app/views and will override
+   the default views if one exists.  (ex: `app/experiments/test_pricing/expensive/users/show.html.erb`)
+
+## Contributing
+
+1. Fork it ( https://github.com/thegarage/gace/fork )
+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 a new Pull Request
+
+## Related Projects
+* [weebo](https://github.com/clemens/weebo)

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/setup'
+require "bundler/gem_tasks"
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task default: :spec

data/gace.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gace/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gace'
+  spec.version       = Gace::VERSION
+  spec.authors       = ['Ryan Sonnek']
+  spec.email         = ['ryan@codecrate.com']
+  spec.summary       = %q(Rails integration for Google Analytics Content Experiments)
+  spec.description   = %q(GACE is a simple way to integrate content experiments into your Rails application)
+  spec.homepage      = 'https://github.com/thegarage/gace'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 'rails', '>= 4.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'shoulda-matchers'
+  spec.add_development_dependency 'pry'
+end

data/lib/gace.rb

@@ -0,0 +1,5 @@
+require 'gace/version'
+require 'gace/railtie'
+
+module Gace
+end

data/lib/gace/controller_helpers.rb

@@ -0,0 +1,26 @@
+module Gace
+  module ControllerHelpers
+    extend ActiveSupport::Concern
+
+    included do |base|
+      base.send(:attr_reader, :experiment_key)
+      base.helper_method :experiment_key
+      base.helper_method :experiment_control?
+    end
+
+    private
+
+    def experiment_control?
+      experiment_key && !params[:gace_var]
+    end
+
+    def define_experiment(name, experiment_key)
+      @experiment_key = experiment_key
+
+      if params[:gace_var]
+        variation_path = Rails.root.join('app/experiments', name.to_s, params[:gace_var])
+        prepend_view_path(variation_path)
+      end
+    end
+  end
+end

data/lib/gace/railtie.rb

@@ -0,0 +1,11 @@
+require 'gace/view_helpers'
+require 'gace/controller_helpers'
+
+module Gace
+  class Railtie < Rails::Railtie
+    initializer 'gace.view_helpers' do |app|
+      ActionView::Base.send :include, Gace::ViewHelpers
+      ActionController::Base.send :include, Gace::ControllerHelpers
+    end
+  end
+end

data/lib/gace/version.rb

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

data/lib/gace/view_helpers.rb

@@ -0,0 +1,22 @@
+module Gace
+  module ViewHelpers
+    def gace_javascript_include
+      return unless experiment_control?
+      script = <<-EOS.strip_heredoc
+        <script>function utmx_section(){}function utmx(){}(function(){var
+        k='#{experiment_key}',d=document,l=d.location,c=d.cookie;
+        if(l.search.indexOf('utm_expid='+k)>0)return;
+        function f(n){if(c){var i=c.indexOf(n+'=');if(i>-1){var j=c.
+        indexOf(';',i);return escape(c.substring(i+n.length+1,j<0?c.
+        length:j))}}}var x=f('__utmx'),xx=f('__utmxx'),h=l.hash;d.write(
+        '<sc'+'ript src="'+'http'+(l.protocol=='https:'?'s://ssl':
+        '://www')+'.google-analytics.com/ga_exp.js?'+'utmxkey='+k+
+        '&utmx='+(x?x:'')+'&utmxx='+(xx?xx:'')+'&utmxtime='+new Date().
+        valueOf()+(h?'&utmxhash='+escape(h.substr(1)):'')+
+        '" type="text/javascript" charset="utf-8"><\/sc'+'ript>')})();
+        </script><script>utmx('url','A/B');</script>
+      EOS
+      script.html_safe
+    end
+  end
+end

data/spec/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/spec/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/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// 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 vendor/assets/javascripts of plugins, if any, 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/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/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 vendor/assets/stylesheets of plugins, if any, 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/spec/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/spec/dummy/app/controllers/examples_controller.rb

@@ -0,0 +1,5 @@
+class ExamplesController < ApplicationController
+  def show
+    define_experiment :test_pricing, '28391929-0'
+  end
+end

data/spec/dummy/app/experiments/test_pricing/expensive/examples/show.html.erb

@@ -0,0 +1 @@
+This is the expensive variation template

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

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

data/spec/dummy/app/views/examples/show.html.erb

@@ -0,0 +1 @@
+This is the control template

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <%= gace_javascript_include %>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>