cmxl 1.2.0 → 1.3.0

data/lib/cmxl/fields/account_balance.rb

@@ -5,11 +5,11 @@ module Cmxl
       self.parser = /(?<funds_code>\A[a-zA-Z]{1})(?<date>\d{6})(?<currency>[a-zA-Z]{3})(?<amount>[\d|,|\.]{4,15})/i
 
       def date
-        to_date(self.data['date'])
+        to_date(data['date'])
       end
 
       def credit?
-        self.data['funds_code'].to_s.upcase == 'C'
+        data['funds_code'].to_s.casecmp('C').zero?
       end
 
       def debit?
@@ -17,19 +17,19 @@ module Cmxl
       end
 
       def amount
-        to_amount(self.data['amount'])
+        to_amount(data['amount'])
       end
 
       def sign
-        self.credit? ? 1 : -1
+        credit? ? 1 : -1
       end
 
       def amount_in_cents
-        to_amount_in_cents(self.data['amount'])
+        to_amount_in_cents(data['amount'])
       end
 
       def to_h
-        super.merge({
+        super.merge(
           'date' => date,
           'funds_code' => funds_code,
           'credit' => credit?,
@@ -38,7 +38,7 @@ module Cmxl
           'amount' => amount,
           'amount_in_cents' => amount_in_cents,
           'sign' => sign
-        })
+        )
       end
     end
   end

data/lib/cmxl/fields/account_identification.rb

@@ -5,7 +5,7 @@ module Cmxl
       self.parser = /(?<bank_code>\w{8,11})\/(?<account_number>\d{0,23})(?<currency>[A-Z]{3})?|(?<country>[a-zA-Z]{2})(?<ban>\d{11,36})/i
 
       def iban
-        "#{self.country}#{self.ban}"
+        "#{country}#{ban}"
       end
     end
   end

data/lib/cmxl/fields/floor_limit_indicator.rb

@@ -0,0 +1,20 @@
+module Cmxl
+  module Fields
+    class FloorLimitIndicator < Field
+      self.tag = 34
+      self.parser = /(?<currency>[a-zA-Z]{3})(?<type_indicator>[DC]?)(?<amount>[\d|,|\.]{4,15})/i
+
+      def credit?
+        data['type_indicator'].empty? || data['type_indicator'] == 'C'
+      end
+
+      def debit?
+        data['type_indicator'].empty? || data['type_indicator'] == 'D'
+      end
+
+      def amount
+        to_amount(data['amount'])
+      end
+    end
+  end
+end

data/lib/cmxl/fields/reference.rb

@@ -5,17 +5,16 @@ module Cmxl
       self.parser = /(?<statement_identifier>[a-zA-Z]{0,2})(?<date>\d{6})(?<additional_number>.*)/i
 
       def reference
-        self.source
+        source
       end
 
       def date
-        to_date(self.data['date'])
+        to_date(data['date'])
       end
 
       def to_h
-        super.merge({'date' => date, 'reference' => source})
+        super.merge('date' => date, 'reference' => source)
       end
-
     end
   end
 end

data/lib/cmxl/fields/statement_details.rb

@@ -7,31 +7,31 @@ module Cmxl
       class << self
         def parse(line)
           # remove line breaks as they are allowed via documentation but not needed for data-parsing
-          super line.gsub(/\n/, '')
+          super line.delete("\n")
         end
       end
 
       def sub_fields
-        @sub_fields ||= if self.data['details'] =~ /#{Regexp.escape(self.data['seperator'])}(\d{2})/
-            Hash[self.data['details'].scan(/#{Regexp.escape(self.data['seperator'])}(\d{2})([^#{Regexp.escape(self.data['seperator'])}]*)/)]
-          else
-            {}
+        @sub_fields ||= if data['details'] =~ /#{Regexp.escape(data['seperator'])}(\d{2})/
+                          Hash[data['details'].scan(/#{Regexp.escape(data['seperator'])}(\d{2})([^#{Regexp.escape(data['seperator'])}]*)/)]
+                        else
+                          {}
           end
       end
 
       def description
-        self.sub_fields['00'] || self.data['details']
+        sub_fields['00'] || data['details']
       end
 
       def information
-        info = (20..29).to_a.collect {|i| self.sub_fields[i.to_s] }.join('')
-        info.empty? ? self.description : info
+        info = (20..29).to_a.collect { |i| sub_fields[i.to_s] }.join('')
+        info.empty? ? description : info
       end
 
       def sepa
-        if self.information =~ /([A-Z]{4})\+/
+        if information =~ /([A-Z]{4})\+/
           Hash[
-            *self.information.split(/([A-Z]{4})\+/)[1..-1].tap {|info| info << "" if info.size.odd? }
+            *information.split(/([A-Z]{4})\+/)[1..-1].tap { |info| info << '' if info.size.odd? }
           ]
         else
           {}
@@ -39,15 +39,15 @@ module Cmxl
       end
 
       def bic
-        self.sub_fields['30']
+        sub_fields['30']
       end
 
       def name
-        [self.sub_fields['32'], self.sub_fields['33']].compact.join(" ")
+        [sub_fields['32'], sub_fields['33']].compact.join(' ')
       end
 
       def iban
-        self.sub_fields['38'] || self.sub_fields['31']
+        sub_fields['38'] || sub_fields['31']
       end
 
       def to_h

data/lib/cmxl/fields/transaction.rb

@@ -77,12 +77,15 @@ module Cmxl
       def initial_amount_in_cents
         supplementary.initial_amount_in_cents
       end
+
       def initial_currency
         supplementary.initial_currency
       end
+
       def charges_in_cents
         supplementary.charges_in_cents
       end
+
       def charges_currency
         supplementary.charges_currency
       end
@@ -92,21 +95,27 @@ module Cmxl
       def description
         details.description if details
       end
+
       def information
         details.information if details
       end
+
       def bic
         details.bic if details
       end
+
       def name
         details.name if details
       end
+
       def iban
         details.iban if details
       end
+
       def sepa
         details.sepa if details
       end
+
       def sub_fields
         details.sub_fields if details
       end
@@ -126,7 +135,7 @@ module Cmxl
           'swift_code' => swift_code,
           'reference' => reference,
           'bank_reference' => bank_reference,
-          'currency_letter' => currency_letter,
+          'currency_letter' => currency_letter
         }.tap do |h|
           h.merge!(details.to_h) if details
           h.merge!(supplementary.to_h) if supplementary.source

data/lib/cmxl/fields/transaction_supplementary.rb

@@ -1,20 +1,23 @@
 module Cmxl
   module Fields
     class TransactionSupplementary < Field
-
       attr_accessor :source, :initial, :charges
 
       class << self
         def parse(line)
-          initial = $1 if line && line.match(initial_parser)
-          charges = $1 if line && line.match(charges_parser)
+          initial = Regexp.last_match(1) if line && line.match(initial_parser)
+          charges = Regexp.last_match(1) if line && line.match(charges_parser)
           new(line, initial, charges)
         end
 
-        def initial_parser; %r{((?:\/OCMT\/)(?<initial>[a-zA-Z]{3}[\d,]{1,15}))} end
-        def charges_parser; %r{((?:\/CHGS\/)(?<charges>[a-zA-Z]{3}[\d,]{1,15}))} end
-      end
+        def initial_parser
+          %r{((?:\/OCMT\/)(?<initial>[a-zA-Z]{3}[\d,]{1,15}))}
+        end
 
+        def charges_parser
+          %r{((?:\/CHGS\/)(?<charges>[a-zA-Z]{3}[\d,]{1,15}))}
+        end
+      end
 
       def initialize(line, initial, charges)
         self.source = line
@@ -44,10 +47,10 @@ module Cmxl
           initial_amount_in_cents: initial_amount_in_cents,
           initial_currency: initial_currency,
           charges_in_cents: charges_in_cents,
-          charges_currency: charges_currency,
+          charges_currency: charges_currency
         }
       end
-      alias_method :to_hash, :to_h
+      alias to_hash to_h
     end
   end
 end

data/lib/cmxl/fields/vmk_summary.rb

@@ -0,0 +1,33 @@
+module Cmxl
+  module Fields
+    class VmkSummary < Field
+      self.tag = 90
+      self.parser = /(?<entries>\d{,53})(?<currency>\w{3})(?<amount>[\d|,|\.]{1,15})/i
+
+      def credit?
+        modifier == 'C'
+      end
+
+      def debit?
+        modifier == 'D'
+      end
+
+      def entries
+        data['entries'].to_i
+      end
+
+      def amount
+        to_amount(data['amount'])
+      end
+
+      def to_h
+        {
+          type: debit? ? 'debit' : 'credit',
+          entries: entries,
+          amount: amount,
+          currency: currency
+        }
+      end
+    end
+  end
+end

data/lib/cmxl/statement.rb

@@ -13,12 +13,12 @@ module Cmxl
       self.source = source
       self.fields = []
       self.lines = []
-      self.strip_headers! if Cmxl.config[:strip_headers]
-      self.parse!
+      strip_headers! if Cmxl.config[:strip_headers]
+      parse!
     end
 
     def transactions
-      self.fields.select { |field| field.kind_of?(Fields::Transaction) }
+      fields.select { |field| field.is_a?(Fields::Transaction) }
     end
 
     # Internal: Parse a single MT940 statement and extract the line data
@@ -30,71 +30,86 @@ module Cmxl
       # do not remove line breaks within transaction lines as they are used to determine field details
       # e.g. :61:-supplementary
       source.split("\n:").each(&:strip!).each do |line|
-        line = ":#{line}" unless line =~ %r{^:} # prepend lost : via split
+        line = ":#{line}" unless line =~ /^:/ # prepend lost : via split
 
-        if line.match(/\A:86:/)
+        if line =~ /\A:86:/
           if field = fields.last
             field.add_meta_data(line)
           end
         else
           field = Field.parse(line)
-          self.fields << field unless field.nil?
+          fields << field unless field.nil?
         end
       end
     end
 
     def strip_headers!
-      self.source.gsub!(/\A.+?(?=^:)/m, '') # beginning: strip every line in the beginning that does not start with a :
-      self.source.gsub!(/^[^:]+\z/, '') # end: strip every line in the end that does not start with a :
-      self.source.strip!
+      source.gsub!(/\A.+?(?=^:)/m, '') # beginning: strip every line in the beginning that does not start with a :
+      source.gsub!(/^[^:]+\z/, '') # end: strip every line in the end that does not start with a :
+      source.strip!
     end
 
-
     # Public: SHA2 of the provided source
     # This is an experiment of trying to identify statements. The MT940 itself might not provide a unique identifier
     #
     # Returns the SHA2 of the source
     def sha
-      Digest::SHA2.new.update(self.source).to_s
+      Digest::SHA2.new.update(source).to_s
     end
 
     def reference
-      self.field(20).reference
+      field(20).reference
     end
 
     def generation_date
-      self.field(20).date || self.field(13).date
+      field(20).date || field(13).date
     end
 
     def account_identification
-      self.field(25)
+      field(25)
     end
 
     def opening_balance
-      self.field(60, 'F')
+      field(60, 'F')
     end
 
     def opening_or_intermediary_balance
-      self.field(60)
+      field(60)
     end
 
     def closing_balance
-      self.field(62, 'F')
+      field(62, 'F')
     end
 
     def closing_or_intermediary_balance
-      self.field(62)
+      field(62)
     end
 
     def available_balance
-      self.field(64)
+      field(64)
     end
 
     def legal_sequence_number
-      self.field(28).source
+      field(28).source
+    end
+
+    def vmk_credit_summary
+      field(90, 'C')
+    end
+
+    def vmk_debit_summary
+      field(90, 'D')
+    end
+
+    def mt942?
+      fields.any? { |field| field.is_a? Fields::FloorLimitIndicator }
     end
 
     def to_h
+      mt942? ? mt942_hash : mt940_hash
+    end
+
+    def mt940_hash
       {
         'reference' => reference,
         'sha' => sha,
@@ -107,9 +122,24 @@ module Cmxl
         'fields' => fields.map(&:to_h)
       }
     end
+
+    def mt942_hash
+      {
+        'reference' => reference,
+        'sha' => sha,
+        'generation_date' => generation_date,
+        'account_identification' => account_identification.to_h,
+        'debit_summary' => vmk_debit_summary.to_h,
+        'credit_summary' => vmk_credit_summary.to_h,
+        'transactions' => transactions.map(&:to_h),
+        'fields' => fields.map(&:to_h)
+      }
+    end
+
     def to_hash
       to_h
     end
+
     def to_json(*args)
       to_h.to_json(*args)
     end
@@ -120,8 +150,8 @@ module Cmxl
     # Example:
     # field(20)
     # field(61,'F')
-    def field(tag, modifier=nil)
-      self.fields.detect {|field| field.tag == tag.to_s && (modifier.nil? || field.modifier == modifier) }
+    def field(tag, modifier = nil)
+      fields.detect { |field| field.tag == tag.to_s && (modifier.nil? || field.modifier == modifier) }
     end
   end
 end

data/lib/cmxl/version.rb

@@ -1,3 +1,3 @@
 module Cmxl
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'.freeze
 end