Merge pull request #13 from vinicciusguedes/develop

Develop
vinicciusguedes · Jan 20, 2025 · 7ad6cb9 · 7ad6cb9
2 parents 86c4f85 + 5942b59
commit 7ad6cb9
Show file tree

Hide file tree

Showing 13 changed files with 54 additions and 55 deletions.
diff --git a/README.md b/README.md
@@ -1,19 +1,18 @@
 [![Packagist](https://img.shields.io/packagist/v/vinicciusguedes/laravel-cnab.svg?style=flat-square)](https://github.com/vinicciusguedes/laravel-cnab)
 [![Packagist](https://img.shields.io/packagist/dt/vinicciusguedes/laravel-cnab.svg?style=flat-square)](https://github.com/vinicciusguedes/laravel-cnab)
-[![Packagist](https://img.shields.io/packagist/l/vinicciusguedes/laravel-cnab.svg?style=flat-square)](https://github.com/vinicciusguedes/laravel-cnab)
-[![build](https://github.com/vinicciusguedes/laravel-cnab/actions/workflows/build.yml/badge.svg)](https://github.com/vinicciusguedes/laravel-cnab/actions/workflows/build.yml)
+[![MIT Licensed](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/vinicciusguedes/laravel-bitwise/build.yml?style=flat-square)](https://github.com/vinicciusguedes/laravel-cnab/actions)
 [![GitHub forks](https://img.shields.io/github/forks/vinicciusguedes/laravel-cnab.svg?style=social&label=Fork)](https://github.com/vinicciusguedes/laravel-cnab)
 
 # Laravel Cnab
-Pacote para gerar boletos, remessas e leitura de retorno.
+Pacote PHP para geração de boletos bancários, criação de remessas no formato padrão de bancos e leitura de arquivos de retorno. Facilita a integração com sistemas financeiros e bancários, proporcionando funcionalidades para a emissão e controle de boletos, bem como a interpretação dos arquivos de retorno para atualização de status e conciliação bancária.
 
-**Projeto atualizado para o PHP 7.2, utilize sempre a última versão do PHP**
 
-[Documentação do Projeto](https://laravel-cnab.readthedocs.io/)
+[Documentação do Projeto](https://github.com/vinicciusguedes/laravel-cnab/tree/master/docs/source/usage)
 
 ## Instalação
 
-Via linha de comando:
+Você pode instalar o pacote através do Composer:
 ```composer
 composer require vinicciusguedes/laravel-cnab
 ```
@@ -25,10 +24,5 @@ Ou, coloque em seu arquivo composer.json:
 }
 ```
 
-## Doações
-
-**Estamos em busca de *doadores* e *patrocinadores* para ajudar a financiar parte do desenvolvimento deste pacote**
-
-Este é um projeto totalmente *OpenSource*, para usa-lo, copia-lo e modifica-lo você não paga absolutamente nada. Porém para continuarmos a mante-lo de forma adequada é necessária alguma contribuição seja feita, seja auxiliando na codificação, na documentação, na realização de testes e identificação de falhas e BUGs.
-
-Mas também, caso você ache que qualquer informação obtida aqui, lhe foi útil e que isso vale de algum dinheiro e está disposto a doar algo, sinta-se livre para enviar qualquer quantia, seja diretamente ao autor ou através do PayPal e do PagSeguro.
+___ 
+**Desenvolvedor:** Viníccius Guedes
diff --git a/composer.json b/composer.json
@@ -3,7 +3,12 @@
     "description": "Biblioteca para gerar boletos, remessas e leitura de retorno em laravel",
     "keywords": [
         "vinicciusguedes",
-        "laravel-cnab"
+        "laravel-cnab",
+        "cnab",
+        "cnab240",
+        "cnab400",
+        "remessa",
+        "boleto"
     ],
     "homepage": "https://github.com/vinicciusguedes/laravel-cnab",
     "license": "MIT",

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,4 +1,4 @@
-Laravel Boleto's Docs
+Laravel CNAB Docs
 =====================
 
 .. toctree::

diff --git a/docs/source/usage/remessa/bancobrasil.rst b/docs/source/usage/remessa/bancobrasil.rst
@@ -11,10 +11,10 @@ This bank has the following mandatory fields:
 .. code-block:: php
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Bb;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Bb;
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Bb;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Bb;
 
     $send->setBeneficiario($beneficiario)
         ->setCarteira(11)
@@ -37,10 +37,10 @@ Or, Simply:
     ];
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Bb($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Bb($sendArray);
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Bb($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Bb($sendArray);
 
 .. ATTENTION::
     To generate the file see the :ref:`send` session.
diff --git a/docs/source/usage/remessa/banconordeste.rst b/docs/source/usage/remessa/banconordeste.rst
@@ -8,10 +8,10 @@ This bank has the following mandatory fields:
 .. code-block:: php
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Bnb;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Bnb;
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Bnb;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Bnb;
 
     $send->setBeneficiario($beneficiario)
         ->setCarteira(21)
@@ -30,10 +30,10 @@ Or, Simply:
     ];
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Bnb($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Bnb($sendArray);
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Bnb($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Bnb($sendArray);
 
 .. ATTENTION::
     To generate the file see the :ref:`send` session.
diff --git a/docs/source/usage/remessa/bancoob.rst b/docs/source/usage/remessa/bancoob.rst
@@ -10,10 +10,10 @@ This bank has the following mandatory fields:
 .. code-block:: php
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Bancoob;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Bancoob;
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Bancoob;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Bancoob;
 
     $send->setBeneficiario($beneficiario)
         ->setCarteira(1)
@@ -34,10 +34,10 @@ Or, Simply:
     ];
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Bancoob($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Bancoob($sendArray);
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Bancoob($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Bancoob($sendArray);
 
 .. ATTENTION::
     To generate the file see the :ref:`send` session.
diff --git a/docs/source/usage/remessa/banrisul.rst b/docs/source/usage/remessa/banrisul.rst
@@ -11,10 +11,10 @@ This bank has the following mandatory fields:
 .. code-block:: php
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Banrisul;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Banrisul;
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Banrisul;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Banrisul;
 
     $send->setBeneficiario($beneficiario)
         ->setCarteira(1)
@@ -37,10 +37,10 @@ Or, Simply:
     ];
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Banrisul($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Banrisul($sendArray);
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Banrisul($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Banrisul($sendArray);
 
 .. ATTENTION::
     To generate the file see the :ref:`send` session.
diff --git a/docs/source/usage/remessa/bradesco.rst b/docs/source/usage/remessa/bradesco.rst
@@ -11,10 +11,10 @@ This bank has the following mandatory fields:
 .. code-block:: php
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Bradesco;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Bradesco;
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Bradesco;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Bradesco;
 
     $send->setBeneficiario($beneficiario)
         ->setIdremessa(1)
@@ -37,10 +37,10 @@ Or, Simply:
     ];
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Bradesco($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Bradesco($sendArray);
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Bradesco($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Bradesco($sendArray);
 
 .. ATTENTION::
     To generate the file see the :ref:`send` session.
diff --git a/docs/source/usage/remessa/caixa.rst b/docs/source/usage/remessa/caixa.rst
@@ -10,10 +10,10 @@ This bank has the following mandatory fields:
 .. code-block:: php
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Caixa;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Caixa;
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Caixa;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Caixa;
 
     $send->setBeneficiario($beneficiario)
         ->setIdremessa(1)
@@ -34,10 +34,10 @@ Or, Simply:
     ];
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Caixa($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Caixa($sendArray);
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Caixa($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Caixa($sendArray);
 
 .. ATTENTION::
     To generate the file see the :ref:`send` session.
diff --git a/docs/source/usage/remessa/hsbc.rst b/docs/source/usage/remessa/hsbc.rst
@@ -10,10 +10,10 @@ This bank has the following mandatory fields:
 .. code-block:: php
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Hsbc;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Hsbc;
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Hsbc;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Hsbc;
 
     $send->setBeneficiario($beneficiario)
         ->setCarteira('CSB')
@@ -34,10 +34,10 @@ Or, Simply:
     ];
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Hsbc($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Hsbc($sendArray);
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Hsbc($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Hsbc($sendArray);
 
 .. ATTENTION::
     To generate the file see the :ref:`send` session.
diff --git a/docs/source/usage/remessa/itau.rst b/docs/source/usage/remessa/itau.rst
@@ -9,10 +9,10 @@ This bank has the following mandatory fields:
 .. code-block:: php
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Itau;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Itau;
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Itau;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Itau;
 
     $send->setBeneficiario($beneficiario)
         ->setCarteira(109)
@@ -31,10 +31,10 @@ Or, Simply:
     ];
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Itau($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Itau($sendArray);
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Itau($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Itau($sendArray);
 
 .. ATTENTION::
     To generate the file see the :ref:`send` session.
diff --git a/docs/source/usage/remessa/santander.rst b/docs/source/usage/remessa/santander.rst
@@ -10,10 +10,10 @@ This bank has the following mandatory fields:
 .. code-block:: php
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Santander;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Santander;
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Santander;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Santander;
 
     $send->setBeneficiario($beneficiario)
         ->setCarteira(101)
@@ -34,10 +34,10 @@ Or, Simply:
     ];
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Santander($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Santander($sendArray);
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Santander($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Santander($sendArray);
 
 .. ATTENTION::
     To generate the file see the :ref:`send` session.
diff --git a/docs/source/usage/remessa/sicredi.rst b/docs/source/usage/remessa/sicredi.rst
@@ -11,10 +11,10 @@ This bank has the following mandatory fields:
 .. code-block:: php
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Sicredi;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Sicredi;
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Sicredi;
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Sicredi;
 
     $send->setBeneficiario($beneficiario)
         ->setIdremessa(1)
@@ -37,10 +37,10 @@ Or, Simply:
     ];
 
     // for 400 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Banco\Sicredi($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab400\Cobranca\Banco\Sicredi($sendArray);
 
     // Or, for 240 positions
-    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Banco\Sicredi($sendArray);
+    $send = new VinicciusGuedes\LaravelCnab\Cnab\Remessa\Cnab240\Cobranca\Banco\Sicredi($sendArray);
 
 
 .. ATTENTION::