zugpferd 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f90a4d018fae6b09d232eecf5126777ae3b6ba430a21aca41518e87e3f37d6ac
-  data.tar.gz: b955207706bf352b187ebabfa02045a9be79adbffa586397e91446f71a32ec3c
+  metadata.gz: 668190b295d1286b2f8efd2f2896054e9c102c48da549d70486ef13677d042ad
+  data.tar.gz: '0274834d75a8c12690e178b5e075a8bed9792180b627c19a1fd3313534d9914c'
 SHA512:
-  metadata.gz: cbc3be25cd3d9634b5317c1e9abaa07ecc6616240a33c949ef5c433166f93f2bdc2cbe3c54d165321d4c17fac3db0aba9a024e0162cd5d00eb55b72100a357f4
-  data.tar.gz: 3bd7a4168513db97668fb68083670bbb81dcddc51fc4b817571a7a2373ebbf70c16d6a7c78e6386ac13eb6ae103b13ca94f67b9c56ded12bb46ae24e494e7416
+  metadata.gz: 74be6147cd6ef40e90a23548e0e15c0b65e7c5e402535c2575f1dc41926b66b981f7c1e555d297f006ae69988ff9470c4d8b2eb2e8a4c7c83aa8791cc8bde1f5
+  data.tar.gz: 2cb11d5ef99e1d3341006fd37d2fa8e9ba3703fbebc7c642577f269aaa9aae3ddf666c2ed892a6ca5e92df17945d1d2b916b9b542c16f283b909ec862ddd8cdd

data/lib/zugpferd/cii/mapping.rb

@@ -23,6 +23,10 @@ module Zugpferd
         profile_id:       "#{CONTEXT}/ram:BusinessProcessSpecifiedDocumentContextParameter/ram:ID",
       }.freeze
 
+      # Delivery (BG-13)
+      DELIVERY = "#{TRANSACTION}/ram:ApplicableHeaderTradeDelivery"
+      DELIVERY_DATE = "ram:ActualDeliverySupplyChainEvent/ram:OccurrenceDateTime/udt:DateTimeString"
+
       # Settlement (contains currency, payment, tax, totals)
       SETTLEMENT = "#{TRANSACTION}/ram:ApplicableHeaderTradeSettlement"
       AGREEMENT = "#{TRANSACTION}/ram:ApplicableHeaderTradeAgreement"

data/lib/zugpferd/cii/reader.rb

@@ -35,6 +35,7 @@ module Zugpferd
 
       def build_invoice(root)
         settlement = root.at_xpath(SETTLEMENT, NS)
+        delivery = root.at_xpath(DELIVERY, NS)
         type_code = text(root, INVOICE[:type_code])
         model_class = TYPE_CODE_MAP.fetch(type_code, Model::Invoice)
 
@@ -42,6 +43,7 @@ module Zugpferd
           number: text(root, INVOICE[:number]),
           issue_date: parse_cii_date(text(root, INVOICE[:issue_date])),
           due_date: parse_cii_date(settlement ? text(settlement, PAYMENT_TERMS_DUE_DATE) : nil),
+          delivery_date: parse_cii_date(delivery ? text(delivery, DELIVERY_DATE) : nil),
           type_code: text(root, INVOICE[:type_code]),
           currency_code: text(root, INVOICE_SETTLEMENT[:currency_code]),
           buyer_reference: text(root, INVOICE_SETTLEMENT[:buyer_reference]),

data/lib/zugpferd/cii/writer.rb

@@ -66,7 +66,7 @@ module Zugpferd
         xml["rsm"].SupplyChainTradeTransaction do
           doc.line_items.each { |li| build_line_item(xml, li) }
           build_agreement(xml, doc)
-          xml["ram"].ApplicableHeaderTradeDelivery
+          build_delivery(xml, doc)
           build_settlement(xml, doc)
         end
       end
@@ -141,6 +141,18 @@ module Zugpferd
         end
       end
 
+      def build_delivery(xml, doc)
+        xml["ram"].ApplicableHeaderTradeDelivery do
+          if doc.delivery_date
+            xml["ram"].ActualDeliverySupplyChainEvent do
+              xml["ram"].OccurrenceDateTime do
+                xml["udt"].DateTimeString(format_cii_date(doc.delivery_date), format: "102")
+              end
+            end
+          end
+        end
+      end
+
       def build_settlement(xml, doc)
         xml["ram"].ApplicableHeaderTradeSettlement do
           if doc.payment_instructions&.creditor_reference_id

data/lib/zugpferd/model/billing_document.rb

@@ -18,6 +18,7 @@ module Zugpferd
       # @return [Date, nil] BT-9 Payment due date
       # @return [String] BT-3 Invoice type code
       # @return [String] BT-5 Document currency code (default: "EUR")
+      # @return [Date, nil] BT-72 Actual delivery date
       # @return [String, nil] BT-10 Buyer reference
       # @return [String, nil] BT-24 Specification identifier
       # @return [String, nil] BT-23 Business process type
@@ -30,10 +31,10 @@ module Zugpferd
       # @return [PaymentInstructions, nil] BG-16 Payment information
       # @return [Array<AllowanceCharge>] BG-20/BG-21 Document-level allowances and charges
       attr_accessor :number, :issue_date, :due_date, :type_code,
-                    :currency_code, :buyer_reference, :customization_id,
-                    :profile_id, :note, :seller, :buyer, :line_items,
-                    :tax_breakdown, :monetary_totals, :payment_instructions,
-                    :allowance_charges
+                    :currency_code, :delivery_date, :buyer_reference,
+                    :customization_id, :profile_id, :note, :seller, :buyer,
+                    :line_items, :tax_breakdown, :monetary_totals,
+                    :payment_instructions, :allowance_charges
 
       # @param number [String] BT-1 Invoice number
       # @param issue_date [Date] BT-2 Issue date

data/lib/zugpferd/pdf/embedder.rb

@@ -0,0 +1,126 @@
+require "open3"
+require "tempfile"
+
+module Zugpferd
+  module PDF
+    class Embedder
+      class GhostscriptNotFound < Zugpferd::Error; end
+      class EmbedError < Zugpferd::Error; end
+
+      VERSIONS = %w[rc 1p0 2p0 2p1].freeze
+
+      CONFORMANCE_LEVELS = {
+        "2p1" => ["MINIMUM", "BASIC WL", "BASIC", "EN 16931", "EXTENDED", "XRECHNUNG"],
+        "2p0" => ["MINIMUM", "BASIC WL", "BASIC", "EN 16931", "EXTENDED", "XRECHNUNG"],
+        "1p0" => ["BASIC", "COMFORT", "EXTENDED"],
+      }.freeze
+
+      # @param pdf_path [String] Pfad zum Input-PDF
+      # @param xml [String] XML-String (UBL oder CII)
+      # @param output_path [String] Pfad zur Ausgabe-PDF
+      # @param version [String] "2p1" (default), "2p0", "1p0", "rc"
+      # @param conformance_level [String] "EN 16931" (default), "BASIC", etc.
+      # @return [String] Pfad zur erzeugten PDF-Datei
+      def embed(pdf_path:, xml:, output_path:, version: "2p1", conformance_level: "EN 16931")
+        validate_params!(pdf_path, version, conformance_level)
+        ensure_ghostscript!
+
+        xml_file = write_xml_tempfile(xml)
+        begin
+          run_ghostscript(pdf_path, xml_file.path, output_path, version, conformance_level)
+        ensure
+          xml_file.close!
+        end
+
+        output_path
+      end
+
+      private
+
+      def validate_params!(pdf_path, version, conformance_level)
+        raise ArgumentError, "PDF file not found: #{pdf_path}" unless File.exist?(pdf_path)
+        raise ArgumentError, "Unknown version: #{version}. Valid: #{VERSIONS.join(", ")}" unless VERSIONS.include?(version)
+
+        if version != "rc"
+          valid_levels = CONFORMANCE_LEVELS[version]
+          unless valid_levels&.include?(conformance_level)
+            raise ArgumentError,
+              "Unknown conformance level '#{conformance_level}' for version #{version}. " \
+              "Valid: #{valid_levels.join(", ")}"
+          end
+        end
+      end
+
+      def ensure_ghostscript!
+        _, _, status = Open3.capture3("gs", "--version")
+        raise GhostscriptNotFound, "Ghostscript (gs) not found in PATH" unless status.success?
+      rescue Errno::ENOENT
+        raise GhostscriptNotFound, "Ghostscript (gs) not found in PATH"
+      end
+
+      def vendor_dir
+        File.expand_path("../../../vendor/zugferd", __dir__)
+      end
+
+      def zugferd_ps_path
+        File.join(vendor_dir, "zugferd.ps")
+      end
+
+      def icc_profile_path
+        File.join(vendor_dir, "default_rgb.icc")
+      end
+
+      def write_xml_tempfile(xml)
+        tmpfile = Tempfile.new(["zugferd", ".xml"])
+        tmpfile.binmode
+        tmpfile.write(xml)
+        tmpfile.flush
+        tmpfile
+      end
+
+      def run_ghostscript(pdf_path, xml_path, output_path, version, conformance_level)
+        ps_path = zugferd_ps_path
+        icc_path = icc_profile_path
+
+        unless File.exist?(ps_path)
+          raise EmbedError, "zugferd.ps not found at #{ps_path}. Run bin/setup-schemas."
+        end
+
+        unless File.exist?(icc_path)
+          raise EmbedError, "ICC profile not found at #{icc_path}. Run bin/setup-schemas."
+        end
+
+        cmd = build_command(pdf_path, xml_path, output_path, version, conformance_level, ps_path, icc_path)
+        stdout, stderr, status = Open3.capture3(*cmd)
+
+        unless status.success?
+          raise EmbedError, "Ghostscript failed (exit #{status.exitstatus}):\n#{stderr}#{stdout}"
+        end
+
+        unless File.exist?(output_path)
+          raise EmbedError, "Ghostscript did not produce output file: #{output_path}"
+        end
+      end
+
+      def build_command(pdf_path, xml_path, output_path, version, conformance_level, ps_path, icc_path)
+        cmd = %w[gs]
+        cmd += %w[-dBATCH -dNOPAUSE -dNOOUTERSAVE]
+        cmd += %w[-sDEVICE=pdfwrite]
+        cmd += %w[-dPDFA=3 -dPDFACompatibilityPolicy=1]
+        cmd += %w[-sColorConversionStrategy=RGB -sProcessColorModel=DeviceRGB]
+        cmd << "--permit-file-read=#{xml_path}"
+        cmd << "--permit-file-read=#{icc_path}"
+        cmd << "--permit-file-read=#{pdf_path}"
+        cmd << "-sZUGFeRDXMLFile=#{xml_path}"
+        cmd << "-sZUGFeRDProfile=#{icc_path}"
+        cmd << "-sZUGFeRDVersion=#{version}"
+        cmd << "-sZUGFeRDConformanceLevel=#{conformance_level}"
+        cmd << "-o"
+        cmd << output_path
+        cmd << ps_path
+        cmd << pdf_path
+        cmd
+      end
+    end
+  end
+end

data/lib/zugpferd/pdf.rb

@@ -0,0 +1 @@
+require_relative "pdf/embedder"

data/lib/zugpferd/ubl/mapping.rb

@@ -26,6 +26,10 @@ module Zugpferd
         note:               "cbc:Note",
       }.freeze
 
+      # Delivery (BG-13)
+      DELIVERY = "cac:Delivery"
+      DELIVERY_DATE = "cbc:ActualDeliveryDate"
+
       # Seller (BG-4)
       SELLER = "cac:AccountingSupplierParty/cac:Party"
       # Buyer (BG-7)

data/lib/zugpferd/ubl/reader.rb

@@ -33,10 +33,13 @@ module Zugpferd
 
         model_class = @credit_note ? Model::CreditNote : Model::Invoice
 
+        delivery_node = root.at_xpath(DELIVERY, @ns)
+
         model_class.new(
           number: text(root, INVOICE[:number]),
           issue_date: parse_date(text(root, INVOICE[:issue_date])),
           due_date: parse_date(text(root, INVOICE[:due_date])),
+          delivery_date: delivery_node ? parse_date(text(delivery_node, DELIVERY_DATE)) : nil,
           type_code: text(root, type_code_element),
           currency_code: text(root, INVOICE[:currency_code]),
           buyer_reference: text(root, INVOICE[:buyer_reference]),

data/lib/zugpferd/ubl/writer.rb

@@ -53,6 +53,7 @@ module Zugpferd
 
         build_supplier(xml, doc.seller, doc.payment_instructions) if doc.seller
         build_customer(xml, doc.buyer) if doc.buyer
+        build_delivery(xml, doc) if doc.delivery_date
         build_payment_means(xml, doc.payment_instructions) if doc.payment_instructions
         build_payment_terms(xml, doc.payment_instructions) if doc.payment_instructions&.note
         doc.allowance_charges.each { |ac| build_allowance_charge(xml, ac, doc.currency_code) }
@@ -140,6 +141,12 @@ module Zugpferd
         end
       end
 
+      def build_delivery(xml, doc)
+        xml["cac"].Delivery do
+          xml["cbc"].ActualDeliveryDate doc.delivery_date.to_s
+        end
+      end
+
       def build_payment_means(xml, payment)
         xml["cac"].PaymentMeans do
           xml["cbc"].PaymentMeansCode payment.payment_means_code

data/lib/zugpferd/validation/mustang_validator.rb

@@ -0,0 +1,41 @@
+require "open3"
+
+module Zugpferd
+  module Validation
+    class MustangValidator
+      Result = Struct.new(:valid, :output, keyword_init: true)
+
+      CONTAINER_NAME = "zugpferd-mustang"
+      IMAGE = "zugpferd-mustang:latest"
+
+      # @param pdf_path [String] Pfad zur PDF-Datei
+      # @return [Result]
+      def validate(pdf_path)
+        pdf_path = File.expand_path(pdf_path)
+        dir = File.dirname(pdf_path)
+        filename = File.basename(pdf_path)
+
+        cmd = [
+          "docker", "run", "--rm",
+          "-v", "#{dir}:/data:ro",
+          IMAGE,
+          "--action", "validate",
+          "--source", "/data/#{filename}",
+        ]
+
+        stdout, stderr, status = Open3.capture3(*cmd)
+        output = "#{stdout}#{stderr}".strip
+
+        Result.new(valid: status.success?, output: output)
+      end
+
+      # @return [Boolean] true wenn das Docker-Image vorhanden ist
+      def available?
+        _, _, status = Open3.capture3("docker", "image", "inspect", IMAGE)
+        status.success?
+      rescue Errno::ENOENT
+        false
+      end
+    end
+  end
+end

data/lib/zugpferd/validation/pdf_validator.rb

@@ -0,0 +1,93 @@
+require "net/http"
+require "uri"
+require "json"
+
+module Zugpferd
+  module Validation
+    class PdfValidator
+      Result = Struct.new(:compliant, :failures, keyword_init: true)
+
+      def initialize(host: "localhost", port: 8080)
+        @base_uri = URI("http://#{host}:#{port}")
+      end
+
+      # @param pdf_path [String] Pfad zur PDF-Datei
+      # @param profile [String] veraPDF-Profil ("3b", "3a", "3u")
+      # @return [Result]
+      def validate(pdf_path, profile: "3b")
+        uri = URI("#{@base_uri}/api/validate/#{profile}")
+
+        boundary = "----ZugpferdBoundary#{SecureRandom.hex(16)}"
+        body = build_multipart_body(pdf_path, boundary)
+
+        request = Net::HTTP::Post.new(uri)
+        request["Content-Type"] = "multipart/form-data; boundary=#{boundary}"
+        request["Accept"] = "application/json"
+        request.body = body
+
+        response = Net::HTTP.start(uri.hostname, uri.port) do |http|
+          http.read_timeout = 120
+          http.request(request)
+        end
+
+        parse_response(response)
+      end
+
+      # @return [Boolean] true wenn veraPDF erreichbar ist
+      def available?
+        uri = URI("#{@base_uri}/api/info")
+        response = Net::HTTP.get_response(uri)
+        response.code == "200"
+      rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, SocketError, Net::OpenTimeout
+        false
+      end
+
+      private
+
+      def build_multipart_body(pdf_path, boundary)
+        filename = File.basename(pdf_path)
+        content = File.binread(pdf_path)
+
+        body = +""
+        body << "--#{boundary}\r\n"
+        body << "Content-Disposition: form-data; name=\"file\"; filename=\"#{filename}\"\r\n"
+        body << "Content-Type: application/pdf\r\n"
+        body << "\r\n"
+        body << content
+        body << "\r\n"
+        body << "--#{boundary}--\r\n"
+        body
+      end
+
+      def parse_response(response)
+        unless response.code == "200"
+          raise "veraPDF returned HTTP #{response.code}: #{response.body}"
+        end
+
+        data = JSON.parse(response.body)
+        job = data.dig("report", "jobs", 0) || data.dig("report", "batchSummary") || {}
+        validation = job["validationResult"] || job
+
+        compliant = validation["compliant"] == true
+        failures = extract_failures(validation)
+
+        Result.new(compliant: compliant, failures: failures)
+      end
+
+      def extract_failures(validation)
+        details = validation["details"] || validation["rulesSummary"] || {}
+        rules = details["rules"] || []
+
+        rules.select { |r| r["status"] == "failed" }.map do |rule|
+          {
+            clause: rule["clause"],
+            test_number: rule["testNumber"],
+            description: rule["description"],
+            object: rule["object"],
+            checks: rule["checks"]&.select { |c| c["status"] == "failed" },
+          }
+        end
+      end
+    end
+  end
+end

data/lib/zugpferd/validation/schema_validator.rb

@@ -0,0 +1,46 @@
+require "nokogiri"
+
+module Zugpferd
+  module Validation
+    # Validates XML against XSD schemas using Nokogiri.
+    #
+    # @example
+    #   validator = SchemaValidator.new(schemas_path: "vendor/schemas")
+    #   errors = validator.validate(xml, schema_key: :ubl_invoice)
+    class SchemaValidator
+      XSD_PATHS = {
+        ubl_invoice: "ubl/xsd/maindoc/UBL-Invoice-2.1.xsd",
+        ubl_credit_note: "ubl/xsd/maindoc/UBL-CreditNote-2.1.xsd",
+        cii: "cii/CrossIndustryInvoice_100pD16B.xsd",
+      }.freeze
+
+      # @param schemas_path [String] path to the schemas directory
+      def initialize(schemas_path:)
+        @schemas_path = schemas_path
+        @schema_cache = {}
+      end
+
+      # Validates XML against an XSD schema.
+      #
+      # @param xml_string [String] XML to validate
+      # @param schema_key [Symbol] one of +:ubl_invoice+, +:ubl_credit_note+, +:cii+
+      # @return [Array<String>] error messages (empty if valid)
+      def validate(xml_string, schema_key:)
+        doc = Nokogiri::XML(xml_string)
+        schema = load_schema(schema_key)
+        schema.validate(doc).map(&:message)
+      end
+
+      private
+
+      def load_schema(key)
+        @schema_cache[key] ||= begin
+          path = File.join(@schemas_path, XSD_PATHS.fetch(key))
+          Dir.chdir(File.dirname(path)) do
+            Nokogiri::XML::Schema(File.read(File.basename(path)))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zugpferd/validation/schematron_validator.rb

@@ -0,0 +1,114 @@
+require "nokogiri"
+require "open3"
+require "tempfile"
+
+module Zugpferd
+  module Validation
+    # Validates XML against Schematron business rules using Saxon HE.
+    #
+    # Supports CEN EN 16931 and XRechnung rule sets.
+    #
+    # @example
+    #   validator = SchematronValidator.new(schemas_path: "vendor/schemas")
+    #   errors = validator.validate(xml, rule_set: :xrechnung_ubl)
+    #   fatals = errors.select { |e| e.flag == "fatal" }
+    class SchematronValidator
+      SVRL_NS = "http://purl.oclc.org/dsdl/svrl"
+
+      XSLT_PATHS = {
+        cen_ubl: "schematron/cen/ubl/xslt/EN16931-UBL-validation.xslt",
+        cen_cii: "schematron/cen/cii/xslt/EN16931-CII-validation.xslt",
+        xrechnung_ubl: "schematron/xrechnung/schematron/ubl/XRechnung-UBL-validation.xsl",
+        xrechnung_cii: "schematron/xrechnung/schematron/cii/XRechnung-CII-validation.xsl",
+      }.freeze
+
+      SAXON_JARS = [
+        "saxon/saxon-he-12.5.jar",
+        "saxon/xmlresolver-5.2.2.jar",
+      ].freeze
+
+      class TransformError < StandardError; end
+
+      Result = Struct.new(:id, :location, :text, :flag, keyword_init: true)
+
+      # @param schemas_path [String] path to the schemas directory
+      def initialize(schemas_path:)
+        @schemas_path = schemas_path
+      end
+
+      # Validates XML against a single Schematron rule set.
+      #
+      # @param xml_string [String] XML to validate
+      # @param rule_set [Symbol] one of +:cen_ubl+, +:cen_cii+, +:xrechnung_ubl+, +:xrechnung_cii+
+      # @return [Array<Result>] validation errors
+      # @raise [TransformError] if Saxon fails
+      def validate(xml_string, rule_set:)
+        xslt_path = resolve_xslt(rule_set)
+        svrl_xml = run_saxon(xml_string, xslt_path)
+        svrl_doc = Nokogiri::XML(svrl_xml)
+        parse_failed_asserts(svrl_doc)
+      end
+
+      # Validates XML against multiple rule sets.
+      #
+      # @param xml_string [String] XML to validate
+      # @param rule_sets [Array<Symbol>] rule sets to apply
+      # @return [Array<Result>] merged validation errors
+      def validate_all(xml_string, rule_sets:)
+        rule_sets.flat_map { |rs| validate(xml_string, rule_set: rs) }
+      end
+
+      private
+
+      def resolve_xslt(rule_set)
+        path = File.join(@schemas_path, XSLT_PATHS.fetch(rule_set))
+        raise ArgumentError,
+          "XSLT not found: #{path} – run bin/setup-schemas" \
+          unless File.exist?(path)
+        path
+      end
+
+      def saxon_classpath
+        SAXON_JARS.map do |jar|
+          path = File.join(@schemas_path, jar)
+          raise ArgumentError,
+            "#{jar} not found: #{path} – run bin/setup-schemas" \
+            unless File.exist?(path)
+          path
+        end.join(":")
+      end
+
+      def run_saxon(xml_string, xslt_path)
+        input = Tempfile.new(["input", ".xml"])
+        input.write(xml_string)
+        input.close
+
+        stdout, stderr, status = Open3.capture3(
+          "java", "-cp", saxon_classpath,
+          "net.sf.saxon.Transform",
+          "-s:#{input.path}",
+          "-xsl:#{xslt_path}"
+        )
+
+        unless status.success?
+          raise TransformError, "Saxon transform failed: #{stderr}"
+        end
+
+        stdout
+      ensure
+        input&.unlink
+      end
+
+      def parse_failed_asserts(svrl_doc)
+        svrl_doc.xpath("//svrl:failed-assert", "svrl" => SVRL_NS).map do |node|
+          Result.new(
+            id: node["id"],
+            location: node["location"],
+            text: node.at_xpath("svrl:text", "svrl" => SVRL_NS)&.text&.strip,
+            flag: node["flag"]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/zugpferd/validation.rb

@@ -0,0 +1,2 @@
+require_relative "validation/schema_validator"
+require_relative "validation/schematron_validator"

data/vendor/zugferd/zugferd.ps

@@ -0,0 +1,527 @@
+%!PS
+
+% Copyright (C) 2001-2024 Artifex Software, Inc.
+% All Rights Reserved.
+%
+% This software is provided AS-IS with no warranty, either express or
+% implied.
+%
+% This software is distributed under license and may not be copied,
+% modified or distributed except as expressly authorized under the terms
+% of the license contained in the file LICENSE in this distribution.
+%
+% Refer to licensing information at http://www.artifex.com or contact
+% Artifex Software, Inc.,  39 Mesa Street, Suite 108A, San Francisco,
+% CA 94129, USA, for further information.
+%
+% ZUGFeRD.ps
+% This program will create an (unsigned) ZUGFeRD compliant PDF file.
+% In order to do so the user must provide certain information, or edit
+% this program.
+%
+% Required information is the path to the XML file containing the invoice
+% data, and the path to an ICC profile appropriate for the chosen
+% ColorConversionStrategy.
+%
+% -sZUGFeRDXMLFile defines a path to the XML invoice file.
+%
+% -sZUGFeRDProfile defines the path to the ICC profile.
+%
+% -sZUGFeRDVersion defines the version of the ZUGFeRD standard to be used.
+% Missing or invalid values would be silently replaced by the default ("2p1").
+%
+% -sZUGFeRDConformanceLevel defines the level of conformance.
+% Missing or invalid values would be silently replaced by the default ("BASIC").
+%
+% Note that the ZUGFeRD standard states:
+%
+%   The content of the field fx:ConformanceLevel has to be picked from
+%   the content of the element "GuidelineSpecifiedDocumentContextParameter"
+%   (specification identifier BT-24) of the XML instance file.
+%
+% Optionally:
+%   -sZUGFeRDDateTime can be used to set a string representing the modification
+%   date of the XML invoice file. If this is ommitted a dummy value will be
+%   used. It is up to the user to create a correctly formatted PDF date/time
+%   string. See section 7.9.4 of the PDF 2.0 specification (ISO-32000-2:2017)
+%   for details of the format.
+%
+% The user must additionally set -dPDFA=3 and -sColorConversionStrategy
+% on the Ghostscript command line, and set the permissions for Ghostscript
+% to read both these files. It is simplest to put the files in a directory
+% and then permit reading of the entire directory.
+%
+% Example command line :
+%
+% gs --permit-file-read=/usr/home/me/zugferd/          \
+%    -sDEVICE=pdfwrite                                 \
+%    -dPDFA=3                                          \
+%    -sColorConversionStrategy=RGB                     \
+%    -sZUGFeRDXMLFile=/usr/home/me/zugferd/invoice.xml \
+%    -sZUGFeRDProfile=/usr/home/me/zugferd/rgb.icc     \
+%    -sZUGFeRDVersion=2p1                              \
+%    -sZUGFeRDConformanceLevel=BASIC                   \
+%    -o /usr/home/me/zugferd/zugferd.pdf               \
+%    /usr/home/me/zugferd/zugferd.ps                   \
+%    /usr/home/me/zugferd/original.pdf
+%
+% Much of this program results from a Ghostscript bug report, the thread
+% can be found at
+%   https://bugs.ghostscript.com/show_bug.cgi?id=696472
+% Portions of the code below were supplied by Reinhard Nissl and
+% I'm indebted to him for his efforts in helping me create a solution for
+% this problem as well as for the code he supplied, particularly for the
+% SimpleUTF16BE routine.
+%
+% The program was further refined and expanded by Adrian Devries in :
+%   https://bugs.ghostscript.com/show_bug.cgi?id=703862
+%
+% And refined again following feedback from Thorsten Engel in:
+%   https://bugs.ghostscript.com/show_bug.cgi?id=707694
+%
+% It should not be necessary to modify this program, the comments in the
+% code are there purely for information, but there is one area which
+% might reasonably be altered. The section with the --8<-- lines could be
+% replaced with a simpler /N 3 or /N 4 if you always intend to produce
+% the same kind of files; RGB or CMYK.
+%
+% Remaining tasks have been marked with "TODO".
+
+% istring SimpleUTF16BE ostring
+/SimpleUTF16BE
+{
+    dup length
+    1 add
+    2 mul
+    string
+    % istring ostring
+    dup 0 16#FE put
+    dup 1 16#FF put
+    2
+    3 -1 roll
+    % ostring index istring
+    {
+        % ostring index ichar
+        3 1 roll
+        % ichar ostring index
+        2 copy 16#00 put
+        1 add
+        2 copy
+        5 -1 roll
+        % ostring index ostring index ichar
+        put
+        1 add
+        % ostring index
+    }
+    forall
+    % ostring index
+    pop
+}
+bind def
+
+% Cf. https://en.wikibooks.org/wiki/PostScript_FAQ#How_to_concatenate_strings%3F
+/concatstringarray { % [(a) (b) ... (z)] --> (ab...z)
+  0 1 index {
+    length add
+  } forall
+  string
+  0 3 2 roll {
+    3 copy putinterval
+    length add
+  } forall
+  pop
+} bind def
+
+/ZUGFeRDVersion where {
+  pop % Discard the dictionary
+  ZUGFeRDVersion (rc) ne {
+    ZUGFeRDVersion (1p0) ne {
+      ZUGFeRDVersion (2p0) ne {
+        ZUGFeRDVersion (2p1) ne {
+          /ZUGFeRDVersion (2p1) def
+        } if
+      } if
+    } if
+  } if
+}{
+  /ZUGFeRDVersion (2p1) def
+} ifelse
+
+/ZUGFeRDConformanceLevel where {
+  pop % Discard the dictionary
+  ZUGFeRDVersion (rc)  eq
+  ZUGFeRDVersion (1p0) eq or {
+    ZUGFeRDConformanceLevel (BASIC) ne {
+      ZUGFeRDConformanceLevel (COMFORT) ne {
+        ZUGFeRDConformanceLevel (EXTENDED) ne {
+          /ZUGFeRDConformanceLevel (BASIC) def
+        } if
+      } if
+    } if
+  } if
+  ZUGFeRDVersion (2p0) eq
+  ZUGFeRDVersion (2p1) eq or {
+    ZUGFeRDConformanceLevel (MINIMUM) ne {
+      ZUGFeRDConformanceLevel (BASIC WL) ne {
+        ZUGFeRDConformanceLevel (BASIC) ne {
+          ZUGFeRDConformanceLevel (EN 16931) ne {
+            ZUGFeRDConformanceLevel (EXTENDED) ne {
+              ZUGFeRDConformanceLevel (XRECHNUNG) ne {
+                /ZUGFeRDConformanceLevel (BASIC) def
+              } if
+            } if
+          } if
+        } if
+      } if
+    } if
+  } if
+}{
+  /ZUGFeRDConformanceLevel (BASIC) def
+} ifelse
+
+% ZUGFeRDSchema
+/ZUGFeRDSchema () def
+ZUGFeRDVersion (rc)  eq
+ZUGFeRDVersion (1p0) eq or
+ZUGFeRDVersion (2p0) eq or {
+  /ZUGFeRDSchema (ZUGFeRD PDFA Extension Schema) def
+} if
+ZUGFeRDVersion (2p1) eq {
+  /ZUGFeRDSchema (Factur-X PDFA Extension Schema) def
+} if
+
+% ZUGFeRDNamespaceURI
+/ZUGFeRDNamespaceURI () def
+ZUGFeRDVersion (rc)  eq {
+  /ZUGFeRDNamespaceURI (urn:ferd:pdfa:invoice:rc#) def
+} if
+ZUGFeRDVersion (1p0) eq {
+  /ZUGFeRDNamespaceURI (urn:ferd:pdfa:CrossIndustryDocument:invoice:1p0#) def
+} if
+ZUGFeRDVersion (2p0) eq {
+  /ZUGFeRDNamespaceURI (urn:zugferd:pdfa:CrossIndustryDocument:invoice:2p0#) def
+} if
+ZUGFeRDVersion (2p1) eq {
+  /ZUGFeRDNamespaceURI (urn:factur-x:pdfa:CrossIndustryDocument:invoice:1p0#) def
+} if
+
+% ZUGFeRDPrefix
+/ZUGFeRDPrefix () def
+ZUGFeRDVersion (rc)  eq
+ZUGFeRDVersion (1p0) eq or
+ZUGFeRDVersion (2p0) eq or {
+  /ZUGFeRDPrefix (zf) def
+} if
+ZUGFeRDVersion (2p1) eq {
+  /ZUGFeRDPrefix (fx) def
+} if
+
+% ZUGFeRDVersionDescription
+/ZUGFeRDVersionDescription () def
+ZUGFeRDVersion (rc)  eq
+ZUGFeRDVersion (1p0) eq or
+ZUGFeRDVersion (2p0) eq or {
+  /ZUGFeRDVersionDescription (The actual version of the ZUGFeRD XML schema) def
+} if
+ZUGFeRDVersion (2p1) eq {
+  /ZUGFeRDVersionDescription (The actual version of the Factur-X XML schema) def
+} if
+
+% ZUGFeRDConformanceLevelDescription
+/ZUGFeRDConformanceLevelDescription () def
+ZUGFeRDVersion (rc)  eq
+ZUGFeRDVersion (1p0) eq or
+ZUGFeRDVersion (2p0) eq or {
+  /ZUGFeRDConformanceLevelDescription (The conformance level of the embedded ZUGFeRD data) def
+} if
+ZUGFeRDVersion (2p1) eq {
+  /ZUGFeRDConformanceLevelDescription (The conformance level of the embedded Factur-X data) def
+} if
+
+% ZUGFeRDDocumentFileName
+/ZUGFeRDDocumentFileName () def
+ZUGFeRDVersion (rc)  eq {
+  /ZUGFeRDDocumentFileName (ZUGFeRD-invoice.xml) def
+} if
+ZUGFeRDVersion (1p0) eq {
+  /ZUGFeRDDocumentFileName (ZUGFeRD-invoice.xml) def
+} if
+ZUGFeRDVersion (2p0) eq {
+  ZUGFeRDConformanceLevel (XRECHNUNG) ne {
+    /ZUGFeRDDocumentFileName (zugferd-invoice.xml) def
+  }{
+    /ZUGFeRDDocumentFileName (xrechnung.xml) def
+  } ifelse
+} if
+ZUGFeRDVersion (2p1) eq {
+  ZUGFeRDConformanceLevel (XRECHNUNG) ne {
+    /ZUGFeRDDocumentFileName (factur-x.xml) def
+  }{
+    /ZUGFeRDDocumentFileName (xrechnung.xml) def
+  } ifelse
+} if
+
+% ZUGFeRDVersionData
+/ZUGFeRDVersionData () def
+ZUGFeRDVersion (rc)  eq {
+  /ZUGFeRDVersionData (RC) def
+} if
+ZUGFeRDVersion (1p0) eq {
+  /ZUGFeRDVersionData (1.0) def
+} if
+ZUGFeRDVersion (2p0) eq {
+  ZUGFeRDConformanceLevel (XRECHNUNG) ne {
+    /ZUGFeRDVersionData (2p0) def
+  }{
+    /ZUGFeRDVersionData (1p2) def
+  } ifelse
+} if
+ZUGFeRDVersion (2p1) eq {
+  ZUGFeRDConformanceLevel (XRECHNUNG) ne {
+    /ZUGFeRDVersionData (1.0) def
+  }{
+    /ZUGFeRDVersionData (1p2) def
+  } ifelse
+} if
+
+/ZUGFeRDMetadata [
+(
+<rdf:Description)
+( xmlns:pdfaExtension="http://www.aiim.org/pdfa/ns/extension/")
+( xmlns:pdfaProperty="http://www.aiim.org/pdfa/ns/property#")
+( xmlns:pdfaSchema="http://www.aiim.org/pdfa/ns/schema#")
+( rdf:about="">
+  <pdfaExtension:schemas>
+    <rdf:Bag>
+      <rdf:li rdf:parseType="Resource">
+        <pdfaSchema:schema>)ZUGFeRDSchema(</pdfaSchema:schema>
+        <pdfaSchema:namespaceURI>)ZUGFeRDNamespaceURI(</pdfaSchema:namespaceURI>
+        <pdfaSchema:prefix>)ZUGFeRDPrefix(</pdfaSchema:prefix>
+        <pdfaSchema:property>
+          <rdf:Seq>
+            <rdf:li rdf:parseType="Resource">
+              <pdfaProperty:name>DocumentFileName</pdfaProperty:name>
+              <pdfaProperty:valueType>Text</pdfaProperty:valueType>
+              <pdfaProperty:category>external</pdfaProperty:category>
+              <pdfaProperty:description>Name of the embedded XML invoice file</pdfaProperty:description>
+            </rdf:li>
+            <rdf:li rdf:parseType="Resource">
+              <pdfaProperty:name>DocumentType</pdfaProperty:name>
+              <pdfaProperty:valueType>Text</pdfaProperty:valueType>
+              <pdfaProperty:category>external</pdfaProperty:category>
+              <pdfaProperty:description>INVOICE</pdfaProperty:description>
+            </rdf:li>
+            <rdf:li rdf:parseType="Resource">
+              <pdfaProperty:name>Version</pdfaProperty:name>
+              <pdfaProperty:valueType>Text</pdfaProperty:valueType>
+              <pdfaProperty:category>external</pdfaProperty:category>
+              <pdfaProperty:description>)ZUGFeRDVersionDescription(</pdfaProperty:description>
+            </rdf:li>
+            <rdf:li rdf:parseType="Resource">
+              <pdfaProperty:name>ConformanceLevel</pdfaProperty:name>
+              <pdfaProperty:valueType>Text</pdfaProperty:valueType>
+              <pdfaProperty:category>external</pdfaProperty:category>
+              <pdfaProperty:description>)ZUGFeRDConformanceLevelDescription(</pdfaProperty:description>
+            </rdf:li>
+          </rdf:Seq>
+        </pdfaSchema:property>
+      </rdf:li>
+    </rdf:Bag>
+  </pdfaExtension:schemas>
+</rdf:Description>
+<rdf:Description xmlns:)ZUGFeRDPrefix(=")ZUGFeRDNamespaceURI(" rdf:about="">
+  <)ZUGFeRDPrefix(:ConformanceLevel>)ZUGFeRDConformanceLevel(</)ZUGFeRDPrefix(:ConformanceLevel>
+  <)ZUGFeRDPrefix(:DocumentFileName>)ZUGFeRDDocumentFileName(</)ZUGFeRDPrefix(:DocumentFileName>
+  <)ZUGFeRDPrefix(:DocumentType>INVOICE</)ZUGFeRDPrefix(:DocumentType>
+  <)ZUGFeRDPrefix(:Version>)ZUGFeRDVersionData(</)ZUGFeRDPrefix(:Version>
+</rdf:Description>
+)
+  ] concatstringarray def
+
+/Usage {
+  (example usage:                                               \n) print
+  (      gs --permit-file-read=/usr/home/me/zugferd/          \\\n) print
+  (         -sDEVICE=pdfwrite                                 \\\n) print
+  (         -dPDFA=3                                          \\\n) print
+  (         -sColorConversionStrategy=RGB                     \\\n) print
+  (         -sZUGFeRDXMLFile=/usr/home/me/zugferd/invoice.xml \\\n) print
+  (         -sZUGFeRDProfile=/usr/home/me/zugferd\rgb.icc     \\\n) print
+  (         -sZUGFeRDVersion=2p1                              \\\n) print
+  (         -sZUGFeRDConformanceLevel=BASIC                   \\\n) print
+  (         -o /usr/home/me/zugferd/zugferd.pdf               \\\n) print
+  (         /usr/home/me/zugferd/zugferd.ps                   \\\n) print
+  (         /usr/home/me/zugferd/original.pdf                   \n) print
+  flush
+} def
+
+% First check that the user has defined the XML invoice file on the command line
+%
+/ZUGFeRDXMLFile where {
+  pop % Discard the dictionary
+  %
+  % Now check that the ICC Profile is defined
+  %
+  /ZUGFeRDProfile where {
+    pop % Discard the dictionary
+
+    % Step 1, add the required PDF/A boilerplate.
+    % This is mostly copied from lib/pdfa_def.ps
+
+    % Create a PDF stream object to hold the ICC profile.
+    [ /_objdef {icc_PDFA} /type /stream /OBJ pdfmark
+
+    % Add the required entries to the stream dictionary (/N only)
+    [ {icc_PDFA}
+    <<
+    %% This code attempts to set the /N (number of components) key for the ICC colour space.
+    %% To do this it checks the ColorConversionStrategy or the device ProcessColorModel if
+    %% ColorConversionStrategy is not set.
+    %% This is not 100% reliable. A better solution is for the user to edit this and replace
+    %% the code between the ---8<--- lines with a simple declaration like:
+    %%   /N 3
+    %% where the value of N is the number of components from the profile defined in ZUGFeRDProfile.
+    %%
+    %% ----------8<--------------8<-------------8<--------------8<----------
+      systemdict /ColorConversionStrategy known {
+        systemdict /ColorConversionStrategy get cvn dup /Gray eq {
+          pop /N 1 false
+        }{
+          dup /RGB eq {
+            pop /N 3 false
+          }{
+            /CMYK eq {
+              /N 4 false
+            }{
+              (ColorConversionStrategy not a device space, falling back to ProcessColorModel, output may not be valid PDF/A.)=
+              true
+            } ifelse
+          } ifelse
+        } ifelse
+      } {
+        (ColorConversionStrategy not set, falling back to ProcessColorModel, output may not be valid PDF/A.)=
+        true
+      } ifelse
+
+      {
+        currentpagedevice /ProcessColorModel get
+        dup /DeviceGray eq {
+          pop /N 1
+        }{
+          dup /DeviceRGB eq {
+            pop /N 3
+          }{
+            dup /DeviceCMYK eq {
+              pop /N 4
+            } {
+              (ProcessColorModel not a device space.)=
+              /ProcessColorModel cvx /rangecheck signalerror
+            } ifelse
+          } ifelse
+        } ifelse
+      } if
+    %% ----------8<--------------8<-------------8<--------------8<----------
+    >> /PUT pdfmark
+
+    % Now read the ICC profile from the file into the stream
+    [ {icc_PDFA} ZUGFeRDProfile (r) file /PUT pdfmark
+
+    % Define the output intent dictionary :
+    [/_objdef {OutputIntent_PDFA} /type /dict /OBJ pdfmark
+
+    % Add the required keys to the dictionary
+    [{OutputIntent_PDFA} <<
+        /Type /OutputIntent
+        /S /GTS_PDFA1                       % Required for PDF/A.
+        /DestOutputProfile {icc_PDFA}       % The actual profile.
+        /OutputConditionIdentifier (Custom) % TODO: A better solution is a
+                                            %       a string from the ICC
+                                            %       Registry, but Custom
+                                            %       is always valid.
+      >> /PUT pdfmark
+
+    % And now add the OutputIntent to the Catalog dictionary
+    [ {Catalog} << /OutputIntents [ {OutputIntent_PDFA} ]>> /PUT pdfmark
+
+    % Step 2, define the XML file and read it into the PDF
+    % First we define the PDF stream to contain the XML invoice
+    [ /_objdef {InvoiceStream} /type /stream /OBJ pdfmark
+    % Fill in the dictionary elements we need. We believe the
+    % ModDate is not useful so it's just set to a valid value.
+    [ {InvoiceStream} <<
+        /Type /EmbeddedFile
+        /Subtype (text/xml) cvn
+        /Params <<
+          /ModDate systemdict /ZUGFeRDDateTime known
+            {ZUGFeRDDateTime}
+            {(D:20130121081433+01'00')}
+            ifelse
+          /Size ZUGFeRDXMLFile status
+            {pop pop exch pop}
+            {(Failed to get file status!\n)print /status load /ioerror signalerror}
+            ifelse
+        >>
+      >> /PUT pdfmark
+    % Now read the data from the file and store it in the stream
+    [ {InvoiceStream} ZUGFeRDXMLFile (r) file /PUT pdfmark
+    % and close the stream
+    [ {InvoiceStream} /CLOSE pdfmark
+
+    % Step 3 create the File Specification dictionary for the embedded file
+    % Create the dictionary
+    [ /_objdef {FSDict} /type /dict /OBJ pdfmark
+    % Fill in the required dictionary elements
+    [ {FSDict}    <<
+      /Type /Filespec
+      /F ZUGFeRDDocumentFileName
+      /UF ZUGFeRDDocumentFileName SimpleUTF16BE
+      /Desc (ZUGFeRD electronic invoice)
+      /AFRelationship /Alternative
+      /EF <<
+          /F {InvoiceStream}
+          /UF {InvoiceStream}
+        >>
+      >>
+    /PUT pdfmark
+
+    % Step 4 Create the Associated Files dictionary to hold the FS dict
+    % Create the dictionary
+    [ /_objdef {AFArray} /type /array /OBJ pdfmark
+    % Put (append) the FS dictionary into the Associated Files array
+    [ {AFArray} {FSDict} /APPEND pdfmark
+
+    % Step 5 Add an entry in the Catalog dictionary containing the AF array
+    % Since Ghostscript 10.04.0 this is no longer required, providing the output file is
+    % PDF/A-3 or higher. The PDF/A-3 tech note 0010 (p28) clarifies that the /AF in the Catalog
+    % is mandatory and GS 10.04.0 will emit one itself.
+    %
+    % This line retained for historical reference, and as an example for cases where the output
+    % is not PDF/A-3
+    %
+    %    [ {Catalog} << /AF {AFArray} >> /PUT pdfmark
+
+    % Step 6 use the EMBED pdfmark to add the XML file and FS dictionary to the PDF name tree
+    [ /Name ZUGFeRDDocumentFileName /FS {FSDict} /EMBED pdfmark
+
+    % Step 7 Add the extra ZUGFeRD XML data to the Metadata
+    [ /XML ZUGFeRDMetadata /Ext_Metadata pdfmark
+  }
+  {
+    % No ICC Profile definition on the command line;
+    % chide the user and give them an example
+    (\nERROR - ZUGFeRDProfile has not been supplied, you must supply an ICC profile) print
+    (\n        Producing a potentially INVALID PDF/A file.                       \n) print
+    Usage
+  } ifelse
+}
+{
+  % No XML invoice definition on the command line;
+  % chide the user and give them an example
+  (\nERROR - ZUGFeRDXMLFile has not been supplied, you must supply a XML invoice file) print
+  (\n        Producing a PDF/A file, NOT a ZUGFeRD file.                           \n) print
+  Usage
+} ifelse
+
+% That's all the ZUGFeRD and PDF/A-3 setup completed,
+% all that remains now is to run the input file
+
+%%EOF

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zugpferd
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Alexander Zeitler
@@ -66,9 +66,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-description: Read, write and convert electronic invoices according to EN 16931. Supports
-  UBL 2.1 and UN/CEFACT CII syntaxes with dedicated classes for Invoice, Credit Note,
-  Corrected Invoice, Self-billed Invoice, Partial Invoice and Prepayment Invoice.
+description: Read, write and convert XRechnung and ZUGFeRD electronic invoices (e-Rechnung)
+  according to EN 16931. Supports UBL 2.1 and UN/CEFACT CII syntaxes with dedicated
+  classes for Invoice, Credit Note, Corrected Invoice, Self-billed Invoice, Partial
+  Invoice and Prepayment Invoice.
 email:
 executables: []
 extensions: []
@@ -96,9 +97,18 @@ files:
 - lib/zugpferd/model/tax_breakdown.rb
 - lib/zugpferd/model/tax_subtotal.rb
 - lib/zugpferd/model/trade_party.rb
+- lib/zugpferd/pdf.rb
+- lib/zugpferd/pdf/embedder.rb
 - lib/zugpferd/ubl/mapping.rb
 - lib/zugpferd/ubl/reader.rb
 - lib/zugpferd/ubl/writer.rb
+- lib/zugpferd/validation.rb
+- lib/zugpferd/validation/mustang_validator.rb
+- lib/zugpferd/validation/pdf_validator.rb
+- lib/zugpferd/validation/schema_validator.rb
+- lib/zugpferd/validation/schematron_validator.rb
+- vendor/zugferd/default_rgb.icc
+- vendor/zugferd/zugferd.ps
 homepage: https://alexzeitler.github.io/zugpferd/
 licenses:
 - MIT
@@ -106,7 +116,7 @@ metadata:
   source_code_uri: https://github.com/alexzeitler/zugpferd
   homepage_uri: https://alexzeitler.github.io/zugpferd/
   changelog_uri: https://github.com/alexzeitler/zugpferd/blob/master/CHANGELOG.md
-  documentation_uri: https://alexzeitler.github.io/zugpferd/
+  documentation_uri: https://www.rubydoc.info/gems/zugpferd
   bug_tracker_uri: https://github.com/alexzeitler/zugpferd/issues
 post_install_message:
 rdoc_options: []
@@ -126,5 +136,5 @@ requirements: []
 rubygems_version: 3.5.20
 signing_key:
 specification_version: 4
-summary: EN 16931 E-Invoice library for Ruby (UBL + CII)
+summary: XRechnung & ZUGFeRD e-invoicing library for Ruby (UBL + CII)
 test_files: []