hbci 0.2.0

data/lib/hbci/segments/hnshk.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Hbci
+  module Segments
+    # Signature Head Segment
+    #
+    # Top of the signature and counterpart of HNSHA
+    # https://www.hbci-zka.de/dokumente/spezifikation_deutsch/fintsv3/FinTS_3.0_Security_Sicherheitsverfahren_HBCI_Rel_20130718_final_version.pdf#page=63
+    class HNSHKv4 < Hbci::Segment
+      element_group :head, type: ElementGroups::SegmentHead do
+        # element :position, default: 2
+        element :position
+      end
+
+      element_group :security_profile do
+        element :security_method, default: 'PIN'
+        element :version, default: 1
+      end
+
+      element :tan_mechanism, default: 999
+
+      # Random security control reference. MUST be the same
+      # as in the signature footer
+      element :security_reference
+
+      element :area_of_security_application, default: 1
+      element :role_of_security_supplier, default: 1
+      element_group :security_identification_details do
+        element :type, default: 1
+        element :cid
+        element :party_identification # system_id
+      end
+
+      element :security_reference_number, default: 1
+
+      element_group :secured_at do
+        element :identifier, default: 1
+        element :date, default: ->(_eg) { Time.now.strftime('%Y%m%d') }
+        element :time, default: ->(_eg) { Time.now.strftime('%H%m%S') }
+      end
+
+      element_group :hash_alg do
+        element :usage, default: 1
+        element :code, default: 999
+        element :param_code, default: 1
+        element :param_value
+      end
+
+      element_group :sig_alg do
+        element :usage, default: 6
+        element :code, default: 10
+        element :operation_mode, default: 16
+      end
+
+      element_group :key do
+        element :bank_country_code, default: 280
+        element :bank_code # blz
+        element :user_id # login id  # "Benutzerkennung"
+        element :type, default: 'S'
+        element :number, default: 0
+        element :version, default: 0
+      end
+
+      def compile
+        self.security_reference = request_message.sec_ref
+        self.security_identification_details.party_identification = request_message.dialog ? request_message.dialog.system_id : 0
+        self.tan_mechanism = request_message.dialog.tan_mechanism if request_message.dialog && request_message.dialog.tan_mechanism
+        set_credentials
+      end
+
+      private
+
+      def set_credentials
+        key.bank_code = Connector.instance.credentials.bank_code
+        key.user_id = Connector.instance.credentials.user_id
+      end
+    end
+  end
+end

data/lib/hbci/segments/hnvsd.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Hbci
+  module Segments
+    class HNVSDv1 < Segment
+      attr_reader :segments
+
+      element_group :head, type: ElementGroups::SegmentHead
+      element :content, type: :binary
+
+      def initialize
+        super()
+        @segments = []
+        yield self if block_given?
+      end
+
+      def find(segment_type)
+        segments = find_all(segment_type)
+        warn "more then one #{segment_type} segment available" if segments.size > 1
+        segments.first
+      end
+
+      def find_all(segment_type)
+        @raw_segments = Parser.parse(content)
+        @raw_segments.select { |sd| sd[0][0] == segment_type }.map{ |sd| Hbci::SegmentFactory.build(sd) }
+      end
+
+      def add_segment(segment)
+        segment.build(self)
+        @segments.push(segment)
+      end
+
+      def compile
+        head.position = 999
+        @segments.each_with_index do |segment, _index|
+          segment.request_message = request_message
+          segment.compile
+          unless segment.head.position
+            segment.head.position = request_message.next_position
+            request_message.next_position += 1
+          end
+        end
+        @segments.each do |segment|
+          segment.after_compile if segment.respond_to?(:after_compile)
+        end
+        self.content = @segments.join('')
+      end
+    end
+  end
+end

data/lib/hbci/segments/hnvsk.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Hbci
+  module Segments
+    class HNVSKv3 < Hbci::Segment
+      element_group :head, type: ElementGroups::SegmentHead do
+        element :position, default: 998
+      end
+
+      element_group :security_profile do
+        element :method, default: 'PIN'
+        element :version, default: 1
+      end
+
+      element :security_function_code, default: 998
+
+      element :role_of_security_supplier, default: 1
+
+      element_group :security_identification_details do
+        element :type, default: 1
+        element :cid
+        element :party_identification # system_id
+      end
+
+      element_group :secured_at do
+        element :identifier, default: 1
+        element :date, default: ->(_eg) { Time.now.strftime('%Y%m%d') }
+        element :time, default: ->(_eg) { Time.now.strftime('%H%m%S') }
+      end
+
+      element_group :enc_alg do
+        element :usage, default: 2
+        element :operation_mode, default: 2
+        element :code, default: 13
+        element :key, default: '@5@NOKEY'
+        element :type, default: 6
+        element :additional_name, default: 1
+        element :additional_value
+      end
+
+      element_group :key do
+        element :bank_country_code, default: 280
+        element :bank_code # blz
+        element :user_id # login id
+        element :type, default: 'V'
+        element :number, default: 1
+        element :version, default: 1
+      end
+
+      element :compression_method, default: 0
+
+      def compile
+        head.position = 998
+        security_identification_details.party_identification = request_message.dialog ? request_message.dialog.system_id : 0
+        key.bank_code = Connector.instance.credentials.bank_code
+        key.user_id = Connector.instance.credentials.user_id
+      end
+    end
+  end
+end

data/lib/hbci/segments/segment_head.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Hbci
+  module Segments
+    module SegmentHead
+      def self.included(klass)
+        klass.element_group :head, type: ElementGroups::SegmentHead
+      end
+    end
+  end
+end

data/lib/hbci/segments/unknown.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Hbci
+  module Segments
+    class Unknown < Segment
+      element_group :head, type: ElementGroups::SegmentHead
+
+      10.times do |i|
+        element_group "element_group_#{i}".to_sym, type: ElementGroups::Unknown
+      end
+
+      def self.type
+        'Unknown'
+      end
+
+      def self.version
+        '0'
+      end
+    end
+  end
+end

data/lib/hbci/services/accounts_receiver.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Hbci
+  module Services
+    class AccountsReceiver
+      attr_reader :dialog
+
+      def initialize(dialog)
+        @dialog = dialog
+      end
+
+      def perform
+        dialog.response.find('HNVSD').find_all('HIUPD').map do |hiupd|
+          { account_number: hiupd.ktv.number, bank_code: hiupd.ktv.kik_blz }
+        end
+      end
+    end
+  end
+end

data/lib/hbci/services/balance_receiver.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Hbci
+  module Services
+    class BalanceReceiver < BaseReceiver
+      def perform
+        request_message = MessageFactory.build(dialog) do |hnvsd|
+          hnvsd.add_segment(build_hksal)
+        end
+        request_message.compile
+
+        @response = Response.new(Connector.instance.post(request_message))
+
+        raise @response.to_s unless request_successful?
+
+        @response.find('HNVSD').find('HISAL').booked_amount
+      end
+
+      private
+
+      def request_successful?
+        hirmg = @response.find('HIRMG')
+        return false if hirmg && hirmg.ret_val_1.code[0].to_i == 9
+
+        hnvsd = @response.find('HNVSD')
+        hirmg = hnvsd.find('HIRMG')
+        return false if hirmg && hirmg.ret_val_1.code[0].to_i == 9
+
+        true
+      end
+
+      def build_hksal
+        case version
+        when 4 then build_hksal_v4
+        when 6 then build_hksal_v6
+        when 7 then build_hksal_v7
+        end
+      end
+
+      def build_hksal_v4
+        hksal = Segments::HKSALv4.new
+        hksal.account.code   = iban.extended_data.bank_code
+        hksal.account.number = iban.extended_data.account_number
+        hksal
+      end
+
+      def build_hksal_v6
+        hksal = Segments::HKSALv6.new
+        hksal.account.number = iban.extended_data.account_number
+        hksal.account.kik_blz = iban.extended_data.bank_code
+        hksal
+      end
+
+      def build_hksal_v7
+        hksal = Segments::HKSALv7.new
+        hksal.account.iban        = iban.to_s
+        hksal.account.bic         = iban.extended_data.bic
+        hksal.account.kik_blz     = iban.extended_data.bank_code
+        hksal.account.kik_country = 280
+        hksal.account.number      = iban.extended_data.account_number
+        hksal
+      end
+
+      def supported_versions
+        dialog.response.find('HNVSD').find_all('HISALS').map { |x| x.head.version.to_i }
+      end
+    end
+  end
+end

data/lib/hbci/services/base_receiver.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Hbci
+  module Services
+    class BaseReceiver
+      attr_reader :dialog
+      attr_reader :iban
+
+      def initialize(dialog, iban, version = nil)
+        @dialog = dialog
+        @iban = Ibanizator.iban_from_string(iban)
+        @version = version
+
+        # raise "The version #{@version} is not supported" if version && !supported_versions.include?(@version)
+      end
+
+      def perform
+        raise NotImplementedError, "#{self.class.name}#perform is an abstract method."
+      end
+
+      private
+
+      def request_successful?
+        hirmg = @response.find('HIRMG')
+        return false if hirmg && hirmg.ret_val_1.code[0].to_i == 9
+
+        hnvsd = @response.find('HNVSD')
+        hirmg = hnvsd.find('HIRMG')
+        return false if hirmg && hirmg.ret_val_1.code[0].to_i == 9
+
+        true
+      end
+
+      def version
+        @version ||= supported_versions.max
+      end
+
+      def supported_versions
+        raise NotImplementedError, "#{self.class.name}#supported_versions is an abstract method."
+      end
+    end
+  end
+end

data/lib/hbci/services/system_id_receiver.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Hbci
+  module Services
+    class SystemIdReceiver
+      def perform
+        request_message = MessageFactory.build(nil) do |hnvsd|
+          hnvsd.add_segment(Segments::HKIDNv2.new)
+          hnvsd.add_segment(Segments::HKVVBv3.new)
+          hnvsd.add_segment(Segments::HKSYNv3.new)
+        end
+        request_message.compile
+
+        @response = Response.new(Connector.instance.post(request_message))
+
+        raise @response.to_s unless request_successful?
+
+        @response.find('HNVSD').find('HISYN').system_id
+      end
+
+      private
+
+      def request_successful?
+        hirmg = @response.find('HIRMG')
+        return false if hirmg && hirmg.ret_val_1.code[0].to_i == 9
+
+        hnvsd = @response.find('HNVSD')
+        hirmg = hnvsd.find('HIRMG')
+        return false if hirmg && hirmg.ret_val_1.code[0].to_i == 9
+
+        true
+      end
+    end
+  end
+end

data/lib/hbci/services/transactions_receiver.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Hbci
+  module Services
+    class TransactionsReceiver < BaseReceiver
+      attr_reader :next_attach
+
+      def perform(start_date, end_date)
+        @start_date = start_date
+        @end_date = end_date
+
+        transactions = []
+        loop do
+          request_message = MessageFactory.build(dialog) do |hnvsd|
+            hnvsd.add_segment(build_hkkaz)
+          end
+          request_message.compile
+
+          @response = Response.new(Connector.instance.post(request_message))
+
+          raise @response.to_s unless request_successful?
+
+          hikaz = @response.find('HNVSD').find('HIKAZ')
+          transactions.concat(parse_transactions(hikaz.booked)) if hikaz
+
+          break if @response.find('HNVSD').find('HIRMS').ret_val_1.code != '3040'
+
+          @next_attach = @response.find('HNVSD').find('HIRMS').ret_val_1.parm
+        end
+        transactions
+      end
+
+      private
+
+      def build_hkkaz
+        case version
+        when 6 then build_hkkaz_v6
+        when 7 then build_hkkaz_v7
+        end
+      end
+
+      def build_hkkaz_v6
+        hkkaz = Segments::HKKAZv6.new
+        hkkaz.account.number      = iban.extended_data.account_number
+        hkkaz.account.kik_blz     = iban.extended_data.bank_code
+        hkkaz.account.kik_country = 280
+        hkkaz.from                = @start_date.strftime('%Y%m%d')
+        hkkaz.to                  = @end_date.strftime('%Y%m%d')
+        hkkaz.attach              = next_attach
+        hkkaz
+      end
+
+      def build_hkkaz_v7
+        hkkaz = Segments::HKKAZv7.new
+        hkkaz.account.iban        = iban.to_s
+        hkkaz.account.bic         = iban.extended_data.bic
+        hkkaz.account.number      = iban.extended_data.account_number
+        hkkaz.account.kik_blz     = iban.extended_data.bank_code
+        hkkaz.account.kik_country = 280
+        hkkaz.from                = @start_date.strftime('%Y%m%d')
+        hkkaz.to                  = @end_date.strftime('%Y%m%d')
+        hkkaz.attach              = next_attach
+        hkkaz
+      end
+
+      def parse_transactions(mt940)
+        Cmxl.parse(mt940.force_encoding('ISO-8859-1').encode('UTF-8')).flat_map(&:transactions).map(&:to_h)
+      end
+
+      def supported_versions
+        dialog.response.find('HNVSD').find_all('HIKAZS').map { |x| x.head.version.to_i }
+      end
+    end
+  end
+end