vanity 1.6.1 → 1.7.0

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/redcloth

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'redcloth' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('RedCloth', 'redcloth')

data/bin/vanity

@@ -1,69 +1,16 @@
 #!/usr/bin/env ruby
-# Is there a better way to detect Rails?
-if File.exist?("config/boot.rb") && File.exist?("config/environment.rb")
-  require "config/environment"
-else
-  path = File.expand_path("../lib", File.dirname(__FILE__))
-  $LOAD_PATH.unshift path unless $LOAD_PATH.include?(path)
-  require "vanity"
-end
+#
+# This file was generated by Bundler.
+#
+# The application 'vanity' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
 
-require "optparse"
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
 
-playground = Vanity.playground
-options = Struct.new(:output).new
-opts = OptionParser.new("", 24, "  ") do |opts|
-  opts.banner = "Usage: #{File.basename($0)} [options] command\n"
-  opts.banner << "Commands:\n"
-  opts.banner << "  list    List all experiments and metrics\n"
-  opts.banner << "  report  Report on all running experiments/metrics\n"
-  opts.banner << "  upgrade Upgrade your database when deploying new release\n"
+require 'rubygems'
+require 'bundler/setup'
 
-  opts.separator ""
-  opts.separator "Reporting options:"
-  opts.on "--output FILE", "Write report to this file (default: stdout)" do |path|
-    options.output = path
-  end
-
-  opts.separator ""
-  opts.separator "Common options:"
-  opts.on "--load_path PATH", "Path to experiments directory (default: #{playground.load_path})" do |path|
-    playground.load_path = path
-  end
-  opts.on "-d", "--database url", "Database connection URL (e.g. redis:/localhost:6379)" do |conn|
-    playground.establish_connection conn
-  end
-  opts.on "--redis HOST:PORT:DB", "DEPRECATED: Redis server host (default: localhost:6379)" do |redis|
-    host, port, db = redis.split(":")
-    playground.establish_connection "redis:/#{host}:#{port}/#{db}"
-  end
-  opts.on_tail "-h", "--help", "Show this message" do
-    puts opts.to_s.gsub(/^.*DEPRECATED.*$/s, '')
-    exit
-  end
-  opts.on_tail "-v", "--version", "Show version"  do
-    puts "Vanity #{Vanity::Version::STRING}"
-    exit
-  end
-end
-
-opts.parse!(ARGV)
-if ARGV.empty?
-  puts opts.banner
-  exit
-end
-
-ARGV.each do |cmd|
-  case cmd
-  when "report"
-    require "vanity/commands/report"
-    Vanity::Commands.report options.output
-  when "list"
-    require "vanity/commands/list"
-    Vanity::Commands.list
-  when "upgrade"
-    require "vanity/commands/upgrade"
-    Vanity::Commands.upgrade
-  else fail "No such command: #{cmd}"
-  end
-end
+load Gem.bin_path('vanity', 'vanity')

data/bin/yard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yard')

data/bin/yardoc

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yardoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yardoc')

data/bin/yri

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yri')

data/lib/generators/templates/vanity_migration.rb

@@ -0,0 +1,53 @@
+class VanityMigration < ActiveRecord::Migration
+  def self.up
+    create_table :vanity_metrics do |t|
+      t.string :metric_id
+      t.datetime :updated_at
+    end
+    add_index :vanity_metrics, [:metric_id]
+
+    create_table :vanity_metric_values do |t|
+      t.integer :vanity_metric_id
+      t.integer :index
+      t.integer :value
+      t.string :date
+    end
+    add_index :vanity_metric_values, [:vanity_metric_id]
+
+    create_table :vanity_experiments do |t|
+      t.string :experiment_id
+      t.integer :outcome
+      t.datetime :created_at
+      t.datetime :completed_at
+    end
+    add_index :vanity_experiments, [:experiment_id]
+
+    create_table :vanity_conversions do |t|
+      t.integer :vanity_experiment_id
+      t.integer :alternative
+      t.integer :conversions
+    end
+    add_index :vanity_conversions, [:vanity_experiment_id, :alternative], :name => "by_experiment_id_and_alternative"
+
+    create_table :vanity_participants do |t|
+      t.string :experiment_id
+      t.string :identity
+      t.integer :shown
+      t.integer :seen
+      t.integer :converted
+    end
+    add_index :vanity_participants, [:experiment_id]
+    add_index :vanity_participants, [:experiment_id, :identity], :name => "by_experiment_id_and_identity"
+    add_index :vanity_participants, [:experiment_id, :shown], :name => "by_experiment_id_and_shown"
+    add_index :vanity_participants, [:experiment_id, :seen], :name => "by_experiment_id_and_seen"
+    add_index :vanity_participants, [:experiment_id, :converted], :name => "by_experiment_id_and_converted"
+  end
+
+  def self.down
+    drop_table :vanity_metrics
+    drop_table :vanity_metric_values 
+    drop_table :vanity_experiments 
+    drop_table :vanity_conversions 
+    drop_table :vanity_participants 
+  end
+end

data/lib/generators/vanity_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class VanityGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+  def create_model_file
+    migration_template "vanity_migration.rb", "db/migrate/vanity_migration.rb"
+  end
+end

data/lib/vanity/adapters/abstract_adapter.rb

@@ -8,6 +8,11 @@ module Vanity
       #
       # @since 1.4.0
       def establish_connection(spec)
+        begin
+          require "vanity/adapters/#{spec[:adapter]}_adapter"
+        rescue LoadError
+          raise "Could not find #{spec[:adapter]} in your load path"
+        end
         adapter_method = "#{spec[:adapter]}_connection"
         send adapter_method, spec
       end

data/lib/vanity/adapters/active_record_adapter.rb

@@ -3,7 +3,7 @@ module Vanity
     class << self
       # Creates new ActiveRecord connection and returns ActiveRecordAdapter.
       def active_record_connection(spec)
-        require 'active_record'
+        require "active_record"
         ActiveRecordAdapter.new(spec)
       end
     end
@@ -12,61 +12,6 @@ module Vanity
     class ActiveRecordAdapter < AbstractAdapter
       # Base model, stores connection and defines schema
       class VanityRecord < ActiveRecord::Base
-        def self.define_schema
-          # Create a schema table to store the schema version
-          unless connection.tables.include?('vanity_schema')
-            connection.create_table :vanity_schema do |t|
-              t.integer :version
-            end
-          end
-
-          # Migrate
-          unless VanitySchema.find_by_version(1)
-            connection.create_table :vanity_metrics do |t|
-              t.string :metric_id
-              t.datetime :updated_at
-            end
-            connection.add_index :vanity_metrics, [:metric_id]
-
-            connection.create_table :vanity_metric_values do |t|
-              t.integer :vanity_metric_id
-              t.integer :index
-              t.integer :value
-              t.string :date
-            end
-            connection.add_index :vanity_metric_values, [:vanity_metric_id]
-
-            connection.create_table :vanity_experiments do |t|
-              t.string :experiment_id
-              t.integer :outcome
-              t.datetime :created_at
-              t.datetime :completed_at
-            end
-            connection.add_index :vanity_experiments, [:experiment_id]
-
-            connection.create_table :vanity_conversions do |t|
-              t.integer :vanity_experiment_id
-              t.integer :alternative
-              t.integer :conversions
-            end
-            connection.add_index :vanity_conversions, [:vanity_experiment_id, :alternative], :name => "by_experiment_id_and_alternative"
-
-            connection.create_table :vanity_participants do |t|
-              t.string :experiment_id
-              t.string :identity
-              t.integer :shown
-              t.integer :seen
-              t.integer :converted
-            end
-            connection.add_index :vanity_participants, [:experiment_id]
-            connection.add_index :vanity_participants, [:experiment_id, :identity], :name => "by_experiment_id_and_identity"
-            connection.add_index :vanity_participants, [:experiment_id, :shown], :name => "by_experiment_id_and_shown"
-            connection.add_index :vanity_participants, [:experiment_id, :seen], :name => "by_experiment_id_and_seen"
-            connection.add_index :vanity_participants, [:experiment_id, :converted], :name => "by_experiment_id_and_converted"
-
-            VanitySchema.create(:version => 1)
-          end
-        end
       end
 
       # Schema model
@@ -122,27 +67,19 @@ module Vanity
         # passed to create if creating, or will be used to
         # update the found participant.
         def self.retrieve(experiment, identity, create = true, update_with = nil)
-          record = VanityParticipant.first(
-                  :conditions =>
-                          {:experiment_id => experiment.to_s, :identity => identity.to_s})
-
-          if record
+          if record = VanityParticipant.first(:conditions=>{ :experiment_id=>experiment.to_s, :identity=>identity.to_s })
             record.update_attributes(update_with) if update_with
           elsif create
-            record = VanityParticipant.create(
-                    {:experiment_id => experiment.to_s,
-                     :identity => identity}.merge(update_with || {}))
+            record = VanityParticipant.create({ :experiment_id=>experiment.to_s, :identity=>identity }.merge(update_with || {}))
           end
-
           record
         end
       end
 
       def initialize(options)
-        options[:adapter] = options[:active_record_adapter] if options[:active_record_adapter]
-
-        VanityRecord.establish_connection(options)
-        VanityRecord.define_schema
+        @options = options.inject({}) { |h,kv| h[kv.first.to_s] = kv.last ; h }
+        @options["adapter"] = @options["active_record_adapter"] if @options["active_record_adapter"]
+        VanityRecord.establish_connection(@options)
       end
 
       def active?
@@ -299,6 +236,10 @@ module Vanity
         record = VanityExperiment.find_by_experiment_id(experiment.to_s)
         record && record.destroy
       end
+
+      def to_s
+        @options.to_s
+      end
     end
   end
 end

data/lib/vanity/adapters/redis_adapter.rb

@@ -28,7 +28,7 @@ module Vanity
       def disconnect!
         if redis
           begin
-            redis.quit
+            redis.client.disconnect
           rescue Exception => e
             warn("Error while disconnecting from redis: #{e.message}")
           end

data/lib/vanity/frameworks/rails.rb

@@ -44,6 +44,10 @@ module Vanity
             return @vanity_identity if @vanity_identity
             if symbol && object = send(symbol)
               @vanity_identity = object.id
+            elsif request.get? && params[:_identity]
+              @vanity_identity = params[:_identity]
+              cookies["vanity_id"] = { :value=>@vanity_identity, :expires=>1.month.from_now }
+              @vanity_identity
             elsif response # everyday use
               @vanity_identity = cookies["vanity_id"] || ActiveSupport::SecureRandom.hex(16)
               cookie = { :value=>@vanity_identity, :expires=>1.month.from_now }
@@ -60,11 +64,33 @@ module Vanity
         around_filter :vanity_context_filter
         before_filter :vanity_reload_filter unless ::Rails.configuration.cache_classes
         before_filter :vanity_query_parameter_filter
+        after_filter :vanity_track_filter
       end
       protected :use_vanity
     end
 
-
+    module UseVanityMailer
+      def use_vanity_mailer(symbol = nil)
+        # Context is the instance of ActionMailer::Base
+        Vanity.context = self
+        if symbol && (@object = symbol)
+          class << self
+            define_method :vanity_identity do
+              @vanity_identity = (String === @object ? @object : @object.id)
+            end
+          end
+        else
+          class << self
+            define_method :vanity_identity do
+              @vanity_identity = @vanity_identity || ActiveSupport::SecureRandom.hex(16)
+            end
+          end
+        end
+      end
+      protected :use_vanity_mailer
+    end
+    
+    
     # Vanity needs these filters.  They are includes in ActionController and
     # automatically added when you use #use_vanity in your controller.
     module Filters
@@ -112,7 +138,15 @@ module Vanity
       def vanity_reload_filter
         Vanity.playground.reload!
       end
-
+      
+      # Filter to track metrics
+      # pass _track param along to call track! on that alternative
+      def vanity_track_filter
+        if request.get? && params[:_track]
+          track! params[:_track]
+        end
+      end
+      
       protected :vanity_context_filter, :vanity_query_parameter_filter, :vanity_reload_filter
     end
 
@@ -159,6 +193,18 @@ module Vanity
           value
         end
       end
+      
+      # Generate url with the identity of the current user and the metric to track on click
+      def vanity_track_url_for(identity, metric, options = {})
+        options = options.merge(:_identity => identity, :_track => metric)
+        url_for(options)
+      end
+      
+      # Generate url with the fingerprint for the current Vanity experiment
+      def vanity_tracking_image(identity, metric, options = {})
+        options = options.merge(:controller => :vanity, :action => :image, :_identity => identity, :_track => metric)
+        image_tag(url_for(options), :width => "1px", :height => "1px", :alt => "")
+      end
 
       def vanity_js
         return if @_vanity_experiments.nil?
@@ -206,15 +252,22 @@ module Vanity
       end
 
       def add_participant
-        if params[:e].nil? || params[:e].empty?
-          render :status => 404, :nothing => true
-          return
-        end
+      	if params[:e].nil? || params[:e].empty?
+      	  render :status => 404, :nothing => true
+      	  return
+      	end
         exp = Vanity.playground.experiment(params[:e])
         exp.chooses(exp.alternatives[params[:a].to_i].value)
         render :status => 200, :nothing => true
       end
     end
+    
+    module TrackingImage
+      def image
+        # send image
+        send_file(File.expand_path("../images/x.gif", File.dirname(__FILE__)), :type => 'image/gif', :stream => false, :disposition => 'inline')
+      end
+    end
   end
 end
 
@@ -241,6 +294,14 @@ if defined?(ActionController)
   end
 end
 
+if defined?(ActionMailer)
+  # Include in mailer, add view helper methods.
+  ActionMailer::Base.class_eval do
+    include Vanity::Rails::UseVanityMailer
+    include Vanity::Rails::Filters
+    helper Vanity::Rails::Helpers
+  end
+end
 
 # Automatically configure Vanity.
 if defined?(Rails)
@@ -263,7 +324,7 @@ if defined?(PhusionPassenger)
   PhusionPassenger.on_event(:starting_worker_process) do |forked|
     if forked
       begin
-        Vanity.playground.establish_connection if Vanity.playground.collecting?
+        Vanity.playground.reconnect! if Vanity.playground.collecting?
       rescue Exception=>ex
         Rails.logger.error "Error reconnecting: #{ex.to_s}"
       end