invoice_printer 1.0.0 → 1.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68dd28c7401462152f32f64078ec6ec4bc6c1c20
-  data.tar.gz: 3485ac3d5c69314d76ea634456ef9f468c08d928
+  metadata.gz: bbd94bf5220a80cfe9001aaa3f4de3280a55341b
+  data.tar.gz: e008c681ad05e8af4e21cd434c1d3646d954b3ca
 SHA512:
-  metadata.gz: d525aa420194f46dbcb91f18938ed7930bf84910ff07b07c8bbb0002418faddfaa8840b42e52f5c76b7da8a7bd06f4957850c3761270629bd56b1d7e58f504c8
-  data.tar.gz: c5f6d1afa08840f2eba50b83b54def3bb65799c07e5c66e04138a9cd625bea5d70c70977994802a24437db29960c9818f9b7b12068a3bd40244e2cc683481988
+  metadata.gz: a0382b87d579e861ef8c22cb2f676b065f4eec8fa21223af9822a601ffc8ffba3aa90c1259a1bc528697b472139b01a55bee7876e3e57e005c760c84ed65b9ef
+  data.tar.gz: de82e8d3c3c1d40602b682240f38985564fa8b05dd77a997b3fa29ee107c6968902f7a2e229e097bc6da4b1fc05ff9eba1558ed2afb8be793233007f8b98273e

data/README.md

@@ -4,13 +4,13 @@
 
  
 
-Super simple PDF invoicing in pure Ruby (based on Prawn library).
+Super simple PDF invoicing in pure Ruby
 
-InvoicePrinter does not impose any validations nor calculations on you. It is
-designed only to provide an interface to build the PDF version of these documents.
+InvoicePrinter is a Ruby library and a command line program. You can use Ruby or JSON to build the final PDF.
 
 ## Features
 
+- A4 and US letter paper size
 - Invoice/document name and number
 - Purchaser and provider boxes with addresses and identificaton numbers
 - Payment method box showing banking details including SWIFT and IBAN fields
@@ -24,6 +24,8 @@ designed only to provide an interface to build the PDF version of these document
 - Background (as image)
 - Stamp & signature (as image)
 - Note
+- JSON format
+- CLI
 - Well tested
 
 ## Example
@@ -144,8 +146,63 @@ def show
 end
 ```
 
+### JSON format
+
+JSON format is supported via `from_json` method. JSON itself mimicks the original Ruby objects:
+
+```ruby
+json = InvoicePrinter::Document.new(...).to_json
+document = InvoicePrinter::Document.from_json(json)
+
+
+InvoicePrinter.print(
+  document:  document,
+  ...
+)
+
+```
+
+## CLI
+
+InvoicePrinter ships with a command line executable called `invoice_printer`.
+
+It supports all features except it only accepts JSON as an input.
+
+```
+$ invoice_printer --help
+Usage: invoice_printer [options]
+
+Options:
+
+    -l, --labels   labels as JSON
+  -d, --document   document as JSON
+     -s, --stamp   path to stamp
+          --logo   path to logotype
+          --font   path to font
+     --page_size   letter or a4 (letter is the default)
+  -f, --filename   output path
+    -r, --render   directly render PDF stream (filename option will be ignored)
+```
+
+
 ## Customization
 
+### Page size
+
+Both A4 and US letter is supported. Just pass `page_size` as an argument to `print` or `render` methods:
+
+```ruby
+InvoicePrinter.print(
+  document: invoice,
+  labels: labels,
+  page_size: :a4,
+  file_name: 'invoice.pdf'
+)
+```
+
+`:letter` is the default.
+
+
 ### Localization
 
 To localize your documents you can set both global defaults or instance
@@ -172,7 +229,7 @@ to `initializers/invoice_printer.rb` if you are using Rails.
 
 ```ruby
 InvoicePrinter.labels = {
-  name: 'Invoice'
+  name: 'Invoice',
   provider: 'Provider',
   purchaser: 'Purchaser',
   tax_id: 'Identification number',
@@ -193,7 +250,7 @@ InvoicePrinter.labels = {
   tax: 'Tax',
   tax2: 'Tax 2',
   tax3: 'Tax 3',
-  subtotal: 'Subtotal'
+  subtotal: 'Subtotal',
   total: 'Total'
 }
 ```

data/bin/invoice_printer

@@ -0,0 +1,140 @@
+#!/usr/bin/env ruby
+$LOAD_PATH << File.expand_path('lib')
+
+require 'optparse'
+require 'json'
+require 'invoice_printer'
+
+def show_version
+  puts "InvoicePrinter v#{InvoicePrinter::VERSION}"
+
+  exit 0
+end
+
+def show_help
+  puts <<~HELP
+    Usage: invoice_printer [options]
+
+    Options:
+
+        -l, --labels   labels as JSON
+      -d, --document   document as JSON
+         -s, --stamp   path to stamp
+              --logo   path to logotype
+              --font   path to font
+         --page-size   letter or a4 (letter is the default)
+      -f, --filename   output path
+        -r, --render   directly render PDF stream (filename option will be ignored)
+
+  HELP
+
+  exit 0
+end
+
+options = {}
+
+parser = OptionParser.new do|opts|
+	opts.banner = "Usage: invoice_printer [options]"
+
+  opts.on('-l', '--labels JSON') do |json|
+    options[:labels] = json
+  end
+
+  opts.on('-d', '--document JSON') do |json|
+    options[:document] = json
+  end
+
+  opts.on('-s', '--stamp PATH') do |path|
+    options[:stamp] = path
+  end
+
+  opts.on('--logo PATH') do |path|
+    options[:logo] = path
+  end
+
+  opts.on('--font PATH') do |path|
+    options[:font] = path
+  end
+
+  opts.on('--page-size OPTION') do |option|
+    options[:page_size] = option.to_sym
+  end
+
+  opts.on('-f', '--filename PATH') do |path|
+    options[:filename] = path
+  end
+
+  opts.on('-r', '--render') do
+    options[:render] = true
+  end
+
+  opts.on('-v', '--version') do
+    show_version
+  end
+
+  opts.on('--debug') do
+    options[:debug] = true
+  end
+
+  opts.on('-h', '--help') do
+    show_help
+  end
+end
+
+begin
+  parser.parse!
+
+  show_help if options.empty?
+
+  # Defaults
+  options[:page_size] ||= :letter
+
+  raise '--document not provided' unless options[:document]
+
+  begin
+    json     = JSON.parse options[:document]
+    document = InvoicePrinter::Document.from_json(json)
+  rescue => e
+    STDERR.puts "ERROR: parsing JSON failed. Invalid JSON?"
+
+    if options[:debug]
+      STDERR.puts
+      STDERR.puts e.message
+      STDERR.puts e.backtrace
+    end
+
+    exit 1
+  end
+
+  if options[:render]
+    stream = InvoicePrinter.render(
+      document:  document,
+      font:      options[:font],
+      stamp:     options[:stamp],
+      logo:      options[:logo],
+      page_size: options[:page_size]
+    )
+
+    puts stream
+  else
+    raise '--filename not provided. Use --render if you with to render to STDOUT.' unless options[:filename]
+
+    InvoicePrinter.print(
+      document:  document,
+      font:      options[:font],
+      stamp:     options[:stamp],
+      logo:      options[:logo],
+      file_name: options[:filename],
+      page_size: options[:page_size]
+    )
+  end
+rescue => e
+  STDERR.puts "ERROR: #{e.message}"
+
+  if options[:debug]
+    STDERR.puts
+    STDERR.puts e.backtrace
+  end
+
+  exit 1
+end

data/examples/complex_invoice.rb

@@ -19,7 +19,7 @@ item = InvoicePrinter::Document::Item.new(
 )
 
 item2 = InvoicePrinter::Document::Item.new(
-  name: 'Consolting',
+  name: 'Consulting',
   quantity: '10',
   unit: 'hr',
   price: '$ 30',
@@ -66,3 +66,13 @@ InvoicePrinter.print(
   file_name: 'complex_invoice.pdf',
   background: 'background.png'
 )
+
+InvoicePrinter.print(
+  document: invoice,
+  labels: labels,
+  stamp: 'stamp.png',
+  logo: 'prawn.png',
+  file_name: 'complex_invoice_a4.pdf',
+  background: 'background.png',
+  page_size: :a4
+)

data/examples/czech_invoice.rb

@@ -49,6 +49,7 @@ invoice = InvoicePrinter::Document.new(
   number: 'č. 198900000001',
   provider_name: 'Petr Nový',
   provider_tax_id: '56565656',
+  provider_tax_id2: 'CZ56565656',
   provider_street: 'Rolnická',
   provider_street_number: '1',
   provider_postcode: '747 05',
@@ -59,6 +60,8 @@ invoice = InvoicePrinter::Document.new(
   purchaser_street_number: '1',
   purchaser_postcode: '747 70',
   purchaser_city: 'Opava',
+  purchaser_tax_id: '56565656',
+  purchaser_tax_id2: 'CZ56565656',
   issue_date: '05/03/2016',
   due_date: '19/03/2016',
   subtotal: 'Kč 10.000',
@@ -78,3 +81,12 @@ InvoicePrinter.print(
   logo: 'prawn.png',
   file_name: 'czech_invoice.pdf'
 )
+
+InvoicePrinter.print(
+  document: invoice,
+  labels: labels,
+  font: File.expand_path('../Overpass-Regular.ttf', __FILE__),
+  logo: 'prawn.png',
+  file_name: 'czech_invoice_a4.pdf',
+  page_size: :a4
+)

data/examples/international_invoice.rb

@@ -82,3 +82,12 @@ InvoicePrinter.print(
   logo: 'prawn.png',
   file_name: 'international_invoice.pdf'
 )
+
+InvoicePrinter.print(
+  document: invoice,
+  labels: labels,
+  font: File.expand_path('../Overpass-Regular.ttf', __FILE__),
+  logo: 'prawn.png',
+  file_name: 'international_invoice_a4.pdf',
+  page_size: :a4
+)

data/examples/long_invoice.rb

@@ -19,7 +19,7 @@ item = InvoicePrinter::Document::Item.new(
 )
 
 item2 = InvoicePrinter::Document::Item.new(
-  name: 'Consolting',
+  name: 'Consulting',
   quantity: '10',
   unit: 'hr',
   price: '$ 30',
@@ -64,5 +64,13 @@ InvoicePrinter.print(
   stamp: 'stamp.png',
   logo: 'prawn.png',
   file_name: 'long_invoice.pdf'
+)
 
+InvoicePrinter.print(
+  document: invoice,
+  labels: labels,
+  stamp: 'stamp.png',
+  logo: 'prawn.png',
+  file_name: 'long_invoice_a4.pdf',
+  page_size: :a4
 )

data/examples/promo.rb

@@ -82,3 +82,12 @@ InvoicePrinter.print(
   logo: 'logo.png',
   file_name: 'promo.pdf'
 )
+
+InvoicePrinter.print(
+  document: invoice,
+  labels: labels,
+  font: File.expand_path('../Overpass-Regular.ttf', __FILE__),
+  logo: 'logo.png',
+  file_name: 'promo_a4.pdf',
+  page_size: :a4
+)

data/examples/simple_invoice.rb

@@ -38,3 +38,10 @@ InvoicePrinter.print(
   logo: 'prawn.png',
   file_name: 'simple_invoice.pdf'
 )
+
+InvoicePrinter.print(
+  document: invoice,
+  logo: 'prawn.png',
+  file_name: 'simple_invoice_a4.pdf',
+  page_size: :a4
+)

data/invoice_printer.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
+  spec.bindir        = 'bin'
 
   spec.add_dependency 'json', '~> 2.1'
   spec.add_dependency 'prawn', '2.1.0'

data/lib/invoice_printer/document/item.rb

@@ -27,34 +27,50 @@ module InvoicePrinter
                   :tax3,
                   :amount
 
-      def initialize(name: nil,
+      class << self
+        def from_json(json)
+          new(
+            name:     json['name'],
+            quantity: json['quantity'],
+            unit:     json['unit'],
+            price:    json['price'],
+            tax:      json['tax'],
+            tax2:     json['tax2'],
+            tax3:     json['tax3'],
+            amount:   json['amount']
+          )
+        end
+      end
+
+      def initialize(name:     nil,
                      quantity: nil,
-                     unit: nil,
-                     price: nil,
-                     tax: nil,
-                     tax2: nil,
-                     tax3: nil,
-                     amount: nil)
-        @name = String(name)
+                     unit:     nil,
+                     price:    nil,
+                     tax:      nil,
+                     tax2:     nil,
+                     tax3:     nil,
+                     amount:   nil)
+
+        @name     = String(name)
         @quantity = String(quantity)
-        @unit = String(unit)
-        @price = String(price)
-        @tax = String(tax)
-        @tax2 = String(tax2)
-        @tax3 = String(tax3)
-        @amount = String(amount)
+        @unit     = String(unit)
+        @price    = String(price)
+        @tax      = String(tax)
+        @tax2     = String(tax2)
+        @tax3     = String(tax3)
+        @amount   = String(amount)
       end
 
       def to_h
         {
-          'name': @name,
+          'name':     @name,
           'quantity': @quantity,
-          'unit': @unit,
-          'price': @price,
-          'tax': @tax,
-          'tax2': @tax2,
-          'tax3': @tax3,
-          'amount': @amount,
+          'unit':     @unit,
+          'price':    @price,
+          'tax':      @tax,
+          'tax2':     @tax2,
+          'tax3':     @tax3,
+          'amount':   @amount,
         }
       end