bai2_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0b1d37b3e9c9ca7581b62b7cd7925d3366b570e45012bee9284ec59d44c6903
+  data.tar.gz: 6e6dc98eb2a9a0f394ad54143f2591140dc31152094a02df76f2f7270750ffe3
+SHA512:
+  metadata.gz: 883269f713bd6d7036fa287b0c0c27f606638030193690f15cc94966595bd70cc4c47a96120ea50ddd1293c49ba5e9eda60822017303edaccc5aeb7b2629fc4a
+  data.tar.gz: dbef20c4a3ecd2a554c127ca27981ace0a45449fd793619a398a839e28b4e3f7fc7e8d99fbe817894c43aa0d122f1e0f1a3dbe3572f55f636a2104b54149676d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,36 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.0
+  Exclude:
+    - 'bai2_ruby.gemspec'
+
+Layout/LineLength:
+  Exclude:
+    - 'lib/bai2_ruby/writer.rb'
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ParameterLists:
+  Exclude:
+    - 'lib/bai2_ruby/structures/**/*.rb'
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-08-12
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 dpaluy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+# BAI2 Ruby
+
+BAI2 - Bank Administration Institute 2 file format
+
+BAI2 Ruby is a gem that provides a parser and writer for the BAI2 (Bank Administration Institute) file format. This gem allows you to easily read and write BAI2 files in your Ruby applications.
+
+## Features
+
+- Parse BAI2 files into Ruby objects
+- Generate BAI2 files from Ruby objects
+- Supports all standard BAI2 record types
+- Handles date and time parsing with configurable time zones
+
+## Installation
+
+`gem "bai2_ruby"`
+
+## Usage
+
+### Parsing a BAI2 file
+
+```ruby
+require 'bai2_ruby'
+
+# Read the content of a BAI2 file
+bai2_content = File.read('path/to/your/bai2_file.bai')
+
+# Create a parser instance
+parser = BAI2::Parser.new(bai2_content)
+
+# Parse the content
+bai2_file = parser.parse
+
+# Access the parsed data
+puts bai2_file.header.sender_id
+puts bai2_file.header.file_creation_date
+
+bai2_file.groups.each do |group|
+  puts group.header.originator_id
+  group.accounts.each do |account|
+    puts account.header.customer_account_number
+    account.transactions.each do |transaction|
+      puts "#{transaction.type}: #{transaction.amount}"
+    end
+  end
+end
+```
+
+### Writing a BAI2 file
+
+```ruby
+require 'bai2_ruby'
+
+# Create BAI2 structures
+file_header = BAI2::Structures::FileHeader.new(
+  sender_id: 'SENDER1',
+  receiver_id: 'RECEIVER1',
+  file_creation_date: Date.today,
+  file_creation_time: Time.now,
+  file_id: '123456',
+  physical_record_length: 80,
+  block_size: 0,
+  version_number: '2'
+)
+
+# ... Create other structures (groups, accounts, transactions) ...
+
+# Create a BAI2::File object
+bai2_file = BAI2::File.new(file_header, groups, file_trailer)
+
+# Create a writer instance
+writer = BAI2::Writer.new(bai2_file)
+
+# Generate BAI2 content
+bai2_content = writer.generate
+
+# Write to a file
+File.write('path/to/output.bai', bai2_content)
+```
+
+### Configuration
+
+By default, the parser uses UTC for time parsing. You can specify a different time zone when creating a parser:
+
+```ruby
+parser = BAI2::Parser.new(bai2_content, time_zone: "-05:00")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dpaluy/bai2_ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/bai2_ruby/account.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module BAI2
+  class Account
+    attr_reader :header, :transactions, :trailer
+
+    def initialize(header, transactions, trailer = nil)
+      @header = header
+      @transactions = transactions
+      @trailer = trailer
+    end
+
+    def set_trailer(trailer)
+      raise BAI2::Error, "Trailer has already been set" if @trailer
+
+      @trailer = trailer
+    end
+
+    def total_credits
+      transactions.select(&:credit?).sum(&:amount)
+    end
+
+    def total_debits
+      transactions.select(&:debit?).sum(&:amount)
+    end
+
+    def net_total
+      transactions.sum(&:signed_amount)
+    end
+  end
+end

data/lib/bai2_ruby/file.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module BAI2
+  class File
+    attr_reader :header, :groups, :trailer
+
+    def initialize(header, groups, trailer)
+      @header = header
+      @groups = groups
+      @trailer = trailer
+    end
+
+    def total_credits
+      groups.sum(&:total_credits)
+    end
+
+    def total_debits
+      groups.sum(&:total_debits)
+    end
+
+    def net_total
+      groups.sum(&:net_total)
+    end
+
+    def all_transactions
+      groups.flat_map { |group| group.accounts.flat_map(&:transactions) }
+    end
+  end
+end

data/lib/bai2_ruby/group.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module BAI2
+  class Group
+    attr_reader :header, :accounts, :trailer
+
+    def initialize(header, accounts, trailer = nil)
+      @header = header
+      @accounts = accounts
+      @trailer = trailer
+    end
+
+    def set_trailer(trailer)
+      raise BAI2::Error, "Trailer has already been set" if @trailer
+
+      @trailer = trailer
+    end
+
+    def total_credits
+      accounts.sum(&:total_credits)
+    end
+
+    def total_debits
+      accounts.sum(&:total_debits)
+    end
+
+    def net_total
+      accounts.sum(&:net_total)
+    end
+  end
+end

data/lib/bai2_ruby/parser.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module BAI2
+  class Parser
+    def initialize(content, time_zone: "+00:00")
+      @lines = content.split("\n")
+      @current_group = nil
+      @current_account = nil
+      @time_zone = time_zone
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
+    def parse
+      file_header = parse_file_header(@lines.shift)
+      file_trailer = parse_file_trailer(@lines.pop)
+
+      groups = []
+
+      @lines.each do |line|
+        record_code = line[0, 2]
+        case record_code
+        when "02"
+          @current_group = parse_group_header(line)
+          groups << @current_group
+        when "03"
+          @current_account = parse_account_header(line)
+          @current_group.accounts << @current_account
+        when "16"
+          transaction = parse_transaction(line)
+          @current_account.transactions << transaction
+        when "49"
+          parse_account_trailer(line)
+        when "98"
+          parse_group_trailer(line)
+        else
+          raise BAI2::Error, "Unknown record code: #{record_code}"
+        end
+      end
+
+      BAI2::File.new(file_header, groups, file_trailer)
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+
+    private
+
+    def parse_file_header(line)
+      fields = line.split(",")
+      date = parse_date(fields[3])
+      BAI2::Structures::FileHeader.new(
+        sender_id: fields[1],
+        receiver_id: fields[2],
+        file_creation_date: date,
+        file_creation_time: parse_time(fields[4], date),
+        file_id: fields[5],
+        physical_record_length: fields[6].to_i,
+        block_size: fields[7].to_i,
+        version_number: fields[8]
+      )
+    end
+
+    def parse_file_trailer(line)
+      fields = line.split(",")
+      BAI2::Structures::FileTrailer.new(
+        file_control_total: fields[1].to_f,
+        number_of_groups: fields[2].to_i,
+        number_of_records: fields[3].to_i
+      )
+    end
+
+    def parse_group_header(line)
+      fields = line.split(",")
+      date = parse_date(fields[4])
+      header = BAI2::Structures::GroupHeader.new(
+        ultimate_receiver_id: fields[1],
+        originator_id: fields[2],
+        group_status: fields[3],
+        as_of_date: date,
+        as_of_time: parse_time(fields[5], date),
+        currency_code: fields[6],
+        as_of_date_modifier: fields[7]
+      )
+      BAI2::Group.new(header, [])
+    end
+
+    def parse_account_header(line)
+      fields = line.split(",")
+      header = BAI2::Structures::AccountHeader.new(
+        customer_account_number: fields[1],
+        currency_code: fields[2],
+        type_code: fields[3]
+      )
+      BAI2::Account.new(header, [])
+    end
+
+    def parse_transaction(line)
+      fields = line.split(",")
+      BAI2::Transaction.new(fields[1], fields[2].to_f, fields[3])
+    end
+
+    def parse_account_trailer(line)
+      fields = line.split(",")
+      trailer = BAI2::Structures::AccountTrailer.new(
+        account_control_total: fields[1].to_f,
+        number_of_records: fields[2].to_i
+      )
+      @current_account.set_trailer(trailer)
+    end
+
+    def parse_group_trailer(line)
+      fields = line.split(",")
+      trailer = BAI2::Structures::GroupTrailer.new(
+        group_control_total: fields[1].to_f,
+        number_of_accounts: fields[2].to_i,
+        number_of_records: fields[3].to_i
+      )
+      @current_group.set_trailer(trailer)
+    end
+
+    def parse_date(date_string)
+      Date.strptime(date_string, "%y%m%d")
+    end
+
+    def parse_time(time_string, date)
+      hours = time_string[0, 2].to_i
+      minutes = time_string[2, 2].to_i
+      Time.new(date.year, date.month, date.day, hours, minutes, 0, @time_zone)
+    end
+  end
+end

data/lib/bai2_ruby/structures/account_header.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module BAI2
+  module Structures
+    class AccountHeader
+      attr_reader :customer_account_number, :currency_code, :type_code
+
+      def initialize(customer_account_number:, currency_code:, type_code:)
+        @customer_account_number = customer_account_number
+        @currency_code = currency_code
+        @type_code = type_code
+      end
+    end
+  end
+end

data/lib/bai2_ruby/structures/account_trailer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module BAI2
+  module Structures
+    class AccountTrailer
+      attr_reader :account_control_total, :number_of_records
+
+      def initialize(account_control_total:, number_of_records:)
+        @account_control_total = account_control_total
+        @number_of_records = number_of_records
+      end
+    end
+  end
+end

data/lib/bai2_ruby/structures/file_header.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BAI2
+  module Structures
+    class FileHeader
+      attr_reader :sender_id, :receiver_id, :file_creation_date, :file_creation_time,
+                  :file_id, :physical_record_length, :block_size, :version_number
+
+      def initialize(sender_id:, receiver_id:, file_creation_date:, file_creation_time:,
+                     file_id:, physical_record_length:, block_size:, version_number:)
+        @sender_id = sender_id
+        @receiver_id = receiver_id
+        @file_creation_date = file_creation_date
+        @file_creation_time = file_creation_time
+        @file_id = file_id
+        @physical_record_length = physical_record_length
+        @block_size = block_size
+        @version_number = version_number
+      end
+    end
+  end
+end

data/lib/bai2_ruby/structures/file_trailer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module BAI2
+  module Structures
+    class FileTrailer
+      attr_reader :file_control_total, :number_of_groups, :number_of_records
+
+      def initialize(file_control_total:, number_of_groups:, number_of_records:)
+        @file_control_total = file_control_total
+        @number_of_groups = number_of_groups
+        @number_of_records = number_of_records
+      end
+    end
+  end
+end

data/lib/bai2_ruby/structures/group_header.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BAI2
+  module Structures
+    class GroupHeader
+      attr_reader :ultimate_receiver_id, :originator_id, :group_status, :as_of_date,
+                  :as_of_time, :currency_code, :as_of_date_modifier
+
+      def initialize(ultimate_receiver_id:, originator_id:, group_status:, as_of_date:,
+                     as_of_time:, currency_code:, as_of_date_modifier:)
+        @ultimate_receiver_id = ultimate_receiver_id
+        @originator_id = originator_id
+        @group_status = group_status
+        @as_of_date = as_of_date
+        @as_of_time = as_of_time
+        @currency_code = currency_code
+        @as_of_date_modifier = as_of_date_modifier
+      end
+    end
+  end
+end

data/lib/bai2_ruby/structures/group_trailer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module BAI2
+  module Structures
+    class GroupTrailer
+      attr_reader :group_control_total, :number_of_accounts, :number_of_records
+
+      def initialize(group_control_total:, number_of_accounts:, number_of_records:)
+        @group_control_total = group_control_total
+        @number_of_accounts = number_of_accounts
+        @number_of_records = number_of_records
+      end
+    end
+  end
+end

data/lib/bai2_ruby/structures/transaction.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BAI2
+  module Structures
+    class Transaction
+      attr_reader :type, :amount, :funds_type, :availability, :bank_reference, :customer_reference, :text
+
+      def initialize(type:, amount:, funds_type:, availability:, bank_reference:, customer_reference:, text:)
+        @type = type
+        @amount = amount
+        @funds_type = funds_type
+        @availability = availability
+        @bank_reference = bank_reference
+        @customer_reference = customer_reference
+        @text = text
+      end
+    end
+  end
+end

data/lib/bai2_ruby/transaction.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module BAI2
+  class Transaction
+    attr_reader :type, :amount, :text, :funds_type
+
+    CREDIT_CODES = %w[105 106 107 108 109 110 115 116 118 201 202 206 207 210 221 222 223 224 225 226 227 230 231 263
+                      285 415 416 420 490 600 601 616 618 621 623 632 633 634 664 701 702 703 705 706 707 708 709 710
+                      711 712 713 714 715 716 717 805 902].freeze
+    DEBIT_CODES = %w[175 176 177 178 179 180 181 185 186 187 188 277 278 405 406 407 408 410 412 413 414 425 465 469
+                     470 471 472 477 481 482 484 485 486 487 489 500 501 502 505 506 507 508 509 510 512 513 514 516
+                     518 519 522 532 535 536 554 555 556 557 558 560 561 564 566 570 702 703 709 715 720 890].freeze
+
+    def initialize(type, amount, text, funds_type = nil)
+      @type = type
+      @amount = amount.to_f
+      @text = text
+      @funds_type = funds_type
+    end
+
+    def debit?
+      DEBIT_CODES.include?(@type)
+    end
+
+    def credit?
+      CREDIT_CODES.include?(@type)
+    end
+
+    def signed_amount
+      debit? ? -@amount : @amount
+    end
+
+    # rubocop:disable Style/FormatString
+    def to_s
+      "#{credit? ? "Credit" : "Debit"} transaction (#{@type}): $#{"%.2f" % @amount.abs} - #{@text}"
+    end
+    # rubocop:enable Style/FormatString
+
+    def as_json
+      {
+        type: @type,
+        amount: @amount,
+        signed_amount: signed_amount,
+        text: @text,
+        is_debit: debit?,
+        is_credit: credit?
+      }
+    end
+  end
+end

data/lib/bai2_ruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BAI2
+  VERSION = "0.1.0"
+end

data/lib/bai2_ruby/writer.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module BAI2
+  class Writer
+    def initialize(file)
+      @file = file
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def generate
+      content = []
+      content << generate_file_header(@file.header)
+
+      @file.groups.each do |group|
+        content << generate_group_header(group.header)
+
+        group.accounts.each do |account|
+          content << generate_account_header(account.header)
+
+          account.transactions.each do |transaction|
+            content << generate_transaction(transaction)
+          end
+
+          content << generate_account_trailer(account.trailer)
+        end
+
+        content << generate_group_trailer(group.trailer)
+      end
+
+      content << generate_file_trailer(@file.trailer)
+      content.join("\n")
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    private
+
+    def generate_file_header(header)
+      "01,#{header.sender_id},#{header.receiver_id},#{format_date(header.file_creation_date)},#{format_time(header.file_creation_time)},#{header.file_id},#{header.physical_record_length},#{header.block_size},#{header.version_number}"
+    end
+
+    def generate_group_header(header)
+      "02,#{header.ultimate_receiver_id},#{header.originator_id},#{header.group_status},#{format_date(header.as_of_date)},#{format_time(header.as_of_time)},#{header.currency_code},#{header.as_of_date_modifier}"
+    end
+
+    def generate_account_header(header)
+      "03,#{header.customer_account_number},#{header.currency_code},#{header.type_code}"
+    end
+
+    def generate_transaction(transaction)
+      "16,#{transaction.type},#{format_amount(transaction.amount)},#{transaction.text}"
+    end
+
+    def generate_account_trailer(trailer)
+      "49,#{format_amount(trailer.account_control_total)},#{trailer.number_of_records}"
+    end
+
+    def generate_group_trailer(trailer)
+      "98,#{format_amount(trailer.group_control_total)},#{trailer.number_of_accounts},#{trailer.number_of_records}"
+    end
+
+    def generate_file_trailer(trailer)
+      "99,#{format_amount(trailer.file_control_total)},#{trailer.number_of_groups},#{trailer.number_of_records}"
+    end
+
+    def format_date(date)
+      date.strftime("%y%m%d")
+    end
+
+    def format_time(time)
+      time.strftime("%H%M")
+    end
+
+    def format_amount(amount)
+      format("%.2f", amount)
+    end
+  end
+end

data/lib/bai2_ruby.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "date"
+require "time"
+require_relative "bai2_ruby/version"
+require_relative "bai2_ruby/structures/file_header"
+require_relative "bai2_ruby/structures/file_trailer"
+require_relative "bai2_ruby/structures/group_header"
+require_relative "bai2_ruby/structures/group_trailer"
+require_relative "bai2_ruby/structures/account_header"
+require_relative "bai2_ruby/structures/account_trailer"
+require_relative "bai2_ruby/structures/transaction"
+require_relative "bai2_ruby/parser"
+require_relative "bai2_ruby/writer"
+require_relative "bai2_ruby/file"
+require_relative "bai2_ruby/group"
+require_relative "bai2_ruby/account"
+require_relative "bai2_ruby/transaction"
+
+module BAI2
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/bai2_ruby.rbs

@@ -0,0 +1,4 @@
+module Bai2Ruby
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: bai2_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dpaluy
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-12 00:00:00.000000000 Z
+dependencies: []
+description: Bank Administration Institute 2 (BAI2) file format implementation wrapper
+  for Ruby
+email:
+- dpaluy@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/bai2_ruby.rb
+- lib/bai2_ruby/account.rb
+- lib/bai2_ruby/file.rb
+- lib/bai2_ruby/group.rb
+- lib/bai2_ruby/parser.rb
+- lib/bai2_ruby/structures/account_header.rb
+- lib/bai2_ruby/structures/account_trailer.rb
+- lib/bai2_ruby/structures/file_header.rb
+- lib/bai2_ruby/structures/file_trailer.rb
+- lib/bai2_ruby/structures/group_header.rb
+- lib/bai2_ruby/structures/group_trailer.rb
+- lib/bai2_ruby/structures/transaction.rb
+- lib/bai2_ruby/transaction.rb
+- lib/bai2_ruby/version.rb
+- lib/bai2_ruby/writer.rb
+- sig/bai2_ruby.rbs
+homepage: https://github.com/dpaluy/bai2_ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.18
+signing_key:
+specification_version: 4
+summary: BAI2 implementation wrapper for Ruby
+test_files: []