RubyGems - gxapi_rails - Versions diffs - 0.0.2 - Mend

gxapi_rails 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (68) hide show

checksums.yaml +7 -0
data/LICENSE.txt +20 -0
data/README.md +161 -0
data/Rakefile +25 -0
data/app/helpers/gxapi_helper.rb +108 -0
data/lib/gxapi.rb +160 -0
data/lib/gxapi/base.rb +100 -0
data/lib/gxapi/controller_methods.rb +41 -0
data/lib/gxapi/engine.rb +14 -0
data/lib/gxapi/google_analytics.rb +193 -0
data/lib/gxapi/ostruct.rb +86 -0
data/lib/gxapi/version.rb +3 -0
data/spec/dummy/README.rdoc +261 -0
data/spec/dummy/Rakefile +7 -0
data/spec/dummy/app/assets/javascripts/application.js +13 -0
data/spec/dummy/app/assets/stylesheets/application.css +13 -0
data/spec/dummy/app/controllers/application_controller.rb +3 -0
data/spec/dummy/app/controllers/posts_controller.rb +11 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/helpers/posts_helper.rb +2 -0
data/spec/dummy/app/models/post.rb +3 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/app/views/posts/_form.html.erb +25 -0
data/spec/dummy/app/views/posts/edit.html.erb +6 -0
data/spec/dummy/app/views/posts/index.html.erb +36 -0
data/spec/dummy/app/views/posts/new.html.erb +5 -0
data/spec/dummy/app/views/posts/show.html.erb +15 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +70 -0
data/spec/dummy/config/boot.rb +10 -0
data/spec/dummy/config/database.yml +22 -0
data/spec/dummy/config/database.yml.default +111 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +38 -0
data/spec/dummy/config/environments/production.rb +67 -0
data/spec/dummy/config/environments/test.rb +37 -0
data/spec/dummy/config/gxapi.yml +17 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/inflections.rb +15 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +7 -0
data/spec/dummy/config/initializers/session_store.rb +8 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/konfig/application.rb +16 -0
data/spec/dummy/config/konfig/development.rb +10 -0
data/spec/dummy/config/konfig/production.rb +3 -0
data/spec/dummy/config/konfig/test.rb +3 -0
data/spec/dummy/config/konfig/test_prod.rb +3 -0
data/spec/dummy/config/locales/en.yml +5 -0
data/spec/dummy/config/routes.rb +3 -0
data/spec/dummy/config/test.p12 +0 -0
data/spec/dummy/data/log/dummy/development.log +113 -0
data/spec/dummy/data/log/dummy/test.log +927 -0
data/spec/dummy/db/development.sqlite3 +0 -0
data/spec/dummy/db/test.sqlite3 +0 -0
data/spec/dummy/log/test.log +1443 -0
data/spec/dummy/public/404.html +26 -0
data/spec/dummy/public/422.html +26 -0
data/spec/dummy/public/500.html +25 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/script/rails +6 -0
data/spec/features/display_variant_js_spec.rb +34 -0
data/spec/helpers/gxapi_helper_spec.rb +63 -0
data/spec/lib/gxapi/base_spec.rb +80 -0
data/spec/lib/gxapi/google_analytics_spec.rb +70 -0
data/spec/lib/gxapi_spec.rb +32 -0
data/spec/spec_helper.rb +32 -0
metadata +233 -0

data/spec/dummy/public/404.html ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html ADDED Viewed

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/spec/dummy/public/favicon.ico ADDED Viewed

File without changes

data/spec/dummy/script/rails ADDED Viewed

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/features/display_variant_js_spec.rb ADDED Viewed

@@ -0,0 +1,34 @@
+require 'spec_helper'
+module Gxapi
+  describe 'Gxapi Integration with Rails' do
+    before(:all) do
+      Gxapi.reload_experiments
+    end
+    context 'GET /posts' do
+      it 'renders the google analytics data for a user' do
+        visit posts_path
+        expect(page.body).to match(/cxApi\.setChosenVariation/)
+      end
+      it 'renders the content expected when a parameter is passed in
+        for the variant value' do
+        visit posts_path(variant: 'fake_var')
+        expect(page.body).to have_content('Fake Var Version')
+      end
+    end
+  end
+end

data/spec/helpers/gxapi_helper_spec.rb ADDED Viewed

@@ -0,0 +1,63 @@
+require 'spec_helper'
+describe GxapiHelper do
+  context "#gxapi_variant_name" do
+    it "returns default if the variable is not set" do
+      helper.gxapi_variant_name.should eql "default"
+    end
+    it "returns the name of the vairant if it is set" do
+      assign(:variant, stub(:value => stub(:name => "x")))
+      helper.gxapi_variant_name.should eql("x")
+    end
+    it "handles different vairant names" do
+      assign(:variantx, stub(:value => stub(:name => "x")))
+      helper.gxapi_variant_name(:variantx).should eql("x")
+    end
+  end
+  context "#gxapi_experiment_js" do
+    context "with variant set" do
+      before(:each) do
+        assign(
+          :variant,
+          stub(
+            :value => stub(
+              :name => "x",
+              :experiment_id => "y",
+              :index => 1
+            )
+          )
+        )
+      end
+      it "adds the javascript src for Google analytics only once
+        but does the js call each time the method is called" do
+        ret = helper.gxapi_experiment_js + helper.gxapi_experiment_js
+        ret.scan(/google\-analytics\.com/).length.should eql(1)
+        ret.scan(/setChosenVariation/).length.should eql(2)
+      end
+      it "should add the domain if an option is passed" do
+        ret = helper.gxapi_experiment_js(:domain => ".example.com")
+        ret.should =~ /setDomainName/
+      end
+    end
+    it "should not do anything if the instance var is not defined" do
+      helper.gxapi_experiment_js.should eql("")
+    end
+  end
+end

data/spec/lib/gxapi/base_spec.rb ADDED Viewed

@@ -0,0 +1,80 @@
+require 'spec_helper'
+describe Gxapi::Base do
+  #We cache based on the id, so we need to get a random one.
+  subject do
+    Gxapi::Base.new(user_key)
+  end
+  let(:user_key) do
+    Kernel.rand(1000000000000000)
+  end
+  let(:valid_variants) do
+    ["original", "variant1"]
+  end
+  let(:test_experiment_name) do
+    "Untitled experiment"
+  end
+  context "#env" do
+    it "should delegate to its class" do
+      subject.env.should eql Gxapi.env
+    end
+  end
+  context "#get_variant" do
+    it "should make a call to myna and return a future" do
+      variant = subject.get_variant(test_experiment_name)
+      valid_variants.should include variant.value.name
+      [0, 1].should include variant.value.index
+    end
+    it "should set a key in the rails cache for a given
+      uuid/experiment combo" do
+      variant = subject.get_variant(test_experiment_name)
+      variant.value
+      cache_key = "#{user_key}_untitled_experiment"
+      Gxapi.cache.read(cache_key).should have_key("index")
+    end
+    it "should time out after 2 seconds and return the default value" do
+      Gxapi.cache.stubs(:fetch).yields{sleep(3)}
+      start_time = Time.now
+      variant = subject.get_variant(test_experiment_name)
+      # make sure we return the default value
+      variant.value.name.should eql("default")
+      (Time.now - start_time).should be < 2.5
+    end
+    it "should allow a user to override the chosen variant" do
+      variant = subject.get_variant(test_experiment_name, "fakeval")
+      variant.value.experiment_id.should be_nil
+      variant.value.name.should eql("fakeval")
+      variant.value.index.should eql -1
+    end
+  end
+  context "#user_key" do
+    it "should set up its user_key" do
+      subject.user_key.should eql user_key
+    end
+  end
+end

data/spec/lib/gxapi/google_analytics_spec.rb ADDED Viewed

@@ -0,0 +1,70 @@
+require 'spec_helper'
+module Gxapi
+  describe GoogleAnalytics do
+    before(:each) do
+      Gxapi.cache.clear
+    end
+    context "#get_experiments" do
+      it "gets a list of experiments" do
+        experiments = subject.get_experiments
+        experiments.first.should be_a(Gxapi::Ostruct)
+      end
+    end
+    context "#get_experiment" do
+      it "should filter by name" do
+        experiment = subject.get_experiments.first
+        subject.get_experiment(experiment.name).should eql(experiment)
+      end
+    end
+    context "#get_variant" do
+      before(:each) do
+        subject.stubs(
+          get_experiment: Ostruct.new({
+            id: "123",
+            name: "X",
+            traffic_coverage: 1.0,
+            variations: [
+              Ostruct.new(
+                name: "original",
+                weight: 0.5,
+                status: "ACTIVE"
+              ),
+              Ostruct.new(
+                name: "variation1",
+                weight: 0.5,
+                status: "ACTIVE"
+              )
+            ]
+          })
+        )
+      end
+      it "should return a variant determined by weight" do
+        variant = subject.get_variant("fakename")
+        ["original", "variation1"].should include variant.name
+        [0, 1].should include variant.index
+      end
+      it "returns the default if traffic_coverage is 0" do
+        subject.get_experiment.stubs(traffic_coverage: 0)
+        variant = subject.get_variant("fakename")
+        variant.name.should eql("default")
+        variant.index.should eql(-1)
+      end
+    end
+  end
+end

data/spec/lib/gxapi_spec.rb ADDED Viewed

@@ -0,0 +1,32 @@
+require 'spec_helper'
+describe Gxapi do
+  before(:all) do
+    Gxapi.config_path = File.expand_path(
+      "../../support/config.yml", __FILE__
+    )
+    Gxapi.env = "test"
+  end
+  context ".cache" do
+    it "should have a cache that gets defined by default" do
+      Gxapi.cache.should be_kind_of(ActiveSupport::Cache::Store)
+    end
+    context "with Rails" do
+      it "should use the Rails cache once it is available" do
+        Gxapi.cache.should be Rails.cache
+      end
+      it "should still allow you to override the cache" do
+        my_cache = stub()
+        Gxapi.cache = my_cache
+        Gxapi.cache.should eql(my_cache)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,32 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../../spec/dummy/config/environment", __FILE__)
+require 'gxapi'
+require 'rspec/rails'
+require 'capybara/rails'
+require 'rails/engine'
+require 'mocha/setup'
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+Mocha::Configuration.prevent(:stubbing_non_existent_method)
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run focus: true
+  config.before(:all) do
+    Gxapi.logger = Logger.new(STDOUT)
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,233 @@
+--- !ruby/object:Gem::Specification
+name: gxapi_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Dan Langevin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Google Analytics and integration
+email: dan.langevin@lifebooker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/helpers/gxapi_helper.rb
+- lib/gxapi/base.rb
+- lib/gxapi/controller_methods.rb
+- lib/gxapi/engine.rb
+- lib/gxapi/google_analytics.rb
+- lib/gxapi/ostruct.rb
+- lib/gxapi/version.rb
+- lib/gxapi.rb
+- LICENSE.txt
+- Rakefile
+- README.md
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/posts_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/helpers/posts_helper.rb
+- spec/dummy/app/models/post.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/views/posts/_form.html.erb
+- spec/dummy/app/views/posts/edit.html.erb
+- spec/dummy/app/views/posts/index.html.erb
+- spec/dummy/app/views/posts/new.html.erb
+- spec/dummy/app/views/posts/show.html.erb
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/database.yml.default
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/gxapi.yml
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/konfig/application.rb
+- spec/dummy/config/konfig/development.rb
+- spec/dummy/config/konfig/production.rb
+- spec/dummy/config/konfig/test.rb
+- spec/dummy/config/konfig/test_prod.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config/test.p12
+- spec/dummy/config.ru
+- spec/dummy/data/log/dummy/development.log
+- spec/dummy/data/log/dummy/test.log
+- spec/dummy/db/development.sqlite3
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/test.log
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/Rakefile
+- spec/dummy/README.rdoc
+- spec/dummy/script/rails
+- spec/features/display_variant_js_spec.rb
+- spec/helpers/gxapi_helper_spec.rb
+- spec/lib/gxapi/base_spec.rb
+- spec/lib/gxapi/google_analytics_spec.rb
+- spec/lib/gxapi_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/LifebookerInc/gxapi_rails
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.0.3
+signing_key:
+specification_version: 4
+summary: Google Analytics
+test_files:
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/posts_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/helpers/posts_helper.rb
+- spec/dummy/app/models/post.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/views/posts/_form.html.erb
+- spec/dummy/app/views/posts/edit.html.erb
+- spec/dummy/app/views/posts/index.html.erb
+- spec/dummy/app/views/posts/new.html.erb
+- spec/dummy/app/views/posts/show.html.erb
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/database.yml.default
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/gxapi.yml
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/konfig/application.rb
+- spec/dummy/config/konfig/development.rb
+- spec/dummy/config/konfig/production.rb
+- spec/dummy/config/konfig/test.rb
+- spec/dummy/config/konfig/test_prod.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config/test.p12
+- spec/dummy/config.ru
+- spec/dummy/data/log/dummy/development.log
+- spec/dummy/data/log/dummy/test.log
+- spec/dummy/db/development.sqlite3
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/test.log
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/Rakefile
+- spec/dummy/README.rdoc
+- spec/dummy/script/rails
+- spec/features/display_variant_js_spec.rb
+- spec/helpers/gxapi_helper_spec.rb
+- spec/lib/gxapi/base_spec.rb
+- spec/lib/gxapi/google_analytics_spec.rb
+- spec/lib/gxapi_spec.rb
+- spec/spec_helper.rb