secretariat 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6d3c5177f9a94e1341b1b533cfe34b91f9babe7eafa5d483cbf4b5f489509c0
-  data.tar.gz: d51e684d34ac4fc61007cd6243c26cc8cfd31df95799b39079841d6e23b352f8
+  metadata.gz: 78a5b530fb987800431c180f91436cd9d538ed364f478aa17ddee805e85fc2f3
+  data.tar.gz: c4d569c8923b971e91eb5d1862f1e8484ddaf402cb62b6e405c4bee24ba2518f
 SHA512:
-  metadata.gz: a1c7ea742126169c1b97b0ce347d8d7f6830f5eabb5542b814ae9313c9a0c4d904076124fccd18a182e217ce1a4e87008bc6e5350f7f53b562fee8795855486e
-  data.tar.gz: f228bac7b78241d5437b61fb1d9505c0ebb2ed2608f7489cf5145da34a662b5efd50a87090cf3b9ca27af9e2af6708865e3cf7039e0c466fc48711f3347017cb
+  metadata.gz: 7dbdd370a0790c03b4f2fdbbefa16c3653e5554236e97b25eb7ff778ec1253a57e1323166ada9e8010fd5b47266ceee0bfc5e3c4e0f4d31a98f8ffd2d417f5d1
+  data.tar.gz: 61c934e0e8994226b61ad2780695c610d86000265cb0e95478d994f3740143f5849c3662be0fe2e8754cc5ef02aff1176f2e7753a5036437cb087a39d833fb56

data/lib/secretariat/helpers.rb

@@ -15,5 +15,12 @@ module Secretariat
         xml.text(format(amount, round: 4, digits: digits))
       end
     end
+
+    def self.date_element(xml, date)
+      date = date.strftime("%Y%m%d") if date.respond_to?(:strftime)
+      xml['udt'].DateTimeString(format: '102') do
+        xml.text(date)
+      end
+    end
   end
 end

data/lib/secretariat/invoice.rb

@@ -20,12 +20,18 @@ module Secretariat
   Invoice = Struct.new("Invoice",
     :id,
     :issue_date,
+    :service_period_start,
+    :service_period_end,
     :seller,
     :buyer,
+    :buyer_reference,
     :line_items,
     :currency_code,
     :payment_type,
     :payment_text,
+    :payment_terms_text,
+    :payment_due_date,
+    :payment_iban,
     :tax_category,
     :tax_percent,
     :tax_amount,
@@ -104,12 +110,12 @@ module Secretariat
       )
     end
 
-    def to_xml(version: 1)
+    def to_xml(version: 1, validate: true)
       if version < 1 || version > 2
         raise 'Unsupported Document Version'
       end
 
-      unless valid?
+      if validate && !valid?
         raise ValidationError.new("Invoice is invalid", errors)
       end
 
@@ -141,19 +147,23 @@ module Secretariat
                 xml.text(issue_date.strftime("%Y%m%d"))
               end
             end
+            
           end
           transaction = by_version(version, 'SpecifiedSupplyChainTradeTransaction', 'SupplyChainTradeTransaction')
           xml['rsm'].send(transaction) do
 
             if version == 2
               line_items.each_with_index do |item, i|
-                item.to_xml(xml, i + 1, version: version) # one indexed
+                item.to_xml(xml, i + 1, version: version, validate: validate) # one indexed
               end
             end
 
             trade_agreement = by_version(version, 'ApplicableSupplyChainTradeAgreement', 'ApplicableHeaderTradeAgreement')
 
             xml['ram'].send(trade_agreement) do
+              if buyer_reference
+                xml['ram'].BuyerReference buyer_reference
+              end
               xml['ram'].SellerTradeParty do
                 seller.to_xml(xml, version: version)
               end
@@ -184,6 +194,11 @@ module Secretariat
               xml['ram'].SpecifiedTradeSettlementPaymentMeans do
                 xml['ram'].TypeCode payment_code
                 xml['ram'].Information payment_text
+                if payment_iban
+                  xml['ram'].PayeePartyCreditorFinancialAccount do
+                    xml['ram'].IBANID payment_iban
+                  end
+                end
               end
               xml['ram'].ApplicableTradeTax do
 
@@ -198,8 +213,23 @@ module Secretariat
                 percent = by_version(version, 'ApplicablePercent', 'RateApplicablePercent')
                 xml['ram'].send(percent, Helpers.format(tax_percent))
               end
+              if version == 2 && service_period_start && service_period_end
+                xml['ram'].BillingSpecifiedPeriod do
+                  xml['ram'].StartDateTime do
+                    Helpers.date_element(xml, service_period_start)
+                  end
+                  xml['ram'].EndDateTime do
+                    Helpers.date_element(xml, service_period_end)
+                  end
+                end
+              end
               xml['ram'].SpecifiedTradePaymentTerms do
-                xml['ram'].Description "Paid"
+                xml['ram'].Description payment_terms_text || "Paid"
+                if payment_due_date
+                  xml['ram'].DueDateDateTime do
+                    Helpers.date_element(xml, payment_due_date)
+                  end
+                end
               end
 
               monetary_summation = by_version(version, 'SpecifiedTradeSettlementMonetarySummation', 'SpecifiedTradeSettlementHeaderMonetarySummation')

data/lib/secretariat/line_item.rb

@@ -84,8 +84,8 @@ module Secretariat
       TAX_CATEGORY_CODES[tax_category] || 'S'
     end
 
-    def to_xml(xml, line_item_index, version: 2)
-      if !valid?
+    def to_xml(xml, line_item_index, version: 2, validate: true)
+      if validate && !valid?
         pp errors
         raise ValidationError.new("LineItem #{line_item_index} is invalid", errors)
       end

data/lib/secretariat/validator.rb

@@ -15,8 +15,13 @@ limitations under the License.
 =end
 
 require 'nokogiri'
+require 'tmpdir'
 
 module Secretariat
+
+  class ValidatorError < StandardError; end
+
+
   class Validator
     SCHEMATRON = [
       '../../schemas/zugferd_1/ZUGFeRD1p0.sch',
@@ -55,10 +60,27 @@ module Secretariat
       Dir.mktmpdir do |dir|
         docpath = File.join(dir, 'doc.xml')
         File.write(docpath, doc, mode: 'wb')
-        out = `java -jar bin/schxslt-cli.jar -v -d #{docpath} -s #{schematron_path}`
-        return [] if out.match("[valid]")
-        out.lines
+        jarpath = File.join(__dir__, '../..', 'bin', 'schxslt-cli.jar')
+        out = `java -jar #{jarpath} -v -d #{docpath} -s #{schematron_path}`
+        return [] if out.start_with?("[valid]")
+        return process_schematron_errors(out)
+      end
+    end
+
+    private
+
+    def process_schematron_errors(output)
+      errors = []
+      error_lines = output.lines.clone
+      error_lines.shift # get rid of file notice
+      
+      while(error_lines.length > 0) do
+        assert_error = error_lines.shift
+        _, ref = assert_error.split(" failed-assert ").map(&:strip)
+        error_description = error_lines.shift.strip
+        errors << ValidatorError.new("#{error_description} - Reference: #{ref}")
       end
+      errors
     end
   end
 end

data/lib/secretariat/version.rb

@@ -15,5 +15,5 @@ limitations under the License.
 =end
 
 module Secretariat
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: secretariat
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Jan Krutisch