bankscrap 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7567c87bd47ae9505b4abaa485cae8442dd41b40
-  data.tar.gz: 9e5a1bdc25a930b5e8340bd65be5f1302d0a7da0
+  metadata.gz: e2142881eec4c8dcc412763eb07d3c84cc33d1fe
+  data.tar.gz: a23a8c1e02e54605ca8789a601f7774eb5712bca
 SHA512:
-  metadata.gz: 63da5ae6218c554d0ce6d745cdf252f18ecd2bfa137bd8a06d24018d108802ba02907d97ae9e986ea89de9274e683a5f15b54fdf9696e4258307746db87edfab
-  data.tar.gz: 542a627dfcc461df1ad682ffed3af835345e8b85b8c521dede4ce03690fba24f204c97f671057f023b1897a2ad5a0b5b1004c828c07853c5c377b1dfe48ad91a
+  metadata.gz: 5c5a268c46975640c1d851fc860d863f6bbcba8450d0992ec6f23a4f62b6973fe8734ac05169593bfa5ef9d7d15bd3787dc4feb5d7ec8f534453052a54ce5684
+  data.tar.gz: e8dbc234ed3712d90e6b0bbecbb4fe40373de20b17416a5ba040424e1791a421413f4139d46ae6ccc8cde9e989b0ea9cc2b0d643b37ff1f2b56055ed65ef312c

data/README.md

@@ -77,29 +77,37 @@ Replace 01/01/1980 with your actual birthday.
 
 #### Transactions with date range
 
-    $ bankscrap transactions YourBank --user YOUR_BANK_USER --password YOUR_BANK_PASSWORD --extra=from:01-01-2015 to:01-02-2015
+    $ bankscrap transactions YourBank --user YOUR_BANK_USER --password YOUR_BANK_PASSWORD --from 01-01-2015 --to 01-02-2015
 
 ---
 
 By default it will use your first bank account, if you want to fetch transactions for a different account you can use this syntax:
 
-    $ bankscrap transactions YourBank your_iban --user YOUR_DNI --password YOUR_PASSWORD
+    $ bankscrap transactions YourBank --iban "your_iban" --user YOUR_DNI --password YOUR_PASSWORD
 
 If you don't want to pass your user and password everytime you can define them in your .bash_profile by adding:
 
     export BANK_SCRAP_USER=YOUR_BANK_USER
     export BANK_SCRAP_PASSWORD=YOUR_BANK_PASSWORD
 
+#### Export transactions to CSV
+
+    $ bankscrap transactions YourBank --user YOUR_BANK_USER --password YOUR_BANK_PASSWORD --format CSV [--output ./my_transactions.csv]
+
+Currently only CSV is supported. The output parameter is optional, by default `transactions.csv` is used.
+
 ### From Ruby code
 
 You can also use this gem from your own app as library. To do so first you must initialize a BankScrap::Bank object
 
 
 ```ruby
-require 'bankscrap-bbva'
 # BBVA
+require 'bankscrap-bbva'
 bbva = Bankscrap::BBVA::Bank.new(YOUR_BBVA_USER, YOUR_BBVA_PASSWORD)
+
 # ING
+require 'bankscrap-ing'
 ing = Bankscrap::ING::Bank.new(YOUR_DNI, YOUR_ING_PASSWORD, extra_args: {"birthday" => "dd/mm/yyyy"})
 ```
 

data/lib/bankscrap/cli.rb

@@ -8,6 +8,10 @@ module Bankscrap
       option :password, default: ENV['BANKSCRAP_PASSWORD']
       option :log,      default: false
       option :debug,    default: false
+      option :iban,     default: nil
+
+      option :format
+      option :output
 
       # Some bank needs more input, like birthday, this would go here
       # Usage:
@@ -29,21 +33,18 @@ module Bankscrap
 
     desc 'transactions BANK', "get account's transactions"
     shared_options
-    def transactions(bank, iban = nil)
+    options from: :string, to: :string
+    def transactions(bank)
       assign_shared_options
 
-      begin
-        start_date = @extra_args.key?('from') ? Date.strptime(@extra_args['from'], '%d-%m-%Y') : nil
-        end_date = @extra_args.key?('to') ? Date.strptime(@extra_args['to'], '%d-%m-%Y') : nil
-      rescue ArgumentError
-        say 'Invalid date format. Correct format d-m-Y', :red
-      end
+      start_date = parse_date(options[:from]) if options[:from]
+      end_date = parse_date(options[:to]) if options[:to]
 
       initialize_client_for(bank)
 
-      account = iban ? @client.account_with_iban(iban) : @client.accounts.first
+      account = @iban ? @client.account_with_iban(@iban) : @client.accounts.first
 
-      if !start_date.nil? && !end_date.nil?
+      if start_date && end_date
         if start_date > end_date
           say 'From date must be lower than to date', :red
           exit
@@ -54,8 +55,9 @@ module Bankscrap
         transactions = account.transactions
       end
 
-      say "Transactions for: #{account.description} (#{account.iban})", :cyan
+      export_to_file(transactions, options[:format], options[:output]) if options[:format]
 
+      say "Transactions for: #{account.description} (#{account.iban})", :cyan
       transactions.each do |transaction|
         say transaction.to_s, (transaction.amount > Money.new(0) ? :green : :red)
       end
@@ -66,6 +68,7 @@ module Bankscrap
     def assign_shared_options
       @user       = options[:user]
       @password   = options[:password]
+      @iban       = options[:iban]
       @log        = options[:log]
       @debug      = options[:debug]
       @extra_args = options[:extra]
@@ -84,5 +87,25 @@ module Bankscrap
     rescue NameError
       raise ArgumentError.new("Invalid bank name. Did you mean \"#{bank_name.upcase}\"?")
     end
+
+    def parse_date(string)
+      Date.strptime(string, '%d-%m-%Y')
+    rescue ArgumentError
+      say 'Invalid date format. Correct format d-m-Y (eg: 31-12-2016)', :red
+      exit
+    end
+
+    def export_to_file(data, format, path)
+      exporter(format, path).write_to_file(data)
+    end
+
+    def exporter(format, path)
+      case format.downcase
+      when 'csv' then BankScrap::Exporter::Csv.new(path)
+      else
+        say 'Sorry, file format not supported.', :red
+        exit
+      end
+    end
   end
 end

data/lib/bankscrap/exporters/csv.rb

@@ -0,0 +1,20 @@
+require 'csv'
+
+module BankScrap
+  module Exporter
+    class Csv
+      HEADERS = %w(Date Description Amount).freeze
+
+      def initialize(output = nil)
+        @output = output || 'transactions.csv'
+      end
+
+      def write_to_file(data)
+        CSV.open(@output, 'wb') do |csv|
+          csv << HEADERS
+          data.each { |line| csv << line.to_a }
+        end
+      end
+    end
+  end
+end

data/lib/bankscrap/transaction.rb

@@ -14,6 +14,10 @@ module Bankscrap
       "#{effective_date.strftime('%d/%m/%Y')}   #{description.ljust(45)} #{amount.format.rjust(20)}"
     end
 
+    def to_a
+      [effective_date.strftime('%d/%m/%Y'), description, amount]
+    end
+
     private
 
     def inspect_attributes

data/lib/bankscrap/version.rb

@@ -1,3 +1,3 @@
 module Bankscrap
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.1'.freeze
 end

data/lib/bankscrap.rb

@@ -9,3 +9,4 @@ require_relative 'bankscrap/bank'
 require_relative 'bankscrap/account'
 require_relative 'bankscrap/investment'
 require_relative 'bankscrap/transaction'
+require_relative 'bankscrap/exporters/csv'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bankscrap
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Javier Cuevas
@@ -146,6 +146,7 @@ files:
 - lib/bankscrap/bank.rb
 - lib/bankscrap/cli.rb
 - lib/bankscrap/config.rb
+- lib/bankscrap/exporters/csv.rb
 - lib/bankscrap/investment.rb
 - lib/bankscrap/locale/en.yml
 - lib/bankscrap/transaction.rb