kanaui 0.5.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b509920c148aef35ccf0bffbe38b935b669a35ff
-  data.tar.gz: e5d121e521e55c1c3f882f7f0bbfd576c961a7e9
+  metadata.gz: c634cb242e7d9aef0a4bb937451a57c3f10f0c90
+  data.tar.gz: '08e4e1e1419a230305488420fa8f2f8b69de57a4'
 SHA512:
-  metadata.gz: e8ebbb2db468390719e6c125880f483382f2cfd61ca4256128409c7dfa89aa11b367d3f6b5bdc039897c81de3fd627007348ff2c86e82096e94392c4c7f47b4d
-  data.tar.gz: bc6c3397d0fa1f6192f81cf85c199934126c4a42283791ec8e6ec7b0b8e31dc7678804dc5c288474713f22a9ccad7dac089967a2a6fed42440b5edb83956bc81
+  metadata.gz: 4e4bd12458f02a2beeddd6b111e89460245bcc24c8d65be1debd3b261eb88dc55ce6a139e7e550e5110c59cc8d63b287805ec47d74ad803849560b97e55a2eb2
+  data.tar.gz: a3d7284429507ddc4b465613407b30ccd3ed118f31b834a7db4846ff1a7b9b416e89f9526e5c2f38a4ee4ed28651f3b3d9d6fe4aa8121a9d2534b18cfe1ae68e

data/README.md

@@ -12,7 +12,10 @@ Kill Bill compatibility
 | Kanaui version | Kill Bill version |
 | -------------: | ----------------: |
 | 0.4.y          | 0.16.z            |
-| 0.5.y          | 0.18.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
 ===============
@@ -34,15 +37,18 @@ KillBillClient.api_key = 'bob'
 KillBillClient.api_secret = 'lazar'
 ```
 
-Running Kanaui
---------------
+Testing
+-------
 
-You can run Kanaui locally by using the test/dummy app provided:
+To run the dummy app:
 
 ```
-bundle install
-cd test/dummy
-export RAILS_ENV=development
-bundle install
-rails server
+rails s
+```
+
+
+To run tests:
+
+```
+rails t
 ```

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

@@ -6,13 +6,13 @@
 //
 //= require js-routes
 //= require log4javascript
-//= require moment
 //= require spin
 //= require jquery
 //= require jquery_ujs
 //= 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,8 @@
  *= 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/bootstrap_and_overrides.css

@@ -1,9 +1,5 @@
 /*
  *= require twitter-bootstrap-static/bootstrap
- *
- * Use Font Awesome icons (default)
- * To use Glyphicons sprites instead of Font Awesome, replace with "require twitter-bootstrap-static/sprites"
- *= require twitter-bootstrap-static/fontawesome
 */
 
 /* Override Bootstrap 3 font locations */

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,25 +21,34 @@ 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]
-        redirect_to dashboard_index_path(:start_date => @start_date,
-                                         :end_date => @end_date,
-                                         :name => name,
-                                         :smooth => params[:smooth],
-                                         :sql_only => params[:sql_only],
-                                         :format => params[:format]) and return
+        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?
+        query_params[:type] = params[:type] unless params[:type].blank?
+
+        redirect_to dashboard_index_path(query_params) and return
       end
 
-      render
+      params.permit!
     end
 
     # 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
@@ -57,7 +67,7 @@ module Kanaui
       else
         reports = raw_reports
       end
-      render :json => reports
+      render json: reports
     end
 
     private
@@ -108,6 +118,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
@@ -115,7 +126,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