banco 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46ea6fd6061ec915ad68f9f440e8f8ebde2e68f8
+  data.tar.gz: 8e547c123763df3b53cf35ed8b79fcddce711072
+SHA512:
+  metadata.gz: 9ac616b841ca909252d1e5716450185dd057f5de1c8f28caa6dcdef98982d81a7d596639fbd9d53e67ceffb77ea2863cb9a04f8cf2d44bc49d180a6c2b1c2244
+  data.tar.gz: ccc7d6ceebfb4434c8b04da880e823e0ad9ea13239bd802aebca8dbc9c6fa41cb9849cc47ca24218500b697f88abbd60a6dcf154930899229070a3f007fdf23c

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2017 Ian Marley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README

@@ -0,0 +1,12 @@
+Welcome to Banco !
+
+Banco has been developed to summarize statements downloaded from your bank. 
+Install as a Rubygem, navigate to the directory your .csv files are in and execute from the command line with 'banco'.
+
+Banco will only accept comma seperated value files (.csv) and will produce a summary for the period uploaded from the file. 
+
+Remove the header line from your downloaded bank statement and Banco will total the incoming & outgoing transactions for the period. Reporting the bottom line aswell as summing up the values for similar transactions. This is achieved by matching the description name, currently set at the first 9 characters of the string, you can change this to be more or less exact.
+
+Hope your numbers are positive !
+code@s33d.co
+https://github.com/s33dco/banco

data/bin/banco

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/banco/viewable'
+require_relative '../lib/banco/get_file'
+require_relative '../lib/banco/reader'
+require_relative '../lib/banco/reporter'
+
+module Banco
+	def self.starter
+		Viewable::prompt
+		file = GetFile.new
+		file.make_name
+		reader = file.name 
+		reader = Reader.new(file.csv_file_name, file.summary_name)
+		reader.read_in_csv_data
+		report = reader.report_name 
+		report = Reporter.new(reader.csv_file_name, reader.report_name, reader.all_from_csv)
+	end
+	Viewable::hello
+	report = starter
+	loop do
+		report.menu
+		answer = gets.chomp.downcase
+		case answer
+		when 'a'
+			print report.transactions_all
+		when 'o'
+			print report.transactions_out
+		when "i"
+			print report.transactions_in
+		when "m"
+			print report.money_out_summary
+		when "n"
+			print report.money_in_summary
+		when "b"
+			print report.bottom_line
+		when "l"
+			report = starter
+		when "s"
+			report.save_summary_to_file
+		when "t"
+			report.save_transactions_to_file
+		when "q"
+			break
+		else
+			report.menu
+		end
+	end
+	Viewable::farewell
+end
+

data/lib/banco/get_file.rb

@@ -0,0 +1,40 @@
+module Banco
+	class GetFile
+		attr_reader :name, :csv_file_name, :summary_name
+
+		def make_name
+			@csv_file_name = gets.chomp.downcase
+			if @csv_file_name == 'q'
+				Viewable::farewell
+				exit
+			else
+				file_checker_cleaner(@csv_file_name)
+				@name = @csv_file_name.split('.').first
+				@doctype = @csv_file_name.split('.').last
+				@summary_name = @name
+				@csv_file_name
+			end
+		end
+
+		def file_checker_cleaner(filename)
+			if filename =~/([^\s]+(\.csv)$)/
+				puts "\nloading #{filename}..."
+			else
+				puts "#{filename} won't work !".center(54)
+				puts "try again or 'q' to exit".center(54)
+				make_name
+			end
+		end
+	end
+end
+
+if __FILE__ == $0
+	file = Banco::GetFile.new()
+	file.make_name
+	puts "\n\n\n"
+	p file.valid_file
+	p file.name
+	p file.summary_name
+end
+
+

data/lib/banco/reader.rb

@@ -0,0 +1,65 @@
+require_relative 'transaction'
+require_relative 'viewable'
+
+require 'csv'
+
+module Banco
+	class Reader
+		include Viewable
+
+		attr_reader :all_from_csv, :report_name, :csv_file_name
+
+		def initialize(csv_file_name, report_name)
+			@csv_file_name = csv_file_name
+			@report_name = report_name
+			@all_from_csv = []
+		end
+
+		def read_in_csv_data
+            begin
+            @csv_row_count = 1
+            CSV.foreach(@csv_file_name) do |row|
+                @all_from_csv << Transaction.new(row[0],row[1],row[2],row[3],row[4],@csv_row_count)
+                @csv_row_count += 1
+                end
+            rescue ArgumentError => e
+                non_numeric_in_csv(e, @csv_row_count)
+                puts "sorted ? ('y' to continue or 'q' to exit)".rjust(54)
+                input = gets.chomp.downcase
+                @all_from_csv = []
+                input == "y" ? retry : Viewable::farewell
+            rescue Errno::ENOENT => e
+                puts "Can't find file #{@csv_file_name} - have another go or (q) quit\n\n"
+                loop do
+	                input = gets.chomp.downcase
+		                case input
+		                when 'q'
+		                	Viewable::farewell
+		                	exit
+		                when /([^\s]+(\.csv)$)/
+							@csv_file_name = input
+							break
+						else	
+		                	puts "\ninvalid file - try again or 'q' to quit\n\n"
+	        			end
+        		end
+        		retry
+        	end
+        end
+
+		def non_numeric_in_csv(exception, row_number)
+            reason = exception.message.split(':')
+            puts "Please check row #{row_number} of #{@csv_file_name},"
+            puts "#{reason.last} should be a numeric value".rjust(54)
+        end
+	end
+end
+
+if __FILE__ == $0
+    reader = Banco::Reader.new("test.csv", "test")
+    reader.read_in_csv_data
+    puts reader.report_name
+    puts reader.csv_file_name
+    puts reader.all_from_csv
+    p reader
+end

data/lib/banco/reporter.rb

@@ -0,0 +1,70 @@
+require_relative 'transaction'
+require_relative 'reader'
+require_relative 'viewable'
+require 'csv'
+
+module Banco
+    class Reporter
+
+        include Viewable
+
+    	attr_reader :all_transactions, :outgoing_trans, :incoming_trans, 
+                    :outgoings, :incomings, :outgoing_total, :incoming_total, 
+                    :name, :csv_file_name
+
+    	def initialize(csv_file_name, report_name, transactions)
+    		@csv_file_name = csv_file_name
+            @name = report_name
+    		@all_transactions = transactions
+            @outgoing_trans = []
+            @incoming_trans = []
+            @outgoings = Hash.new(0)
+            @incomings = Hash.new(0)
+            puts "formating data..."
+            remove_blank_lines
+            split_in_out
+            total_outgoing
+            total_incoming
+            puts "\n\n"
+    	end
+
+
+        def remove_blank_lines
+        	   @all_transactions.delete_if{|trans| trans.moneyin == 0 && trans.moneyout == 0}
+        end
+
+        def split_in_out
+            @outgoing_trans, @incoming_trans = @all_transactions.partition{|trans| trans.moneyin == 0 && trans.moneyout > 0}
+        end
+
+        def total_outgoing
+            @outgoing_trans.each{|trans| @outgoings[trans.description[0..8]] += trans.moneyout}
+            @outgoing_total = @outgoings.values.map.reduce(:+)
+        end
+
+        def total_incoming
+            @incoming_trans.each{|trans| @incomings[trans.description[0..8]] += trans.moneyin}
+            @incoming_total = @incomings.values.map.reduce(:+)
+        end
+    end
+end
+
+
+if __FILE__ == $0
+    reader = Banco::Reader.new("test.csv", "test")
+    reader.read_in_csv_data
+    puts "\n\n\n#all csv data from reader object\n\n"
+    puts "#{reader.all_from_csv}\n\n"
+    report = Banco::Reporter.new(reader.csv_file_name, reader.report_name, reader.all_from_csv)
+    puts "#{report.name} is the Reporter object's name\nReporter object contents below, (3 arrays, 2 hashes):\n\n"
+    puts "\n\nall transactions array\n"
+    p report.all_transactions
+    puts "\n\noutgoings array\n"
+    p report.outgoing_trans  
+    puts "\n\nincomings array\n"
+    p report.incoming_trans
+    puts "\n\nOutgoings hash\n"
+    p report.outgoings
+    puts "\n\nIncomings hash\n"
+    p report.incomings
+end

data/lib/banco/transaction.rb

@@ -0,0 +1,31 @@
+module Banco
+	class Transaction
+		require 'bigdecimal'
+		attr_reader :date, :description, :type, :moneyin, :moneyout, :csv_row_count
+
+		def initialize(date_string, description, type, moneyin, moneyout, csv_row_count)
+			@csv_row_count = csv_row_count
+			@moneyin = convert(moneyin)
+			@moneyout = convert(moneyout)
+			@date = date_string
+			@description = '%-22.22s' % "#{description.upcase}"
+			@type = '%-8.8s' % "#{type.upcase}"
+		end
+
+		def convert(money)
+			money.nil? ? money = BigDecimal('0') : money = BigDecimal(money)
+	    end
+
+		def to_s
+			"#{date} #{type} #{description}"
+		end
+	end
+end
+
+if __FILE__ == $0
+    trans = Banco::Transaction.new("01/01/17", "Supermarket","Purchase", "72.90", "0","1")
+    p trans
+    t = Banco::Transaction.new
+    t.send(:initialize, "02/02/18", "new way", "credit", "0", '111.11','2')    
+    p t
+end

data/lib/banco/viewable.rb

@@ -0,0 +1,180 @@
+module Banco
+    module Viewable
+      def menu
+        puts "Enter :\n"
+        puts "'a' to view all transactions"
+        puts "'o' to view all outgoing transactions"
+        puts "'i' to view all incoming transactions"
+        puts "'m' for money out summary"
+        puts "'n' for money in summary"
+        puts "'b' for the bottom line"
+        puts "'s' to save summaries to file"
+        puts "'t' to save transactions to file"
+        puts "\n'l' to load a new file\n"
+        puts "\nor 'q' to quit\n\n\n"
+      end
+
+      def to_pounds(money)
+        format = sprintf("%10.2f", money.truncate(2))
+        "£#{format}"
+      end
+
+      def dashes
+        "---".center(55,"-")
+      end
+
+      def date_range
+        "(#{self.all_transactions.last.date} - #{self.all_transactions.first.date})"
+      end
+
+      def facts(transactions)
+        "#{transactions.size} transactions for period #{date_range}"
+      end
+
+      def money_out_summary
+        print_summary("Outgoings", self.outgoings, self.outgoing_total)
+      end
+        
+      def money_in_summary
+        print_summary("Incomings", self.incomings, self.incoming_total)
+      end
+
+      def transactions_all
+        output = output_s = ""
+        output << dashes
+        output << "\n"
+        output << "All transactions:\n"
+        output << "#{facts(self.all_transactions)}\n\n"
+        self.all_transactions.each do |trans| 
+          if trans.moneyout == 0
+            output << "#{trans} + #{to_pounds(trans.moneyin)}\n"
+          else
+            output << "#{trans} - #{to_pounds(trans.moneyout)}\n"
+          end
+        end
+        output << dashes
+        output << "\n\n"  
+      end
+
+      def transactions_out
+        output = output_s = ""
+        output << dashes
+        output << "\n"
+        output << "Outgoing Transactions:\n"
+        output << "#{facts(self.outgoing_trans)}\n\n"
+        self.outgoing_trans.each{|trans| output << "#{trans} - #{to_pounds(trans.moneyout)}\n"}
+        output << dashes
+        output << "\n\n"
+      end
+
+      def transactions_in
+        output = output_s = ""
+        output << dashes
+        output << "\n"
+        output << "Incoming Transactions :\n"
+        output << "#{facts(self.incoming_trans)}\n\n"
+        self.incoming_trans.each{|trans| output << "#{trans} + #{to_pounds(trans.moneyin)}\n"}
+        output << dashes
+        output << "\n\n"
+      end
+
+      def print_summary(kind, hash, total)
+        output = output_s = ""
+        output << dashes
+        output << "\n"
+        output << "#{kind} Summary, totals from #{hash.size} different sources :\n"
+        output << "#{date_range}\n"
+        hash.sort_by{|k,v| v}.reverse.each{|k,v| output << "#{k} #{to_pounds(v)}\n".rjust(54)}
+        output << "\n"
+        output << "Total #{kind}: #{to_pounds(total)}\n".rjust(54)
+        output << dashes
+        output << "\n\n"
+      end
+
+      def bottom_line
+        output = output_s = ""
+        output << dashes
+        output << "\n"
+        output << "#{facts(self.all_transactions)}".rjust(54)
+        output << "\n\n"
+        output << "Money In  : #{to_pounds(self.incoming_total)}".rjust(54)
+        output << "\n"
+        output << "Money Out : #{to_pounds(self.outgoing_total)}".rjust(54)
+        output << "\n\n"
+        diff = self.incoming_total - self.outgoing_total
+          if self.outgoing_total > self.incoming_total
+            output << "Outgoings exceed Incomings, DEFICIT of #{to_pounds(diff)}".rjust(54)
+          else
+            output << "Incomings exceed Outgoings, SURPLUS of #{to_pounds(diff)}".rjust(54)
+          end
+        output << "\n"
+        output << dashes
+        output << "\n\n"
+      end
+
+      def self.farewell
+          puts "\n\n"
+          puts "*".center(55,'*')
+          puts "  Banco  ".center(55,'*')
+          puts "  hope your numbers were positive  ".center(55,'*')
+          puts "   code@s33d.co   ".center(55,'*')
+          puts "*".center(55,'*')
+          puts "\n\n\n"
+          exit
+      end
+
+      def self.hello
+          puts "\n\n"
+          puts "Banco will summarize your bank statements.".center(55)
+          puts "import a .csv file for review".center(55)
+          puts "\n\n"
+          puts "the .csv file should have :".center(55)
+          puts "NO headers".center(55)
+          puts "with columns ordered (left to right)".center(55)
+          puts "date - description - type - money in - money out".center(55)
+          puts "all additional columns will be ignored".center(55)
+      end
+
+      def self.prompt
+          puts "\n\n"
+          puts "Enter the name of you .csv file to review".center(54)
+          puts "(use 'test.csv' for the test file)".center(54)
+          puts "or 'q' to quit...".center(55)
+          puts "\n\n"
+          end 
+
+      def save_summary_to_file(to_file="#{self.name}_summary.txt")
+          File.open(to_file, "w") do |file|
+            t = Time.now
+            file.puts t.strftime("\n\nprinted : %d %b %y at %I:%M%P")
+            file.puts "summarized by Banco from #{self.csv_file_name}"
+            file.puts "\n"
+            file.puts self.money_out_summary
+            file.puts "\n"
+            file.puts self.money_in_summary
+            file.puts "\n"
+            file.puts self.bottom_line
+            file.puts "\n"
+            file.puts "code@s33d.co".rjust(54)
+          end
+          puts "\n\nfile saved as #{self.name}_summary.txt\n\n"
+      end
+
+      def save_transactions_to_file(to_file="#{self.name}_transactions.txt")
+          File.open(to_file, "w") do |file|
+            t = Time.now
+            file.puts t.strftime("\n\nprinted : %d %b %y at %I:%M%P")
+            file.puts "summarized by Banco from #{self.csv_file_name}"
+            file.puts "\n"
+            file.puts self.transactions_out
+            file.puts "\n"
+            file.puts self.transactions_in
+            file.puts "\n"
+            file.puts self.bottom_line
+            file.puts "\n"
+            file.puts "code@s33d.co".rjust(54)
+          end
+          puts "\n\nfile saved as #{self.name}_transactions.txt\n\n"
+      end
+  end
+end

data/spec/banco/reader_spec.rb

@@ -0,0 +1,14 @@
+require 'banco/reader'
+module Banco
+	describe Reader do 
+		before do
+			csv_file_name = "test.csv"
+			report_name = "test"
+			@testreader = Banco::Reader.new(csv_file_name, report_name)
+			@testreader.read_in_csv_data
+		end
+		it "should produce an array for all rows on csv file" do
+			expect(@testreader.all_from_csv.length).to eq(10)
+		end
+	end
+end

data/spec/banco/reporter_spec.rb

@@ -0,0 +1,54 @@
+require 'banco/reporter'
+require 'banco/reader'
+module Banco
+	describe Reporter do 
+		before do
+			csv_file_name = "test.csv"
+			report_name = "test"
+			@testreader = Banco::Reader.new(csv_file_name, report_name)
+			@testreader.read_in_csv_data
+			@tester = Banco::Reporter.new('test.csv', 'test', @testreader.all_from_csv)
+			@tester.remove_blank_lines
+            @tester.split_in_out
+            @tester.total_outgoing
+            @tester.total_incoming
+		end
+
+		it "should remove transactions with zero values (moneyin / moneyout)" do
+			expect(@tester.all_transactions.size).to eq(8)
+		end
+		
+
+		it "should produce an array of incoming transactions" do
+		    expect(@tester.incoming_trans.size).to eq(4)
+		end
+
+		it "should produce an array of outgoing transactions" do
+			expect(@tester.outgoing_trans.size).to eq(4)
+		end
+
+		it "should produce a hash of outgoing transactions" do
+			expect(@tester.outgoings.size).to eq(2)
+		end
+
+		it "should produce a hash of incoming transactions" do
+			expect(@tester.incomings.size).to eq(2)
+		end
+
+		it "should sum incoming transactions by matching description string" do
+			expect(@tester.incomings['INCOMING2']).to eq(183.34)
+		end
+
+		it "should sum outgoing transactions by matching description string" do
+			expect(@tester.outgoings['OUTGOING2']).to eq(182.68)
+		end
+
+		it "should sum total incoming transactions" do
+			expect(@tester.incoming_total).to eq(321.58)
+		end
+
+		it "should sum total outgoing transactions" do
+			expect(@tester.outgoing_total).to eq(320.92)
+		end
+	end
+end

data/spec/banco/transaction_spec.rb

@@ -0,0 +1,47 @@
+require 'banco/transaction'
+
+module Banco
+	describe Transaction do
+		before do 
+			@trans1 = Transaction.new("12/01/17","some transaction", "credit", "57.91", "0.00", "1")
+			@trans2 = Transaction.new("13/01/17","some other transaction", "debit", "0.00", "57.91",'2')
+		end
+
+		# it "Should convert money in values to pence" do
+		#  	expect(@trans1.moneyin).to eq(5791)
+		# end
+
+		# it "Should convert money out values to pence" do
+		# 	expect(@trans2.moneyout).to eq(5791)
+		# end
+
+		it "Should have a description string of 22 characters (upcase)" do
+			expect(@trans2.description).to eq("SOME OTHER TRANSACTION")
+			expect(@trans1.description).to eq("SOME TRANSACTION      ")
+		end
+
+		it "Should have a type string upcased and 8 characters long" do
+			expect(@trans2.type).to eq("DEBIT   ")
+		end
+		
+		it "Should have a date string" do
+			expect(@trans1.date).to eq("12/01/17")
+		end
+
+		it "Should have a row number" do
+			expect(@trans2.csv_row_count).to eq("2")
+		end
+
+		it "should have a to_s of all date description type" do
+			expect(@trans1.to_s).to eq("12/01/17 CREDIT   SOME TRANSACTION      ")
+		end
+
+		it "convert empty strings in money columns to integers" do
+			expect(@trans1.moneyout).to eq(0)
+		end
+
+		it "convert empty strings in money columns to integers" do
+			expect(@trans2.moneyin).to eq(0)
+		end
+	end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: banco
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- s33d
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description: "Welcome to Banco !\n\nBanco has been developed to summarize statements
+  downloaded from your bank. \nInstall as a Rubygem, navigate to the directory your
+  .csv files are in and execute from the command line with 'banco'.\n\nBanco will
+  only accept comma seperated value files (.csv) and will produce a summary for the
+  period uploaded from the file. \n\nRemove the header line from your downloaded bank
+  statement and Banco will total the incoming & outgoing transactions for the period.
+  Reporting the bottom line aswell as summing up the values for similar transactions.
+  This is achieved by matching the description name, currently set at the first 9
+  characters of the string, you can change this to be more or less exact.\n\nHope
+  your numbers are positive !\ncode@s33d.co\nhttps://github.com/s33dco/banco"
+email: code@s33d.co
+executables:
+- banco
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README
+- bin/banco
+- lib/banco/get_file.rb
+- lib/banco/reader.rb
+- lib/banco/reporter.rb
+- lib/banco/transaction.rb
+- lib/banco/viewable.rb
+- spec/banco/reader_spec.rb
+- spec/banco/reporter_spec.rb
+- spec/banco/transaction_spec.rb
+homepage: https://github.com/s33dco/banco
+licenses:
+- MIT
+metadata: {}
+post_install_message: Thanks for installing, hope your numbers are positive!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Make your bank's .csv file statement more readable
+test_files:
+- spec/banco/reader_spec.rb
+- spec/banco/reporter_spec.rb
+- spec/banco/transaction_spec.rb