ubl 0.0.4 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f257c1e68bac4286b082be4900f49a27fc736a69dc7cafa7de79cca2219e9035
-  data.tar.gz: 15be033154369701934e55ddc4ae34a2270032f129e8f9409927a4b06174f00e
+  metadata.gz: 5c951c7c837dfd7a900976e605a78832e0bf2bfd15733c4877f045df4bf0214e
+  data.tar.gz: bceb1d66414fe51ae67db3c15ad0e60f6e127834dfc7f587781f9464a430364c
 SHA512:
-  metadata.gz: 63d7d62032fc619e8756655f2e737cc17bb5f54b9452478bdf15aadb3c040430f54a1db90e647fe5696182c719f33f2d22ff3649d5ade31c38ed8f8758f8f99d
-  data.tar.gz: 8e9ef76a121e0288be720acd30d14bb38747c0ed5e19f22abed25ec5768ba57ca4640d17dd547ce0b9f7be988d139cac7a667a4e3085ee4dac871c39b82c37fd
+  metadata.gz: f94eccdd50a880d39a67ab3fcfa102ff6115792fc06f94c6fc0c9702797902e3975e75c532d0512ee4ea9c58f05042b07cb2419703a5955be3cf19dabd30ffb3
+  data.tar.gz: 3ced736e13ab314f47aea124fdea03188512b659e8f1579500d60a4ddf3d11a1f32f2b52573e54bc526c9494d50e9ca692818f1d8c1afbc0bc8570e2fc2a7d09

data/README.md

@@ -2,7 +2,7 @@
 
 # Ubl
 
-Generate UBL invoices and credit notes for Peppol
+Generate UBL (Universal Business Language) documents, such as invoices and credit notes, compliant with the Peppol network.
 
 ## installation
 
@@ -25,10 +25,7 @@ require "ubl"
 
 invoice = Ubl::Invoice.new
 invoice.invoice_nr = "INV-2025-001"
-invoice.issue_date = Date.new(2025, 6, 28)
-invoice.due_date = Date.new(2025, 7, 28)
-invoice.currency = "EUR"
-invoice.pdffile = __dir__ + "/invoice_test.pdf"
+invoice.pdffile = "./invoice.pdf"
 
 invoice.add_supplier(
   name: "ACME Corp",
@@ -54,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.
+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"

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.0.4"
+  VERSION = "0.1.1"
 end

data/lib/ubl.rb

@@ -1,8 +1,9 @@
 require_relative "ubl/builder"
+require_relative "ubl/validate"
 
 ##
-# The Invoice and CreditNote class generates UBL (Universal Business Language) compliant XML
-# documents following PEPPOL standards.
+# Generate UBL (Universal Business Language) documents,
+# such as invoices and credit notes, compliant with the Peppol network.
 module Ubl
   class Invoice < UblBuilder
     ##
@@ -69,4 +70,32 @@ module Ubl
       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