redis_analytics 0.6.0 → 0.7.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0ef5f23c2318259c84c82a4bdadc2807a98b9f4
+  data.tar.gz: f7d5120d54362f3db06621fc3a0d2a8d49de5e56
+SHA512:
+  metadata.gz: dbf6336fa2e451e0a96cb19f0431a6d26ae9677f42442b8ec75a600f1d80d0b9006d1eedb950e5be8e57974017979622c887311c4be58a3f5231bdcf89c1aa0f
+  data.tar.gz: caeb72ecf45491fbd8c147e1388c9a1dbd209ac903ea6820d2f814696884cb5dac16f08d045273252b1b909ea6bff5d79cae61350c6c92aa00e2949d50bbdcc7

data/Gemfile.lock

@@ -1,57 +1,176 @@
 PATH
   remote: .
   specs:
-    redis_analytics (0.1.0)
-      activesupport (>= 3.2.0)
-      browser (>= 0.1.6)
-      geoip (>= 1.2.1)
-      json (>= 1.7.7)
-      rack (>= 1.4.0)
-      redis (>= 3.0.2)
-      sinatra (>= 1.3.3)
+    redis_analytics (0.7.0)
+      browser
+      geoip
+      jquery-rails
+      json
+      rails (>= 3.2.0, < 5)
+      redis
+      sqlite3
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.2.13)
-      i18n (= 0.6.1)
-      multi_json (~> 1.0)
-    browser (0.1.6)
-    diff-lcs (1.1.3)
-    geoip (1.2.1)
-    i18n (0.6.1)
-    json (1.7.7)
-    metaclass (0.0.1)
-    mocha (0.12.7)
+    actionmailer (4.1.0)
+      actionpack (= 4.1.0)
+      actionview (= 4.1.0)
+      mail (~> 2.5.4)
+    actionpack (4.1.0)
+      actionview (= 4.1.0)
+      activesupport (= 4.1.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.0)
+      activesupport (= 4.1.0)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.0)
+      activesupport (= 4.1.0)
+      builder (~> 3.1)
+    activerecord (4.1.0)
+      activemodel (= 4.1.0)
+      activesupport (= 4.1.0)
+      arel (~> 5.0.0)
+    activesupport (4.1.0)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.0)
+    browser (0.4.1)
+    builder (3.2.2)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    celluloid-io (0.15.0)
+      celluloid (>= 0.15.0)
+      nio4r (>= 0.5.0)
+    coderay (1.1.0)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    diff-lcs (1.2.5)
+    docile (1.1.3)
+    erubis (2.7.0)
+    fakeredis (0.4.3)
+      redis (~> 3.0.0)
+    ffi (1.9.3)
+    formatador (0.2.4)
+    geoip (1.4.0)
+    guard (2.6.0)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.2.8)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    hike (1.2.3)
+    i18n (0.6.9)
+    jquery-rails (3.1.0)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.1)
+    listen (2.7.1)
+      celluloid (>= 0.15.2)
+      celluloid-io (>= 0.15.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.5)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    minitest (5.3.2)
+    mocha (1.0.0)
       metaclass (~> 0.0.1)
-    multi_json (1.7.1)
+    multi_json (1.9.2)
+    nio4r (1.0.0)
+    polyglot (0.3.4)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
     rack (1.5.2)
-    rack-protection (1.5.0)
-      rack
     rack-test (0.6.2)
       rack (>= 1.0)
-    rake (10.0.3)
-    redis (3.0.2)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
-    sinatra (1.3.3)
-      rack (~> 1.3, >= 1.3.6)
-      rack-protection (~> 1.2)
-      tilt (~> 1.3, >= 1.3.3)
-    tilt (1.3.6)
+    rails (4.1.0)
+      actionmailer (= 4.1.0)
+      actionpack (= 4.1.0)
+      actionview (= 4.1.0)
+      activemodel (= 4.1.0)
+      activerecord (= 4.1.0)
+      activesupport (= 4.1.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.0)
+      sprockets-rails (~> 2.0)
+    railties (4.1.0)
+      actionpack (= 4.1.0)
+      activesupport (= 4.1.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.2.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.3)
+      ffi (>= 0.5.0)
+    redis (3.0.7)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.5.0)
+    sprockets (2.12.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.1.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.9)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.3)
+    tilt (1.4.1)
+    timers (1.1.0)
+    tins (1.1.0)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  mocha (>= 0.12.7)
-  rack-test (>= 0.6.2)
-  rake (>= 10.0.3)
+  coveralls
+  fakeredis
+  guard-rspec
+  mocha
+  rack-test
+  rake
   redis_analytics!
-  rspec (>= 2.11.0)
+  rspec
+  simplecov

data/README.md

@@ -2,11 +2,11 @@
 
 ### What is redis_analytics?
 
-A gem that provides a Redis based web analytics solution for your rack-compliant apps
+A ruby gem that uses redis to track web analytics for your rails apps
 
 ### Why should I use it?
 
-It gives you detailed analytics about visitors, unique visitors, browsers, OS, visitor recency, traffic sources and more
+It gives you detailed analytics about visitors, unique visitors, browsers, OS, visitor recency, traffic sources, etc
 
 ### Does it have a cool dashboard?
 
@@ -14,11 +14,9 @@ Yes, It uses the excellent [Morris.js](http://www.oesmith.co.uk/morris.js/) for
 
 ![Screenshot](https://github.com/saturnine/redis_analytics/raw/master/screenshot.png)
 
-### OK, so how do I install it?
+### Cool! So how do I install it?
 
-`gem install redis_analytics`
-
-or in your `Gemfile`
+In your `Gemfile`
 
 ```ruby
 gem 'redis_analytics'
@@ -27,53 +25,36 @@ gem 'redis_analytics'
 Make sure your redis server is running! Redis configuration is outside the scope of this README, but
 check out the [Redis documentation](http://redis.io/documentation).
 
-### How do I enable tracking in my rack-compliant app?
-
-#### Step 1: Load the redis_analytics library and configure it
+### How do I enable tracking in my rails apps?
 
 ```ruby
-# this is not required unless you use :require => false in your Gemfile
 require 'redis_analytics'
 
-# configure your redis connection (this is mandatory) and namespace (this is optional)
-Rack::RedisAnalytics.configure do |configuration|
+# configure your redis_connection (mandatory) and redis_namespace (optional)
+RedisAnalytics.configure do |configuration|
   configuration.redis_connection = Redis.new(:host => 'localhost', :port => '6379')
   configuration.redis_namespace = 'ra'
 end
 ```
-#### Step 2: Use the Tracker rack middleware (NOT REQUIRED FOR RAILS)
-
-```ruby
-# in Sinatra you would do...
-use Rack::RedisAnalytics::Tracker
-```
-
-For rails the middleware is added automatically, so you do not need to add it manually using `config.middleware.use`
 
 ### Where can I see the dashboard?
 
-Simply navigate to `/redis_analytics` in your rack app
-
-You can also run the standalone dashboard sinatra app like:
-
-`redis_analytics_dashboard --redis-host 127.0.0.1 --redis-port 6379 --redis-namespace ra`
-
-### Where do I change the dashboard URL endpoint?
-
-Set a dashboard endpoint in your configuration:
+The Dashboard is a `Rails::Engine`. Just mount it into your `routes.rb` file at your favorite endpoint
 
 ```ruby
-Rack::RedisAnalytics.configure do |configuration|
-  configuration.dashboard_endpoint = '/dashboard'
+Rails.application.routes.draw do
+  mount RedisAnalytics::Dashboard::Engine => "/dashboard"
 end
 ```
 
-### What if I have multiple rails apps that I want to track as one?
+and navigate to `/dashboard` in your app
 
-In the configuration, keep the value of redis_namespace the same across all your rails apps
+### What if I have multiple rails apps that I want to track as one single website?
+
+Just make sure you use the same `redis_connection` and `redis_namespace` in the configuration for all your rails apps
 
 ```ruby
-Rack::RedisAnalytics.configure do |configuration|
+RedisAnalytics.configure do |configuration|
   configuration.redis_connection = Redis.new(:host => 'localhost', :port => '6379')
   configuration.redis_namespace = 'mywebsite.org'
 end
@@ -86,7 +67,7 @@ Also it is recommended to regularly get an updated binary of 'GeoLite Country' d
 You will then need to point to the GeoIP.dat file in your configuration.
 
 ```ruby
-Rack::RedisAnalytics.configure do |configuration|
+RedisAnalytics.configure do |configuration|
   configuration.redis_connection = Redis.new(:host => 'localhost', :port => '6379')
   configuration.redis_namespace = 'mywebsite.org'
   configuration.geo_ip_data_path = '/path/to/GeoIP.dat'
@@ -97,55 +78,71 @@ end
 
 ### Tracking custom metrics
 
-You can define and track your own metrics by defining an instance method inside the `Metrics` module
+You can define how to track custom metrics by creating an instance method inside the `RedisAnalytics::Metrics` module
+
+```ruby
+module RedisAnalytics::Metrics
+
+  # methods to track custom metrics  
+
+end
+```
 
-All you need to do, is make sure the method name conforms to the following format:
+RedisAnalytics only looks for method names which conform to the following format:
 
 `[abc]_[x]_per_[y]`
 
 where
 
 * `abc` is a metric name
-* `x` can be any one of `ratio` or `count` and defines how the metric is stored (`zset` or `string` respectively)
-* `y` can be any one of `hit` or `visit` and defines how will be tracked  (once per hit or once per visit)
+* `x` can be any one of `ratio` or `count` and defines the type of the metric
+* `y` can be any one of `hit` or `visit` and defines how the metric will be tracked (once per hit or once per visit)
 
-The return value of the method should be `Fixnum` for `count` and `String` for `ratio`  
+The return value of the method is important and should be `Fixnum` for `count` and `String` for `ratio` failing which, your metric might not work!
 
-If the return value is an `error` or `nil` the metric won't be tracked  
+If the return value is an `error` or `nil` the metric won't be tracked at all
 
-You can access the `Rack::Request` object via `@rack_request` and the `Rack::Response` object via `@rack_response` in your method  
+You can access the `Rack::Request` object via `@rack_request` and the `Rack::Response` object via `@rack_response` in your methods
 
-You are free to define other methods that do not have the above format in the `Metrics` module as helper methods  
+You are free to define other methods that do not have the above format in the `Metrics` module as helper methods
 
 ```ruby
-module Rack::RedisAnalytics::Metrics
+module RedisAnalytics::Metrics
 
-  # whenever a product is sold, i want to track it per product_id
-  def product_sales_ratio_per_hit
-    if @request.path == '/product/sale'
-      return @request.params['product_id']
+  # TRACKING RATIOS
+
+  # i want to track ratio of product views per product_id & user_id using query params
+  def user_product_views_ratio_per_hit
+    if @rack_request.path == '/product/info'
+      return "#{@rack_request.params['product_id']}_#{@rack_request.params['user_id']}"
     end
   end
 
-  # whenever a product is viewed by a user, i want to track it per product & user
-  def user_product_views_ratio_per_hit
-    if @request.path == '/product/info'
-      return "#{@request.params['product_id']}_#{@request.params['user_id']}"
+  # i want to track ratio of sold products by product_id using the URL `/products/:id/sale`
+  def product_sales_ratio_per_hit
+    if @rack_request.path =~ Regexp.new("\/product\/([0-9]+)\/sale")
+      return $1
     end
   end
 
-  # how many times did a visitor reach the payment step
+  # TRACKING COUNTS
+
+  # i want to track how many times a visitor reached the payment step
   def payment_step_count_per_hit
-    return 1 if @request.path == '/payment'
+    return 1 if @rack_request.path == '/payment'
   end
 
 end
 ```
 
+### Customizing the dashboard
+
+Coming soon
+
 ### Using filters
 
 ```ruby
-Rack::RedisAnalytics.configure do |configuration|
+RedisAnalytics.configure do |configuration|
 
   # simple string path filter
   configuration.add_path_filter('/robots.txt')
@@ -166,15 +163,8 @@ Rack::RedisAnalytics.configure do |configuration|
 end
 ```
 
-## How does it work?
-
-![Screenshot](https://github.com/saturnine/redis_analytics/raw/master/wsd.png)
-
 ## License
 
-Since redis_analytics is licensed under MIT, you can use redis_analytics, provided you leave the attribution as is, in code as well as on the dashboard pages
-
-Copyright (c) 2012-2013 Schubert Cardozo. See [LICENSE!](LICENSE) for further details. 
-
-
+Since redis_analytics is licensed under MIT, you can use redis_analytics for free, provided you leave the attribution as is, in code as well as on the dashboard pages
 
+Copyright (c) 2012-2014 Schubert Cardozo. See [MIT-LICENSE!](MIT-LICENSE) for further details.

data/TODO.md

@@ -1,5 +1,6 @@
 ## TODO
 
+* traffic sources (split up and bugfixes)
 * cleanup and refactor analytics.rb
 * cleanup and refactor dashboard.rb
 * dashboard to have custom date selectors

data/app/controllers/redis_analytics/api_controller.rb

@@ -0,0 +1,50 @@
+module RedisAnalytics
+  class ApiController < ApplicationController
+
+    def visits
+      to_date_time = Date.parse(params[:to_date_time]).to_time rescue Time.now
+      unit = params[:unit] || 'day'
+      aggregate = (params[:aggregate] == 'yes')
+      units = (params[:unit_count] || 1).to_i
+      p = params[:metrics].split(',')
+      from_date_time = to_date_time - units.send(unit)
+      results = []
+      
+      p.each_with_index do |q, j|
+        result = self.send("#{unit}ly_#{q}", from_date_time, :to_date => to_date_time, :aggregate => aggregate)
+        if result.is_a?(Array) # time range data (non-aggregate)
+          result.each_with_index do |r, i|
+            results[i] ||= {}
+            date_value = r[0][0..2]
+            time_value = r[0][3..-1]
+            date_time_value = []
+            date_time_value << date_value.join('-')
+            date_time_value << time_value.join(':') if time_value
+            # results[i]['raw'] = date_time_value.join(' ').strip
+            results[i]['unix'] = Time.mktime(*r[0].map(&:to_i)).to_i
+            strf = case unit
+                   when 'minute'
+                     '%H%Mhrs'
+                   when 'hour'
+                     '%a %H00hrs'
+                   when 'day'
+                     '%a'
+                   when 'month'
+                     '%b'
+                   when 'year'
+                     '%Y'
+                   end
+            results[i]['raw'] = Time.at(results[i]['unix']).strftime(strf)
+            results[i][q] = r[1]
+          end
+        elsif result.is_a?(Hash) or result.is_a?(Fixnum) # aggregate data
+          results[j] = {q => result}
+        end
+      end
+      render :json => results 
+    rescue Exception => e
+      render :status => 500, :text => [e.message, e.backtrace]
+    end
+
+  end
+end