Class: MnoEnterprise::InvoicePdf

Inherits:
Object
  • Object
show all
Includes:
ImageHelper
Defined in:
app/pdf/mno_enterprise/invoice_pdf.rb

Constant Summary

Constants included from ImageHelper

MnoEnterprise::ImageHelper::IMAGES_LOCATION

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ImageHelper

#app_image_path, #engine_image_path, #fit_image, #main_logo_path, #main_logo_white_bg_path

Constructor Details

#initialize(invoice) ⇒ InvoicePdf

InvoicePdf requires to be initialized with an Invoice object

Raises:

  • (ArgumentError) 


8
9
10
11
12
13
14
15
16
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
48
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/pdf/mno_enterprise/invoice_pdf.rb', line 8

def initialize(invoice)
  raise ArgumentError, "Received #{invoice.class} object (expected instance of Invoice)" unless invoice.is_a?(MnoEnterprise::Invoice)
  @invoice = invoice
  @pdf = nil
  @data = {}

  #===============================
  # Initialize formatting
  #===============================
  @format = {}
  @format[:header_size] = 120
  @format[:footer_size] = 100
  @format[:top_margin] = 36
  @format[:bottom_margin] = 36

  #===============================
  # Data hash
  #===============================
  @data = {}

  # Invoice details
  @data[:invoice_reference] = @invoice.slug

  # Customer details
  invoicable = @invoice.organization
  [:name, :email, :current_credit].each do |detail|
    @data["customer_#{detail}".to_sym] = invoicable.respond_to?(detail) ? invoicable.send(detail) : nil
  end

  # Billing Address - Kept at the invoice level for audit purpose
  @data[:customer_billing_address] = @invoice.billing_address

  # Financial values
  @data[:invoice_price] = @invoice.price
  @data[:invoice_currency] = @invoice.price.currency.to_s
  @data[:invoice_currency_name] = @invoice.price.currency.name
  @data[:invoice_credit_paid] = @invoice.credit_paid
  @data[:invoice_total_payable] = @invoice.total_payable
  @data[:invoice_tax_payable] = @invoice.tax_payable
  @data[:invoice_tax_pips] = (@invoice.tax_pips_applied || 0)
  @data[:invoice_total_payable_with_tax] = @data[:invoice_total_payable] + @data[:invoice_tax_payable]
  @data[:invoice_fully_paid] = (@data[:invoice_total_payable].zero? || @data[:invoice_total_payable].negative?)

  # Last App billing (Account Situation)
  @data[:invoice_previous_total_due] = @invoice.previous_total_due
  @data[:invoice_previous_total_paid] = @invoice.previous_total_paid

  # Billing details
  @data[:billing_report] = @invoice.billing_summary.map do |item|
    item_label = item[:label]
    price_label = format_price item

    (item[:lines] || []).each do |item_line|
      item_label += "<font size='4'>\n\n</font><font size='8'><color rgb='999999'><i>#{Prawn::Text::NBSP * 3}#{item_line[:label]}</i></color></font>"
      price_label += "<font size='4'>\n\n</font><font size='8'><color rgb='999999'>#{format_price(item_line)}</color></font>"
    end

    [item_label, item[:name], item[:usage], price_label]
  end

  # Billing period
  @data[:period_started_at] = @invoice.started_at.utc.to_date
  @data[:period_ended_at] = (@invoice.ended_at.utc - 1.minute).to_date # '- 1 minute' to avoid midnight (which belongs to following day)
  @data[:period_month] = @invoice.ended_at.strftime("%B")
  next_period = @data[:period_ended_at] + 1.month
  @data[:period_charge_date] = Date.new(next_period.year,next_period.month,2)
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



4
5
6
 
# File 'app/pdf/mno_enterprise/invoice_pdf.rb', line 4

def data
  @data
end

#invoice ⇒ Object (readonly)

Returns the value of attribute invoice.



4
5
6
 
# File 'app/pdf/mno_enterprise/invoice_pdf.rb', line 4

def invoice
  @invoice
end

#pdf ⇒ Object (readonly)

Returns the value of attribute pdf.



4
5
6
 
# File 'app/pdf/mno_enterprise/invoice_pdf.rb', line 4

def pdf
  @pdf
end

Instance Method Details

#add_page_body ⇒ Object

This method is responsible for generating the actual pdf content



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'app/pdf/mno_enterprise/invoice_pdf.rb', line 172

def add_page_body
  payment_enabled = !Settings.payment.disabled

  @pdf.stroke_color '999999'

  #===============================
  # Invoice Reference
  #===============================
  @pdf.float do
    original_color = @pdf.fill_color
    @pdf.fill_color "F0F0F0"
    @pdf.fill_rounded_rectangle [310,@pdf.cursor], 230, 50, 5
    @pdf.fill_color = original_color

    @pdf.text_box "Your Reference", at: [310,@pdf.cursor], width: 65, height: 13, align: :center, valign: :center,
                  style: :bold_italic, size: 7

    @pdf.text_box @data[:invoice_reference], at: [310,@pdf.cursor], width: 230, height: 50, align: :center, valign: :center,
                  style: :bold
  end

  #===============================
  # Customer information
  #===============================
  @pdf.text @data[:customer_name], align: :left, inline_format: true

  if @data[:customer_email]
    @pdf.text "<color rgb='999999'>#{@data[:customer_email]}</color>", align: :left, inline_format: true
  end

  if @data[:customer_billing_address]
    @pdf.move_down 5
    @pdf.text "<color rgb='999999'>#{@data[:customer_billing_address]}</color>", align: :left, inline_format: true, style: :italic, size: 9
  end

  #===============================
  # Summary
  #===============================
  @pdf.move_down 40
  @pdf.font_size(20) { @pdf.text 'Summary', style: :bold }
  @pdf.stroke_horizontal_rule
  @pdf.move_down 10

  summary_data_amount = @data[:invoice_price]
  summary_data_amount = @data[:invoice_total_payable_with_tax] if payment_enabled

  summary_data = []
  summary_data << ['Period', 'Total Payable' + (@data[:invoice_tax_pips] > 0 ? "\n<font size='8'><i>(incl. GST)</i></font>" : '')]
  summary_data << ["#{@data[:period_started_at].strftime("%B, %e %Y")} to #{@data[:period_ended_at].strftime("%B, %e %Y")}",money(summary_data_amount)]

  # Draw Table background
  bg_height = @data[:invoice_tax_pips] > 0 ? 58 : 50
  @pdf.float do
    original_color = @pdf.fill_color
    @pdf.fill_color "d1e17c"
    @pdf.fill_rounded_rectangle [0,@pdf.cursor], 540, bg_height, 5
    @pdf.fill_color = original_color
  end

  # Draw Table
  @pdf.table(summary_data) do |t|
    t.header = true
    t.width = 540
    t.column_widths = [435,105]
    t.cell_style = { borders: [] }
    t.row(0).font_style = :bold

    t.cell_style = { padding: [5, 5, 5, 10], inline_format: true }
    t.cells.style do |c|
      if c.column == 1
        c.align = :center
      end
    end
  end

  @pdf.move_down 10
  @pdf.indent(5) do
    @pdf.font_size(8) do
      @pdf.text "<color rgb='999999'> This charge will appear as INV #{@data[:invoice_reference]} on your bank statement.</color>", inline_format: true
      @pdf.text "<color rgb='999999'> Charges are all displayed in #{@data[:invoice_currency_name]} (#{@data[:invoice_currency]})</color>", inline_format: true
      if @data[:invoice_fully_paid]
        @pdf.text "<color rgb='999999'>  No credit card payments required for this invoice</color>", inline_format: true
      else
        @pdf.text "<color rgb='999999'>  Your designated credit card will be charged on #{@data[:period_charge_date].strftime("%B,%e %Y")} at midnight UTC by Maestrano Pty Ltd as service provider to the #{MnoEnterprise.app_name} platform.</color>", inline_format: true
      end
    end
  end

  #===============================
  # Credit Remaining
  # ---
  # Only if greater than zero
  #===============================
  if @data[:customer_current_credit] && @data[:customer_current_credit].positive?
    @pdf.move_down 5
    @pdf.indent(5) do
      @pdf.font_size(8) do
        @pdf.text "<color rgb='999999'>  Note that your credit is shared with any organization you may have created</color>", inline_format: true
      end
    end

    @pdf.move_up 28

    @pdf.float do
      original_color = @pdf.fill_color
      @pdf.fill_color "67BBE9"
      @pdf.fill_rounded_rectangle [445,@pdf.cursor], 95, 50, 5
      @pdf.fill_color = original_color

      @pdf.text_box "Credit Remaining", at: [445,@pdf.cursor], width: 95, height: 23, align: :center, valign: :center,
                    style: :bold, size: 10

      @pdf.text_box money(@data[:customer_current_credit]), at: [445,@pdf.cursor], width: 95, height: 37, align: :center, valign: :bottom
    end

    @pdf.move_down 40
  end

  if payment_enabled
    #===============================
    # Account Situation
    #===============================
    @pdf.move_down 30
    @pdf.font_size(20) { @pdf.text 'Account Situation', style: :bold }
    @pdf.stroke_horizontal_rule
    @pdf.move_down 10

    # Situation Data
    situation_data = []
    # Header
    situation_data << [
      '',
      '',
      'Due Last Month',
      '',
      'Paid (Thank You)',
      '',
      'This Month',
      '',
      'Credit',
      '',
      'Total'
    ]

    #Content
    situation_data << [
      '',
      '',
      money(@data[:invoice_previous_total_due]),
      '-',
      money(@data[:invoice_previous_total_paid]),
      '+',
      money(@data[:invoice_price]),
      '-',
      money(@data[:invoice_credit_paid]),
      '=',
      money(@data[:invoice_total_payable])
    ]

    # Draw background
    @pdf.float do
      original_color = @pdf.fill_color
      @pdf.fill_color "F0F0F0"
      @pdf.fill_rounded_rectangle [0,@pdf.cursor], 540, 50, 5
      @pdf.fill_color = original_color
    end


    # Draw left background
    @pdf.float do
      original_color = @pdf.fill_color
      @pdf.fill_color "E0E0E0"
      @pdf.fill_rounded_rectangle [0,@pdf.cursor], 80, 50, 5
      @pdf.fill_color = original_color
      @pdf.move_down 21
      if @data[:invoice_tax_pips] > 0
        @pdf.text_box 'Excl. GST', at: [12,@pdf.cursor]
      else
        @pdf.text_box 'Details', at: [20,@pdf.cursor]
      end
    end

    # Draw table
    @pdf.table(situation_data) do |t|
      t.header = true
      t.width = 540
      t.column_widths = [75,18,75,18,75,18,75,18,75,18,75]
      t.row(0).font_style = :bold
      t.row(0).size = 8
      t.row(0).height = 22
      t.row(1).height = 25

      t.cell_style = {
        borders: [],
        overflow: :shrink_to_fit,
        align: :center
      }

      # Color the '+','-' and '=' characters
      t.cells.style do |c|
        if c.row == 1 && c.column.odd?
          c.text_color = "a8a8a8"
        end
      end
    end


    #=================================
    # Account Situation - Tax Section
    #=================================
    if @data[:invoice_tax_pips] > 0

      #-----------------
      # GST row
      #-----------------
      @pdf.move_down 8

      table_data = []
      table_data << [
        '',
        '',
        '',
        '',
        '',
        '',
        '',
        '',
        'GST',
        '+',
        money(@data[:invoice_tax_payable]),
      ]

      # Draw table background
      @pdf.float do
        original_color = @pdf.fill_color
        @pdf.fill_color "F0F0F0"
        @pdf.fill_rounded_rectangle [368,@pdf.cursor], 172, 24, 5
        @pdf.fill_color = original_color
      end

      # Draw left background
      @pdf.float do
        original_color = @pdf.fill_color
        @pdf.fill_color "FAB451"
        @pdf.fill_rounded_rectangle [368,@pdf.cursor], 80, 24, 5
        @pdf.fill_color = original_color
      end

      @pdf.table(table_data) do |t|
        t.header = true
        t.width = 540
        t.column_widths = [75,18,75,18,75,18,75,18,75,18,75]
        t.row(0).height = 25

        t.cell_style = {
          borders: [],
          overflow: :shrink_to_fit,
          align: :center
        }

        # Color the '+','-' and '=' characters
        t.cells.style do |c|
          if c.row == 0 && c.column.odd?
            c.text_color = "a8a8a8"
          end
        end
      end


      #-----------------
      # Total (incl. GST)
      #-----------------
      @pdf.move_down 5

      table_data = []
      table_data << [
        '',
        '',
        '',
        '',
        '',
        '',
        '',
        '',
        'Total (incl. GST)',
        '=',
        money(@data[:invoice_total_payable_with_tax]),
      ]

      # Draw table background
      @pdf.float do
        original_color = @pdf.fill_color
        @pdf.fill_color "F0F0F0"
        @pdf.fill_rounded_rectangle [368,@pdf.cursor], 172, 24, 5
        @pdf.fill_color = original_color
      end

      # Draw left background
      @pdf.float do
        original_color = @pdf.fill_color
        @pdf.fill_color "DAE173"
        @pdf.fill_rounded_rectangle [368,@pdf.cursor], 80, 24, 5
        @pdf.fill_color = original_color
      end

      @pdf.table(table_data) do |t|
        t.header = true
        t.width = 540
        t.row(0).font_style = :bold
        t.column_widths = [75,18,75,18,75,18,75,18,75,18,75]
        t.row(0).height = 25

        t.cell_style = {
          borders: [],
          overflow: :shrink_to_fit,
          align: :center
        }

        # Color the '+','-' and '=' characters
        t.cells.style do |c|
          if c.row == 0 && c.column.odd?
            c.text_color = "a8a8a8"
          end
        end
      end
    end
  end

  #===============================
  # Details
  #===============================
  @pdf.start_new_page
  @pdf.font_size(20) { @pdf.text 'Details', style: :bold }
  @pdf.stroke_horizontal_rule
  @pdf.move_down 10

  app_details_data = []
  app_details_data << ['Product', 'Type', 'Usage', 'Price' + (@data[:invoice_tax_pips] > 0 ? "\n<font size='8'><i>(excl. GST)</i></font>" : '')]
  app_details_data += @data[:billing_report]

  @pdf.table(app_details_data) do |t|
    t.header = true
    t.width = 540
    t.row_colors = ["FFFFFF", "F0F0F0"]
    t.column_widths = [240,100,100,100]
    t.cell_style = { borders: [:bottom],
                     border_width: 1,
                     border_color: "999999",
                     inline_format: true
    }
    t.row(0).borders = [:bottom]
    t.row(0).border_width = 2
    t.row(0).font_style = :bold
  end
end

#add_page_footer ⇒ Object

Add a repeated footer to the document



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'app/pdf/mno_enterprise/invoice_pdf.rb', line 140

def add_page_footer
  @pdf.repeat :all do
    @pdf.bounding_box([0, @pdf.bounds.bottom], width: 540, height: @format[:footer_size]) do
      @pdf.move_down 50
      @pdf.stroke_color '999999'
      @pdf.stroke_horizontal_rule
      @pdf.move_down 10
      @pdf.font_size(8) do
        @pdf.text "<color rgb='999999'>This invoice has been generated by Maestrano Pty Ltd on behalf of the #{MnoEnterprise.app_name} platform (the \"Service\").</color>", inline_format: true
        @pdf.text "<color rgb='999999'>All charges in this invoice are in #{@data[:invoice_currency_name]} (#{@data[:invoice_currency]}). Credit card payments will be processed by Maestrano Pty Ltd.</color>", inline_format: true
        @pdf.text " ", inline_format: true
        @pdf.text "<color rgb='999999'>Maestrano Pty Ltd | Suite 504, 46 Market Street, Sydney, NSW 2000, Australia | ABN: 80 152 564 424</color>", inline_format: true
      end
    end
  end
end

#add_page_header ⇒ Object

Add a repeated header to the document



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'app/pdf/mno_enterprise/invoice_pdf.rb', line 126

def add_page_header
  title = Settings.payment.disabled ? 'Account Statement - ' : 'Monthly Invoice - '
  @pdf.repeat :all do
    @pdf.bounding_box([0, @pdf.bounds.top+@format[:header_size]], width: 540, height: @format[:footer_size]) do
      @pdf.float do
        @pdf.image main_logo_white_bg_path(true), fit: [135, (@format[:footer_size])]
      end
      @pdf.move_down 52
      @pdf.font_size(20) { @pdf.text "#{title} #{@data[:period_month]}", style: :bold, align: :right }
    end
  end
end

#add_page_numbering ⇒ Object

Add page number on every page



158
159
160
161
162
163
164
165
166
167
168
 
# File 'app/pdf/mno_enterprise/invoice_pdf.rb', line 158

def add_page_numbering
  numbering_options = {
    at: [@pdf.bounds.right - 150, 0-@format[:footer_size]],
    width: 150,
    align: :right,
    start_count_at: 1,
    color: "999999",
    size: 8
  }
  @pdf.number_pages "Page <page> of <total>", numbering_options
end

#format_price(item) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
 
# File 'app/pdf/mno_enterprise/invoice_pdf.rb', line 83

def format_price(item)
  # price_tag is deprecated
  price = item[:price]
  if price
    # Money hash are automatically parsed to Money in core/lib/her_extension/middleware/mnoe_api_v1_parse_json.rb
    money(price)
  else
    item[:price_tag]
  end
end

#generate_content ⇒ Object

Generate the document content by adding body, header, footer and page numbering



97
98
99
100
101
102
103
104
105
106
107
 
# File 'app/pdf/mno_enterprise/invoice_pdf.rb', line 97

def generate_content
  @pdf = Prawn::Document.new(
    info: self.metadata,
    top_margin: @format[:header_size] + @format[:top_margin],
    bottom_margin: @format[:footer_size] + @format[:bottom_margin]
  )
  add_page_body
  add_page_header
  add_page_footer
  add_page_numbering
end

#metadata ⇒ Object

Generate the document metadata



110
111
112
113
114
115
116
117
118
 
# File 'app/pdf/mno_enterprise/invoice_pdf.rb', line 110

def metadata
  {
    Title: 'Maestrano Monthly Invoice',
    Author: 'Maestrano',
    Subject: 'Maestrano Monthly Invoice',
    Producer: 'Maestrano',
    CreationDate: Time.now
  }
end

#money(m) ⇒ Object

Format a money object



121
122
123
 
# File 'app/pdf/mno_enterprise/invoice_pdf.rb', line 121

def money(m)
  "#{m.format(symbol: false)} #{m.currency.to_s}"
end

#render ⇒ Object

Render the pdf document and return it as a string object



78
79
80
81
 
# File 'app/pdf/mno_enterprise/invoice_pdf.rb', line 78

def render
  generate_content
  @pdf.render
end