bankscrap 1.0.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0cc99604f8b8921d6ecbf987686300f460113d5
-  data.tar.gz: d2fa8d351088f6386753b955606724f0e345c67a
+  metadata.gz: 7e9fea8d54632ad5388ccd2cd6075fbe0dd69bcc
+  data.tar.gz: 681e5691f14fbaa556502d5da1f16d4dff3b27be
 SHA512:
-  metadata.gz: 564a3bb5e22a61f54254fe82f853a2b4bfcf3f356c6930940241e25d028d20bae5467ab0db06faaadfce30c7c0fa79e699d9c31c54d1f6126e09d64edd3b6927
-  data.tar.gz: 8c51bff3b08ab398e3b30d052dceff1d181dc1ae9b081f70f188c2044832e997d522f174e127a2ae7081dbf478344fde943f135bb0e52ebb5d0587ab399183e1
+  metadata.gz: 23d25b06fbb967b07673077bb58cf8c214e1ab403fedfd511362c39d198923232c7d00473ae30b5b0731a45e3112e887ab23c696c4744405def72c3c4456e265
+  data.tar.gz: d828191804b5f7e55ff58cd78da48ecaac34bb8687b01cb1459b2d42b5b55750ec3cc42a400e84772548255ef9a98e5cc8e1fb4b2af19e9eab1e4990072b41ae

data/README.md

@@ -59,42 +59,47 @@ Note that you only need to install the gem for your selected bank – the main g
 
 ###### BBVA
 
-    $ bankscrap balance YourBank --user YOUR_BANK_USER --password YOUR_BANK_PASSWORD
+    $ bankscrap balance YourBank --credentials=user:YOUR_BANK_USER password:YOUR_BANK_PASSWORD
 
 ###### ING Direct
 ING needs one more argument: your birthday.
 
-    $ bankscrap balance ING --user YOUR_DNI --password YOUR_PASSWORD --extra=birthday:01/01/1980
+    $ bankscrap balance ING --credentials=user:YOUR_DNI password:YOUR_BANK_PASSWORD birthday:01/01/1980
 
 Replace 01/01/1980 with your actual birthday.
 
 #### Transactions for last 30 days
 ###### BBVA
 
-    $ bankscrap transactions BBVA --user YOUR_BBVA_USER --password YOUR_BBVA_PASSWORD
+    $ bankscrap transactions BBVA --credentials=user:YOUR_BANK_USER password:YOUR_BANK_PASSWORD
 
 ###### ING Direct
 
-    $ bankscrap transactions ING --user YOUR_DNI --password YOUR_PASSWORD --extra=birthday:01/01/1980
+    $ bankscrap transactions ING --credentials=nif:YOUR_DNI password:YOUR_BANK_PASSWORD birthday:01/01/1980
 
 #### Transactions with date range
 
-    $ bankscrap transactions YourBank --user YOUR_BANK_USER --password YOUR_BANK_PASSWORD --from 01-01-2015 --to 01-02-2015
+    $ bankscrap transactions YourBank --credentials=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 --iban "your_iban" --user YOUR_DNI --password YOUR_PASSWORD
+    $ bankscrap transactions YourBank --iban "your_iban" --credentials=user:YOUR_BANK_USER password:YOUR_BANK_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 BANKSCRAP_[BANK_NAME]_USER=YOUR_BANK_USER
+    export BANKSCRAP_[BANK_NAME]_PASSWORD=YOUR_BANK_USER
+    export BANKSCRAP_[BANK_NAME]_ANY_OTHER_CREDENTIAL=ANY_OTHER_CREDENTIAL
+
+eg: 
+    export BANKSCRAP_BBVA_NET_CASH_USER=YOUR_BANK_USER
+
 
 #### Export transactions to CSV
 
-    $ bankscrap transactions YourBank --user YOUR_BANK_USER --password YOUR_BANK_PASSWORD --format CSV [--output ./my_transactions.csv]
+    $ bankscrap transactions YourBank --credentials=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.
 
@@ -106,11 +111,11 @@ You can also use this gem from your own app as library. To do so first you must
 ```ruby
 # BBVA
 require 'bankscrap-bbva'
-bbva = Bankscrap::BBVA::Bank.new(YOUR_BBVA_USER, YOUR_BBVA_PASSWORD)
+bbva = Bankscrap::BBVA::Bank.new(user: YOUR_BBVA_USER, password: YOUR_BBVA_PASSWORD)
 
 # ING
 require 'bankscrap-ing'
-ing = Bankscrap::ING::Bank.new(YOUR_DNI, YOUR_ING_PASSWORD, extra_args: {"birthday" => "dd/mm/yyyy"})
+ing = Bankscrap::ING::Bank.new(nif: YOUR_NIF, password: YOUR_ING_PASSWORD, birthday: "dd/mm/yyyy")
 ```
 
 

data/generators/templates/README.md.tt

@@ -1,6 +1,6 @@
 # Bankscrap::<%= module_name %>
 
-Bankscrap adapter for <%= bank_name %>
+[Bankscrap](https://github.com/bankscrap/bankscrap) adapter for <%= bank_name %>.
 
 **TODO**: write a proper description for your adapter.
 
@@ -26,12 +26,12 @@ Or install it yourself as:
 ### From terminal
 #### Bank account balance
 
-    $ bankscrap balance <%= module_name %> --user YOUR_USER --password YOUR_PASSWORD --extra=company_code:YOUR_COMPANY_CODE
+    $ bankscrap balance <%= module_name %> --credentials=user:YOUR_USER --password:YOUR_PASSWORD --any_other_credential:ANY_OTHER_CREDENTIAL
 
 
 #### Transactions
 
-    $ bankscrap transactions <%= module_name %> --user YOUR_USER --password YOUR_PASSWORD --extra=company_code:YOUR_COMPANY_CODE
+    $ bankscrap transactions <%= module_name %> --credentials=user:YOUR_USER --password:YOUR_PASSWORD --any_other_credential:ANY_OTHER_CREDENTIAL
 
 ---
 
@@ -39,11 +39,9 @@ For more details on usage instructions please read [Bankscrap readme](https://gi
 
 ### From Ruby code
 
-**TODO**: check if your bank adapter needs more extra_args for the initializer.
-
 ```ruby
 require '<%= gem_name %>'
-<%= bank_name.underscore %> = Bankscrap::<%= module_name %>::Bank.new(YOUR_USER, YOUR_PASSWORD, extra_args: {arg: EXTRA_ARG_1})
+<%= bank_name.underscore %> = Bankscrap::<%= module_name %>::Bank.new(user: YOUR_USER, password: YOUR_PASSWORD, any_other_credential: ANY_OTHER_CREDENTIAL)
 ```
 
 

data/generators/templates/lib/bankscrap/%bank_name_dasherized%/bank.rb.tt

@@ -11,23 +11,20 @@ module Bankscrap
       # ACCOUNTS_ENDPOINT     = '/accounts'.freeze
       # TRANSACTIONS_ENDPOINT = '/transactions'.freeze
 
-      def initialize(user, password, log: false, debug: false, extra_args: nil)
-        @user = user
-        @password = password
-        @log = log
-        @debug = debug
-        # @extra_arg1 = extra_args.with_indifferent_access['extra_arg1']
+      # TODO: change this for the proper credentials required in your adapter.
+      # It can be anything (user, birthday, ID, whatever you need).
+      REQUIRED_CREDENTIALS  = [:user, :password, :any_other_credential]
 
-        initialize_connection
+      def initialize(credentials = {})
+        super do
+          # Here you can do further processing of the received credentials
+          # or add custom headers to the HTTP client
 
-        # Optional Custom headers
-        # user_agent = SecureRandom.hex(32).upcase + ';Android;LGE;Nexus 5;1080x1776;Android;5.1.1;BMES;4.4;xxhd'
-        # add_headers(
-        #   'User-Agent' => user_agent
-        # )
-
-        login
-        super
+          # user_agent = SecureRandom.hex(32).upcase + ';Android;LGE;Nexus 5;1080x1776;Android;5.1.1;BMES;4.4;xxhd'
+          # add_headers(
+          #   'User-Agent' => user_agent
+          # )
+        end
       end
 
       # Fetch all the accounts for the given user

data/lib/bankscrap/account.rb

@@ -1,10 +1,15 @@
 module Bankscrap
   class Account
     include Utils::Inspectable
-
-    attr_accessor :bank, :id, :name, :balance, :currency, :available_balance, :description, :transactions, :iban, :bic
+    
+    attr_accessor :bank, :id, :name, :balance, 
+                  :available_balance, :description, 
+                  :transactions, :iban, :bic
 
     def initialize(params = {})
+      raise NotMoneyObjectError.new(:balance) unless params[:balance].is_a?(Money)
+      raise NotMoneyObjectError.new(:available_balance) unless params[:available_balance].is_a?(Money)
+
       params.each { |key, value| send "#{key}=", value }
     end
 
@@ -16,10 +21,14 @@ module Bankscrap
       bank.fetch_transactions_for(self, start_date: start_date, end_date: end_date)
     end
 
+    def currency
+      balance.try(:currency)
+    end
+
     private
 
     def inspect_attributes
-      %i(id name balance currency available_balance description iban bic)
+      %i(id name balance available_balance description iban bic)
     end
   end
 end

data/lib/bankscrap/bank.rb

@@ -7,18 +7,46 @@ module Bankscrap
                      'like Gecko) Chrome/18.0.1025.166 Mobile Safari/535.19'.freeze
     attr_accessor :headers, :accounts, :investments
 
-    def initialize(_user, _password, log: false, debug: false, extra_args: nil)
+    REQUIRED_CREDENTIALS = [:user, :password] 
+
+    class MissingCredential < ArgumentError; end
+
+    def initialize(credentials = {})
+      # Assign required credentials as env vars. 
+      # If empty, use ENV vars as fallback:
+      # BANKSCRAP_MY_BANK_USER, BANKSCRAP_MY_BANK_PASWORD, etc.
+      self.class::REQUIRED_CREDENTIALS.each do |field|
+        value = credentials.with_indifferent_access[field] || ENV["#{env_vars_prefix}_#{field.upcase}"]
+
+        if value.blank?
+          raise MissingCredential, "Missing credential: '#{field}'"
+        else
+          instance_variable_set("@#{field}", value)
+        end
+      end
+
+      initialize_http_client
+
+      # Bank adapters should use the yield block to do any required processing of credentials
+      yield if block_given?
+
+      login
       @accounts = fetch_accounts
+
+      # Not all the adapters have support for investments
+      if self.respond_to?(:fetch_investments)
+        @investments = fetch_investments
+      end
     end
 
     # Interface method placeholders
 
-    def fetch_accounts
-      raise "#{self.class} should implement a fetch_account method"
+    def login
+      raise "#{self.class} should implement a login method"
     end
 
-    def fetch_investments
-      raise "#{self.class} should implement a fetch_investment method"
+    def fetch_accounts
+      raise "#{self.class} should implement a fetch_account method"
     end
 
     def fetch_transactions_for(*)
@@ -64,19 +92,27 @@ module Bankscrap
       @http.get(url).body
     end
 
-    def initialize_connection
+    def initialize_http_client
       @http = Mechanize.new do |mechanize|
         mechanize.user_agent = WEB_USER_AGENT
         mechanize.agent.http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        mechanize.log = Logger.new(STDOUT) if @debug
-        # mechanize.set_proxy 'localhost', 8888
+        mechanize.log = Logger.new(STDOUT) if Bankscrap.debug
+
+        if Bankscrap.proxy
+          mechanize.set_proxy Bankscrap.proxy[:host], Bankscrap.proxy[:port]
+        end
       end
 
       @headers = {}
     end
 
     def log(msg)
-      puts msg if @log
+      puts msg if Bankscrap.log
+    end
+
+    # Prefix for env vars used to store credentials
+    def env_vars_prefix
+      self.class.parent.name.underscore.upcase.gsub('/', '_')
     end
   end
 end

data/lib/bankscrap/cli.rb

@@ -8,22 +8,15 @@ end
 module Bankscrap
   class CLI < Thor
     def self.shared_options
-      option :user,     default: ENV['BANKSCRAP_USER']
-      option :password, default: ENV['BANKSCRAP_PASSWORD']
-      option :log,      default: false
-      option :debug,    default: false
-      option :iban,     default: nil
-
+      option :credentials, default: {}, type: :hash
+      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:
-      # bankscrap balance BANK_NAME --extra=birthday:01/12/1980
-      option :extra, type: :hash, default: {}
     end
 
-    desc 'balance BANK', "get accounts' balance"
+    desc 'balance BankName', "get accounts' balance"
     shared_options
     def balance(bank)
       assign_shared_options
@@ -31,11 +24,14 @@ module Bankscrap
 
       @client.accounts.each do |account|
         say "Account: #{account.description} (#{account.iban})", :cyan
-        say "Balance: #{account.balance}", :green
+        say "Balance: #{account.balance.format}", :green
+        if account.balance != account.available_balance
+          say "Available: #{account.available_balance.format}", :yellow
+        end
       end
     end
 
-    desc 'transactions BANK', "get account's transactions"
+    desc 'transactions BankName', "get account's transactions"
     shared_options
     options from: :string, to: :string
     def transactions(bank)
@@ -74,17 +70,17 @@ module Bankscrap
     private
 
     def assign_shared_options
-      @user       = options[:user]
-      @password   = options[:password]
-      @iban       = options[:iban]
-      @log        = options[:log]
-      @debug      = options[:debug]
-      @extra_args = options[:extra]
+      @credentials  = options[:credentials]
+      @iban         = options[:iban]
+      @log          = options[:log]
+      @debug        = options[:debug]
     end
 
     def initialize_client_for(bank_name)
       bank_class = find_bank_class_for(bank_name)
-      @client = bank_class.new(@user, @password, log: @log, debug: @debug, extra_args: @extra_args)
+      Bankscrap.log = @log
+      Bankscrap.debug = @debug
+      @client = bank_class.new(@credentials)
     end
 
     def find_bank_class_for(bank_name)

data/lib/bankscrap/transaction.rb

@@ -2,11 +2,12 @@ module Bankscrap
   class Transaction
     include Utils::Inspectable
 
-    attr_accessor :id, :amount, :currency,
-                  :effective_date, :description,
+    attr_accessor :id, :amount, :description, :effective_date,
                   :balance, :account
 
     def initialize(params = {})
+      raise NotMoneyObjectError.new(:amount) unless params[:amount].is_a?(Money)
+
       params.each { |key, value| send "#{key}=", value }
     end
 
@@ -18,14 +19,14 @@ module Bankscrap
       [effective_date.strftime('%d/%m/%Y'), description, amount]
     end
 
+    def currency
+      amount.currency
+    end
+
     private
 
     def inspect_attributes
-      [
-        :id, :amount, :currency,
-        :effective_date, :description,
-        :balance
-      ]
+      [ :id, :amount, :effective_date, :description, :balance ]
     end
   end
 end

data/lib/bankscrap/version.rb

@@ -1,3 +1,3 @@
 module Bankscrap
-  VERSION = '1.0.4'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/lib/bankscrap.rb

@@ -10,3 +10,22 @@ require_relative 'bankscrap/account'
 require_relative 'bankscrap/investment'
 require_relative 'bankscrap/transaction'
 require_relative 'bankscrap/exporters/csv'
+
+module Bankscrap
+  class << self
+    attr_accessor :log
+    attr_accessor :debug
+    attr_accessor :proxy
+  end
+
+  class NotMoneyObjectError < TypeError
+    def initialize(attribute)
+      super("#{attribute} should be a Money object")
+    end
+  end
+
+
+  self.log = false
+  self.debug = false
+  # self.proxy = {host: 'localhost', port: 8888}
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bankscrap
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Javier Cuevas
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-02 00:00:00.000000000 Z
+date: 2016-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,6 +73,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.39.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +164,6 @@ files:
 - generators/templates/lib/%gem_name%.rb.tt
 - generators/templates/lib/bankscrap/%bank_name_dasherized%/bank.rb.tt
 - generators/templates/lib/bankscrap/%bank_name_dasherized%/version.rb.tt
-- lib/.DS_Store
 - lib/bankscrap.rb
 - lib/bankscrap/account.rb
 - lib/bankscrap/bank.rb
@@ -182,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Get your bank account details.