ruby_fints 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 334a1e0c17c756b2380b9fb739cfeeb7198030e5
+  data.tar.gz: 565548ae22bb8510b7da5e4db147c28076a9ca48
+SHA512:
+  metadata.gz: 42513b7488dbd861747ad06d08ad5948811bd81d508cb352f50a75a6132c405d633a2346063fde5b7b88ddd55d834c4a14a700e3bfe3013d0471da0ad23acfc3
+  data.tar.gz: 6bfd3b8107a41506a60d0ab56d230e078ac50d1fc060e164e2192e5f35bf5b0089c9b237c454dd29f983f3f4ac0d4212e6bac6563668efacbb38ea03293f1612

data/.gitignore

@@ -0,0 +1,58 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# rvm
+.ruby-version
+
+# jeweler generated
+#pkg # upload gem file to server
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For VS Code
+.vscode/
+
+# For vim:
+*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc
+
+pkg/
+
+/Gemfile.lock

data/.ruby-gemset

@@ -0,0 +1 @@
+ruby_fints

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 PlaytestCloud 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,71 @@
+ruby_fints
+==========
+
+This is a pure-Ruby implementation of FinTS (formerly known as HBCI), a
+online-banking protocol commonly supported by German banks.
+
+Limitations
+-----------
+
+* Only FinTS 3.0 is supported
+* Only PIN/TAN authentication is supported, no signature cards
+* Only a number of reading operations are currently supported
+* Supports Ruby 2.2+
+
+Banks tested:
+
+* Sparkasse
+
+Usage
+-----
+
+```ruby
+require 'ruby_fints'
+require 'pp'
+
+FinTS::Client.logger.level = Logger::DEBUG
+f = FinTS::PinTanClient.new(
+    '123456789',  # Your bank's BLZ
+    'myusername',
+    'mypin',
+    'https://mybank.com/...'  # endpoint, e.g.: https://hbci-pintan.gad.de/cgi-bin/hbciservlet
+)
+
+accounts = f.get_sepa_accounts
+pp accounts
+# [{iban: 'DE12345678901234567890', bic: 'ABCDEFGH1DEF', accountnumber: '123456790', subaccount: '', blz: '123456789'}]
+
+statement = f.get_statement(accounts[0], Date.new(2017, 4, 3), Date.new(2017, 4, 4))
+pp statement.map(&:data)
+
+# [#<Cmxl::Fields::Transaction:0x007fab6b457ec8
+#  @data=
+#   {"date"=>"170404",
+#    "entry_date"=>"0404",
+#    "funds_code"=>"C",
+#    "currency_letter"=>"R",
+#    "amount"=>"96,38",
+#    "swift_code"=>"N062",
+#    "reference"=>"NONREF",
+#    "bank_reference"=>""},
+#  @details=
+#   #<Cmxl::Fields::StatementDetails:0x007fab6b457838
+#    @data=
+#     {"transaction_code"=>"166",
+#      "details"=>
+#       "?00GUTSCHRIFT?109251?20EREF+010F209270562741?21SVWZ+STRIPEX4J1J3?22AWV-MELDEPFLICHT BEACHTEN?23HOTLINE BUNDESBANK.?24(0800) 1234-111?30SXPYDKKK?35DK6689000000010241?32Stripe Payments UK Ltd?34888",
+#      "seperator"=>"?"}
+#  ]
+
+# for retrieving the holdings of an account (This has not been tested for this implementation yet so it might not work)
+holdings = f.get_holdings(accounts[0])
+```
+
+Credits
+-------
+
+This is a close port of [python-fints](https://github.com/raphaelm/python-fints) library by Raphael Michel
+which in turn is a port of the [fints-hbci-php](https://github.com/mschindler83/fints-hbci-php)
+implementation that was released by Markus Schindler under the MIT license.
+
+Thanks for your work!

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/lib/fints/client.rb

@@ -0,0 +1,144 @@
+module FinTS
+  class Client
+    class << self
+      attr_writer :logger
+
+      def logger
+        @logger ||= Logger.new($stdout).tap do |log|
+          log.progname = self.name
+        end
+      end
+    end
+
+    def initialize
+      @accounts = []
+    end
+
+    def get_sepa_accounts
+      dialog = new_dialog
+      dialog.sync
+      dialog.init
+
+      msg_spa = new_message(dialog, [Segment::HKSPA.new(3, nil, nil, nil)])
+      FinTS::Client.logger.debug("Sending HKSPA: #{msg_spa}")
+      resp = dialog.send_msg(msg_spa)
+      FinTS::Client.logger.debug("Got HKSPA response: #{resp}")
+      dialog.send_end
+
+      accounts = resp.find_segment('HISPA')
+      raise SegmentNotFoundError, 'Could not find HISPA segment' if accounts.nil?
+      accountlist = accounts.split('+').drop(1)
+      @accounts = accountlist.map do |acc|
+        arr = acc.split(':')
+        {
+          iban: arr[1],
+          bic: arr[2],
+          accountnumber: arr[3],
+          subaccount: arr[4],
+          blz: arr[6]
+        }
+      end
+    end
+
+    def get_statement(account, start_date, end_date)
+      FinTS::Client.logger.info("Start fetching from #{start_date} to #{end_date}")
+
+      dialog = new_dialog
+      dialog.sync
+      dialog.init
+
+      msg = create_statement_message(dialog, account, start_date, end_date, nil)
+      FinTS::Client.logger.debug("Send message: #{msg}")
+      resp = dialog.send_msg(msg)
+      touchdowns = resp.get_touchdowns(msg)
+      responses = [resp]
+      touchdown_counter = 1
+
+      while touchdowns.include?(Segment::HKKAZ)
+        FinTS::Client.logger.info("Fetching more results (#{touchdown_counter})...")
+        msg = create_statement_message(dialog, account, start_date, end_date, touchdowns[Segment::HKKAZ])
+        FinTS::Client.logger.debug("Send message: #{msg}")
+
+        resp = dialog.send_msg(msg)
+        responses << resp
+        touchdowns = resp.get_touchdowns(msg)
+
+        touchdown_counter += 1
+      end
+
+      FinTS::Client.logger.info('Fetching done.')
+      re_data = /^[^@]*@([0-9]+?)@(.+)/m
+      statement_response = ''
+      responses.each do |r|
+        seg = r.find_segment('HIKAZ')
+        next unless seg
+        match = re_data.match(seg)
+        next unless match
+        statement_response += match[2]
+      end
+      statement = Helper.mt940_to_array(statement_response)
+
+      FinTS::Client.logger.debug("Statement: #{statement}")
+      dialog.send_end
+      statement
+    end
+
+    def create_statement_message(dialog, account, start_date, end_date, touchdown)
+      hversion = dialog.hkkazversion
+
+      acc = if [4, 5, 6].include?(hversion)
+              [account[:accountnumber], account[:subaccount], '280', account[:blz]].join(':')
+            elsif hversion == 7
+              [account[:iban], account[:bic], account[:accountnumber], account[:subaccount], '280', account[:blz]].join(':')
+            else
+              raise ArgumentError, "Unsupported HKKAZ version #{hversion}"
+            end
+
+      segment = Segment::HKKAZ.new(3, hversion, acc, start_date, end_date, touchdown)
+      new_message(dialog, [segment])
+    end
+
+    def get_holdings(account)
+      # init dialog
+      dialog = self.new_dialog()
+      dialog.sync
+      dialog.init
+
+      # execute job
+      msg = create_get_holdings_message(dialog, account)
+      FinTS::Client.logger.debug("Sending HKWPD: #{msg}")
+      resp = dialog.send_msg(msg)
+      FinTS::Client.logger.debug("Got HIWPD response: #{resp}")
+
+      # end dialog
+      dialog.send_end
+
+      # find segment and split up to balance part
+      seg = resp.find_segment('HIWPD')
+      if seg
+        mt535_lines = seg.lines
+        # The first line contains a FinTS HIWPD header - drop it.
+        mt535_lines.delete_at(0)
+        mt535 = MT535Miniparser.new
+        mt535.parse(mt535_lines)
+      else
+        FinTS::Client.logger.warn('No HIWPD response segment found - maybe account has no holdings?')
+        []
+      end
+    end
+
+    def create_get_holdings_message(dialog, account)
+      hversion = dialog.hksalversion
+
+      acc = if [1, 2, 3, 4, 5, 6].include?(hversion)
+              [account[:accountnumber], account[:subaccount], '280', account[:blz]].join(':')
+            elsif hversion == 7
+              [account[:iban], account[:bic], account[:accountnumber], account[:subaccount], '280', account[:blz]].join(':')
+            else
+              raise ArgumentError, "Unsupported HKSAL version #{hversion}"
+            end
+
+      new_message(dialog, [Segment::HKWPD.new(3, hversion, acc)])
+    end
+  end
+end

data/lib/fints/connection_error.rb

@@ -0,0 +1,3 @@
+module FinTS
+  class ConnectionError < StandardError; end
+end

data/lib/fints/dialog.rb

@@ -0,0 +1,104 @@
+module FinTS
+  class DialogError < StandardError; end
+
+  class Dialog
+    attr_accessor :system_id
+    attr_accessor :dialog_id
+    attr_accessor :msg_no
+    attr_accessor :tan_mechs
+    attr_accessor :hkkazversion
+    attr_accessor :hksalversion
+
+    def initialize(blz, username, pin, system_id, connection)
+      @blz = blz
+      @username = username
+      @pin = pin
+      @system_id = system_id
+      @connection = connection
+      @msg_no = 1
+      @dialog_id = 0
+      @hksalversion = 6
+      @hkkazversion = 6
+      @tan_mechs = []
+    end
+
+    def sync
+      FinTS::Client.logger.info('Initialize SYNC')
+
+      seg_identification = Segment::HKIDN.new(3, @blz, @username, 0)
+      seg_prepare = Segment::HKVVB.new(4)
+      seg_sync = Segment::HKSYN.new(5)
+
+      msg_sync = Message.new(@blz, @username, @pin, @system_id, @dialog_id, @msg_no, [
+        seg_identification,
+        seg_prepare,
+        seg_sync
+      ])
+
+      FinTS::Client.logger.debug("Sending SYNC: #{msg_sync}")
+      resp = send_msg(msg_sync)
+      FinTS::Client.logger.debug("Got SYNC response: #{resp}")
+      @system_id = resp.get_system_id
+      @dialog_id = resp.get_dialog_id
+      @bankname = resp.get_bank_name
+      @hksalversion = resp.get_hksal_max_version
+      @hkkazversion = resp.get_hkkaz_max_version
+      @tan_mechs = resp.get_supported_tan_mechanisms
+
+      FinTS::Client.logger.debug("Bank name: #{@bankname}")
+      FinTS::Client.logger.debug("System ID: #{@system_id}")
+      FinTS::Client.logger.debug("Dialog ID: #{@dialog_id}")
+      FinTS::Client.logger.debug("HKKAZ max version: #{@hkkazversion}")
+      FinTS::Client.logger.debug("HKSAL max version: #{@hksalversion}")
+      FinTS::Client.logger.debug("TAN mechanisms: #{@tan_mechs}")
+      send_end
+    end
+
+    def init
+      FinTS::Client.logger.info('Initialize Dialog')
+      seg_identification = Segment::HKIDN.new(3, @blz, @username, @system_id)
+      seg_prepare = Segment::HKVVB.new(4)
+
+      msg_init = Message.new(@blz, @username, @pin, @system_id, @dialog_id, @msg_no, [
+        seg_identification,
+        seg_prepare,
+      ], @tan_mechs)
+      FinTS::Client.logger.debug("Sending INIT: #{msg_init}")
+      resp = send_msg(msg_init)
+      FinTS::Client.logger.debug("Got INIT response: #{resp}")
+
+      @dialog_id = resp.get_dialog_id
+      FinTS::Client.logger.info("Received dialog ID: #{@dialog_id}")
+
+      @dialog_id
+    end
+
+    def send_msg(msg)
+      FinTS::Client.logger.info('Sending Message')
+      msg.msg_no = @msg_no
+      msg.dialog_id = @dialog_id
+
+      resp = Response.new(@connection.send_msg(msg))
+      if !resp.successful?
+        raise DialogError, resp.get_summary_by_segment('HIRMG')
+      end
+      @msg_no += 1
+      resp
+    end
+
+    def send_end
+      FinTS::Client.logger.info('Initialize END')
+
+      msg_end = Message.new(@blz, @username, @pin, @system_id, @dialog_id, @msg_no, [
+        Segment::HKEND.new(3, @dialog_id)
+      ])
+      FinTS::Client.logger.debug("Sending END: #{msg_end}")
+      resp = send_msg(msg_end)
+      FinTS::Client.logger.debug("Got END response: #{resp}")
+      FinTS::Client.logger.info('Resetting dialog ID and message number count')
+      @dialog_id = 0
+      @msg_no = 1
+      resp
+    end
+  end
+end