ubl 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d85586554b03950c5f00fc767da60c5cc179650d76c9afab96f40752dc83269b
-  data.tar.gz: b767d4c66653121049e27d3208e6d518efe8093b240f8b05b852f82ce98b0605
+  metadata.gz: f257c1e68bac4286b082be4900f49a27fc736a69dc7cafa7de79cca2219e9035
+  data.tar.gz: 15be033154369701934e55ddc4ae34a2270032f129e8f9409927a4b06174f00e
 SHA512:
-  metadata.gz: 84c1e2c7e3335681e7aef44f3404cbe2d520d9003882a2991ed47c5e8ef21c4ab18d7db484048b626e97d51761f81b329fe10e2d0a93daff5ef3eb327cf96dcd
-  data.tar.gz: 73332157c0330f6d1c7c1ba28e76e4bfc164d51c6fccba007ac36d37f927241897906725b9d7624632eeb2a9bd0a9209e3254c7f1213fdd6057b4e17002fe3af
+  metadata.gz: 63d7d62032fc619e8756655f2e737cc17bb5f54b9452478bdf15aadb3c040430f54a1db90e647fe5696182c719f33f2d22ff3649d5ade31c38ed8f8758f8f99d
+  data.tar.gz: 8e9ef76a121e0288be720acd30d14bb38747c0ed5e19f22abed25ec5768ba57ca4640d17dd547ce0b9f7be988d139cac7a667a4e3085ee4dac871c39b82c37fd

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/ubl.svg)](https://badge.fury.io/rb/ubl)
+
 # Ubl
 
 Generate UBL invoices and credit notes for Peppol
@@ -16,9 +18,42 @@ if bundler is not being used to manage dependencies, install the gem by executin
 gem install ubl
 ```
 
-## usage
+## Example
+
+```ruby
+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.add_supplier(
+  name: "ACME Corp",
+  country: "BE",
+  vat_id: "BE0123456749",
+  address: "Main Street 123",
+  city: "Brussels",
+  postal_code: "1000"
+)
+
+invoice.add_customer(
+  name: "Customer Ltd",
+  country: "BE",
+  vat_id: "BE0123456749",
+  address: "Customer Lane 456",
+  city: "Antwerpen",
+  postal_code: "1012"
+)
+
+invoice.add_line(name: "Consulting Services", quantity: 10, unit_price: 100.0, tax_rate: 21.0)
+invoice.add_line(name: "Software License", quantity: 1, unit_price: 500.0, tax_rate: 21.0)
+
+invoice.build
+```
 
-todo: write usage instructions here
 
 ## development
 

data/lib/ubl/builder.rb

@@ -5,8 +5,6 @@ require "date"
 require "base64"
 
 module Ubl
-  class Error < StandardError; end
-
   class UblBuilder
     attr_accessor :invoice_nr, :issue_date, :due_date, :currency, :supplier,
       :customer, :invoice_lines, :tax_total, :legal_monetary_total, :pdffile
@@ -15,8 +13,8 @@ module Ubl
     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(ubl_be = false)
-      @ubl_be = ubl_be
+    def initialize(extension = nil)
+      @ubl_be = extension == "UBL_BE"
       @issue_date = Date.today
       @due_date = @issue_date + 30
       @currency = "EUR"

data/lib/ubl/version.rb

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

data/lib/ubl.rb

@@ -0,0 +1,72 @@
+require_relative "ubl/builder"
+
+##
+# The Invoice and CreditNote class generates UBL (Universal Business Language) compliant XML
+# documents following PEPPOL standards.
+module Ubl
+  class Invoice < UblBuilder
+    ##
+    # Creates a new Invoice instance.
+    #
+    # == Parameters
+    # * +extension+ - (String) Optional. Set to +"UBL_BE"+ to generate UBL.BE compliant invoices
+    #   for Belgian requirements. Defaults to +nil+ for standard PEPPOL format.
+    #
+    def initialize(extension = nil)
+      super
+    end
+
+    def build
+      builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
+        xml.Invoice(namespaces) do
+          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)
+        end
+      end
+      builder.to_xml
+    end
+  end
+
+  class CreditNote < UblBuilder
+    ##
+    # Creates a new CreditNote instance.
+    #
+    # == Parameters
+    # * +extension+ - (String) Optional. Set to +"UBL_BE"+ to generate UBL.BE compliant
+    #   credit notes for Belgian requirements. Defaults to +nil+ for standard PEPPOL format.
+    #
+    def initialize(extension = nil)
+      super
+    end
+
+    def build
+      builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
+        xml.CreditNote(namespaces.merge("xmlns" => "urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2")) do
+          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)
+        end
+      end
+      builder.to_xml
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ubl
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - roel4d
@@ -48,8 +48,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/credit_note.rb
-- lib/invoice.rb
+- lib/ubl.rb
 - lib/ubl/builder.rb
 - lib/ubl/version.rb
 - sig/ubl.rbs

data/lib/credit_note.rb

@@ -1,29 +0,0 @@
-require_relative "ubl/builder"
-
-module Ubl
-  class CreditNote < UblBuilder
-    def initialize(ubl_be)
-      super
-    end
-
-    def build
-      builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
-        xml.CreditNote(namespaces.merge("xmlns" => "urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2")) do
-          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)
-        end
-      end
-      builder.to_xml
-    end
-  end
-end

data/lib/invoice.rb

@@ -1,29 +0,0 @@
-require_relative "ubl/builder"
-
-module Ubl
-  class Invoice < UblBuilder
-    def initialize(ubl_be)
-      super
-    end
-
-    def build
-      builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
-        xml.Invoice(namespaces) do
-          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)
-        end
-      end
-      builder.to_xml
-    end
-  end
-end