ubl 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7910f61d2fb9d3441defbd3a471c8dee214fcc2328430ddc74564e03839e02f
-  data.tar.gz: 94702d68716de735e38896e7c927fadb216917f422b1ed9cc58f8aac697541aa
+  metadata.gz: 07e7d21d74c69ab965fe5a9968fd7404629079233b2fd6554e7fac2f51aff5e6
+  data.tar.gz: e13d2459ed88883a5206449565fb665bee8a59a097bbccf489c975be4ace1489
 SHA512:
-  metadata.gz: 274419fa7cbf69522f8ba6ade35415aead6750e63efce27f623e136accb2705dd29fc339dfcdfea63f9a9a16fcf0bd3587ef07e46aa3d073048af2724ed6d19b
-  data.tar.gz: 52e29b3ecaa743ea11d525f743ec0de05207a4c0d2980509ee9ec53fd2ccffb8a6901ab4758ec9fcdc99713ca16411d483cd73fa63e05605dba5ac736a957496
+  metadata.gz: 02d979487d2aafb9c96ab9ce923cb19f1821fd8850f8766a584ff0b5f06f86d5993747c0378c1eff62ef701518fe40876915d2234477f52bcb8e4c41660ef6f1
+  data.tar.gz: 73a22110aa073edce5165461c9883ec1796d92e5ded7b320de8c0de220d82f6755f2407e74fe9bd43dd95f545ca19390e78e1e3d17d518fdb8db284a1ae9f2c8

data/README.md

@@ -2,7 +2,7 @@
 
 # Ubl
 
-Generate UBL (Universal Business Language) documents, such as invoices and credit notes, compliant with the Peppol network.
+Generate and validate UBL (Universal Business Language) documents, such as invoices and credit notes, compliant with the Peppol network.
 
 ## installation
 
@@ -51,6 +51,20 @@ invoice.add_line(name: "Software License", quantity: 1, unit_price: 500.0, tax_r
 invoice.build
 ```
 
+If you need the UBL.BE version:
+```ruby
+invoice = Ubl::Invoice.new("UBL_BE")
+```
+
+You can also validate the result. 
+You need Docker for the schematron validation. (https://github.com/roel4d/peppol_schematron)
+With `schematron: false` you can disable this and only the xsd validation will run.
+```ruby
+Tempfile.create("invoice.xml") do |invoice_file|
+  File.write(invoice_file, content)
+  p Ubl.validate_invoice(invoice_file.path, extension: "UBL_BE", schematron: true)
+end
+```
 
 ## development
 

data/lib/ubl/builder.rb

@@ -3,18 +3,15 @@
 require "nokogiri"
 require "date"
 require "base64"
+require_relative "constants"
 
 module Ubl
   class UblBuilder
     attr_accessor :invoice_nr, :issue_date, :due_date, :currency, :supplier,
       :customer, :invoice_lines, :tax_total, :legal_monetary_total, :pdffile
 
-    CUSTOMIZATION_ID = "urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0"
-    CUSTOMIZATION_UBL_BE = "urn:cen.eu:en16931:2017#conformant#urn:UBL.BE:1.0.0.20180214"
-    PROFILE_ID = "urn:fdc:peppol.eu:2017:poacc:billing:01:1.0"
-
     def initialize(extension = nil)
-      @ubl_be = extension == "UBL_BE"
+      @ubl_be = extension == UBL_BE
       @issue_date = Date.today
       @due_date = @issue_date + 30
       @currency = "EUR"
@@ -54,6 +51,13 @@ module Ubl
       }
     end
 
+    def add_payment_means(iban:, bic:)
+      @payment_means = {
+        iban: iban,
+        bic: bic
+      }
+    end
+
     def add_line(name:, quantity:, unit_price:, tax_rate: 21.0, unit: "ZZ")
       line_extension_amount = (quantity * unit_price).round(2)
       tax_amount = (line_extension_amount * (tax_rate / 100.0)).round(2)
@@ -114,6 +118,15 @@ module Ubl
       end
     end
 
+    def build_content(xml)
+      build_party(xml, @supplier, "AccountingSupplierParty")
+      build_party(xml, @customer, "AccountingCustomerParty")
+      build_payment_means(xml)
+      build_tax_total(xml)
+      build_monetary_total(xml)
+      build_invoice_lines(xml)
+    end
+
     def add_attachment(id, filename)
       @attachments << {id: id, content:}
     end
@@ -255,5 +268,19 @@ module Ubl
         xml["cbc"].PayableAmount(currencyID: @currency) { xml.text sprintf("%.2f", @legal_monetary_total) }
       end
     end
+
+    def build_payment_means(xml)
+      return unless @payment_means
+
+      xml["cac"].PaymentMeans do
+        xml["cbc"].PaymentMeansCode "1"
+        xml["cac"].PayeeFinancialAccount do
+          xml["cbc"].ID @payment_means[:iban]
+          xml["cac"].FinancialInstitutionBranch do
+            xml["cbc"].ID @payment_means[:bic]
+          end
+        end
+      end
+    end
   end
 end

data/lib/ubl/constants.rb

@@ -0,0 +1,6 @@
+module Ubl
+  CUSTOMIZATION_ID = "urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0"
+  CUSTOMIZATION_UBL_BE = "urn:cen.eu:en16931:2017#conformant#urn:UBL.BE:1.0.0.20180214"
+  PROFILE_ID = "urn:fdc:peppol.eu:2017:poacc:billing:01:1.0"
+  UBL_BE = "UBL_BE"
+end

data/lib/ubl/validate.rb

@@ -0,0 +1,78 @@
+require "nokogiri"
+require "date"
+require "fileutils"
+require "colorize"
+require_relative "constants"
+
+module Ubl
+  class Validator
+    def initialize(extension: nil, schematron: true)
+      @ubl_be = extension == UBL_BE
+      @schematron = schematron
+    end
+
+    def validate_invoice(path)
+      xsd = File.join(__dir__, "../../xsd/maindoc/UBL-Invoice-2.1.xsd")
+      validate(path, xsd)
+    end
+
+    def validate_credit_note(path)
+      xsd = File.join(__dir__, "../../xsd/maindoc/UBL-CreditNote-2.1.xsd")
+      validate(path, xsd)
+    end
+
+    private
+
+    def validate(path, xsd)
+      ubl_content = File.read(path)
+      errors = validate_xsd(ubl_content, xsd)
+      return errors if errors.any?
+
+      errors = validate_schematron(path) if @schematron
+
+      errors
+    end
+
+    def validate_xsd(xml_content, xsd)
+      return ["XSD not found: #{xsd}"] unless File.exist?(xsd)
+
+      begin
+        xml_doc = Nokogiri::XML(xml_content)
+        xsd_doc = Nokogiri::XML::Schema(File.open(xsd))
+        errors = xsd_doc.validate(xml_doc)
+        errors.map(&:message)
+      rescue => e
+        ["XSD validation error: #{e.message}"]
+      end
+    end
+
+    def validate_schematron(invoice_file)
+      env = @ubl_be ? "-e UBL_BE=true" : ""
+      cmd = "docker run --rm #{env} -v #{invoice_file}:/app/invoice.xml:ro ghcr.io/roel4d/peppol_schematron:latest 2>/dev/null"
+      # puts cmd
+      svrl_content = `#{cmd}`
+      parse_svrl_errors(svrl_content)
+    end
+
+    def get_svrl_errors(svrl_doc, flag, color)
+      errors = []
+      svrl_doc.xpath("//failed-assert[@flag=\"#{flag}\"]").each do |node|
+        test = node["test"].squeeze(" ")
+        # location = node['location']
+        text = node.xpath("text").map(&:content).join(" ").tr("\n", " ").squeeze(" ").strip
+        errors << flag.colorize(color) + ": #{text}\n       #{test.colorize(:grey)}"
+      end
+      errors
+    end
+
+    # Parse SVRL (Schematron Validation Report Language) output for errors
+    def parse_svrl_errors(svrl_content)
+      svrl_doc = Nokogiri::XML(svrl_content)
+      svrl_doc.remove_namespaces!
+      errors = []
+      errors << get_svrl_errors(svrl_doc, "fatal", :red)
+      errors << get_svrl_errors(svrl_doc, "warning", :light_red)
+      errors.flatten
+    end
+  end
+end

data/lib/ubl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ubl
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/ubl.rb

@@ -1,7 +1,8 @@
 require_relative "ubl/builder"
+require_relative "ubl/validate"
 
 ##
-# Generate UBL (Universal Business Language) documents,
+# Generate and validate UBL (Universal Business Language) documents,
 # such as invoices and credit notes, compliant with the Peppol network.
 module Ubl
   class Invoice < UblBuilder
@@ -22,15 +23,8 @@ module Ubl
           build_header(xml) do |xml|
             xml["cbc"].InvoiceTypeCode "380"
           end
-
           build_document_reference(xml, "CommercialInvoice")
-
-          build_party(xml, @supplier, "AccountingSupplierParty")
-          build_party(xml, @customer, "AccountingCustomerParty")
-
-          build_tax_total(xml)
-          build_monetary_total(xml)
-          build_invoice_lines(xml)
+          build_content(xml)
         end
       end
       builder.to_xml
@@ -55,18 +49,39 @@ module Ubl
           build_header(xml) do |xml|
             xml["cbc"].CreditNoteTypeCode "381"
           end
-
           build_document_reference(xml, "CreditNote")
-
-          build_party(xml, @supplier, "AccountingSupplierParty")
-          build_party(xml, @customer, "AccountingCustomerParty")
-
-          build_tax_total(xml)
-          build_monetary_total(xml)
-          build_invoice_lines(xml)
+          build_content(xml)
         end
       end
       builder.to_xml
     end
   end
+
+  ##
+  # Validate an invoice
+  #
+  # == Parameters
+  # * +path+       - The path to the XML invoice that needs validation.
+  # * +extension+  - Set to +"UBL_BE"+ to generate UBL.BE compliant documents.
+  #                  Defaults to +nil+ for standard PEPPOL format.
+  # * +schematron+ - If +true+, run a Schematron validation using Docker.
+  #                  Requires Docker to be installed and running. Defaults to +true+.
+  def self.validate_invoice(path, extension: nil, schematron: true)
+    validator = Validator.new(extension:, schematron:)
+    validator.validate_invoice(path)
+  end
+
+  ##
+  # Validate a credit note
+  #
+  # == Parameters
+  # * +path+       - The path to the XML credit note that needs validation.
+  # * +extension+  - Set to +"UBL_BE"+ to generate UBL.BE compliant documents.
+  #                  Defaults to +nil+ for standard PEPPOL format.
+  # * +schematron+ - If +true+, run a Schematron validation using Docker.
+  #                  Requires Docker to be installed and running. Defaults to +true+.
+  def self.validate_credit_note(path, extension: nil, schematron: true)
+    validator = Validator.new(extension:, schematron:)
+    validator.validate_credit_note(path)
+  end
 end