kanaui 0.6.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44408c840e86c3b09c99de32d8562b6f6cb11f8b
-  data.tar.gz: b4c65299ff506937976f193d337701969e0cba65
+  metadata.gz: b97ea14f934efc662bd48c78371bb3bbaf57a347
+  data.tar.gz: e3b86efa67ff817e61cd181654d92fa1ba1fad3d
 SHA512:
-  metadata.gz: a1fd5e4063dea83305ead4baa1e6b60d9c532d86a4518067c2a2995709fab84df428c266f0a2d5a96222f5729bc8d3f7336d9036046b8d222fc2e4bd0dcb6e7f
-  data.tar.gz: b62394e70ab37f0d418930846d288e8da1fec047dc9ad37a35cdaa0b5be8c9d6801aa54a84073e7c3d9ed8c131379e76265dc72ea2a972eb1f41e566559931ee
+  metadata.gz: 9bf5d0c1847d69ca090ea670cd9731ecaeac658bac5b5a2fd2cf7dea1a463a9fa138a5c32ffd8db01f5a69a3d50efedf1a492b4c9705cfe6bf13ab1e2831654f
+  data.tar.gz: 62cd8b7055b53dce95b8abfe0f309a7d4cd84cb9ed18da9bb700341c38191b743b80ae852feb2821954e2aae26675fbefec4192a72d41371de01e90e4f982774

data/README.md

@@ -14,6 +14,8 @@ Kill Bill compatibility
 | 0.4.y          | 0.16.z            |
 | 0.5.y          | 0.18.z (Rails 4)  |
 | 0.6.y          | 0.18.z (Rails 5)  |
+| 1.x.y          | 0.20.z            |
+| 2.x.y          | 0.22.z            |
 
 Getting Started
 ===============

data/Rakefile

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -20,11 +22,9 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
 load 'rails/tasks/engine.rake'
 
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -36,5 +36,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
-task :default => :test
+task default: :test

data/app/assets/javascripts/application.js

@@ -12,6 +12,7 @@
 //= require twitter/bootstrap
 //= require dataTables/jquery.dataTables
 //= require dataTables/bootstrap/3/jquery.dataTables.bootstrap
+//= require dataTables/extras/dataTables.colVis
 //= require d3
 //= require bootstrap-datepicker
 //= require jquery.spin

data/app/assets/javascripts/kanaui/kiddo/kiddo_initialize.js

@@ -8,7 +8,7 @@
       var renderer = new Kiddo.Renderer('#chartAnchor');
 
       if (error) {
-        console.log(error);
+        ajaxErrorAlert(error);
         return renderer.noData();
       }
 

data/app/assets/javascripts/kanaui/reports.dataTables.js

@@ -40,16 +40,88 @@ ReportsDataTables.prototype.buildTable = function(data, wrapper) {
     }
 
     var aoColumns = [];
+    var columnsVisible = [];
     for (var i in data['header']) {
-        aoColumns.push({ "sTitle": data['header'][i] })
+        var isVisible =  isColumnVisible(data['header'][i]);
+        aoColumns.push({ "sTitle": data['header'][i], "name": data['header'][i], "visible": isVisible })
+        if (isVisible) {
+            columnsVisible.push(data['header'][i]);
+        }
     }
 
     dataTable.dataTable({
         "aaData": aaData,
-        "aoColumns": aoColumns
+        "aoColumns": aoColumns,
+        "scrollX": true,
+        "sDom": 'C<"clear">lfrtip'
     });
+
+    dataTable.on( 'column-visibility.dt', function ( e, settings, column, state ) {
+        setColumnVisible(settings.aoColumns[column].name, state);
+    });
+
+    $("#copy-url").click(function(e){
+        var pathPlusParams = $(this).data("reports-path");
+        var sPageURL = decodeURIComponent(pathPlusParams.substring(1)).split('?');
+        var params = sPageURL[1].split('&');
+
+        var columnsVisible = $("#visible-table-columns").val();
+        var placeholder = $("#url-placeholder");
+
+        var urlToShare = window.location.origin + "/" + sPageURL[0] + "?";
+        for (var i in params) {
+            var keyValue = params[i].split('=');
+            if (keyValue[0] == 'columns') {
+                continue;
+            }
+            urlToShare += "&" + params[i];
+        }
+
+        placeholder.val(urlToShare + "&columns=" + columnsVisible);
+        placeholder.removeClass("hidden");
+        placeholder.select();
+
+        document.execCommand("Copy");
+        placeholder.addClass("hidden");
+        alert("URL copied into the clipboard!")
+    });
+
+    $("#visible-table-columns").val(columnsVisible.join());
 }
 
 ReportsDataTables.prototype.buildCSVURL = function(position) {
     return this.reports.buildDataURL(position, 'csv');
 }
+function setColumnVisible(column, isVisible) {
+    var columnsVisible = $("#visible-table-columns").val();
+    if (columnsVisible == undefined || columnsVisible == null || columnsVisible.length == 0) {
+        columnsVisible = [];
+    } else {
+        columnsVisible = (columnsVisible).split(",");
+    }
+
+    var columnIndex = columnsVisible.indexOf(column);
+    if (isVisible && columnIndex == -1) {
+        columnsVisible.push(column);
+    } else if (!isVisible && columnIndex != -1) {
+        columnsVisible.splice(columnIndex, 1);
+    }
+
+    $("#visible-table-columns").val(columnsVisible.join());
+}
+
+function isColumnVisible(column) {
+    var columnsVisible = $("#visible-table-columns").val();
+    if ((columnsVisible == undefined || columnsVisible == null || columnsVisible.length == 0) && column != 'tenant_record_id') {
+        return true;
+    }
+    columnsVisible = (columnsVisible).split(",");
+
+    for (var i in columnsVisible) {
+        if (columnsVisible[i] == column) {
+            return true;
+        }
+    }
+
+    return false;
+}

data/app/assets/stylesheets/application.css

@@ -6,6 +6,7 @@
  *= require bootstrap-datepicker3
  *= require dataTables/jquery.dataTables
  *= require dataTables/bootstrap/3/jquery.dataTables.bootstrap
+ *= require dataTables/extras/dataTables.colVis
  *= require font-awesome
  *= require bootstrap_and_overrides
  *= require kanaui/kanaui

data/app/assets/stylesheets/kanaui/reports.css

@@ -1,5 +1,10 @@
-#date-picker {
-    margin-bottom: 20px;
+#reports-table th, #reports-table td,
+#dataTable-api_wrapper th, #dataTable-api_wrapper td {
+    white-space: nowrap;
+}
+
+.sql-query {
+    word-break: break-word;
 }
 
 .axis path,
@@ -92,3 +97,62 @@
 .grid path{
   stroke-width: 0;
 }
+
+button.ColVis_Button, button.ColVis_Button:hover {
+    background: inherit;
+    box-shadow: unset;
+    text-transform: none;
+    color: #333 !important;
+    border-color: #adadad;
+}
+
+ul.ColVis_collection {
+    background-color: #f3f3f3;
+}
+
+ul.ColVis_collection li, ul.ColVis_collection li:hover{
+    border: none;
+    box-shadow: unset;
+    background: transparent;
+}
+
+button.ColVis_Button:hover, ul.ColVis_collection li:hover {
+    background-color: #e6e6e6;
+    border-color: #adadad;
+}
+
+.dataTables_wrapper .dataTables_paginate .paginate_button {
+    padding: 0.25em 0.5em;
+}
+
+.flex-panel {
+    display: -webkit-flex;
+    display: flex;
+    -webkit-flex-direction: row;
+    flex-direction: row;
+}
+
+.flex-inner-left-panel {
+    -ms-flex: 1 .5 0%;
+    -webkit-flex: 1 .5 0%;
+    flex: 1 .5 0%;
+}
+
+.flex-inner-left-panel ul li {
+    white-space: nowrap;
+}
+
+.flex-inner-right-panel {
+    -ms-flex: .5 1 70%;
+    -webkit-flex: .5 1 70%;
+    flex: .5 1 70%;
+    overflow: scroll;
+}
+
+#date-picker .form-group {
+    height: 34px;
+}
+
+#table-tools {
+    padding-bottom: 10px;
+}

data/app/controllers/kanaui/dashboard_controller.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Kanaui
   class DashboardController < Kanaui::EngineController
-
     #
     # Load the dashboard by rendering the view and executing the javascript that will call
     # the reports and available_reports endpoints below.
@@ -20,16 +21,19 @@ module Kanaui
 
       query = build_slice_and_dice_query
 
+      # get columns visibility from query parameters to be used by tables
+      @visible_columns = params[:columns]
+
       # Redirect also in case the dates have been updated to avoid any confusion in the view
       if query.present? || params[:start_date].blank? || params[:end_date].blank?
-        # TODO Make metrics configurable
+        # TODO: Make metrics configurable
         name = query.present? ? "#{params[:name]}#{query}^metric:count" : params[:name]
-        query_params = {:start_date => @start_date,
-                        :end_date => @end_date,
-                        :name => name,
-                        :smooth => params[:smooth],
-                        :sql_only => params[:sql_only],
-                        :format => params[:format]}
+        query_params = { start_date: @start_date,
+                         end_date: @end_date,
+                         name: name,
+                         smooth: params[:smooth],
+                         sql_only: params[:sql_only],
+                         format: params[:format] }
 
         # Test only
         query_params[:fake] = params[:fake] unless params[:fake].blank?
@@ -44,7 +48,7 @@ module Kanaui
     # Not used anymore as reports are pulled from index
     def available_reports
       available_reports = Kanaui::DashboardHelper::DashboardApi.available_reports(options_for_klient)
-      render :json => available_reports
+      render json: available_reports
     end
 
     def reports
@@ -63,7 +67,18 @@ module Kanaui
       else
         reports = raw_reports
       end
-      render :json => reports
+      respond_to do |fmt|
+        fmt.csv do
+          filename = params[:name]
+          unless params[:start_date].blank?
+            filename += "_#{params[:start_date]}"
+            filename += "-#{params[:end_date]}" unless params[:end_date].blank?
+          end
+          filename += '.csv'
+          send_data(raw_reports, filename: filename)
+        end
+        fmt.all { render json: reports }
+      end
     end
 
     private
@@ -114,6 +129,7 @@ module Kanaui
       filter_query = ''
       filters.each do |k, v|
         next if v.blank?
+
         filter_query << '%26' unless filter_query.blank?
         filter_query << "(#{k}=#{v.join("|#{k}=")})"
       end
@@ -121,7 +137,8 @@ module Kanaui
 
       groups.each do |k, v|
         next if v.blank?
-        # TODO Make "no other" configurable
+
+        # TODO: Make "no other" configurable
         query << "^dimension:#{k}(#{v.join('|')}|-)"
       end
 

data/app/controllers/kanaui/engine_controller.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Kanaui
   class EngineController < ApplicationController
-
     layout :get_layout
 
     def get_layout
@@ -17,12 +18,46 @@ module Kanaui
     def options_for_klient
       user = current_tenant_user
       {
-          :username => user[:username],
-          :password => user[:password],
-          :session_id => user[:session_id],
-          :api_key => user[:api_key],
-          :api_secret => user[:api_secret]
+        username: user[:username],
+        password: user[:password],
+        session_id: user[:session_id],
+        api_key: user[:api_key],
+        api_secret: user[:api_secret]
       }
     end
+
+    rescue_from(KillBillClient::API::ResponseError) do |killbill_exception|
+      flash[:error] = "Error while communicating with the Kill Bill server: #{as_string(killbill_exception)}"
+      redirect_to dashboard_index_path
+    end
+
+    def as_string(e)
+      if e.is_a?(KillBillClient::API::ResponseError)
+        "Error #{e.response.code}: #{as_string_from_response(e.response.body)}"
+      else
+        log_rescue_error(e)
+        e.message
+      end
+    end
+
+    def log_rescue_error(error)
+      Rails.logger.warn "#{error.class} #{error}. #{error.backtrace.join("\n")}"
+    end
+
+    def as_string_from_response(response)
+      error_message = response
+      begin
+        # BillingExceptionJson?
+        error_message = JSON.parse response
+      rescue StandardError => _e
+      end
+
+      if error_message.respond_to?(:[]) && error_message['message'].present?
+        # Likely BillingExceptionJson
+        error_message = error_message['message']
+      end
+      # Limit the error size to avoid ActionDispatch::Cookies::CookieOverflow
+      error_message[0..1000]
+    end
   end
 end

data/app/controllers/kanaui/reports_controller.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Kanaui
   class ReportsController < Kanaui::EngineController
-
     def index
       @reports = JSON.parse(Kanaui::DashboardHelper::DashboardApi.available_reports(options_for_klient)).map(&:deep_symbolize_keys)
     end
@@ -13,7 +14,7 @@ module Kanaui
       Kanaui::DashboardHelper::DashboardApi.create_report(report_from_params.to_json, options_for_klient)
 
       flash[:notice] = 'Report successfully created'
-      redirect_to :action => :index
+      redirect_to action: :index
     end
 
     def edit
@@ -26,34 +27,36 @@ module Kanaui
       Kanaui::DashboardHelper::DashboardApi.update_report(params.require(:id), report_from_params.to_json, options_for_klient)
 
       flash[:notice] = 'Report successfully updated'
-      redirect_to :action => :index
+      redirect_to action: :index
     end
 
     def refresh
       Kanaui::DashboardHelper::DashboardApi.refresh_report(params.require(:id), options_for_klient)
 
       flash[:notice] = 'Report refresh successfully scheduled'
-      redirect_to :action => :index
+      redirect_to action: :index
     end
 
     def destroy
       Kanaui::DashboardHelper::DashboardApi.delete_report(params.require(:id), options_for_klient)
 
       flash[:notice] = 'Report successfully deleted'
-      redirect_to :action => :index
+      redirect_to action: :index
     end
 
     private
 
     def report_from_params
       {
-          :reportName => params[:report_name],
-          :reportPrettyName => params[:report_pretty_name],
-          :reportType => params[:report_type],
-          :sourceTableName => params[:source_table_name],
-          :refreshProcedureName => params[:refresh_procedure_name],
-          :refreshFrequency => params[:refresh_frequency],
-          :refreshHourOfDayGmt => params[:refresh_hour_of_day_gmt]
+        reportName: params[:report_name],
+        reportPrettyName: params[:report_pretty_name],
+        reportType: params[:report_type],
+        sourceTableName: params[:source_table_name],
+        sourceName: params[:source_name],
+        sourceQuery: params[:source_query],
+        refreshProcedureName: params[:refresh_procedure_name],
+        refreshFrequency: params[:refresh_frequency].presence,
+        refreshHourOfDayGmt: params[:refresh_hour_of_day_gmt]
       }
     end
   end