brot 0.1.1 → 0.3.0

data/test/currency_support_test.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+
+class CurrencySupportTest < Minitest::Test
+  DOCUMENT_ATTRIBUTES = {
+    message_id: 'MSG-20260313-01',
+    payment_information_id: 'PMT-20260313-01',
+    initiating_party_name: 'Example Debtor GmbH',
+    debtor_name: 'Example Debtor GmbH',
+    debtor_iban: 'DE12500105170648489890',
+    debtor_bic: 'INGDDEFFXXX',
+    requested_execution_date: Date.new(2026, 3, 13),
+    created_at: Time.utc(2026, 3, 13, 12, 0, 0)
+  }.freeze
+  TRANSFER_ATTRIBUTES = {
+    amount: '1250.50',
+    creditor_name: 'Example Supplier GmbH',
+    creditor_iban: 'DE89370400440532013000',
+    creditor_bic: 'COBADEFFXXX',
+    end_to_end_id: 'INV-2026-0001',
+    remittance_information: 'Invoice 2026-0001',
+    instruction_id: 'INSTR-2026-0001'
+  }.freeze
+  TRANSFER_OVERRIDE_KEYS = %i[
+    amount
+    creditor_bic
+    creditor_iban
+    creditor_name
+    currency
+    end_to_end_id
+    instruction_id
+    purpose_code
+    remittance_information
+  ].freeze
+  PAIN_001_001_12_NS = {
+    'ns' => 'urn:iso:std:iso:20022:tech:xsd:pain.001.001.12'
+  }.freeze
+  PAIN_001_001_03_NS = {
+    'ns' => 'urn:iso:std:iso:20022:tech:xsd:pain.001.001.03'
+  }.freeze
+
+  def test_serializes_transfer_currency_for_version_twelve
+    parsed = Nokogiri::XML(document(version: Brot::PainVersion::PAIN_001_001_12, currency: 'usd').to_xml)
+    currency = parsed.at_xpath('//ns:Amt/ns:InstdAmt', PAIN_001_001_12_NS).attribute('Ccy').value
+
+    assert_equal 'USD', currency
+  end
+
+  def test_supports_mixed_currencies_for_version_twelve
+    document = mixed_currency_document_for_version_twelve
+    parsed = Nokogiri::XML(document.to_xml)
+    amounts = parsed.xpath('//ns:Amt/ns:InstdAmt', PAIN_001_001_12_NS)
+    currencies = amounts.map { it['Ccy'] }
+
+    assert_equal %w[EUR USD], currencies
+    assert_predicate document.validate, :valid?
+  end
+
+  def test_serializes_transfer_currency_for_version_three
+    parsed = Nokogiri::XML(document(version: Brot::PainVersion::PAIN_001_001_03, currency: 'usd').to_xml)
+    currency = parsed.at_xpath('//ns:Amt/ns:InstdAmt', PAIN_001_001_03_NS).attribute('Ccy').value
+
+    assert_equal 'USD', currency
+  end
+
+  private
+
+  def document(**overrides)
+    attributes = DOCUMENT_ATTRIBUTES.merge(version: Brot::PainVersion::PAIN_001_001_03)
+    attributes.merge!(overrides)
+    attributes[:transfers] ||= [transfer(**transfer_overrides(overrides))]
+    Brot::Document.new(**attributes)
+  end
+
+  def transfer(**overrides) = Brot::Transfer.new(**TRANSFER_ATTRIBUTES, **overrides)
+
+  def transfer_overrides(overrides) = overrides.slice(*TRANSFER_OVERRIDE_KEYS)
+
+  def mixed_currency_document_for_version_twelve
+    document(
+      version: Brot::PainVersion::PAIN_001_001_12,
+      transfers: [
+        transfer(currency: 'EUR'),
+        usd_transfer
+      ]
+    )
+  end
+
+  def usd_transfer
+    transfer(
+      amount: '99.95',
+      currency: 'USD',
+      creditor_name: 'Example Vendor LLC',
+      creditor_iban: 'FR7630006000011234567890189',
+      creditor_bic: 'AGRIFRPP',
+      end_to_end_id: 'INV-2026-0002',
+      remittance_information: 'Invoice 2026-0002',
+      instruction_id: 'INSTR-2026-0002'
+    )
+  end
+end

data/test/document_test.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+
+EXPECTED_DOCUMENT_NAMESPACES = {
+  Brot::PainVersion::PAIN_001_001_12 => 'urn:iso:std:iso:20022:tech:xsd:pain.001.001.12',
+  Brot::PainVersion::PAIN_001_001_03 => 'urn:iso:std:iso:20022:tech:xsd:pain.001.001.03'
+}.freeze
+DOCUMENT_ATTRIBUTES = {
+  message_id: 'MSG-20260313-01',
+  payment_information_id: 'PMT-20260313-01',
+  initiating_party_name: 'Example Debtor GmbH',
+  debtor_name: 'Example Debtor GmbH',
+  debtor_iban: 'DE12500105170648489890',
+  debtor_bic: 'INGDDEFFXXX',
+  requested_execution_date: Date.new(2026, 3, 13),
+  created_at: Time.utc(2026, 3, 13, 12, 0, 0)
+}.freeze
+TRANSFER_ATTRIBUTES = {
+  amount: '1250.50',
+  creditor_name: 'Example Supplier GmbH',
+  creditor_iban: 'DE89370400440532013000',
+  creditor_bic: 'COBADEFFXXX',
+  end_to_end_id: 'INV-2026-0001',
+  remittance_information: 'Invoice 2026-0001',
+  instruction_id: 'INSTR-2026-0001'
+}.freeze
+TRANSFER_OVERRIDE_KEYS = %i[
+  amount
+  creditor_bic
+  creditor_iban
+  creditor_name
+  currency
+  end_to_end_id
+  instruction_id
+  purpose_code
+  remittance_information
+].freeze
+
+class DocumentTest < Minitest::Test
+  def test_defaults_to_the_default_supported_version
+    assert_equal Brot::PainVersion::PAIN_001_001_03, document.version
+  end
+
+  def test_accepts_a_pain_version_object
+    assert_equal Brot::PainVersion::PAIN_001_001_12,
+                 document(version: Brot::PainVersion::PAIN_001_001_12).version
+  end
+
+  def test_serializes_the_expected_namespace_for_each_version
+    EXPECTED_DOCUMENT_NAMESPACES.each do |version, namespace|
+      assert_equal namespace, parsed_document(version).root.namespace.href
+    end
+  end
+
+  def test_serializes_group_header_values_for_each_version
+    assert_for_each_version('//ns:GrpHdr/ns:MsgId', 'MSG-20260313-01')
+    assert_for_each_version('//ns:GrpHdr/ns:NbOfTxs', '1')
+    assert_for_each_version('//ns:GrpHdr/ns:CtrlSum', '1250.50')
+  end
+
+  def test_serializes_payment_metadata_for_each_version
+    assert_for_each_version('//ns:PmtTpInf/ns:SvcLvl/ns:Cd', 'SEPA')
+    assert_for_each_version('//ns:Amt/ns:InstdAmt', '1250.50')
+
+    EXPECTED_DOCUMENT_NAMESPACES.each_key do |version|
+      assert_equal 'EUR',
+                   parsed_document(version).at_xpath('//ns:Amt/ns:InstdAmt', ns(version)).attribute('Ccy').value
+    end
+  end
+
+  def test_serializes_remittance_information_for_each_version
+    assert_for_each_version('//ns:RmtInf/ns:Ustrd', 'Invoice 2026-0001')
+  end
+
+  def test_serializes_version_specific_requested_execution_dates
+    assert_xpath(Brot::PainVersion::PAIN_001_001_12, '//ns:ReqdExctnDt/ns:Dt', '2026-03-13')
+    assert_xpath(Brot::PainVersion::PAIN_001_001_03, '//ns:ReqdExctnDt', '2026-03-13')
+  end
+
+  def test_serializes_version_specific_bic_element_names
+    assert_xpath(Brot::PainVersion::PAIN_001_001_12, '//ns:DbtrAgt/ns:FinInstnId/ns:BICFI', 'INGDDEFFXXX')
+    assert_xpath(Brot::PainVersion::PAIN_001_001_03, '//ns:DbtrAgt/ns:FinInstnId/ns:BIC', 'INGDDEFFXXX')
+  end
+
+  def test_serializes_notprovided_when_bic_is_missing_for_each_version
+    EXPECTED_DOCUMENT_NAMESPACES.each_key do |version|
+      parsed = Nokogiri::XML(document(version:, debtor_bic: nil, creditor_bic: nil).to_xml)
+
+      assert_equal 'NOTPROVIDED', parsed.at_xpath('//ns:DbtrAgt/ns:FinInstnId/ns:Othr/ns:Id', ns(version)).content
+      assert_equal 'NOTPROVIDED', parsed.at_xpath('//ns:CdtrAgt/ns:FinInstnId/ns:Othr/ns:Id', ns(version)).content
+    end
+  end
+
+  def test_validates_generated_xml_against_the_bundled_xsd_for_each_version
+    EXPECTED_DOCUMENT_NAMESPACES.each_key do |version|
+      assert_path_exists Brot::Schema.bundled_xsd_path(version)
+      assert_predicate document(version:).validate, :valid?
+    end
+  end
+
+  def test_schema_validate_infers_the_version_from_the_xml_namespace
+    assert_predicate Brot::Schema.validate(document.to_xml(pretty: false)), :valid?
+  end
+
+  def test_validate_bang_returns_a_valid_result_for_documents_and_raw_xml
+    assert_predicate document.validate!, :valid?
+    assert_predicate Brot::Schema.validate!(document.to_xml(pretty: false)), :valid?
+  end
+
+  def test_rejects_an_invalid_iban
+    error = assert_raises(Brot::ValidationError) { invalid_document }
+
+    assert_equal 'iban is invalid', error.message
+  end
+
+  def test_rejects_an_unsupported_version
+    error = assert_raises(Brot::ValidationError) { document(version: :'pain.001.999.99') }
+
+    assert_equal 'version must be one of pain.001.001.12, pain.001.001.03', error.message
+  end
+
+  private
+
+  def assert_for_each_version(xpath, expected)
+    EXPECTED_DOCUMENT_NAMESPACES.each_key { |version| assert_xpath(version, xpath, expected) }
+  end
+
+  def assert_xpath(version, xpath, expected)
+    assert_equal expected,
+                 parsed_document(version).at_xpath(xpath, ns(version)).content
+  end
+
+  def document(version: Brot::PainVersion::PAIN_001_001_03, **overrides)
+    transfer_overrides = transfer_attributes_from(overrides)
+    attributes = DOCUMENT_ATTRIBUTES.merge(transfers: [transfer(**transfer_overrides)], version:)
+    attributes[:debtor_bic] = overrides[:debtor_bic] if overrides.key?(:debtor_bic)
+    Brot::Document.new(**attributes)
+  end
+
+  def invalid_document = Brot::Document.new(**DOCUMENT_ATTRIBUTES, transfers: [transfer], debtor_iban: 'INVALID')
+
+  def transfer_attributes_from(overrides)
+    overrides.slice(*TRANSFER_OVERRIDE_KEYS)
+  end
+
+  def parsed_document(version)
+    @parsed_documents ||= {}
+    @parsed_documents[version] ||= Nokogiri::XML(document(version:).to_xml)
+  end
+
+  def transfer(**overrides) = Brot::Transfer.new(**TRANSFER_ATTRIBUTES, **overrides)
+
+  def ns(version) = { 'ns' => EXPECTED_DOCUMENT_NAMESPACES.fetch(version) }
+end

data/test/transfer_test.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+
+class TransferTest < Minitest::Test
+  ATTRIBUTES = {
+    amount: '1250.50',
+    creditor_name: 'Example Supplier GmbH',
+    creditor_iban: 'DE89370400440532013000',
+    creditor_bic: 'COBADEFFXXX',
+    end_to_end_id: 'INV-2026-0001',
+    remittance_information: 'Invoice 2026-0001',
+    instruction_id: 'INSTR-2026-0001'
+  }.freeze
+
+  def test_defaults_currency_to_eur
+    assert_equal 'EUR', transfer.currency
+  end
+
+  def test_normalizes_currency_to_uppercase
+    assert_equal 'USD', transfer(currency: 'usd').currency
+  end
+
+  def test_rejects_an_invalid_currency
+    error = assert_raises(Brot::ValidationError) { transfer(currency: 'EURO') }
+
+    assert_equal 'currency is invalid', error.message
+  end
+
+  private
+
+  def transfer(**overrides) = Brot::Transfer.new(**ATTRIBUTES, **overrides)
+end