dtaus 0.1.1 → 0.2.0

data/lib/dtaus/dta_generator.rb

@@ -0,0 +1,217 @@
+# encoding: utf-8
+
+module DTAUS
+  
+  # Baut den DTAUS Datensatz aus einem DTAUS::Datensatz Objekt
+  class DtaGenerator
+    
+    def initialize(datensatz)
+      @datensatz = datensatz
+    end
+    
+    # Header (A), Buchungen (C) und Footer (E) werden zusammengefügt
+    #
+    def to_dta
+      raise DTAUSException.new("Keine Buchungen vorhanden") unless @datensatz.buchungen.size > 0
+      
+      dta = segment_a + segment_c + segment_e
+      
+      raise IncorrectSizeException.new("Datensatzlänge ist nicht durch 128 teilbar: #{dta.size}") if dta.size % 128 != 0
+      
+      dta
+    end
+    
+    # Erstellt A-Segment (HEADER) der DTAUS-Datei
+    #--
+    # Aufbau des Segments:
+    # 
+    # Nr. Start Länge     Beschreibung
+    # 1   0     4 Zeichen   Länge des Datensatzes, immer 128 Bytes, also immer "0128"
+    # 2   4     1 Zeichen   Datensatz-Typ, immer 'A'
+    # 3   5     2 Zeichen   Art der Transaktionen
+    #             "LB" für Lastschriften Bankseitig
+    #             "LK" für Lastschriften Kundenseitig
+    #             "GB" für Gutschriften Bankseitig
+    #             "GK" für Gutschriften Kundenseitig
+    # 4   7     8 Zeichen   Bankleitzahl des Auftraggebers
+    # 5   15    8 Zeichen   CST, "00000000", nur belegt, wenn Diskettenabsender Kreditinstitut
+    # 6   23    27 Zeichen  Name des Auftraggebers
+    # 7   50    6 Zeichen   aktuelles Datum im Format DDMMJJ
+    # 8   56    4 Zeichen   CST, "    " (Blanks)
+    # 9   60    10 Zeichen  Kontonummer des Auftraggebers
+    # 10  70    10 Zeichen  Optionale Referenznummer
+    # 11a 80    15 Zeichen  Reserviert, 15 Blanks
+    # 11b 95    8 Zeichen   Ausführungsdatum im Format DDMMJJJJ. Nicht jünger als Erstellungsdatum (A7), jedoch höchstens 15 Kalendertage später. Sonst Blanks.
+    # 11c 103   24 Zeichen  Reserviert, 24 Blanks
+    # 12  127   1 Zeichen   Währungskennzeichen
+    #             " " = DM
+    #             "1" = Euro
+    #++
+    # Insgesamt 128 Zeichen
+    #
+    def segment_a
+      result = '0128'                                                     #  4 Zeichen  Länge des Datensatzes, immer 128 Bytes, also immer "0128"
+      result += 'A'                                                       #  1 Zeichen  Datensatz-Typ, immer 'A'
+      result += segment_a_transaktionstyp(@datensatz.transaktionstyp)     #  2 Zeichen  Art der Transaktionen
+      result += '%8i' % @datensatz.auftraggeber_konto.blz                 #  8 Zeichen  Bankleitzahl des Auftraggebers
+      result += '%08i' % 0                                                #  8 Zeichen  CST, "00000000", nur belegt, wenn Diskettenabsender Kreditinstitut
+      result += '%-27.27s' % @datensatz.auftraggeber_konto.kontoinhaber   # 27 Zeichen  Name des Auftraggebers
+      result += @datensatz.ausfuehrungsdatum.strftime("%d%m%y")           #  6 Zeichen  aktuelles Datum im Format DDMMJJ
+      result += ' ' * 4                                                   #  4 Zeichen  CST, "    " (Blanks)
+      result += '%010i' % @datensatz.auftraggeber_konto.kontonummer       # 10 Zeichen  Kontonummer des Auftraggebers
+      result += '%010i' % 0                                               # 10 Zeichen  Optionale Referenznummer
+      result += ' '  * 15                                                 # 15 Zeichen  Reserviert, 15 Blanks
+      result += '%8s' % @datensatz.ausfuehrungsdatum.strftime("%d%m%Y")   #  8 Zeichen  Optionales Ausführungsdatum im Format DDMMJJJJ. Nicht jünger als Erstellungsdatum (A7), jedoch höchstens 15 Kalendertage später. Sonst Blanks.
+      result += ' ' * 24                                                  # 24 Zeichen  Reserviert, 24 Blanks
+      result += '1'                                                       #  1 Zeichen  Währungskennzeichen ('1' = Euro)
+      
+      raise IncorrectSizeException.new("A-Segment: #{result.size} Zeichen, 128 erwartet.") if result.size != 128
+      
+      result
+    end
+    
+    def segment_c
+      result = ''
+      
+      @datensatz.buchungen.each do |buchung|
+        result += segment_c_buchung(buchung)
+        result += segment_c_erweiterungen(buchung)
+      end
+      
+      result
+    end
+    
+    # Erstellt ein C-Segments für eine Buchung
+    #
+    def segment_c_buchung(buchung)
+      # Länge des DTA-Datensatzes
+      erweiterungen = buchung.erweiterungen + @datensatz.auftraggeber_konto.erweiterungen
+      
+      result  = '%04i' % (187 + erweiterungen.size * 29)             #  4 Zeichen  Länge des Datensatzes, 187 + x * 29 (x..Anzahl Erweiterungsteile)
+      result += 'C'                                                  #  1 Zeichen  Datensatz-Typ, immer 'C'
+      result += '%08i' % 0                                           #  8 Zeichen  Bankleitzahl des Auftraggebers (optional)
+      result += '%08i' % buchung.kunden_konto.blz                    #  8 Zeichen  Bankleitzahl des Kunden
+      result += '%010i' % buchung.kunden_konto.kontonummer           # 10 Zeichen  Kontonummer des Kunden
+      result += '0%011i0' % buchung.kunden_konto.kundennummer        # 13 Zeichen  Verschiedenes 1. Zeichen: "0" 2. - 12. Zeichen: interne Kundennummer oder Nullen 13. Zeichen: "0"
+      result += segment_c_transaktionstyp(buchung.transaktionstyp)   #  5 Zeichen  Art der Transaktion (7a: 2 Zeichen, 7b: 3 Zeichen)
+      result += ' '                                                  #  1 Zeichen  Reserviert, " " (Blank)
+      result += '0' * 11                                             # 11 Zeichen  Betrag
+      result += '%08i' % @datensatz.auftraggeber_konto.blz           #  8 Zeichen  Bankleitzahl des Auftraggebers
+      result += '%010i' % @datensatz.auftraggeber_konto.kontonummer  # 10 Zeichen  Kontonummer des Auftraggebers
+      result += '%011i' % buchung.betrag                             # 11 Zeichen  Betrag in Euro einschließlich Nachkommastellen, nur belegt, wenn Euro als Währung angegeben wurde
+      result += ' ' * 3                                              #  3 Zeichen  Reserviert, 3 Blanks
+      result += buchung.kunden_konto.kontoinhaber[0..26].ljust(27)   # 27 Zeichen  Name des Kunden
+      result +=  ' ' * 8                                             #  8 Zeichen  Reserviert, 8 Blanks
+      
+      if result.size != 128
+        raise IncorrectSizeException.new("C-Segement 1: #{result.size} Zeichen, 128 erwartet (#{buchung.kunden_konto.kontoinhaber})")
+      end
+      
+      result
+    end
+    
+    # Erstellt den Erweiterungen-Teil des C-Segments für diese Buchung
+    #
+    def segment_c_erweiterungen(buchung)
+      erweiterungen = buchung.erweiterungen + @datensatz.auftraggeber_konto.erweiterungen
+      
+      result  = @datensatz.auftraggeber_konto.kontoinhaber[0..26].ljust(27)   # 27 Zeichen  Name des Auftraggebers
+      result += buchung.verwendungszweck[0..26].ljust(27)                     # 27 Zeichen  Verwendungszweck
+      result += '1'                                                           # 1 Zeichen  Währungskennzeichen ('1' = Euro)
+      result += '  '                                                          # 2 Zeichen   Reserviert, 2 Blanks
+      result += "%02i" % erweiterungen.size                                   # 2 Zeichen   Anzahl der Erweiterungsdatensätze, "00" bis "15"
+      
+      result += erweiterungen[0..1].inject('') {|tmp, erweiterung| tmp += "#{erweiterung.type}#{erweiterung.text}"}
+      result  = result.ljust(128)
+      
+      if erweiterungen.size > 2
+        erweiterungen[2..-1].each_slice(4) do |slice|
+          result += slice.inject('') {|tmp, erweiterung| tmp += "#{erweiterung.type}#{erweiterung.text}"}.ljust(128)
+        end
+      end
+      
+      if result.size > 256 * 3 or result.size % 128 != 0
+        raise IncorrectSizeException.new("Erweiterungen: #{result.size} Zeichen") 
+      end
+      
+      result
+    end
+    
+    # Erstellt E-Segment (Prüfsummen) der DTAUS-Datei
+    #--
+    # Aufbau des Segments:
+    #
+    # Nr. Start Länge   Beschreibung
+    # 1   0   4 Zeichen   Länge des Datensatzes, immer 128 Bytes, also immer "0128"
+    # 2   4   1 Zeichen   Datensatz-Typ, immer 'E'
+    # 3   5   5 Zeichen   5 Blanks
+    # 4   10  7 Zeichen   Anzahl der Datensätze vom Typ C
+    # 5   17  13 Zeichen  Kontrollsumme Beträge
+    # 6   30  17 Zeichen  Kontrollsumme Kontonummern
+    # 7   47  17 Zeichen  Kontrollsumme Bankleitzahlen
+    # 8   64  13 Zeichen  Kontrollsumme Euro, nur belegt, wenn Euro als Währung angegeben wurde (A12, C17a)
+    # 9   77  51 Zeichen  51 Blanks
+    #++
+    # Insgesamt 128 Zeichen
+    #
+    def segment_e
+      result  = '0128'                              #  4 Zeichen  Länge des Datensatzes, immer 128 Bytes, also immer "0128"
+      result += 'E'                                 #  1 Zeichen  Datensatz-Typ, immer 'E'
+      result += ' ' * 5                             #  5 Zeichen  5 Blanks
+      result += '%07i' % @datensatz.buchungen.size  #  7 Zeichen  Anzahl der Datensätze vom Typ C
+      result += '0' * 13                            # 13 Zeichen  Kontrollsumme Beträge in DM
+      result += '%017i' % checksum_konto            # 17 Zeichen  Kontrollsumme Kontonummern
+      result += '%017i' % checksum_blz              # 17 Zeichen  Kontrollsumme Bankleitzahlen
+      result += '%013i' % checksum_betrag           # 13 Zeichen  Kontrollsumme Beträge in Euro
+      result += ' '  * 51                           # 51 Zeichen  51 Blanks
+      
+      raise IncorrectSize.new("E-Segment: #{result.size}, 128 erwartet") if result.size != 128
+      
+      result
+    end
+  
+  private
+
+    # Checksumme der Kontonummern
+    #
+    def checksum_konto
+      @datensatz.buchungen.inject(0) {|sum, buchung| sum += buchung.kunden_konto.kontonummer}
+    end
+
+    # Checksumme der Bankleitzahlen
+    #
+    def checksum_blz
+      @datensatz.buchungen.inject(0) {|sum, buchung| sum += buchung.kunden_konto.blz}
+    end
+
+    # Checksumme der Beträge
+    #
+    def checksum_betrag
+      @datensatz.buchungen.inject(0) {|sum, buchung| sum += buchung.betrag}
+    end
+
+    def segment_a_transaktionstyp(symbol)
+      case symbol
+      when :lastschrift
+        'LK'
+      when :gutschrift
+        'GK'
+      else
+        raise Exception.new("Unknown transaktionstyp #{symbol}.")
+      end
+    end
+    
+    def segment_c_transaktionstyp(symbol)
+      case symbol
+      when :lastschrift
+        '05000'
+      when :gutschrift
+        '51000'
+      else
+        raise Exception.new("Unknown transaktionstyp #{symbol}.")
+      end
+    end
+    
+  end
+  
+end

data/lib/dtaus/erweiterung.rb

@@ -1,4 +1,7 @@
-class DTAUS
+# encoding: utf-8
+
+module DTAUS
+
   # Eine Erweiterung eines C-Segments
   # Stellt eine Länge von 27 Zeichen sicher
   #
@@ -13,38 +16,50 @@ class DTAUS
       :auftraggeber => TYPE_AUFTRAGGEBER
     }
 
-    class IncorrectErweiterungType; end;
     attr_reader :type, :text
 
-    # Erstellt ein Array von Erweiterungen aus einem beliebig langem String
+    # Erstellt eine Erweiterung
     #
-    def self.from_string(_typ, _text)
-      erweiterungen = []
-      _text = DTAUS.convert_text(_text)
-      if _text.size > 27
-        index = 27
-        while index < _text.size
-          erweiterungen << Erweiterung.new(_typ, _text[index..index += 26])
-        end
-      end
-      erweiterungen
-    end
-
-    # erweiterung = Erweiterung.new(:verwendungszweck, 'Rechnung Nr 12345')
-    # _type muss ein Symbol aus :kunde, :verwendungszweck, :auftraggeber sein.
+    # [<tt>_text</tt>] ist ein beliebig langer String
+    # [<tt>_type</tt>] muss ein Symbol sein, aus: 
+    #                  <tt>:kunde</tt>, <tt>:verwendungszweck</tt>, <tt>:auftraggeber</tt>
     #
     def initialize(_type, _text)
-      raise IncorrectErweiterungType.new unless TYPES.keys.include?(_type) or TYPES.values.include?(_type)
-      @text = DTAUS.convert_text(_text).ljust(27)
-      raise IncorrectSize.new("Text size may not exceed 27 Chars") if text.size > 27
+      unless TYPES.keys.include?(_type) or TYPES.values.include?(_type)
+        raise IncorrectErweiterungTypeException.new("Allowed types: :kunde, :verwendungszweck, :auftraggeber") 
+      end
+      @text = Converter.convert_text(_text).ljust(27)
+      if text.size > 27
+        raise IncorrectSizeException.new("Text size may not exceed 27 Chars") 
+      end
       @type = TYPES[_type] || _type
     end
 
-    def to_dta
-      "#{type}#{text}"
+    # Erstellt aus einem beliebig langem String eine Liste von Erweiterungen,
+    # wenn dies nötig wird.
+    # Es werden nur Erweiterungen für den Teil von <tt>_text</tt> erzeugt, der
+    # nicht in das Standardfeld von 27 Zeichen passt.
+    # Keine Erweiterungen werden erzeugt, wenn der <tt>_text</tt> vollständig
+    # in das Standardfeld von 27 Zeichen passt.
+    #
+    # [<tt>_text</tt>] ist ein beliebig langer String
+    # [<tt>_type</tt>] muss ein Symbol sein, aus: 
+    #                  <tt>:kunde</tt>, <tt>:verwendungszweck</tt>, <tt>:auftraggeber</tt>
+    #
+    # returns: Array of Erweiterung
+    def self.from_string(_type, _text)
+      erweiterungen = []
+      _text = Converter.convert_text(_text)
+      
+      # first slice will be omitted
+      _text.slice!(0..26) 
+      
+      while _text.size > 0
+        erweiterungen << Erweiterung.new(_type, _text.slice!(0..26))
+      end
+      erweiterungen
     end
 
   end
 
 end
-

data/lib/dtaus/exceptions.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+module DTAUS
+  
+  # Generische Exception für Dtaus
+  class DTAUSException < Exception; end;
+
+  # Exception für zu lange oder zu kurze DTA-Teile
+  class IncorrectSizeException < DTAUSException; end;
+  
+  # Exception für falsch übergebene Typen bei Erweiterungen
+  class IncorrectErweiterungTypeException < DTAUSException; end;
+  
+end

data/lib/dtaus/konto.rb

@@ -1,36 +1,60 @@
-require 'dtaus/erweiterung'
+# encoding: utf-8
 
-class DTAUS
-	# Kontodaten verwalten mit Name des Inhabers und Bank, Bankleitzahl und Kontonummer.
-	#
-	# Kundenkonto:
-	#  konto = Konto.new(kontonummer, bankleitzahl, inhaber, bankname, false, kundennummer)
-	# oder einfach
-	#  konto = Konto.new(kontonummer, bankleitzahl, inhaber, bankname)
-	#
-	# Auftraggeberkonto:
-	#  konto = Konto.new(kontonummer, bankleitzahl, inhaber, bankname, true)
-	#
-	class Konto
-		attr_reader	:blz, :bank, :name, :kunnr, :auftraggeber, :nummer
-
-		def initialize(_nummer, _blz, _name, _bank, _auftraggeber = false, _kunnr = 0)
-      @auftraggeber = _auftraggeber
+module DTAUS
 
-      @nummer = DTAUS.convert_number(_nummer)
-      @blz    = DTAUS.convert_number(_blz)
-			@kunnr = DTAUS.convert_number(_kunnr)
-			@name  = DTAUS.convert_text(_name)
-			@bank  = DTAUS.convert_text(_bank)
+  # Kontodaten mit Name des Inhabers, Bank, Bankleitzahl und Kontonummer.
+  # Kann zwischen Auftraggeber und Kundenkonto unterscheiden.
+  class Konto
+    attr_reader  :blz, :bankname, :kontoinhaber, :kundennummer, :is_auftraggeber, :kontonummer
 
-			raise DTAUSException.new("Ungültige Kontonummer: #{nummer}") if nummer == 0 or nummer.to_s.size > 10
-			raise DTAUSException.new("Ungültige Bankleitzahl: #{blz}")   if blz	== 0 or blz.to_s.size > 8
-		end
-
+    alias :is_auftraggeber? :is_auftraggeber
+    
+    # Erstellt ein neues Konto
+    #
+    # +params+ as Hash:
+    # [<tt>:kontonummer</tt>] die Kontonummer
+    # [<tt>:blz</tt>] die Bankleitzahl
+    # [<tt>:kontoinhaber</tt>] der Name der Kontoinhabers
+    # [<tt>:bankname</tt>] der Name der Bank
+    # [<tt>:is_auftraggeber</tt>] Boolischer Wert, ob dieses Konto ein Auftraggeberkonto ist;
+    #                             wird gebraucht, um den Typ der Erweiterung zu bestimmen;
+    #                             _optional_, default-Wert ist +false+
+    # [<tt>:kundennummer</tt>] eine Kundennummer; _optional_, defautl-Wert ist <tt>0</tt>
+    def initialize(params = {})
+      # defaults
+      params = {
+        :is_auftraggeber => false,
+        :kundennummer => 0
+      }.merge(params)
+      
+      [:blz, :bankname, :kontoinhaber, :kontonummer].each do |attr|
+        raise ArgumentError.new("Missing params[:#{attr}] for new Konto.") if params[attr].nil?
+      end
+      
+      @is_auftraggeber = params[:is_auftraggeber]
+
+      @kontonummer  = Converter.convert_number(params[:kontonummer])
+      @blz          = Converter.convert_number(params[:blz])
+      @kundennummer = Converter.convert_number(params[:kundennummer])
+      @kontoinhaber = Converter.convert_text(params[:kontoinhaber])
+      @bankname     = Converter.convert_text(params[:bankname])
+
+      if @kontonummer == 0 or @kontonummer.to_s.size > 10
+        raise DTAUSException.new("Ungültige Kontonummer: #{@kontonummer}") 
+      end
+      if @blz  == 0 or @blz.to_s.size > 8
+        raise DTAUSException.new("Ungültige Bankleitzahl: #{@blz}")   
+      end
+      if @kundennummer.to_s.size > 11
+        raise DTAUSException.new("Ungültige Kundennummer: #{@kundennummer}")   
+      end
+      
+    end
+    
+    # Erstellt eine Liste von Erweiterungen für den Kontoinhaber
     def erweiterungen
-      Erweiterung.from_string(auftraggeber ? :auftraggeber : :kunde, name)
+      Erweiterung.from_string(is_auftraggeber? ? :auftraggeber : :kunde, kontoinhaber)
     end
-
-	end
-end
 
+  end
+end

data/lib/dtaus/validator.rb

@@ -0,0 +1,217 @@
+class DTAUS
+  class Validator
+    attr_reader :string
+
+    def self.load(filename)
+      new(File.open(filename).read)
+    end
+
+    def initialize(string)
+      @string = string
+    end
+
+    def a_satz
+      @a_satz = ASatz.new(@string[0..127])
+    end
+
+    def e_satz
+      @e_satz = ESatz.new(@string[-128..-1])
+    end
+
+    def c_saetze
+      @c_saetze = CSatz.many(@string[128..-129])
+    end
+  end
+
+  class Satz
+    attr_reader :string
+
+    def initialize(string)
+      @string = string
+    end
+
+    def satzlaenge
+      @string[0..3]
+    end
+
+    def satzart
+      @string[4..4]
+    end
+  end
+
+  class CSatz < Satz
+    def self.many(string)
+      this = new(string)
+      anzahl_erweiterungen = this.anzahl_erweiterungen.to_i
+
+      if anzahl_erweiterungen < 3
+        offset = 0
+      else
+        anzahl_bloecke = ((anzahl_erweiterungen - 2) / 2) + anzahl_erweiterungen % 2
+        offset = anzahl_bloecke * 128
+      end
+
+      return [this] if string[255 + offset..-1].nil?
+      return [this] + many(string[255 + offset..-1])
+
+    end
+
+    def blz_erstbeteiligte_bank
+      @string[5..12]
+    end
+
+    def blz_empfaenger
+      @string[13..20]
+    end
+
+    def konto_empfaenger
+      @string[21..30]
+    end
+
+    def interne_kundennummer
+      @string[31..43]
+    end
+
+    def textschluessel
+      @string[44..45]
+    end
+
+    def ergaenzung
+      @string[46..48]
+    end
+
+    def leerzeichen1
+      @string[49..50]
+    end
+
+    def nullen
+      @string[50..60]
+    end
+
+    def blz_absender
+      @string[61..68]
+    end
+
+    def konto_absender
+      @string[69..78]
+    end
+
+    def betrag
+      @string[79..89]
+    end
+
+    def leerzeichen2
+      @string[90..92]
+    end
+
+    def name_empfaenger
+      @string[93..119]
+    end
+
+    def leerzeichen3
+      @string[120..127]
+    end
+
+    def name_absender
+      @string[128..154]
+    end
+
+    def verwendungszweck
+      @string[155..181]
+    end
+
+    def waehrung
+      @string[182..182]
+    end
+
+    def leerzeichen4
+      @string[183..184]
+    end
+
+    def anzahl_erweiterungen
+      @string[185..186]
+    end
+
+    def interne_erweiterungen
+      @string[187..244]
+    end
+
+    def leerzeichen5
+      @string[245..255]
+    end
+  end
+
+  class ESatz < Satz
+
+    def leerzeichen1
+      @string[5..9]
+    end
+
+    def anzahl_c_saetze
+      @string[10..16]
+    end
+
+    def summe_dm
+      @string[17..29]
+    end
+
+    def summe_konto
+      @string[30..46]
+    end
+
+    def summe_blz
+      @string[47..63]
+    end
+
+    def summe_euro
+      @string[64..76]
+    end
+
+    def leerzeichen2
+      @string[77..127]
+    end
+  end
+
+  class ASatz < Satz
+
+    def kennzeichen
+      @string[5..6]
+    end
+
+    def blz_empfaenger
+      @string[7..14]
+    end
+
+    def blz_absender
+      @string[15..22]
+    end
+
+    def name_absender
+      @string[23..49]
+    end
+
+    def erstellt_am
+      @string[50..55]
+    end
+
+    def leerzeichen1
+      @string[56..59]
+    end
+
+    def konto_absender
+      @string[60..69]
+    end
+
+    def sammel_referenznummer
+      @string[70..79]
+    end
+
+    def leerzeichen2
+      @string[80..126]
+    end
+
+    def waehrung
+      @string[127..127]
+    end
+  end
+end