coda_standard 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4736e6a722c4f15a13d9ca03d58d0aee055173a4
-  data.tar.gz: 326312b1f946d0946fa6fae52b8b2285f037cf96
+  metadata.gz: c747a72bd151e0741c2f0652934829fbc1414563
+  data.tar.gz: 8ff61da7a6ff285449b50983284063aecebc14f5
 SHA512:
-  metadata.gz: c1eda00743d3e70d3ce79fa2781067bb81c20b3b236f84f1a0465f4dcad8a3665bed5e0bf08971c527a0c3f95382d766ad0c51a6867345d2bbe7ff962a164eed
-  data.tar.gz: f72454d377adacc424be90df42cd8107058138ecf46d15ed0254453c59034f35e1c9d47b00fe7b14c6d7fcc769688d73f39359efe97ba713a0f84f74f60ce5f9
+  metadata.gz: 0dbd5e47ecc16eae6426567c7dd1ce4e28d21f893b6dd5c9ba65c43ec1308b89516f9c5cc27ae6554a60fc32c268d0f4a6a7506d2230dc12794f7aa3342909c3
+  data.tar.gz: 18c23f3a27786da2289c6e888a4b0ff93605089ba45181bfa71349c29546b1241475a00ceb45eda2d7bc9e38c1037dd7f35d7e3314be8bb9c8206b5295d26c1d

data/README.md

@@ -1,42 +1,41 @@
-# coda_standard Gem
+# coda_standard
 
-This gem parses the Coded statement of account (CODA) bank standard.
-## Installation
+This gem parses the [Coded statement of account](https://www.febelfin.be/sites/default/files/files/Standard-CODA-22-EN.pdf) (CODA) bank standard used by some  banks and follows version 2.2 of this standard.
 
-Add this line to your application's Gemfile:
+> This bank standard specifies the lay-out for the electronic files, by banks to customers, of the account transactions and the information concerning the enclosures in connection with the movement. 
 
-```ruby
-gem 'coda_standard'
-```
-
-And then execute:
+The coda_standard gem requires Ruby version ~> 2.0. 
 
-    $ bundle
-
-Or install it yourself as:
+## Install
 
     $ gem install coda_standard
 
-## Usage
-
-    $ CodaStandard::Parser.new.parse(filename)
+or add the following line to Gemfile:
 
-Returns an TransactionList object
+```
+gem 'coda_standard'
+```
 
-    $ CodaStandard::Parser.new.parse(filename).transactions
+and run `bundle install` from your shell.
 
-Returns an array of transactions
+## Usage
 
-    $ CodaStandard::Parser.new.parse(filename).current_bic => "GEBABEBB"
+```ruby
+# a new TransactionList object:
+CodaStandard::Parser.new(filename).parse
 
-You can get different common data from the TransactionList (current_bic, old_balance, current_account, current_account_type)
+# or an array of transactions:
+CodaStandard::Parser.new(filename).parse.transactions
 
-    $ CodaStandard::Parser.new.show(filename)
+# or maybe the BIC:
+CodaStandard::Parser.new(filename).parse.current_bic => "GEBABEBB"
+# also available are: old_balance, current_account, current_account_type
 
-Shows the transactions info in the terminal
+# or print a more readable represenation of the file
+CodaStandard::Parser.new(filename).show
+```
 
-The info you can get from each transaction is:
-  name, currency, bic, address, postcode, city, country, amount, account, entry_date, reference_number and transaction_number
+The available getters for each transaction are: `name`, `currency`, `bic`, `address`, `postcode`, `city`, `country`, `amount`, `account`, `entry_date`, `reference_number` and `transaction_number`.
 
 ## Contributing
 
@@ -46,4 +45,6 @@ The info you can get from each transaction is:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
-=======
+## License
+
+coda_standard is Copyright © 2015 Alvaro Leal. It is free software, and may be redistributed under the terms specified in the [LICENSE](LICENSE) file.

data/lib/coda_standard/line.rb

@@ -2,31 +2,33 @@ module CodaStandard
   class Line
     attr_reader :line
 
+    FIELDS = {
+      current_bic: /^0.{59}(.{11})/,
+      current_account: /^1(.{41})/,
+      name: /^23.{45}(.{35})/,
+      currency: /^23.{42}(.{3})/,
+      entry_date: /^21.{113}(\d{6})/,
+      reference_number: /^21.{8}(.{21})/,
+      address: /^32.{8}(.{105})/,
+      account: /^23\d{8}(\w+)\D/,
+      bic: /^22.{96}(.{11})/,
+      amount: /^21\d+\s+(\d{16})/,
+      old_balance: /^1.{41}(\d)(\d{15})/,
+      sep_address: /(^.+)(\d{4})\s(\S+)(\s\S+)?$/,
+      sep_account: /(^.)(.{3})(.+)/,
+      bban_be_account: /(^.{12})/,
+      bban_foreign_account: /(^.{34})/,
+      iban_be_account: /(^.{31})/,
+      iban_foreign_account: /(^.{34})/,
+      transaction_number: /^21.{60}(.{15})/,
+      clean_structured: /.{3}(.{12})/,
+      currencies: /(^.+)(AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUC|CUP|CVE|CZK|DJF|DKK|DOP|DZD|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|SSP|STD|SVC|SYP|SZL|THB|TJS|TMT|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFU|XOF|XPD|XPF|XPT|XSU|XTS|XUA|XXX|YER|ZAR|ZMW|ZWL)/
+    }
+
+    CLEAN_ZEROS_REGEX = /0*([^0]\d+)(\d{3})/
+
     def initialize(line)
       @line = line
-      @regexp = {
-        current_bic: /^0.{59}(.{11})/,
-        current_account: /^1(.{41})/,
-        name: /^23.{45}(.{35})/,
-        currency: /^23.{42}(.{3})/,
-        entry_date: /^21.{113}(\d{6})/,
-        reference_number: /^21.{8}(.{21})/,
-        address: /^32.{8}(.{105})/,
-        account: /^23\d{8}(\w+)\D/,
-        bic: /^22.{96}(.{11})/,
-        amount: /^21\d+\s+(\d{16})/,
-        old_balance: /^1.{41}(\d)(\d{15})/,
-        clean_zeros: /0*([^0]\d+)(\d{3})/,
-        sep_address: /(^.+)(\d{4})\s(\S+)(\s\S+)?$/,
-        sep_account: /(^.)(.{3})(.+)/,
-        bban_be_account: /(^.{12})/,
-        bban_foreign_account: /(^.{34})/,
-        iban_be_account: /(^.{31})/,
-        iban_foreign_account: /(^.{34})/,
-        transaction_number: /^21.{60}(.{15})/,
-        clean_structured: /.{3}(.{12})/,
-        currencies:/(^.+)(AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYR|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUC|CUP|CVE|CZK|DJF|DKK|DOP|DZD|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LTL|LVL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRO|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|SSP|STD|SVC|SYP|SZL|THB|TJS|TMT|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|USS|UYI|UYU|UZS|VEF|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XFU|XOF|XPD|XPF|XPT|XSU|XTS|XUA|XXX|YER|ZAR|ZMW|ZWL)/
-      }
     end
 
     def current_bic
@@ -80,7 +82,7 @@ module CodaStandard
     private
 
     def extract(field)
-      result = @line.scan(@regexp[field]).join.strip
+      result = @line.scan(FIELDS[field]).join.strip
       case field
         when :address
           result = separate_address(result)
@@ -95,39 +97,37 @@ module CodaStandard
     end
 
     def separate_address(address)
-      address_fields = address.scan(@regexp[:sep_address])[0]
+      address_fields = address.scan(FIELDS[:sep_address])[0]
       {address: address_fields[0].strip, postcode: address_fields[1], city: address_fields[2], country: address_fields[3]}
     end
 
     def clean_account(account)
-      account_type = account.scan(@regexp[:sep_account])[0][0]
-      # sequence_number = account.scan(@regexp[:sep_account])[0][1]
-      raw_account = account.scan(@regexp[:sep_account])[0][2]
+      account_type = account.scan(FIELDS[:sep_account])[0][0]
+      raw_account = account.scan(FIELDS[:sep_account])[0][2]
       case account_type
         when "0" then account_type = "bban_be_account"
         when "1" then account_type = "bban_foreign_account"
         when "2" then account_type = "iban_be_account"
         when "3" then account_type = "iban_foreign_account"
       end
-      account_number = raw_account.scan(@regexp[account_type.to_sym]).join
+      account_number = raw_account.scan(FIELDS[account_type.to_sym]).join
       {account_type: account_type, account_number: account_number}
     end
 
     def clean_zeros(amount)
       amount[0] == "0" ? amount_sign = "" : amount_sign = "-"
-      amount_integral = amount.scan(@regexp[:clean_zeros])[0][0]
-      amount_decimals = amount.scan(@regexp[:clean_zeros])[0][1]
+      amount_integral = amount.scan(CLEAN_ZEROS_REGEX)[0][0]
+      amount_decimals = amount.scan(CLEAN_ZEROS_REGEX)[0][1]
       separator = ","
       amount_sign + amount_integral + separator + amount_decimals
     end
 
     def check_structured(number)
       if number[0] == "1"
-        structured = true
-        number.scan(@regexp[:clean_structured]).join
+        number.scan(FIELDS[:clean_structured]).join
       else
         "not structured"
       end
     end
   end
-end
+end

data/lib/coda_standard/parser.rb

@@ -1,53 +1,55 @@
 module CodaStandard
   class Parser
     attr_reader :transactions, :old_balance, :current_bic, :current_account, :current_transaction
-    def initialize
-      @transactions = TransactionList.new
+
+    def initialize(filename)
+      @filename            = filename
+      @transactions        = TransactionList.new
       @current_transaction = Transaction.new
     end
 
-    def parse(file_name)
-      file = File.open( file_name ).each do |row|
-      line = Line.new(row)
-      case
-        when line.line =~ /^0/
-          @transactions.current_bic = line.current_bic
-        when line.line =~ /^1/
-          set_account(line.current_account)
-          @transactions.old_balance = line.old_balance
-        when line.line =~ /^21/
-          @current_transaction = @transactions.create
-          @current_transaction.entry_date = line.entry_date
-          @current_transaction.reference_number = line.reference_number
-          @current_transaction.amount = line.amount
-          @current_transaction.transaction_number = line.transaction_number
-        when line.line =~ /^22/
-          @current_transaction.bic = line.bic
-        when line.line =~ /^23/
-          @current_transaction.currency = line.currency
-          @current_transaction.name = line.name
-          @current_transaction.account = line.account
-        when line.line =~ /^32/
-          set_address(line.address)
+    def parse
+      File.open(@filename).each do |row|
+        line = Line.new(row)
+        case
+          when line.line =~ /^0/
+            @transactions.current_bic = line.current_bic
+          when line.line =~ /^1/
+            set_account(line.current_account)
+            @transactions.old_balance = line.old_balance
+          when line.line =~ /^21/
+            @current_transaction = @transactions.create
+            @current_transaction.entry_date         = line.entry_date
+            @current_transaction.reference_number   = line.reference_number
+            @current_transaction.amount             = line.amount
+            @current_transaction.transaction_number = line.transaction_number
+          when line.line =~ /^22/
+            @current_transaction.bic = line.bic
+          when line.line =~ /^23/
+            @current_transaction.currency = line.currency
+            @current_transaction.name     = line.name
+            @current_transaction.account  = line.account
+          when line.line =~ /^32/
+            set_address(line.address)
         end
       end
       @transactions
     end
 
     def set_address(address)
-      @current_transaction.address = address[:address]
+      @current_transaction.address  = address[:address]
       @current_transaction.postcode = address[:postcode]
-      @current_transaction.city = address[:city]
-      @current_transaction.country = address[:country]
+      @current_transaction.city     = address[:city]
+      @current_transaction.country  = address[:country]
     end
 
     def set_account(account)
-      @transactions.current_account = account[:account_number]
+      @transactions.current_account      = account[:account_number]
       @transactions.current_account_type = account[:account_type]
     end
 
-    def show(file_name)
-      parse(file_name)
+    def show
+      parse
       puts "**--Transactions--**\n\n"
       puts "Account: #{@transactions.current_account} Account type: #{@transactions.current_account_type} BIC: #{@transactions.current_bic}"
       puts "Old balance: #{@transactions.old_balance} \n\n"
@@ -60,4 +62,4 @@ module CodaStandard
       end
     end
   end
-end
+end

data/lib/coda_standard/version.rb

@@ -1,3 +1,3 @@
 module CodaStandard
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/coda_standard.rb

@@ -3,5 +3,6 @@ require "coda_standard/parser"
 require "coda_standard/transaction"
 require "coda_standard/transaction_list"
 require "coda_standard/line"
+
 module CodaStandard
 end

data/spec/parser_spec.rb

@@ -3,9 +3,8 @@ require_relative 'spec_helper'
 describe CodaStandard::Parser do
 
   before :each do
-    @file_name = 'spec/coda.cod'
-    @file = File.open( @file_name )
-    @parser = CodaStandard::Parser.new
+    filename = 'spec/coda.cod'
+    @parser = CodaStandard::Parser.new(filename)
   end
 
   describe "initialize" do
@@ -16,10 +15,11 @@ describe CodaStandard::Parser do
 
   describe "parse" do
     before :each do
-      @parser.parse(@file_name)
+      @parser.parse
     end
+
     it "returns a Transactions object" do
-        expect(@parser.parse(@file_name)).to be_a(CodaStandard::TransactionList)
+        expect(@parser.parse).to be_a(CodaStandard::TransactionList)
     end
   end
 
@@ -63,7 +63,8 @@ describe CodaStandard::Parser do
 
   describe "show" do
     it "shows the info from the transactions" do
-      expect{@parser.show(@file_name)}.to output("**--Transactions--**\n\nAccount: 539007547034 Account type: bban_be_account BIC: GEBABEBB\nOld balance: 57900,000 \n\n-- Transaction n.1 - number 100000834941 - in date 310315-- \n\n   RN: 0001500000103 Account: BE53900754703405 BIC:GKCCBEBB\n   Amount: 500,000 EUR\n   Name: LASTNM PERSON\n   Address: CHAUSSEE DE BIERE 10 1978 SOMECITY  \n\n-- Transaction n.2 - number 100000835749 - in date 310315-- \n\n   RN: 0001500000104 Account: LU539007547034898400 BIC:BILLLULL\n   Amount: 200,000 EUR\n   Name: M.JOHN DOE\n   Address: 5 STREET 3654 CITY  BELGIQUE \n\n").to_stdout
+      expect{@parser.show}.to output("**--Transactions--**\n\nAccount: 539007547034 Account type: bban_be_account BIC: GEBABEBB\nOld balance: 57900,000 \n\n-- Transaction n.1 - number 100000834941 - in date 310315-- \n\n   RN: 0001500000103 Account: BE53900754703405 BIC:GKCCBEBB\n   Amount: 500,000 EUR\n   Name: LASTNM PERSON\n   Address: CHAUSSEE DE BIERE 10 1978 SOMECITY  \n\n-- Transaction n.2 - number 100000835749 - in date 310315-- \n\n   RN: 0001500000104 Account: LU539007547034898400 BIC:BILLLULL\n   Amount: 200,000 EUR\n   Name: M.JOHN DOE\n   Address: 5 STREET 3654 CITY  BELGIQUE \n\n").to_stdout
     end
   end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coda_standard
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Alvaro Leal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-13 00:00:00.000000000 Z
+date: 2015-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler