bankscrap-openbank 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1b65647a5159a87170071f62b9e436746cc82e0
+  data.tar.gz: f29fa5cf4c2ab71265e6c73beb806e71ce92ea0d
+SHA512:
+  metadata.gz: 9e0d44b99398209c21b48c6c34ac64b6c6c2d9af3d3aaaa4ea5da443024f0bb5a5687493841b6d16a22c9738ef62ec4b2937efefa567b8f6cf94777759e0bbfd
+  data.tar.gz: 7deac7f651ea8e0445b4bcd390358755a0ea89ec4af3976a706ebde8c6b1a642e2baff4df3eae68b2b7e34192d2ba72fba10fc71ce2979a72eca4fa138961fe5

data/Gemfile

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

data/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/README.md

@@ -0,0 +1,51 @@
+# Bankscrap::Openbank
+
+[Bankscrap](https://github.com/bankscrap/bankscrap) adapter for Openbank.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bankscrap-openbank'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bankscrap-openbank
+
+## Usage
+
+### From terminal
+#### Bank account balance
+
+    $ bankscrap balance Openbank --credentials=user:YOUR_USER --password:YOUR_PASSWORD
+
+
+#### Transactions
+
+    $ bankscrap transactions Openbank --credentials=user:YOUR_USER --password:YOUR_PASSWORD
+
+---
+
+For more details on usage instructions please read [Bankscrap readme](https://github.com/bankscrap/bankscrap/#usage).
+
+### From Ruby code
+
+```ruby
+require 'bankscrap-openbank'
+openbank = Bankscrap::Openbank::Bank.new(user: YOUR_USER, password: YOUR_PASSWORD)
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/bankscrap/bankscrap-openbank/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-openbank.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bankscrap/openbank/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bankscrap-openbank'
+  spec.version       = Bankscrap::Openbank::VERSION
+  spec.authors       = ['zjuanma']
+  spec.email         = ['zjuanma@gmail.com']
+  spec.summary       = 'Openbank adapter for Bankscrap'
+  spec.homepage      = 'https://github.com/zjuanma/bankscrap-openbank'
+  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'
+  spec.add_development_dependency 'byebug', '~> 8.0'
+end

data/lib/bankscrap-openbank.rb

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

data/lib/bankscrap/openbank/account.rb

@@ -0,0 +1,79 @@
+require_relative 'utils.rb'
+
+module Bankscrap
+  module Openbank
+    class Account < ::Bankscrap::Account
+      include Utils
+
+      attr_accessor :contract_id
+
+      ACCOUNT_ENDPOINT = '/OPB_BAMOBI_WS_ENS/ws/BAMOBI_WS_Def_Listener'.freeze
+
+      # Fetch transactions for the given account.
+      # By default it fetches transactions for the last month,
+      #
+      # Returns an array of BankScrap::Transaction objects
+      def fetch_transactions_for(connection, start_date: Date.today - 1.month, end_date: Date.today)
+        transactions = []
+        end_page = false
+        repo = nil
+        importe_cta = nil
+
+        # Loop over pagination
+        until end_page
+          document = connection.post(ACCOUNT_ENDPOINT, fields: xml_account(connection, start_date, end_date, repo, importe_cta))
+
+          transactions += document.xpath('//listadoMovimientos/movimiento').map { |data| build_transaction(data) }
+
+          repo = document.at_xpath('//methodResult/repo')
+          importe_cta = document.at_xpath('//methodResult/importeCta')
+          end_page = value_at_xpath(document, '//methodResult/finLista') != 'N'
+        end
+
+        transactions
+      end
+
+      def xml_account(connection, from_date, to_date, repo, importe_cta)
+        is_pagination = repo ? 'S' : 'N'
+        xml_from_date = xml_date(from_date)
+        xml_to_date = xml_date(to_date)
+        <<-account
+      <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:v1="http://www.isban.es/webservices/BAMOBI/Cuentas/F_bamobi_cuentas_lip/internet/BAMOBICTA/v1">
+        #{connection.xml_security_header}
+        <soapenv:Body>
+          <v1:listaMovCuentasFechas_LIP facade="BAMOBICTA">
+            <entrada>
+        #{connection.xml_datos_cabecera}
+              <datosConexion>#{connection.user_data.children}</datosConexion>
+              <contratoID>#{contract_id}</contratoID>
+              <fechaDesde>#{xml_from_date}</fechaDesde>
+              <fechaHasta>#{xml_to_date}</fechaHasta>
+        #{importe_cta}
+              <esUnaPaginacion>#{is_pagination}</esUnaPaginacion>
+        #{repo}
+            </entrada>
+          </v1:listaMovCuentasFechas_LIP>
+        </soapenv:Body>
+      </soapenv:Envelope>
+        account
+      end
+
+      def xml_date(date)
+        "<dia>#{date.day}</dia><mes>#{date.month}</mes><anyo>#{date.year}</anyo>"
+      end
+
+      # Build a transaction object from API data
+      def build_transaction(data)
+        Transaction.new(
+          account: self,
+          id: value_at_xpath(data, 'numeroMovimiento'),
+          amount: money(data, 'importe'),
+          description: value_at_xpath(data, 'descripcion'),
+          effective_date: Date.strptime(value_at_xpath(data, 'fechaValor'), '%Y-%m-%d'),
+          # TODO: Bankscrap has no interface to add operation date
+          balance: money(data, 'importeSaldo')
+        )
+      end
+    end
+  end
+end

data/lib/bankscrap/openbank/bank.rb

@@ -0,0 +1,164 @@
+require 'bankscrap'
+require 'securerandom'
+require 'byebug'
+require_relative 'account.rb'
+require_relative 'card.rb'
+require_relative 'utils.rb'
+
+module Bankscrap
+  module Openbank
+    class Bank < ::Bankscrap::Bank
+      include Utils
+
+      attr_accessor :user_data
+
+      # Define the endpoints for the Bank API here
+      BASE_ENDPOINT     = 'https://www.openbank.mobi'.freeze
+      LOGIN_ENDPOINT    = '/OPBMOV_IPAD_NSeg_ENS/ws/QUIZ_Def_Listener'.freeze
+      PRODUCTS_ENDPOINT = '/OPB_BAMOBI_WS_ENS/ws/BAMOBI_WS_Def_Listener'.freeze
+      USER_AGENT        = 'Dalvik/1.6.0 (Linux; U; Android 4.4.4; XT1032 Build/KXB21.14-L1.40)'.freeze
+
+      def initialize(credentials = {})
+        super do
+          add_headers(
+            'Content-Type'     => 'text/xml; charset=utf-8',
+            'User-Agent'       => USER_AGENT,
+            'Host'             => 'www.openbank.mobi',
+            'Connection'       => 'Keep-Alive',
+            'Accept-Encoding'  => 'gzip'
+          )
+        end
+      end
+
+      def login
+        log 'login'
+        post(LOGIN_ENDPOINT, fields: xml_login(public_ip))
+      end
+
+      # Fetch all the accounts for the given user
+      #
+      # Should returns an array of Bankscrap::Account objects
+      def fetch_accounts
+        log 'fetch_accounts'
+        document = post(PRODUCTS_ENDPOINT, fields: xml_products)
+        document.xpath('//cuentas/cuenta').map { |data| build_account(data) } +
+          document.xpath('//tarjetas/tarjeta').map { |data| build_card(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(product, start_date: Date.today - 1.month, end_date: Date.today)
+        product.fetch_transactions_for(self, start_date: start_date, end_date: end_date)
+      end
+
+      def xml_security_header
+        <<-security
+        <soapenv:Header>
+          <wsse:Security SOAP-ENV:actor="http://www.isban.es/soap/actor/wssecurityB64" SOAP-ENV:mustUnderstand="1" S12:role="wsssecurity" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:S12="http://www.w3.org/2003/05/soap-envelope" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
+            <wsse:BinarySecurityToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="SSOToken" ValueType="esquema" EncodingType="hwsse:Base64Binary">#{@token_credential}</wsse:BinarySecurityToken>
+          </wsse:Security>
+        </soapenv:Header>
+        security
+      end
+
+      def xml_datos_cabecera
+        <<-datos
+        <datosCabecera>
+          <version>3.0.4</version>
+          <terminalID>Android</terminalID>
+          <idioma>es-ES</idioma>
+        </datosCabecera>
+        datos
+      end
+
+      def post(method, fields: {})
+        response = super(BASE_ENDPOINT + method, fields: fields)
+        parse_context(response)
+      end
+
+      private
+
+      def xml_products
+        <<-products
+      <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://www.isban.es/webservices/BAMOBI/Posglobal/F_bamobi_posicionglobal_lip/internet/BAMOBIPGL/v1">
+        #{xml_security_header}
+        <soapenv:Body>
+          <v1:obtenerPosGlobal_LIP facade="BAMOBIPGL">
+            <entrada>#{xml_datos_cabecera}</entrada>
+          </v1:obtenerPosGlobal_LIP>
+        </soapenv:Body>
+      </soapenv:Envelope>
+        products
+      end
+
+      # Build an Account object from API data
+      def build_account(data)
+        Account.new(
+          bank: self,
+          id: value_at_xpath(data, 'comunes/contratoID/NUMERO_DE_CONTRATO'),
+          name: value_at_xpath(data, 'comunes/descContrato'),
+          available_balance: money(data, 'importeDispAut'),
+          balance: money(data, 'impSaldoActual'),
+          iban: value_at_xpath(data, 'IBAN').tr(' ', ''),
+          description: value_at_xpath(data, 'comunes/alias') || value_at_xpath(data, 'comunes/descContrato'),
+          contract_id: data.at_xpath('contratoIDViejo').children.to_s
+        )
+      end
+
+      # Build an Card object from API data
+      def build_card(data)
+        Card.new(
+          bank: self,
+          id: value_at_xpath(data, 'pan'),
+          name: value_at_xpath(data, 'comunes/descContrato'),
+          available_balance: money(data, 'impDisponible'),
+          balance: money(data, 'impSaldoDispuesto'),
+          iban: value_at_xpath(data, 'comunes/contratoID'),
+          description: "#{value_at_xpath(data, 'comunes/alias') || value_at_xpath(data, 'comunes/descContrato')} (#{value_at_xpath(data, 'descTipoTarjeta')})",
+          contract_id: data.at_xpath('comunes/contratoID').children.to_s
+        )
+      end
+
+      def parse_context(xml)
+        document = Nokogiri::XML(xml)
+        @cookie_credential = value_at_xpath(document, '//cookieCredential', @cookie_credential)
+        @token_credential = value_at_xpath(document, '//tokenCredential', @token_credential)
+        self.user_data = document.at_xpath('//methodResult/datosUsuario') || user_data
+        document
+      end
+
+      def public_ip
+        log 'getting public ip'
+        ip = open('http://api.ipify.org').read
+        log "public ip: [#{ip}]"
+        ip
+      end
+
+      def format_user(user)
+        user.upcase
+      end
+
+      def xml_login(public_ip)
+        <<-login
+      <v:Envelope xmlns:v="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:c="http://schemas.xmlsoap.org/soap/encoding/"  xmlns:d="http://www.w3.org/2001/XMLSchema"  xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
+        <v:Header />
+        <v:Body>
+          <n0:authenticateCredential xmlns:n0="http://www.isban.es/webservices/TECHNICAL_FACADES/Security/F_facseg_security/internet/loginServicesNSegWS/v1" facade="loginServicesNSegWS">
+            <CB_AuthenticationData i:type=":CB_AuthenticationData">
+              <documento i:type=":documento">
+                <CODIGO_DOCUM_PERSONA_CORP i:type="d:string">#{@user}</CODIGO_DOCUM_PERSONA_CORP>
+                <TIPO_DOCUM_PERSONA_CORP i:type="d:string">N</TIPO_DOCUM_PERSONA_CORP>
+              </documento>
+              <password i:type="d:string">#{@password}</password>
+            </CB_AuthenticationData>
+            <userAddress i:type="d:string">#{public_ip}</userAddress>
+          </n0:authenticateCredential>
+        </v:Body>
+      </v:Envelope>
+        login
+      end
+    end
+  end
+end

data/lib/bankscrap/openbank/card.rb

@@ -0,0 +1,75 @@
+require_relative 'utils.rb'
+
+module Bankscrap
+  module Openbank
+    class Card < Account
+      include Utils
+
+      CARD_ENDPOINT = '/OPB_BAMOBI_WS_ENS/ws/BAMOBI_WS_Def_Listener'.freeze
+
+      # Fetch transactions for the given account.
+      # By default it fetches transactions for the last month,
+      #
+      # Returns an array of BankScrap::Transaction objects
+      def fetch_transactions_for(connection, start_date: Date.today - 1.month, end_date: Date.today)
+        transactions = []
+        end_page = false
+        repos = nil
+
+        # Loop over pagination
+        until end_page
+          document = connection.post(CARD_ENDPOINT, fields: xml_card(connection, start_date, end_date, repos))
+
+          transactions += document.xpath('//lista/dato').map { |data| build_transaction(data) }
+
+          repos = document.at_xpath('//methodResult/repos')
+          end_page = value_at_xpath(document, '//methodResult/finLista') != 'N'
+        end
+
+        transactions
+      end
+
+      def xml_card(connection, from_date, to_date, repos)
+        is_pagination = repos ? 'S' : 'N'
+        xml_from_date = xml_date(from_date)
+        xml_to_date = xml_date(to_date)
+        <<-card
+      <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:v1="http://www.isban.es/webservices/BAMOBI/Tarjetas/F_bamobi_tarjetas_lip/internet/BAMOBITAJ/v1">
+        #{connection.xml_security_header}
+        <soapenv:Body>
+          <v1:listaMovTarjetasFechas_LIP facade="BAMOBITAJ">
+            <entrada>
+              <datosConexion>#{connection.user_data.children}</datosConexion>
+              #{connection.xml_datos_cabecera}
+              <contratoTarjeta>#{contract_id}</contratoTarjeta>
+              <numeroTarj>#{id}</numeroTarj>
+              <fechaDesde>#{xml_from_date}</fechaDesde>
+              <fechaHasta>#{xml_to_date}</fechaHasta>
+              <esUnaPaginacion>#{is_pagination}</esUnaPaginacion>
+              #{repos}
+            </entrada>
+          </v1:listaMovTarjetasFechas_LIP>
+        </soapenv:Body>
+      </soapenv:Envelope>
+        card
+      end
+
+      def xml_date(date)
+        "<dia>#{date.day}</dia><mes>#{date.month}</mes><anyo>#{date.year}</anyo>"
+      end
+
+      # Build a transaction object from API data
+      def build_transaction(data)
+        Transaction.new(
+          account: self,
+          id: value_at_xpath(data, 'movimDia'),
+          amount: money(data, 'importeMovto'),
+          description: value_at_xpath(data, 'descMovimiento'),
+          effective_date: Date.strptime(value_at_xpath(data, 'fechaAnota'), '%Y-%m-%d'),
+          # operation_date: Date.strptime(value_at_xpath(data, 'fechaOpera'), "%Y-%m-%d"),
+          balance: Money.new(0, 'EUR') # TODO: Prepaid/debit cards don't have a Balance - maybe Credit ones do.
+        )
+      end
+    end
+  end
+end

data/lib/bankscrap/openbank/utils.rb

@@ -0,0 +1,17 @@
+module Bankscrap
+  module Openbank
+    module Utils
+      def value_at_xpath(node, xpath, default = '')
+        value = node.at_xpath(xpath)
+        value ? value.content.strip : default
+      end
+
+      def money(data, xpath)
+        Money.new(
+          value_at_xpath(data, xpath + '/IMPORTE').delete('.'),
+          value_at_xpath(data, xpath + '/DIVISA')
+        )
+      end
+    end
+  end
+end

data/lib/bankscrap/openbank/version.rb

@@ -0,0 +1,5 @@
+module Bankscrap
+  module Openbank
+    VERSION = '2.0.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: bankscrap-openbank
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- zjuanma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bankscrap
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description: 
+email:
+- zjuanma@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bankscrap-openbank.gemspec
+- lib/bankscrap-openbank.rb
+- lib/bankscrap/openbank/account.rb
+- lib/bankscrap/openbank/bank.rb
+- lib/bankscrap/openbank/card.rb
+- lib/bankscrap/openbank/utils.rb
+- lib/bankscrap/openbank/version.rb
+homepage: https://github.com/zjuanma/bankscrap-openbank
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Openbank adapter for Bankscrap
+test_files: []