rails_admin_mydash 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b67b99bbf01affa133bba7810b3acf636cf4bd31
-  data.tar.gz: a6a54c5e092385610db8b80e610f5d7d8b59617f
+  metadata.gz: d4e2fbef2752b495ea75283d3859c5cd1d559034
+  data.tar.gz: 6c0aed6ea36fdb41af371cd7acab87cb281f52a6
 SHA512:
-  metadata.gz: 919e091bf8e8e5cddc4eb636ae0ef4b1837a4e6043dcc9c5433b8353ca84f55b748ba246dac749c2bf2bdeae23f7b857e5ab0895a17a2208ab2fb752cdcb5214
-  data.tar.gz: 06012d90886d783d6a0e7ae24411849063c74d9a5a82691667508caba30242430c7e24b9de60441506448a133cba5f13b933fa2c1158c1531baf324e43a6d593
+  metadata.gz: e2a971bb5a0fda8ba30d76f6bc0e6ab9653d41e97a9eb202ebb6fb19d14f586e3f6f995ec23f24b8c9521af92f0eee226aa71113e1f06f81f85bc5ed30fb1711
+  data.tar.gz: ec4b39eba036a12f63c1f932bc1b03ab7405703e26023e740e8bf96ce4a589c3a0b228fbc9915a3d3799ea988631699c15cc50013116c52bef1aa3d1bb413c09

data/README.md

@@ -4,15 +4,17 @@ A rails_admin alternative dashboard. It overrides the default dashboard componen
 
 Features:
 
-- show the last 3 records for each model (useful to reach the last items easily)
+- last 3 records for each model (useful to reach the last items easily)
 
-- show optionally admin notices (to show informations to the users)
+- Google Analytics data if enabled
 
-- show auditing / history table if enabled
+- admin notices if enabled (to show informations to the users)
 
-- hid breadcrump and nav tabs on the dashboard
+- auditing / history table if enabled
 
-- disable counters progress bars (minor performance improvement)
+- no breadcrump and nav tabs on the dashboard
+
+- no counters progress bars (minor performance improvement)
 
 ## Installation
 
@@ -20,6 +22,35 @@ Features:
 
 - Execute `bundle`
 
+## Google Analytics
+
+- To enable Google Analytics follow this guide: [Google Analytics Embed API](https://developers.google.com/analytics/devguides/reporting/embed/v1/getting-started)
+
+- Set the options in rails_admin config:
+
+```ruby
+# In config.actions block:
+dashboard do
+  ga_key 'XXX.apps.googleusercontent.com'
+  ga_chart_id 'ga:YYYYYYYYY'
+  ga_start_date '60daysAgo'
+  ga_end_date '30daysAgo'
+  ga_metrics 'ga:sessions,ga:pageviews'
+end
+```
+
+Options:
+
+- ga_key: required - CLIENT_ID parameter (obtained from [Google API Client Libraries](https://developers.google.com/api-client-library/javascript/start/start-js#Setup) - [ID client OAuth 2.0](https://console.developers.google.com/apis/credentials))
+
+- ga_chart_id: optional - chart to show, if not specified the selector is shown
+
+- ga_start_date: optional - starting date, default: '30daysAgo'
+
+- ga_end_date: optional - ending date, default: 'yesterday'
+
+- ga_metrics: optional - type of data to show, default: 'ga:sessions'
+
 ## Admin notices
 
 - Create and apply a migration:

data/app/views/rails_admin/main/_analytics_embed.html.haml

@@ -0,0 +1,78 @@
+:css
+  #ga-auth-button { color: #888; font-style: italic; text-align: center; }
+  #ga-timeline { overflow-x: scroll; }
+  #ga-timeline .gapi-analytics-data-chart > div > div { margin: 0 auto; }
+  #ga-view-selector table { margin: 5px auto 0 auto; }
+
+.panel.panel-info
+  .panel-heading
+    %h3.panel-title= t 'admin.dashboard.google_analytics'
+  .panel-body
+    %section#ga-auth-button
+    %section#ga-view-selector
+    %section#ga-timeline
+
+:javascript
+  var gapi_init = false;
+  if( !$('#gapi-script').length ) {
+    // Include once
+    (function(w,d,s,g,js,fjs){
+      g=w.gapi||(w.gapi={});g.analytics={q:[],ready:function(cb){this.q.push(cb)}};
+      js=d.createElement(s);fjs=d.getElementsByTagName(s)[0];
+      js.id='gapi-script';
+      js.src='https://apis.google.com/js/platform.js';
+      fjs.parentNode.insertBefore(js,fjs);js.onload=function(){g.load('analytics')};
+    }(window,document,'script'));
+    gapi_init = true; 
+  }
+
+:javascript
+  var timeline;
+  var ga_chart_id = '#{@action.ga_chart_id}';
+  var ga_metrics = '#{@action.ga_metrics ? @action.ga_metrics : "ga:sessions"}';
+  var ga_start_date = '#{@action.ga_start_date ? @action.ga_start_date : "30daysAgo"}';
+  var ga_end_date = '#{@action.ga_end_date ? @action.ga_end_date : "yesterday"}';
+  var ga_client_id = '#{@action.ga_key}';
+  gapi.analytics.ready(function() {
+    // >> Create the view selector.
+    if( !ga_chart_id ) {
+      var viewSelector = new gapi.analytics.ViewSelector({
+        container: 'ga-view-selector'
+      });
+      viewSelector.on( 'change', function( ids ) {
+        // console.log( ids );
+        timeline.set( { query: { ids: ids } } ).execute();
+      });
+    }
+    // >> Create the timeline chart.
+    timeline = new gapi.analytics.googleCharts.DataChart({
+      reportType: 'ga',
+      query: {
+        'dimensions': 'ga:date',
+        'metrics': ga_metrics,
+        'start-date': ga_start_date,
+        'end-date': ga_end_date,
+      },
+      chart: {
+        type: 'LINE',
+        container: 'ga-timeline'
+      }
+    });
+    if( gapi_init ) {
+      // >> Authorize the user.
+      gapi.analytics.auth.authorize({
+        container: 'ga-auth-button',
+        clientid: ga_client_id,
+      });
+      // >> Hook up the components to work together.
+      gapi.analytics.auth.on('success', function(response) {
+        if( ga_chart_id ) timeline.set( { query: { ids: ga_chart_id } } ).execute();
+        else viewSelector.execute();
+        $('#ga-auth-button').fadeOut( 500 );
+      });
+    }
+    else {
+      if( ga_chart_id ) timeline.set( { query: { ids: ga_chart_id } } ).execute();
+      else viewSelector.execute();
+    }
+  });

data/app/views/rails_admin/main/dashboard.html.haml

@@ -4,42 +4,50 @@
   td.c2 { text-align: center; }
 
 %div#mydash
-  - if @admin_notices
+  .row
+    - if @action.ga_key
+      %div{class:@action.ga_key ? 'col-md-7' : 'col-md-12'}
+        = render partial: 'analytics_embed'
+    - if @admin_notices && @admin_notices.any?
+      %div{class:@action.ga_key ? 'col-md-5' : 'col-md-12'}
+        %div.panel.panel-info
+          %div.panel-heading
+            %h3.panel-title= t 'admin.dashboard.notices'
+          / %div.panel-body
+          %table.table
+            - @admin_notices.each do |notice|
+              %tr
+                %td= notice.message
+  - if @abstract_models
     %div.panel.panel-info
       %div.panel-heading
-        %h3.panel-title= t 'admin.dashboard.notices'
-      / %div.panel-body
-      %table.table
-        - @admin_notices.each do |notice|
+        %h3.panel-title= t 'admin.dashboard.records'
+      %table.table.table-condensed.table-striped.dashboard-table
+        %thead
           %tr
-            %td= notice.message
-  - if @abstract_models
-    %table.table.table-condensed.table-striped.dashboard-table
-      %thead
-        %tr
-          %th.shrink.model-name= t 'admin.table_headers.model_name'
-          %th.shrink.records= t 'admin.table_headers.records'
-          %th.last-records= t 'admin.table_headers.last_records'
-          %th.shrink.controls
-      %tbody
-        - @abstract_models.each do |abstract_model|
-          - if authorized? :index, abstract_model
-            - index_path = index_path(model_name: abstract_model.to_param)
-            - row_class = "#{cycle("odd", "even")}#{" link" if index_path} #{abstract_model.param_key}_links"
-            %tr{class: row_class, :"data-link" => index_path}
-              %td.c1
-                %span.show= link_to capitalize_first_letter(abstract_model.config.label_plural), index_path, class: 'pjax'
-              %td.c2
-                - if @count[abstract_model.model.name]
-                  = @count[abstract_model.model.name]
-              %td.c3
-                - if @last_rows[abstract_model.model.name]
-                  %div.last-records-list
-                    - @last_rows[abstract_model.model.name].each do |row|
-                      - if row.respond_to?( :name ) && ( show_action = action(:show, abstract_model, row) )
-                        %div.last-records-item= link_to(row.name, url_for(action: show_action.action_name, model_name: abstract_model.to_param, id: row.id), class: 'pjax')
-              %td.c4.links
-                %ul.inline.list-inline= menu_for :collection, abstract_model, nil, true
+            %th.shrink.model-name= t 'admin.table_headers.model_name'
+            %th.shrink.records= t 'admin.table_headers.records'
+            %th.last-records= t 'admin.table_headers.last_records'
+            %th.shrink.controls
+        %tbody
+          - @abstract_models.each do |abstract_model|
+            - if authorized? :index, abstract_model
+              - index_path = index_path(model_name: abstract_model.to_param)
+              - row_class = "#{cycle("odd", "even")}#{" link" if index_path} #{abstract_model.param_key}_links"
+              %tr{class: row_class, :"data-link" => index_path}
+                %td.c1
+                  %span.show= link_to capitalize_first_letter(abstract_model.config.label_plural), index_path, class: 'pjax'
+                %td.c2
+                  - if @count[abstract_model.model.name]
+                    = @count[abstract_model.model.name]
+                %td.c3
+                  - if @last_rows[abstract_model.model.name]
+                    %div.last-records-list
+                      - @last_rows[abstract_model.model.name].each do |row|
+                        - if row.respond_to?( :name ) && ( show_action = action(:show, abstract_model, row) )
+                          %div.last-records-item= link_to(row.name, url_for(action: show_action.action_name, model_name: abstract_model.to_param, id: row.id), class: 'pjax')
+                %td.c4.links
+                  %ul.inline.list-inline= menu_for :collection, abstract_model, nil, true
   - if @auditing_adapter && authorized?(:history_index)
     #block-tables.block
       .content

data/lib/rails_admin_mydash/config/actions/dashboard.rb

@@ -48,6 +48,26 @@ RailsAdmin::Config::Actions::Dashboard.class_eval do
     false
   end
 
+  register_instance_option :ga_chart_id do
+    nil
+  end
+
+  register_instance_option :ga_end_date do
+    'yesterday'
+  end
+
+  register_instance_option :ga_key do
+    nil
+  end
+
+  register_instance_option :ga_metrics do
+    'ga:sessions'
+  end
+
+  register_instance_option :ga_start_date do
+    '30daysAgo'
+  end
+
   register_instance_option :last_records do
     3
   end

data/lib/rails_admin_mydash/version.rb

@@ -1,3 +1,3 @@
 module RailsAdminMydash
-  VERSION = '0.1.6'
+  VERSION = '0.1.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_admin_mydash
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-01 00:00:00.000000000 Z
+date: 2017-02-05 00:00:00.000000000 Z
 dependencies: []
 description: An alternative dashboard for rails_admin
 email:
@@ -20,6 +20,7 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/views/rails_admin/main/_analytics_embed.html.haml
 - app/views/rails_admin/main/_mydashboard_history.html.haml
 - app/views/rails_admin/main/dashboard.html.haml
 - lib/rails_admin_mydash.rb