bank_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6f2aa174d501060b2a458a4275f4189a2f6fe55
+  data.tar.gz: bcaf182763556fc6b996c4ebf8406365c425d2f8
+SHA512:
+  metadata.gz: e89a962dc628fbfd6e4f65cafe43dff5f62fdce890b2da14ccefe45e91040164b590ffb39fe02563d256ce59168f12471a9c12ca6bc87dff3e1b7a6244ccd3f0
+  data.tar.gz: 5a923b6a828655f1edaea35ceae699d249806eea2cf3547267e839345e870065b7a6449cc19482e2b8f9a24bd209d9cacf5e5ba0ab751547dced7400d1708759

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at oaestay@uc.cl. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bank_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    bank_api (0.1.0)
+      pincers
+      timezone (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    childprocess (0.8.0)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.9.18)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    pincers (0.7.12)
+      nokogiri (~> 1.6)
+      selenium-webdriver (~> 2.45)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubyzip (1.2.1)
+    selenium-webdriver (2.53.4)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.0)
+      websocket (~> 1.0)
+    timezone (1.2.9)
+    websocket (1.2.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bank_api!
+  bundler (~> 1.16)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 oaestay
+
+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,58 @@
+# BankApi
+
+BankApi is a gem that wraps chilean banks web operations. For now, it can get recent deposits on Banco de Chile accounts.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bank_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bank_api
+
+## Usage
+
+For now, the gem can only get recent deposits of Banco de Chile accounts (only Enterprise accounts have been tested). To add your credentials so the client can login, create the following initializer:
+
+```
+# config/initializers/bank_api.rb
+
+BankApi.configure do |config|
+  # Add the rut linked to the account
+  config.bdc_user_rut = '12345678-9'
+  # Add the account's password
+  config.bdc_password = 'secretpassword'
+  # Add the account's enterprise rut
+  config.bdc_company_rut = '98765432-1'
+  config.days_to_check = 3
+end
+
+```
+
+The days to check is set by default to 6, and can be configured as seen in the initializer.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bank_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BankApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/platanus/bank-api-gem/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bank_api.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bank_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bank_api"
+  spec.version       = BankApi::VERSION
+  spec.authors       = ["oaestay"]
+  spec.email         = ["oaestay@uc.cl"]
+
+  spec.summary       = 'Wrapper for chilean banks'
+  spec.description   = 'Wrapper for chilean banks'
+  spec.homepage      = 'https://github.com/platanus/bank-api-gem'
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'pincers'
+  spec.add_dependency 'timezone', '~> 1.0'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bank_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bank_api/clients/banco_de_chile_company_client.rb

@@ -0,0 +1,109 @@
+require 'timezone'
+
+require 'bank_api/clients/base_client'
+
+module BankApi::Clients
+  class BancoDeChileCompanyClient < BaseClient
+    COMPANY_LOGIN_URL = 'https://www.empresas.bancochile.cl/cgi-bin/navega?pagina=enlinea/login_fus'
+    COMPANY_DEPOSITS_URL = 'https://www.empresas.bancochile.cl/GlosaInternetEmpresaRecibida/ConsultaRecibidaAction.do'
+
+    TABLE_OFFSET = 1
+
+    DATE_COLUMN = 0
+    RUT_COLUMN = 4
+    AMOUNT_COLUMN = 6
+    STATE_COLUMN = 7
+
+    NUMBER_OF_COLUMNS = 9
+
+    def initialize(config = BankApi::Configuration.new)
+      @bdc_company_rut = config.bdc_company_rut
+      @bdc_user_rut = config.bdc_user_rut
+      @bdc_password = config.bdc_password
+      super
+    end
+
+    private
+
+    def validate_credentials
+      raise BankApi::MissingCredentialsError if [
+        @bdc_company_rut,
+        @bdc_user_rut,
+        @bdc_password
+      ].any?(&:nil?)
+    end
+
+    def get_deposits
+      login
+      goto_deposits
+      select_deposits_range
+      submit_deposits_form
+      deposits = extract_deposits_from_html
+      browser.close
+      deposits
+    end
+
+    def login
+      goto_login_url
+      set_login_values
+      click_login_button
+    end
+
+    def goto_login_url
+      browser.goto COMPANY_LOGIN_URL
+    end
+
+    def set_login_values
+      browser.search('#rutemp1').set without_verifier_digit_or_separators(@bdc_company_rut)
+      browser.search('#dvemp1').set verifier_digit(@bdc_company_rut)
+      browser.search('#rut1').set without_verifier_digit_or_separators(@bdc_user_rut)
+      browser.search('#verificador1').set verifier_digit(@bdc_user_rut)
+      browser.search('#pin1').set @bdc_password
+    end
+
+    def click_login_button
+      browser.search('.btn_amarillodegrade').click
+    end
+
+    def goto_deposits
+      browser.goto COMPANY_DEPOSITS_URL
+    end
+
+    def select_deposits_range
+      timezone = Timezone['America/Santiago']
+      range_start = (
+        timezone.utc_to_local(Time.now).to_date - @days_to_check
+      ).strftime("%d/%m/%Y")
+      browser.search('input[name=initDate]').set(range_start)
+    end
+
+    def submit_deposits_form
+      browser.search('#consultar').click
+    end
+
+    def any_deposits?
+      browser.search('table#sin_datos').count.zero?
+    end
+
+    def extract_deposits_from_html
+      deposits = []
+
+      return deposits unless any_deposits?
+
+      deposit = {}
+      browser.search('.linea1tabla').each_with_index do |div, index|
+        if ((index - TABLE_OFFSET) % NUMBER_OF_COLUMNS) == RUT_COLUMN
+          deposit[:rut] = div.text
+        elsif ((index - TABLE_OFFSET) % NUMBER_OF_COLUMNS) == DATE_COLUMN
+          deposit[:date] = Date.parse div.text
+        elsif ((index - TABLE_OFFSET) % NUMBER_OF_COLUMNS) == AMOUNT_COLUMN
+          deposit[:amount] = div.text.delete(',')
+        elsif ((index - TABLE_OFFSET) % NUMBER_OF_COLUMNS) == STATE_COLUMN
+          deposits << deposit if div.text == 'Aprobada'
+          deposit = {}
+        end
+      end
+      deposits
+    end
+  end
+end

data/lib/bank_api/clients/base_client.rb

@@ -0,0 +1,51 @@
+require 'pincers'
+
+require 'bank_api/exceptions'
+require 'bank_api/sign_deposits'
+require 'bank_api/values/deposit_entry'
+
+module BankApi::Clients
+  class BaseClient
+    def initialize(config = BankApi::Configuration.new)
+      @days_to_check = config.days_to_check
+    end
+
+    def get_recent_deposits
+      validate_credentials
+      parse_entries(get_deposits)
+    end
+
+    private
+
+    def validate_credentials
+      raise NotImplementedError
+    end
+
+    def get_deposits
+      raise NotImplementedError
+    end
+
+    def without_verifier_digit_or_separators(rut)
+      rut.split("-")[0].delete('.')
+    end
+
+    def verifier_digit(rut)
+      rut.split("-")[1]
+    end
+
+    def browser
+      @browser ||= Pincers.for_webdriver :chrome
+    end
+
+    def parse_entries(entries)
+      deposit_entries = entries.map do |entry|
+        BankApi::Values::DepositEntry.new(
+          entry[:amount],
+          entry[:date],
+          entry[:rut]
+        )
+      end
+      BankApi::SignDeposits.sign(deposit_entries)
+    end
+  end
+end

data/lib/bank_api/configuration.rb

@@ -0,0 +1,13 @@
+module BankApi
+  class Configuration
+    attr_accessor :bdc_user_rut, :bdc_password, :bdc_company_rut, :days_to_check
+
+    def initialize
+      @bdc_user_rut = nil
+      @bdc_password = nil
+      @bdc_company_rut = nil
+
+      @days_to_check = 6
+    end
+  end
+end

data/lib/bank_api/exceptions.rb

@@ -0,0 +1,3 @@
+module BankApi
+  class MissingCredentialsError < StandardError; end
+end

data/lib/bank_api/sign_deposits.rb

@@ -0,0 +1,44 @@
+require 'digest/sha1'
+
+module BankApi::SignDeposits
+  extend self
+
+  def sign(deposits)
+    entries = get_entry_occurrencies(deposits)
+    sign_entries(entries)
+  end
+
+  private
+
+  def get_entry_occurrencies(deposits)
+    entry_occurrencies_keys = {}
+
+    deposits.map do |entry|
+      key = entry_key(entry)
+      occurrency = entry_occurrencies_keys[key] || 0
+      entry_occurrencies_keys[key] = occurrency + 1
+
+      { deposit_entry: entry, occurrencies: entry_occurrencies_keys[key] }
+    end
+  end
+
+  def sign_entries(entries)
+    entries.each { |entry_occurrency| sign_entry(entry_occurrency) }
+  end
+
+  def sign_entry(entry_occurrency)
+    entry = entry_occurrency[:deposit_entry]
+    occurrencies = entry_occurrency[:occurrencies]
+
+    entry.signature = entry_signature(entry, occurrencies)
+  end
+
+  def entry_signature(entry, occurrencies)
+    key = entry_key(entry)
+    Digest::SHA1.hexdigest("#{key}|#{occurrencies}")
+  end
+
+  def entry_key(entry)
+    "#{entry.amount}|#{entry.date}|#{entry.rut}"
+  end
+end

data/lib/bank_api/values/deposit_entry.rb

@@ -0,0 +1,11 @@
+module BankApi::Values
+  class DepositEntry
+    attr_accessor :amount, :date, :rut, :signature
+
+    def initialize(amount, date, rut)
+      @amount = amount
+      @date = date
+      @rut = rut
+    end
+  end
+end

data/lib/bank_api/version.rb

@@ -0,0 +1,3 @@
+module BankApi
+  VERSION = "0.1.0"
+end

data/lib/bank_api.rb

@@ -0,0 +1,25 @@
+require "bank_api/configuration"
+require "bank_api/version"
+require 'bank_api/clients/banco_de_chile_company_client'
+
+module BankApi
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.get_bdc_recent_company_deposits
+    Clients::BancoDeChileCompanyClient.new(configuration).get_recent_deposits
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: bank_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- oaestay
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pincers
+  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: timezone
+  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.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wrapper for chilean banks
+email:
+- oaestay@uc.cl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bank_api.gemspec
+- bin/console
+- bin/setup
+- lib/bank_api.rb
+- lib/bank_api/clients/banco_de_chile_company_client.rb
+- lib/bank_api/clients/base_client.rb
+- lib/bank_api/configuration.rb
+- lib/bank_api/exceptions.rb
+- lib/bank_api/sign_deposits.rb
+- lib/bank_api/values/deposit_entry.rb
+- lib/bank_api/version.rb
+homepage: https://github.com/platanus/bank-api-gem
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Wrapper for chilean banks
+test_files: []