invoice_printer 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6529faa82615534d3264b96cd81e8402fb46543f
-  data.tar.gz: 39685b41d40e812c7b83d95994e1dfad9dafe5ed
+  metadata.gz: 63f93d4c152d2abbbae2b1b8ceb8eb5dfd8be827
+  data.tar.gz: a1c352ad082498294f84bd041768e7a7c3f47e63
 SHA512:
-  metadata.gz: 6b180c62070d36ab9d1ad80db58e583bfd43068daf8b1dfbb4acd7129b50d84e50d47f5ecf2ca7cb9e5d689f1ce84f4f21174ce1b9baaa60db8d6b37018ab375
-  data.tar.gz: 988a1f21746a489cf0f350208e2b985e1a72995667f6f31c5a9fdab51370cce7919022126ef3f8696af04e0e92d5f260fea8a49419e1ee23bba117c3e4a29916
+  metadata.gz: f2fbdf0d91fcd1fbd6b478b4e6a9325697a02d355d3e7b03c3e4d5f1c0f6be60b62f8e66f410bbe9d64e219b052d72786f2fb60de83dbc2b08fcf8af21916013
+  data.tar.gz: 828eff18046495b5bf2e4481715524c8742444af0722b11e74fe0158b8f792c63183588313e8159e0a99c9ed2a1850f1af05e90930c126d87f5fe7d6b52910b0

data/README.md

@@ -23,6 +23,7 @@ See more usecases in the `examples/` directory.
 - Configurable labels
 - Configurable font file
 - Logotype
+- Stamp & signature (as image)
 - Note
 - Well tested
 
@@ -78,8 +79,8 @@ item = InvoicePrinter::Document::Item.new(
 invoice = InvoicePrinter::Document.new(
   number: '201604030001',
   provider_name: 'Business s.r.o.',
-  provider_ic: '56565656',
-  provider_dic: '465454',
+  provider_tax_id: '56565656',
+  provider_tax_id2: '465454',
   provider_street: 'Rolnicka',
   provider_street_number: '1',
   provider_postcode: '747 05',
@@ -87,8 +88,8 @@ invoice = InvoicePrinter::Document.new(
   provider_city_part: 'Katerinky',
   provider_extra_address_line: 'Czech Republic',
   purchaser_name: 'Adam',
-  purchaser_ic: '',
-  purchaser_dic: '',
+  purchaser_tax_id: '',
+  purchaser_tax_id2: '',
   purchaser_street: 'Ostravska',
   purchaser_street_number: '1',
   purchaser_postcode: '747 70',
@@ -139,8 +140,8 @@ InvoicePrinter.labels = {
   name: 'Invoice'
   provider: 'Provider',
   purchaser: 'Purchaser',
-  ic: 'Identification number',
-  dic: 'Identification number',
+  tax_id: 'Identification number',
+  tax_id2: 'Identification number',
   payment: 'Payment',
   payment_by_transfer: 'Payment by bank transfer on the account below:',
   payment_in_cash: 'Payment in cash',

data/examples/czech_invoice.rb

@@ -12,8 +12,8 @@ labels = {
   name: 'Faktura',
   provider: 'Prodejce',
   purchaser: 'Kupující',
-  ic: 'IČ',
-  dic: 'DIČ',
+  tax_id: 'IČ',
+  tax_id2: 'DIČ',
   payment: 'Forma úhrady',
   payment_by_transfer: 'Platba na následující účet:',
   account_number: 'Číslo účtu',
@@ -48,7 +48,7 @@ second_item = InvoicePrinter::Document::Item.new(
 invoice = InvoicePrinter::Document.new(
   number: 'č. 198900000001',
   provider_name: 'Petr Nový',
-  provider_ic: '56565656',
+  provider_tax_id: '56565656',
   provider_street: 'Rolnická',
   provider_street_number: '1',
   provider_postcode: '747 05',

data/examples/simple_invoice.rb

@@ -35,5 +35,6 @@ invoice = InvoicePrinter::Document.new(
 
 InvoicePrinter.print(
   document: invoice,
+  logo: 'example.jpg',
   file_name: 'simple_invoice.pdf'
 )

data/lib/invoice_printer.rb

@@ -10,7 +10,8 @@ require 'invoice_printer/pdf_document'
 #   InvoicePrinter.print(
 #     document: invoice,
 #     font: 'path-to-font-file.ttf',
-#     logo: 'logo.jpg'
+#     stamp: 'stamp.jpg',
+#     logo: 'logo.jpg',
 #     file_name: 'invoice.pdf'
 #   )
 module InvoicePrinter
@@ -46,21 +47,36 @@ module InvoicePrinter
   end
 
   # Print the given InvoicePrinter::Document to PDF file named +file_name+
-  def self.print(document:, file_name:, labels: {}, font: nil, logo: nil)
+  #
+  # document - InvoicePrinter::Document object
+  # file_name - output file
+  # labels - labels to override
+  # font - font file to use
+  # stamp - stamp & signature (image)
+  # logo - logotype (image)
+  def self.print(document:, file_name:, labels: {}, font: nil, stamp: nil, logo: nil)
     PDFDocument.new(
       document: document,
       labels: labels,
       font: font,
+      stamp: stamp,
       logo: logo,
     ).print(file_name)
   end
 
   # Render the PDF document InvoicePrinter::Document to PDF directly
-  def self.render(document:, labels: {}, font: nil, logo: nil)
+  #
+  # document - InvoicePrinter::Document object
+  # labels - labels to override
+  # font - font file to use
+  # stamp - stamp & signature (image)
+  # logo - logotype (image)
+  def self.render(document:, labels: {}, font: nil, stamp: nil, logo: nil)
     PDFDocument.new(
       document: document,
       labels: labels,
       font: font,
+      stamp: stamp,
       logo: logo
     ).render
   end

data/lib/invoice_printer/document.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module InvoicePrinter
   # Invoice and receipt representation
   #
@@ -6,8 +8,8 @@ module InvoicePrinter
   #   invoice = InvoicePrinter::Document.new(
   #     number: '198900000001',
   #     provider_name: 'Business s.r.o.',
-  #     provider_ic: '56565656',
-  #     provider_dic: '465454',
+  #     provider_tax_id: '56565656',
+  #     provider_tax_id2: '465454',
   #     provider_street: 'Rolnicka',
   #     provider_street_number: '1',
   #     provider_postcode: '747 05',
@@ -15,8 +17,8 @@ module InvoicePrinter
   #     provider_city_part: 'Katerinky',
   #     provider_extra_address_line: 'Czech Republic',
   #     purchaser_name: 'Adam',
-  #     purchaser_ic: '',
-  #     purchaser_dic: '',
+  #     purchaser_tax_id: '',
+  #     purchaser_tax_id2: '',
   #     purchaser_street: 'Ostravska',
   #     purchaser_street_number: '1',
   #     purchaser_postcode: '747 70',
@@ -46,8 +48,8 @@ module InvoicePrinter
     attr_reader :number,
                 # Provider fields
                 :provider_name,
-                :provider_ic,
-                :provider_dic,
+                :provider_tax_id,
+                :provider_tax_id2,
                 # Provider address fields
                 :provider_street,
                 :provider_street_number,
@@ -57,8 +59,8 @@ module InvoicePrinter
                 :provider_extra_address_line,
                 # Purchaser fields
                 :purchaser_name,
-                :purchaser_ic,
-                :purchaser_dic,
+                :purchaser_tax_id,
+                :purchaser_tax_id2,
                 # Purchaser address fields
                 :purchaser_street,
                 :purchaser_street_number,
@@ -83,8 +85,8 @@ module InvoicePrinter
 
     def initialize(number: nil,
                    provider_name: nil,
-                   provider_ic: nil,
-                   provider_dic: nil,
+                   provider_tax_id: nil,
+                   provider_tax_id2: nil,
                    provider_street: nil,
                    provider_street_number: nil,
                    provider_postcode: nil,
@@ -92,8 +94,8 @@ module InvoicePrinter
                    provider_city_part: nil,
                    provider_extra_address_line: nil,
                    purchaser_name: nil,
-                   purchaser_ic: nil,
-                   purchaser_dic: nil,
+                   purchaser_tax_id: nil,
+                   purchaser_tax_id2: nil,
                    purchaser_street: nil,
                    purchaser_street_number: nil,
                    purchaser_postcode: nil,
@@ -114,8 +116,8 @@ module InvoicePrinter
                    note: nil)
       @number = String(number)
       @provider_name = String(provider_name)
-      @provider_ic = String(provider_ic)
-      @provider_dic = String(provider_dic)
+      @provider_tax_id = String(provider_tax_id)
+      @provider_tax_id2 = String(provider_tax_id2)
       @provider_street = String(provider_street)
       @provider_street_number = String(provider_street_number)
       @provider_postcode = String(provider_postcode)
@@ -123,8 +125,8 @@ module InvoicePrinter
       @provider_city_part = String(provider_city_part)
       @provider_extra_address_line = String(provider_extra_address_line)
       @purchaser_name = String(purchaser_name)
-      @purchaser_ic = String(purchaser_ic)
-      @purchaser_dic = String(purchaser_dic)
+      @purchaser_tax_id = String(purchaser_tax_id)
+      @purchaser_tax_id2 = String(purchaser_tax_id2)
       @purchaser_street = String(purchaser_street)
       @purchaser_street_number = String(purchaser_street_number)
       @purchaser_postcode = String(purchaser_postcode)
@@ -152,8 +154,8 @@ module InvoicePrinter
       {
         'number': @number,
         'provider_name': @provider_name,
-        'provider_ic': @provider_ic,
-        'provider_dic': @provider_dic,
+        'provider_tax_id': @provider_tax_id,
+        'provider_tax_id2': @provider_tax_id2,
         'provider_street': @provider_street,
         'provider_street_number': @provider_street_number,
         'provider_postcode': @provider_postcode,
@@ -161,8 +163,8 @@ module InvoicePrinter
         'provider_city_part': @provider_city_part,
         'provider_extra_address_line': @provider_extra_address_line,
         'purchaser_name': @purchaser_name,
-        'purchaser_ic': @purchaser_ic,
-        'purchaser_dic': @purchaser_dic,
+        'purchaser_tax_id': @purchaser_tax_id,
+        'purchaser_tax_id2': @purchaser_tax_id2,
         'purchaser_street': @purchaser_street,
         'purchaser_street_number': @purchaser_street_number,
         'purchaser_postcode': @purchaser_postcode,

data/lib/invoice_printer/document/item.rb

@@ -44,6 +44,23 @@ module InvoicePrinter
         @tax3 = String(tax3)
         @amount = String(amount)
       end
+
+      def to_h
+        {
+          'name': @name,
+          'quantity': @quantity,
+          'unit': @unit,
+          'price': @price,
+          'tax': @tax,
+          'tax2': @tax2,
+          'tax3': @tax3,
+          'amount': @amount,
+        }
+      end
+
+      def to_json
+        to_h.to_json
+      end
     end
   end
 end

data/lib/invoice_printer/pdf_document.rb

@@ -11,6 +11,7 @@ module InvoicePrinter
   #     document: invoice,
   #     labels: {},
   #     font: 'font.ttf',
+  #     stamp: 'stamp.jpg',
   #     logo: 'example.jpg'
   #   )
   class PDFDocument
@@ -18,14 +19,14 @@ module InvoicePrinter
     class LogoFileNotFound < StandardError; end
     class InvalidInput < StandardError; end
 
-    attr_reader :invoice, :labels, :file_name, :font, :logo
+    attr_reader :invoice, :labels, :file_name, :font, :stamp, :logo
 
     DEFAULT_LABELS = {
       name: 'Invoice',
       provider: 'Provider',
       purchaser: 'Purchaser',
-      ic: 'Identification number',
-      dic: 'Identification number',
+      tax_id: 'Identification number',
+      tax_id2: 'Identification number',
       payment: 'Payment',
       payment_by_transfer: 'Payment by bank transfer on the account below:',
       payment_in_cash: 'Payment in cash',
@@ -54,11 +55,12 @@ module InvoicePrinter
       @@labels = DEFAULT_LABELS.merge(labels)
     end
 
-    def initialize(document: Document.new, labels: {}, font: nil, logo: nil)
+    def initialize(document: Document.new, labels: {}, font: nil, stamp: nil, logo: nil)
       @document = document
       @labels = PDFDocument.labels.merge(labels)
       @pdf = Prawn::Document.new
       @font = font
+      @stamp = stamp
       @logo = logo
 
       raise InvalidInput, 'document is not a type of InvoicePrinter::Document' \
@@ -121,6 +123,7 @@ module InvoicePrinter
       build_info_box
       build_items
       build_total
+      build_stamp
       build_logo
       build_note
       build_footer
@@ -205,17 +208,17 @@ module InvoicePrinter
           width: 240
         )
       end
-      unless @document.provider_ic.empty?
+      unless @document.provider_tax_id.empty?
         @pdf.text_box(
-          "#{@labels[:ic]}:    #{@document.provider_ic}",
+          "#{@labels[:tax_id]}:    #{@document.provider_tax_id}",
           size: 10,
           at: [10, 550 - @push_down],
           width: 240
         )
       end
-      unless @document.provider_dic.empty?
+      unless @document.provider_tax_id2.empty?
         @pdf.text_box(
-          "#{@labels[:dic]}:    #{@document.provider_dic}",
+          "#{@labels[:tax_id2]}:    #{@document.provider_tax_id2}",
           size: 10,
           at: [10, 535 - @push_down],
           width: 240
@@ -284,17 +287,17 @@ module InvoicePrinter
           width: 240
         )
       end
-      unless @document.purchaser_ic.empty?
+      unless @document.purchaser_tax_id2.empty?
         @pdf.text_box(
-          "#{@labels[:ic]}:    #{@document.purchaser_ic}",
+          "#{@labels[:tax_id2]}:    #{@document.purchaser_tax_id2}",
           size: 10,
           at: [290, 550 - @push_down],
           width: 240
         )
       end
-      unless @document.purchaser_dic.empty?
+      unless @document.purchaser_tax_id.empty?
         @pdf.text_box(
-          "#{@labels[:dic]}:    #{@document.purchaser_dic}",
+          "#{@labels[:tax_id]}:    #{@document.purchaser_tax_id}",
           size: 10,
           at: [290, 535 - @push_down],
           width: 240
@@ -570,6 +573,14 @@ module InvoicePrinter
       @pdf.image(@logo, at: [0, bottom]) if @logo && !@logo.empty?
     end
 
+    # Insert a stamp (with signature) after the total table
+    def build_stamp
+      if @stamp && !@stamp.empty?
+        @pdf.move_down(15)
+        @pdf.image(@stamp, position: :right)
+      end
+    end
+
     # Note at the end
     def build_note
       @pdf.text_box(

data/lib/invoice_printer/version.rb

@@ -1,3 +1,3 @@
 module InvoicePrinter
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/test/inputs_test.rb

@@ -21,10 +21,10 @@ class InputsTest < Minitest::Test
 
   def test_non_string_inputs_are_converted_to_strings
     params = default_document_params.merge(
-      provider_ic: 12345678910,
-      provider_dic: 12345678910,
-      purchaser_ic: 12345678910,
-      purchaser_dic: 12345678910
+      provider_tax_id: 12345678910,
+      provider_tax_id2: 12345678910,
+      purchaser_tax_id: 12345678910,
+      purchaser_tax_id2: 12345678910
     )
 
     # No exceptions should be raised

data/test/test_ext.rb

@@ -30,10 +30,10 @@ module InvoicePrinter
       strings << @document.provider_city
       strings << @document.provider_city_part
       strings << @document.provider_extra_address_line
-      strings << "#{@labels[:ic]}:    #{@document.provider_ic}" \
-        unless @document.provider_ic.empty?
-      strings << "#{@labels[:dic]}:    #{@document.provider_dic}" \
-        unless @document.provider_dic.empty?
+      strings << "#{@labels[:tax_id]}:    #{@document.provider_tax_id}" \
+        unless @document.provider_tax_id.empty?
+      strings << "#{@labels[:tax_id2]}:    #{@document.provider_tax_id2}" \
+        unless @document.provider_tax_id2.empty?
       strings
     end
 
@@ -47,10 +47,10 @@ module InvoicePrinter
       strings << @document.purchaser_city
       strings << @document.purchaser_city_part
       strings << @document.purchaser_extra_address_line
-      strings << "#{@labels[:ic]}:    #{@document.purchaser_ic}" \
-        unless @document.purchaser_ic.empty?
-      strings << "#{@labels[:dic]}:    #{@document.purchaser_dic}" \
-        unless @document.purchaser_dic.empty?
+      strings << "#{@labels[:tax_id]}:    #{@document.purchaser_tax_id}" \
+        unless @document.purchaser_tax_id.empty?
+      strings << "#{@labels[:tax_id2]}:    #{@document.purchaser_tax_id2}" \
+        unless @document.purchaser_tax_id2.empty?
       strings
     end
 

data/test/test_helper.rb

@@ -9,8 +9,8 @@ module InvoicePrinterHelpers
     {
       number: '198900000001',
       provider_name: 'Business s.r.o.',
-      provider_ic: '56565656',
-      provider_dic: '465454',
+      provider_tax_id: '56565656',
+      provider_tax_id2: '465454',
       provider_street: 'Rolnicka',
       provider_street_number: '1',
       provider_postcode: '747 05',
@@ -18,8 +18,8 @@ module InvoicePrinterHelpers
       provider_city_part: 'Katerinky',
       provider_extra_address_line: 'Czech Republic',
       purchaser_name: 'Adam',
-      purchaser_ic: nil,
-      purchaser_dic: nil,
+      purchaser_tax_id: nil,
+      purchaser_tax_id2: nil,
       purchaser_street: 'Ostravska',
       purchaser_street_number: '1',
       purchaser_postcode: '747 70',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invoice_printer
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Josef Strzibny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-06 00:00:00.000000000 Z
+date: 2016-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -133,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Super simple PDF invoicing in pure Ruby