Ajustando a função is_valid PT 2

README.md

@@ -48,7 +48,9 @@ False
   - [is_valid_cep](#is_valid_cep)
   - [format_cep](#format_cep)
   - [remove_symbols_cep](#remove_symbols_cep)
-  - [generate_cep](#generate_cep)  
+  - [generate_cep](#generate_cep)
+- [Boleto](#boleto)
+  - [is_valid_boleto](#is_valid_boleto)  
 
 ## CPF
 
@@ -176,6 +178,17 @@ Gera um CEP válido aleatório.
 '77520503'
 ```
 
+## Boleto
+
+### is_valid_boleto
+
+Verifica se o boleto é valido. Apenas números, formatados como string. Não verifica se o boleto existe.
+
+```python
+>>> from brutils import is_valid_boleto
+>>> is_valid_boleto('x')
+False
+```
 
 ## Contributing
 

README_EN.md

@@ -49,6 +49,8 @@ False
   - [format_cep](#format_cep)
   - [remove_symbols_cep](#remove_symbols_cep)   
   - [generate_cep](#generate_cep)
+- [Boleto](#boleto)
+  - [is_valid_boleto](#is_valid_boleto)
 
 ## CPF
 
@@ -182,6 +184,18 @@ Generate a valid random CEP.
 '77520503'
 ```
 
+## Boleto
+
+### is_valid_boleto
+
+Check if boleto is valid. Numbers only, formatted as strings. Does not check if boleto exists.
+
+```python
+>>> from brutils import is_valid_boleto
+>>> is_valid_boleto('x')
+False
+```
+
 ## Contributing
 
 Collaboration is super welcome! We prepared the [contributing file][contributing] to help you in the first steps. Every little bit of help counts! Feel free to create new [GitHub issues][github-issues] and interact here.

brutils/__init__.py

@@ -16,4 +16,4 @@
     generate as generate_cep,
     remove_symbols as remove_symbols_cep,
 )
-from brutils.boleto import validate
+from brutils.boleto import is_valid

brutils/boleto.py

@@ -1,4 +1,4 @@
-def validate(boleto):
+def is_valid(boleto):
     boleto_str = str(boleto)
 
     if not boleto_str.isdigit():

tests/test_boleto.py

@@ -1,13 +1,38 @@
 from unittest import TestCase
-from brutils.boleto import validate
+from brutils.boleto import is_valid
 
 
 class Boleto(TestCase):
-    def test_validate(self):
+    def test_is_valid(self):
         ## When boleto's len is different than 47 and 48, returns false
-        self.assertFalse(validate("1"))
-        self.assertTrue(validate(47 * "1"))
-        self.assertTrue(validate(48 * "1"))
+        self.assertFalse(is_valid("1"))
+        self.assertTrue(is_valid(47 * "1"))
+        self.assertTrue(is_valid(48 * "1"))
         ## When boleto is not string, returns False
-        self.assertFalse(validate(1))
+        self.assertFalse(is_valid(1))
         ##verificação  -> fazer
+        #    A linha é composta por 47 ou 48 dígitos que são distribuídos em 5 campos:
+        #         | campo 1   |  campo 2   |  campo 3   |4|    campo 5    |
+        #          1112X.XXXX3.XXXXX.XXXXX3.XXXXX.XXXXX3.4.5555.6666666666
+        #           *5*   *5*   *5*   *6*    *5*   *6*  *1* *4*   *10*
+        # 1 - Os três primeiros números da linha digitável identificam o código
+        #      do banco que emitiu o boleto.
+        # 2 - O quarto dígito indica a moeda. No caso do real será sempre o número 9.
+        # 3 - Esse número representa o dígito verificador do boleto. Existe um dígito
+        #      verificador no primeiro campo da linha, outro no segundo campo e outro
+        #      no terceiro campo.
+        # 4 - O único número do campo 4 representa o dígito verificador geral.
+        # 5 - Os quatro números que aparecem depois do dígito verificador geral
+        #      representam o fator de vencimento do boleto. Importante ressaltar
+        #      que não será apresentado na forma de dia, mês e ano. Aparecerá a
+        #      quantidade de dias que se passaram desde a data-base estipulada pelo
+        #      Banco Central (7 de outubro de 1997). Ou seja, um boleto com vencimento
+        #      em 05/09/2022 serão apresentados os números 9099.
+        # 6 - Os 10 últimos números indicam o valor do documento, sem descontos. Ou seja,
+        #      se o valor da conta é R$ 1,00 o final da sua linha digitável será 0000000100.
+        # * - Os demais campos representados na imagem na cor cinza, são chamados de campos
+        #      livres. Nesses campos cada banco pode definir de uma forma, como por exemplo,
+        #      trazendo as informações do cliente (número da agência, número identificador
+        #      do boleto, etc).
+        #
+        # SOURCE: https://forum.casadodesenvolvedor.com.br/topic/45002-quais-dados-est%C3%A3o-contidos-no-c%C3%B3digo-de-barras-do-boleto/