bankscrap 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebfe09ab93a020eff2ab36510dee31dd4bd3b50b
-  data.tar.gz: 197c3f50a4465a30521b40a053acc63d8319200d
+  metadata.gz: 27417d295cb4b8c1f6c6d5e21a45ae62a5c49627
+  data.tar.gz: 630ec94eeb87fa8981f73b2cea65562e1356a39f
 SHA512:
-  metadata.gz: aaf90b7decc33ef007be0fd0579e56fd2ffd7f3d4dbc61bc7423b9444c1209df1fa3ef3adef8b82e332f6a7948d742d62d7107aa913bc595423cffb30d6e0a9e
-  data.tar.gz: 1ff9929c99f38501222bb1efb5b8165d5b7f1e265967f6bf5507b082db94924843d935836c21f6797eaf0f31f88de07210182d16d7c3c47f7aebfc16470befb4
+  metadata.gz: 61536463748cd80fa26ed4abe26558b86cdcc7f2f475e314a179578d7c439efbf1dfea0539c48f64c614ac4bff1d5191f54db390fd8d809ab5daad92bd6e28ab
+  data.tar.gz: 31c6dbcd704f6a5cae04367551c48b4796772f35362040d2bf20b0d346bac043bef5071f37d6fbce54840e789fa25eabb5b849c74c732ce246c761eaf9ea7d12

data/README.md

@@ -1,4 +1,4 @@
-# Bankscrap
+# 💸 Bankscrap 💸 
 
 [![](http://188.166.39.57:3000/badge.svg)](http://188.166.39.57:3000)
 
@@ -8,7 +8,8 @@ Feel free to contribute and add your bank if it isn't supported.
 
 ## Supported banks
 
-* **BBVA**: [bankscrap-bbva](https://github.com/bankscrap/bankscrap-bbva)
+* **BBVA** (personal accounts): [bankscrap-bbva](https://github.com/bankscrap/bankscrap-bbva)
+* **BBVA Net Cash** (business accounts): [bankscrap-bbva-net-cash](https://github.com/bankscrap/bankscrap-bbva-net-cash)
 * **ING Direct**: [bankscrap-ing](https://github.com/bankscrap/bankscrap-ing)
 * **Banc Sabadell** (WIP): [bankscrap-banc-sabadell](https://github.com/bankscrap/bankscrap-banc-sabadell)
 
@@ -144,7 +145,7 @@ account.transactions
 
 ## Contributing
 
-1. Fork it ( https://github.com/bank-scrap/bank_scrap/fork )
+1. Fork it ( https://github.com/bankscrap/bankscrap/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/generators/adapter_generator.rb

@@ -0,0 +1,38 @@
+module Bankscrap
+  class AdapterGenerator < Thor::Group
+    include Thor::Actions
+
+    argument :bank_name
+
+    def self.source_root
+       File.join(File.dirname(__FILE__), 'templates')
+    end
+
+    def generate
+      self.destination_root = File.expand_path('.', gem_name)
+      directory '.'
+
+      say ""
+      say "Great! Now you can start implementing your bank's adapter for Bankscrap.", :yellow
+      say ""
+      say "To get started take a look to:", :yellow
+      say "#{destination_root}/#{gem_name}.rb", :yellow
+      say ""
+      say "If you need help you can join our Slack chat room. Click the Slack badge on Github:", :yellow
+      say "https://github.com/bankscrap/bankscrap", :yellow
+    end
+
+    protected
+
+    def bank_name_dasherized
+      @bank_name_dasherized ||= bank_name.underscore.dasherize
+    end
+    def gem_name
+      @gem_name ||= 'bankscrap-' + bank_name_dasherized
+    end
+
+    def module_name
+      @module_name ||= bank_name
+    end
+  end
+end

data/generators/templates/%gem_name%.gemspec.tt

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bankscrap/<%= bank_name_dasherized %>/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = '<%= gem_name %>'
+  spec.version       = Bankscrap::<%= module_name %>::VERSION
+  spec.authors       = ['Your Name']
+  spec.email         = ['your@email.com']
+  spec.summary       = '<%= bank_name %> adapter for Bankscrap'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'bankscrap'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/generators/templates/Gemfile.tt

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in <%= gem_name %>.gemspec
+gemspec

data/generators/templates/LICENSE.txt

@@ -0,0 +1,20 @@
+MIT License
+
+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/generators/templates/README.md.tt

@@ -0,0 +1,56 @@
+# Bankscrap::<%= module_name %>
+
+Bankscrap adapter for <%= bank_name %>
+
+**TODO**: write a proper description for your adapter.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem '<%= gem_name %>'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install <%= gem_name %>
+
+## Usage
+
+### From terminal
+#### Bank account balance
+
+    $ bankscrap balance <%= module_name %> --user YOUR_USER --password YOUR_PASSWORD --extra=company_code:YOUR_COMPANY_CODE
+
+
+#### Transactions
+
+    $ bankscrap transactions <%= module_name %> --user YOUR_USER --password YOUR_PASSWORD --extra=company_code:YOUR_COMPANY_CODE
+
+---
+
+For more details on usage instructions please read [Bankscrap readme](https://github.com/bankscrap/bankscrap/#usage).
+
+### 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})
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/bankscrap/<%= gem_name %>/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`)
+5. Create a new Pull Request

data/generators/templates/Rakefile.tt

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/generators/templates/lib/%gem_name%.rb.tt

@@ -0,0 +1,2 @@
+require_relative 'bankscrap/<%= bank_name_dasherized %>/bank'
+require_relative 'bankscrap/<%= bank_name_dasherized %>/version'

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

@@ -0,0 +1,91 @@
+require 'bankscrap'
+require 'securerandom'
+
+module Bankscrap
+  module <%= module_name %>
+    class Bank < ::Bankscrap::Bank
+
+      # Define the endpoints for the Bank API here
+      # BASE_ENDPOINT         = 'https://api.mybank.com'.freeze
+      # LOGIN_ENDPOINT        = '/login'.freeze
+      # 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']
+
+        initialize_connection
+
+        # 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
+      end
+
+      # Fetch all the accounts for the given user
+      #
+      # Should returns an array of Bankscrap::Account objects
+      def fetch_accounts
+        # Example if the API expects a JSON POST request
+        # response = post(BASE_ENDPOINT + ACCOUNTS_ENDPOINT, fields: {}.to_json)
+        # json = JSON.parse(response)
+        # json['accounts'].map { |data| build_account(data) }
+      end
+
+      # Fetch transactions for the given account.
+      #
+      # Account should be a Bankscrap::Account object
+      # Should returns an array of Bankscrap::Account objects
+      def fetch_transactions_for(account, start_date: Date.today - 1.month, end_date: Date.today)
+        # Example if the API expects a JSON POST request
+        # response = post(BASE_ENDPOINT + TRANSACTIONS_ENDPOINT, fields: {}.to_json)
+        # json = JSON.parse(response)
+        # json['transactions'].map { |data| build_transaction(data) }
+      end
+
+      private
+
+      # First request to login
+      def login
+        # Example if the API expects a JSON POST request
+        # params = { user: @user, password: @password }
+        # post(BASE_ENDPOINT + LOGIN_ENDPOINT, fields: params.to_json)
+      end
+
+      # Build an Account object from API data
+      def build_account(data)
+        Account.new(
+          bank: self,
+          id: REPLACE_ME,
+          name: REPLACE_ME,
+          available_balance: REPLACE_ME,
+          balance: REPLACE_ME,
+          currency: REPLACE_ME,
+          iban: REPLACE_ME,
+          description: REPLACE_ME
+        )
+      end
+
+      # Build a transaction object from API data
+      def build_transaction(data, account)
+        Transaction.new(
+          account: account,
+          id: REPLACE_ME,
+          amount: REPLACE_ME,
+          description: REPLACE_ME,
+          effective_date: REPLACE_ME,
+          currency: REPLACE_ME, # Should be a Money object
+          balance: REPLACE_ME   # Should be a Money object
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Bankscrap
+  module <%= bank_name %>
+    VERSION = '1.0.0'.freeze
+  end
+end

data/lib/bankscrap/cli.rb

@@ -1,5 +1,9 @@
 require 'thor'
 require 'active_support/core_ext/string'
+Dir[File.expand_path("../../..", __FILE__) + "/generators/*.rb"].each do |generator|
+  require generator
+end
+
 
 module Bankscrap
   class CLI < Thor
@@ -63,6 +67,10 @@ module Bankscrap
       end
     end
 
+
+    register(Bankscrap::AdapterGenerator, "generate_adapter", "generate_adapter MyBankName", 
+      "generates a template for a new Bankscrap bank adapter")
+
     private
 
     def assign_shared_options

data/lib/bankscrap/version.rb

@@ -1,3 +1,3 @@
 module Bankscrap
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.0.3'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bankscrap
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Javier Cuevas
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-01 00:00:00.000000000 Z
+date: 2016-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -140,6 +140,15 @@ extra_rdoc_files: []
 files:
 - README.md
 - bin/bankscrap
+- generators/adapter_generator.rb
+- generators/templates/%gem_name%.gemspec.tt
+- generators/templates/Gemfile.tt
+- generators/templates/LICENSE.txt
+- generators/templates/README.md.tt
+- generators/templates/Rakefile.tt
+- 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