cfonb 0.0.0 → 0.0.2

data/spec/cfonb/parser_spec.rb

@@ -0,0 +1,469 @@
+# frozen_string_literal: true
+
+require 'cfonb'
+
+describe CFONB::Parser do
+  describe '.parse' do
+    subject(:statements) { described_class.new(input).parse }
+
+    let(:input) { File.read('spec/files/example.txt') }
+
+    context 'with a valid input' do
+      it 'parses correctly' do
+        expect(statements).to contain_exactly(
+          an_instance_of(CFONB::Statement),
+          an_instance_of(CFONB::Statement)
+        )
+
+        expect(statements[0]).to have_attributes(
+          bank: '15589',
+          branch: '00000',
+          currency: 'EUR',
+          account: '98765432100',
+          from: Date.new(2019, 5, 15),
+          from_balance: -190.4,
+          to: Date.new(2019, 5, 16),
+          to_balance: -241.21
+        )
+
+        expect(statements[0].operations.size).to eq(3)
+
+        expect(statements[0].operations[0]).to have_attributes(
+          amount: -32.21,
+          currency: 'EUR',
+          date: Date.new(2019, 5, 16),
+          exoneration_code: '0',
+          interbank_code: 'B1',
+          internal_code: '9162',
+          label: "PRLV SEPA TEST CABINET\nMENSUEAUHTR13133",
+          number: 0,
+          reference: '',
+          rejection_code: '',
+          unavailability_code: '0',
+          value_date: Date.new(2019, 5, 16),
+          original_currency: nil,
+          original_amount: nil,
+          debtor: 'INTERNET SFR'
+        )
+
+        expect(statements[0].operations[1]).to have_attributes(
+          amount: -10.7,
+          currency: 'EUR',
+          date: Date.new(2019, 5, 16),
+          exoneration_code: '0',
+          interbank_code: 'B1',
+          internal_code: '9162',
+          label: 'VIR  SEPA DEMONSTRATION',
+          number: 0,
+          reference: '',
+          rejection_code: '',
+          unavailability_code: '0',
+          value_date: Date.new(2019, 5, 16),
+          original_currency: nil,
+          original_amount: nil,
+          debtor: 'ELEC ERDF'
+        )
+
+        expect(statements[0].operations[2]).to have_attributes(
+          amount: -7.9,
+          currency: 'EUR',
+          date: Date.new(2019, 5, 15),
+          exoneration_code: '1',
+          interbank_code: '62',
+          internal_code: '0117',
+          label: 'F COMMISSION D INTERVENTION',
+          number: 0,
+          reference: '',
+          rejection_code: '',
+          unavailability_code: '0',
+          value_date: Date.new(2019, 5, 15),
+          original_currency: nil,
+          original_amount: nil
+        )
+
+        expect(statements[1]).to have_attributes(
+          bank: '18706',
+          branch: '00000',
+          currency: 'EUR',
+          account: '00123456789',
+          from: Date.new(2019, 5, 16),
+          from_balance: -241.21,
+          to: Date.new(2019, 5, 17),
+          to_balance: -163.72
+        )
+
+        expect(statements[1].operations.size).to eq(3)
+
+        expect(statements[1].operations[0]).to have_attributes(
+          amount: BigDecimal('97.49', 4),
+          currency: 'EUR',
+          date: Date.new(2019, 5, 17),
+          exoneration_code: '',
+          interbank_code: 'A3',
+          internal_code: '0158',
+          label: "PRLV SEPA GROUPAMA CEN\nP051928612   22793301700040",
+          number: 0,
+          reference: '',
+          rejection_code: '',
+          unavailability_code: '0',
+          value_date: Date.new(2019, 5, 15),
+          original_currency: nil,
+          original_amount: nil
+        )
+
+        expect(statements[1].operations[1]).to have_attributes(
+          amount: -12.1,
+          currency: 'EUR',
+          date: Date.new(2019, 5, 15),
+          exoneration_code: '1',
+          interbank_code: '62',
+          internal_code: '0337',
+          label: 'F FRAIS PRLV IMP 97 49EUR',
+          number: 0,
+          reference: '',
+          rejection_code: '',
+          unavailability_code: '0',
+          value_date: Date.new(2019, 5, 15),
+          original_currency: nil,
+          original_amount: nil
+        )
+
+        expect(statements[1].operations[2]).to have_attributes(
+          amount: -7.9,
+          currency: 'EUR',
+          date: Date.new(2019, 5, 16),
+          exoneration_code: '1',
+          interbank_code: '62',
+          internal_code: '0117',
+          label: 'F COMMISSION D INTERVENTION',
+          number: 0,
+          reference: '',
+          rejection_code: '',
+          unavailability_code: '0',
+          value_date: Date.new(2019, 5, 16),
+          original_currency: nil,
+          original_amount: nil
+        )
+      end
+    end
+
+    context 'with an operation out of a statement' do
+      let(:input) { File.read('spec/files/operation_out_of_statement.txt') }
+
+      it 'raises UnstartedStatementError' do
+        expect do
+          statements
+        end.to raise_error(CFONB::UnstartedStatementError)
+      end
+    end
+
+    context 'with an operation detail without an operation' do
+      let(:input) { File.read('spec/files/operation_detail_without_operation.txt') }
+
+      it 'raises UnstartedOperationError' do
+        expect do
+          statements
+        end.to raise_error(CFONB::UnstartedOperationError)
+      end
+    end
+
+    context 'with an end of statement without its beginning' do
+      let(:input) { File.read('spec/files/end_of_statement_without_beginning.txt') }
+
+      it 'raises UnstartedStatementError' do
+        expect do
+          statements
+        end.to raise_error(CFONB::UnstartedStatementError)
+      end
+    end
+
+    context 'with a new statement starting without the previous being finished' do
+      let(:input) { File.read('spec/files/new_statement_without_previous_ended.txt') }
+
+      it 'raises UnfinishedStatementError' do
+        expect do
+          statements
+        end.to raise_error(CFONB::UnfinishedStatementError)
+      end
+    end
+
+    context 'when parser error' do
+      let(:input) { File.read('spec/files/invalid_date.txt') }
+
+      it 'raises CFONB::ParserError' do
+        expect { statements }.to raise_error(CFONB::ParserError)
+      end
+    end
+
+    context 'with an optimistic parse' do
+      subject(:statements) { described_class.new(input).parse(optimistic: true) }
+
+      context 'with a valid input' do
+        it 'parses correctly' do
+          expect(statements).to contain_exactly(
+            an_instance_of(CFONB::Statement),
+            an_instance_of(CFONB::Statement)
+          )
+
+          expect(statements[0]).to have_attributes(
+            bank: '15589',
+            branch: '00000',
+            currency: 'EUR',
+            account: '98765432100',
+            from: Date.new(2019, 5, 15),
+            from_balance: -190.4,
+            to: Date.new(2019, 5, 16),
+            to_balance: -241.21
+          )
+
+          expect(statements[0].operations.size).to eq(3)
+
+          expect(statements[0].operations[0]).to have_attributes(
+            amount: -32.21,
+            currency: 'EUR',
+            date: Date.new(2019, 5, 16),
+            exoneration_code: '0',
+            interbank_code: 'B1',
+            internal_code: '9162',
+            label: "PRLV SEPA TEST CABINET\nMENSUEAUHTR13133",
+            number: 0,
+            reference: '',
+            rejection_code: '',
+            unavailability_code: '0',
+            value_date: Date.new(2019, 5, 16),
+            original_currency: nil,
+            original_amount: nil,
+            debtor: 'INTERNET SFR'
+          )
+
+          expect(statements[0].operations[1]).to have_attributes(
+            amount: -10.7,
+            currency: 'EUR',
+            date: Date.new(2019, 5, 16),
+            exoneration_code: '0',
+            interbank_code: 'B1',
+            internal_code: '9162',
+            label: 'VIR  SEPA DEMONSTRATION',
+            number: 0,
+            reference: '',
+            rejection_code: '',
+            unavailability_code: '0',
+            value_date: Date.new(2019, 5, 16),
+            original_currency: nil,
+            original_amount: nil,
+            debtor: 'ELEC ERDF'
+          )
+
+          expect(statements[0].operations[2]).to have_attributes(
+            amount: -7.9,
+            currency: 'EUR',
+            date: Date.new(2019, 5, 15),
+            exoneration_code: '1',
+            interbank_code: '62',
+            internal_code: '0117',
+            label: 'F COMMISSION D INTERVENTION',
+            number: 0,
+            reference: '',
+            rejection_code: '',
+            unavailability_code: '0',
+            value_date: Date.new(2019, 5, 15),
+            original_currency: nil,
+            original_amount: nil
+          )
+
+          expect(statements[1]).to have_attributes(
+            bank: '18706',
+            branch: '00000',
+            currency: 'EUR',
+            account: '00123456789',
+            from: Date.new(2019, 5, 16),
+            from_balance: -241.21,
+            to: Date.new(2019, 5, 17),
+            to_balance: -163.72
+          )
+
+          expect(statements[1].operations.size).to eq(3)
+
+          expect(statements[1].operations[0]).to have_attributes(
+            amount: BigDecimal('97.49', 4),
+            currency: 'EUR',
+            date: Date.new(2019, 5, 17),
+            exoneration_code: '',
+            interbank_code: 'A3',
+            internal_code: '0158',
+            label: "PRLV SEPA GROUPAMA CEN\nP051928612   22793301700040",
+            number: 0,
+            reference: '',
+            rejection_code: '',
+            unavailability_code: '0',
+            value_date: Date.new(2019, 5, 15),
+            original_currency: nil,
+            original_amount: nil
+          )
+
+          expect(statements[1].operations[1]).to have_attributes(
+            amount: -12.1,
+            currency: 'EUR',
+            date: Date.new(2019, 5, 15),
+            exoneration_code: '1',
+            interbank_code: '62',
+            internal_code: '0337',
+            label: 'F FRAIS PRLV IMP 97 49EUR',
+            number: 0,
+            reference: '',
+            rejection_code: '',
+            unavailability_code: '0',
+            value_date: Date.new(2019, 5, 15),
+            original_currency: nil,
+            original_amount: nil
+          )
+
+          expect(statements[1].operations[2]).to have_attributes(
+            amount: -7.9,
+            currency: 'EUR',
+            date: Date.new(2019, 5, 16),
+            exoneration_code: '1',
+            interbank_code: '62',
+            internal_code: '0117',
+            label: 'F COMMISSION D INTERVENTION',
+            number: 0,
+            reference: '',
+            rejection_code: '',
+            unavailability_code: '0',
+            value_date: Date.new(2019, 5, 16),
+            original_currency: nil,
+            original_amount: nil
+          )
+        end
+      end
+
+      context 'with an operation out of a statement' do
+        let(:input) { File.read('spec/files/operation_out_of_statement.txt') }
+
+        it 'ignores the operation' do
+          expect(statements.size).to eq(1)
+          expect(statements[0].operations.size).to eq(1)
+          expect(statements[0].operations[0]).to have_attributes(
+            amount: -10.7,
+            currency: 'EUR',
+            date: Date.new(2019, 5, 16),
+            exoneration_code: '0',
+            interbank_code: 'B1',
+            internal_code: '9162',
+            label: 'VIR  SEPA DEMONSTRATION',
+            number: 0,
+            reference: '',
+            rejection_code: '',
+            unavailability_code: '0',
+            value_date: Date.new(2019, 5, 16),
+            original_currency: nil,
+            original_amount: nil,
+            debtor: 'ELEC ERDF'
+          )
+        end
+      end
+
+      context 'with an operation detail without an operation' do
+        let(:input) { File.read('spec/files/operation_detail_without_operation.txt') }
+
+        it 'ignores the operation detail' do
+          expect(statements.size).to eq(1)
+          expect(statements[0].operations.size).to eq(1)
+          expect(statements[0].operations[0]).to have_attributes(
+            amount: -10.7,
+            currency: 'EUR',
+            date: Date.new(2019, 5, 16),
+            exoneration_code: '0',
+            interbank_code: 'B1',
+            internal_code: '9162',
+            label: 'VIR  SEPA DEMONSTRATION',
+            number: 0,
+            reference: '',
+            rejection_code: '',
+            unavailability_code: '0',
+            value_date: Date.new(2019, 5, 16),
+            original_currency: nil,
+            original_amount: nil,
+            debtor: 'ELEC ERDF'
+          )
+        end
+      end
+
+      context 'with an end of statement without its beginning' do
+        let(:input) { File.read('spec/files/end_of_statement_without_beginning.txt') }
+
+        it 'ignores the end of statement' do
+          expect(statements.size).to eq(1)
+          expect(statements[0].operations.size).to eq(1)
+          expect(statements[0].operations[0]).to have_attributes(
+            amount: -10.7,
+            currency: 'EUR',
+            date: Date.new(2019, 5, 16),
+            exoneration_code: '0',
+            interbank_code: 'B1',
+            internal_code: '9162',
+            label: 'VIR  SEPA DEMONSTRATION',
+            number: 0,
+            reference: '',
+            rejection_code: '',
+            unavailability_code: '0',
+            value_date: Date.new(2019, 5, 16),
+            original_currency: nil,
+            original_amount: nil,
+            debtor: 'ELEC ERDF'
+          )
+        end
+      end
+
+      context 'with a new statement starting without the previous being finished' do
+        let(:input) { File.read('spec/files/new_statement_without_previous_ended.txt') }
+
+        it 'ignores the new statement' do
+          expect(statements.size).to eq(1)
+          expect(statements[0].operations.size).to eq(2)
+          expect(statements[0].operations[0]).to have_attributes(
+            amount: -10.7,
+            currency: 'EUR',
+            date: Date.new(2019, 5, 16),
+            exoneration_code: '0',
+            interbank_code: 'B1',
+            internal_code: '9162',
+            label: 'VIR  SEPA DEMONSTRATION',
+            number: 0,
+            reference: '',
+            rejection_code: '',
+            unavailability_code: '0',
+            value_date: Date.new(2019, 5, 16),
+            original_currency: nil,
+            original_amount: nil,
+            debtor: 'ELEC ERDF'
+          )
+          expect(statements[0].operations[1]).to have_attributes(
+            amount: -7.9,
+            currency: 'EUR',
+            date: Date.new(2019, 5, 16),
+            exoneration_code: '1',
+            interbank_code: '62',
+            internal_code: '0117',
+            label: 'F COMMISSION D INTERVENTION',
+            number: 0,
+            reference: '',
+            rejection_code: '',
+            unavailability_code: '0',
+            value_date: Date.new(2019, 5, 16),
+            original_currency: nil,
+            original_amount: nil
+          )
+        end
+      end
+
+      context 'when parser error' do
+        let(:input) { File.read('spec/files/invalid_date.txt') }
+
+        it 'returns empty statements' do
+          expect(statements.size).to eq(0)
+        end
+      end
+    end
+  end
+end

data/spec/cfonb/statement_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'cfonb'
+
+describe CFONB::Statement do
+  subject(:statement) do
+    described_class.new(begin_line)
+                   .tap { _1.operations << operation }
+                   .tap { _1.merge_new_balance(end_line) }
+  end
+
+  let(:operation) do
+    CFONB::Operation
+      .new(operation_line)
+      .tap { _1.merge_detail(detail_line) }
+  end
+
+  let(:begin_line) do
+    CFONB::LineParser.parse(
+      '0115589    00000EUR2 98765432100  150519                                                  0000000001904}150519160519    '
+    )
+  end
+  let(:operation_line) do
+    CFONB::LineParser.parse(
+      '0415589916200000EUR2 98765432100B1160519  160519PRLV SEPA TEST CABINET           0000000000000000000322J                '
+    )
+  end
+  let(:detail_line) do
+    CFONB::LineParser.parse(
+      '0515589916200000EUR2 98765432100B1160519     LIBMENSUEAUHTR13133                                                        '
+    )
+  end
+  let(:end_line) do
+    CFONB::LineParser.parse(
+      '0715489    00000EUR2 98765432100  160519                                                  0000000002412J                '
+    )
+  end
+
+  describe '#raw' do
+    it 'joins all the statement raws' do
+      expect(statement.raw).to eq(<<~TXT.chomp)
+        0115589    00000EUR2 98765432100  150519                                                  0000000001904}150519160519#{'    '}
+        0415589916200000EUR2 98765432100B1160519  160519PRLV SEPA TEST CABINET           0000000000000000000322J#{'                '}
+        0515589916200000EUR2 98765432100B1160519     LIBMENSUEAUHTR13133#{'                                                        '}
+        0715489    00000EUR2 98765432100  160519                                                  0000000002412J#{'                '}
+      TXT
+    end
+  end
+
+  describe '#rib' do
+    it 'returns the correct rib' do
+      expect(statement.rib).to eq('15589000009876543210088')
+    end
+  end
+
+  describe '#iban' do
+    it 'returns the correct iban' do
+      expect(statement.iban).to eq('FR7615589000009876543210088')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cfonb
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.2
 platform: ruby
 authors:
 - Johan Le Bray
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-08 00:00:00.000000000 Z
+date: 2023-09-25 00:00:00.000000000 Z
 dependencies: []
 description: An easy to use CFONB format parser
 email: ''
@@ -18,7 +18,36 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/cfonb.rb
-homepage: https://rubygems.org/gems/cfonb
+- lib/cfonb/error.rb
+- lib/cfonb/line_parser.rb
+- lib/cfonb/line_parser/base.rb
+- lib/cfonb/line_parser/new_balance.rb
+- lib/cfonb/line_parser/operation.rb
+- lib/cfonb/line_parser/operation_detail.rb
+- lib/cfonb/line_parser/previous_balance.rb
+- lib/cfonb/operation.rb
+- lib/cfonb/operation_detail.rb
+- lib/cfonb/operation_detail/fee.rb
+- lib/cfonb/operation_detail/lc2.rb
+- lib/cfonb/operation_detail/lcc.rb
+- lib/cfonb/operation_detail/lcs.rb
+- lib/cfonb/operation_detail/lib.rb
+- lib/cfonb/operation_detail/mmo.rb
+- lib/cfonb/operation_detail/nbe.rb
+- lib/cfonb/operation_detail/npy.rb
+- lib/cfonb/operation_detail/rcn.rb
+- lib/cfonb/operation_detail/ref.rb
+- lib/cfonb/parser.rb
+- lib/cfonb/refinements/strings.rb
+- lib/cfonb/statement.rb
+- spec/cfonb/line_parser/new_balance_spec.rb
+- spec/cfonb/line_parser/operation_detail_spec.rb
+- spec/cfonb/line_parser/operation_spec.rb
+- spec/cfonb/line_parser/previous_balance_spec.rb
+- spec/cfonb/operation_spec.rb
+- spec/cfonb/parser_spec.rb
+- spec/cfonb/statement_spec.rb
+homepage: https://github.com/pennylane-hq/cfonb
 licenses:
 - MIT
 metadata: {}
@@ -37,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: CFONB parser