vinifranco/zip-return-parser

Interpretador para arquivos de retorno em ZIP

v1.1.0 2023-09-22 00:00 UTC

Requires

• php: ^7.2.5|^8.0
• ext-mbstring: *
• ext-zip: *
• nesbot/carbon: ^2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3
• phpunit/phpunit: ^7
• vimeo/psalm: ^4

MIT

• Vini Franco
• Murilo Sandiego Ferreira
• Altierres Washington

README

Pacote para ler arquivos de retorno de APIs de banking que estejam em formato ZIP.

• Interpretador para arquivos de retorno em ZIP
  • Requerimentos
  • Motivação
    • Uso
    • Créditos
    • Licença

Requerimentos

• PHP >=7.2.5.
• PHP extensão ZIP
• PHP extensão Mbstring

Motivação

Algumas APIs de bancos retornam os arquivos - seja de movimentação, remessa ou qualquer outro tipo de retorno - zipados, codificados em formato base64 em respostas de API. Para facilitar o processo, este pacote contém funções de processamento comum para tais arquivos.

Uso

Exemplo com o formato da API do banco Sicoob, que tem um campo 'resultado' e um 'arquivo' que está codificado em formato base64. O arquivo que está dentro do ZIP é um JSON:

  use Vini\ZipReturnParser\Handler;
  use Vini\ZipReturnParser\Responses\Sicoob;
  use Vini\ZipReturnParser\Factories\FileFormatFactory;
  
  // ... busca o arquivo na API do banco: $respostaApi
  
  // Cria uma instância do handler
  $handler = new Handler();

  // Cria o formato de resposta
  $response = (new Sicoob($respostaApi))->format();

  // Passa o arquivo para o handler
  $handler->fromBase64($response->arquivo)->make();

  // Usa o primeiro arquivo e cria uma instância da classe que trata JSON automaticamente
  $file = $handler->first()->toFormat(FileFormatFactory::FORMAT_JSON);

  // Imprime na tela o conteúdo do arquivo (nesse passo qualquer outro processamento pode ser feito)
  var_dump($file->getDecoded());

  // Limpa os arquivos temporários do disco
  $handler->clean();

Créditos

Agradeço a colaboração dos amigos nos testes e processo de elaboração da ideia que tornou esse pacote realidade:

• Murilo Sandiego
• Altierres Washington

Licença

MIT