bankscrap-bbva-net-cash 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fbcd07b15419ce680a0c2829917d370dd832419f
+  data.tar.gz: 900676d73e0aaa89036775d15f3b2a80110c522e
+SHA512:
+  metadata.gz: 7a818e4de058a58b831613dd7c7ec00904b02f8c1eab4b1bdb5bc166521ff0dbf08661136257d9adcd5e24c706b9971c9a7527af6c750c640471e5297ac6567c
+  data.tar.gz: 879692f2eb09c00a1b05c5baf8d7dede32097aac6b88c2887a4884b05aff44d1f70012ec001e1655831270a4155c32f458f35ab3185015a09d4d0fd390aa3ad4

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  TargetRubyVersion: 2.1
+
+Metrics/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bankscrap-bbva-net-cash.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,55 @@
+# Bankscrap::BBVANetCash
+
+Bankscrap adapter for the API behind BBVA's [Net Cash mobile app](https://play.google.com/store/apps/details?id=com.bbva.netcash).
+
+This adapter is only valid for **company accounts** (the ones that have access to Net Cash). For personal accounts 
+you should use [bankscrap-bbva](https://github.com/bankscrap/bankscrap-bbva).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bankscrap-bbva-net-cash'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bankscrap-bbva-net-cash
+
+## Usage
+
+### From terminal
+#### Bank account balance
+
+    $ bankscrap balance BBVANetCash --user YOUR_USER --password YOUR_PASSWORD --extra=company_code:YOUR_COMPANY_CODE
+
+
+#### Transactions
+
+    $ bankscrap transactions BBVANetCash --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
+
+
+```ruby
+require 'bankscrap-bbva-net-cash'
+bbva_net_cash = Bankscrap::BBVANetCash::Bank.new(YOUR_USER, YOUR_PASSWORD, extra_args: {company_code: YOUR_COMPANY_CODE})
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/bankscrap/bankscrap-bbva-net-cash/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 @@
+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-net-cash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bankscrap-bbva-net-cash'
+  spec.version       = Bankscrap::BBVANetCash::VERSION
+  spec.authors       = ['Javier Cuevas']
+  spec.email         = ['javier@diacode.com']
+  spec.summary       = 'BBVA Net Cash 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.2'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/bankscrap-bbva-net-cash.rb

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

data/lib/bankscrap/bbva-net-cash/bank.rb

@@ -0,0 +1,244 @@
+require 'bankscrap'
+require 'securerandom'
+
+module Bankscrap
+  module BBVANetCash
+    class Bank < ::Bankscrap::Bank
+
+      BASE_ENDPOINT         = 'https://www.bbvanetcash.mobi'.freeze
+      LOGIN_ENDPOINT        = '/DFAUTH/slod_mult_mult/EAILServlet'.freeze
+      ACCOUNTS_ENDPOINT     = '/SESKYOS/kyos_mult_web_servicios_02/services/rest/CuentasServiceREST/getDatosCuentas'.freeze
+      TRANSACTIONS_ENDPOINT = '/SESKYOS/kyos_mult_web_servicios_02/services/rest/CuentasServiceREST/getMovimientos'.freeze
+
+      def initialize(user, password, log: false, debug: false, extra_args: nil)
+        @company_code = extra_args.with_indifferent_access['company_code']
+        @user = format_user(user.dup, @company_code.to_s.dup)
+        @password = password.upcase
+        @log = log
+        @debug = debug
+
+        initialize_connection
+
+        # Create a user_agent with a random string for privacy
+        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,
+          'Accept'           => 'application/json',
+          'Accept-Charset'   => 'UTF-8',
+          'Connection'       => 'Keep-Alive',
+          'Host'             => 'www.bbvanetcash.mobi'
+        )
+
+        login
+        super
+      end
+
+      # Fetch all the accounts for the given user
+      # Returns an array of Bankscrap::Account objects
+      def fetch_accounts
+        log 'fetch_accounts'
+
+        custom_headers = {
+          'Content-Type' => 'application/json; charset=UTF-8',
+          'Contexto' => get_context
+        }
+
+        params = {
+          "peticionCuentasKYOSPaginadas" =>  {
+            "favoritos" => false,
+            "paginacion" => "0"
+          }
+        }
+
+        response = with_headers(custom_headers) do
+          post(BASE_ENDPOINT + ACCOUNTS_ENDPOINT, fields: params.to_json)
+        end
+
+        json = JSON.parse(response)
+
+        if json['respuestacuentas']['cuentas'].is_a? Array
+          # TODO: test this with a user with multiple accounts
+          json['respuestacuentas']['cuentas'].map { |data| build_account(data) }
+        else
+          [build_account(json['respuestacuentas']['cuentas'])]
+        end
+      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')
+
+        custom_headers = {
+          'Content-Type' => 'application/json; charset=UTF-8',
+          'Contexto' => get_context
+        }
+
+        params = {
+          "peticionMovimientosKYOS" => {
+            "numAsunto" => account.iban,
+            "bancoAsunto" => "BANCO BILBAO VIZCAYA ARGENTARIA S.A",
+            "fechaDesde" => start_date.strftime("%Y%m%d"),
+            "fechaHasta" => end_date.strftime("%Y%m%d"),
+            "concepto" => [],
+            "importe_Desde" => "",
+            "importe_Hasta" => "",
+            "divisa" => "EUR",
+            "paginacionTLSMT017" => "N000000000000+0000000000000000000",
+            "paginacionTLSMT016" => "N00000000000+0000000000000000",
+            "descargaInformes" => false,
+            "numElem" => 0,
+            "banco" => "1",
+            "idioma" => "51",
+            "formatoFecha" => "dd\/MM\/yyyy",
+            "paginacionMOVDIA" => "1",
+            "ultimaFechaPaginacionAnterior" => "",
+            "ordenacion" => "DESC"
+          }
+        }
+
+        url = BASE_ENDPOINT + TRANSACTIONS_ENDPOINT
+
+        transactions = []
+        with_headers(custom_headers) do
+          # Loop over pagination
+          loop do
+            json = JSON.parse(post(url, fields: params.to_json))['respuestamovimientos']
+
+            unless json['movimientos'].blank?
+              transactions += json['movimientos'].map do |data|
+                build_transaction(data, account)
+              end
+              
+              params['peticionMovimientosKYOS']['paginacionMOVDIA'] = json['paginacionMOVDIA']
+              params['peticionMovimientosKYOS']['paginacionTLSMT016'] = json['paginacionTLSMT016']
+              params['peticionMovimientosKYOS']['paginacionTLSMT017'] = json['paginacionTLSMT017']
+            end
+
+            break unless json['descripcion'] == 'More records available'
+          end
+        end
+
+        transactions
+      end
+
+      private
+
+      # The user that gets sent to the API is a string composed by 3 items:
+      # 00230001 <- no idea why this number ¯\_(ツ)_/¯
+      # Company code
+      # User <- always in upcase
+      def format_user(user, company_code)
+        '00230001' + company_code + user.upcase
+      end
+
+      def login
+        log 'login'
+        params = {
+          'origen'         => 'pibeemovil',
+          'eai_tipoCP'     => 'up',
+          'eai_URLDestino' => 'success_eail_CAS.jsp',
+          '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['referencia'],
+          name: data['empresaDes'],
+          available_balance: data['saldoValor'].to_f,
+          balance: data['saldoContable'],
+          currency: data['divisa'],
+          iban: data['numeroAsunto'],
+          description: "#{data['bancoDes']} #{data['numeroAsuntoMostrar']}"
+        )
+      end
+
+      # Build a transaction object from API data
+      def build_transaction(data, account)
+        Transaction.new(
+          account: account,
+          id: data['codRmsoperS'],
+          amount: transaction_amount(data),
+          description: data['concepto'] || data['descConceptoTx'],
+          effective_date: Date.strptime(data['fechaContable'], '%d/%m/%Y'),
+          currency: data['divisa'],
+          balance: Money.new(data['saldoContable'].to_f * 100, data['currency'])
+        )
+      end
+
+      def transaction_amount(data)
+        Money.new(data['importe'].to_f * 100, data['divisa'])
+      end
+
+      # This API has a custom header called 'Contexto' that is required for every
+      # request after login. Some of the data has been anonymized.
+      def get_context
+        {
+          "perfil" => {
+            "usuario" => @user,
+            "nombre" => "",
+            "apellido1" => "",
+            "apellido2" => "",
+            "dni" => "",
+            "cargoFun" => "",
+            "centroCoste" => "",
+            "matricula" => "",
+            "bancoOperativo" => "",
+            "oficinaOperativa" => "",
+            "bancoFisico" => "",
+            "oficinaFisica" => "",
+            "paisOficina" => "",
+            "idioma" => "1",
+            "idiomaIso" => "1",
+            "divisaBase" => "ZZZ",
+            "divisaSecundaria" => "",
+            "xtiOfiFisica" => "",
+            "xtiOfiOperati" => "",
+            "listaAutorizaciones" => [
+              "AAAA",
+              "BBBB"
+            ]
+          },
+          "puesto" => {
+            "puestoLogico" => "3"
+          },
+          "transacciones" => {
+            "canalLlamante" => "4",
+            "medioAcceso" => "7",
+            "secuencia" => nil,
+            "servicioProducto" => "27",
+            "tipoIdentificacionCliente" => "6",
+            "identificacionCliente" => "",
+            "modoProceso" => nil,
+            "autorizacion" => nil,
+            "origenFisico" => nil
+          },
+          "datosTecnicos" => {
+            "idPeticion" => nil,
+            "UUAARemitente" => nil,
+            "usuarioLogico" => "",
+            "cabecerasHttp" => {
+              "aap" => "00000034",
+              "iv-user" => @user
+            }
+          },
+          "codigoCliente" => "1",
+          "tipoAutenticacion" => "1",
+          "identificacionCliente" => "",
+          "tipoIdentificacionCliente" => "6",
+          "propiedades" => nil
+        }
+      end
+    end
+  end
+end

data/lib/bankscrap/bbva-net-cash/version.rb

@@ -0,0 +1,5 @@
+module Bankscrap
+  module BBVANetCash
+    VERSION = '1.0.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: bankscrap-bbva-net-cash
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Javier Cuevas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-01 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.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !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"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bankscrap-bbva.gemspec
+- lib/bankscrap-bbva-net-cash.rb
+- lib/bankscrap/bbva-net-cash/bank.rb
+- lib/bankscrap/bbva-net-cash/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 Net Cash adapter for Bankscrap
+test_files: []