bankscrap-arquia 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5da0a8be1c72e2f78a71e1de5bd7162b3f81eab6
+  data.tar.gz: cb67eb4591184e996e058d41d4f5f0afc07f66c3
+SHA512:
+  metadata.gz: 8418b19ad9f11e3476f1538e37e812620f5464e7160f2b7ea53a122af6cfe874bf56a01ae8a60bed9bd615f78490f43e72a6be3abfba11c0f85570aa446baac2
+  data.tar.gz: e58074b6b0a58f4ac823ae0ce66cc42b77bc622efb4acaa421f79b4b066f5bf7ca5721da808b03a67a584207e9a526016646db6328763a077ff05d26052a4c68

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-arquia.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,52 @@
+# Bankscrap::Arquia
+
+Bankscrap adapter for [Arquia Banca](https://www.arquia.es/) (only tested with personal accounts).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bankscrap-arquia'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bankscrap-arquia
+
+## Usage
+
+### From terminal
+#### Bank account balance
+
+    $ bankscrap balance Arquia --user YOUR_USER --password YOUR_PASSWORD --extra=nif:YOUR_NIF
+
+
+#### Transactions
+
+    $ bankscrap transactions Arquia --user YOUR_USER --password YOUR_PASSWORD --extra=nif:YOUR_NIF
+
+---
+
+For more details on usage instructions please read [Bankscrap readme](https://github.com/bankscrap/bankscrap/#usage).
+
+### From Ruby code
+
+```ruby
+require 'bankscrap-arquia'
+arquia = Bankscrap::Arquia::Bank.new(YOUR_USER, YOUR_PASSWORD, extra_args: {nif: YOUR_NIF})
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/bankscrap/bankscrap-arquia/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-arquia.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/arquia/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bankscrap-arquia'
+  spec.version       = Bankscrap::Arquia::VERSION
+  spec.authors       = ['Javier Cuevas']
+  spec.email         = ['javi@diacode.com']
+  spec.summary       = 'Arquia 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.3'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/bankscrap-arquia.rb

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

data/lib/bankscrap/arquia/bank.rb

@@ -0,0 +1,162 @@
+require 'bankscrap'
+require 'securerandom'
+
+module Bankscrap
+  module Arquia
+    class Bank < ::Bankscrap::Bank
+
+      # Define the endpoints for the Bank API here
+      BASE_ENDPOINT     = 'https://api.arquia.es'.freeze
+      AUTH_ENDPOINT     = '/api/Auth'.freeze
+      TOKEN_ENDPOINT    = '/token'.freeze
+      USER_ENDPOINT     = '/api/user'.freeze
+      PRODUCTS_ENDPOINT = '/api/products'.freeze
+      ACCOUNTS_ENDPOINT = '/api/accounts'.freeze
+
+      def initialize(user, password, log: false, debug: false, extra_args: nil)
+        @user = user
+        @password = password
+        @log = log
+        @debug = debug
+        @nif = extra_args.with_indifferent_access['nif'].dup.upcase
+
+        initialize_connection
+
+        add_headers(
+          'Authorization' => 'Bearer',
+          'api-version' => '2',
+          'Content-Type' => 'application/json; charset=utf-8',
+          'Host' =>  'api.arquia.es',
+          'User-Agent' => ''
+        )
+
+        login
+        super
+      end
+
+      # Fetch all the accounts for the given user
+      #
+      # Should returns an array of Bankscrap::Account objects
+      def fetch_accounts
+        # First we need to fetch the products / views for the user
+        
+        user_response = JSON.parse(get(BASE_ENDPOINT + USER_ENDPOINT))
+        view = user_response['views'].find { |view| view['type'] == 0}
+        view_id = view['id']
+
+        # Now we get the accounts for that product / view
+        products_response = JSON.parse(get(BASE_ENDPOINT + PRODUCTS_ENDPOINT + "/#{view_id}"))
+
+        # Find which products are accounts
+        products_response.select! do |product|
+          product['$type'] == 'Arquia.Backend.Domain.Models.Entities.Account, Arquia.Backend.Domain.Models'
+        end
+
+        products_response.map { |account| build_account(account) }
+      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)
+        from = format_date(start_date)
+        to = format_date(end_date)
+        page = 1
+        transactions = []
+
+        loop do
+          url = BASE_ENDPOINT + ACCOUNTS_ENDPOINT + "/#{account.id}/extract/from/#{from}/to/#{to}/page/#{page}"
+          response = get(url)
+          json = JSON.parse(response)
+          transactions += json.map do |data|
+            build_transaction(data, account)
+          end
+          page += 1
+          break unless json.any?
+        end
+
+        transactions
+      end
+
+      private
+
+      def login
+        # First step for login: request keyboard positions
+        params = {
+          "$type" => "Arquia.Backend.Domain.Models.ValueObjects.IdentificationData, Arquia.Backend.Domain.Models",
+          "DocumentId" => @nif,
+          "UserName" => @user
+        }
+        auth_response = JSON.parse(post(BASE_ENDPOINT + AUTH_ENDPOINT, fields: params.to_json))
+        keyboard_order = auth_response['order']
+        required_pw_positions = auth_response['positions']
+        identifier = auth_response['identifier']
+
+        # Second step: get token
+        params = {
+          'client_id' => 'mobilefrontend',
+          'grant_type' => 'password',
+          'documentid' => @nif,
+          'username' =>  @user,
+          'positions' => get_correct_positions(keyboard_order, required_pw_positions),
+          'ChallengeId' => identifier,
+          'client_version' => '1.1.5'
+        }
+
+        # Note this request is a form type, not a json, that's why we don't use params.to_json
+        token_response = JSON.parse(post(BASE_ENDPOINT + TOKEN_ENDPOINT, fields: params))        
+        token = token_response['access_token']
+
+        # Set the token as header for future requests
+        add_headers(
+          'Authorization' => "Bearer #{token}"
+        )
+      end
+
+      # Build an Account object from API data
+      def build_account(data)
+        Account.new(
+          bank: self,
+          id: data['numProd'],
+          name: data['description'],
+          available_balance: data['availableBalance'],
+          balance: data['balance'],
+          currency: 'EUR',
+          iban: data['iban']['ibanCode'],
+          description: data['description']
+        )
+      end
+
+      # Build a transaction object from API data
+      def build_transaction(data, account)
+        Transaction.new(
+          account: account,
+          id: data['id'],
+          amount: Money.new(data['amount'].to_f * 100, 'EUR'),
+          description: data['description'],
+          effective_date: data['valueDate'].to_date, # Format is 2016-05-02T00:00:00
+          currency: 'EUR', # We only know the API returns data['currency'] == 0 for EUR
+          balance: Money.new(data['balance'].to_f * 100, 'EUR')
+        )
+      end
+
+      private
+
+      # Example:
+      # @password = '12345678'
+      # get_correct_positions("4912650378", "03") => "20"
+      # Required position 0 is "1", which matches position 2
+      # Required position 3 is "4", which matches position 0
+      def get_correct_positions(keyboard_order, required_pw_positions)
+        required_pw_positions.chars.collect do |position|
+          keyboard_order.index(@password[position.to_i])
+        end.join
+      end
+
+      def format_date(date)
+        date.strftime('%Y-%m-%d')
+      end
+    end
+  end
+end

data/lib/bankscrap/arquia/version.rb

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

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: bankscrap-arquia
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Javier Cuevas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-02 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.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !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:
+- javi@diacode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bankscrap-arquia.gemspec
+- lib/bankscrap-arquia.rb
+- lib/bankscrap/arquia/bank.rb
+- lib/bankscrap/arquia/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: Arquia adapter for Bankscrap
+test_files: []