bankscrap-bbva 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ef32ec6a56dd9b9352ca60ff3a86b14e9b70f21
+  data.tar.gz: ad37699ac93f8a959cd8562a0e6dd590a466bbdb
+SHA512:
+  metadata.gz: 023c42192b35b82f99a8fe7f4e704e42a2419fbf0963a8317131ffe7299e75eb820d68ae09a341134480f08c5358bd54f49001f5e58639b7ffb5771d59c8c62e
+  data.tar.gz: ff6b7afb3e00a79649cd3b4313f094de12ad50032d7d80b7172a4dead6337d96f63e31d42bf5e9dc3c08c1bbd59c96bb1b2730e4dca58ee729775183a51ee1a4

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bankscrap-bbva.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Raúl Marcos
+
+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/README.md

@@ -0,0 +1,33 @@
+# Bankscrap::BBVA
+
+Bankscrap adapter for the API behind BBVA's [mobile app](https://play.google.com/store/apps/developer?id=BBVA&hl=en).
+This adapter is only valid for personal accounts (the ones that work with that mobile APP), not for company accounts.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bankscrap-bbva'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bankscrap-bbva
+
+## Usage
+
+For usage instructions please read [Bankscrap readme](https://github.com/bankscrap/bankscrap/blob/refactor/README.md#usage).
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/bankscrap-bbva/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/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bankscrap-bbva.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bankscrap/bbva/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bankscrap-bbva"
+  spec.version       = Bankscrap::BBVA::VERSION
+  spec.authors       = ['Javier Cuevas']
+  spec.email         = ["javier@diacode.com"]
+  spec.summary       = %q{BBVA 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", "~> 1.0"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/bankscrap-bbva.rb

@@ -0,0 +1,2 @@
+require_relative 'bankscrap/bbva/bank'
+require_relative 'bankscrap/bbva/version'

data/lib/bankscrap/bbva/bank.rb

@@ -0,0 +1,172 @@
+require 'bankscrap'
+
+module Bankscrap
+  module BBVA
+    class Bank < ::Bankscrap::Bank
+      BASE_ENDPOINT     = 'https://servicios.bbva.es'
+      LOGIN_ENDPOINT    = '/DFAUTH/slod/DFServletXML'
+      PRODUCTS_ENDPOINT = '/ENPP/enpp_mult_web_mobility_02/products/v1'
+      ACCOUNT_ENDPOINT  = '/ENPP/enpp_mult_web_mobility_02/accounts/'
+      # BBVA expects an identifier before the actual User Agent, but 12345 works fine
+      USER_AGENT        = '12345;Android;LGE;Nexus 5;1080x1776;Android;5.1.1;BMES;4.4;xxhd'
+
+      def initialize(user, password, log: false, debug: false, extra_args: nil)
+        @user = format_user(user.dup)
+        @password = password
+        @log = log
+        @debug = debug
+
+        initialize_connection
+
+        add_headers(
+          'User-Agent'       => USER_AGENT,
+          'BBVA-User-Agent'  => USER_AGENT,
+          'Accept-Language'  => 'spa',
+          'Content-Language' => 'spa',
+          'Accept'           => 'application/json',
+          'Accept-Charset'   => 'UTF-8',
+          'Connection'       => 'Keep-Alive',
+          'Host'             => 'bancamovil.grupobbva.com',
+          'Cookie2'          => '$Version=1'
+        )
+
+        login
+        super
+      end
+
+      # Fetch all the accounts for the given user
+      # Returns an array of Bankscrap::Account objects
+      def fetch_accounts
+        log 'fetch_accounts'
+
+        # Even if the required method is an HTTP POST
+        # the API requires a funny header that says is a GET
+        # otherwise the request doesn't work.
+        response = with_headers('BBVA-Method' => 'GET') do
+          post(BASE_ENDPOINT + PRODUCTS_ENDPOINT)
+        end
+
+        json = JSON.parse(response)
+        json['accounts'].map { |data| build_account(data) }
+      end
+
+      # Fetch transactions for the given account.
+      # By default it fetches transactions for the last month,
+      # The maximum allowed by the BBVA API is the last 3 years.
+      #
+      # Account should be a Bankscrap::Account object
+      # Returns an array of Bankscrap::Transaction objects
+      def fetch_transactions_for(account, start_date: Date.today - 1.month, end_date: Date.today)
+        from_date = start_date.strftime('%Y-%m-%d')
+
+        # Misteriously we need a specific content-type here
+        funny_headers = {
+          'Content-Type' => 'application/json; charset=UTF-8',
+          'BBVA-Method' => 'GET'
+        }
+
+        # The API accepts a toDate param that we could pass the end_date argument,
+        # however when we pass the toDate param, the API stops returning the account balance.
+        # Therefore we need to take a workaround: only filter with fromDate and loop
+        # over all the available pages, filtering out the movements that doesn't match
+        # the end_date argument.
+        url = BASE_ENDPOINT +
+              ACCOUNT_ENDPOINT +
+              account.id +
+              "/movements/v1?fromDate=#{from_date}"
+
+        offset = nil
+        pagination_balance = nil
+        transactions = []
+
+        with_headers(funny_headers) do
+          # Loop over pagination
+          loop do
+            new_url = offset ? (url + "&offset=#{offset}") : url
+            new_url = pagination_balance ? (new_url + "&paginationBalance=#{pagination_balance}") : new_url
+            json = JSON.parse(post(new_url))
+
+            unless json['movements'].blank?
+              # As explained before, we have to discard records newer than end_date.
+              filtered_movements = json['movements'].select { |m| Date.parse(m['operationDate']) <= end_date }
+
+              transactions += filtered_movements.map do |data|
+                build_transaction(data, account)
+              end
+              offset = json['offset']
+              pagination_balance = json['paginationBalance']
+            end
+
+            break unless json['thereAreMoreMovements'] == true
+          end
+        end
+
+        transactions
+      end
+
+      private
+
+      # As far as we know there are two types of identifiers BBVA uses
+      # 1) A number of 7 characters that gets passed to the API as it is
+      # 2) A DNI number, this needs to transformed before it get passed to the API
+      #    Example: "49021740T" will become "0019-049021740T"
+      def format_user(user)
+        user.upcase!
+
+        if user.match(/^[0-9]{8}[A-Z]$/)
+          # It's a DNI
+          "0019-0#{user}"
+        else
+          user
+        end
+      end
+
+      def login
+        log 'login'
+        params = {
+          'origen'         => 'enpp',
+          'eai_tipoCP'     => 'up',
+          'eai_user'       => @user,
+          'eai_password'   => @password
+        }
+        post(BASE_ENDPOINT + LOGIN_ENDPOINT, fields: params)
+      end
+
+      # Build an Account object from API data
+      def build_account(data)
+        Account.new(
+          bank: self,
+          id: data['id'],
+          name: data['name'],
+          available_balance: data['availableBalance'],
+          balance: data['availableBalance'],
+          currency: data['currency'],
+          iban: data['iban'],
+          description: "#{data['typeDescription']} #{data['familyCode']}"
+        )
+      end
+
+      # Build a transaction object from API data
+      def build_transaction(data, account)
+        Transaction.new(
+          account: account,
+          id: data['id'],
+          amount: transaction_amount(data),
+          description: data['conceptDescription'] || data['description'],
+          effective_date: Date.strptime(data['operationDate'], '%Y-%m-%d'),
+          currency: data['currency'],
+          balance: transaction_balance(data)
+        )
+      end
+
+      def transaction_amount(data)
+        Money.new(data['amount'] * 100, data['currency'])
+      end
+
+      def transaction_balance(data)
+        return unless data['accountBalanceAfterMovement']
+        Money.new(data['accountBalanceAfterMovement'] * 100, data['currency'])
+      end
+    end
+  end
+end

data/lib/bankscrap/bbva/version.rb

@@ -0,0 +1,5 @@
+module Bankscrap
+  module BBVA
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: bankscrap-bbva
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Javier Cuevas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bankscrap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- javier@diacode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bankscrap-bbva.gemspec
+- lib/bankscrap-bbva.rb
+- lib/bankscrap/bbva/bank.rb
+- lib/bankscrap/bbva/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: BBVA adapter for Bankscrap
+test_files: []