xrechnung 0.1.0

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in xrechnung.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop-rspec", "~> 2.1"

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    xrechnung (0.1.0)
+      builder (~> 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    builder (3.2.4)
+    diff-lcs (1.4.4)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    multi_xml (0.6.0)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.13.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    rubyzip (2.3.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httparty
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop-rspec (~> 2.1)
+  rubyzip (~> 2.0)
+  xrechnung!
+
+BUNDLED WITH
+   2.2.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Digineo GmbH
+
+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,44 @@
+# Xrechnung
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/xrechnung`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xrechnung'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install xrechnung
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/digineo/xrechnung. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/digineo/xrechnung/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Xrechnung project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/digineo/xrechnung/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,55 @@
+require "pathname"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+namespace :validator do
+  VALIDATOR_SOURCES = {
+    tool: {
+      filename:    "validator/validationtool-1.4.1-standalone.jar",
+      release_url: "https://github.com/itplr-kosit/validator/releases/download/v1.4.1/validationtool-1.4.1.zip",
+    },
+    scenarios: {
+      filename:    "validator/scenarios.xml",
+      release_url: "https://github.com/itplr-kosit/validator-configuration-xrechnung/releases/download/release-2020-12-31/validator-configuration-xrechnung_2.0.1_2020-12-31.zip",
+    }
+  }
+
+  VALIDATOR_SOURCES.each do |_, v|
+    base    = Pathname.new(__dir__).join("validator")
+    zipfile = base.join(File.basename(v[:release_url]))
+
+    file zipfile do
+      require "httparty"
+
+      base.mkpath unless base.exist?
+
+      res = HTTParty.get(v[:release_url], follow_redirects: true)
+      File.open(zipfile, "wb") { |f| f.write res.body }
+    end
+
+    file v[:filename] => zipfile do
+      require "zip"
+
+      Zip::File.foreach(zipfile) do |entry|
+        entry.extract base.join(entry.name)
+      end
+    end
+  end
+
+  desc "Download official validator and scenarios"
+  task download: VALIDATOR_SOURCES.map { |_, v| v[:filename] }
+
+  desc "Run validator on test fixtures"
+  task run: :download do
+    fixtures  = Pathname.new(__dir__).join("spec/fixtures/*.xml")
+    output    = Pathname.new(__dir__).join("validator/results").tap(&:mkpath)
+    tool      = VALIDATOR_SOURCES[:tool][:filename]
+    scenarios = VALIDATOR_SOURCES[:scenarios][:filename]
+
+    sh "java -jar #{tool} -s #{scenarios} --output-directory #{output} --html --disable-gui #{fixtures}"
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xrechnung"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/xrechnung.rb

@@ -0,0 +1,326 @@
+require "xrechnung/version"
+require "date"
+require "xrechnung/currency"
+require "xrechnung/quantity"
+require "xrechnung/id"
+require "xrechnung/member_container"
+require "xrechnung/contact"
+require "xrechnung/party_legal_entity"
+require "xrechnung/party_tax_scheme"
+require "xrechnung/postal_address"
+require "xrechnung/party"
+require "xrechnung/payee_financial_account"
+require "xrechnung/payment_means"
+require "xrechnung/tax_total"
+require "xrechnung/tax_category"
+require "xrechnung/tax_subtotal"
+require "xrechnung/legal_monetary_total"
+require "xrechnung/item"
+require "xrechnung/allowance_charge"
+require "xrechnung/price"
+require "xrechnung/invoice_line"
+require "xrechnung/invoice_document_reference"
+require "builder"
+
+module Xrechnung
+  class Error < StandardError; end
+
+  class Document
+    include MemberContainer
+
+    # Invoice number BT-1
+    #
+    # Eine eindeutige Kennung der Rechnung, die diese im System des Verkäufers identifiziert.
+    # Anmerkung: Es ist kein „identification scheme“ zu verwenden.
+    #
+    # @!attribute id
+    #   @return [String]
+    member :id, type: String
+
+    # Invoice issue date BT-2
+    #
+    # Das Datum, an dem die Rechnung ausgestellt wurde.
+    #
+    # @!attribute issue_date
+    #   @return [Date]
+    member :issue_date, type: Date
+
+    # Payment due date BT-9
+    #
+    # Das Fälligkeitsdatum des Rechnungsbetrages.
+    #
+    # @!attribute due_date
+    #   @return [Date]
+    member :due_date, type: Date
+
+    # Invoice type code BT-3
+    # Ein Code, der den Funktionstyp der Rechnung angibt.
+    #
+    # Anmerkung: Der Rechnungstyp muss gemäß UNTDID 1001 spezifiziert werden.
+    # Folgende Codes aus der Codeliste sollen verwendet werden:
+    # • 326 (Partial invoice)
+    # • 380 (Commercial invoice)
+    # • 384 (Corrected invoice)
+    # • 389 (Self-billed invoice)
+    # • 381 (Credit note)
+    # • 875 (Partial construction invoice)
+    # • 876 (Partial final construction invoice)
+    # • 877 (Final construction invoice)
+    #
+    # @!attribute invoice_type_code
+    #   @return [Integer]
+    member :invoice_type_code, type: Integer, default: 380
+
+    # Invoice currency code BT-5
+    #
+    # Die Währung, in der alle Rechnungsbeträge angegeben werden, ausgenommen ist der Umsatzsteuer-
+    # Gesamtbetrag, der in der Abrechnungswährung anzugeben ist.
+    # Anmerkung: Nur eine Währung ist in der Rechnung zu verwenden, der „Invoice total VAT amount in accounting
+    # currency“ (BT-111) ist in der Abrechnungswährung auszuweisen. Die gültigen Währungen sind bei der ISO 4217
+    # „Codes for the representation of currencies and funds“ registriert. Nur die Alpha-3-Darstellung darf verwendet
+    # werden.
+    #
+    # @!attribute document_currency_code
+    #   @return [String]
+    member :document_currency_code, type: String, default: "EUR"
+
+    # INVOICE NOTE BG-1
+    #
+    # Eine Gruppe von Informationselementen für rechnungsrelevante Erläuterungen
+    # mit Hinweisen auf den Rechnungsbetreff.
+    #
+    # @!attribute notes
+    #   @return [Array]
+    member :notes, type: Array, default: []
+
+    # Purchase order reference BT-13
+    #
+    # Eine vom Erwerber ausgegebene Kennung für eine referenzierte Bestellung.
+    #
+    # @!attribute purchase_order_reference
+    #   @return [String]
+    member :purchase_order_reference, type: String
+
+    # Sales order reference BT-14
+    #
+    # Eine vom Verkäufer ausgegebene Kennung für einen referenzierten Auftrag.
+    #
+    # @!attribute sales_order_reference
+    #   @return [String]
+    member :sales_order_reference, type: String, optional: true
+
+    # Gruppe SELLER BG-4
+    #
+    # Eine Gruppe von Informationselementen, die Informationen über den Verkäufer liefern.
+    #
+    # @!attribute accounting_supplier_party
+    #   @return [Xrechnung::Party]
+    member :accounting_supplier_party, type: Xrechnung::Party
+
+    # BUYER BG-7
+    #
+    # Eine Gruppe von Informationselementen, die Informationen über den Erwerber liefern.
+    #
+    # @!attribute accounting_customer_party
+    #   @return [Xrechnung::Party]
+    member :accounting_customer_party, type: Xrechnung::Party
+
+    # Value added tax point date BT-7
+    #
+    # Das Datum, zu dem die Umsatzsteuer für den Verkäufer und für den Erwerber abrechnungsrelevant wird.
+    # Die Anwendung von BT-7 und 8 schließen sich gegenseitig aus.
+    #
+    # @!attribute tax_point_date
+    #   @return [Date]
+    member :tax_point_date, type: Date
+
+    # VAT accounting currency code BT-6
+    #
+    # Die für die Umsatzsteuer-Abrechnungs- und -Meldezwecke verwendete Währung, die im Land des Verkäufers gültig
+    # ist oder verlangt wird.
+    # Anmerkung: Zu Verwenden in Kombination mit „Invoice total VAT amount in accounting currency“ (BT-111), wenn
+    # die Umsatzsteuerabrechnungswährung von der Rechnungswährung abweicht. Die gültigen Währungen sind bei
+    # der ISO 4217 „Codes for the representation of currencies and funds“ registriert. Nur die Alpha-3-Darstellung darf
+    # verwendet werden.
+    #
+    # @!attribute tax_currency_code
+    #   @return [String]
+    member :tax_currency_code, type: String, default: "EUR"
+
+    # Buyer reference BT-10
+    #
+    # Ein vom Erwerber zugewiesener und für interne Lenkungszwecke benutzter Bezeichner.
+    # Anmerkung: Im Rahmen des Steuerungsprojekts eRechnung ist mit der so genannten Leitweg-ID eine
+    # Zuordnungsmöglichkeit entwickelt worden, deren verbindliche Nutzung von Bund und mehreren Ländern
+    # vorgegeben wird. Die Leitweg-ID ist prinzipiell für Bund, Länder und Kommunen einsetzbar. Für die Darstellung der
+    # Leitweg-ID wird das in XRechnung verpflichtende Feld Buyer Reference benutzt.
+    # Länder und Kommunen, die ihren Rechnungsstellern abweichend von der Leitweg-ID eigene Zuordnungsmuster
+    # mitteilen, können diese statt der Leitweg-ID im Feld Buyer Reference verwenden.
+    # Hinweis: Es existiert eine Handreichung zur Bildung der Leitweg-ID, die über die KoSIT zu erhalten ist (siehe Website
+    # XRechnung bzw. FAQ-Liste).
+    #
+    # @!attribute buyer_reference
+    #   @return [String]
+    member :buyer_reference, type: String
+
+    # @!attribute billing_reference
+    #   @return [Xrechnung::InvoiceDocumentReference]
+    member :billing_reference, type: Xrechnung::InvoiceDocumentReference, optional: true
+
+    # Contract reference BT-12
+    #
+    # Eine eindeutige Bezeichnung des Vertrages (z. B. Vertragsnummer).
+    #
+    # @!attribute contract_document_reference_id
+    #   @return [String]
+    member :contract_document_reference_id, type: String
+
+    # Project reference BT-11
+    #
+    # Die Kennung eines Projektes, auf das sich die Rechnung bezieht.
+    #
+    # @!attribute project_reference_id
+    #   @return [String]
+    member :project_reference_id, type: String
+
+    # SELLER TAX REPRESENTATIVE PARTY BG-11
+    #
+    # Eine Gruppe von Informationselementen, die Informationen über den
+    # Steuervertreter des Verkäufers liefern.
+    #
+    # @!attribute tax_representative_party
+    #   @return [Xrechnung::Party]
+    member :tax_representative_party, type: Xrechnung::Party, optional: true
+
+    # PAYMENT INSTRUCTIONS BG-16
+    #
+    # Eine Gruppe von Informationselementen, die Informationen darüber liefern, wie die Zahlung
+    # erfolgen soll.
+    #
+    # @!attribute payment_means
+    #   @return [Xrechnung::PaymentMeans]
+    member :payment_means, type: Xrechnung::PaymentMeans
+
+    # Payment terms BT-20
+    #
+    # Eine Textbeschreibung der Zahlungsbedingungen, die für den fälligen Zahlungsbetrag gelten (einschließlich
+    # Beschreibung möglicher Skonto- und Verzugsbedingungen). Dieses Informationselement kann mehrere Zeilen und
+    # mehrere Angaben zu Zahlungsbedingungen beinhalten und sowohl unstrukturierten als strukturierten Text enthalten.
+    # Der unstrukturierte Text darf dabei keine # enthalten.
+    #
+    # @!attribute payment_terms_note
+    #   @return [String]
+    member :payment_terms_note, type: String
+
+    # VAT BREAKDOWN BG-23
+    #
+    # Eine Gruppe von Informationselementen, die Informationen über die
+    # Umsatzsteueraufschlüsselung in verschiedene Kategorien liefern.
+    #
+    # @!attribute tax_total
+    #   @return [Xrechnung::TaxTotal]
+    member :tax_total, type: Xrechnung::TaxTotal
+
+    # DOCUMENT TOTALS BG-22
+    #
+    # Eine Gruppe von Informationselementen, die die monetären Gesamtbeträge der Rechnung
+    # liefern.
+    #
+    # @!attribute legal_monetary_total
+    #   @return [Xrechnung::LegalMonetaryTotal]
+    member :legal_monetary_total, type: Xrechnung::LegalMonetaryTotal
+
+    # INVOICE LINE BG-25
+    #
+    # Eine Gruppe von Informationselementen, die Informationen über einzelne
+    # Rechnungspositionen liefern.
+    #
+    # @!attribute invoice_lines
+    #   @return [Array]
+    member :invoice_lines, type: Array, default: []
+
+    def to_xml(indent: 2, target: "")
+      xml = Builder::XmlMarkup.new(indent: indent, target: target)
+      xml.instruct! :xml, version: "1.0", encoding: "UTF-8"
+
+      xml.ubl :Invoice, \
+        "xmlns:ubl"          => "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2",
+        "xmlns:cac"          => "urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2",
+        "xmlns:cbc"          => "urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2",
+        "xmlns:xsi"          => "http://www.w3.org/2001/XMLSchema-instance",
+        "xsi:schemaLocation" => "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2 http://docs.oasis-open.org/ubl/os-UBL-2.1/xsd/maindoc/UBL-Invoice-2.1.xsd" do
+        xml.cbc :CustomizationID, "urn:cen.eu:en16931:2017#compliant#urn:xoev-de:kosit:standard:xrechnung_2.0"
+        xml.cbc :ID, id
+        xml.cbc :IssueDate, issue_date
+        xml.cbc :DueDate, due_date
+        xml.cbc :InvoiceTypeCode, invoice_type_code
+
+        notes.each do |note|
+          xml.cbc :Note, note
+        end
+
+        xml.cbc :TaxPointDate, tax_point_date
+        xml.cbc :DocumentCurrencyCode, document_currency_code
+        xml.cbc :TaxCurrencyCode, tax_currency_code
+        xml.cbc :BuyerReference, buyer_reference
+
+        xml.cac :OrderReference do
+          xml.cbc :ID, purchase_order_reference
+          unless members[:sales_order_reference][:optional] && sales_order_reference.nil?
+            xml.cbc :SalesOrderID, sales_order_reference
+          end
+        end
+
+        unless members[:billing_reference][:optional] && billing_reference.nil?
+          xml.cac :BillingReference do
+            billing_reference&.to_xml(xml)
+          end
+        end
+
+        xml.cac :ContractDocumentReference do
+          xml.cbc :ID, contract_document_reference_id
+        end
+
+        xml.cac :ProjectReference do
+          xml.cbc :ID, project_reference_id
+        end
+
+        xml.cac :AccountingSupplierParty do
+          accounting_supplier_party&.to_xml(xml)
+        end
+
+        xml.cac :AccountingCustomerParty do
+          accounting_customer_party&.to_xml(xml)
+        end
+
+        unless members[:tax_representative_party][:optional] && tax_representative_party.nil?
+          xml.cac :TaxRepresentativeParty do
+            tax_representative_party&.to_xml(xml)
+          end
+        end
+
+        xml.cac :PaymentMeans do
+          payment_means&.to_xml(xml)
+        end
+
+        xml.cac :PaymentTerms do
+          xml.cbc :Note, payment_terms_note
+        end
+
+        xml.cac :TaxTotal do
+          tax_total&.to_xml(xml)
+        end
+
+        xml.cac :LegalMonetaryTotal do
+          legal_monetary_total&.to_xml(xml)
+        end
+
+        invoice_lines.each do |invoice_line|
+          invoice_line&.to_xml(xml)
+        end
+      end
+
+      target
+    end
+  end
+end