audit_rails 1.1.10 → 2.0.0

data/app/assets/javascripts/audit_rails/page-views.js

@@ -0,0 +1,71 @@
+var data  = JSON.parse( $('div#pageViewsCount').attr('data-visit-count'));
+var right = d3.max([20, (900 - data.length * 50)]);
+var margin = {top: 40, right: right, bottom: 100, left: 40},
+    width = 960 - margin.left - margin.right,
+    height = 360 - margin.top - margin.bottom;
+
+var x = d3.scale.ordinal()
+    .rangeRoundBands([0, width], .1);
+
+var y = d3.scale.linear()
+    .range([height, 0]);
+
+var xAxis = d3.svg.axis()
+    .scale(x)
+    .orient("bottom");
+
+var yAxis = d3.svg.axis()
+    .scale(y)
+    .orient("left");
+
+var tip = d3.tip()
+  .attr('class', 'd3-tip')
+  .offset([-10, 0])
+  .html(function(d) {
+    return "<strong>Page Views:</strong> <span style='color:red'>" + d.count + "</span>";
+  })
+
+var svg = d3.select("div#pageViewsCount").append("svg")
+    .attr("width", width + margin.left + margin.right)
+    .attr("height", height + margin.top + margin.bottom)
+  .append("g")
+    .attr("transform", "translate(" + margin.left + "," + margin.top + ")");
+
+svg.call(tip);
+
+x.domain(data.map(function(d) { return d.page; }));
+y.domain([0, d3.max(data, function(d) { return d.count; })]);
+
+svg.append("g")
+    .attr("class", "x axis")
+    .attr("transform", "translate(0," + height + ")")
+    .call(xAxis)
+    .selectAll("text")
+    .style("text-anchor", "end")
+    .attr("dx", "-.8em")
+    .attr("dy", ".15em")
+    .attr("transform", function(d) {
+                return "rotate(-65)" 
+                });
+
+svg.append("g")
+    .attr("class", "y axis")
+    .call(yAxis)
+  .append("text")
+    .attr("transform", "rotate(-90)")
+    .attr("y", -40)
+    .attr("x", -80)
+    .attr("dy", "0.71em")
+    .style("text-anchor", "end")
+    .text("Page Views");
+
+svg.selectAll(".bar")
+    .data(data)
+  .enter().append("rect")
+    .attr("class", "bar")
+    .attr("x", function(d) { return x(d.page); })
+    .attr("width", x.rangeBand())
+    .attr("y", function(d) { return y(d.count); })
+    .attr("height", function(d) { return height - y(d.count); })
+    .on('mouseover', tip.show)
+    .on('mouseout', tip.hide);

data/app/assets/javascripts/audit_rails/user-counts.js

@@ -0,0 +1,72 @@
+var data  = JSON.parse( $('div#userViewsCount').attr('data-visit-count'));
+
+var right = d3.max([20, (900 - data.length * 50)]);
+var margin = {top: 40, right: right, bottom: 100, left: 40},
+    width = 960 - margin.left - margin.right,
+    height = 360 - margin.top - margin.bottom;
+
+var x = d3.scale.ordinal()
+    .rangeRoundBands([0, width], .1);
+
+var y = d3.scale.linear()
+    .range([height, 0]);
+
+var xAxis = d3.svg.axis()
+    .scale(x)
+    .orient("bottom");
+
+var yAxis = d3.svg.axis()
+    .scale(y)
+    .orient("left");
+
+var tip = d3.tip()
+  .attr('class', 'd3-tip')
+  .offset([-10, 0])
+  .html(function(d) {
+    return "<strong>Page Views:</strong> <span style='color:red'>" + d.count + "</span>";
+  })
+
+var svg = d3.select("div#userViewsCount").append("svg")
+    .attr("width", width + margin.left + margin.right)
+    .attr("height", height + margin.top + margin.bottom)
+  .append("g")
+    .attr("transform", "translate(" + margin.left + "," + margin.top + ")");
+
+svg.call(tip);
+
+x.domain(data.map(function(d) { return d.user; }));
+y.domain([0, d3.max(data, function(d) { return d.count; })]);
+
+svg.append("g")
+    .attr("class", "x axis")
+    .attr("transform", "translate(0," + height + ")")
+    .call(xAxis)
+    .selectAll("text")
+    .style("text-anchor", "end")
+    .attr("dx", "-.8em")
+    .attr("dy", ".15em")
+    .attr("transform", function(d) {
+                return "rotate(-65)" 
+                });
+
+svg.append("g")
+    .attr("class", "y axis")
+    .call(yAxis)
+  .append("text")
+    .attr("transform", "rotate(-90)")
+    .attr("y", -40)
+    .attr("x", -80)
+    .attr("dy", "0.71em")
+    .style("text-anchor", "end")
+    .text("Page Views");
+
+svg.selectAll(".bar")
+    .data(data)
+  .enter().append("rect")
+    .attr("class", "bar")
+    .attr("x", function(d) { return x(d.user); })
+    .attr("width", x.rangeBand())
+    .attr("y", function(d) { return y(d.count); })
+    .attr("height", function(d) { return height - y(d.count); })
+    .on('mouseover', tip.show)
+    .on('mouseout', tip.hide);

data/app/assets/stylesheets/audit_rails/audit_rails.css

@@ -1,3 +1,65 @@
 .left {
   float: left;
 }
+.audit-row{
+  width: 60%;
+  border-radius: 15px;
+}
+.clear{
+  clear: both;
+}
+.axis path,
+.axis line {
+  fill: none;
+  stroke: #000;
+  shape-rendering: crispEdges;
+}
+
+.bar {
+  fill: orange;
+}
+
+.bar:hover {
+  fill: orangered ;
+}
+
+.line {
+  fill: white;
+  border-color: orange;
+}
+.line:hover {
+  border-color: orangered;
+}
+
+.x.axis path {
+  /*display: none;*/
+}
+
+.d3-tip {
+  line-height: 1;
+  font-weight: bold;
+  padding: 12px;
+  background: rgba(0, 0, 0, 0.8);
+  color: #fff;
+  border-radius: 2px;
+}
+
+/* Creates a small triangle extender for the tooltip */
+.d3-tip:after {
+  box-sizing: border-box;
+  display: inline;
+  font-size: 10px;
+  width: 100%;
+  line-height: 1;
+  color: rgba(0, 0, 0, 0.8);
+  content: "\25BC";
+  position: absolute;
+  text-align: center;
+}
+
+/* Style northward tooltips differently */
+.d3-tip.n:after {
+  margin: -1px 0 0 0;
+  top: 100%;
+  left: 0;
+}

data/app/controllers/audit_rails/audits_controller.rb

@@ -2,16 +2,14 @@ require_dependency "audit_rails/application_controller"
 
 module AuditRails
   class AuditsController < ApplicationController
+    before_filter :apply_filter, except: [:create]
 
     def index
-      @audits = AuditRails::Audit.reverse_chronological
-      
-      respond_to do |format|
-        format.html # index.html.erb
-        format.json { render json: @audits }
-        format.xls { send_data @audits.to_xls(:columns => [:user_name, :action, :description, :created_at], 
-          :headers => ['User name', 'Action', 'Details', 'When?']), filename: 'audits.xls'}
+      find_all_audits
 
+      if params[:commit] == "Download Filtered Report"
+        send_data(@audits.to_xls(:columns => [:user_name, :action, :description, :created_at], 
+                  :headers => ['User name', 'Action', 'Details', 'When?']), filename: 'audits.xls') and return
       end
     end
 
@@ -21,12 +19,27 @@ module AuditRails
     end
 
     def analytics
-      @range_begin = params[:analytics] ? params[:analytics][:range_begin] : nil
-      @range_end   = params[:analytics] ? params[:analytics][:range_end] : nil
       @analysis_by_user_name  = AuditRails::Audit.in_range(@range_begin, @range_end).analysis_by_user_name
       @analysis_by_page_views = AuditRails::Audit.in_range(@range_begin, @range_end).analysis_by_page_views
       @total = AuditRails::Audit.in_range(@range_begin, @range_end).count
       @no_audits = AuditRails::Audit.count == 0
+
+      if params[:commit] == "Download Filtered Report"
+        find_all_audits
+        send_data(@audits.to_xls(:columns => [:user_name, :action, :description, :created_at], 
+                  :headers => ['User name', 'Action', 'Details', 'When?']), filename: 'audits.xls') and return
+      end
+    end
+
+    private
+
+    def apply_filter
+      @range_begin = params[:analytics] ? params[:analytics][:range_begin] : nil
+      @range_end   = params[:analytics] ? params[:analytics][:range_end] : nil
+    end
+
+    def find_all_audits
+      @audits = AuditRails::Audit.reverse_chronological.in_range(@range_begin, @range_end)
     end
   end
 end

data/app/helpers/audit_rails/audits_helper.rb

@@ -3,13 +3,18 @@ module AuditRails
     def add_to_audit(action_name=nil, controller_name=nil, user_name=nil, description=nil)
       if action_name == "login"
         if AuditRails::Audit.no_audit_entry_for_today?(action_name, user_name)
-          AuditRails::Audit.create(action: action_name, controller: controller_name, user_name: user_name, description: description)
+          AuditRails::Audit.create(action: action_name, 
+            controller: controller_name || request.params[:controller], 
+            user_name: user_name, 
+            description: description,
+            ip_address: request.remote_ip.to_s)
         end
       else
         AuditRails::Audit.create(action: action_name || request.params[:action],
           controller: controller_name || request.params[:controller],
           user_name: user_name, 
-          description: description)
+          description: description,
+          ip_address: request.remote_ip.to_s)
       end
     end
 

data/app/models/audit_rails/audit.rb

@@ -5,7 +5,7 @@ module AuditRails
     end
 
     if needs_attr_accessible?
-      attr_accessible :action, :controller, :description, :user_name
+      attr_accessible :action, :controller, :description, :user_name, :ip_address
     end
 
     # Supports both string and date format of range given
@@ -19,6 +19,7 @@ module AuditRails
     scope :reverse_chronological, ->{order('created_at DESC')}
     scope :group_by_controller_action, ->{group([:controller, :action])}
     scope :group_by_user_name, ->{group('user_name')}
+    scope :group_by_ip_address, ->{group('ip_address')}
 
     def self.no_audit_entry_for_today?(action_name, user_name)
       audits = where(action: action_name, user_name: user_name, 
@@ -28,11 +29,19 @@ module AuditRails
     end
 
     def self.analysis_by_user_name
-      group_by_user_name.count
+      group_by_user_name.count.map{|k,v| {'user' => k, 'count' => v}}.to_json
     end
 
     def self.analysis_by_page_views
-      group_by_controller_action.count
+      group_by_controller_action.count.map{|k,v| {'page' => k.join('/'), 'count' => v}}.to_json
+    end
+
+    def self.unique_visitor_count
+      group_by_ip_address.count.values.size
+    end
+
+    def self.visitor_count
+      group_by_ip_address.count.values.sum
     end
   end
 end

data/app/views/audit_rails/audits/_form.html.erb

@@ -1,10 +1,5 @@
-<div>
-  <%= form_tag(analytics_audits_path) do %>
-    Begin:
-    <%= text_field_tag('analytics[range_begin]', @range_begin)%>
-    &nbsp;&nbsp;&nbsp;&nbsp;
-    End:
-    <%= text_field_tag('analytics[range_end]', @range_end)%>
-    <%= submit_tag('filter')%>
+<div class='row'>
+  <%= form_tag(path, method: :get) do %>
+    <%= render partial: 'form_elements' %>
   <% end %>
 </div>

data/app/views/audit_rails/audits/_form_elements.html.erb

@@ -0,0 +1,20 @@
+<div class='col-sm-2'>
+  <div class="input-group">
+    <%= text_field_tag('analytics[range_begin]', @range_begin, placeholder: 'Begin', class: 'form-control')%>
+  </div>
+</div>
+<div class='col-sm-2'>
+  <div class="input-group">
+    <%= text_field_tag('analytics[range_end]', @range_end, placeholder: 'End', class: 'form-control')%>
+  </div>
+</div>
+<div class='col-sm-1'>
+  <div class="input-group">
+    <%= submit_tag('Filter', class: 'btn btn-primary btn-sm')%>
+  </div>
+</div>
+<div class='col-sm-2'>
+  <div class="input-group">
+    <%= submit_tag('Download Filtered Report',  class: 'btn btn-primary btn-sm')  %>
+  </div>
+</div>

data/app/views/audit_rails/audits/_list.html.erb

@@ -0,0 +1,12 @@
+<% audits.each do |audit| %>
+  <div class='audit-row well'>
+    <div class='audit-title'>
+     <%= "#{audit.controller}/" if audit.controller %><%= audit.action %> by <%= audit.user_name %> about <%= distance_of_time_in_words(audit.created_at, Time.now) %> ago
+   </div>
+   <% if audit.description %>
+     <div class='audit-description'>
+      <%= audit.description %>
+     </div>
+  <% end %>
+  </div>
+<% end %>

data/app/views/audit_rails/audits/_page_views.html.erb

@@ -1,24 +1,11 @@
+<div class='clear'></div>
 <div class='left'>
-  <div id='analyticsByPage'>Total page views: <%= @total %></div>
+  <ul class="nav nav-pills">
+    <li class="active">
+      <a href="#">Total page views <span class="badge"><%= @total %></span></a>
+    </li>
+  </ul>
   <br/>
-  <canvas id="pageViews" height="300" width="400"></canvas>
-  <script>
+  <div id='pageViewsCount' data-visit-count='<%= @analysis_by_page_views %>'></div>
 
-    var lineChartData = {
-      labels : <%= "#{@analysis_by_page_views.keys}".html_safe %>,
-      datasets : [
-        {
-          fillColor : "rgba(151,187,205,0.5)",
-          strokeColor : "rgba(220,220,220,1)",
-          pointColor : "rgba(220,220,220,1)",
-          pointStrokeColor : "#fff",
-          data : <%= @analysis_by_page_views.values %>
-        }
-      ]
-      
-    }
-
-  var myLine = new Chart(document.getElementById("pageViews").getContext("2d")).Line(lineChartData, {scaleLineWidth : 2, scaleLineColor : "rgba(0,0,0,.1)", scaleSteps : <%= @analysis_by_user_name.values.max/5 + 2%>});
-  
-  </script>
 </div>

data/app/views/audit_rails/audits/_user_clicks.html.erb

@@ -1,24 +1,9 @@
 <div class='left'>
-  <div id='analyticsByUser'>Total user clicks : <%= @total %></div>
+  <ul class="nav nav-pills">
+    <li class="active">
+      <a href="#">Total user clicks <span class="badge"><%= @total %></span></a>
+    </li>
+  </ul>
   <br/>
-  <canvas id="userViews" height="300" width="400"></canvas>
-  <script>
-
-    var barChartData = {
-      labels : <%= "#{@analysis_by_user_name.keys}".html_safe %>,
-      datasets : [
-        {
-          fillColor : "rgba(151,187,205,0.5)",
-          strokeColor : "rgba(220,220,220,1)",
-          pointColor : "rgba(220,220,220,1)",
-          pointStrokeColor : "#fff",
-          data : <%= @analysis_by_user_name.values %>
-        }
-      ]
-      
-    }
-
-  var myBar = new Chart(document.getElementById("userViews").getContext("2d")).Bar(barChartData, {scaleLineWidth : 2, scaleLineColor : "rgba(0,0,0,.1)", scaleSteps : <%= @analysis_by_user_name.values.max/5 + 2%>});
-
-  </script>
+  <div id='userViewsCount' data-visit-count='<%= @analysis_by_user_name %>'></div>
 </div>

data/app/views/audit_rails/audits/analytics.html.erb

@@ -2,7 +2,7 @@
   <h1>Analytics</h1>
 </div>
 
-<%= render partial: 'form' %>
+<%= render partial: 'form', locals: {path: audit_rails.analytics_audits_path} %>
 <br/>
 <br/>
 <% if @analysis_by_user_name == {} %>