RubyGems - charted - Versions diffs - 0.0.2 → 0.0.3 - Mend

charted 0.0.2 → 0.0.3

Files changed (5) hide show

data/README.md CHANGED

@@ -1,13 +1,17 @@
 Description
 ===========
-Charted is a minimal web traffic analytics app.  Still under development!
+Charted is a minimal web traffic analytics app.
 Installation
 ============
     $ gem install charted
+Also install the relevant database adapter, depending on which db you plan to use:
+    $ gem install dm-mysql-adapter
 Setup a `config.ru` file and run it like any other Sinatra application.
     require 'rubygems'
@@ -49,6 +53,10 @@ Updating
 ========
     $ gem install charted
+If you concatenated the JavaScript, you may need to do it again:
+    $ charted --js > /path/to/my/project/public/charted.js
 Usage
 =====
@@ -56,8 +64,7 @@ Usage
 The web application is for end users, to get information about your traffic use
 the included command line application.
-    $ charted --help
-    $ charted --dashboard --site hugh # just needs the first few letters
+    $ charted --site hugh # just needs the first few letters
     +-------+--------+--------------------------------------+
     | Total | Unique | Visits                               |
     +-------+--------+--------------------------------------+
@@ -66,6 +73,47 @@ the included command line application.
     | 5,342 |  3,988 | December 2012                        |
     ...
+Basic tracking of common stats like visits, referrers, or user agents are done
+automatically.  You can also track events, conversions, and experiments.
+Events can be recorded with JavaScript:
+    Charted.events("1st Button Clicked");
+    Charted.events("1st Button Clicked", "2nd Button Clicked");
+To start a conversion, you'll need to set the `data-conversions` attribute of
+the `<body>` element:
+    <body data-conversions="RSS Subscribed; Item Purchased">
+Just separate goal names with a semi-colon.  When the conversion goal has been
+reached:
+    Charted.goals("RSS Subscribed");
+    Charted.goals("RSS Subscribed", "Item Purchased"); // calls can be batched
+Experiments use the `data-experiments` attribute and use the format
+`experiment: bucket1, bucket2, ...`:
+    <body data-experiments="Buy Button: Blue, Green, Red">
+The included JavaScript will automatically select a bucket for this user and
+append a relevant class name to the `<body>` element like:
+    <body class="buy-button-green">
+The class name is just the experiment label and bucket lowercased with spaces
+replaced with dashes.  Use CSS to tweak the buy button.  When a user clicks
+on a button, use JavaScript to send a message to the server:
+    Charted.goals("Buy Button");
+Running `charted --clean` will prune the database of old data.  I recommend
+putting this as a cronjob.  It can also be used to remove bad entries in the
+events/conversions/experiments table:
+    charted --clean "Buy Button"
 Development
 ===========
@@ -86,8 +134,12 @@ Tests are setup to run via `ruby test/*_test.rb` or via `rake`.
 TODO
 ====
-* deploy task in Rakefile for development
-* add date range option
+* don't catch-all load error, makes debugging config.ru difficult
+* fix sorting
+* fix search terms
+* consider removing colored titles
+* shorten lists (too many single entries) on dashboard, add --full?
+* browser version (IE6, IE7, IE8...) ?
 License
 =======

data/charted CHANGED

@@ -8,15 +8,14 @@ require 'fileutils'
 ENV['CHARTED_CMD'] = '1'
 ARGV.options do |o|
-  cmd, action = Charted::Command.new, nil
+  cmd, action = Charted::Command.new, [:dashboard]
   o.set_summary_indent('  ')
   o.banner = "Usage: #{File.basename($0)} [OPTION]"
   o.on('-c', '--clean [label]', 'clean out old data') { |label| action = [:clean, label] }
-  o.on('-d', '--dashboard', 'show dashboard') { action = [:dashboard] }
   o.on('-h', '--help', 'show this help message') { puts o; exit }
   o.on('-j', '--js', 'output js code') { action = [:js] }
   o.on('-m', '--migrate', 'migrates database') { cmd.migrate; exit }
   o.on('-s', '--site domain', 'set site') { |site| cmd.site = site }
   o.parse!
-  action.nil? ? puts(o) : cmd.send(*action.compact)
+  cmd.send(*action.compact)
 end

data/lib/charted.rb CHANGED

@@ -19,7 +19,7 @@ require 'dashes'
 DataMapper::Model.raise_on_save_failure = true
 module Charted
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
   GEOIP = GeoIP.new("#{File.dirname(__FILE__)}/../geoip.dat")
   JS_FILE = "#{File.dirname(__FILE__)}/../public/charted/script.js"
@@ -272,7 +272,8 @@ module Charted
           expires: (Date.today + 365*2).to_time)
       end
-      referrer = nil if URI.parse(params[:referrer].to_s).host == @site.domain
+      referrer = params[:referrer].to_s
+      referrer = nil if URI.parse(referrer).host == @site.domain || referrer =~ /^\s*$/
       @visitor.visits.create(
         path: params[:path],
         title: params[:title],

data/test/charted_test.rb CHANGED

@@ -179,7 +179,7 @@ class AppTest < ChartedTest
       :bucket => 1,
       :path => '/',
       :title => 'Prime',
-      :referrer => 'localhost',
+      :referrer => 'http://localhost/?k=v',
       :resolution => '1280x800'
     }
     @env = {
@@ -212,7 +212,7 @@ class AppTest < ChartedTest
     assert_equal(@site, visit.site)
     assert_equal('Prime', visit.title)
     assert_equal('/', visit.path)
-    assert_equal(nil, visit.referrer)
+    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'])

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: charted
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: .
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2013-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra