sepa_file_parser 0.1.0

data/lib/sepa_file_parser/general/group_header.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module SepaFileParser
+  class GroupHeader
+
+    attr_reader :message_id,
+                :creation_date_time,
+                :additional_information,
+                :message_pagination,
+                :xml_data
+
+    def initialize(xml_data)
+      @xml_data               = xml_data
+      @message_id             = xml_data.xpath('MsgId/text()').text
+      @creation_date_time     = Time.parse(xml_data.xpath('CreDtTm/text()').text)
+      @message_pagination     = (x = xml_data.xpath('MsgPgntn')).empty? ? nil : MessagePagination.new(x)
+      @additional_information = xml_data.xpath('AddtlInf/text()').text
+    end
+  end
+
+  class MessagePagination
+
+    attr_reader :page_number,
+                :xml_data
+
+    def initialize(xml_data)
+      @xml_data            = xml_data
+      @page_number         = xml_data.xpath('PgNb/text()').text.to_i
+      @last_page_indicator = xml_data.xpath('LastPgInd/text()').text == 'true'
+    end
+
+    def last_page?
+      @last_page_indicator
+    end
+  end
+end

data/lib/sepa_file_parser/general/pain_entry.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  class PainEntry
+
+    attr_reader :xml_data
+
+    def initialize(xml_data)
+      @xml_data = xml_data
+
+      @amount = [
+        xml_data.xpath('Amt/InstdAmt').first,
+        xml_data.xpath('InstdAmt').first,
+      ].find { |a| a != nil }.text
+    end
+
+    def amount
+      SepaFileParser::Misc.to_amount(@amount)
+    end
+
+    def amount_in_cents
+      SepaFileParser::Misc.to_amount_in_cents(@amount)
+    end
+
+    # @return [String]
+    def currency
+      @currency ||= [
+        xml_data.xpath('Amt/InstdAmt/@Ccy').first,
+        xml_data.xpath('InstdAmt/@Ccy').first,
+      ].find { |a| a != nil }.text
+    end
+
+    def account
+      @account ||= SepaFileParser::Account.from_pain_data(
+                     xml_data,
+                     currency,
+                     'Cdtr',
+                   )
+    end
+
+    def remittance_information
+      @remittance_information ||= xml_data.xpath('RmtInf/Ustrd').text
+    end
+
+  end
+end

data/lib/sepa_file_parser/general/postal_address.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  class PostalAddress
+
+    attr_reader :xml_data
+
+    def initialize(xml_data)
+      @xml_data = xml_data
+    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

data/lib/sepa_file_parser/general/record.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  class Record
+
+    attr_reader :xml_data
+
+    def initialize(xml_data)
+      @xml_data = xml_data
+      @amount = xml_data.xpath('Amt/text()').text
+    end
+
+    def amount
+      SepaFileParser::Misc.to_amount(@amount)
+    end
+
+    def amount_in_cents
+      SepaFileParser::Misc.to_amount_in_cents(@amount)
+    end
+
+    def currency
+      @currency ||= xml_data.xpath('Amt/@Ccy').text
+    end
+
+    def type
+      @type ||= SepaFileParser::Type::Builder.build_type(xml_data.xpath('Tp'))
+    end
+
+    def charges_included?
+      @charges_included ||= xml_data.xpath('ChrgInclInd/text()').text.downcase == 'true'
+    end
+
+    def debit
+      @debit ||= xml_data.xpath('CdtDbtInd/text()').text.upcase == 'DBIT'
+    end
+
+    def credit?
+      !debit
+    end
+
+    def debit?
+      debit
+    end
+
+    def sign
+      credit? ? 1 : -1
+    end
+  end
+end

data/lib/sepa_file_parser/general/transaction.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  class Transaction
+
+    attr_reader :xml_data
+
+    def initialize(xml_data, debit, amount = nil, currency = nil)
+      @xml_data = xml_data
+      @debit    = debit
+      @amount   = parse_amount || amount
+      @currency = parse_currency || currency
+    end
+
+    def amount
+      SepaFileParser::Misc.to_amount(@amount)
+    end
+
+    def amount_in_cents
+      SepaFileParser::Misc.to_amount_in_cents(@amount)
+    end
+
+    def currency
+      @currency
+    end
+
+    def creditor
+      @creditor ||= SepaFileParser::Creditor.new(xml_data)
+    end
+
+    def debitor
+      @debitor ||= SepaFileParser::Debitor.new(xml_data)
+    end
+
+    def name
+      credit? ? debitor.name : creditor.name
+    end
+
+    def iban
+      credit? ? debitor.iban : creditor.iban
+    end
+
+    def bic
+      credit? ? debitor.bic : creditor.bic
+    end
+
+    def postal_address
+      credit? ? debitor.postal_address : creditor.postal_address
+    end
+
+    def credit?
+      !debit
+    end
+
+    def debit?
+      debit
+    end
+
+    def debit
+      @debit
+    end
+
+    def sign
+      credit? ? 1 : -1
+    end
+
+    def remittance_information
+      @remittance_information ||= begin
+        if (x = xml_data.xpath('RmtInf/Ustrd')).empty?
+          nil
+        else
+          x.collect(&:content).join(' ')
+        end
+      end
+    end
+
+    def swift_code
+      @swift_code ||= xml_data.xpath('BkTxCd/Prtry/Cd/text()').text.split('+')[0]
+    end
+
+    def reference
+      @reference ||= xml_data.xpath('Refs/InstrId/text()').text
+    end
+
+    def bank_reference # May be missing
+      @bank_reference ||= xml_data.xpath('Refs/AcctSvcrRef/text()').text
+    end
+
+    def end_to_end_reference # May be missing
+      @end_to_end_reference ||= xml_data.xpath('Refs/EndToEndId/text()').text
+    end
+
+    def mandate_reference # May be missing
+      @mandate_reference ||= xml_data.xpath('Refs/MndtId/text()').text
+    end
+
+    def creditor_reference # May be missing
+      @creditor_reference ||= xml_data.xpath('RmtInf/Strd/CdtrRefInf/Ref/text()').text
+    end
+
+    def transaction_id # May be missing
+      @transaction_id ||= xml_data.xpath('Refs/TxId/text()').text
+    end
+
+    def creditor_identifier # May be missing
+      @creditor_identifier ||= xml_data.xpath('RltdPties/Cdtr/Id/PrvtId/Othr/Id/text()').text
+    end
+
+    def payment_information # May be missing
+      @payment_information ||= xml_data.xpath('Refs/PmtInfId/text()').text
+    end
+
+    def additional_information # May be missing
+      @addition_information ||= xml_data.xpath('AddtlTxInf/text()').text
+    end
+
+    def reason_code # May be missing
+      @reason_code ||= xml_data.xpath('RtrInf/Rsn/Cd/text()').text
+    end
+
+    private
+
+    def parse_amount
+      if xml_data.xpath('Amt').any?
+        xml_data.xpath('Amt/text()').text
+      elsif xml_data.xpath('AmtDtls').any?
+        xml_data.xpath('AmtDtls//Amt/text()').first.text
+      end
+    end
+
+    def parse_currency
+      if xml_data.xpath('Amt').any?
+        xml_data.xpath('Amt/@Ccy').text
+      elsif xml_data.xpath('AmtDtls').any?
+        xml_data.xpath('AmtDtls//Amt/@Ccy').first.text
+      end
+    end
+  end
+end

data/lib/sepa_file_parser/general/type/builder.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  module Type
+    class Builder
+      def self.build_type(xml_data)
+        if xml_data.xpath('Prtry').any?
+          Proprietary.new(
+            xml_data.xpath('Prtry/Id/text()').text,
+            xml_data.xpath('Prtry/Issr/text()').text
+          )
+        elsif xml_data.xpath('Cd').any?
+          Code.new(xml_data.xpath('Cd/text()').text)
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/sepa_file_parser/general/type/code.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  module Type
+    class Code
+      attr_reader :code
+
+      def initialize(code)
+        @code = code
+      end
+    end
+  end
+end

data/lib/sepa_file_parser/general/type/proprietary.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  module Type
+    class Proprietary
+      attr_reader :id, :issuer
+
+      def initialize(id, issuer)
+        @id, @issuer = id, issuer
+      end
+    end
+  end
+end

data/lib/sepa_file_parser/misc.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  class Misc
+    class << self
+
+      # @param value [nil, String]
+      # @return [Integer, nil]
+      def to_amount_in_cents(value)
+        return nil if value == nil || value.strip == ''
+
+        # Using dollars and cents as representation for parts before and after the decimal separator
+        dollars, cents = value.split(/,|\./)
+        cents ||= '0'
+        format('%s%s', dollars, cents.ljust(2, '0')).to_i
+      end
+
+      # @param value [nil, String]
+      # @return [BigDecimal, nil]
+      def to_amount(value)
+        return nil if value == nil || value.strip == ''
+
+        BigDecimal(value.tr(',', '.'))
+      end
+
+    end
+  end
+end

data/lib/sepa_file_parser/pain001/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  module Pain001
+    class Base
+      attr_reader :group_header, :payment_informations, :xml_data
+
+      def initialize(xml_data)
+        @xml_data = xml_data
+        # CstmrCdtTrfInitn = Customer Credit Transaction Initiation
+        grphdr = xml_data.xpath('CstmrCdtTrfInitn/GrpHdr')
+        @group_header = SepaFileParser::GroupHeader.new(grphdr)
+        payment_informations = xml_data.xpath('CstmrCdtTrfInitn/PmtInf')
+        @payment_informations = payment_informations.map{ |x| PaymentInformation.new(x) }
+      end
+    end
+  end
+end

data/lib/sepa_file_parser/pain001/payment_information.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  module Pain001
+    class PaymentInformation
+
+      attr_reader :xml_data
+
+      def initialize(xml_data)
+        @xml_data = xml_data
+      end
+
+      def identification
+        @identification ||= xml_data.xpath('PmtInfId/text()').text
+      end
+
+      def requested_execution_date
+        @requested_execution_date ||= Time.parse(xml_data.xpath('ReqdExctnDt/text()').text)
+      end
+
+      def account
+        @account ||= SepaFileParser::Account.from_pain_data(
+                       xml_data,
+                       entries.first.currency,
+                       'Dbtr',
+                     )
+      end
+
+      def entries
+        @entries ||= xml_data.xpath('CdtTrfTxInf').map do |x|
+                       SepaFileParser::PainEntry.new(x)
+                     end
+      end
+
+      def source
+        xml_data.to_s
+      end
+
+      def self.parse(xml)
+        self.new(Nokogiri::XML(xml).xpath('PmtInf'))
+      end
+    end
+  end
+end

data/lib/sepa_file_parser/pain008/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  module Pain008
+    class Base
+      attr_reader :group_header, :payment_informations, :xml_data
+
+      def initialize(xml_data)
+        @xml_data = xml_data
+        # CstmrDrctDbtInitn = Customer Direct Debig Initiation
+        grphdr = xml_data.xpath('CstmrDrctDbtInitn/GrpHdr')
+        @group_header = SepaFileParser::GroupHeader.new(grphdr)
+        payment_informations = xml_data.xpath('CstmrDrctDbtInitn/PmtInf')
+        @payment_informations = payment_informations.map{ |x| PaymentInformation.new(x) }
+      end
+    end
+  end
+end

data/lib/sepa_file_parser/pain008/payment_information.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  module Pain008
+    class PaymentInformation
+
+      attr_reader :xml_data
+
+      def initialize(xml_data)
+        @xml_data = xml_data
+      end
+
+      def identification
+        @identification ||= xml_data.xpath('PmtInfId/text()').text
+      end
+
+      def requested_collection_date
+        @requested_collection_date ||= Time.parse(xml_data.xpath('ReqdColltnDt/text()').text)
+      end
+
+      def account
+        @account ||= SepaFileParser::Account.from_pain_data(
+                       xml_data,
+                       entries.first.currency,
+                       'Cdtr',
+                     )
+      end
+
+      def entries
+        @entries ||= xml_data.xpath('DrctDbtTxInf').map do |x|
+                       SepaFileParser::PainEntry.new(x)
+                     end
+      end
+
+      def source
+        xml_data.to_s
+      end
+
+      def self.parse(xml)
+        self.new(Nokogiri::XML(xml).xpath('PmtInf'))
+      end
+    end
+  end
+end

data/lib/sepa_file_parser/register.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative './xml'
+
+# Add registrations
+## CAMT052
+SepaFileParser::Xml.register('urn:iso:std:iso:20022:tech:xsd:camt.052.001.02', :camt052)
+
+## CAMT053
+SepaFileParser::Xml.register('urn:iso:std:iso:20022:tech:xsd:camt.053.001.02', :camt053)
+SepaFileParser::Xml.register('urn:iso:std:iso:20022:tech:xsd:camt.053.001.04', :camt053)
+SepaFileParser::Xml.register('urn:iso:std:iso:20022:tech:xsd:camt.053.001.08', :camt053)
+SepaFileParser::Xml.register('urn:iso:std:iso:20022:tech:xsd:camt.053.001.10', :camt053)
+
+## CAMT054
+SepaFileParser::Xml.register('urn:iso:std:iso:20022:tech:xsd:camt.054.001.02', :camt054)
+SepaFileParser::Xml.register('urn:iso:std:iso:20022:tech:xsd:camt.054.001.04', :camt054)
+
+## PAIN001
+SepaFileParser::Xml.register('urn:iso:std:iso:20022:tech:xsd:pain.001.001.03', :pain001)
+
+## PAIN008
+SepaFileParser::Xml.register('urn:iso:std:iso:20022:tech:xsd:pain.008.003.02', :pain008)

data/lib/sepa_file_parser/string.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  class String
+    def self.parse(raw_camt)
+      doc = Nokogiri::XML raw_camt
+      SepaFileParser::Xml.parse(doc)
+    end
+  end
+end

data/lib/sepa_file_parser/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  VERSION = '0.1.0'.freeze
+end

data/lib/sepa_file_parser/xml.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  class Xml
+    PARSER_MAPPING = {
+      camt052: SepaFileParser::Camt052::Base,
+      camt053: SepaFileParser::Camt053::Base,
+      camt054: SepaFileParser::Camt054::Base,
+      pain001: SepaFileParser::Pain001::Base,
+      pain008: SepaFileParser::Pain008::Base,
+    }.freeze
+
+    SUPPORTED_PARSERS = PARSER_MAPPING.keys.freeze
+
+    @namespace_parsers = {}
+
+    def self.register(namespace, parser)
+      if !SUPPORTED_PARSERS.include?(parser)
+        raise SepaFileParser::Errors::UnsupportedParserClass, parser.to_s
+      end
+
+      if @namespace_parsers.key?(namespace) # Prevent overwriting existing registrations
+        raise SepaFileParser::Errors::NamespaceAlreadyRegistered, namespace
+      end
+
+      @namespace_parsers[namespace] = PARSER_MAPPING[parser]
+    end
+
+    def self.parse(doc)
+      if !doc.is_a?(Nokogiri::XML::Document)
+        raise SepaFileParser::Errors::NotXMLError, doc.class
+      end
+
+      namespace = doc.namespaces['xmlns']
+      doc.remove_namespaces!
+
+      parser_class = @namespace_parsers[namespace]
+      if parser_class == nil
+        raise SepaFileParser::Errors::UnsupportedNamespaceError, namespace
+      end
+
+      return parser_class.new(doc.xpath('Document'))
+    end
+  end
+end

data/lib/sepa_file_parser.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+require 'time'
+require 'bigdecimal'
+
+require_relative 'sepa_file_parser/misc'
+require_relative 'sepa_file_parser/version'
+require_relative 'sepa_file_parser/errors'
+require_relative 'sepa_file_parser/general/account_balance'
+require_relative 'sepa_file_parser/general/creditor'
+require_relative 'sepa_file_parser/general/debitor'
+require_relative 'sepa_file_parser/general/entry'
+require_relative 'sepa_file_parser/general/record'
+require_relative 'sepa_file_parser/general/charges'
+require_relative 'sepa_file_parser/general/account'
+require_relative 'sepa_file_parser/general/batch_detail'
+require_relative 'sepa_file_parser/general/group_header'
+require_relative 'sepa_file_parser/general/pain_entry'
+require_relative 'sepa_file_parser/general/postal_address'
+require_relative 'sepa_file_parser/general/transaction'
+require_relative 'sepa_file_parser/general/type/builder'
+require_relative 'sepa_file_parser/general/type/code'
+require_relative 'sepa_file_parser/general/type/proprietary'
+require_relative 'sepa_file_parser/camt052/report'
+require_relative 'sepa_file_parser/camt052/base'
+require_relative 'sepa_file_parser/camt053/statement'
+require_relative 'sepa_file_parser/camt053/base'
+require_relative 'sepa_file_parser/camt054/notification'
+require_relative 'sepa_file_parser/camt054/base'
+require_relative 'sepa_file_parser/pain001/payment_information'
+require_relative 'sepa_file_parser/pain001/base'
+require_relative 'sepa_file_parser/pain008/payment_information'
+require_relative 'sepa_file_parser/pain008/base'
+require_relative 'sepa_file_parser/file'
+require_relative 'sepa_file_parser/string'
+require_relative 'sepa_file_parser/register'
+require_relative 'sepa_file_parser/xml'