invoice_printer 2.0.0.beta3 → 2.2.0

data/docs/SERVER.md

@@ -23,9 +23,11 @@ By default server binds to `0.0.0.0:9393`.
 Get the public image and run it:
 
 ```bash
-$ sudo docker pull strzibnyj/invoice_printer_server:latest
-$ sudo docker run -d -p 9393:9393 -t docker.io/strzibnyj/invoice_printer_server
+$ sudo docker pull strzibnyj/invoice_printer_server:$VERSION
+$ sudo docker run -d -p 9393:9393 -v ~/path/to/invocies:/data:Z -t docker.io/strzibnyj/invoice_printer_server
 ```
+You can use `latest` as a `$VERSION`. Specifying the `-v` option is only required when using the `/print` action to create the documents at certain path. It will allow you to provide the desired filename as "/data/invoice-name.pdf".
+
 The server will then be available on `0.0.0.0:9393`.
 
 Docker image already contains the optional `invoice_printer_fonts` gem.
@@ -59,11 +61,14 @@ Options:
 - `document` - JSON representation of the document
 - `labels` - JSON for labels
 - `font` - path to font file or builtin font name
+- `bold_font` - path to bold font file or builtin font name
 - `stamp` - path to stamp file
 - `logo` - path to logotype file
 - `background` - path to background file
 - `page_size` - letter or A4 page size
 
+These parameters are the same as for the [command line](./COMMAND_LINE.md).
+
 On success a `200` response is returned:
 
 ```json
@@ -99,6 +104,7 @@ Options:
 - `document` - JSON representation of the document
 - `labels` - JSON for labels
 - `font` - path to font file or builtin font name
+- `bold_font` - path to bold font file or builtin font name
 - `stamp` - path to stamp file
 - `logo` - path to logotype file
 - `background` - path to background file

data/examples/breakdown.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+# This is an example of a longer invoice.
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'invoice_printer'
+
+labels = {
+  tax: '10% VAT'
+}
+
+item = InvoicePrinter::Document::Item.new(
+  name: 'Programming',
+  quantity: '10',
+  unit: 'h',
+  price: '$ 60',
+  tax: '$ 60',
+  amount: '$ 600'
+)
+
+item2 = InvoicePrinter::Document::Item.new(
+  name: 'Consulting',
+  breakdown: "Excludes 1 hour free consultation",
+  quantity: '10',
+  unit: 'h',
+  price: '$ 30',
+  tax: '$ 30',
+  amount: '$ 300'
+)
+
+breakdown = <<BREAKDOWN
+Issue 404: 15h
+Issue 505: 5h
+BREAKDOWN
+
+item3 = InvoicePrinter::Document::Item.new(
+  name: 'Support',
+  breakdown: breakdown,
+  quantity: '20',
+  unit: 'h',
+  price: '$ 15',
+  tax: '$ 30',
+  amount: '$ 330'
+)
+
+invoice = InvoicePrinter::Document.new(
+  number: 'NO. 198900000001',
+  provider_name: 'John White',
+  provider_lines: "79 Stonybrook St.\nBronx, NY 10457",
+  purchaser_name: 'Will Black',
+  purchaser_lines: "8648 Acacia Rd.\nBrooklyn, NY 11203",
+  issue_date: '05/03/2016',
+  due_date: '19/03/2016',
+  subtotal: '$ 1,000',
+  tax: '$ 100',
+  total: '$ 1,100',
+  bank_account_number: '156546546465',
+  items: [item, item2, item3],
+  note: 'This is a note at the end.'
+)
+
+InvoicePrinter.print(
+  document: invoice,
+  labels: labels,
+  stamp: File.expand_path('../stamp.png', __FILE__),
+  logo: File.expand_path('../prawn.png', __FILE__),
+  file_name: 'breakdown.pdf'
+)
+
+InvoicePrinter.print(
+  document: invoice,
+  labels: labels,
+  stamp: File.expand_path('../stamp.png', __FILE__),
+  logo: File.expand_path('../prawn.png', __FILE__),
+  file_name: 'breakdown_a4.pdf',
+  page_size: :a4
+)

data/examples/international_invoice.rb

@@ -80,7 +80,7 @@ InvoicePrinter.print(
   document: invoice,
   labels: labels,
   font: 'overpass',
-  logo: 'prawn.png',
+  logo: File.expand_path('../prawn.png', __FILE__),
   file_name: 'international_invoice.pdf'
 )
 
@@ -88,7 +88,7 @@ InvoicePrinter.print(
   document: invoice,
   labels: labels,
   font: 'overpass',
-  logo: 'prawn.png',
+  logo: File.expand_path('../prawn.png', __FILE__),
   file_name: 'international_invoice_a4.pdf',
   page_size: :a4
 )

data/examples/long_invoice.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# This is an example of a very simple invoice.
+# This is an example of a longer invoice.
 
 lib = File.expand_path('../../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -12,7 +12,7 @@ labels = {
 item = InvoicePrinter::Document::Item.new(
   name: 'Programming',
   quantity: '10',
-  unit: 'hr',
+  unit: 'h',
   price: '$ 60',
   tax: '$ 60',
   amount: '$ 600'
@@ -21,7 +21,7 @@ item = InvoicePrinter::Document::Item.new(
 item2 = InvoicePrinter::Document::Item.new(
   name: 'Consulting',
   quantity: '10',
-  unit: 'hr',
+  unit: 'h',
   price: '$ 30',
   tax: '$ 30',
   amount: '$ 300'
@@ -30,7 +30,7 @@ item2 = InvoicePrinter::Document::Item.new(
 item3 = InvoicePrinter::Document::Item.new(
   name: 'Support',
   quantity: '20',
-  unit: 'hr',
+  unit: 'h',
   price: '$ 15',
   tax: '$ 30',
   amount: '$ 330'
@@ -55,16 +55,16 @@ invoice = InvoicePrinter::Document.new(
 InvoicePrinter.print(
   document: invoice,
   labels: labels,
-  stamp: 'stamp.png',
-  logo: 'prawn.png',
+  stamp: File.expand_path('../stamp.png', __FILE__),
+  logo: File.expand_path('../prawn.png', __FILE__),
   file_name: 'long_invoice.pdf'
 )
 
 InvoicePrinter.print(
   document: invoice,
   labels: labels,
-  stamp: 'stamp.png',
-  logo: 'prawn.png',
+  stamp: File.expand_path('../stamp.png', __FILE__),
+  logo: File.expand_path('../prawn.png', __FILE__),
   file_name: 'long_invoice_a4.pdf',
   page_size: :a4
 )

data/examples/promo.rb

@@ -46,20 +46,24 @@ second_item = InvoicePrinter::Document::Item.new(
   amount: 'Kč 9.000'
 )
 
+provider_address = <<ADDRESS
+Rolnická 1
+747 05  Opava
+Kateřinky
+ADDRESS
+
+purchaser_address = <<ADDRESS
+Ostravská 1
+747 70  Opava
+ADDRESS
+
 invoice = InvoicePrinter::Document.new(
   number: 'č. 198900000001',
   provider_name: 'Petr Nový',
+  provider_lines:  provider_address,
   provider_tax_id: '56565656',
-  provider_street: 'Rolnická',
-  provider_street_number: '1',
-  provider_postcode: '747 05',
-  provider_city: 'Opava',
-  provider_city_part: 'Kateřinky',
   purchaser_name: 'Adam Černý',
-  purchaser_street: 'Ostravská',
-  purchaser_street_number: '1',
-  purchaser_postcode: '747 70',
-  purchaser_city: 'Opava',
+  purchaser_lines: purchaser_address,
   issue_date: '05/03/2016',
   due_date: '19/03/2016',
   subtotal: 'Kč 10.000',
@@ -75,16 +79,18 @@ invoice = InvoicePrinter::Document.new(
 InvoicePrinter.print(
   document: invoice,
   labels: labels,
-  font: File.expand_path('../../../assets/fonts/overpass/Overpass-Regular.ttf', __FILE__),
-  logo: 'logo.png',
+  font: File.expand_path('../../assets/fonts/overpass/Overpass-Regular.ttf', __FILE__),
+  bold_font: File.expand_path('../../assets/fonts/overpass/Overpass-Bold.ttf', __FILE__),
+  logo: File.expand_path('../logo.png', __FILE__),
   file_name: 'promo.pdf'
 )
 
 InvoicePrinter.print(
   document: invoice,
   labels: labels,
-  font: File.expand_path('../../../assets/fonts/overpass/Overpass-Regular.ttf', __FILE__),
-  logo: 'logo.png',
+  font: File.expand_path('../../assets/fonts/overpass/Overpass-Regular.ttf', __FILE__),
+  bold_font: File.expand_path('../../assets/fonts/overpass/Overpass-Bold.ttf', __FILE__),
+  logo: File.expand_path('../logo.png', __FILE__),
   file_name: 'promo_a4.pdf',
   page_size: :a4
 )

data/examples/provider_purchaser_lines.rb

@@ -47,7 +47,8 @@ Rolnická 1
 747 05  Opava
 Kateřinky
 
-fith line wont show
+
+6th line wont show
 ADDRESS
 
 purchaser_address = <<ADDRESS
@@ -55,8 +56,7 @@ Ostravská 1
 747 70  Opava
 
 
-
-fith line wont show
+6th line wont show
 ADDRESS
 
 invoice = InvoicePrinter::Document.new(
@@ -64,20 +64,11 @@ invoice = InvoicePrinter::Document.new(
   provider_name: 'Petr Nový',
   provider_tax_id: '56565656',
   provider_tax_id2: 'CZ56565656',
-  provider_street: 'Rolnická',
-  provider_street_number: '1',
-  provider_postcode: '747 05',
-  provider_city: 'Opava',
-  provider_city_part: 'Kateřinky',
   provider_lines: provider_address,
   purchaser_name: 'Adam Černý',
-  purchaser_street: 'Ostravská',
-  purchaser_street_number: '1',
-  purchaser_postcode: '747 70',
-  purchaser_city: 'Opava',
-  purchaser_lines: purchaser_address,
   purchaser_tax_id: '56565656',
   purchaser_tax_id2: 'CZ56565656',
+  purchaser_lines: purchaser_address,
   issue_date: '05/03/2016',
   due_date: '19/03/2016',
   subtotal: 'Kč 10.000',
@@ -94,7 +85,7 @@ InvoicePrinter.print(
   document: invoice,
   labels: labels,
   font: 'overpass',
-  logo: 'prawn.png',
+  logo: File.expand_path('../prawn.png', __FILE__),
   file_name: 'provider_purchaser_lines.pdf'
 )
 
@@ -102,7 +93,7 @@ InvoicePrinter.print(
   document: invoice,
   labels: labels,
   font: 'overpass',
-  logo: 'prawn.png',
+  logo: File.expand_path('../prawn.png', __FILE__),
   file_name: 'provider_purchaser_lines_a4.pdf',
   page_size: :a4
 )

data/examples/simple_invoice.rb

@@ -5,6 +5,16 @@ lib = File.expand_path('../../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'invoice_printer'
 
+provider_address = <<ADDRESS
+5th Avenue
+747 05  NYC
+ADDRESS
+
+purchaser_address = <<ADDRESS
+7th Avenue
+747 70  NYC
+ADDRESS
+
 item = InvoicePrinter::Document::Item.new(
   name: 'Programming',
   quantity: '10',
@@ -16,36 +26,25 @@ item = InvoicePrinter::Document::Item.new(
 invoice = InvoicePrinter::Document.new(
   number: 'NO. 198900000001',
   provider_name: 'John White',
-  # Deprecated 1.3 API, use provider_lines
-  # Here for compatibility test
-  provider_street: '5th Avenue',
-  provider_street_number: '1',
-  provider_postcode: '747 05',
-  provider_city: 'NYC',
-  purchaser_name: 'Will Black',
-  # Deprecated 1.3 API, use purchaser_lines
-  # Here for compatibility test
-  purchaser_street: '7th Avenue',
-  purchaser_street_number: '1',
-  purchaser_postcode: '747 70',
-  purchaser_city: 'NYC',
+  provider_lines: provider_address,
+  purchaser_lines: purchaser_address,
   issue_date: '05/03/2016',
   due_date: '19/03/2016',
   total: '$ 900',
   bank_account_number: '156546546465',
   items: [item],
-  note: 'This is a note at the end.'
+  note: "This is a note at the end.\nA note with two lines."
 )
 
 InvoicePrinter.print(
   document: invoice,
-  logo: 'prawn.png',
+  logo: File.expand_path('../prawn.png', __FILE__),
   file_name: 'simple_invoice.pdf'
 )
 
 InvoicePrinter.print(
   document: invoice,
-  logo: 'prawn.png',
+  logo: File.expand_path('../prawn.png', __FILE__),
   file_name: 'simple_invoice_a4.pdf',
   page_size: :a4
 )

data/examples/variable_field_invoice.rb

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+# This is an example of a international invoice with Czech labels and English translation.
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'invoice_printer'
+
+labels = {
+  name: 'Faktura',
+  provider: 'Prodejce',
+  purchaser: 'Kupující',
+  tax_id: 'IČ',
+  tax_id2: 'DIČ',
+  payment: 'Forma úhrady',
+  payment_by_transfer: 'Platba na následující účet:',
+  account_number: 'Číslo účtu',
+  issue_date: 'Datum vydání',
+  due_date: 'Datum splatnosti',
+  variable_field: 'Variabilní symbol',
+  item: 'Položka',
+  quantity: 'Počet',
+  unit: 'MJ',
+  price_per_item: 'Cena za položku',
+  amount: 'Celkem bez daně',
+  subtotal: 'Cena bez daně',
+  tax: 'DPH 21 %',
+  total: 'Celkem'
+}
+
+# Default English labels as sublabels
+sublabels = InvoicePrinter::PDFDocument::DEFAULT_LABELS
+labels.merge!({ sublabels: sublabels })
+
+first_item = InvoicePrinter::Document::Item.new(
+  name: 'Konzultace',
+  quantity: '2',
+  unit: 'hod',
+  price: 'Kč 500',
+  amount: 'Kč 1.000'
+)
+
+second_item = InvoicePrinter::Document::Item.new(
+  name: 'Programování',
+  quantity: '10',
+  unit: 'hod',
+  price: 'Kč 900',
+  amount: 'Kč 9.000'
+)
+
+provider_address = <<ADDRESS
+Rolnická 1
+747 05  Opava
+Kateřinky
+ADDRESS
+
+purchaser_address = <<ADDRESS
+8648 Acacia Rd.
+Brooklyn, NY 11203
+ADDRESS
+
+invoice = InvoicePrinter::Document.new(
+  number: 'č. 198900000001',
+  provider_name: 'Petr Nový',
+  provider_lines: provider_address,
+  provider_tax_id: '56565656',
+  purchaser_name: 'Adam Black',
+  purchaser_lines: purchaser_address,
+  issue_date: '05/03/2016',
+  due_date: '19/03/2016',
+  variable_symbol: 'VS198900000001',
+  subtotal: 'Kč 10.000',
+  tax: 'Kč 2.100',
+  total: 'Kč 12.100,-',
+  bank_account_number: '156546546465',
+  account_iban: 'IBAN464545645',
+  account_swift: 'SWIFT5456',
+  items: [first_item, second_item],
+  note: 'Osoba je zapsána v živnostenském rejstříku.'
+)
+
+InvoicePrinter.print(
+  document: invoice,
+  labels: labels,
+  font: 'overpass',
+  logo: File.expand_path('../prawn.png', __FILE__),
+  file_name: 'variable_field_invoice.pdf'
+)
+
+InvoicePrinter.print(
+  document: invoice,
+  labels: labels,
+  font: 'overpass',
+  logo: File.expand_path('../prawn.png', __FILE__),
+  file_name: 'variable_field_invoice_a4.pdf',
+  page_size: :a4
+)