bankscrap 2.0.5 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99d6ad8497281047d3900aba58f6264727231e3d
-  data.tar.gz: 0387949b4ac135e26d194816e8dfe3807b7a3e52
+  metadata.gz: 1481cd3fa9e6859cd8afaed3ddf47a7fcafa66d1
+  data.tar.gz: 3c11cce2190b9c058e2a28be2934015bbd63a9dc
 SHA512:
-  metadata.gz: d5a694b436ff3b72990a872211930f4883879ed75306745af7cdb600148a9eed2bd36fb0bbf4cc065bd5ae5f4e3f60031f0d71c8808b47778fe3b8c19bbd839b
-  data.tar.gz: b1a9e088ae08d230bef00e3a647f89ceb3494d2e778e5dc8c7773dcea169ace61b916760dc8ef308d54f6a8c11b9a924beee56e4a07bf1e689771de321268c21
+  metadata.gz: c1d7ec05a3268e4760d387bb77172c3b20a9d8052c78253b40c8f0e53656f9532e2d260fcf5aaa62e0e115ab6c09f42376be65cdb460f03880b08bfe1c1519ff
+  data.tar.gz: 4bd5ddeb61e0f411a65ed0aa30c6581e5ece111d32856832a512c41ee5de416e532d3f29f7176efc6266f2151f3a0e0a5c7dd99fba1d80f964831fc4d3b6d69b

data/README.md

@@ -1,6 +1,6 @@
 # 💸 Bankscrap 💸
 
-[![](http://188.166.39.57:3000/badge.svg)](http://188.166.39.57:3000)
+[![Slack](https://now-examples-slackin-hiyfeggjfn.now.sh/badge.svg)](https://now-examples-slackin-hiyfeggjfn.now.sh/)
 [![Gem Version](https://badge.fury.io/rb/bankscrap.svg)](https://badge.fury.io/rb/bankscrap)
 [![Build Status](https://travis-ci.org/bankscrap/bankscrap.svg?branch=master)](https://travis-ci.org/bankscrap/bankscrap)
 
@@ -16,7 +16,9 @@ Feel free to contribute and add your bank if it isn't supported.
 * **Arquia Banca**: [bankscrap-arquia](https://github.com/bankscrap/bankscrap-arquia)
 * **Openbank**: [bankscrap-openbank](https://github.com/bankscrap/bankscrap-openbank)
 * **Sabadell**: [bankscrap-sabadell](https://github.com/bankscrap/bankscrap-sabadell)
+* **Ibercaja**: [bankscrap-ibercaja](https://github.com/bankscrap/bankscrap-ibercaja)
 * **Santander** (WIP): [bankscrap-santander](https://github.com/bankscrap/bankscrap-santander)
+* **Shinsei Bank**: [bankscrap-shinsei](https://github.com/bankscrap/bankscrap-shinsei)
 
 Interested in any other bank? Open a new Issue and we'll try to help.
 
@@ -175,6 +177,34 @@ ing = Bankscrap::ING::Bank.new(dni: YOUR_DNI, password: YOUR_ING_PASSWORD, birth
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+### Start a new Bank Adapter with the generator
+You can use a generator to create the basic template for your new bank adapter.
+1. Install the bankscrap gem (`gem install bankscrap`) if you don't have it already.
+2. Use the name of your *BankName* like: `bankscrap generate_adapter BankName`, you will get:
+
+```
+      create
+      create  bankscrap-my-bank-name.gemspec
+      create  .gitignore
+      create  Gemfile
+      create  LICENSE.txt
+      create  README.md
+      create  Rakefile
+      create  lib/bankscrap-my-bank-name.rb
+      create  lib/bankscrap/my-bank-name/bank.rb
+      create  lib/bankscrap/my-bank-name/version.rb
+
+Great! Now you can start implementing your bank's adapter for Bankscrap.
+
+To get started take a look to:
+/Users/username/bankscrap/bankscrap-my-bank-name/lib/bankscrap/my-bank-name/bank.rb
+
+If you need help you can join our Slack chat room. Click the Slack badge on Github:
+https://github.com/bankscrap/bankscrap
+```
+3. Create a git repository on the newly created directory (`git init`) and start commiting.
+4. Push your repo to github and open an Issue at https://github.com/bankscrap/bankscrap/issues referencing it
+
 ## Thanks
 
 Thanks to Javier Cuevas (@javiercr) for his [BBVA](https://github.com/javiercr/bbva) gem.

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

@@ -75,6 +75,7 @@ module Bankscrap
           id: REPLACE_ME,
           amount: REPLACE_ME, # Should be a Money object
           description: REPLACE_ME,
+          description_detail: REPLACE_ME, # Optional
           effective_date: REPLACE_ME,
           operation_date: REPLACE_ME,
           balance: REPLACE_ME  # Should be a Money object

data/lib/bankscrap/cli.rb

@@ -6,6 +6,8 @@ end
 
 module Bankscrap
   class CLI < Thor
+    SPACER = (' ' * 3).freeze
+
     def self.shared_options
       option :credentials, default: {}, type: :hash
       option :log,         default: false, type: :boolean
@@ -112,18 +114,18 @@ module Bankscrap
     def print_transactions_header
       say "\n"
       say 'DATE'.ljust(13)
-      say 'DESCRIPTION'.ljust(50) + '   '
-      say 'AMOUNT'.rjust(15) + '   '
+      say 'DESCRIPTION'.ljust(50) + SPACER
+      say 'AMOUNT'.rjust(15) + SPACER
       say 'BALANCE'.rjust(15)
       say '-' * 99
     end
 
     def print_transaction(transaction)
       color = (transaction.amount.to_i > 0 ? :green : :red)
-      say transaction.effective_date.strftime('%d/%m/%Y') + '   '
-      say transaction.description.squish.truncate(50).ljust(50) + '   ', color
-      say transaction.amount.format.rjust(15) + '   ', color
-      say transaction.balance.format.rjust(15)
+      say transaction.effective_date.strftime('%d/%m/%Y') + SPACER
+      say Utils::CliString.new(transaction.description).squish.truncate(50).ljust(50) + SPACER, color
+      say Utils::CliString.new(transaction.amount.format).rjust(15) + SPACER, color
+      say Utils::CliString.new(transaction.balance.format).rjust(15)
     end
   end
 end

data/lib/bankscrap/exporters/csv.rb

@@ -3,7 +3,7 @@ require 'csv'
 module BankScrap
   module Exporter
     class Csv
-      HEADERS = %w(Date Description Amount).freeze
+      HEADERS = %w(ID Date Description DescriptionDetail Amount).freeze
 
       def initialize(output = nil)
         @output = output || 'transactions.csv'

data/lib/bankscrap/transaction.rb

@@ -2,7 +2,7 @@ module Bankscrap
   class Transaction
     include Utils::Inspectable
 
-    attr_accessor :id, :amount, :description, :effective_date, :operation_date, :balance, :account
+    attr_accessor :id, :amount, :description, :description_detail, :effective_date, :operation_date, :balance, :account
 
     def initialize(params = {})
       raise NotMoneyObjectError.new(:amount) unless params[:amount].is_a?(Money)
@@ -15,7 +15,7 @@ module Bankscrap
     end
 
     def to_a
-      [effective_date.strftime('%d/%m/%Y'), description, amount]
+      [id, effective_date.strftime('%d/%m/%Y'), description, description_detail, amount]
     end
 
     def currency

data/lib/bankscrap/utils/cli_string.rb

@@ -0,0 +1,40 @@
+require 'unicode/display_width'
+
+module Bankscrap
+  module Utils
+    class CliString < String
+      def ljust(to_length, padstr = ' ')
+        self.class.new(self + padding(to_length, padstr))
+      end
+
+      def rjust(to_length, padstr = ' ')
+        self.class.new(padding(to_length, padstr) + self)
+      end
+
+      def truncate(truncate_at)
+        if display_width > truncate_at
+          self.class.new(self[0..-2]).truncate(truncate_at)
+        else
+          self.class.new(self)
+        end
+      end
+
+      private
+
+      def padding(to_length, padstr)
+        padstr.to_str * padding_length(to_length)
+      end
+
+      def padding_length(to_length)
+        [
+          0,
+          to_length - display_width
+        ].max
+      end
+
+      def display_width
+        Unicode::DisplayWidth.of(self)
+      end
+    end
+  end
+end

data/lib/bankscrap/version.rb

@@ -1,3 +1,3 @@
 module Bankscrap
-  VERSION = '2.0.5'.freeze
+  VERSION = '2.0.6'.freeze
 end

data/lib/bankscrap.rb

@@ -2,6 +2,7 @@ require 'active_support/all'
 require 'money'
 require 'rubygems'
 require_relative 'bankscrap/utils/inspectable'
+require_relative 'bankscrap/utils/cli_string'
 require_relative 'bankscrap/version'
 require_relative 'bankscrap/config'
 require_relative 'bankscrap/cli'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bankscrap
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.6
 platform: ruby
 authors:
 - Javier Cuevas
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-29 00:00:00.000000000 Z
+date: 2017-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,6 +109,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: unicode-display_width
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Command line tools to get bank account details from some banks.
 email:
 - javi@diacode.com
@@ -139,9 +153,10 @@ files:
 - lib/bankscrap/investment.rb
 - lib/bankscrap/locale/en.yml
 - lib/bankscrap/transaction.rb
+- lib/bankscrap/utils/cli_string.rb
 - lib/bankscrap/utils/inspectable.rb
 - lib/bankscrap/version.rb
-homepage: https://github.com/bank-scrap/bank_scrap
+homepage: https://github.com/bankscrap/bankscrap
 licenses:
 - MIT
 metadata: {}