norma43_parser 2.1.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f57b1728de66fc99d9d73d5d98edb6a5a9524441dedae9bd1a2501d4c9279a1
-  data.tar.gz: aaf6c47260dd9b1f3adb2e1d557d946e5c9fa6d64f25de616c0346a6c113541d
+  metadata.gz: 652bfca27d2c071900dd50639cf8ae2762f9bf558d26c58173c3fb391317ca7c
+  data.tar.gz: 74f1b4bf47f3f95470a77a181a48fa642b42287637b9e1ad6dd8d24ee1527aa6
 SHA512:
-  metadata.gz: a5ddd29c9b554700d7e9060376a8a4cc60ee6c2b75c84ffd55cc46b745f792e064c46daac4a54159a111ae5c809ba3051b185973b502f472b418409f71b02ca5
-  data.tar.gz: 720c008c9cdc44429cabb0477ba28983852b99d0ef8ebc0274493f782925f697c5bff756cf8dcd6be1207f13a5285cd8c3b2e9213779eede4492518b7f529bd0
+  metadata.gz: 7aacbf47d289d4a58e958b8f12d1ec0486897a43ecac0c497f04020f126c7cdb70ea30be7a45e899e7448bbe457d9cfbd73eb85291fb10988cb1853cd06c1dfd
+  data.tar.gz: 6f94a39e9179d56efbfd0a72aaebc725cc5d90fac6576ff87ac753f8613448b9eb7e889b8400496991c2133ea629713f00223fa800ee9c5339248c1822af51b5

data/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: Ruby CI
+
+on: [ pull_request, push ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ["3.3", "3.2", "3.1", "3.0", "jruby-head"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rspec

data/.github/workflows/release.yml

@@ -0,0 +1,33 @@
+name: Create gem release pull request
+on:
+  push:
+    branches:
+      - 'master'
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: GoogleCloudPlatform/release-please-action@v3
+        id: release
+        with:
+          release-type: ruby
+          package-name: norma43_parser
+          bump-minor-pre-major: true
+          version-file: 'lib/norma43/version.rb'
+      - uses: actions/checkout@v2
+        if: ${{ steps.release.outputs.release_created }}
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+        if: ${{ steps.release.outputs.release_created }}
+      - name: Publish gem to Rubygems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push --KEY rubygems --host https://rubygems.org *.gem
+        env:
+          GEM_HOST_API_KEY: "${{ secrets.RUBYGEMS_PUBLISH_TOKEN }}"
+        if: ${{ steps.release.outputs.release_created }}

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -1,29 +1,45 @@
-## 2.1.1 (2020-03-13)
+## [4.0.0](https://github.com/sequra/norma43_parser/compare/3.0.0...v4.0.0) (2024-06-18)
 
-### Breaking Changes
 
--
+### ⚠ BREAKING CHANGES
+
+* Drop Ruby support below 3
+
+### Features
+
+* Get IBANs from account instances ([#15](https://github.com/sequra/norma43_parser/issues/15)) ([c69d162](https://github.com/sequra/norma43_parser/commit/c69d162361b188f2b2d904b1958e3108be9a3939))
+
+
+## [3.1.0](https://github.com/sequra/norma43_parser/compare/3.0.0...v3.1.0) (2024-06-19)
+
 
-### Bug fixes
+### Features
 
--
+* get IBANs from account instances ([#15](https://github.com/sequra/norma43_parser/issues/15)) ([3a5dd36](https://github.com/sequra/norma43_parser/commit/3a5dd366a934525e421d3cbcaceabb88a285fb6d))
+
+## v3.0.0 (2021-12-15)
+
+### Breaking Changes
+
+- Drop Ruby support below 2.6.
+
+## v2.1.1 (2020-03-13)
 
 ### Enhancements
 
 - Update rake requirement from ~> 10.0 to ~> 13.0 (#6)
 
-## 2.0.0 (2019-10-17)
+## v2.0.0 (2019-10-17)
 
 ### Breaking Changes
 
 - Drop Ruby support below 2.4.
 
-### Bug fixes
-
--
 
 ### Enhancements
 
 - Clean up dependencies
 
-## 1.0.1 (2016-02-16)
+## v1.0.1 (2016-02-16)
+
+- Initial release

data/Gemfile

@@ -3,8 +3,8 @@
 source "https://rubygems.org"
 
 group :development, :test do
-  gem "rubocop", ">= 0.75", require: false
-  gem "rubocop-performance", require: false
+  gem "rubocop", "~> 1", require: false
+  gem "rubocop-performance", "~> 1", require: false
 end
 
 gemspec

data/Gemfile.lock

@@ -1,73 +1,73 @@
 PATH
   remote: .
   specs:
-    norma43_parser (2.1.1)
-      virtus (~> 1.0)
+    norma43_parser (3.1.0)
       zeitwerk (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    axiom-types (0.1.1)
-      descendants_tracker (~> 0.0.4)
-      ice_nine (~> 0.11.0)
-      thread_safe (~> 0.3, >= 0.3.1)
-    coercible (1.0.0)
-      descendants_tracker (~> 0.0.1)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.3)
-    equalizer (0.0.11)
-    ice_nine (0.11.2)
-    jaro_winkler (1.5.3)
-    parallel (1.18.0)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    ast (2.4.2)
+    diff-lcs (1.5.1)
+    json (2.7.2)
+    json (2.7.2-java)
+    language_server-protocol (3.17.0.3)
+    parallel (1.25.1)
+    parser (3.3.3.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.0)
+    racc (1.8.0-java)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.0)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rubocop (0.75.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.0)
-      rubocop (>= 0.71.0)
-    ruby-progressbar (1.10.1)
-    thread_safe (0.3.6)
-    unicode-display_width (1.6.0)
-    virtus (1.0.5)
-      axiom-types (~> 0.1)
-      coercible (~> 1.0)
-      descendants_tracker (~> 0.0, >= 0.0.3)
-      equalizer (~> 0.0, >= 0.0.9)
-    zeitwerk (2.3.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    strscan (3.1.0)
+    strscan (3.1.0-java)
+    unicode-display_width (2.5.0)
+    zeitwerk (2.6.15)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0)
   norma43_parser!
   rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (>= 0.75)
-  rubocop-performance
+  rspec (~> 3.9)
+  rubocop (~> 1)
+  rubocop-performance (~> 1)
 
 BUNDLED WITH
-   1.17.3
+   2.4.22

data/README.md

@@ -49,6 +49,8 @@ information_mode_code=3,
 transactions=[transaction1..transactionN]
 ```
 
+Also, accounts know their full IBAN. For the example above, `#iban` returns `"ES5400810054180001234567"`. 
+
 ### Transaction
 
 The transaction object has all the information described in the standard format and may include a maximum of five additional items.

data/lib/norma43/models/account/spanish_iban.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Norma43
+  module Models
+    class Account
+      class SpanishIban
+        COUNTRY_CODE = "ES"
+        BANK_CODE_RANGE = BRANCH_CODE_RANGE = 0..9999
+        MAX_BANK_CODE_SIZE = MAX_BRANCH_CODE_SIZE = 4
+        ACCOUNT_NUMBER_RANGE = 0..9_999_999_999
+        IBAN_MODULUS = 97
+        IBAN_FORMAT_STRING = "%{country_code}%<checksum_number>02d%{ccc}"
+        CCC_MODULUS = 11
+        CCC_FORMAT_STRING = "%<bank_code>04d%<branch_code>04d%<checksum_number>02d%<account_number>010d"
+        CCC_WEIGHTS = [6, 3, 7, 9, 10, 5, 8, 4, 2, 1].freeze # Sorted by order of magnitude: units, tens, hundreds, etc.
+
+        def self.from_account(account)
+          return nil unless valid_numbers?(account.bank_code, account.branch_code, account.account_number)
+
+          new(
+            bank_code: account.bank_code,
+            branch_code: account.branch_code,
+            account_number: account.account_number
+          ).to_s
+        end
+
+        def initialize(bank_code:, branch_code:, account_number:)
+          @bank_code, @branch_code, @account_number =
+            if self.class.valid_numbers?(bank_code, branch_code, account_number)
+              [bank_code, branch_code, account_number]
+            else
+              [nil, nil, nil]
+            end
+        end
+
+        def to_s
+          return "" if [bank_code, branch_code, account_number].any?(nil)
+
+          iban
+        end
+
+        private
+          attr_reader :bank_code, :branch_code, :account_number
+
+          def self.valid_numbers?(bank_code, branch_code, account_number)
+            return false unless BANK_CODE_RANGE.include?(bank_code)
+            return false unless BRANCH_CODE_RANGE.include?(branch_code)
+            return false unless ACCOUNT_NUMBER_RANGE.include?(account_number)
+            true
+          end
+
+          def iban
+            format_string = IBAN_FORMAT_STRING
+            country_code = COUNTRY_CODE
+            country_number = calculate_country_number
+            ccc = calculate_ccc
+            number = "#{ccc}#{country_number}00".to_i
+            checksum_number = calculate_iban_checksum_number(number)
+
+            sprintf(format_string,
+              country_code: country_code,
+              checksum_number: checksum_number,
+              ccc: ccc)
+          end
+
+          def calculate_country_number
+            COUNTRY_CODE.chars.map { |char| char.to_i(36) }.join
+          end
+
+          def calculate_ccc
+            format_string = CCC_FORMAT_STRING
+            bank_with_branch_number = (bank_code * 10**MAX_BRANCH_CODE_SIZE) + branch_code
+
+            bank_with_branch_check_digit, account_number_check_digit = [
+              bank_with_branch_number, account_number
+            ].map { |number| calculate_spanish_checksum_digit(number) }
+
+            checksum_number = bank_with_branch_check_digit * 10 + account_number_check_digit
+
+            sprintf(format_string,
+              bank_code: bank_code,
+              branch_code: branch_code,
+              checksum_number: checksum_number,
+              account_number: account_number)
+          end
+
+          def calculate_spanish_checksum_digit(number)
+            modulus = CCC_MODULUS
+
+            reminder = CCC_WEIGHTS.map.with_index { |weight, order_of_magnitude|
+              digit_at_position = (number / 10**order_of_magnitude) % 10
+
+              digit_at_position * weight
+            }.sum % modulus
+
+            return reminder if reminder.zero? || reminder == 1
+            modulus - reminder
+          end
+
+          def calculate_iban_checksum_number(number)
+            modulus = IBAN_MODULUS
+            (modulus + 1) - (number % modulus)
+          end
+      end
+    end
+  end
+end

data/lib/norma43/models/account.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Norma43
+  module Models
+    class Account
+      include Mixins::AttributesAssignment
+
+      attr_accessor :bank_code,
+        :branch_code,
+        :account_number,
+        :start_date,
+        :end_date,
+        :balance_code,
+        :balance_amount,
+        :currency_code,
+        :information_mode_code,
+        :abbreviated_name,
+        :debit_entries,
+        :debit_amount,
+        :credit_entries,
+        :credit_amount,
+        :transactions
+
+      def initialize(attributes = EMPTY_ATTRIBUTES)
+        @bank_code,
+        @branch_code,
+        @account_number,
+        @start_date,
+        @end_date,
+        @balance_code,
+        @balance_amount,
+        @currency_code,
+        @information_mode_code,
+        @abbreviated_name,
+        @debit_entries,
+        @debit_amount,
+        @credit_entries,
+        @credit_amount,
+        transactions = Hash(attributes).values_at(
+          :bank_code,
+          :branch_code,
+          :account_number,
+          :start_date,
+          :end_date,
+          :balance_code,
+          :balance_amount,
+          :currency_code,
+          :information_mode_code,
+          :abbreviated_name,
+          :debit_entries,
+          :debit_amount,
+          :credit_entries,
+          :credit_amount,
+          :transactions)
+        @transactions = Array(transactions).map { |attrs| Transaction.new(attrs) }
+      end
+
+      def iban
+        SpanishIban.from_account(self)
+      end
+    end
+  end
+end

data/lib/norma43/models/additional_currency.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Norma43
+  module Models
+    class AdditionalCurrency
+      include Mixins::AttributesAssignment
+
+      attr_accessor :data_code, :currency_code, :amount, :free
+
+      def initialize(attributes = EMPTY_ATTRIBUTES)
+        @data_code,
+        @currency_code,
+        @amount,
+        @free = Hash(attributes).values_at(
+          :data_code,
+          :currency_code,
+          :amount,
+          :free)
+      end
+    end
+  end
+end

data/lib/norma43/models/additional_item.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Norma43
+  module Models
+    class AdditionalItem
+      include Mixins::AttributesAssignment
+
+      attr_accessor :data_code, :item_1, :item_2
+
+      def initialize(attributes = EMPTY_ATTRIBUTES)
+        @data_code,
+        @item_1,
+        @item_2 = Hash(attributes).values_at(
+          :data_code,
+          :item_1,
+          :item_2)
+      end
+    end
+  end
+end

data/lib/norma43/models/document.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Norma43
+  module Models
+    class Document
+      include Mixins::AttributesAssignment
+
+      attr_accessor :id, :created_at, :delivery_number, :file_type, :name, :number_of_lines, :accounts
+
+      def initialize(attributes = EMPTY_ATTRIBUTES)
+        @id,
+        @created_at,
+        @delivery_number,
+        @file_type,
+        @name,
+        @number_of_lines,
+        accounts = Hash(attributes).values_at(
+          :id,
+          :created_at,
+          :delivery_number,
+          :file_type,
+          :name,
+          :number_of_lines,
+          :accounts)
+        @accounts = Array(accounts).map { |account| Account.new(account) }
+      end
+
+      # @deprecated Please ask each transaction inside accounts for their transaction_date instead
+      def transaction_date
+        warn "[DEPRECATION] `transaction_date` is deprecated, use `#transaction_date` from transactions in `#accounts` instead"
+        date = nil
+
+        accounts.flat_map(&:transactions).each { |transaction|
+          date = transaction&.transaction_date
+          break unless date.nil?
+        }
+
+        date
+      end
+    end
+  end
+end

data/lib/norma43/models/mixins/attributes_assignment.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Norma43
+  module Models
+    module Mixins
+      module AttributesAssignment
+        EMPTY_ATTRIBUTES = {}.freeze
+
+        def attributes=(new_attributes)
+          Hash(new_attributes).each do |attr_name, attr_value|
+            attr_writer_method_name = "#{attr_name}=".to_sym
+            next unless public_methods(false).include?(attr_writer_method_name)
+
+            public_send(attr_writer_method_name, attr_value)
+          end
+        end
+
+        def attributes
+          instance_variables.map { |ivar_name|
+            attr_reader_method_name = ivar_name.to_s.delete_prefix("@").to_sym
+            next unless public_methods(false).include?(attr_reader_method_name)
+
+            attr_value = public_send(attr_reader_method_name)
+
+            [attr_reader_method_name, attr_value]
+          }.compact.to_h
+        end
+        alias_method :to_hash, :attributes # Implicit coercion for `Hash(model)`
+        alias_method :to_h,    :attributes # Explicit coercion
+      end
+    end
+  end
+end

data/lib/norma43/models/transaction.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Norma43
+  module Models
+    class Transaction
+      include Mixins::AttributesAssignment
+
+      attr_accessor :origin_branch_code,
+        :transaction_date,
+        :value_date,
+        :shared_item,
+        :own_item,
+        :amount_code,
+        :amount,
+        :document_number,
+        :reference_1,
+        :reference_2,
+        :additional_items,
+        :additional_currency
+
+      def initialize(attributes = EMPTY_ATTRIBUTES)
+        @origin_branch_code,
+        @transaction_date,
+        @value_date,
+        @shared_item,
+        @own_item,
+        @amount_code,
+        @amount,
+        @document_number,
+        @reference_1,
+        @reference_2,
+        additional_items,
+        additional_currency = Hash(attributes).values_at(
+          :origin_branch_code,
+          :transaction_date,
+          :value_date,
+          :shared_item,
+          :own_item,
+          :amount_code,
+          :amount,
+          :document_number,
+          :reference_1,
+          :reference_2)
+        @additional_items = Array(additional_items).map { |attrs| AdditionalItem.new(attrs) }
+        @additional_currency = AdditionalCurrency.new(additional_currency) if additional_currency
+      end
+
+      def debit?; self.amount_code == DEBIT_CODE end
+    end
+  end
+end