ng-bank-parser 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5904cb150c3b458c49643ee2ff3717ddaf01cc30
-  data.tar.gz: 875fe8dc6feaccba17d8da19f27ebde90f45e0c0
+  metadata.gz: 051a42caac128747e23f1153ab29969b73cbaa38
+  data.tar.gz: 613248ebd4a944520d81c31366c3eebca7c6297e
 SHA512:
-  metadata.gz: 5e09a5b5685f2d03555aeaf0ca727e3428acd730f2da07463b54c988d6351538ca58a20b8bbd77aaa4612dd06a513c0fe88aaac2956b60b190334b82111fe9fd
-  data.tar.gz: c4e7303f6756d87d1d91c1bb48a94d3b99101dc2fe1ba16a0aa04b5e0743c038fb686a0c31a2998aaeee2daf2ab9feed485dd78ea9a146903da1795022b35d70
+  metadata.gz: b97fc6045653913ba4b119c814f53936265d895c72066c303266437411362cde7878d985e6049930ca20996717fa508db3f3b8ee6c6d6f43390210c832a71e63
+  data.tar.gz: 145c45868fb797ec049bbf9e26ba0621256a95ea3926f5c40018826d790237be0a99feb9bac79ed986eee6cea204f4f7452c5161d9c31d8ccaac4319f64fdfbe

data/.gitignore

@@ -27,7 +27,7 @@ build/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
+Gemfile.lock
 # .ruby-version
 # .ruby-gemset
 

data/Gemfile.lock

@@ -11,64 +11,66 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    Ascii85 (1.0.2)
-    activesupport (4.2.4)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
+    Ascii85 (1.0.3)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     afm (0.2.2)
-    diff-lcs (1.2.5)
-    domain_name (0.5.25)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
-    hashery (2.1.1)
-    http-cookie (1.0.2)
+    hashery (2.1.2)
+    http-cookie (1.0.3)
       domain_name (~> 0.5)
-    i18n (0.7.0)
-    json (1.8.3)
-    mime-types (2.99)
-    mini_portile2 (2.0.0)
-    minitest (5.8.3)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
     netrc (0.11.0)
-    nokogiri (1.6.7)
-      mini_portile2 (~> 2.0.0.rc2)
-    pdf-reader (1.3.3)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    pdf-reader (2.1.0)
       Ascii85 (~> 1.0.0)
-      afm (~> 0.2.0)
+      afm (~> 0.2.1)
       hashery (~> 2.0)
       ruby-rc4
       ttfunk
-    rake (10.4.2)
-    rest-client (1.8.0)
+    rake (10.5.0)
+    rest-client (2.0.2)
       http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    roo (2.1.1)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    roo (2.7.1)
       nokogiri (~> 1)
       rubyzip (~> 1.1, < 2.0.0)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.2)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-mocks (3.3.2)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
     ruby-rc4 (0.1.5)
-    rubyzip (1.1.7)
-    thread_safe (0.3.5)
-    ttfunk (1.4.0)
-    tzinfo (1.2.2)
+    rubyzip (1.2.2)
+    thread_safe (0.3.6)
+    ttfunk (1.5.1)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.1)
+    unf_ext (0.0.7.5)
 
 PLATFORMS
   ruby
@@ -80,4 +82,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.10.6
+   1.16.4

data/README.md

@@ -2,9 +2,9 @@
 This is a simple gem to parse Nigerian bank statements of all formats. If your bank and/or file format is not supported, consider reading the contribute wiki and submitting a pull request.
 
 ## API
-Because not everyone develops in rails, we created a public API to use the gem at http://bank-parser.devcenter.co/parse. The parameters are (bank_key, file_path, password). Read the *Usage* section for more information
+Because not everyone develops in rails, we created a public API to use the gem at http://bank-parser.square-api.com/parse. The parameters are (bank_key, file_path, password). Read the *Usage* section for more information
 
-    http://bank-parser.devcenter.co/parse(bank_key, file_path, password)
+    http://bank-parser.square-api.com/parse(bank_key, file_path, password)
 
 ## Installation
 
@@ -92,6 +92,14 @@ Heritage Bank:
 - key: hb
 - supported formats: pdf
 
+Access Bank:
+- key: accessbank
+- supported formats: pdf
+
+Ecobank:
+- key: ecobank
+- supported formats: pdf
+
 ## Contributing
 
 Documentation on contribution can be found in the contribution wiki

data/lib/ng-bank-parser.rb

@@ -1,13 +1,14 @@
-require "ng-bank-parser/version"
-require "ng-bank-parser/banks"
-require "ng-bank-parser/router"
-require "ng-bank-parser/pdf-unlocker"
-require "ng-bank-parser/parsers/gtb-excel-parser"
-require "ng-bank-parser/parsers/uba-pdf-parser"
-require "ng-bank-parser/parsers/hb-pdf-parser"
-require "ng-bank-parser/parsers/firstbank-pdf-parser"
-require "ng-bank-parser/parsers/accessbank-pdf-parser"
+require_relative "ng-bank-parser/version"
+require_relative "ng-bank-parser/banks"
+require_relative "ng-bank-parser/router"
+require_relative "ng-bank-parser/pdf-unlocker"
+require_relative "ng-bank-parser/parsers/gtb-excel-parser"
+require_relative "ng-bank-parser/parsers/uba-pdf-parser"
+require_relative "ng-bank-parser/parsers/hb-pdf-parser"
+require_relative "ng-bank-parser/parsers/firstbank-pdf-parser"
+require_relative "ng-bank-parser/parsers/accessbank-pdf-parser"
+require_relative "ng-bank-parser/parsers/ecobank-pdf-parser"
 
 module NgBankParser
-  # Your code goes here...
+  # Your code goes here... 
 end

data/lib/ng-bank-parser/banks.rb

@@ -46,6 +46,15 @@ module NgBankParser
 						 invalid: "lib/ng-bank-parser/fixtures/accessbank-pdf-invalid.pdf",
 						 extensions: ["pdf"]
 				 }]
-	  	}]
+	  	},{
+				key: "ecobank",
+				name: "Ecobank Nigeria",
+				parsers: [{
+					format: "pdf",
+					valid: "lib/ng-bank-parser/fixtures/ecobank-pdf-valid.pdf",
+					invalid: "lib/ng-bank-parser/fixtures/ecobank-pdf-invalid.pdf",
+					extensions: ["pdf"]
+				}]
+			}]
 	end
 end

data/lib/ng-bank-parser/fixtures/ecobank-pdf-invalid.pdf

@@ -0,0 +1,160 @@
+%PDF-1.3
+3 0 obj
+<</Type /Page
+/Parent 1 0 R
+/Resources 2 0 R
+/Contents 4 0 R>>
+endobj
+4 0 obj
+<</Length 165>>
+stream
+0.57 w
+0 G
+BT
+/F1 16 Tf
+16 TL
+0 g
+56.69 785.20 Td
+(Hello world!) Tj
+ET
+BT
+/F1 16 Tf
+16 TL
+0 g
+56.69 756.85 Td
+(This a random PDF file for testing our parsers.) Tj
+ET
+endstream
+endobj
+1 0 obj
+<</Type /Pages
+/Kids [3 0 R ]
+/Count 1
+/MediaBox [0 0 595.28 841.89]
+>>
+endobj
+5 0 obj
+<</BaseFont/Helvetica/Type/Font
+/Encoding/WinAnsiEncoding
+/Subtype/Type1>>
+endobj
+6 0 obj
+<</BaseFont/Helvetica-Bold/Type/Font
+/Encoding/WinAnsiEncoding
+/Subtype/Type1>>
+endobj
+7 0 obj
+<</BaseFont/Helvetica-Oblique/Type/Font
+/Encoding/WinAnsiEncoding
+/Subtype/Type1>>
+endobj
+8 0 obj
+<</BaseFont/Helvetica-BoldOblique/Type/Font
+/Encoding/WinAnsiEncoding
+/Subtype/Type1>>
+endobj
+9 0 obj
+<</BaseFont/Courier/Type/Font
+/Encoding/WinAnsiEncoding
+/Subtype/Type1>>
+endobj
+10 0 obj
+<</BaseFont/Courier-Bold/Type/Font
+/Encoding/WinAnsiEncoding
+/Subtype/Type1>>
+endobj
+11 0 obj
+<</BaseFont/Courier-Oblique/Type/Font
+/Encoding/WinAnsiEncoding
+/Subtype/Type1>>
+endobj
+12 0 obj
+<</BaseFont/Courier-BoldOblique/Type/Font
+/Encoding/WinAnsiEncoding
+/Subtype/Type1>>
+endobj
+13 0 obj
+<</BaseFont/Times-Roman/Type/Font
+/Encoding/WinAnsiEncoding
+/Subtype/Type1>>
+endobj
+14 0 obj
+<</BaseFont/Times-Bold/Type/Font
+/Encoding/WinAnsiEncoding
+/Subtype/Type1>>
+endobj
+15 0 obj
+<</BaseFont/Times-Italic/Type/Font
+/Encoding/WinAnsiEncoding
+/Subtype/Type1>>
+endobj
+16 0 obj
+<</BaseFont/Times-BoldItalic/Type/Font
+/Encoding/WinAnsiEncoding
+/Subtype/Type1>>
+endobj
+2 0 obj
+<<
+/ProcSet [/PDF /Text /ImageB /ImageC /ImageI]
+/Font <<
+/F1 5 0 R
+/F2 6 0 R
+/F3 7 0 R
+/F4 8 0 R
+/F5 9 0 R
+/F6 10 0 R
+/F7 11 0 R
+/F8 12 0 R
+/F9 13 0 R
+/F10 14 0 R
+/F11 15 0 R
+/F12 16 0 R
+>>
+/XObject <<
+>>
+>>
+endobj
+17 0 obj
+<<
+/Producer (jsPDF 20120619)
+/CreationDate (D:20150829130726)
+>>
+endobj
+18 0 obj
+<<
+/Type /Catalog
+/Pages 1 0 R
+/OpenAction [3 0 R /FitH null]
+/PageLayout /OneColumn
+>>
+endobj
+xref
+0 19
+0000000000 65535 f 
+0000000301 00000 n 
+0000001530 00000 n 
+0000000009 00000 n 
+0000000087 00000 n 
+0000000388 00000 n 
+0000000478 00000 n 
+0000000573 00000 n 
+0000000671 00000 n 
+0000000773 00000 n 
+0000000861 00000 n 
+0000000955 00000 n 
+0000001052 00000 n 
+0000001153 00000 n 
+0000001246 00000 n 
+0000001338 00000 n 
+0000001432 00000 n 
+0000001754 00000 n 
+0000001836 00000 n 
+trailer
+<<
+/Size 19
+/Root 18 0 R
+/Info 17 0 R
+>>
+startxref
+1940
+%%EOF

data/lib/ng-bank-parser/parsers/accessbank-pdf-parser/helpers.rb

@@ -111,8 +111,6 @@ module AccessbankPdfHelpers
   end
 
 
-
-
   def error(msg)
     { status: 400, message: msg }
   end
@@ -122,7 +120,6 @@ module AccessbankPdfHelpers
   end
 
 
-
   private
     def remove_line_spacing(str)
       str.gsub(/^$\n/, '').lines
@@ -161,6 +158,7 @@ module AccessbankPdfHelpers
       Date.strptime(date_str, '%d-%b-%y')
     end
 
+    
     def string_with_slash_to_date(date_str)
       Date.strptime(date_str, '%d/%m/%Y')
     end

data/lib/ng-bank-parser/parsers/ecobank-pdf-parser.rb

@@ -0,0 +1,35 @@
+require 'pdf-reader'
+require 'open-uri'
+require_relative 'ecobank-pdf-parser/helpers'
+
+module NgBankParser
+  class EcobankPdf
+    extend EcobankPdfHelpers
+
+    FILE_FORMATS = [".pdf"]
+    
+    def self.parse(path, password=nil) 
+      unless FILE_FORMATS.include? File.extname(path)
+        return error("Invalid file format. Please use one of the following: #{ FILE_FORMATS.each{ |format| format }}")
+      end
+
+      file = open(path)
+      begin
+        @pdf = PDF::Reader.new(file)
+      rescue PDF::Reader::EncryptedPDFError
+        return error("Invalid file. Please use an unencrypted pdf")
+      rescue 
+        return error("Couldn't parse this file")
+      end
+
+      pdf_array = pdf_to_a(@pdf)
+
+      unless has_valid_details?(pdf_array)
+        return error("Couldn't fetch account details from pdf")
+      end
+
+      response = get_details(pdf_array)
+      return success(response)
+    end 
+  end
+end

data/lib/ng-bank-parser/parsers/ecobank-pdf-parser/helpers.rb

@@ -0,0 +1,164 @@
+module NgBankParser
+  module EcobankPdfHelpers
+
+    def pdf_to_a(pdf)
+      lines = []
+
+      pdf.pages.each do |page|
+        remove_line_spacing(page.text).each do |line|
+          lines << line.strip.split(/\s\s+/)
+        end
+      end
+
+      return lines
+    end
+
+
+    def get_details(pdf_array)
+      details = Hash.new
+      details[:bank_name] = 'Ecobank'
+      details[:account_number] = get_account_number(pdf_array)
+      details[:account_name] =  get_account_name(pdf_array)
+
+      transactions = get_transactions(pdf_array)
+      details[:from_date] = transactions[0][:date]
+      details[:to_date] = transactions[-1][:date]
+      details[:transactions] = transactions
+
+      return details
+    end
+
+    
+    def has_valid_details?(pdf_array)
+      return (get_account_number(pdf_array) and get_account_name(pdf_array))
+    end
+
+
+    def get_account_name(pdf_array)
+      pdf_array.each do |row|
+        row.each_with_index do |cell, index|
+          if cell == 'Name'
+            return row[index + 1]
+          end
+        end
+      end
+      return nil
+    end
+
+    
+    def get_account_number(pdf_array)
+      pdf_array.each do |row|
+        row.each do |cell|
+          if cell =~ /[0-9]{10}/
+            return cell
+          end
+        end
+      end
+      return nil
+    end
+
+    
+    def get_transactions(pdf_array)
+      start_index = get_first_line_of_transactions(pdf_array) 
+      transactions = []
+
+      opening_balance = pdf_array[start_index][-1]
+
+      pdf_array[start_index..-1].each do |transaction|
+        if valid_transaction?(transaction)
+
+          transaction_hash = Hash.new
+          transaction_hash[:date] = string_with_dash_to_date(transaction[0])
+          
+          if transaction.count == 6
+            transaction_hash[:remarks] = transaction[2]
+            transaction_hash[:ref] = transaction[3]
+            transaction_hash[:amount] = amount_to_f(transaction[4])
+            transaction_hash[:balance] = amount_to_f(transaction[5])
+          elsif transaction.count == 5
+            if transaction[2].chars.first === "'"
+              transaction_hash[:remarks] = ""
+              transaction_hash[:ref] = transaction[2]
+              transaction_hash[:amount] = amount_to_f(transaction[3])
+              transaction_hash[:balance] = amount_to_f(transaction[4])
+            elsif transaction[2].split("'")[1]
+              transaction_hash[:remarks] = transaction[2].split("'")[0]
+              transaction_hash[:ref] = transaction[2].split("'")[1]
+              transaction_hash[:amount] = amount_to_f(transaction[3])
+              transaction_hash[:balance] = amount_to_f(transaction[4])
+            else
+              transaction_hash[:remarks] = transaction[2]
+              transaction_hash[:ref] = transaction[3]
+              amount_and_balance = transaction[4].split(" ")
+              transaction_hash[:amount] = amount_to_f(amount_and_balance[0])
+              transaction_hash[:balance] = amount_to_f(amount_and_balance[1])
+            end
+          else 
+            remarks_and_ref = transaction[2].split("'")
+            transaction_hash[:remarks] = remarks_and_ref[0]
+            transaction_hash[:ref] = "'" << remarks_and_ref[1]
+            amount_and_balance = transaction[3].split(" ")
+            transaction_hash[:amount] = amount_to_f(amount_and_balance[0])
+            transaction_hash[:balance] = amount_to_f(amount_and_balance[1])
+          end
+
+          transaction_hash[:type] = transaction_type(transaction_hash[:balance], opening_balance)
+        
+          opening_balance = transaction_hash[:balance]
+          transactions << transaction_hash
+        end
+      end
+
+      return transactions
+    end
+
+
+    def error(message)
+      { status: 400, message: message }
+    end
+
+    def success(data)
+      { status: 200, data: data }
+    end
+    
+
+    private
+    def remove_line_spacing(str)
+      str.gsub(/^$\n/, '').lines
+    end
+
+
+    def transaction_type(current_balance, former_balance)
+      former_balance = amount_to_f(former_balance) if former_balance.is_a?(String)
+
+      current_balance - former_balance > 1 ? 'credit' : 'debit'
+    end
+
+
+    def amount_to_f(amount)
+      amount.gsub(/[^\d\.]/, '').to_f
+    end
+
+
+    def get_first_line_of_transactions(pdf_array)
+      start = -1
+
+      pdf_array.each_with_index do |row, index|
+        start = index + 1 if row[0] == 'Transaction Date'
+      end
+
+      return start
+    end
+
+
+    def valid_transaction?(line)
+       # first column matches ecobank transaction date pattern and it has between 4 and 6 columns
+      line[0] =~ /([0-3][0-9])[\-]([a-zA-Z]+)[\-]([0-9]{4})/ and line.count >= 4 and line.count <= 6
+    end
+
+
+    def string_with_dash_to_date(date_str)
+      Date.strptime(date_str, '%d-%b-%y')
+    end
+  end
+end

data/lib/ng-bank-parser/version.rb

@@ -1,3 +1,3 @@
 module NgBankParser
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ng-bank-parser
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Opemipo Aikomo
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-17 00:00:00.000000000 Z
+date: 2018-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,6 +150,8 @@ files:
 - lib/ng-bank-parser/banks.rb
 - lib/ng-bank-parser/fixtures/accessbank-pdf-invalid.pdf
 - lib/ng-bank-parser/fixtures/accessbank-pdf-valid.pdf
+- lib/ng-bank-parser/fixtures/ecobank-pdf-invalid.pdf
+- lib/ng-bank-parser/fixtures/ecobank-pdf-valid.pdf
 - lib/ng-bank-parser/fixtures/firstbank-pdf-invalid.pdf
 - lib/ng-bank-parser/fixtures/firstbank-pdf-valid.pdf
 - lib/ng-bank-parser/fixtures/gtb-excel-invalid.pdf
@@ -161,6 +163,8 @@ files:
 - lib/ng-bank-parser/fixtures/uba-pdf-valid.pdf
 - lib/ng-bank-parser/parsers/accessbank-pdf-parser.rb
 - lib/ng-bank-parser/parsers/accessbank-pdf-parser/helpers.rb
+- lib/ng-bank-parser/parsers/ecobank-pdf-parser.rb
+- lib/ng-bank-parser/parsers/ecobank-pdf-parser/helpers.rb
 - lib/ng-bank-parser/parsers/firstbank-pdf-parser.rb
 - lib/ng-bank-parser/parsers/firstbank-pdf-parser/helpers.rb
 - lib/ng-bank-parser/parsers/firstbank-pdf-parser/statement_utils.rb
@@ -199,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: This is a simple gem to parse Nigerian bank statements of all formats created