Class: Kaui::InvoicesController

Inherits:
EngineController show all
Defined in:
app/controllers/kaui/invoices_controller.rb

Constant Summary

Constants included from EngineControllerUtil

EngineControllerUtil::MAXIMUM_NUMBER_OF_RECORDS_DOWNLOAD, EngineControllerUtil::SIMPLE_PAGINATION_THRESHOLD

Instance Method Summary collapse

Methods inherited from EngineController

#check_for_redirect_to_tenant_screen, #current_ability, #current_user, #options_for_klient, #populate_account_details, #retrieve_allowed_users_for_current_user, #retrieve_tenants_for_current_user

Methods included from ErrorHandler

#perform_redirect_after_error

Instance Method Details

#commit_invoice ⇒ Object 



170
171
172
173
174
175
 
# File 'app/controllers/kaui/invoices_controller.rb', line 170

def commit_invoice
  cached_options_for_klient = 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 (invoice., invoice.invoice_id), notice: 'Invoice successfully committed'
end

#download ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'app/controllers/kaui/invoices_controller.rb', line 17

def download
   = params[:account_id]
  start_date = params[:startDate]
  end_date = params[:endDate]
  all_fields_checked = params[:allFieldsChecked] == 'true'
  query_string = handle_balance_search(params[:search])
  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
  query_string = remapping_addvanced_search_fields(query_string, Kaui::Invoice::ADVANCED_SEARCH_NAME_CHANGES)
  invoices = if .present? && query_string.blank?
               Kaui::.paginated_invoices(, nil, nil, 'NONE', options_for_klient).map! { |invoice| Kaui::Invoice.build_from_raw_invoice(invoice) }
             else
               Kaui::Invoice.list_or_search(query_string, 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

#index ⇒ Object 



6
7
8
9
10
11
12
13
14
15
 
# File 'app/controllers/kaui/invoices_controller.rb', line 6

def index
  @search_query = params[:account_id]
  @advance_search_query = params[:q] || request.query_string
  @ordering = params[:ordering] || (@search_query.blank? ? 'desc' : 'asc')
  @offset = params[:offset] || 0
  @limit = params[:limit] || 50
  @search_fields = Kaui::Invoice::ADVANCED_SEARCH_COLUMNS.map { |attr| [attr, attr.split('_').join(' ').capitalize] }

  @max_nb_records = @search_query.blank? ? Kaui::Invoice.list_or_search(nil, 0, 0, options_for_klient).pagination_max_nb_records : 0
end

#pagination ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'app/controllers/kaui/invoices_controller.rb', line 49

def pagination
  cached_options_for_klient = options_for_klient

  searcher = lambda do |search_key, offset, limit|
     = begin
      Kaui::.find_by_id_or_key(search_key, false, false, cached_options_for_klient)
    rescue StandardError
      nil
    end
    if .nil?
      search_key = remapping_addvanced_search_fields(search_key, Kaui::Invoice::ADVANCED_SEARCH_NAME_CHANGES)
      Kaui::Invoice.list_or_search(search_key, offset, limit, cached_options_for_klient)
    else
      Kaui::.paginated_invoices(search_key, offset, limit, 'NONE', cached_options_for_klient).map! { |invoice| Kaui::Invoice.build_from_raw_invoice(invoice) }
    end
  end

  data_extractor = lambda do |invoice, column|
    Kaui..call(invoice, view_context)[2][column]
  end
  formatter = lambda do |invoice|
    Kaui..call(invoice, view_context)[1]
  end

  paginate searcher, data_extractor, formatter
end

#restful_show ⇒ Object 



156
157
158
159
 
# File 'app/controllers/kaui/invoices_controller.rb', line 156

def restful_show
  invoice = Kaui::Invoice.find_by_id(params.require(:id), false, 'NONE', options_for_klient)
  redirect_to (invoice., invoice.invoice_id)
end

#restful_show_by_number ⇒ Object 



161
162
163
164
 
# File 'app/controllers/kaui/invoices_controller.rb', line 161

def restful_show_by_number
  invoice = Kaui::Invoice.find_by_number(params.require(:number), false, 'NONE', options_for_klient)
  redirect_to (invoice., invoice.invoice_id)
end

#show ⇒ Object

rubocop:disable Lint/HashCompareByIdentity



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'app/controllers/kaui/invoices_controller.rb', line 77

def show
  # Go to the database once
  cached_options_for_klient = 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,
    'FIXED' => 1,
    'RECURRING' => 2,
    'REPAIR_ADJ' => 3,
    'USAGE' => 4,
    'PARENT_SUMMARY' => 5,
    'ITEM_ADJ' => 6,
    'CBA_ADJ' => 7,
    'CREDIT_ADJ' => 8,
    'TAX' => 9
  }
  # TODO: The pretty description has to be shared with the view
  @invoice.items.sort_by! do |ii|
    # Make sure not to compare nil (ArgumentError comparison of Array with Array failed)
    a = precedence[ii.item_type] || 100
    b = (ii.pretty_plan_name.blank? || !ii.item_type.in?(%w[USAGE RECURRING]) ? ii.description : ii.pretty_plan_name) || ''
    [a, b]
  end

  fetch_payments = promise { @invoice.payments(true, true, 'FULL', cached_options_for_klient).map { |payment| Kaui::InvoicePayment.build_from_raw_payment(payment) } }
  fetch_pms = fetch_payments.then { |payments| Kaui::PaymentMethod.payment_methods_for_payments(payments, cached_options_for_klient) }
  fetch_invoice_fields = promise { @invoice.custom_fields('NONE', cached_options_for_klient).sort { |cf_a, cf_b| cf_a.name.downcase <=> cf_b.name.downcase } }
  fetch_payment_fields = promise do
    all_payment_fields = @account.all_custom_fields(:PAYMENT, 'NONE', cached_options_for_klient)
    all_payment_fields.each_with_object({}) do |entry, hsh|
      (hsh[entry.object_id] ||= []) << entry
    end
  end

  fetch_available_invoice_item_tags = promise { Kaui::TagDefinition.all_for_invoice_item(cached_options_for_klient) }
  fetch_tags_per_invoice_item = promise do
    tags_per_invoice_item = @account.all_tags(:INVOICE_ITEM, false, 'NONE', cached_options_for_klient)
    tags_per_invoice_item.each_with_object({}) do |entry, hsh|
      (hsh[entry.object_id] ||= []) << entry
    end
  end

  fetch_custom_fields_per_invoice_item = promise do
    custom_fields_per_invoice_item = @account.all_custom_fields(:INVOICE_ITEM, 'NONE', cached_options_for_klient)
    custom_fields_per_invoice_item.each_with_object({}) do |entry, hsh|
      (hsh[entry.object_id] ||= []) << entry
    end
  end

  fetch_invoice_tags = promise { @invoice.tags(false, 'NONE', cached_options_for_klient).sort { |tag_a, tag_b| tag_a <=> tag_b } }
  fetch_available_invoice_tags = promise { Kaui::TagDefinition.all_for_invoice(cached_options_for_klient) }

  @payments = wait(fetch_payments)
  @payment_methods = wait(fetch_pms)
  @custom_fields = wait(fetch_invoice_fields)
  @payment_custom_fields = wait(fetch_payment_fields)
  @custom_fields_per_invoice_item = wait(fetch_custom_fields_per_invoice_item)
  @tags_per_invoice_item = wait(fetch_tags_per_invoice_item)
  @available_invoice_item_tags = wait(fetch_available_invoice_item_tags)
  @invoice_tags = wait(fetch_invoice_tags)
  @available_invoice_tags = wait(fetch_available_invoice_tags)
  @available_invoice_tags.reject! { |td| td.name == 'WRITTEN_OFF' } if @invoice.status == 'VOID'
end

#show_html ⇒ Object 



166
167
168
 
# File 'app/controllers/kaui/invoices_controller.rb', line 166

def show_html
  render html: Kaui::Invoice.as_html(params.require(:id), options_for_klient).html_safe
end

#void_invoice ⇒ Object

rubocop:enable Lint/HashCompareByIdentity



144
145
146
147
148
149
150
151
152
153
154
 
# File 'app/controllers/kaui/invoices_controller.rb', line 144

def void_invoice
  cached_options_for_klient = 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 (invoice., invoice.invoice_id), notice: 'Invoice successfully voided'
  rescue StandardError => e
    flash[:error] = "Unable to void invoice: #{as_string(e)}"
    redirect_to (invoice., invoice.invoice_id)
  end
end