charted 0.0.8 → 0.1.0

data/lib/charted/version.rb

@@ -0,0 +1,3 @@
+module Charted
+  VERSION = '0.1.0'
+end

data/migrate/001_init_schema.rb

@@ -0,0 +1,56 @@
+Sequel.migration do
+  change do
+    create_table(:sites) do
+      primary_key :id
+      column :domain, String, null: false, unique: true
+      column :created_at, DateTime, null: false
+    end
+
+    create_table(:visitors) do
+      primary_key :id
+      foreign_key :site_id, :sites
+      column :secret, String, null: false
+      column :resolution, String
+      column :created_at, DateTime
+      column :platform, String
+      column :browser, String
+      column :browser_version, String
+      column :country, String
+      column :bucket, Integer, null: false
+    end
+
+    create_table(:visits) do
+      primary_key :id
+      foreign_key :visitor_id, :visitors
+      column :path, String, null: false
+      column :title, String, null: false
+      column :referrer, String, size: 2048
+      column :search_terms, String
+      column :created_at, DateTime, null: false
+    end
+
+    create_table(:events) do
+      primary_key :id
+      foreign_key :visitor_id, :visitors
+      column :label, String, null: false
+      column :created_at, DateTime, null: false
+    end
+
+    create_table(:conversions) do
+      primary_key :id
+      foreign_key :visitor_id, :visitors
+      column :label, String, null: false
+      column :created_at, DateTime, null: false
+      column :ended_at, DateTime
+    end
+
+    create_table(:experiments) do
+      primary_key :id
+      foreign_key :visitor_id, :visitors
+      column :label, String, null: false
+      column :bucket, String, null: false
+      column :created_at, DateTime, null: false
+      column :ended_at, DateTime
+    end
+  end
+end

data/public/charted/script.js

@@ -0,0 +1,96 @@
+var Charted = {
+  URL: "/charted/",
+  RECORD_URL: URL + "record",
+  send: function(url, queryString) {
+    if (this.cookie("chartedignore")) { return; }
+    if (typeof jQuery === 'undefined') {
+      var script = document.createElement("script");
+      script.type = "text/javascript";
+      script.async = true;
+      script.src = url + "?" + queryString;
+      document.getElementsByTagName("head")[0].appendChild(script);
+    } else if (url.match(/^https?:\/\//)) {
+      jQuery.getScript(url + "?" + queryString);
+    } else {
+      jQuery.get(url, queryString);
+    }
+  },
+  cookie: function(name) {
+    var obj = {};
+    var val = document.cookie.match(new RegExp("(?:^|;) *"+name+"=([^;]*)"));
+    if (val) {
+      val = this.decode(val[1]).split("&");
+      return val[0];
+    }
+    return null;
+  },
+  ignore: function() {
+    var date = new Date();
+    date.setTime(date.getTime()+(2*365*24*60*60*1000));
+    var expires = "; expires="+date.toGMTString();
+    document.cookie = "chartedignore=1"+expires+"; path=/";
+  },
+  clear: function() {
+    document.cookie = 'charted=; expires=Thu, 01 Jan 1970 00:00:01 GMT;';
+  },
+  strip: function(str) {
+    return String(str).replace(/^\s+|\s+$/g, '');
+  },
+  decode: function(encoded) {
+    return decodeURIComponent(encoded.replace("+", "%20"));
+  },
+  normalize: function(str) {
+    return str.toLowerCase().replace(' ', '-').replace(/\W/g, '');
+  },
+  events: function() {
+    var str = [];
+    for (var i = 0; i < arguments.length; i++) {
+      str.push(arguments[i]);
+    }
+    this.send(this.RECORD_URL, "events=" + encodeURIComponent(str.join(";")));
+  },
+  goals: function() {
+    var str = [];
+    for (var i = 0; i < arguments.length; i++) {
+      str.push(arguments[i]);
+    }
+    this.send(this.RECORD_URL, "goals=" + encodeURIComponent(str.join(";")));
+  },
+  init: function() {
+    var cookie = this.cookie("charted");
+    var bucketNum = cookie ?
+      parseInt(cookie.split("-")[1]) :
+      Math.floor(Math.random() * 10);
+    var convQuery = "";
+    var conversions = document.body.getAttribute("data-conversions");
+    if (conversions) {
+      convQuery = "&conversions=" + encodeURIComponent(conversions);
+    }
+    var expQuery = "";
+    var experiments = document.body.getAttribute("data-experiments");
+    if (experiments) {
+      expQuery = "&experiments=";
+      experiments = experiments.split(";");
+      for (var i = 0; i < experiments.length; i++) {
+        var experiment = experiments[i].split(":");
+        var label = this.strip(experiment[0]);
+        var buckets = experiment[1].split(",");
+        var bucket = buckets[bucketNum % buckets.length];
+        bucket = this.strip(bucket);
+
+        document.body.className +=
+          (this.normalize(label) + "-" + this.normalize(bucket) + " ");
+        expQuery += encodeURIComponent(label + ":" + bucket + ";");
+      }
+    }
+    Charted.send(
+      Charted.URL,
+      "path=" + encodeURIComponent(window.location.pathname) +
+      "&title=" + encodeURIComponent(document.title) +
+      "&referrer=" + encodeURIComponent(document.referrer) +
+      "&resolution=" + encodeURIComponent(screen.width+"x"+screen.height) +
+      "&bucket=" + bucketNum +
+      convQuery + expQuery);
+  }
+};
+Charted.init();

data/test/app_test.rb

@@ -0,0 +1,160 @@
+require_relative 'helper'
+
+class AppTest < ChartedTest
+  include Rack::Test::Methods
+
+  def setup
+    super
+    clear_cookies
+    @site = Charted::Site.create(:domain => 'example.org')
+    @params = {
+      :bucket => 1,
+      :path => '/',
+      :title => 'Prime',
+      :referrer => 'http://localhost/?k=v',
+      :resolution => '1280x800'
+    }
+    @env = {
+      'HTTP_USER_AGENT' =>
+        'Mozilla/5.0 (X11; Linux i686; rv:14.0) Gecko/20100101 Firefox/14.0.1',
+      'REMOTE_ADDR' => '67.188.42.140'
+    }
+  end
+
+  def test_environment
+    assert_equal(:test, Charted::App.environment)
+  end
+
+  def test_bad_domain
+    get '/charted', @params, 'HTTP_HOST' => 'localhost'
+    assert_equal(404, last_response.status)
+    assert_equal(0, Charted::Visitor.count)
+    assert_equal(0, Charted::Visit.count)
+  end
+
+  def test_error
+    raises_error = lambda { |*args| raise('Stubbed Error') }
+    Charted::Site.stub(:first, raises_error) do
+      assert_raises(RuntimeError) do
+        get '/charted', @params, @env
+      end
+    end
+    mail = Pony.last_mail
+    assert_equal('dev@localhost', mail[:to])
+    assert_equal('[Charted Error] Stubbed Error', mail[:subject])
+    assert(mail[:body])
+  end
+
+  def test_new_visitor
+    get '/charted', @params, @env
+    assert(last_response.ok?)
+    assert_equal(1, Charted::Visitor.count)
+    assert_equal(1, Charted::Visit.count)
+
+    visitor = Charted::Visitor.first
+    visit = Charted::Visit.first
+    assert_equal(@site, visitor.site)
+    assert_equal(@site, visit.site)
+    assert_equal('Prime', visit.title)
+    assert_equal('/', visit.path)
+    assert_equal('http://localhost/?k=v', visit.referrer)
+    assert_equal('1280x800', visitor.resolution)
+    assert_equal('United States', visitor.country)
+    assert_equal(visitor.cookie, rack_mock_session.cookie_jar['charted'])
+  end
+
+  def test_old_visitor
+    visitor = Charted::Visitor.create(:site => @site)
+    visit = Charted::Visit.create(
+      :visitor => visitor, :path => '/', :title => 'Prime')
+    set_cookie("charted=#{visitor.cookie}")
+
+    get '/charted', @params, @env
+    assert(last_response.ok?)
+    assert_equal(1, Charted::Visitor.count)
+    assert_equal(2, Charted::Visit.count)
+    assert_equal(visitor.cookie, rack_mock_session.cookie_jar['charted'])
+  end
+
+  def test_visitor_bad_cookie
+    visitor = Charted::Visitor.create(:site => @site)
+    visit = Charted::Visit.create(
+      :visitor => visitor, :path => '/', :title => 'Prime')
+    set_cookie("charted=#{visitor.id}-zzzzz")
+
+    get '/charted', @params, @env
+    assert(last_response.ok?)
+    assert_equal(2, Charted::Visitor.count)
+    assert_equal(2, Charted::Visit.count)
+    refute_equal(visitor.cookie, rack_mock_session.cookie_jar['charted'])
+  end
+
+  def test_events # TODO: use correct HTTP methods?
+    get '/charted/record', events: 'Event Label;Event Label 2'
+    assert_equal(404, last_response.status)
+
+    visitor = @site.add_visitor({})
+    set_cookie("charted=#{visitor.cookie}")
+    get '/charted/record', events: 'Event Label;Event Label 2'
+    assert(last_response.ok?)
+    assert_equal(2, Charted::Event.count)
+
+    event = Charted::Event.first(label: 'Event Label')
+    assert_equal(@site, event.site)
+    assert_equal(visitor, event.visitor)
+    assert_equal('Event Label', event.label)
+
+    event2 = Charted::Event.first(label: 'Event Label 2')
+    assert(event2)
+    assert_equal('Event Label 2', event2.label)
+  end
+
+  def test_conversions
+    visitor = @site.add_visitor({})
+    set_cookie("charted=#{visitor.cookie}")
+    get '/charted', @params.merge(conversions: 'Logo Clicked;Button Clicked'), @env
+    assert(last_response.ok?)
+    assert_equal(2, Charted::Conversion.count)
+
+    logo = visitor.conversions_dataset.first(label: 'Logo Clicked')
+    button = visitor.conversions_dataset.first(label: 'Button Clicked')
+    refute(logo.ended?)
+    refute(button.ended?)
+
+    get '/charted/record', goals: 'Logo Clicked;Button Clicked'
+    assert(last_response.ok?)
+    logo.reload
+    button.reload
+    assert(logo.ended?)
+    assert(button.ended?)
+  end
+
+  def test_experiments
+    visitor = @site.add_visitor({})
+    set_cookie("charted=#{visitor.cookie}")
+    get '/charted', @params.merge(experiments: 'Logo:A;Button:B'), @env
+    assert(last_response.ok?)
+    assert_equal(2, Charted::Experiment.count)
+
+    logo = visitor.experiments_dataset.first(label: 'Logo')
+    button = visitor.experiments_dataset.first(label: 'Button')
+    assert_equal('Logo', logo.label)
+    assert_equal('A', logo.bucket)
+    refute(logo.ended?)
+    assert_equal('Button', button.label)
+    assert_equal('B', button.bucket)
+    refute(button.ended?)
+
+    get '/charted/record', goals: 'Logo;Button'
+    assert(last_response.ok?)
+    logo.reload
+    button.reload
+    assert(logo.ended?)
+    assert(button.ended?)
+  end
+
+  private
+  def app
+    @app ||= Rack::Server.new.app
+  end
+end

data/test/command_test.rb

@@ -0,0 +1,70 @@
+require_relative 'helper'
+
+class CommandTest < ChartedTest
+  def setup
+    super
+    @cmd = Charted::Command.new
+    @cmd.config_loaded = true
+    Charted::Site.create(:domain => 'localhost')
+    Charted::Site.create(:domain => 'example.org')
+  end
+
+  def test_site
+    assert_raises(Charted::ExitError) { @cmd.site = 'nomatch' }
+    assert_equal(['No sites matching "nomatch"'], @cmd.output)
+    assert_nil(@cmd.site)
+
+    @cmd.output = nil
+    assert_raises(Charted::ExitError) { @cmd.site = 'l' }
+    assert_equal(['"l" ambiguous: localhost, example.org'], @cmd.output)
+
+    @cmd.site = 'local'
+    assert_equal('localhost', @cmd.site.domain)
+
+    @cmd.site = 'ample'
+    assert_equal('example.org', @cmd.site.domain)
+  end
+
+  def test_clean
+    site = Charted::Site.first(domain: 'localhost')
+    visitor = site.add_visitor({})
+    visitor.add_event(label: 'Label')
+    visitor.add_conversion(label: 'Label')
+    visitor.add_experiment(label: 'Label', bucket: 'A')
+    @cmd.output = nil
+    @cmd.clean
+    visitor.reload
+    assert_equal(1, visitor.events.size)
+    assert_equal(1, visitor.conversions.size)
+    assert_equal(1, visitor.experiments.size)
+
+    @cmd.output = nil
+    @cmd.clean('Label')
+    visitor.reload
+    assert_equal(0, visitor.events.size)
+    assert_equal(0, visitor.conversions.size)
+    assert_equal(0, visitor.experiments.size)
+  end
+
+  def test_dashboard
+    assert_raises(Charted::ExitError) { @cmd.dashboard }
+    assert_equal(['Please specify website with --site'], @cmd.output)
+    
+    @cmd.output = nil
+    @cmd.site = 'localhost'
+    @cmd.dashboard
+  end
+
+  def test_js
+    @cmd.output = nil
+    @cmd.js
+    assert_match("var Charted", @cmd.output[0])
+  end
+
+  def test_format
+    assert_equal('-10,200', @cmd.send(:format, -10200))
+    assert_equal('-1', @cmd.send(:format, -1))
+    assert_equal('1', @cmd.send(:format, 1))
+    assert_equal('1,200,300', @cmd.send(:format, 1200300))
+  end
+end

data/test/config_test.rb

@@ -0,0 +1,11 @@
+require_relative 'helper'
+
+class ConfigTest < ChartedTest
+  def test_config
+    assert_equal(365, Charted.config.delete_after)
+    assert_equal('dev@localhost', Charted.config.error_email)
+    assert_equal(['localhost'], Charted.config.sites)
+    assert_equal('sqlite::memory', Charted.config.db_options)
+    assert_equal({via: :sendmail}, Charted.config.email_options)
+  end
+end

data/test/fixtures.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../lib/charted', File.dirname(__FILE__))
+require_relative '../lib/charted'
 require 'date'
 
 module Charted

data/test/helper.rb

@@ -0,0 +1,43 @@
+ENV['RACK_ENV'] = 'test'
+
+require_relative '../lib/charted'
+require 'minitest/autorun'
+require 'rack'
+require 'rack/test'
+require 'rack/server'
+require 'fileutils'
+
+Charted.configure do |c|
+  c.delete_after  365
+  c.error_email   'dev@localhost'
+  c.sites         ['localhost']
+  c.db_options    'sqlite::memory'
+  c.email_options(via: :sendmail)
+end
+Charted::Migrate.run
+
+module Pony
+  def self.mail(fields)
+    Charted::Visit.select_all.delete
+    Charted::Event.select_all.delete
+    Charted::Conversion.select_all.delete
+    Charted::Experiment.select_all.delete
+    Charted::Visitor.select_all.delete
+    Charted::Site.select_all.delete
+    @last_mail = fields
+  end
+
+  def self.last_mail
+    @last_mail
+  end
+end
+
+class ChartedTest < Minitest::Test
+  def setup
+    Pony.mail(nil)
+  end
+
+  def teardown
+    FileUtils.rm_rf(File.expand_path('../temp', File.dirname(__FILE__)))
+  end
+end