Add postal address support

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    camt_parser (2.15.1)
+    camt_parser (2.16.0)
       nokogiri
 
 GEM

lib/camt_parser.rb

@@ -16,6 +16,7 @@
 require_relative "camt_parser/general/account"
 require_relative "camt_parser/general/batch_detail"
 require_relative "camt_parser/general/group_header"
+require_relative "camt_parser/general/postal_address"
 require_relative "camt_parser/general/transaction"
 require_relative "camt_parser/general/type/builder"
 require_relative "camt_parser/general/type/code"

lib/camt_parser/general/creditor.rb

@@ -28,5 +28,17 @@ def bic
     def bank_name
       @bank_name ||= xml_data.xpath('RltdAgts/CdtrAgt/FinInstnId/Nm/text()').text
     end
+
+    # @return [CamtParser::PostalAddress, nil]
+    def postal_address # May be missing
+      postal_address = [
+        xml_data.xpath('RltdPties/Cdtr/PstlAdr'),
+        xml_data.xpath('RltdPties/Cdtr/Pty/PstlAdr'),
+      ].reject(&:empty?).first
+
+      return nil if postal_address == nil || postal_address.empty?
+
+      @address ||= CamtParser::PostalAddress.new(postal_address)
+    end
   end
 end

lib/camt_parser/general/debitor.rb

@@ -28,5 +28,17 @@ def bic
     def bank_name
       @bank_name ||= xml_data.xpath('RltdAgts/DbtrAgt/FinInstnId/Nm/text()').text
     end
+
+    # @return [CamtParser::PostalAddress, nil]
+    def postal_address # May be missing
+      postal_address = [
+        xml_data.xpath('RltdPties/Dbtr/PstlAdr'),
+        xml_data.xpath('RltdPties/Dbtr/Pty/PstlAdr'),
+      ].reject(&:empty?).first
+
+      return nil if postal_address == nil || postal_address.empty?
+
+      @address ||= CamtParser::PostalAddress.new(postal_address)
+    end
   end
 end

lib/camt_parser/general/postal_address.rb

@@ -0,0 +1,51 @@
+module CamtParser
+  class PostalAddress
+
+    attr_reader :xml_data
+
+    def initialize(xml_data)
+      @xml_data = xml_data
+    end
+
+    # @return [Boolean]
+    def structured?
+      street_name != "" ||
+        building_number != "" ||
+        postal_code != "" ||
+        town_name != ""
+    end
+
+    # @return [Array<String>]
+    def lines # May be empty
+      xml_data.xpath('AdrLine').map do |x|
+        x.xpath('text()').text
+      end
+    end
+
+    # @return [String]
+    def street_name # May be missing
+      xml_data.xpath('StrtNm/text()').text
+    end
+
+    # @return [String]
+    def building_number # May be missing
+      xml_data.xpath('BldgNb/text()').text
+    end
+
+    # @return [String]
+    def postal_code # May be missing
+      xml_data.xpath('PstCd/text()').text
+    end
+
+    # @return [String]
+    def town_name # May be missing
+      xml_data.xpath('TwnNm/text()').text
+    end
+
+    # @return [String]
+    def country # May be missing
+      xml_data.xpath('Ctry/text()').text
+    end
+
+  end
+end

lib/camt_parser/general/transaction.rb

@@ -42,6 +42,10 @@ def bic
       credit? ? debitor.bic : creditor.bic
     end
 
+    def postal_address
+      credit? ? debitor.postal_address : creditor.postal_address
+    end
+
     def credit?
       !debit
     end

lib/camt_parser/version.rb

@@ -1,3 +1,3 @@
 module CamtParser
-  VERSION = '2.15.1'.freeze
+  VERSION = '2.16.0'.freeze
 end

spec/lib/camt_parser/general/creditor_spec.rb

@@ -17,10 +17,17 @@
   specify { expect(creditor.xml_data).to_not be_nil }
 
   context "version 8" do
-    let(:camt)           { CamtParser::File.parse('spec/fixtures/053/valid_example_v8.xml') }
-    let(:ex_entry)       { entries[2] }
+    let(:camt)     { CamtParser::File.parse('spec/fixtures/053/valid_example_v8.xml') }
+    let(:ex_entry) { entries[2] }
 
     specify { expect(creditor.name).to eq("DHL Express (Schweiz) AG") }
     specify { expect(creditor.bic).to eq("UBSWCHZH80A") }
   end
+
+  context "with address" do
+    let(:camt) { CamtParser::File.parse('spec/fixtures/053/valid_example_with_debit.xml') }
+
+    specify { expect(creditor.name).to eq("Testkonto Nummer 2") }
+    specify { expect(creditor.postal_address.lines).to eq(["Berlin", "Infinite Loop 2", "12345"]) }
+  end
 end

spec/lib/camt_parser/general/debitor_spec.rb

@@ -17,9 +17,16 @@
   specify { expect(debitor.xml_data).to_not be_nil }
 
   context "version 8" do
-    let(:camt)           { CamtParser::File.parse('spec/fixtures/053/valid_example_v8.xml') }
+    let(:camt) { CamtParser::File.parse('spec/fixtures/053/valid_example_v8.xml') }
 
     specify { expect(debitor.name).to eq("Jon Doe") }
     specify { expect(debitor.bic).to eq("UBSWCHZH80A") }
   end
+
+  context "with address" do
+    let(:camt) { CamtParser::File.parse('spec/fixtures/053/valid_example_v8.xml') }
+
+    specify { expect(debitor.name).to eq("Jon Doe") }
+    specify { expect(debitor.postal_address.lines).to eq(["Hofstrasse 2", "CH-8000 Zürich"]) }
+  end
 end

spec/lib/camt_parser/general/postal_address_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+RSpec.describe CamtParser::PostalAddress do
+  let(:camt)           { CamtParser::File.parse('spec/fixtures/053/valid_example.xml') }
+  let(:statements)     { camt.statements }
+  let(:ex_stmt)        { statements[0] }
+  let(:entries)        { ex_stmt.entries }
+  let(:ex_entry)       { entries[0] }
+  let(:transactions)   { ex_entry.transactions }
+  let(:ex_transaction) { transactions[0] }
+  let(:address)        { ex_transaction.postal_address }
+
+  specify { expect(address.lines).to eq(["Berlin", "Infinite Loop 2", "12345"]) }
+  specify { expect(address.structured?).to eq(false) }
+  specify { expect(address.xml_data).to_not be_nil }
+
+  context "version 8" do
+    let(:camt)     { CamtParser::File.parse('spec/fixtures/053/valid_example_v8.xml') }
+    let(:ex_entry) { entries[2] }
+
+    specify { expect(address.lines).to eq(["Hochstrasse 5", "4052 Basel"]) }
+    specify { expect(address.country).to eq("CH") }
+    specify { expect(address.structured?).to eq(false) }
+    specify { expect(address.street_name).to eq("") }
+  end
+
+  context "with structured address" do
+    let(:camt)           { CamtParser::File.parse('spec/fixtures/053/valid_example_v4.xml') }
+    let(:ex_entry)       { entries[6] }
+    let(:ex_transaction) { transactions[1] }
+    let(:entity)         { ex_transaction.debitor }
+    let(:address)        { entity.postal_address }
+
+    specify { expect(entity.name).to eq("Rutschmann Pia") }
+    specify { expect(address.structured?).to eq(true) }
+    specify { expect(address.street_name).to eq("Marktgasse") }
+    specify { expect(address.building_number).to eq("28") }
+    specify { expect(address.postal_code).to eq("9400") }
+    specify { expect(address.town_name).to eq("Rorschach") }
+    specify { expect(address.country).to eq("CH") }
+  end
+end

spec/lib/camt_parser/general/transaction_spec.rb

@@ -41,6 +41,7 @@
 
     specify { expect(ex_transaction.creditor).to be_kind_of(CamtParser::Creditor) }
     specify { expect(ex_transaction.debitor).to be_kind_of(CamtParser::Debitor) }
+    specify { expect(ex_transaction.postal_address).to be_kind_of(CamtParser::PostalAddress) }
     specify { expect(ex_transaction.remittance_information)
       .to eq("TEST BERWEISUNG MITTELS BLZUND KONTONUMMER - DTA") }
     specify { expect(ex_transaction.iban).to eq("DE09300606010012345671") }