lookout-vanity 1.8.2

data/lib/vanity/metric/remote.rb

@@ -0,0 +1,53 @@
+require "net/http"
+require "cgi"
+
+module Vanity
+  class Metric
+
+    # Specifies the base URL to use for a remote metric. For example:
+    #   metric :sandbox do
+    #     remote "http://api.vanitydash.com/metrics/sandbox"
+    #   end
+    def remote(url = nil)
+      @remote_url = URI.parse(url) if url
+      @mutex ||= Mutex.new
+      extend Remote
+      @remote_url
+    end
+
+    # To update a remote metric, make a POST request to the metric URL with the
+    # content type "application/x-www-form-urlencoded" and the following
+    # fields:
+    # - The +metric+ identifier,
+    # - The +timestamp+ must be RFC 2616 formatted (in Ruby just call +httpdate+
+    #   on the Time object),
+    # - The +identity+ (optional),
+    # - Pass consecutive values using the field +values[]+, or
+    # - Set values by their index using +values[0]+, +values[1]+, etc or
+    # - Set values by series name using +values[foo]+, +values[bar]+, etc.
+    module Remote
+
+      def track!(args = nil)
+        return unless @playground.collecting?
+        timestamp, identity, values = track_args(args)
+        params = ["metric=#{CGI.escape @id.to_s}", "timestamp=#{CGI.escape timestamp.httpdate}"]
+        params << "identity=#{CGI.escape identity.to_s}" if identity
+        params.concat values.map { |v| "values[]=#{v.to_i}" }
+        params << @remote_url.query if @remote_url.query
+        @mutex.synchronize do
+          @http ||= Net::HTTP.start(@remote_url.host, @remote_url.port)
+          @http.request Net::HTTP::Post.new(@remote_url.path, "Content-Type"=>"application/x-www-form-urlencoded"), params.join("&")
+        end
+      rescue Timeout::Error, StandardError
+        @playground.logger.error "Error sending data for metric #{name}: #{$!}"
+        @http = nil
+      ensure
+        call_hooks timestamp, identity, values
+      end
+
+      # "Don't worry, be crappy. Revolutionary means you ship and then test."
+      # -- Guy Kawazaki
+
+    end
+  end
+end

data/lib/vanity/playground.rb

@@ -0,0 +1,408 @@
+require "uri"
+
+module Vanity
+
+  # Playground catalogs all your experiments, holds the Vanity configuration.
+  #
+  # @example
+  #   Vanity.playground.logger = my_logger
+  #   puts Vanity.playground.map(&:name)
+  class Playground
+
+    DEFAULTS = { :collecting => true, :load_path=>"experiments" }
+    DEFAULT_ADD_PARTICIPANT_PATH = '/vanity/add_participant'
+
+    # Created new Playground. Unless you need to, use the global
+    # Vanity.playground.
+    #
+    # First argument is connection specification (see #redis=), last argument is
+    # a set of options, both are optional.  Supported options are:
+    # - connection -- Connection specification
+    # - namespace -- Namespace to use
+    # - load_path -- Path to load experiments/metrics from
+    # - logger -- Logger to use
+    def initialize(*args)
+      options = Hash === args.last ? args.pop : {}
+      # In the case of Rails, use the Rails logger and collect only for
+      # production environment by default.
+      defaults = options[:rails] ? DEFAULTS.merge(:collecting => ::Rails.env.production?, :logger => ::Rails.logger) : DEFAULTS
+      if config_file_exists?
+        env = ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
+        config = load_config_file[env]
+        if Hash === config
+          config = config.inject({}) { |h,kv| h[kv.first.to_sym] = kv.last ; h }
+        else
+          config = { :connection=>config }
+        end
+      else
+        config = {}
+      end
+
+      @options = defaults.merge(config).merge(options)
+      if @options[:host] == 'redis' && @options.values_at(:host, :port, :db).any?
+        warn "Deprecated: please specify Redis connection as URL (\"redis://host:port/db\")"
+        establish_connection :adapter=>"redis", :host=>@options[:host], :port=>@options[:port], :database=>@options[:db] || @options[:database]
+      elsif @options[:redis]
+        @adapter = RedisAdapter.new(:redis=>@options[:redis])
+      else
+        connection_spec = args.shift || @options[:connection]
+        if connection_spec
+          connection_spec = "redis://" + connection_spec unless connection_spec[/^\w+:/]
+          establish_connection connection_spec
+        end
+      end
+
+      warn "Deprecated: namespace option no longer supported directly" if @options[:namespace]
+      @load_path = @options[:load_path] || DEFAULTS[:load_path]
+      unless @logger = @options[:logger]
+        @logger = Logger.new(STDOUT)
+        @logger.level = Logger::ERROR
+      end
+      @loading = []
+      @use_js = false
+      self.add_participant_path = DEFAULT_ADD_PARTICIPANT_PATH
+      @collecting = !!@options[:collecting]
+    end
+   
+    # Deprecated. Use redis.server instead.
+    attr_accessor :host, :port, :db, :password, :namespace
+
+    # Path to load experiment files from.
+    attr_accessor :load_path
+
+    # Logger.
+    attr_accessor :logger
+
+    # Path to the add_participant action, necessary if you have called use_js!
+    attr_accessor :add_participant_path
+
+    # Defines a new experiment. Generally, do not call this directly,
+    # use one of the definition methods (ab_test, measure, etc).
+    #
+    # @see Vanity::Experiment
+    def define(name, type, options = {}, &block)
+      warn "Deprecated: if you need this functionality let's make a better API"
+      id = name.to_s.downcase.gsub(/\W/, "_").to_sym
+      raise "Experiment #{id} already defined once" if experiments[id]
+      klass = Experiment.const_get(type.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase })
+      experiment = klass.new(self, id, name, options)
+      experiment.instance_eval &block
+      experiment.save
+      experiments[id] = experiment
+    end
+
+    # Returns the experiment. You may not have guessed, but this method raises
+    # an exception if it cannot load the experiment's definition.
+    #
+    # @see Vanity::Experiment
+
+    def experiment(name)
+      id = name.to_s.downcase.gsub(/\W/, "_").to_sym
+      warn "Deprecated: pleae call experiment method with experiment identifier (a Ruby symbol)" unless id == name
+      experiments[id.to_sym] or raise NoExperimentError, "No experiment #{id}"
+    end
+
+
+    # -- Robot Detection --
+
+    # Call to indicate that participants should be added via js
+    # This helps keep robots from participating in the ab test
+    # and skewing results.
+    #
+    # If you use this, there are two more steps:
+    # - Set Vanity.playground.add_participant_path = '/path/to/vanity/action',
+    #   this should point to the add_participant path that is added with
+    #   Vanity::Rails::Dashboard, make sure that this action is available
+    #   to all users
+    # - Add <%= vanity_js %> to any page that needs uses an ab_test. vanity_js
+    #   needs to be included after your call to ab_test so that it knows which
+    #   version of the experiment the participant is a member of.  The helper
+    #   will render nothing if the there are no ab_tests running on the current
+    #   page, so adding vanity_js to the bottom of your layouts is a good
+    #   option.  Keep in mind that if you call use_js! and don't include
+    #   vanity_js in your view no participants will be recorded.
+    def use_js!
+      @use_js = true
+    end
+
+    def using_js?
+      @use_js
+    end
+
+
+    # Returns hash of experiments (key is experiment id).
+    #
+    # @see Vanity::Experiment
+    def experiments
+      unless @experiments
+        @experiments = {}
+        @logger.info "Vanity: loading experiments from #{load_path}"
+        Dir[File.join(load_path, "*.rb")].each do |file|
+          experiment = Experiment::Base.load(self, @loading, file)
+          experiment.save
+        end
+      end
+      @experiments
+    end
+
+    # Reloads all metrics and experiments.  Rails calls this for each request in
+    # development mode.
+    def reload!
+      @experiments = nil
+      @metrics = nil
+      load!
+    end
+
+    # Loads all metrics and experiments.  Rails calls this during
+    # initialization.
+    def load!
+      experiments
+      metrics
+    end
+
+    # Returns a metric (raises NameError if no metric with that identifier).
+    #
+    # @see Vanity::Metric
+    # @since 1.1.0
+    def metric(id)
+      metrics[id.to_sym] or raise NameError, "No metric #{id}"
+    end
+
+    # True if collection data (metrics and experiments). You only want to
+    # collect data in production environment, everywhere else run with
+    # collection off.
+    #
+    # @since 1.4.0
+    def collecting?
+      @collecting
+    end
+
+    # Turns data collection on and off.
+    #
+    # @since 1.4.0
+    def collecting=(enabled)
+      @collecting = !!enabled
+    end
+
+    # Returns hash of metrics (key is metric id).
+    #
+    # @see Vanity::Metric
+    # @since 1.1.0
+    def metrics
+      unless @metrics
+        @metrics = {}
+        @logger.info "Vanity: loading metrics from #{load_path}/metrics"
+        Dir[File.join(load_path, "metrics/*.rb")].each do |file|
+          Metric.load self, @loading, file
+        end
+        if config_file_exists? && remote = load_config_file["metrics"]
+          remote.each do |id, url|
+            fail "Metric #{id} already defined in playground" if metrics[id.to_sym]
+            metric = Metric.new(self, id)
+            metric.remote url
+            metrics[id.to_sym] = metric
+          end
+        end
+      end
+      @metrics
+    end
+
+    # Tracks an action associated with a metric.
+    #
+    # @example
+    #   Vanity.playground.track! :uploaded_video
+    #
+    # @since 1.1.0
+    def track!(id, count = 1)
+      metric(id).track! count
+    end
+
+    # Choose a value for any experiment tagged with the specified event;
+    # filter can be used to specify a white-list for experiments.
+    def assign_on(event, filter=nil)
+      experiments.each do |id, obj|
+        if !filter || filter.include?(id)
+          if obj.assign_on?(event)
+            obj.choose
+          end
+        end
+      end
+    end
+
+    # -- Connection management --
+ 
+    # This is the preferred way to programmatically create a new connection (or
+    # switch to a new connection). If no connection was established, the
+    # playground will create a new one by calling this method with no arguments.
+    #
+    # With no argument, uses the connection specified in config/vanity.yml file
+    # for the current environment (RACK_ENV, RAILS_ENV or development). If there
+    # is no config/vanity.yml file, picks the configuration from
+    # config/redis.yml, or defaults to Redis on localhost, port 6379.
+    #
+    # If the argument is a symbol, uses the connection specified in
+    # config/vanity.yml for that environment. For example:
+    #   Vanity.playground.establish_connection :production
+    #
+    # If the argument is a string, it is processed as a URL. For example:
+    #   Vanity.playground.establish_connection "redis://redis.local/5"
+    #
+    # Otherwise, the argument is a hash and specifies the adapter name and any
+    # additional options understood by that adapter (as with config/vanity.yml).
+    # For example:
+    #   Vanity.playground.establish_connection :adapter=>:redis,
+    #                                          :host=>"redis.local"
+    #
+    # @since 1.4.0 
+    def establish_connection(spec = nil)
+      @spec = spec
+      disconnect! if @adapter
+      case spec
+      when nil
+        if config_file_exists?
+          env = ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
+          spec = load_config_file[env]
+          fail "No configuration for #{env}" unless spec
+          establish_connection spec
+        elsif config_file_exists?("redis.yml")
+          env = ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
+          redis = load_config_file("redis.yml")[env]
+          fail "No configuration for #{env}" unless redis
+          establish_connection "redis://" + redis
+        else
+          establish_connection :adapter=>"redis"
+        end
+      when Symbol
+        spec = load_config_file[spec.to_s]
+        establish_connection spec
+      when String
+        uri = URI.parse(spec)
+        params = CGI.parse(uri.query) if uri.query
+        establish_connection :adapter=>uri.scheme, :username=>uri.user, :password=>uri.password,
+          :host=>uri.host, :port=>uri.port, :path=>uri.path, :params=>params
+      else
+        spec = spec.inject({}) { |hash,(k,v)| hash[k.to_sym] = v ; hash }
+        @adapter = Adapters.establish_connection(spec)
+      end
+    end
+
+    def config_file_root
+      (defined?(::Rails) ? ::Rails.root : Pathname.new(".")) + "config"
+    end
+
+    def config_file_exists?(basename = "vanity.yml")
+      File.exists?(config_file_root + basename)
+    end
+
+    def load_config_file(basename = "vanity.yml")
+      YAML.load(ERB.new(File.read(config_file_root + basename)).result)
+    end
+
+    # Returns the current connection. Establishes new connection is necessary.
+    #
+    # @since 1.4.0
+    def connection
+      @adapter || establish_connection
+    end
+
+    # Returns true if connection is open.
+    #
+    # @since 1.4.0
+    def connected?
+      @adapter && @adapter.active?
+    end
+
+    # Closes the current connection.
+    #
+    # @since 1.4.0
+    def disconnect!
+      @adapter.disconnect! if @adapter
+    end
+
+    # Closes the current connection and establishes a new one.
+    #
+    # @since 1.3.0
+    def reconnect!
+      establish_connection(@spec)
+    end
+
+    # Deprecated. Use Vanity.playground.collecting = true/false instead.  Under
+    # Rails, collecting is true in production environment, false in all other
+    # environments, which is exactly what you want.
+    def test!
+      warn "Deprecated: use collecting = false instead"
+      self.collecting = false
+    end
+
+    # Deprecated. Use establish_connection or configuration file instead.
+    def redis=(spec_or_connection)
+      warn "Deprecated: use establish_connection method instead"
+      case spec_or_connection
+      when String
+        establish_connection "redis://" + spec_or_connection
+      when ::Redis
+        @connection = Adapters::RedisAdapter.new(spec_or_connection)
+      when :mock
+        establish_connection :adapter=>:mock
+      else
+        raise "I don't know what to do with #{spec_or_connection.inspect}"
+      end
+    end
+
+    def redis
+      warn "Deprecated: use connection method instead"
+      connection
+    end
+
+  end
+
+  # In the case of Rails, use the Rails logger and collect only for
+  # production environment by default.
+  class << self
+
+    # The playground instance.
+    #
+    # @see Vanity::Playground
+    attr_accessor :playground
+    def playground
+      # In the case of Rails, use the Rails logger and collect only for
+      # production environment by default.
+      @playground ||= Playground.new(:rails=>defined?(::Rails))
+    end
+
+    # Returns the Vanity context.  For example, when using Rails this would be
+    # the current controller, which can be used to get/set the vanity identity.
+    def context
+      Thread.current[:vanity_context]
+    end
+
+    # Sets the Vanity context.  For example, when using Rails this would be
+    # set by the set_vanity_context before filter (via Vanity::Rails#use_vanity).
+    def context=(context)
+      Thread.current[:vanity_context] = context
+    end
+
+    # Path to template.
+    def template(name)
+      path = File.join(File.dirname(__FILE__), "templates/#{name}")
+      path << ".erb" unless name["."]
+      path
+    end
+  end
+end
+
+
+class Object
+
+  # Use this method to access an experiment by name.
+  #
+  # @example
+  #   puts experiment(:text_size).alternatives
+  #
+  # @see Vanity::Playground#experiment
+  # @deprecated
+  def experiment(name)
+    warn "Deprecated. Please call Vanity.playground.experiment directly."
+    Vanity.playground.experiment(name)
+  end
+end