a_b_plugin 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2009 Winton Welsh
+
+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.markdown

@@ -0,0 +1,24 @@
+a\_b\_plugin
+============
+
+Talk to <code>a_b</code> from your Rails or Sinatra app.
+
+Install
+-------
+
+<pre>
+sudo gem install a_b_plugin --source http://gemcutter.org
+</pre>
+
+Setup
+-----
+
+You will need to make a call to <code>ABPlugin.config</code> when your app boots:
+
+<pre>
+ABPlugin.config 'kTJkI8e56OisQrexuChW', 'http://ab.mydomain.com'
+</pre>
+
+The first parameter is the persistence token from the user you created in <code>a_b</code>.
+
+The second parameter is the URL to your <code>a_b</code> server.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'gemspec'
+
+desc "Generate gemspec"
+task :gemspec do
+  File.open("#{Dir.pwd}/#{GEM_NAME}.gemspec", 'w') do |f|
+    f.write(GEM_SPEC.to_ruby)
+  end
+end
+
+desc "Install gem"
+task :install do
+  Rake::Task['gem'].invoke
+  `sudo gem uninstall #{GEM_NAME} -x`
+  `sudo gem install pkg/#{GEM_NAME}*.gem`
+  `rm -Rf pkg`
+end
+
+desc "Package gem"
+Rake::GemPackageTask.new(GEM_SPEC) do |pkg|
+  pkg.gem_spec = GEM_SPEC
+end
+
+desc "Rename project"
+task :rename do
+  name = ENV['NAME'] || File.basename(Dir.pwd)
+  begin
+    dir = Dir['**/gem_template*']
+    from = dir.pop
+    if from
+      rb = from.include?('.rb')
+      to = File.dirname(from) + "/#{name}#{'.rb' if rb}"
+      FileUtils.mv(from, to)
+    end
+  end while dir.length > 0
+  Dir["**/*"].each do |path|
+    next if path.include?('Rakefile')
+    if File.file?(path)
+      `sed -i "" 's/gem_template/#{name}/g' #{path}`
+    end
+  end
+end
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.rcov = true
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end

data/gemspec.rb

@@ -0,0 +1,18 @@
+GEM_NAME = 'a_b_plugin'
+GEM_FILES = FileList['**/*'] - FileList['coverage', 'coverage/**/*', 'pkg', 'pkg/**/*']
+GEM_SPEC = Gem::Specification.new do |s|
+  # == CONFIGURE ==
+  s.author = "Winton Welsh"
+  s.email = "mail@wintoni.us"
+  s.homepage = "http://github.com/winton/#{GEM_NAME}"
+  s.summary = "Talk to a_b from your Rails or Sinatra app"
+  # == CONFIGURE ==
+  s.add_dependency('httparty', '=0.4.5')
+  s.extra_rdoc_files = [ "README.markdown" ]
+  s.files = GEM_FILES.to_a
+  s.has_rdoc = false
+  s.name = GEM_NAME
+  s.platform = Gem::Platform::RUBY
+  s.require_path = "lib"
+  s.version = "0.1.0"
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/lib/a_b_plugin.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + "/a_b_plugin/core_ext/array"
+require File.dirname(__FILE__) + "/a_b_plugin/core_ext/module"
+require File.dirname(__FILE__) + "/a_b_plugin/api"
+require File.dirname(__FILE__) + "/a_b_plugin/helper"
+require File.dirname(__FILE__) + "/a_b_plugin/adapters/rails" if defined?(Rails)
+require File.dirname(__FILE__) + "/a_b_plugin/adapters/sinatra" if defined?(Sinatra)
+
+module ABPlugin
+  
+  mattr_accessor :api
+  mattr_accessor :session_id
+  mattr_accessor :tests
+  mattr_accessor :token
+  mattr_accessor :url
+  mattr_accessor :user_token
+  
+  class <<self
+    
+    def config(token, url)
+      API.base_uri @@url
+      @@api = API.new token
+      boot = @@api.boot
+      @@tests = boot['tests']
+      @@token = token
+      @@url = url
+      @@user_token = boot['user_token']
+    end
+  
+    def select_variant?(selections, variant)
+      test = test_from_variant(variant)
+      return false unless test
+      if !selections || !selections[test['name']]
+        variants = test['variants'].sort do |a, b|
+          a['visitors'] <=> b['visitors']
+        end
+        variants.first['visitors'] += 1
+        selections[test['name']] = variants.first['name']
+      end
+      selections[test['name']] == variant
+    end
+  
+    def test_from_variant(variant)
+      return nil unless ABPlugin.tests
+      tests = ABPlugin.tests.select do |t|
+        t['variants'].collect { |v| v['name'] }.include?(variant)
+      end
+      tests.first
+    end
+  end
+end

data/lib/a_b_plugin/adapters/rails.rb

@@ -0,0 +1,23 @@
+module ABPlugin
+  module Adapters
+    module Rails
+    
+      def self.included(klass)
+        if defined?(::ApplicationController)
+          raise 'Please require a_b_plugin before all other plugins.'
+        end
+        klass.prepend_before_filter :a_b_plugin_before_filter
+      end
+    
+      private
+    
+      def a_b_plugin_before_filter
+        ABPlugin.session_id = session.session_id
+      end
+    end
+  end
+end
+
+ActionController::Base.send(:include, ABRails::Adapters::Rails)
+ActionController::Base.send(:include, ABRails::Helper)
+ActionController::Base.helper(ABRails::Helper)

data/lib/a_b_plugin/adapters/sinatra.rb

@@ -0,0 +1,15 @@
+module ABPlugin
+  module Adapters
+    module Sinatra
+    
+      def self.included(klass)
+        klass.send :before do
+          ABPlugin.session_id = env['rack.session.options']['_session_id']
+        end
+      end
+    end
+  end
+end
+
+Sinatra::Base.send(:include, ABPlugin::Adapters::Sinatra)
+Sinatra::Base.send(:include, ABPlugin::Helper)

data/lib/a_b_plugin/api.rb

@@ -0,0 +1,13 @@
+module ABPlugin
+  class API
+    include HTTParty
+    
+    def initialize(token)
+      @token = token
+    end
+    
+    def boot
+      self.class.get('/boot.json', :query => { :token => @token })
+    end
+  end
+end

data/lib/a_b_plugin/core_ext/array.rb

@@ -0,0 +1,14 @@
+class Array
+  # Extracts options from a set of arguments. Removes and returns the last
+  # element in the array if it's a hash, otherwise returns a blank hash.
+  #
+  #   def options(*args)
+  #     args.extract_options!
+  #   end
+  #
+  #   options(1, 2)           # => {}
+  #   options(1, 2, :a => :b) # => {:a=>:b}
+  def extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end
+end

data/lib/a_b_plugin/core_ext/module.rb

@@ -0,0 +1,60 @@
+class Module
+  def mattr_reader(*syms)
+    syms.extract_options!
+    syms.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        unless defined? @@#{sym}  # unless defined? @@pagination_options
+          @@#{sym} = nil          #   @@pagination_options = nil
+        end                       # end
+
+        def self.#{sym}           # def self.pagination_options
+          @@#{sym}                #   @@pagination_options
+        end                       # end
+
+        def #{sym}                # def pagination_options
+          @@#{sym}                #   @@pagination_options
+        end                       # end
+      EOS
+    end
+  end
+
+  def mattr_writer(*syms)
+    options = syms.extract_options!
+    syms.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        unless defined? @@#{sym}                       # unless defined? @@pagination_options
+          @@#{sym} = nil                               #   @@pagination_options = nil
+        end                                            # end
+
+        def self.#{sym}=(obj)                          # def self.pagination_options=(obj)
+          @@#{sym} = obj                               #   @@pagination_options = obj
+        end                                            # end
+      EOS
+
+      unless options[:instance_writer] == false
+        class_eval(<<-EOS, __FILE__, __LINE__)
+          def #{sym}=(obj)                             # def pagination_options=(obj)
+            @@#{sym} = obj                             #   @@pagination_options = obj
+          end                                          # end
+        EOS
+      end
+    end
+  end
+
+  # Extends the module object with module and instance accessors for class attributes,
+  # just like the native attr* accessors for instance attributes.
+  #
+  #  module AppConfiguration
+  #    mattr_accessor :google_api_key
+  #    self.google_api_key = "123456789"
+  #
+  #    mattr_accessor :paypal_url
+  #    self.paypal_url = "www.sandbox.paypal.com"
+  #  end
+  #
+  #  AppConfiguration.google_api_key = "overriding the api key!"
+  def mattr_accessor(*syms)
+    mattr_reader(*syms)
+    mattr_writer(*syms)
+  end
+end

data/lib/a_b_plugin/helper.rb

@@ -0,0 +1,17 @@
+module ABPlugin
+  module Helper
+    
+    private
+    
+    def a_b(variant, &block)
+      block.call if block_given? && ABPlugin.select_variant?(@a_b_selections, variant)
+    end
+    
+    def a_b_script_tag
+      token = Digest::SHA256.hexdigest(ABPlugin.session_id + ABPlugin.user_token)
+      variants = @a_b_selections.values.collect { |v| "variants[]=#{v}" }.join '&'
+      url = ABPlugin.url + "/visit.js?session_id=#{ABPlugin.session_id}&token=#{token}&#{variants}"
+      "<script src=\"#{url}\" type=\"text/javascript\"></script>"
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require File.expand_path(File.dirname(__FILE__) + "/../lib/a_b_plugin")

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$testing = true
+SPEC = File.dirname(__FILE__)
+
+require 'pp'
+require File.expand_path("#{SPEC}/../rails/init")
+
+Spec::Runner.configure do |config|
+end
+
+# For use with rspec textmate bundle
+def debug(object)
+  puts "<pre>"
+  puts object.pretty_inspect.gsub('<', '&lt;').gsub('>', '&gt;')
+  puts "</pre>"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: a_b_plugin
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Winton Welsh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-19 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.4.5
+    version: 
+description: 
+email: mail@wintoni.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- gemspec.rb
+- init.rb
+- lib/a_b_plugin/adapters/rails.rb
+- lib/a_b_plugin/adapters/sinatra.rb
+- lib/a_b_plugin/api.rb
+- lib/a_b_plugin/core_ext/array.rb
+- lib/a_b_plugin/core_ext/module.rb
+- lib/a_b_plugin/helper.rb
+- lib/a_b_plugin.rb
+- MIT-LICENSE
+- rails/init.rb
+- Rakefile
+- README.markdown
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/winton/a_b_plugin
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Talk to a_b from your Rails or Sinatra app
+test_files: []
+