ruby_fints 0.0.2

data/lib/fints/segment/hkidn.rb

@@ -0,0 +1,22 @@
+module FinTS
+  module Segment
+    # HKIDN (Identifikation)
+    # Section C.3.1.2
+    class HKIDN < BaseSegment
+      def initialize(segment_number, blz, username, system_id=0, customerid=1)
+        data = ["#{country_code}:#{blz}", Helper.fints_escape(username), system_id, customerid]
+        super(segment_number, data)
+      end
+
+      protected
+
+      def type
+        'HKIDN'
+      end
+      
+      def version
+        2
+      end
+    end
+  end
+end

data/lib/fints/segment/hkkaz.rb

@@ -0,0 +1,31 @@
+module FinTS
+  module Segment
+    # HKKAZ (Kontoumsätze)
+    # Refs: http://www.hbci-zka.de/dokumente/spezifikation_deutsch/fintsv3/FinTS_3.0_Messages_Geschaeftsvorfaelle_2015-08-07_final_version.pdf
+    # Section C.2.1.1.1.2
+    class HKKAZ < BaseSegment
+      def initialize(segno, version, account, date_start, date_end, touchdown)
+        @version = version
+        data = [
+          account,
+          'N',
+          date_start.strftime('%Y%m%d'),
+          date_end.strftime('%Y%m%d'),
+          '',
+          touchdown ? Helper.fints_escape(touchdown) : ''
+        ]
+        super(segno, data)
+      end
+
+      protected
+
+      def type
+        'HKKAZ'
+      end
+
+      def version
+        @version
+      end
+    end
+  end
+end

data/lib/fints/segment/hkspa.rb

@@ -0,0 +1,26 @@
+module FinTS
+  module Segment
+    # HKSPA (SEPA-Kontoverbindung anfordern)
+    # Section C.10.1.3
+    class HKSPA < BaseSegment
+      def initialize(segno, accno, subaccfeature, blz)
+        data = if accno.nil?
+                  ['']
+                else
+                  [[accno, subaccfeature, country_code, blz].join(':')]
+                end
+        super(segno, data)
+      end
+
+      protected
+
+      def type
+        'HKSPA'
+      end
+      
+      def version
+        1
+      end
+    end
+  end
+end

data/lib/fints/segment/hksyn.rb

@@ -0,0 +1,26 @@
+module FinTS
+  module Segment
+    # HKSYN (Synchronisation)
+    # Section C.8.1.2
+    class HKSYN < BaseSegment
+      SYNC_MODE_NEW_CUSTOMER_ID = 0
+      SYNC_MODE_LAST_MSG_NUMBER = 1
+      SYNC_MODE_SIGNATURE_ID = 2
+
+      def initialize(segment_no, mode: SYNC_MODE_NEW_CUSTOMER_ID)
+        data = [mode]
+        super(segment_no, data)
+      end
+
+      protected
+
+      def type
+        'HKSYN'
+      end
+      
+      def version
+        3
+      end
+    end
+  end
+end

data/lib/fints/segment/hkvvb.rb

@@ -0,0 +1,26 @@
+module FinTS
+  module Segment
+    # HKVVB (Verarbeitungsvorbereitung)
+    # Section C.3.1.3
+    class HKVVB < BaseSegment
+      LANG_DE = 1
+      LANG_EN = 2
+      LANG_FR = 3
+
+      def initialize(segment_no, lang: LANG_DE)
+        data = [0, 0, lang, Helper.fints_escape(FinTS::GEM_NAME), Helper.fints_escape(FinTS::VERSION)]
+        super(segment_no, data)
+      end
+
+      protected
+
+      def type
+        'HKVVB'
+      end
+      
+      def version
+        3
+      end
+    end
+  end
+end

data/lib/fints/segment/hkwpd.rb

@@ -0,0 +1,30 @@
+module FinTS
+  module Segment
+    # HKWPD (Depotaufstellung anfordern)
+    # Section C.4.3.1
+    # Example: HKPWD:3:7+23456::280:10020030+USD+2'
+    class HKWPD < BaseSegment
+      def initialize(segno, version, account)
+        # The spec allows the specification of currency and
+        # quality of valuations, as shown in the docstring above.
+        # However, both 1822direkt and CortalConsors reject the
+        # call if these two are present, claiming an invalid input.
+        # 'EUR'        # Währung der Depotaufstellung"
+        # 2             # Kursqualität
+        data = [account]
+        super(segno, data)
+        @version = version
+      end
+
+      protected
+
+      def type
+        'HKPWD'
+      end
+      
+      def version
+        @version
+      end
+    end
+  end
+end

data/lib/fints/segment/hnhbk.rb

@@ -0,0 +1,27 @@
+module FinTS
+  module Segment
+    # HNHBK (Nachrichtenkopf)
+    # Section B.5.2
+    class HNHBK < BaseSegment
+      HEADER_LENGTH = 29
+
+      def initialize(msglen, dialog_id, msg_no)
+        if msglen.to_s.length != 12
+          msglen = (msglen.to_i + HEADER_LENGTH + dialog_id.to_s.length + msg_no.to_s.length).to_s.rjust(12, '0')
+        end
+        data = [msglen, 300, dialog_id, msg_no]
+        super(1, data)
+      end
+
+      protected
+
+      def type
+        'HNHBK'
+      end
+      
+      def version
+        3
+      end
+    end
+  end
+end

data/lib/fints/segment/hnhbs.rb

@@ -0,0 +1,22 @@
+module FinTS
+  module Segment
+    # HNHBS (Nachrichtenabschluss)
+    # Section B.5.3
+    class HNHBS < BaseSegment
+      def initialize(segno, msgno)
+        data = [msgno.to_s]
+        super(segno, data)
+      end
+
+      protected
+
+      def type
+        'HNHBS'
+      end
+      
+      def version
+        1
+      end
+    end
+  end
+end

data/lib/fints/segment/hnsha.rb

@@ -0,0 +1,27 @@
+module FinTS
+  module Segment
+    # HNSHA (Signaturabschluss)
+    # Section B.5.2
+    class HNSHA < BaseSegment
+      SECURITY_FUNC = 999
+      SECURITY_BOUNDARY = 1  # SHM
+      SECURITY_SUPPLIER_ROLE = 1  # ISS
+      PINTAN_VERSION = 1  # 1-step
+
+      def initialize(segno, secref, pin)
+        data = [secref, '', Helper.fints_escape(pin)]
+        super(segno, data)
+      end
+
+      protected
+
+      def type
+        'HNSHA'
+      end
+      
+      def version
+        2
+      end
+    end
+  end
+end

data/lib/fints/segment/hnshk.rb

@@ -0,0 +1,38 @@
+module FinTS
+  module Segment
+    # HNSHK (Signaturkopf)
+    # Section B.5.1
+    class HNSHK < BaseSegment
+      SECURITY_FUNC = 999
+      SECURITY_BOUNDARY = 1  # SHM
+      SECURITY_SUPPLIER_ROLE = 1  # ISS
+
+      def initialize(segno, secref, blz, username, system_id, profile_version, security_function=SECURITY_FUNC)
+        data = [
+          ['PIN', profile_version.to_s].join(':'),
+          security_function,
+          secref,
+          SECURITY_BOUNDARY,
+          SECURITY_SUPPLIER_ROLE,
+          ['1', '', system_id.to_s].join(':'),
+          1,
+          ['1', Time.now.strftime('%Y%m%d'), Time.now.strftime('%H%M%S')].join(':'),
+          ['1', '999', '1'].join(':'),  # Negotiate hash algorithm
+          ['6', '10', '16'].join(':'),  # RSA mode
+          [country_code.to_s, blz, Helper.fints_escape(username), 'S', '0', '0'].join(':')
+        ]
+        super(segno, data)
+      end
+
+      protected
+
+      def type
+        'HNSHK'
+      end
+      
+      def version
+        4
+      end
+    end
+  end
+end

data/lib/fints/segment/hnvsd.rb

@@ -0,0 +1,30 @@
+module FinTS
+  module Segment
+    # HNVSD (Verschlüsselte Daten)
+    # Section B.5.4
+    class HNVSD < BaseSegment
+      attr_reader :encoded_data
+
+      def initialize(segno, encoded_data)
+        @encoded_data = encoded_data
+        data = ["@#{encoded_data.length}@#{encoded_data}"]
+        super(segno, data)
+      end
+
+      def set_data(encoded_data)
+        @encoded_data = encoded_data
+        @data = ["@#{encoded_data.length}@#{encoded_data}"]
+      end
+
+      protected
+
+      def type
+        'HNVSD'
+      end
+      
+      def version
+        1
+      end
+    end
+  end
+end

data/lib/fints/segment/hnvsk.rb

@@ -0,0 +1,34 @@
+module FinTS
+  module Segment
+    # HNVSK (Verschlüsselungskopf)
+    # Section B.5.3
+    class HNVSK < BaseSegment  
+      COMPRESSION_NONE = 0
+      SECURITY_SUPPLIER_ROLE = 1  # ISS
+
+      def initialize(segno, blz, username, system_id, profile_version)
+        data = [
+          ['PIN', profile_version.to_s].join(':'),
+          998,
+          SECURITY_SUPPLIER_ROLE,
+          ['1', '', system_id.to_s].join(':'),
+          ['1', Time.now.strftime('%Y%m%d'), Time.now.strftime('%H%M%S')].join(':'),
+          ['2', '2', '13', '@8@00000000', '5', '1'].join(':'),
+          [country_code.to_s, blz, Helper.fints_escape(username), 'S', '0', '0'].join(':'),
+          COMPRESSION_NONE
+        ]
+        super(segno, data)
+      end
+
+      protected
+
+      def type
+        'HNVSK'
+      end
+      
+      def version
+        3
+      end
+    end
+  end
+end

data/lib/fints/segment_not_found_error.rb

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

data/lib/fints/version.rb

@@ -0,0 +1,4 @@
+module FinTS
+  GEM_NAME = 'ruby_fints'
+  VERSION = '0.0.2'
+end

data/lib/ruby_fints.rb

@@ -0,0 +1,29 @@
+require 'base64'
+require 'httparty'
+require 'cmxl'
+require 'logger'
+require_relative 'fints/client'
+require_relative 'fints/connection_error'
+require_relative 'fints/dialog'
+require_relative 'fints/helper'
+require_relative 'fints/https_connection'
+require_relative 'fints/message'
+require_relative 'fints/mt535_miniparser'
+require_relative 'fints/pin_tan_client'
+require_relative 'fints/response'
+require_relative 'fints/segment_not_found_error'
+require_relative 'fints/version'
+require_relative 'fints/segment/base_segment'
+require_relative 'fints/segment/hkend'
+require_relative 'fints/segment/hkidn'
+require_relative 'fints/segment/hkkaz'
+require_relative 'fints/segment/hkspa'
+require_relative 'fints/segment/hksyn'
+require_relative 'fints/segment/hkvvb'
+require_relative 'fints/segment/hkwpd'
+require_relative 'fints/segment/hnhbk'
+require_relative 'fints/segment/hnhbs'
+require_relative 'fints/segment/hnsha'
+require_relative 'fints/segment/hnshk'
+require_relative 'fints/segment/hnvsd'
+require_relative 'fints/segment/hnvsk'

data/ruby_fints.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'fints/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'ruby_fints'
+  s.version     = FinTS::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Marvin Killing']
+  s.email       = ['marvin@playtestcloud.com']
+  s.homepage    = ''
+  s.summary     = %q{Basic FinTS 3.0 implementation in Ruby}
+  s.description = %q{FinTS (formerly known as HBCI) is a protocol to programmatically interface with German banks. This gem is a translation of https://github.com/raphaelm/python-fints into Ruby.}
+
+  s.add_runtime_dependency 'cmxl', '~> 0.2'
+  s.add_runtime_dependency 'httparty', '~> 0.10'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'delorean'
+  s.add_development_dependency 'mocha'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test}/*`.split("\n")
+  s.require_paths = ['lib']
+end

data/test/fixtures/bpd-allowedgv.txt

@@ -0,0 +1 @@
+HNHBK:1:3+000000001881+220+1653639025+1+1653639025:1'HNSHK:2:3+900+2+1+1+2::1241978588+0+1:20120316:210842+1:999:1+6:10:16+280::1:S:0:0'HIRMG:3:2+0010::Nachricht entgegengenommen'HIRMS:4:2:4+3920::Auftraege werden nur gemaess Zwei-Schritt-Verfahren (ITAN) angenommen.:900'HIBPA:5:2:4+1+280:33020000+akf Bank Wuppertal+23+1+220'HISHV:6:2:4+N+RDH:1'HIKAZS:7:5:4+1+1+60:N:N'HIUEBS:8:4:4+1+1+14:51:53:54:67:69'HISUBS:9:5:4+1+1+9999:14:51:53:54'HISLAS:10:5:4+1+1+9999:14:04:05'HISALS:11:5:4+1+1'HIAOMS:12:1:4+1+1+J:756;24;23;24;64;15000,;EUR:208;24;23;24;64;15000,;EUR:246;24;23;24;64;15000,;EUR:440;24;23;24;64;15000,;EUR:616;24;23;24;64;15000,;EUR:752;24;23;24;64;15000,;EUR:705;24;23;24;64;15000,;EUR:203;24;23;24;64;15000,;EUR:348;24;23;24;64;15000,;EUR:056;24;23;24;64;15000,;EUR:372;24;23;24;64;15000,;EUR:380;24;23;24;64;15000,;EUR:442;24;23;24;64;15000,;EUR:528;24;23;24;64;15000,;EUR:040;24;23;24;64;15000,;EUR:620;24;23;24;64;15000,;EUR:724;24;23;24;64;15000,;EUR:826;24;23;24;64;15000,;EUR:474;24;23;24;64;15000,;EUR:352;24;23;24;64;15000,;EUR:300;24;23;24;64;15000,;EUR:250;24;23;24;64;15000,;EUR:638;24;23;24;64;15000,;EUR:254;24;23;24;64;15000,;EUR:292;24;23;24;64;15000,;EUR:312;24;23;24;64;15000,;EUR:470;24;23;24;64;15000,;EUR:196;24;23;24;64;15000,;EUR:233;24;23;24;64;15000,;EUR:428;24;23;24;64;15000,;EUR:276;24;23;24;64;15000,;EUR:578;24;23;24;64;15000,;EUR'HILASS:13:4:4+1+1+14:04:05'HIPINS:14:1:4+1+1+1+5:6:6:BENUTZER:KUNDEN:HKUEB:J:HKSUB:J:HKKAZ:N:HKSLA:J:HKTUE:J:HKTUA:J:HKTUB:N:HKTUL:J:HKAOM:J:HKTAN:N'HITANS:15:2:4+1+1+1+N:J:1:900:1:ITAN:ITAN:6:1:TAN:6:1:N:1:0:N:N:N'HIUPA:16:2:4+XXXX+0+0'HIUPD:17:4:4+10023340::280:33020000+XXXX+EUR+Jan Kahl++Jan Kahl++HKKAZ:1+HKUEB:1+HKSUB:1+HKSAL:1+HKTAN:1'HISYN:18:3:5+1241978588'HNSHA:19:1+2++XXXXX'HNHBS:20:1+1'

data/test/pin_tan_client_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+class RubyFintsTest < Minitest::Test
+
+  # this test tries to go as far as it can to retrieve a list of sepa accounts.
+  # currently we don‘t have the fixtures to make this fully test the entire method.
+  def test_it_raises_when_it_gets_a_bad_response
+    Delorean.time_travel_to(Time.new(2017, 4, 20, 17, 17)) do
+      # we have to mock random number generation
+      Kernel.stubs(:rand).with(1000000..9999999).returns(9999999)
+
+      response = File.read(File.join(File.dirname(__FILE__), 'fixtures', 'bpd-allowedgv.txt'))
+      stub_request(:post, "https://banking-bb6.de/fints30")
+        .to_return(status: 200, body: Base64.encode64(response), headers: {})
+
+      f = FinTS::PinTanClient.new('788000111', 'my?user', 'mypw', 'https://banking-bb6.de/fints30')
+      FinTS::Client.logger.level = Logger::ERROR
+
+      assert_raises FinTS::SegmentNotFoundError do
+        f.get_sepa_accounts
+      end
+    end
+  end
+end