xerpa / bran_checker

Elixir package to validate bank account numbers of Brazilian banks.

BRAN Checker

(Brazilian Account Number Checker)

This rules are based on this document

Supported Banks

• C6
• Itaú
• Nubank
• Santander

Next steps:

• Implement validator for:
  • Bradesco
  • Banco do Brasil
  • Caixa Econômica Federal
• Improve documentation
• Improve test coverage

Installation

def deps do
  [
    {:bran, "~> 1.0.0"}
  ]
end

bran_checker's Issues

Adicionar validação em digito

Criar nova função na implementação dos bancos com alguma forma de validar o digito, conforme a necessidade do banco.

Criar behavior de validação de banco

Criar um behavior para as implementações dos bancos.

Surgiu uma duvida. Com possíveis resultados diferentes em alguns bancos, faz sentido centralizar todas as specs?

Criar validação para nubank

Implementar validação para nubank, baseado neste link

Validação do digito incorreta

A validação abaixo precisa ser quebrada.
A regra diz que se o digit_result for 10, ele deve ter o valor 0.
Então a variavel digit_result precisa ser modificada e ai fazer a comparação se digit_result == digit

https://github.com/Xerpa/bank_validator_br/blob/7d4bfe775d10bb5e26343aaab420984a5d7b25f1/lib/banks/itau.ex#L25

Adicionar mais casos de testes

Precisamos adicionar mais casos de testes com contas válidas para as validações que já temos (Itaú e Satander).

Para obtermos contas válidas podemos utilizar esse gerador.

Atualizar README.md

Criar projeto no coveralls e no sourcelevel na organização da XERPA e atualizar as badges.

• coveralls
• sourcelevel

Renomear "agency" para "bank_branch"

A tradução correta para agencia bancária é bank branch

Criar script de deploy do pacote

Faz sentido essa função retornar só true/false?

Faz sentido manter essa função retornando só true/false e gerando exceção nos casos inesperados/não suportados?
Refatorar a função is_valid? ou criar uma nova que retorna uma tupla?

{:ok, "message"}
{:error, ""}
{:not_implemented, ""} 

https://github.com/Xerpa/bank_validator_br/blob/43c60e25e54fcbb8125ef03238a1f11780810788/lib/bank_validator_br.ex#L21-L34

Refatorar parser

Atualizar parser para verificar se input foi realizado com números, para evitar excessão na função abaixo
https://github.com/Xerpa/bank_validator_br/blob/43c60e25e54fcbb8125ef03238a1f11780810788/lib/bank_validator_br.ex#L38-L42

Habilitarmos o doctests

Como sugerido pelo @volcov em: #29 (comment)_

Faria sentido adicionarmos o doctest para lib?

rem(mod_factor) ñ nos atende se o mod_factor != 10

achei bem interessante a estrategia de passar o rem(mod_factor) novamente para evitar que o resultado tenha mais de 1 digito, mas aparentemente só funciona para mod_factor = 10.

iex(30)> rem(10, 10)
0
iex(31)> rem(4, 10)
4
iex(32)> rem(10, 11)
10 <--- isso seria um problema pois não deveria existir um digito verificador de 2 digitos
iex(33)> rem(2, 11)
2
iex(34)> rem(11, 11)
0

Originally posted by @brunorafa in #24 (comment)

atualizar badge de CI no README para CircleCI

Deveria ter sido feito no PR que migrou pro CircleCI, mas infelizmente passou batido.

Referência:

• Adding Status Badges - CircleCI