cfonb 0.0.0 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ecb2f0157c3dff40868b71296f77af49bd5b2cb6b0e5a1ecbd9abed606392d3
-  data.tar.gz: 2187588d8e68fd14626f125530f2c4e0f3ad78356b1ec1a82bf2273b3e93fd50
+  metadata.gz: 1666b9858511859d77ab8b3c14a11ee214548b5da5154ee927cf7e51b14eca95
+  data.tar.gz: 292ed95e4250414dc82ef2967df62663cdadf529d72d8229d5609eee0fb3f0b1
 SHA512:
-  metadata.gz: 81590edc8a9b56dbdacd3470896cc7649131e7b57aa9167eee59001326463efa47422de544ce140c55c50acb0b9311ad34f869f1e88e48d8b173cfe35313da52
-  data.tar.gz: e41c09652881278e96ec2f43d67494d34b175f21cc651d71dfc4cee2bef47f4c8d67cb01356e52e8be60b6530b1fd3dab6eb4d37254b366ddfe5b370535afa46
+  metadata.gz: 9c74e319b7448e79163010bea1efeb5a5c5391bd0352b3c38d3145fd41f27ae60b0fe562d25b65698d207418288fb61dc4d49231be968f7dead6905bbc854132
+  data.tar.gz: a568a83590cfd3666d9ac96ba4dd6c09a39e73aa3a8136904cc24fe25df7d6b5b2f6d3fac74aee01e4ad57bf4455f9d4cf9e55ed993ca8f07f4b440eb103dc8d

data/lib/cfonb/error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CFONB
+  class Error < StandardError; end
+
+  class ParserError < Error; end
+
+  class InvalidCodeError < ParserError; end
+
+  class UnstartedStatementError < ParserError; end
+
+  class UnstartedOperationError < ParserError; end
+
+  class UnfinishedStatementError < ParserError; end
+end

data/lib/cfonb/line_parser/base.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+
+module CFONB
+  module LineParser
+    class Base
+      using CFONB::Refinements::Strings
+
+      BASE_DICTIONARY = [
+        ['code', (0..1)].freeze,
+        ['bank', (2..6)],
+        ['branch', (11..15)],
+        ['currency', (16..18)],
+        ['scale', 19, proc { _1.to_i }],
+        ['account', (21..31)],
+        ['date', (34..39), proc { |value, instance| instance.send(:parse_date, value) }]
+      ].freeze
+
+      AMOUNT_SPECIFIERS = {
+        'A' => { sign: 1, value: '1' },
+        'B' => { sign: 1, value: '2' },
+        'C' => { sign: 1, value: '3' },
+        'D' => { sign: 1, value: '4' },
+        'E' => { sign: 1, value: '5' },
+        'F' => { sign: 1, value: '6' },
+        'G' => { sign: 1, value: '7' },
+        'H' => { sign: 1, value: '8' },
+        'I' => { sign: 1, value: '9' },
+        '{' => { sign: 1, value: '0' },
+        'J' => { sign: -1, value: '1' },
+        'K' => { sign: -1, value: '2' },
+        'L' => { sign: -1, value: '3' },
+        'M' => { sign: -1, value: '4' },
+        'N' => { sign: -1, value: '5' },
+        'O' => { sign: -1, value: '6' },
+        'P' => { sign: -1, value: '7' },
+        'Q' => { sign: -1, value: '8' },
+        'R' => { sign: -1, value: '9' },
+        '}' => { sign: -1, value: '0' }
+      }.transform_values(&:freeze).freeze
+
+      attr_reader :body, *BASE_DICTIONARY.map(&:first)
+
+      def initialize(input)
+        @body = input
+        (BASE_DICTIONARY + self.class::DICTIONARY).each { parse_attribute(*_1) }
+      end
+
+      private
+
+      def parse_attribute(attr, position, method = nil)
+        input = body[position]&.strip
+        value = method ? method.call(input, self) : input
+
+        instance_variable_set(:"@#{attr}", value)
+      end
+
+      def parse_amount(input)
+        specifier = AMOUNT_SPECIFIERS[input.last]
+        raise ParserError, "Invalid specifier '#{input.last}' for line #{input}" unless specifier
+
+        specifier[:sign] * BigDecimal(input[0..-2] + specifier[:value]) / (10**scale)
+      end
+
+      def parse_date(input)
+        # This won't work after 2060
+        return if input.strip.empty?
+
+        input_with_year = if input.last(2).to_i > 60
+                            "#{input[0..3]}19#{input[4..5]}"
+                          else
+                            "#{input[0..3]}20#{input[4..5]}"
+                          end
+
+        Date.strptime(input_with_year, '%d%m%Y')
+      rescue Date::Error
+        raise ParserError, "Invalid date '#{input}' for line #{input}"
+      end
+    end
+  end
+end

data/lib/cfonb/line_parser/new_balance.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CFONB
+  module LineParser
+    class NewBalance < Base
+      DICTIONARY = [
+        ['amount', (90..103), proc { |value, instance| instance.send(:parse_amount, value) }]
+      ].freeze
+
+      attr_reader(*DICTIONARY.map(&:first))
+
+      CFONB::LineParser.register(CFONB::Parser::NEW_BALANCE_CODE, self)
+    end
+  end
+end

data/lib/cfonb/line_parser/operation.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module CFONB
+  module LineParser
+    class Operation < Base
+      DICTIONARY = [
+        ['internal_operation_code', (7..10)],
+        ['interbank_operation_code', (32..33)],
+        ['rejection_code', (40..41)],
+        ['value_date', (42..47), proc { |value, instance| instance.send(:parse_date, value) }],
+        ['label', (48..79)],
+        ['number', (81..87), proc { _1.to_i }],
+        ['exoneration_code', 88],
+        ['unavailability_code', 89],
+        ['reference', (104..119)],
+        ['amount', (90..103), proc { |value, instance| instance.send(:parse_amount, value) }]
+      ].freeze
+
+      attr_reader(*DICTIONARY.map(&:first))
+
+      CFONB::LineParser.register(CFONB::Parser::OPERATION_CODE, self)
+    end
+  end
+end

data/lib/cfonb/line_parser/operation_detail.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CFONB
+  module LineParser
+    class OperationDetail < Base
+      DICTIONARY = [
+        ['internal_operation_code', (7..10)],
+        ['interbank_operation_code', (32..33)],
+        ['detail_code', (45..47)],
+        ['detail', (48..117)]
+      ].freeze
+
+      attr_reader(*DICTIONARY.map(&:first))
+
+      CFONB::LineParser.register(CFONB::Parser::OPERATION_DETAIL_CODE, self)
+    end
+  end
+end

data/lib/cfonb/line_parser/previous_balance.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CFONB
+  module LineParser
+    class PreviousBalance < Base
+      DICTIONARY = [
+        ['amount', (90..103), proc { |value, instance| instance.send(:parse_amount, value) }]
+      ].freeze
+
+      attr_reader(*DICTIONARY.map(&:first))
+
+      CFONB::LineParser.register(CFONB::Parser::PREVIOUS_BALANCE_CODE, self)
+    end
+  end
+end

data/lib/cfonb/line_parser.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CFONB
+  module LineParser
+    using CFONB::Refinements::Strings
+
+    @parsers = {}
+
+    def self.register(code, klass)
+      @parsers[code] = klass
+    end
+
+    def self.for(code)
+      @parsers[code]
+    end
+
+    def self.parse(input)
+      self.for(input.first(2)).new(input)
+    end
+  end
+end

data/lib/cfonb/operation.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module CFONB
+  class Operation
+    BASE_ATTRIBUTES = %i[
+      raw
+      amount
+      currency
+      date
+      exoneration_code
+      interbank_code
+      internal_code
+      label
+      number
+      reference
+      rejection_code
+      unavailability_code
+      value_date
+    ].freeze
+
+    attr_accessor(*BASE_ATTRIBUTES)
+
+    def initialize(line)
+      self.raw = line.body
+      self.internal_code = line.internal_operation_code
+      self.interbank_code = line.interbank_operation_code
+      self.rejection_code = line.rejection_code
+      self.exoneration_code = line.exoneration_code
+      self.unavailability_code = line.unavailability_code
+      self.currency = line.currency
+      self.amount = line.amount
+      self.date = line.date
+      self.value_date = line.value_date
+      self.label = line.label.strip
+      self.number = line.number
+      self.reference = line.reference
+    end
+
+    def merge_detail(line)
+      self.raw += "\n#{line.body}"
+      OperationDetail.for(line)&.apply(self, line)
+    end
+
+    def type_code
+      "#{interbank_code}#{direction}"
+    end
+
+    private
+
+    def direction
+      amount.positive? ? 'C' : 'D'
+    end
+  end
+end

data/lib/cfonb/operation_detail/fee.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CFONB
+  module OperationDetail
+    class FEE
+      ATTRIBUTES = %i[fee fee_currency].freeze
+
+      def self.apply(operation, line)
+        operation.fee_currency = line.detail[0..2]
+        scale = line.detail[3].to_i
+        sign = operation.amount <=> 0 # the detail amount is unsigned
+
+        operation.fee = sign * BigDecimal(line.detail[4..17]) / (10**scale)
+      end
+
+      CFONB::OperationDetail.register('FEE', self)
+    end
+  end
+end

data/lib/cfonb/operation_detail/lc2.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CFONB
+  module OperationDetail
+    class LC2
+      def self.apply(operation, line)
+        operation.label += "\n#{line.detail.strip}"
+      end
+
+      CFONB::OperationDetail.register('LC2', self)
+    end
+  end
+end

data/lib/cfonb/operation_detail/lcc.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CFONB
+  module OperationDetail
+    class LCC
+      def self.apply(operation, line)
+        operation.label += "\n#{line.detail.strip}"
+      end
+
+      CFONB::OperationDetail.register('LCC', self)
+    end
+  end
+end

data/lib/cfonb/operation_detail/lcs.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CFONB
+  module OperationDetail
+    class LCS
+      def self.apply(operation, line)
+        operation.label += "\n#{line.detail[0..35].strip}"
+      end
+
+      CFONB::OperationDetail.register('LCS', self)
+    end
+  end
+end

data/lib/cfonb/operation_detail/lib.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CFONB
+  module OperationDetail
+    class LIB
+      def self.apply(operation, line)
+        operation.label += "\n#{line.detail.strip}"
+      end
+
+      CFONB::OperationDetail.register('LIB', self)
+    end
+  end
+end

data/lib/cfonb/operation_detail/mmo.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+
+module CFONB
+  module OperationDetail
+    class MMO
+      ATTRIBUTES = %i[original_currency original_amount].freeze
+
+      def self.apply(operation, line)
+        operation.original_currency = line.detail[0..2]
+
+        scale = line.detail[3].to_i
+        sign = operation.amount <=> 0 # the detail amount is unsigned
+
+        operation.original_amount = sign * BigDecimal(line.detail[4..17]) / (10**scale)
+      end
+
+      CFONB::OperationDetail.register('MMO', self)
+    end
+  end
+end

data/lib/cfonb/operation_detail/nbe.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CFONB
+  module OperationDetail
+    class NBE
+      ATTRIBUTES = %i[creditor].freeze
+
+      def self.apply(operation, line)
+        operation.creditor = line.detail.strip
+      end
+
+      CFONB::OperationDetail.register('NBE', self)
+    end
+  end
+end

data/lib/cfonb/operation_detail/npy.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CFONB
+  module OperationDetail
+    class NPY
+      ATTRIBUTES = %i[debtor].freeze
+
+      def self.apply(operation, line)
+        operation.debtor = line.detail.strip
+      end
+
+      CFONB::OperationDetail.register('NPY', self)
+    end
+  end
+end

data/lib/cfonb/operation_detail/rcn.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CFONB
+  module OperationDetail
+    class RCN
+      ATTRIBUTES = %i[reference purpose].freeze
+
+      def self.apply(operation, line)
+        operation.reference = [
+          operation.reference,
+          line.detail[0..34].strip
+        ].compact.join(' - ')
+
+        operation.purpose = line.detail[35..-1]&.strip
+      end
+
+      CFONB::OperationDetail.register('RCN', self)
+    end
+  end
+end

data/lib/cfonb/operation_detail/ref.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CFONB
+  module OperationDetail
+    class REF
+      ATTRIBUTES = %i[reference].freeze
+
+      def self.apply(operation, line)
+        operation.reference = [
+          operation.reference,
+          line.detail.strip
+        ].compact.join(' - ')
+      end
+
+      CFONB::OperationDetail.register('REF', self)
+    end
+  end
+end

data/lib/cfonb/operation_detail.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CFONB
+  module OperationDetail
+    @details = {}
+
+    def self.register(code, klass)
+      if klass.const_defined?(:ATTRIBUTES)
+        Operation.class_eval do
+          attr_accessor(*klass::ATTRIBUTES)
+        end
+      end
+
+      @details[code] = klass
+    end
+
+    def self.for(line)
+      @details[line.detail_code]
+    end
+  end
+end

data/lib/cfonb/parser.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module CFONB
+  class Parser
+    using CFONB::Refinements::Strings
+
+    CODES = [
+      PREVIOUS_BALANCE_CODE = '01',
+      OPERATION_CODE = '04',
+      OPERATION_DETAIL_CODE = '05',
+      NEW_BALANCE_CODE = '07'
+    ].freeze
+
+    def initialize(input)
+      @input = input
+    end
+
+    def parse(optimistic: false)
+      @statements = []
+      @current_statement = nil
+      @current_operation = nil
+      @optimistic = optimistic
+
+      each_line { parse_line(_1) }
+
+      statements
+    end
+
+    private
+
+    attr_reader :input, :statements, :current_statement, :current_operation, :optimistic
+
+    def each_line
+      input.each_line do |line|
+        (line.size / 120).times do |index|
+          start = index * 120
+          finish = start + 119
+
+          yield line[start..finish]
+        end
+      end
+    end
+
+    def parse_line(line)
+      return if line.strip.empty?
+      raise InvalidCodeError, "Invalid line code '#{line.first(2)}'" unless CODES.include?(line.first(2))
+
+      line = CFONB::LineParser.parse(line)
+
+      case line.code
+      when PREVIOUS_BALANCE_CODE
+        return handle_error(UnfinishedStatementError) if current_statement
+
+        @current_statement = CFONB::Statement.new(line)
+      when OPERATION_CODE
+        return handle_error(UnstartedStatementError) unless current_statement
+
+        current_statement.operations << current_operation if current_operation
+        @current_operation = CFONB::Operation.new(line)
+      when OPERATION_DETAIL_CODE
+        return handle_error(UnstartedOperationError) unless current_operation
+
+        current_operation.merge_detail(line)
+      when NEW_BALANCE_CODE
+        return handle_error(UnstartedStatementError) unless current_statement
+
+        current_statement.operations << current_operation if current_operation
+        current_statement.merge_new_balance(line)
+        statements << current_statement
+
+        @current_statement = nil
+        @current_operation = nil
+      end
+    rescue CFONB::ParserError => e
+      handle_error(e)
+    end
+
+    def handle_error(error)
+      raise error unless optimistic
+    end
+  end
+end

data/lib/cfonb/refinements/strings.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CFONB
+  module Refinements
+    module Strings
+      refine String do
+
+        def first(count = 1)
+          self[..(count - 1)]
+        end
+
+        def last(count = 1)
+          self[-count..]
+        end
+      end
+    end
+  end
+end

data/lib/cfonb/statement.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module CFONB
+  class Statement
+    attr_accessor(
+      *%i[
+        begin_raw end_raw
+        bank branch currency account
+        from from_balance
+        to to_balance
+        operations
+      ]
+    )
+
+    def initialize(line)
+      self.begin_raw = line.body
+      self.bank = line.bank
+      self.branch = line.branch
+      self.currency = line.currency
+      self.account = line.account
+      self.from = line.date
+      self.from_balance = line.amount
+      self.operations = []
+    end
+
+    def merge_new_balance(line)
+      self.end_raw = line.body
+      self.to = line.date
+      self.to_balance = line.amount
+    end
+
+    def raw
+      [
+        begin_raw,
+        operations.map(&:raw),
+        end_raw
+      ].join("\n")
+    end
+
+    def rib
+      # https://fr.wikipedia.org/wiki/Clé_RIB
+      key = 97 - ((
+        (bank.to_i * 89) +
+        (branch.to_i * 15) +
+        (account.upcase.tr('A-IJ-RS-Z', '1-91-92-9').to_i * 3)
+      ) % 97)
+
+      "#{bank}#{branch}#{account}#{key.to_s.rjust(2, '0')}"
+    end
+
+    def iban
+      # https://fr.wikipedia.org/wiki/International_Bank_Account_Number
+      normalized_rib = "#{rib}FR00".upcase.gsub(/[A-Z]/) { _1.ord - 55 }
+      key = 98 - (normalized_rib.to_i % 97)
+
+      "FR#{key.to_s.rjust(2, '0')}#{rib}"
+    end
+  end
+end

data/lib/cfonb.rb

@@ -0,0 +1,33 @@
+require 'date'
+
+require_relative 'cfonb/refinements/strings'
+
+require_relative 'cfonb/error'
+require_relative 'cfonb/parser'
+require_relative 'cfonb/statement'
+require_relative 'cfonb/operation'
+require_relative 'cfonb/operation_detail'
+
+require_relative 'cfonb/line_parser'
+require_relative 'cfonb/line_parser/base'
+require_relative 'cfonb/line_parser/previous_balance'
+require_relative 'cfonb/line_parser/operation'
+require_relative 'cfonb/line_parser/operation_detail'
+require_relative 'cfonb/line_parser/new_balance'
+
+require_relative 'cfonb/operation_detail/lib'
+require_relative 'cfonb/operation_detail/lcc'
+require_relative 'cfonb/operation_detail/lc2'
+require_relative 'cfonb/operation_detail/lcs'
+require_relative 'cfonb/operation_detail/mmo'
+require_relative 'cfonb/operation_detail/nbe'
+require_relative 'cfonb/operation_detail/npy'
+require_relative 'cfonb/operation_detail/rcn'
+require_relative 'cfonb/operation_detail/ref'
+require_relative 'cfonb/operation_detail/fee'
+
+module CFONB
+  def self.parse(input, optimistic: false)
+    Parser.new(input).parse(optimistic: optimistic)
+  end
+end

data/spec/cfonb/line_parser/new_balance_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'cfonb'
+
+describe CFONB::LineParser::NewBalance do
+  describe '.initialize' do
+    subject(:line) { described_class.new(input) }
+
+    let(:input) do
+      '0115589    01020EUR2 98765432100  150519                                                  0000000001904L150519160519    '
+    end
+
+    it 'correctly parses a line' do
+      expect(line).to have_attributes(
+        'code' => '01',
+        'bank' => '15589',
+        'branch' => '01020',
+        'currency' => 'EUR',
+        'scale' => 2,
+        'account' => '98765432100',
+        'date' => Date.new(2019, 5, 15),
+        'amount' => -190.43
+      )
+    end
+  end
+end