Merge pull request #22 from mnin/add-support-for-additional-referenced-documents

Add Support For Additional Referenced Documents

Author: halfbyte

lib/secretariat.rb

@@ -24,3 +24,4 @@
 require_relative 'secretariat/line_item'
 require_relative 'secretariat/validator'
 require_relative 'secretariat/tax'
+require_relative 'secretariat/attachment'

lib/secretariat/attachment.rb

@@ -0,0 +1,83 @@
+=begin
+Copyright Jan Krutisch
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+
+require 'mime/types'
+
+module Secretariat
+  Attachment = Struct.new('Attachment',
+    :filename,
+    :type_code,
+    :base64,
+
+    keyword_init: true
+  ) do
+    include Versioner
+
+    def errors
+      @errors
+    end
+
+    def valid?
+      @errors = []
+
+      @errors << "the attribute filename needs to be present" if filename.nil? || filename == ''
+      @errors << "the attribute type_code needs to be present" if type_code.nil? || type_code == ''
+      @errors << "the attribute base64 needs to be present" if base64.nil? || base64 == ''
+
+      if type_code.to_i != 916
+        @errors << "we only support type_code 916"
+        return false
+      end
+
+      if mime_code.nil?
+        @errors << "cannot determine content type for filename: #{filename}"
+        return false
+      end
+      
+      if !ALLOWED_MIME_TYPES.include?(mime_code)
+        @errors << "the mime_code '#{mime_code}' is not allowed"
+        return false
+      end
+
+      return true
+    end
+
+    def mime_code
+      type_for = MIME::Types.type_for(filename).first
+      return if type_for.nil?
+
+      type_for.content_type
+    end
+
+    def to_xml(xml, attachment_index, version: 2, validate: true)
+      if validate && !valid?
+        pp errors
+        raise ValidationError.new("Attachment #{attachment_index} is invalid", errors)
+      end
+
+      xml['ram'].AdditionalReferencedDocument do
+        xml['ram'].IssuerAssignedID filename
+        xml['ram'].TypeCode type_code
+        xml['ram'].Name filename
+        xml['ram'].AttachmentBinaryObject(mimeCode: mime_code, filename: filename) do
+          xml.text(base64)
+        end
+      end
+    end
+  end
+end

lib/secretariat/constants.rb

@@ -15,6 +15,14 @@
 =end
 
 module Secretariat
+  ALLOWED_MIME_TYPES = [
+    "application/pdf",
+    "application/vnd.oasis.opendocument.spreadsheet",
+    "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+    "image/jpeg",
+    "image/png",
+    "text/csv"
+  ]
 
   TAX_CATEGORY_CODES = {
    :STANDARDRATE => "S",

lib/secretariat/invoice.rb

@@ -41,6 +41,7 @@ module Secretariat
     :grand_total_amount,
     :due_amount,
     :paid_amount,
+    :attachments,
 
     keyword_init: true
   ) do
@@ -193,6 +194,13 @@ def to_xml(version: 1, validate: true)
               xml['ram'].BuyerTradeParty do
                 buyer.to_xml(xml, version: version)
               end
+              if version == 2
+                if Array(attachments).size > 0
+                  attachments.each_with_index do |attachment, index|
+                    attachment.to_xml(xml, index, version: version, validate: validate)
+                  end
+                end
+              end
             end
 
             delivery = by_version(version, 'ApplicableSupplyChainTradeDelivery', 'ApplicableHeaderTradeDelivery')
@@ -275,7 +283,7 @@ def to_xml(version: 1, validate: true)
             end
             if version == 1
               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
           end

secretariat.gemspec

@@ -28,8 +28,10 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'nokogiri', '~> 1.10'
   s.add_runtime_dependency 'bigdecimal', '~> 3.1'
+  s.add_runtime_dependency 'mime-types', '~> 3.6.0'
 
   s.add_development_dependency 'minitest', '~> 5.13'
   s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'base64', '~> 0.2.0'
   s.requirements << "To run the validator, Java must be installed"
 end

test/fixtures/example.pdf

@@ -1,5 +1,6 @@
 require 'test_helper'
 require 'date'
+require 'base64'
 
 module Secretariat
   class InvoiceTest < Minitest::Test
@@ -55,6 +56,63 @@ def make_eu_invoice
       )
     end
 
+    def make_eu_invoice_with_attachment
+      seller = TradeParty.new(
+        name: 'Depfu inc',
+        street1: 'Quickbornstr. 46',
+        city: 'Hamburg',
+        postal_code: '20253',
+        country_id: 'DE',
+        vat_id: 'DE304755032'
+      )
+      buyer = TradeParty.new(
+        name: 'Depfu inc',
+        street1: 'Quickbornstr. 46',
+        city: 'Hamburg',
+        postal_code: '20253',
+        country_id: 'SE',
+        vat_id: 'SE304755032'
+      )
+      line_item = LineItem.new(
+        name: 'Depfu Starter Plan',
+        quantity: 1,
+        gross_amount: '29',
+        net_amount: '29',
+        unit: :PIECE,
+        charge_amount: '29',
+        tax_category: :REVERSECHARGE,
+        tax_percent: 0,
+        tax_amount: "0",
+        origin_country_code: 'DE',
+        currency_code: 'EUR'
+      )
+      attachment = Attachment.new(
+        filename: 'example.pdf',
+        type_code: 916,
+        base64: Base64.encode64(open(File.join(__dir__, 'fixtures/example.pdf')).read)
+      )
+      Invoice.new(
+        id: '12345',
+        issue_date: Date.today,
+        service_period_start: Date.today,
+        service_period_end: Date.today + 30,
+        seller: seller,
+        buyer: buyer,
+        line_items: [line_item],
+        currency_code: 'USD',
+        payment_type: :CREDITCARD,
+        payment_text: 'Kreditkarte',
+        tax_category: :REVERSECHARGE,
+        tax_amount: '0',
+        basis_amount: '29',
+        grand_total_amount: 29,
+        due_amount: 0,
+        paid_amount: 29,
+        payment_due_date: Date.today + 14,
+        attachments: [attachment]
+      )
+    end
+
     def make_de_invoice
       seller = TradeParty.new(
         name: 'Depfu inc',
@@ -225,6 +283,19 @@ def test_simple_eu_invoice_against_schematron
       assert_equal [], errors
     end
 
+    def test_simple_eu_invoice_with_attachment_against_schematron
+      xml = make_eu_invoice_with_attachment.to_xml(version: 2)
+      v = Validator.new(xml, version: 2)
+      errors = v.validate_against_schematron
+      if !errors.empty?
+        puts xml
+        errors.each do |error|
+          puts "#{error}"
+        end
+      end
+      assert_equal [], errors
+    end
+
     def test_simple_de_invoice_v2
       xml = make_de_invoice.to_xml(version: 2)
       v = Validator.new(xml, version: 2)