kaui 3.0.2 → 3.0.4

data/app/controllers/kaui/invoices_controller.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'csv'
 module Kaui
   class InvoicesController < Kaui::EngineController
     def index
@@ -12,6 +13,37 @@ module Kaui
       @max_nb_records = @search_query.blank? ? Kaui::Invoice.list_or_search(nil, 0, 0, options_for_klient).pagination_max_nb_records : 0
     end
 
+    def download
+      account_id = params[:account_id]
+      start_date = params[:startDate]
+      end_date = params[:endDate]
+      all_fields_checked = params[:allFieldsChecked] == 'true'
+      columns = if all_fields_checked
+                  KillBillClient::Model::InvoiceAttributes.instance_variable_get('@json_attributes') - Kaui::Invoice::TABLE_IGNORE_COLUMNS
+                else
+                  params.require(:columnsString).split(',').map { |attr| attr.split.join('_').downcase }
+                end
+
+      kb_params = {}
+      kb_params[:startDate] = Date.parse(start_date).strftime('%Y-%m-%d') if start_date
+      kb_params[:endDate] = Date.parse(end_date).strftime('%Y-%m-%d') if end_date
+      if account_id.present?
+        account = Kaui::Account.find_by_id_or_key(account_id, false, false, options_for_klient)
+        invoices = account.invoices(options_for_klient.merge(params: kb_params))
+      else
+        invoices = Kaui::Invoice.list_or_search(nil, 0, MAXIMUM_NUMBER_OF_RECORDS_DOWNLOAD, options_for_klient.merge(params: kb_params))
+      end
+
+      csv_string = CSV.generate(headers: true) do |csv|
+        csv << columns
+
+        invoices.each do |invoice|
+          csv << columns.map { |attr| invoice&.send(attr.downcase) }
+        end
+      end
+      send_data csv_string, filename: "invoices-#{Date.today}.csv", type: 'text/csv'
+    end
+
     def pagination
       cached_options_for_klient = options_for_klient
 
@@ -24,39 +56,32 @@ module Kaui
         if account.nil?
           Kaui::Invoice.list_or_search(search_key, offset, limit, cached_options_for_klient)
         else
-          account.invoices(cached_options_for_klient.merge({ params: { includeVoidedInvoices: true } })).map! { |invoice| Kaui::Invoice.build_from_raw_invoice(invoice) }
+          Kaui::Account.paginated_invoices(search_key, offset, limit, 'NONE', cached_options_for_klient).map! { |invoice| Kaui::Invoice.build_from_raw_invoice(invoice) }
         end
       end
 
       account_id = (params[:search] || {})[:value]
-      if account_id.blank?
-        # Don't show amount and balance, and they will not be populated
-        data_extractor = lambda do |invoice, column|
-          [
-            invoice.invoice_number.to_i,
-            invoice.invoice_date
-          ][column]
-        end
-        formatter = lambda do |invoice|
-          row = [view_context.link_to(invoice.invoice_number, view_context.url_for(controller: :invoices, action: :show, account_id: invoice.account_id, id: invoice.invoice_id))]
-          row += Kaui.invoice_search_columns.call(invoice, view_context, cached_options_for_klient)[1]
-          row
-        end
-      else
-        data_extractor = lambda do |invoice, column|
-          [
-            invoice.invoice_number.to_i,
-            invoice.invoice_date,
-            invoice.amount,
-            invoice.balance,
-            invoice.status
-          ][column]
-        end
-        formatter = lambda do |invoice|
-          row = [view_context.link_to(invoice.invoice_number, view_context.url_for(controller: :invoices, action: :show, account_id: invoice.account_id, id: invoice.invoice_id))]
-          row += Kaui.account_invoices_columns.call(invoice, view_context)[1]
-          row
-        end
+      data_extractor = if account_id.blank?
+                         lambda do |invoice, column|
+                           [
+                             invoice.invoice_number.to_i,
+                             invoice.invoice_date
+                           ][column]
+                         end
+                       else
+                         lambda do |invoice, column|
+                           [
+                             invoice.invoice_number.to_i,
+                             invoice.invoice_date,
+                             invoice.amount,
+                             invoice.balance,
+                             invoice.status
+                           ][column]
+                         end
+                       end
+
+      formatter = lambda do |invoice|
+        Kaui.account_invoices_columns.call(invoice, view_context)[1]
       end
 
       paginate searcher, data_extractor, formatter
@@ -67,7 +92,7 @@ module Kaui
       # Go to the database once
       cached_options_for_klient = options_for_klient
 
-      @invoice = Kaui::Invoice.find_by_id(params.require(:id), 'FULL', cached_options_for_klient)
+      @invoice = Kaui::Invoice.find_by_id(params.require(:id), false, 'FULL', cached_options_for_klient)
       # This will put the TAX items at the bottom
       precedence = {
         'EXTERNAL_CHARGE' => 0,
@@ -132,7 +157,7 @@ module Kaui
 
     def void_invoice
       cached_options_for_klient = options_for_klient
-      invoice = KillBillClient::Model::Invoice.find_by_id(params.require(:id), 'NONE', cached_options_for_klient)
+      invoice = KillBillClient::Model::Invoice.find_by_id(params.require(:id), false, 'NONE', cached_options_for_klient)
       begin
         invoice.void(current_user.kb_username, params[:reason], params[:comment], cached_options_for_klient)
         redirect_to account_invoice_path(invoice.account_id, invoice.invoice_id), notice: 'Invoice successfully voided'
@@ -143,12 +168,12 @@ module Kaui
     end
 
     def restful_show
-      invoice = Kaui::Invoice.find_by_id(params.require(:id), 'NONE', options_for_klient)
+      invoice = Kaui::Invoice.find_by_id(params.require(:id), false, 'NONE', options_for_klient)
       redirect_to account_invoice_path(invoice.account_id, invoice.invoice_id)
     end
 
     def restful_show_by_number
-      invoice = Kaui::Invoice.find_by_number(params.require(:number), 'NONE', options_for_klient)
+      invoice = Kaui::Invoice.find_by_number(params.require(:number), false, 'NONE', options_for_klient)
       redirect_to account_invoice_path(invoice.account_id, invoice.invoice_id)
     end
 
@@ -158,7 +183,7 @@ module Kaui
 
     def commit_invoice
       cached_options_for_klient = options_for_klient
-      invoice = KillBillClient::Model::Invoice.find_by_id(params.require(:id), 'NONE', cached_options_for_klient)
+      invoice = KillBillClient::Model::Invoice.find_by_id(params.require(:id), false, 'NONE', cached_options_for_klient)
       invoice.commit(current_user.kb_username, params[:reason], params[:comment], cached_options_for_klient)
       redirect_to account_invoice_path(invoice.account_id, invoice.invoice_id), notice: 'Invoice successfully committed'
     end

data/app/controllers/kaui/payment_methods_controller.rb

@@ -74,7 +74,7 @@ module Kaui
     def destroy
       payment_method_id = params[:id]
 
-      payment_method = Kaui::PaymentMethod.find_by_id(payment_method_id, false, options_for_klient)
+      payment_method = Kaui::PaymentMethod.find_by_id(payment_method_id, false, false, [], 'NONE', options_for_klient)
       begin
         Kaui::PaymentMethod.destroy(payment_method_id, params[:set_auto_pay_off], false, current_user.kb_username, params[:reason], params[:comment], options_for_klient)
         redirect_to kaui_engine.account_path(payment_method.account_id), notice: "Payment method #{payment_method_id} successfully deleted"
@@ -89,7 +89,7 @@ module Kaui
     end
 
     def restful_show
-      payment_method = Kaui::PaymentMethod.find_by_id(params.require(:id), false, options_for_klient)
+      payment_method = Kaui::PaymentMethod.find_by_id(params.require(:id), false, false, [], 'NONE', options_for_klient)
       redirect_to kaui_engine.account_path(payment_method.account_id)
     end
 
@@ -98,7 +98,7 @@ module Kaui
         external_key = params.require(:external_key)
 
         begin
-          payment_methods = Kaui::PaymentMethod.find_by_external_key(external_key, false, false, 'NONE', options_for_klient)
+          payment_methods = Kaui::PaymentMethod.find_by_external_key(external_key, false, false, [], 'NONE', options_for_klient)
         rescue KillBillClient::API::NotFound
           payment_methods = nil
         end

data/app/controllers/kaui/payments_controller.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'csv'
+
 module Kaui
   class PaymentsController < Kaui::EngineController
     def index
@@ -12,7 +14,68 @@ module Kaui
       @max_nb_records = @search_query.blank? ? Kaui::Payment.list_or_search(nil, 0, 0, options_for_klient).pagination_max_nb_records : 0
     end
 
+    def download
+      account_id = params[:account_id]
+      start_date = params[:startDate]
+      end_date = params[:endDate]
+      all_fields_checked = params[:allFieldsChecked] == 'true'
+      columns = if all_fields_checked
+                  KillBillClient::Model::PaymentAttributes.instance_variable_get('@json_attributes') - %w[transactions audit_logs]
+                else
+                  params.require(:columnsString).split(',').map { |attr| attr.split.join('_').downcase }
+                end
+
+      kb_params = {}
+      kb_params[:startDate] = Date.parse(start_date).strftime('%Y-%m-%d') if start_date
+      kb_params[:endDate] = Date.parse(end_date).strftime('%Y-%m-%d') if end_date
+      if account_id.present?
+        account = Kaui::Account.find_by_id_or_key(account_id, false, false, options_for_klient)
+        payments = account.payments(options_for_klient).map! { |payment| Kaui::Payment.build_from_raw_payment(payment) }
+      else
+        payments = Kaui::Payment.list_or_search(nil, 0, MAXIMUM_NUMBER_OF_RECORDS_DOWNLOAD, options_for_klient.merge(params: kb_params))
+      end
+
+      payments.each do |payment|
+        created_date = nil
+        payment.transactions.each do |transaction|
+          transaction_date = Date.parse(transaction.effective_date)
+          created_date ||= transaction_date if transaction_date < created_date
+        end
+        payment.payment_date = created_date
+      end
+
+      csv_string = CSV.generate(headers: true) do |csv|
+        csv << columns
+
+        payments.each do |payment|
+          next if start_date && end_date && (payment.payment_date < Date.parse(start_date) || payment.payment_date > Date.parse(end_date))
+
+          data = columns.map do |attr|
+            case attr
+            when 'payment_number'
+              payment.payment_number
+            when 'payment_date'
+              view_context.format_date(payment.payment_date, account&.time_zone)
+            when 'total_authed_amount_to_money'
+              view_context.humanized_money_with_symbol(payment.total_authed_amount_to_money)
+            when 'paid_amount_to_money'
+              view_context.humanized_money_with_symbol(payment.paid_amount_to_money)
+            when 'returned_amount_to_money'
+              view_context.humanized_money_with_symbol(payment.returned_amount_to_money)
+            when 'status'
+              payment.transactions.empty? ? nil : payment.transactions[-1].status
+            else
+              payment&.send(attr.downcase)
+            end
+          end
+          csv << data
+        end
+      end
+      send_data csv_string, filename: "payments-#{Date.today}.csv", type: 'text/csv'
+    end
+
     def pagination
+      account = nil
       searcher = lambda do |search_key, offset, limit|
         if Kaui::Payment::TRANSACTION_STATUSES.include?(search_key)
           # Search is done by payment state on the server side, see http://docs.killbill.io/latest/userguide_payment.html#_payment_states
@@ -30,6 +93,7 @@ module Kaui
           rescue StandardError
             nil
           end
+
           payments = if account.nil?
                        Kaui::Payment.list_or_search(search_key, offset, limit, options_for_klient)
                      else
@@ -62,15 +126,7 @@ module Kaui
       end
 
       formatter = lambda do |payment|
-        [
-          view_context.link_to(payment.payment_number, view_context.url_for(controller: :payments, action: :show, account_id: payment.account_id, id: payment.payment_id)),
-          view_context.format_date(payment.payment_date, @account.time_zone),
-          view_context.humanized_money_with_symbol(payment.total_authed_amount_to_money),
-          view_context.humanized_money_with_symbol(payment.paid_amount_to_money),
-          view_context.humanized_money_with_symbol(payment.returned_amount_to_money),
-          payment.transactions.empty? ? nil : view_context.colored_transaction_status(payment.transactions[-1].status),
-          payment.payment_external_key
-        ]
+        Kaui.account_payments_columns.call(account, payment, view_context)[1]
       end
 
       paginate searcher, data_extractor, formatter
@@ -78,7 +134,7 @@ module Kaui
 
     def new
       cached_options_for_klient = options_for_klient
-      fetch_invoice = promise { Kaui::Invoice.find_by_id(params.require(:invoice_id), 'NONE', cached_options_for_klient) }
+      fetch_invoice = promise { Kaui::Invoice.find_by_id(params.require(:invoice_id), false, 'NONE', cached_options_for_klient) }
       fetch_payment_methods = promise { Kaui::PaymentMethod.find_all_by_account_id(params.require(:account_id), false, cached_options_for_klient) }
 
       @invoice = wait(fetch_invoice)

data/app/controllers/kaui/refunds_controller.rb

@@ -5,8 +5,9 @@ module Kaui
     def new
       cached_options_for_klient = options_for_klient
 
-      fetch_invoice = promise { Kaui::Invoice.find_by_id(params.require(:invoice_id), 'NONE', cached_options_for_klient) }
+      fetch_invoice = promise { Kaui::Invoice.find_by_id(params.require(:invoice_id), false, 'NONE', cached_options_for_klient) }
       fetch_payment = promise { Kaui::InvoicePayment.find_by_id(params.require(:payment_id), false, false, cached_options_for_klient) }
+
       fetch_bundles = promise { @account.bundles(cached_options_for_klient) }
 
       @invoice = wait(fetch_invoice)
@@ -18,7 +19,7 @@ module Kaui
 
     # rubocop:disable Lint/FloatComparison
     def create
-      invoice = Kaui::Invoice.find_by_id(params.require(:invoice_id), 'NONE', options_for_klient)
+      invoice = Kaui::Invoice.find_by_id(params.require(:invoice_id), false, 'NONE', options_for_klient)
 
       if params[:adjustment_type] == 'invoiceItemAdjustment'
         items = []

data/app/controllers/kaui/sessions_controller.rb

@@ -3,12 +3,19 @@
 module Kaui
   # Subclassed to specify the correct layout
   class SessionsController < Devise::SessionsController
+    include Kaui::ExceptionHelper
+
     layout Kaui.config[:layout]
 
     skip_before_action :check_for_redirect_to_tenant_screen, raise: false
 
     # The sign-in flow eventually calls authenticate! from config/initializers/killbill_authenticatable.rb
 
+    rescue_from(StandardError) do |exception|
+      @error = standardize_exception(exception)
+      render 'kaui/errors/500', status: 500, layout: false
+    end
+
     protected
 
     # Override after_sign_in_path_for to not have to rely on the default 'root' config which we want to keep on home#index

data/app/controllers/kaui/subscriptions_controller.rb

@@ -72,7 +72,7 @@ module Kaui
     end
 
     def edit
-      @subscription = Kaui::Subscription.find_by_id(params.require(:id), options_for_klient)
+      @subscription = Kaui::Subscription.find_by_id(params.require(:id), 'NONE', options_for_klient)
       _, plans_details = lookup_bundle_and_plan_details(@subscription)
       # Use a Set to deal with multiple pricelists
       @plans = Set.new.merge(plans_details.map(&:plan))
@@ -86,7 +86,7 @@ module Kaui
 
       wait_for_completion = params[:wait_for_completion] == '1'
 
-      subscription = Kaui::Subscription.find_by_id(params.require(:id), options_for_klient)
+      subscription = Kaui::Subscription.find_by_id(params.require(:id), 'NONE', options_for_klient)
 
       input = { planName: plan_name }
 
@@ -124,13 +124,13 @@ module Kaui
                                        else
                                          nil
                                        end
-      subscription = Kaui::Subscription.find_by_id(params.require(:id), options_for_klient)
+      subscription = Kaui::Subscription.find_by_id(params.require(:id), 'NONE', options_for_klient)
       subscription.cancel(current_user.kb_username, params[:reason], params[:comment], requested_date, entitlement_policy, billing_policy, use_requested_date_for_billing, options_for_klient)
       redirect_to kaui_engine.account_bundles_path(subscription.account_id), notice: 'Subscription was successfully cancelled'
     end
 
     def reinstate
-      subscription = Kaui::Subscription.find_by_id(params.require(:id), options_for_klient)
+      subscription = Kaui::Subscription.find_by_id(params.require(:id), 'NONE', options_for_klient)
 
       subscription.uncancel(current_user.kb_username, params[:reason], params[:comment], options_for_klient)
 
@@ -138,7 +138,7 @@ module Kaui
     end
 
     def edit_bcd
-      @subscription = Kaui::Subscription.find_by_id(params.require(:id), options_for_klient)
+      @subscription = Kaui::Subscription.find_by_id(params.require(:id), 'NONE', options_for_klient)
     end
 
     def update_bcd
@@ -158,7 +158,7 @@ module Kaui
     end
 
     def restful_show
-      subscription = Kaui::Subscription.find_by_id(params.require(:id), options_for_klient)
+      subscription = Kaui::Subscription.find_by_id(params.require(:id), 'NONE', options_for_klient)
       redirect_to kaui_engine.account_bundles_path(subscription.account_id)
     end
 
@@ -181,7 +181,7 @@ module Kaui
         external_key = params.require(:external_key)
 
         begin
-          subscription = Kaui::Subscription.find_by_external_key(external_key, options_for_klient)
+          subscription = Kaui::Subscription.find_by_external_key(external_key, 'NONE', options_for_klient)
         rescue KillBillClient::API::NotFound
           subscription = nil
         end
@@ -192,7 +192,7 @@ module Kaui
 
     def update_tags
       subscription_id = params.require(:id)
-      subscription = Kaui::Subscription.find_by_id(subscription_id, options_for_klient)
+      subscription = Kaui::Subscription.find_by_id(subscription_id, 'NONE', options_for_klient)
       tags = []
       params.each_key do |key|
         next unless key.include? 'tag'

data/app/controllers/kaui/transactions_controller.rb

@@ -3,7 +3,7 @@
 module Kaui
   class TransactionsController < Kaui::EngineController
     def restful_show
-      payment = Kaui::Payment.find_by_transaction_id(params.require(:id), false, true, options_for_klient)
+      payment = Kaui::Payment.find_by_transaction_id(params.require(:id), false, true, [], 'NONE', options_for_klient)
       redirect_to account_payment_path(payment.account_id, payment.payment_id)
     end
 
@@ -18,7 +18,7 @@ module Kaui
                                              currency: params[:currency],
                                              transaction_type: params[:transaction_type])
       else
-        payment = Kaui::Payment.find_by_transaction_id(transaction_id, false, false, options_for_klient)
+        payment = Kaui::Payment.find_by_transaction_id(transaction_id, false, false, [], 'NONE', options_for_klient)
         @transaction = Kaui::Transaction.build_from_raw_transaction(payment.transactions.find { |tx| tx.transaction_id == transaction_id })
       end
     end

data/app/helpers/kaui/exception_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Kaui
+  module ExceptionHelper
+    def standardize_exception(exception)
+      if defined?(JRUBY_VERSION)
+        case exception
+        when ActiveRecord::JDBCError
+          return I18n.translate('errors.messages.unable_to_connect_database')
+        end
+      end
+
+      case exception
+      when ActiveRecord::DatabaseConnectionError
+        I18n.translate('errors.messages.unable_to_connect_database')
+      when Errno::ECONNREFUSED, Errno::EBADF
+        I18n.translate('errors.messages.unable_to_connect_killbill')
+      when ->(e) { e.class.name.start_with?('KillBillClient::API') }
+        I18n.translate('errors.messages.error_communicating_killbill')
+      else
+        nil
+      end
+    end
+  end
+end

data/app/helpers/kaui/subscription_helper.rb

@@ -172,5 +172,9 @@ module Kaui
     def subscription_cancelled?(sub)
       sub.present? and sub.billing_end_date.present?
     end
+
+    def paging_button_class(num, current_page)
+      num == current_page ? 'btn btn-primary' : 'btn btn-custom'
+    end
   end
 end

data/app/models/kaui/account.rb

@@ -4,6 +4,8 @@ module Kaui
   class Account < KillBillClient::Model::Account
     attr_accessor :phone, :bill_cycle_day_local
 
+    SENSIVITE_DATA_FIELDS = %w[name email].freeze
+
     def check_account_details_phone
       return true if phone =~ /\A(?:\+?\d{1,3}\s*-?)?\(?(?:\d{3})?\)?[- ]?\d{3}[- ]?\d{4}\z/i
 

data/app/models/kaui/custom_field.rb

@@ -6,7 +6,7 @@ module Kaui
       if search_key.present?
         find_in_batches_by_search_key(search_key, offset, limit, options)
       else
-        find_in_batches(offset, limit, options)
+        find_in_batches(offset, limit, 'NONE', options)
       end
     end
   end

data/app/models/kaui/invoice.rb

@@ -2,6 +2,8 @@
 
 module Kaui
   class Invoice < KillBillClient::Model::Invoice
+    TABLE_IGNORE_COLUMNS = %w[amount balance credit_adj refund_adj items is_parent_invoice parent_invoice_id parent_account_id].freeze
+
     def self.build_from_raw_invoice(raw_invoice)
       result = Kaui::Invoice.new
       KillBillClient::Model::InvoiceAttributes.instance_variable_get('@json_attributes').each do |attr|

data/app/models/kaui/payment_method.rb

@@ -11,12 +11,12 @@ module Kaui
     end
 
     def self.find_safely_by_id(id, options = {})
-      Kaui::PaymentMethod.find_by_id(id, true, options)
+      Kaui::PaymentMethod.find_by_id(id, false, true, [], 'NONE', options)
     rescue StandardError => e
       # Maybe the plugin is not registered or the plugin threw an exception
       Rails.logger.warn(e)
       begin
-        Kaui::PaymentMethod.find_by_id(id, false, options)
+        Kaui::PaymentMethod.find_by_id(id, false, true, [], 'NONE', options)
       rescue StandardError
         nil
       end
@@ -26,7 +26,7 @@ module Kaui
       pms = Kaui::PaymentMethod.find_all_by_account_id(account_id, false, options)
 
       pms.each_with_index do |pm, i|
-        pms[i] = Kaui::PaymentMethod.find_by_id(pm.payment_method_id, true, options)
+        pms[i] = Kaui::PaymentMethod.find_by_id(pm.payment_method_id, false, true, [], 'NONE', options)
       rescue StandardError => e
         # Maybe the plugin is not registered or the plugin threw an exception
         Rails.logger.warn(e)
@@ -49,7 +49,7 @@ module Kaui
 
         # The payment method may have been deleted
         payment_methods_cache[payment.payment_method_id] ||= begin
-          Kaui::PaymentMethod.find_by_id(payment.payment_method_id, true, options)
+          Kaui::PaymentMethod.find_by_id(payment.payment_method_id, false, true, [], 'NONE', options)
         rescue StandardError
           nil
         end