hsbc_pdf_statement_parser 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9737c59472032f49b8bc7539d08856feb6e5703a5a43966b8a80340566e8de6
-  data.tar.gz: 989e26dddd81066f6b2d931067acc47e6b23d60adf35daef7a30bdf27830317e
+  metadata.gz: 1aeed5005a826d427a328576db61241bab262e44941ae1c0af5d34f7028f1281
+  data.tar.gz: 1af68498d1b4e4732e42a7422a32930170f4870f85a458b0a166b95e0ef7b338
 SHA512:
-  metadata.gz: ec9375eeee5b241bfc50fa13a1f39b99587e25fde0c5bde829bcd97d166124727837f788686218b5e46ad3aaaa54dc1707733f6902bd9e400447f93a35eaadf6
-  data.tar.gz: 3db670821e2d4b6868ace32aefe4688645e4766d4e68a28c3c5d64e320fa7d68764799101c050ab1b9b1c2ca2bab907db6c9e6cc950ae3789edc09fbfb0cff65
+  metadata.gz: 64d6adeb4671eff35241d94d8f848fe54cbf6c324aa366e75d658d44b5113b468badde10b262ab092ab8b43e87402dad81cc10f9ba4b281c6fefc325c4533199
+  data.tar.gz: bebec0676834fd0da389f2094017a930c795f103a7477e67062449d31c3598cd9571f5f6dcbb57ab06549e4b761515915e9f211d936bf1e7660452c2497a32db

data/lib/hsbc_pdf_statement_parser/parser.rb

@@ -1,161 +1,165 @@
-class HsbcPdfStatementParser::Parser 
+module HsbcPdfStatementParser
   
-  # Creates a new parser from a PDF file.
-  #
-  # === Parameters
-  #
-  # [filename] the filename to parse
-  def initialize( filename )
-    
-    @reader = PDF::Reader.new( filename )
-    
-  end
-  
-  # Returns an array of the transactions in the document as hashes.
-  #
-  # === Hash keys
-  #
-  # [:date] the date of the transaction _(Date)_
-  # [:type] the type of the transaction, eg ‘VISA’, ‘DD’, ‘ATM’, etc _(String)_
-  # [:details] the details of the transaction. This can span multiple lines _(String)_
-  # [:out] the amount of the transaction, if a debit _(Float, nil)_
-  # [:in] the amount of the transaction, if a credit _(Float, nil)_
-  # [:change] the amount of the transacation: negative if a debit, positive if a credit _(Float)_
-  def transactions
-    
-    @_transactions ||= begin
+  class Parser 
+    
+    # Creates a new parser from a PDF file.
+    #
+    # === Parameters
+    #
+    # [filename] the filename to parse
+    def initialize( filename )
       
-      current_transaction = nil
-      current_date = nil
-      transactions = []
+      @reader = PDF::Reader.new( filename )
       
-      document_text
-        .scan( /BALANCE\s?BROUGHT\s?FORWARD(?:.*?)\n(.*?)BALANCE\s?CARRIED\s?FORWARD/im )
-        .map{ |text| parse_page( text[0] )}
-        .flatten
-        .each do |line|
+    end
+    
+    # Returns an array of the transactions in the document as hashes.
+    #
+    # === Hash keys
+    #
+    # [:date] the date of the transaction _(Date)_
+    # [:type] the type of the transaction, eg ‘VISA’, ‘DD’, ‘ATM’, etc _(String)_
+    # [:details] the details of the transaction. This can span multiple lines _(String)_
+    # [:out] the amount of the transaction, if a debit _(Float, nil)_
+    # [:in] the amount of the transaction, if a credit _(Float, nil)_
+    # [:change] the amount of the transacation: negative if a debit, positive if a credit _(Float)_
+    def transactions
+      
+      @_transactions ||= begin
         
-          # store the current date
-          current_date = line[:date] unless line[:date].nil?
+        current_transaction = nil
+        current_date = nil
+        transactions = []
         
-          # if we have a type, start a new transaction
-          unless line[:type].nil?
-            transactions << current_transaction unless current_transaction.nil?
-            current_transaction = line.merge( date: current_date )
-            next
+        document_text
+          .scan( /BALANCE\s?BROUGHT\s?FORWARD(?:.*?)\n(.*?)BALANCE\s?CARRIED\s?FORWARD/im )
+          .map{ |text| parse_page( text[0] )}
+          .flatten
+          .each do |line|
+          
+            # store the current date
+            current_date = line[:date] unless line[:date].nil?
+          
+            # if we have a type, start a new transaction
+            unless line[:type].nil?
+              transactions << current_transaction unless current_transaction.nil?
+              current_transaction = line.merge( date: current_date )
+              next
+            end
+          
+            # merge things in
+            current_transaction.merge!( line.select{ |k,v| v }, { details: "#{current_transaction[:details]}\n#{line[:details]}" })
+          
           end
         
-          # merge things in
-          current_transaction.merge!( line.select{ |k,v| v }, { details: "#{current_transaction[:details]}\n#{line[:details]}" })
-        
-        end
+        # dump the final transaction + return
+        transactions << current_transaction unless current_transaction.nil?
+        transactions
+      end
       
-      # dump the final transaction + return
-      transactions << current_transaction unless current_transaction.nil?
-      transactions
     end
     
-  end
-  
-  # Returns the opening balance of the statement read from the table on the first page.
-  def opening_balance
-    
-    @_opening_balance ||= scan_figure( 'Opening Balance' )
-    
-  end
-  
-  # Returns the closing balance of the statement read from the table on the first page.
-  def closing_balance
-    
-    @_closing_balance ||= scan_figure( 'Closing Balance' )
-    
-  end
-  
-  # Returns the total value of payments in during the statement read from the table on the first page (ie: not calculated)
-  def payments_in
-    
-    @_payments_in ||= scan_figure( 'Payments In' )
-    
-  end
-  
-  # Returns the total value of payments out during the statement read from the table on the first page (ie: not calculated)
-  def payments_out
-    
-    @_payments_out ||= scan_figure( 'Payments Out' )
-    
-  end
-  
-  private
-  
-  def document_text
-    
-    @text ||= begin
+    # Returns the opening balance of the statement read from the table on the first page.
+    def opening_balance
       
-      @reader.pages.map( &:text ).join
+      @_opening_balance ||= scan_figure( 'Opening Balance' )
       
     end
     
-  end
-  
-  def scan_figure( search_string )
-    
-    @_first_page ||= @reader.pages.first.text
-    
-    match = Regexp.new( "#{search_string}(?:.*?)([0-9\.\,]{4,})", Regexp::IGNORECASE ).match( @_first_page )
-    return nil if match.nil?
-    
-    match[1].gsub( ',', '' ).to_f
-    
-  end
-  
-  def parse_page( page_str )
+    # Returns the closing balance of the statement read from the table on the first page.
+    def closing_balance
+      
+      @_closing_balance ||= scan_figure( 'Closing Balance' )
+      
+    end
     
-    # grab lines + get the longest
-    lines = page_str.lines
-    max_length = lines.map( &:length ).max
+    # Returns the total value of payments in during the statement read from the table on the first page (ie: not calculated)
+    def payments_in
+      
+      @_payments_in ||= scan_figure( 'Payments In' )
+      
+    end
     
-    lines.map{ |line| parse_line( line.rstrip.ljust( max_length ))}.compact
+    # Returns the total value of payments out during the statement read from the table on the first page (ie: not calculated)
+    def payments_out
       
-  end
-  
-  def parse_line( line_str )
+      @_payments_out ||= scan_figure( 'Payments Out' )
+      
+    end
     
-    # if we’re blank…
-    return nil if line_str.strip.empty?
+    private
     
-    # start cutting things up
-    row = {
-      date:    empty_to_nil( line_str[0..12] ),
-      type:    empty_to_nil( line_str[12..20] ),
-      details: empty_to_nil( line_str[20..70] ),
-      out:     empty_to_nil( line_str[70..90] ),
-      in:      empty_to_nil( line_str[90..110] ),
-      balance: empty_to_nil( line_str[110..130] )
-    }
+    def document_text
+      
+      @text ||= begin
+        
+        @reader.pages.map( &:text ).join
+        
+      end
+      
+    end
     
-    # munge things further
-    row[:date]    = Date.strptime( row[:date], '%d %b %y' ) unless row[:date].nil?
-    row[:out]     = row[:out].gsub( ',', '' ).to_f unless row[:out].nil?
-    row[:in]      = row[:in].gsub( ',', '' ).to_f unless row[:in].nil?
-    row[:balance] = row[:balance].gsub( ',', '' ).to_f unless row[:balance].nil?
+    def scan_figure( search_string )
+      
+      @_first_page ||= @reader.pages.first.text
+      
+      match = Regexp.new( "#{search_string}(?:.*?)([0-9\.\,]{4,})", Regexp::IGNORECASE ).match( @_first_page )
+      return nil if match.nil?
+      
+      match[1].gsub( ',', '' ).to_f
+      
+    end
     
-    # set a change amount
-    row[:change]  = if !row[:out].nil?
-      0 - row[:out]
-    elsif !row[:in].nil?
-      row[:in]
-    else
-      nil
+    def parse_page( page_str )
+      
+      # grab lines + get the longest
+      lines = page_str.lines
+      max_length = lines.map( &:length ).max
+      
+      lines.map{ |line| parse_line( line.rstrip.ljust( max_length ))}.compact
+        
     end
     
-    # return
-    row
+    def parse_line( line_str )
       
-  end
-  
-  def empty_to_nil( str )
+      # if we’re blank…
+      return nil if line_str.strip.empty?
+      
+      # start cutting things up
+      row = {
+        date:    empty_to_nil( line_str[0..12] ),
+        type:    empty_to_nil( line_str[12..20] ),
+        details: empty_to_nil( line_str[20..70] ),
+        out:     empty_to_nil( line_str[70..90] ),
+        in:      empty_to_nil( line_str[90..110] ),
+        balance: empty_to_nil( line_str[110..130] )
+      }
+      
+      # munge things further
+      row[:date]    = Date.strptime( row[:date], '%d %b %y' ) unless row[:date].nil?
+      row[:out]     = row[:out].gsub( ',', '' ).to_f unless row[:out].nil?
+      row[:in]      = row[:in].gsub( ',', '' ).to_f unless row[:in].nil?
+      row[:balance] = row[:balance].gsub( ',', '' ).to_f unless row[:balance].nil?
+      
+      # set a change amount
+      row[:change]  = if !row[:out].nil?
+        0 - row[:out]
+      elsif !row[:in].nil?
+        row[:in]
+      else
+        nil
+      end
+      
+      # return
+      row
+        
+    end
     
-    ( str.strip!.empty? ) ? nil : str
+    def empty_to_nil( str )
+      
+      ( str.strip!.empty? ) ? nil : str
+      
+    end
     
   end
   

data/lib/hsbc_pdf_statement_parser/version.rb

@@ -1,3 +1,3 @@
 module HsbcPdfStatementParser
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hsbc_pdf_statement_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jon Pearse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-24 00:00:00.000000000 Z
+date: 2019-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pdf-reader