bank_scrap 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68b5810bd6747ebe4b3f073747092768f5d16019
-  data.tar.gz: 413f9dc6ab905d1c5ec32de0bd3bb76a0a84025f
+  metadata.gz: 0a37e0cd7f424b6fcd7be561a34ea7990060f41a
+  data.tar.gz: 5f14a99961d2b82846a51c55d7df5f817e2e87b5
 SHA512:
-  metadata.gz: 6fc2147bb41666fcfc2cceb6f571dd7ae517ad398c117b38c650c8119b78c450b32471e9f98c6569c1e934ecd02985a6b31ebf2b70661c533a9c943b8e171de2
-  data.tar.gz: fa7b34b93ef33f86f005ba79f6d46533b15c4eda928945d45eb08307e6b64946fec77dd6eaba08f4c93907fe889e416d4310372179aed311c97ac8cdaea78853
+  metadata.gz: ef3a7d2ccc0312098bb22a5e70fbf5a31f768cd9c72fbe208691965886aff8d143a7c1532766d68fff2cb8487a961f05fabf828d6a9fdd5849d751c066a7b55c
+  data.tar.gz: b92c5292be30ec7f56e9e5e361e8d6be65c4528d4f33fc24bedfe91493f3fe697cf164c14798c6517b331083c15c4db932bd27ca5d284334886e4c9e5d46f27f

data/README.md

@@ -2,13 +2,28 @@
 
 Ruby gem to extract balance and transactions from banks. You can use it either as command line tool or as a library.
 
-The aim of this project is to build a library which interacts with some of the most used banks. We already know how boring is to look for your balance on the web, so let's do it with the command line.
-
 Feel free to contribute and add your bank if it isn't supported.
 
 ## Supported banks
 - Bankinter
-- BBVA
+- BBVA (only balance, transactions soon)
+
+Work in progress:
+- ING
+
+Interested in any other bank? Open a new Issue and we'll try to help.
+ 
+## Background and motivation
+
+Most banks don't offer public APIs and the only way to access your data (balance and transactions) is through their websites... and most bank websites are a f*cking nightmare.
+
+We are developers and we don't want to waste time doing things we are able to automate. Having to perform 20 clicks in an awful website just to check how much money we have is not something we like.
+
+There are two approaches to solve this problem: 
+- Web scraping on the bank's site.
+- Reverse engineering the bank's mobile app to use the same API the app uses.
+
+Bankscrap uses both methods depending on the bank.
 
 ## Requirements
 
@@ -16,31 +31,52 @@ Some banks needs a JavaScript runtime in order to work. So if you find an error
 
 ## Installation
 
-Add this line to your application's Gemfile:
+### From Git
 
-```ruby
-gem 'bank_scrap'
-```
+You can check out the latest source from git:
+
+    git clone git://github.com/ismaGNU/bank_scrap
+
+### From RubyGems
 
-And then execute:
+Installation from RubyGems:
 
-    $ bundle
+    gem install bank_scrap
 
-Or install it yourself as:
+Or, if you're using Bundler, just add the following to your Gemfile:
 
-    $ gem install bank_scrap
+    gem 'bank_scrap'
 
 ## Usage
 
+### From terminal
 Retrieve balance account
 
     $ bank_scrap balance BANK_NAME --user YOUR_USER --password YOUR_PASSWORD
 
 BANK_NAME should be in underscore case (`bankinter`, `bbva`).
 
+### From Ruby code
+
+You can also use this gem from your own app as library. To do so first you must initialize a Bankscrapper::Bank object
+
+```ruby
+require 'bank_scrap'
+@bank = BankScrap::Bbva.new(YOUR_BBVA_USER, YOUR_BBVA_PASSWORD)
+```
+
+(Replace Bbva with your own bank)
+
+Now you can fetch your balance:
+
+```ruby
+@bank.get_balance
+```
+
+
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/bankscrap/fork )
+1. Fork it ( https://github.com/ismaGNU/bank_scrap/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/bank_scrap/banks/bankinter.rb

@@ -1,4 +1,3 @@
-
 require 'nokogiri'
 require 'execjs'
 

data/lib/bank_scrap/banks/bbva.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module BankScrap
   class Bbva < Bank
     BASE_ENDPOINT    = 'https://bancamovil.grupobbva.com'

data/lib/bank_scrap/version.rb

@@ -1,3 +1,3 @@
 module BankScrap
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/bank_scrap.rb

@@ -2,9 +2,9 @@ require 'bank_scrap/version'
 require 'bank_scrap/cli'
 require 'bank_scrap/bank'
 
-# TODO: load banks dynamically
-require 'bank_scrap/banks/bankinter'
-require 'bank_scrap/banks/bbva'
-
 module BankScrap
+  # autoload only requires the file when the specified
+  # constant is used for the first time
+  autoload :Bankinter,  'bank_scrap/banks/bankinter'
+  autoload :Bbva,       'bank_scrap/banks/bbva'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bank_scrap
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ismael Sánchez
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-01 00:00:00.000000000 Z
+date: 2014-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler