ubl 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f37938a0758a7354e8fa16557aeadbb9733e8c249a649b17eb9095f2ba5fd97
-  data.tar.gz: 58b6ae9d4e7ed3701e01bfb05a0fe2b958d2f5adbd8f006912fe95a1ce8f9924
+  metadata.gz: b7910f61d2fb9d3441defbd3a471c8dee214fcc2328430ddc74564e03839e02f
+  data.tar.gz: 94702d68716de735e38896e7c927fadb216917f422b1ed9cc58f8aac697541aa
 SHA512:
-  metadata.gz: defb4760407b2645e202042072a7e5ef70a931d9226405d6e455594a58b9d737a3f05ad5f8c36447be774a7c2afdfde9e95ea601ac2d1b5b2858637c2c1a2f1a
-  data.tar.gz: ba81dad3036adf7487e85c369338b606c9e19c304483eafae29d04203353b686be70b85ca01260f65623c45b2dd593b469af1388394c19befaf22357569c5e0b
+  metadata.gz: 274419fa7cbf69522f8ba6ade35415aead6750e63efce27f623e136accb2705dd29fc339dfcdfea63f9a9a16fcf0bd3587ef07e46aa3d073048af2724ed6d19b
+  data.tar.gz: 52e29b3ecaa743ea11d525f743ec0de05207a4c0d2980509ee9ec53fd2ccffb8a6901ab4758ec9fcdc99713ca16411d483cd73fa63e05605dba5ac736a957496

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
 
@@ -20,15 +20,12 @@ gem install ubl
 
 ## 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.pdffile = "./invoice.pdf"
 
 invoice.add_supplier(
   name: "ACME Corp",

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.3"
+  VERSION = "0.1.0"
 end

data/lib/ubl.rb

@@ -1,8 +1,18 @@
 require_relative "ubl/builder"
 
+##
+# Generate UBL (Universal Business Language) documents,
+# such as invoices and credit notes, compliant with the Peppol network.
 module Ubl
   class Invoice < UblBuilder
-    def initialize(ubl_be = false)
+    ##
+    # 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
 
@@ -28,7 +38,14 @@ module Ubl
   end
 
   class CreditNote < UblBuilder
-    def initialize(ubl_be = false)
+    ##
+    # 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
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ubl
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - roel4d
@@ -37,7 +37,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
-description: Generate UBL documents for Peppol
+description: Generate UBL (Universal Business Language) documents, such as invoices
+  and credit notes, compliant with the Peppol network.
 email:
 - roel4d@webding.org
 executables: []
@@ -74,5 +75,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.7
 specification_version: 4
-summary: Generate UBL documents
+summary: Generate UBL documents for Peppol
 test_files: []