ng-bank-parser 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e5a7db57078dcd107ad0639d82e75878f2a20ca
-  data.tar.gz: 643bd67066a3d7403c441560c5fb7da8791c403c
+  metadata.gz: 19849fae342789d9fc403b205e4c2b476dff411a
+  data.tar.gz: 06509361c35618a53005cd7952521731dccf1119
 SHA512:
-  metadata.gz: 6237746ad1515a706fccefd269d85afe998e3fdb5ef34a7500b3999bfc03f2feba27183dfd7ede81aca31d5b46e0a23095a4d1d578c173b0c109fdbd7205e361
-  data.tar.gz: d1510c04d081e6a94a7c2169bc2bf7177d1cad0c5ab4bd800058ac60405e7a1f6e2f68179367e3e1adb12ce53199690bd9ef46b2c01ea71b4382195db3942532
+  metadata.gz: f6cf9a75e0f1ce3b40406852cb0a36678b32e8e03e20f4ce23dcf1283ee6be8b30bdd1aba797c13c544b7180447657733ca321cde9fff7539738ec859fe417ac
+  data.tar.gz: 30fece1d8504473ea6074ac278bd189def9b2936ab1646e753f24a2be25e3dfa0c3ceb9ac354e365666b5a06ac64012e6c6618be26acdc5158850f2f004bd136

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    ng-bank-parser (0.1.2)
+    ng-bank-parser (0.1.4)
       activesupport
-      httmultiparty
       nokogiri
       pdf-reader
+      rest-client
       roo
 
 GEM
@@ -20,21 +20,17 @@ GEM
       tzinfo (~> 1.1)
     afm (0.2.2)
     diff-lcs (1.2.5)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
     hashery (2.1.1)
-    httmultiparty (0.3.16)
-      httparty (>= 0.7.3)
-      mimemagic
-      multipart-post
-    httparty (0.13.5)
-      json (~> 1.8)
-      multi_xml (>= 0.5.2)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
     i18n (0.7.0)
     json (1.8.3)
-    mimemagic (0.3.0)
+    mime-types (2.6.1)
     mini_portile (0.6.2)
     minitest (5.8.0)
-    multi_xml (0.5.5)
-    multipart-post (2.0.0)
+    netrc (0.10.3)
     nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
     pdf-reader (1.3.3)
@@ -44,6 +40,10 @@ GEM
       ruby-rc4
       ttfunk
     rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
     roo (2.1.1)
       nokogiri (~> 1)
       rubyzip (~> 1.1, < 2.0.0)
@@ -66,6 +66,9 @@ GEM
     ttfunk (1.4.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,6 +1,11 @@
 # Ng::Bank::Parser
 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
+
+    http://bank-parser.devcenter.co/parse(bank_key, file_path, password)
+
 ## Installation
 
 Add this line to your application's Gemfile:

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

@@ -25,7 +25,7 @@ module NgBankParser
 				format: "pdf",
 				valid: "lib/ng-bank-parser/fixtures/firstbank-pdf-valid.pdf",
 				fixture_password: 19856,
-				invalid: "lib/ng-bank-parser/fixtures/firstbank-pdf-invalid.xlsx",
+				invalid: "lib/ng-bank-parser/fixtures/firstbank-pdf-invalid.pdf",
 				extensions: ["pdf"]
 			}]
 		}]

data/lib/ng-bank-parser/fixtures/firstbank-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/firstbank-pdf-parser.rb

@@ -1,7 +1,6 @@
 require 'pdf-reader'
 require_relative 'firstbank-pdf-parser/helpers'
 
-
 module NgBankParser
 	class FirstbankPdf
 		extend FirstbankPdfHelpers
@@ -14,7 +13,9 @@ module NgBankParser
 				return error_message 'Invalid file format'
 			end
 
-			if has_encryption? path
+			file = open(path)
+
+			if has_encryption? file
 				if password
 					unless get_unlocked_pdf? path, password
 						return error_message 'Password supplied for decryption is invalid.'
@@ -41,10 +42,8 @@ module NgBankParser
 			else
 				return error_message 'Could not find any transactions'
 			end
-
 		end
 
-
 		private
 
 		def self.extract_transactions(jagged_array = [[]])

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

@@ -1,6 +1,7 @@
 require 'pdf-reader'
 require 'date'
 require 'open-uri'
+require 'securerandom'
 require_relative 'statement_utils'
 require_relative '../../pdf-unlocker.rb'
 
@@ -10,27 +11,37 @@ module NgBankParser
 		
 		@@pdf_reader = nil
 		@@raw_transactions = [[]]
-
-		def has_encryption? path
+		@@account_name = nil
+		@@account_number = nil
+		@@last_balance = nil
+		@@statement_period = nil
+		@@from_date = nil
+		@@to_date = nil
+
+		def has_encryption? file
 			begin
-				@@pdf_reader = PDF::Reader.new(path)
+				@@pdf_reader = PDF::Reader.new(file)
 				false
 			rescue PDF::Reader::EncryptedPDFError
 				true
 			end
 		end
 
-
 		def get_unlocked_pdf? path, password
-			response = PDFUnlocker.new(File.new(path), password).unlocked_pdf
+			response = PDFUnlocker.unlock(path, password)
+
 			return false unless response
 			if response.include? 'Unlock Failed'
 				return false
 			else
 				pseudo_file = StringIO.new
 				pseudo_file.write(response)
-				@@pdf_reader = PDF::Reader.new(pseudo_file)
-				return true
+				begin
+					@@pdf_reader = PDF::Reader.new(pseudo_file)
+					return true
+				rescue
+					return false					
+				end
 			end
 		end
 

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

@@ -14,8 +14,13 @@ module NgBankParser
         end
 
         file = open(url)
-        @reader = PDF::Reader.new(file)
+
+        if has_encryption? file 
+          return invalid_file
+        end
+
         set_up_first_page
+
         if is_valid_pdf?
           set_account_details
           set_transactions
@@ -27,6 +32,15 @@ module NgBankParser
 
       private
 
+      def has_encryption? path
+        begin
+          @reader = PDF::Reader.new(path)
+          false
+        rescue PDF::Reader::EncryptedPDFError
+          true
+        end
+      end
+
       def set_up_first_page
         @first_page_text = @reader.pages.first.text.remove_empty_lines
         set_column_positions(@first_page_text.lines[TABLE_HEADER_LINE_INDEX])

data/lib/ng-bank-parser/parsers/uba-pdf-parser/transaction_tools.rb

@@ -12,8 +12,8 @@ module NgBankParser
     private
 
     def set_transactions
-      @transactions ||= Array.new
-      @transaction_strings ||= Array.new
+      @transactions = Array.new
+      @transaction_strings = Array.new
       @reader.pages[0..-2].each do |page|
         seperate_lines_into_transaction_strings(page.text.remove_empty_lines.lines)
       end

data/lib/ng-bank-parser/pdf-unlocker.rb

@@ -1,21 +1,35 @@
-require 'httmultiparty' 
+require 'rest-client' 
 
 module NgBankParser
 	class PDFUnlocker
-		include HTTMultiParty
-		base_uri 'http://pdf-unlocker.herokuapp.com'
 
-		def initialize(file, password)
-			@pdf = file
+		def self.unlock(path, password)
+			@path = path
 			@password = password
+
+			if File.exists? @path
+				unlock_pdf_file
+			else				
+				unlock_pdf_url
+			end
 		end
 
-		
-		def unlocked_pdf
-			options = { :pdf => @pdf, :password => @password }
+		def self.unlock_pdf_file
+			url = 'http://pdf-unlocker.herokuapp.com/rest/pdf/unlock'
+
+			begin
+				response = RestClient.post url, {:password => @password, :pdf => File.new(@path, 'rb')}
+			rescue
+				response = nil
+			end
+		end
+
+		def self.unlock_pdf_url
+			url = 'http://pdf-unlocker.herokuapp.com/rest/pdf/unlock_with_file_url'
+
 			begin
-				response = self.class.post('/rest/pdf/unlock', :query => options, :detect_mime_type => true).parsed_response
-			rescue StandardError
+				response = RestClient.post url, {:password => @password, :file_url => @path, :multipart => true}
+			rescue
 				response = nil
 			end
 		end

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

@@ -1,43 +1,61 @@
+require 'net/http'
+
 module NgBankParser
   class Router
-    @banks_hash = $Banks
-    @supported_extension_array = []
-    @selected_bank_index
+    @banks = $Banks
     
     #this takes our bank parser along with the bank name supplied from the payload so as to compare
     #and see if the file extension is available for that bank
     #it's result is to fill up the @supported_extension_array with the supported bank extensions
     def self.parse(bank_key, path, password = nil)
-      @password = password;
-      @selected_bank_index = @banks_hash.index {|x| x[:key] == bank_key}
+      @path = path
+      @password = password
+      @selected_bank = @banks.find {|x| x[:key] == bank_key}
       
-      if @selected_bank_index.nil?
+      if @selected_bank.nil?
         return {status: 0, message: "Your bank is not yet supported"}
-      else
-        @supported_extension_array += @banks_hash[@selected_bank_index][:parsers].map {|e| e[:extensions]}
-        parser_picker(path)
-      end      
+      end
+
+      unless file_exists(path) 
+        return {status: 0, message: "File does not exist or is not accesible"} 
+      end
+
+      extensions = @selected_bank[:parsers].map {|e| e[:extensions]}
+      @supported_extensions = extensions.reduce(:concat)
+      pick_parser()
     end
 
     private
 
     #this uses the extension in the file of the uploaded payload to check support in @supported_extension_array
     #and goes on to pick the parser to use for the operation
-    def self.parser_picker(path)
-      extension_name = File.extname(path).delete('.')
-      if @supported_extension_array.reduce(:concat).include?(extension_name)
-          ng_bank_parsers(path)
+    def self.pick_parser()
+      bank_name = @selected_bank[:name]
+      extension_name = File.extname(@path).delete('.')
+
+      if @supported_extensions.include? extension_name
+          parser = @selected_bank[:parsers].find {|p| p[:extensions].include? extension_name}
+          parse_with(parser)
       else
-          return {status: 0, message:"The '.#{extension_name}' file format is not supported for your bank."}
+          return {status: 0, message:"The '.#{extension_name}' file format is not supported for this bank (#{bank_name})."}
       end         
     end
 
     #Builds the the parser to use from the name and file format of the uploaded file
-    def self.ng_bank_parsers(path)
-      key = @banks_hash[@selected_bank_index][:key].capitalize
-      format = @banks_hash[@selected_bank_index][:parsers].map { |e| e[:format].capitalize }
-      class_name = key + format.reduce(:concat)
-      NgBankParser.const_get(class_name).parse(path, @password)
+    def self.parse_with(parser)
+      class_name = @selected_bank[:key].capitalize + parser[:format].capitalize
+      class_object = NgBankParser.const_get(class_name)
+      parser_response = class_object.parse(@path, @password)
+    end
+
+    def self.file_exists(path)
+      return true if File.exists?(path)
+
+      uri = URI(path)
+
+      request = Net::HTTP.new uri.host
+      response= request.request_head uri.path
+      return response.code.to_i == 200
     end
 
   end

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

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

data/ng-bank-parser.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "roo"
   spec.add_dependency "pdf-reader"
   spec.add_dependency "activesupport"
-  spec.add_dependency 'httmultiparty'
+  spec.add_dependency 'rest-client'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ng-bank-parser
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Opemipo Aikomo
@@ -112,7 +112,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: httmultiparty
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -148,7 +148,7 @@ files:
 - bin/setup
 - lib/ng-bank-parser.rb
 - lib/ng-bank-parser/banks.rb
-- lib/ng-bank-parser/fixtures/firstbank-pdf-invalid.xlsx
+- 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
 - lib/ng-bank-parser/fixtures/gtb-excel-valid.xls