unova_factur_x 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 996d6179a21f9d65c42b237554a9107c0acb063cbf0c9ac6119ede6a73c429bd
+  data.tar.gz: 7767c329f0a3e09c314d52a81880111e96059af0223841fb07f9daa524e3c382
+SHA512:
+  metadata.gz: 8eb85a7a4c6e7919a761b0c32c54e06bc3ec46ca0bf32595a3ad3999cf161e1808739f9acf11cd318be36fab01d41e7130ab3a588bedb4dd917329d5eeda999b
+  data.tar.gz: 4ecc28ab0f7a1d9253bc8d211e1fd360b5c77096deccf3eed6fb014199029bd3543a6bc8965814e62118fb5e1287bfc851a22e7255e78b55fd812db80c449b57

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="asdf: 3.1.1" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/unova_factur_x.iml" filepath="$PROJECT_DIR$/.idea/unova_factur_x.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/unova_factur_x.iml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="ast (v2.4.2, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.5.22, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="io-console (v0.7.2, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="irb (v1.14.1, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="json (v2.7.4, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="language_server-protocol (v3.17.0.3, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parallel (v1.26.3, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parser (v3.3.5.0, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="psych (v5.1.2, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="racc (v1.8.1, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.1.1, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.2.1, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rdoc (v6.7.0, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="regexp_parser (v2.9.2, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="reline (v0.5.10, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop (v1.67.0, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop-ast (v1.32.3, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ruby-progressbar (v1.13.0, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="stringio (v3.1.1, asdf: 3.1.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unicode-display_width (v2.6.0, asdf: 3.1.1) [gem]" level="application" />
+  </component>
+</module>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-06-04
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Rodolphe Limousin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,160 @@
+# UnovaFacturX
+
+Gem permettant la génération de factures et d'avoirs au format Factur-X.
+
+## Installation
+
+Ajouter la gem au gemfile et faire un ```bundle install```
+```ruby
+gem "unova_factur_x", git: "git@gitlab.unova.fr:unova-factur-x/unova-factur-x.git"
+```
+
+## Utilisation
+
+Il suffit d'appeler la fonction generate de la gem à l'envoi du PDF par le controller avec les paramètres suivants :
+- pdf: Le fichier PDF de la facture/avoir à transformer en Factur-X. Prends en charge ces deux formes :
+  - Depuis un fichier :
+    ```ruby
+    path = ActiveStorage::Blob.service.send(:path_for, @invoice.file.key)
+    pdf = File.open(path, 'rb')
+    ```
+  - Depuis une génération Prawn :
+    ```ruby
+    pdf = DocumentPdf.new(**options).render
+    ```
+- document_hash: Le hash d'entrée pour la génération du XML, voir ci-après pour plus de détails.
+- [optionnel] type: Le type de document (:invoice par défaut):
+  - :invoice pour une facture,
+  - :credit pour un avoir,
+- [optionnel] with_validations: true ou false, si à true, va essayer de valider les données du hash fourni pour Factur-X /!\ Nécessite Java, à désactiver si Java non présent /!\ (true par défaut)
+- [optionnel] devise: pour configurer la monnaie utilisée sur la facture/l'avoir (Euros 'EUR' par défaut).
+```ruby
+# Exemple d'utilisation :
+send_data UnovaFacturX.generate(pdf: pdf, document_hash: document_hash, type: :invoice, with_validations: true, devise: "USD"),
+          filename: "Factur-X.pdf",
+          type: 'application/pdf',
+          disposition: 'attachment'
+```
+
+Pour le hash du document attendu :
+- Les montants fournis doivent être arithmétiquement cohérents, aucune correction automatique n’est effectuée.
+- Tous les attributs de la facture/du crédit sont attendus en String.
+- Respecter la forme ci-dessous :
+```ruby
+# Exemple de hash pour une facture (Même chose pour un avoir /!\ Ne pas mettre les valeurs de l'avoir en négatif /!\) :
+document_hash = {
+    id: "Numéro unique de facture (BT-1) [OBLIGATOIRE]",
+    issue_date: "Date d'émission format YYYYMMDD (BT-2) [OBLIGATOIRE]",
+    
+    seller: {
+      name: "Nom légal du vendeur (BT-27) [OBLIGATOIRE]",
+      legal_id: "Identifiant légal (SIREN/SIRET) (BT-30) [OPTIONNEL]",
+      vat_number: "Numéro TVA avec préfixe pays acheteur (ex: FR123...) (BT-31) [OPTIONNEL]",
+      address: {
+        line1: "Rue (BT-35) [OBLIGATOIRE]",
+        line2: "Complément adresse [OPTIONNEL]",
+        postcode: "Code postal (BT-38) [OBLIGATOIRE]",
+        city: "Ville (BT-37) [OBLIGATOIRE]",
+        country: "Code pays ISO 3166-1 alpha-2 (BT-40) [OBLIGATOIRE]",
+      }
+    },
+    
+    # [BLOC OBLIGATOIRE]
+    buyer: {
+      id: "Identifiant interne client (BT-46) [OPTIONNEL]",
+      name: "Nom légal du client (BT-44) [OBLIGATOIRE]",
+      vat_number: "Numéro TVA avec préfixe pays acheteur (ex: FR123...) (BT-48) [OPTIONNEL]",
+      contact: { # [OPTIONNEL]
+        name: "Nom du contact client (BT-56) [OPTIONNEL]",
+      },
+      address: {
+        line1: "Rue (BT-50) [OBLIGATOIRE]",
+        line2: "Complément adresse [OPTIONNEL]",
+        postcode: "Code postal (BT-53) [OBLIGATOIRE]",
+        city: "Ville (BT-52) [OBLIGATOIRE]",
+        country: "Code pays ISO 3166-1 alpha-2 (BT-55) [OBLIGATOIRE]",
+      }
+    },
+    
+    # [BLOC OPTIONNEL]
+    delivery: {
+      gln: "Identifiant GLN (schemeID 0088) (BT-71) [OPTIONNEL]",
+      gln_scheme: "0088: GLN (GS1), 0002: SIRENE (France), 9906: SIRET, 9915: TVA intracom FR, 0060: DUNS [OPTIONNEL | OBLIGATOIRE SI GLN]",
+      date: "Date réelle de livraison format YYYYMMDD (BT-72) [OPTIONNEL]",
+      address: {
+        line1: "Rue livraison (BT-75) [OPTIONNEL]",
+        line2: "Complément adresse livraison [OPTIONNEL]",
+        postcode: "Code postal livraison (BT-75) [OPTIONNEL]",
+        city: "Ville livraison (BT-74) [OPTIONNEL]",
+        country: "Code pays ISO 3166-1 alpha-2 (BT-76) [OPTIONNEL]",
+      }
+    },
+    
+    # [BLOC OBLIGATOIRE] (minimum 1 item)
+    items: [
+      {
+        line_id: "Numéro de ligne (BT-126) [OBLIGATOIRE]",
+        seller_assigned_id: "Identifiant interne produit (BT-155) [OPTIONNEL]",
+        name: "Désignation produit/service (BT-153) [OBLIGATOIRE]",
+        quantity: "Quantité (BT-129) [OBLIGATOIRE]",
+        unit_code: "Code unité UN/ECE Rec20 (ex: H87, C62, DAY) (BT-130) [OBLIGATOIRE]",
+        price_ht: "Prix unitaire net HT (BT-146) [OBLIGATOIRE]",
+        vat_rate: "Taux TVA (BT-152) [OBLIGATOIRE]",
+        vat_category: "Catégorie TVA (S, Z, E, AE...) (BT-151) [OBLIGATOIRE]",
+        discount: { # [OPTIONNEL]
+          total_amount: "Montant de la remise applicable à la ligne de facture (BT-136) [OPTIONNEL sauf si discount]",
+          percentage: "Pourcentage de remise applicable à la ligne de facture (BT-138) [OPTIONNEL sauf si discount]",
+          # reason OU reason_code [OBLIGATOIRE] si bloc présent
+          reason: "Motif de la remise applicable à la ligne de facture (BT-139) [OPTIONNEL sauf si discount]",
+          reason_code: "Code de motif de la remise applicable à la ligne de facture (BT-140) [OPTIONNEL sauf si discount]"
+        },
+        line_total: "Montant net de la ligne HT = Quantité × Prix unitaire net (BT-131)"
+      }
+    ],
+    
+    # [BLOC OBLIGATOIRE]
+    payment_means: {
+      type_code: "Code UNCL 4461 (30 = virement) (BT-81) [OBLIGATOIRE]",
+      iban: "IBAN bénéficiaire (BT-84) [OBLIGATOIRE si virement]",
+    },
+    
+    # [BLOC OBLIGATOIRE]
+    vat_breakdown: [
+      {
+        vat_category: "Catégorie TVA (BT-118) [OBLIGATOIRE]",
+        vat_rate: "Taux TVA % (BT-119) [OBLIGATOIRE]",
+        taxable_amount: "Base HT pour ce taux (BT-116) [OBLIGATOIRE]",
+        tax_amount: "Montant TVA pour ce taux (BT-117) [OBLIGATOIRE]",
+        # exemption_reason OU exemption_reason_code [OBLIGATOIRE] si vat_category = "E" (Exempt)
+        exemption_reason: "Motif d'exonération de la TVA (BT-120)",
+        exemption_reason_code: "Code de motif d'exonération de la TVA (BT-121)"
+      }
+    ],
+    
+    # [BLOC OPTIONNEL]
+    discount: [ # Ce bloc est un tableau avec un item par taux de TVA d'item. Il doit donc avoir la même longueur que le bloc vat_breakdown
+      {
+        vat_category: "Catégorie TVA (BT-118) [OBLIGATOIRE si le bloc est présent]",
+        vat_rate: "Taux TVA % (BT-119) [OBLIGATOIRE si le bloc est présent]",
+        total_amount: "Montant total de la remise pour le taux de TVA [OBLIGATOIRE si percentage présent]",
+        percentage: "% de remise au niveau du document si la remise est en % (BT-94) [OPTIONNEL]",
+        # reason OU reason_code [OBLIGATOIRE] si bloc présent
+        reason: "Motif de la remise au niveau du document (BT-97)",
+        reason_code: "Code de motif de la remise au niveau du document (BT-98)",
+      }
+    ],
+    
+    # [BLOC OBLIGATOIRE]
+    totals: {
+      line_total_ht: "Total HT lignes (BT-106) [OBLIGATOIRE]",
+      total_discount: "Somme des remises au niveau du document (BT-107) [OBLIGATOIRE si bloc discount présent]",
+      tax_basis_total_ht: "Total bases taxables (BT-109) [OBLIGATOIRE]",
+      tax_total: "Total TVA (BT-110) [OBLIGATOIRE]",
+      grand_total_ttc: "Total TTC (BT-112) [OBLIGATOIRE]",
+      amount_due: "Montant à payer (BT-115) [OPTIONNEL]",
+      # due_date OU description [OBLIGATOIRE] si amount_due est défini et positif
+      due_date: "Date due du paiement format YYYYMMDD (BT-9)",
+      description: "Termes du paiement (BT-20)"
+    }
+}
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/unova_factur_x/factur_x_generator.rb

@@ -0,0 +1,106 @@
+module UnovaFacturX
+  class FacturXGenerator
+    def initialize(pdf:, xml:)
+      @pdf = pdf
+      @xml = xml
+    end
+
+    def call
+      # Override règles de base HexaPDF pour pas qu'il force la version en 2.0
+      begin
+        ::HexaPDF::Type::Catalog.send(:remove_field, :AF)
+      rescue StandardError
+        nil
+      end
+      ::HexaPDF::Type::Catalog.define_field :AF, type: ::HexaPDF::PDFArray
+
+      # Génération du XML grace au services (hash + xml)
+      xml_doc = @xml
+      xml_string = xml_doc.to_xml
+      xml_io = StringIO.new(xml_string)
+
+      # Transformation du PDF en StringIO
+      pdf_io = @pdf.is_a?(File) ? @pdf : StringIO.new(@pdf)
+      pdf_io.rewind
+
+      # Création d'un nouveau PDF avec HexaPDF
+      doc = ::HexaPDF::Document.new(io: pdf_io)
+      doc.task(:pdfa, level: "3b") # PDF format A/3
+
+      # Ajout du XML au PDF
+      file_spec = doc.files.add(
+        xml_io,
+        name: "factur-x.xml",
+        description: 'Factur-X XML',
+        mime_type: 'text/xml',
+        )
+      file_spec[:AFRelationship] = :Alternative
+
+      doc.catalog[:AF] ||= []
+      doc.catalog[:AF] << file_spec
+
+      # Réécriture des Metadata pour correspondre à Factur-X
+      doc.metadata.custom_metadata(metadata_xml)
+
+      # Renvoi du PDF en StringIO
+      doc.write_to_string
+    end
+
+    private
+
+    def metadata_xml # TODO : Utiliser les bonnes valeurs
+      <<~XML
+        <rdf:Description rdf:about=""
+                         xmlns:pdfaExtension="http://www.aiim.org/pdfa/ns/extension/"
+                         xmlns:pdfaSchema="http://www.aiim.org/pdfa/ns/schema#"
+                         xmlns:pdfaProperty="http://www.aiim.org/pdfa/ns/property#">
+          <pdfaExtension:schemas>
+            <rdf:Bag>
+              <rdf:li rdf:parseType="Resource">
+                <pdfaSchema:schema>Factur-X PDFA Extension Schema</pdfaSchema:schema>
+                <pdfaSchema:namespaceURI>urn:factur-x:pdfa:CrossIndustryDocument:invoice:1p0#</pdfaSchema:namespaceURI>
+                <pdfaSchema:prefix>fx</pdfaSchema:prefix>
+                <pdfaSchema:property>
+                  <rdf:Seq>
+                    <rdf:li rdf:parseType="Resource">
+                      <pdfaProperty:name>DocumentType</pdfaProperty:name>
+                      <pdfaProperty:valueType>Text</pdfaProperty:valueType>
+                      <pdfaProperty:category>external</pdfaProperty:category>
+                      <pdfaProperty:description>The type of the document</pdfaProperty:description>
+                    </rdf:li>
+                    <rdf:li rdf:parseType="Resource">
+                      <pdfaProperty:name>DocumentFileName</pdfaProperty:name>
+                      <pdfaProperty:valueType>Text</pdfaProperty:valueType>
+                      <pdfaProperty:category>external</pdfaProperty:category>
+                      <pdfaProperty:description>The name of the embedded XML file</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>The version of the Factur-X specification</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>The conformance level of the Factur-X data</pdfaProperty:description>
+                    </rdf:li>
+                  </rdf:Seq>
+                </pdfaSchema:property>
+              </rdf:li>
+            </rdf:Bag>
+          </pdfaExtension:schemas>
+        </rdf:Description>
+
+        <rdf:Description rdf:about=""
+                         xmlns:fx="urn:factur-x:pdfa:CrossIndustryDocument:invoice:1p0#">
+          <fx:DocumentType>INVOICE</fx:DocumentType>
+          <fx:DocumentFileName>factur-x.xml</fx:DocumentFileName>
+          <fx:Version>1.0</fx:Version>
+          <fx:ConformanceLevel>EN 16931</fx:ConformanceLevel>
+        </rdf:Description>
+      XML
+    end
+  end
+end