bank_statement_parser 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e74b252e6d34c2c9c5cf38c3c83fa7311346377
-  data.tar.gz: 6b08682abafbf2a6408174c78d7794014a61aebf
+  metadata.gz: 89a85ada90812b38dbb5aff866c06861ce838fb4
+  data.tar.gz: 6abce3b54e55d0838796fbb3da3d4f45766687b0
 SHA512:
-  metadata.gz: b08d15003a8aef7270479d43dab7697103075467e4c0d9a9778ecb08e3a24756ef93a14f57cfb49e09097d381a6717ba520840ca266407c3564d922c45898e0e
-  data.tar.gz: ae5c0fc92af82930c489b31b4ef811bf5875263aafbeaaa8cec7b4f5968efe2662e1f9682df49242f44f19b0a7a17e2910ae78723f5262c726b0d43ad1120428
+  metadata.gz: ba59fef8328bcf716b38198b89c0da1f7325f1aeaa37871d8d3b52ac90cc8d37c476a5b3bbf53105a9f447ea84d0284b802676b810fc2b805bd954bbc55ae437
+  data.tar.gz: 4cbf18ed39352bbe33637afa11bbd356a4a0c443583344333144a5a7c6babf3b2f799ac66c1c77b1998e43d9663f679ee0311322df27f580a9236d3fc4f50632

data/lib/bank_statement_parser/hsbc.rb

@@ -18,6 +18,7 @@
 require 'date'
 require 'bank_statement_parser/base'
 require 'bank_statement_parser/statement_record'
+require 'bank_statement_parser/statement_record_types'
 require 'bank_statement_parser/utils'
 module BankStatementParser
 
@@ -112,8 +113,22 @@ module BankStatementParser
 
     private
 
-    TYPES = ["ATM", "BP", "CHQ", "CIR", "CR", "DD", "DIV", "DR",
-             "MAE", "PIM", "SO", "TFR", "VIS", ")))"]
+    TYPES = {
+      'ATM' => StatementRecordTypes::ATM,
+      'BP' => StatementRecordTypes::BILL_PAYMENT,
+      'CHQ' => StatementRecordTypes::CHEQUE,
+      'CIR' => StatementRecordTypes::CIRRUS,
+      'CR' => StatementRecordTypes::CREDIT,
+      'DD' => StatementRecordTypes::DIRECT_DEBIT,
+      'DIV' => StatementRecordTypes::DIVIDEND,
+      'DR' => StatementRecordTypes::DEBIT,
+      'MAE' => StatementRecordTypes::MAESTRO,
+      'PIM' => StatementRecordTypes::PAYING_IN_MACHINE,
+      'SO' => StatementRecordTypes::STANDING_ORDER,
+      'TFR' => StatementRecordTypes::TRANSFER,
+      'VIS' => StatementRecordTypes::VISA,
+      ')))' => StatementRecordTypes::CONTACTLESS,
+    }
 
     MONTHS = Date::MONTHNAMES[1..12]
 
@@ -371,7 +386,7 @@ module BankStatementParser
       end
 
       payment_details = nil
-      if payment_type_and_details =~ /\A(?<payment_type>#{TYPES.map{ |t| Regexp.quote(t) }.join('|')})\s+(?<payment_details>.*)\z/
+      if payment_type_and_details =~ /\A(?<payment_type>#{TYPES.keys.map{ |t| Regexp.quote(t) }.join('|')})\s+(?<payment_details>.*)\z/
         logger.debug { "Found the start of a record (group)" }
         @cached_payment_type = Regexp.last_match(:payment_type)
         payment_details = Regexp.last_match(:payment_details)
@@ -399,6 +414,7 @@ module BankStatementParser
         # Create statement record
         record = StatementRecord.new(date: @cached_statement_date,
                                      type: @cached_payment_type,
+                                     record_type: TYPES[@cached_payment_type],
                                      credit: record_credit,
                                      amount: record_amount,
                                      detail: full_details,

data/lib/bank_statement_parser/statement_record.rb

@@ -16,19 +16,28 @@
 # along with bank_statement_parser. If not, see <http://www.gnu.org/licenses/>.
 
 require 'yaml'
+require 'bank_statement_parser/statement_record_types'
 
 module BankStatementParser
 
   # A bank statement record
   class StatementRecord
-    attr_accessor :date, :type, :credit, :amount, :detail, :balance
+    attr_accessor :date, :type, :record_type, :credit, :amount, :detail, :balance
 
     # Constructor
-    def initialize date: nil, type: nil, credit: nil, amount: nil, detail: nil,
+    def initialize date: nil, type: nil, record_type: nil, credit: nil, amount: nil, detail: nil,
       balance: nil
 
+      # Sanity check the record type parameter
+      known_record_types = StatementRecordTypes.constants(false).map do |k|
+        StatementRecordTypes.const_get(k, false)
+      end
+      raise "Unknown statement record type #{record_type}" unless
+        known_record_types.include?(record_type)
+
       @date = date
       @type = type
+      @record_type = record_type
       @credit = credit
       @amount = amount
       @detail = detail
@@ -44,6 +53,7 @@ module BankStatementParser
     def ==(other)
       super || (date == other.date &&
                 type == other.type &&
+                record_type == other.record_type &&
                 credit == other.credit &&
                 amount == other.amount &&
                 detail == other.detail &&

data/lib/bank_statement_parser/statement_record_types.rb

@@ -0,0 +1,39 @@
+# Copyright 2015 Simon Dawson <spdawson@gmail.com>
+
+# This file is part of bank_statement_parser.
+#
+# bank_statement_parser is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# bank_statement_parser is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with bank_statement_parser. If not, see <http://www.gnu.org/licenses/>.
+
+module BankStatementParser
+
+  # Constants to enumerate bank statement record types
+  module StatementRecordTypes
+    ATM = :atm
+    BILL_PAYMENT = :bill_payment
+    CHEQUE = :cheque
+    CIRRUS = :cirrus
+    CREDIT = :credit
+    DIRECT_DEBIT = :direct_debit
+    DIVIDEND = :dividend
+    DEBIT = :debit
+    INTEREST = :interest
+    MAESTRO = :maestro
+    PAYING_IN_MACHINE = :paying_in_machine
+    STANDING_ORDER = :standing_order
+    TRANSFER = :transfer
+    VISA = :visa
+    CONTACTLESS = :contactless
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bank_statement_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Simon Dawson
@@ -39,6 +39,7 @@ files:
 - lib/bank_statement_parser/base.rb
 - lib/bank_statement_parser/hsbc.rb
 - lib/bank_statement_parser/statement_record.rb
+- lib/bank_statement_parser/statement_record_types.rb
 - lib/bank_statement_parser/utils.rb
 homepage: https://github.com/spdawson/bank_statement_parser
 licenses: