Merge pull request #4 from tecnospeed/feature/cancel

Feature/cancel

Author: ferfabricio

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 Alterações na biblioteca
 
+## [1.3.0] - 12/03/2019
+### Adicionado
+
+Cancelamento de NFSe utilizando o id da nota, consulta do status do cancelamento.
+
 ## [1.2.0] - 11/03/2019
 ### Adicionado
 

README.md

@@ -83,6 +83,16 @@ Os arquivos serão salvos na pasta configurada (a qual precisa ter permissão de
 
 [Exemplo de download utilizando o ID pode ser encontrado aqui](https://github.com/tecnospeed/plugnotas-php/blob/master/examples/nfse.download.php) e [exemplo de download utilizando o CNPJ e ID Integração aqui](https://github.com/tecnospeed/plugnotas-php/blob/master/examples/nfse.download.cnpjId.php).
 
+### Cancelamento
+
+O cancelamento de uma NFSe pode ser realizado da mesma forma com que a busca e o download, informando o ID da Nfse ou o Cnpj do prestador e o ID Integração.
+
+Da mesma forma que a consulta e o download do PDF da Nfse é necessário de um objeto do tipo `TecnoSpeed\Plugnotas\Configuration`, o qual deve ser setado num novo objeto `TecnoSpeed\Plugnotas\Nfse` utilizando o método `setConfiguration`.
+
+Os respectivos métodos para realizar este procedimento são: `cancel` e `cancelByCnpjAndIdIntegracao`.
+
+Ao criar um cancelamento será retornado um protocolo, tal protocolo pode ser utilizado para consultar o status do cancelamento utilizando a rota `cancelStatus`.
+
 ### Exemplos
 
 Você pode conferir alguns exemplos na pasta `/examples`.

examples/nfse.cancel.cnpjId.php

@@ -0,0 +1,22 @@
+<?php
+
+require '../vendor/autoload.php';
+
+use TecnoSpeed\Plugnotas\Configuration;
+use TecnoSpeed\Plugnotas\Nfse;
+
+try {
+    // Criando configuração (este objeto é onde você irá colocar seu api-key)
+    $configuration = new Configuration(
+        Configuration::TYPE_ENVIRONMENT_SANDBOX, // Ambiente a ser enviada a requisição
+        '2da392a6-79d2-4304-a8b7-959572c7e44d' // API-Key
+    );
+
+    $nfse = new Nfse();
+    $nfse->setConfiguration($configuration);
+    $cancelation = $nfse->cancelByCnpjAndIdIntegracao('00000000000191', '000000000001914');
+    var_dump($cancelation);
+} catch (\Exception $e) {
+  var_dump($e);
+}
+

examples/nfse.cancel.php

@@ -0,0 +1,22 @@
+<?php
+
+require '../vendor/autoload.php';
+
+use TecnoSpeed\Plugnotas\Configuration;
+use TecnoSpeed\Plugnotas\Nfse;
+
+try {
+    // Criando configuração (este objeto é onde você irá colocar seu api-key)
+    $configuration = new Configuration(
+        Configuration::TYPE_ENVIRONMENT_SANDBOX, // Ambiente a ser enviada a requisição
+        '2da392a6-79d2-4304-a8b7-959572c7e44d' // API-Key
+    );
+
+    $nfse = new Nfse();
+    $nfse->setConfiguration($configuration);
+    $cancelation = $nfse->cancel('5c3118127ab98414de5e2bd6');
+    var_dump($cancelation);
+} catch (\Exception $e) {
+  var_dump($e);
+}
+

examples/tmp/.gitkeep

@@ -28,6 +28,11 @@ public function __construct(Configuration $configuration)
         $this->url = $configuration->getUrl();
     }
 
+    public function setClient($client)
+    {
+        $this->client = $client;
+    }
+
     public function send($method, $destination, $data)
     {
         try {
@@ -42,7 +47,7 @@ public function send($method, $destination, $data)
 
                 return ResponseObject::parse($response);
             }
-    
+
             $response = $this->client->request(
                 $method,
                 $destination,
@@ -74,7 +79,7 @@ public function download($method, $destination, $data, $fileName)
 
                 return ResponseObject::parse($response);
             }
-    
+
             $response = $this->client->request(
                 $method,
                 $destination,
@@ -85,7 +90,7 @@ public function download($method, $destination, $data, $fileName)
                 ]
             );
 
-            return true;
+            return ResponseObject::parse($response);
         } catch (ClientException $ce) {
             $response = $ce->getResponse();
             return ResponseObject::parse($response);

src/Communication/CallApi.php

@@ -6,11 +6,9 @@
 
 interface IDfe
 {
-    public function downloadPdf($id);
-    public function downloadPdfByCnpjAndIdIntegracao($cnpj, $idIntegracao);
+    public function cancel($id);
+    public function download($id);
     public function find($id);
-    public function findByCnpjAndIdIntegracao($cnpj, $idIntegracao);
-    public function findByIdOrProtocol($idOrProtocol);
     public function send(Configuration $configuration);
     public function toArray();
     public function validate();

src/Interfaces/IDfe.php

@@ -4,9 +4,8 @@
 use FerFabricio\Hydratator\Hydratate;
 use Respect\Validation\Validator as v;
 use TecnoSpeed\Plugnotas\Abstracts\BuilderAbstract;
-use TecnoSpeed\Plugnotas\Configuration;
 use TecnoSpeed\Plugnotas\Communication\CallApi;
-use TecnoSpeed\Plugnotas\Error\ConfigurationRequiredError;
+use TecnoSpeed\Plugnotas\Configuration;
 use TecnoSpeed\Plugnotas\Error\RequiredError;
 use TecnoSpeed\Plugnotas\Error\ValidationError;
 use TecnoSpeed\Plugnotas\Interfaces\IDfe;
@@ -16,9 +15,12 @@
 use TecnoSpeed\Plugnotas\Nfse\Rps;
 use TecnoSpeed\Plugnotas\Nfse\Servico;
 use TecnoSpeed\Plugnotas\Nfse\Tomador;
+use TecnoSpeed\Plugnotas\Traits\Communication;
 
 class Nfse extends BuilderAbstract implements IDfe
 {
+    use Communication;
+
     private $cidadePrestacao;
     private $configuration;
     private $enviarEmail;
@@ -155,7 +157,7 @@ public function validate()
                 v::keyNested('servico.discriminacao'),
                 v::keyNested('servico.cnae'),
                 v::keyNested('servico.iss.aliquota'),
-                v::keyNested('servico.valor.servico')  
+                v::keyNested('servico.valor.servico')
             )->validate($data) ||
             !v::allOf(
                 v::keyNested('prestador.cpfCnpj'),
@@ -210,45 +212,40 @@ public static function fromArray($data)
 
     public function find($id)
     {
-        if (!$this->configuration) {
-            throw new ConfigurationRequiredError('É necessário setar a configuração utilizando o método setConfiguration.');
-        }
-
-        $communication = new CallApi($this->configuration);
+        $communication = $this->getCallApiInstance($this->configuration);
         return $communication->send('GET', "/nfse/${id}", null);
     }
 
     public function findByCnpjAndIdIntegracao($cnpj, $idIntegracao)
     {
-        if (!$this->configuration) {
-            throw new ConfigurationRequiredError('É necessário setar a configuração utilizando o método setConfiguration.');
-        }
-
-        $communication = new CallApi($this->configuration);
+        $communication = $this->getCallApiInstance($this->configuration);
         return $communication->send('GET', "/nfse/consultar/${idIntegracao}/${cnpj}", null);
     }
 
     public function findByIdOrProtocol($idOrProtocol)
     {
-        if (!$this->configuration) {
-            throw new ConfigurationRequiredError('É necessário setar a configuração utilizando o método setConfiguration.');
-        }
-
-        $communication = new CallApi($this->configuration);
+        $communication = $this->getCallApiInstance($this->configuration);
         return $communication->send('GET', "/nfse/consultar/${idOrProtocol}", null);
     }
 
-    public function downloadPdf($id)
+    public function findCancel($id)
     {
-        if (!$this->configuration) {
-            throw new ConfigurationRequiredError('É necessário setar a configuração utilizando o método setConfiguration.');
-        }
+        $communication = $this->getCallApiInstance($this->configuration);
+        return $communication->send('GET', "/nfse/cancelar/status/${id}", null);
+    }
 
+    public function download($id)
+    {
+        return $this->downloadPdf($id);
+    }
+
+    public function downloadPdf($id)
+    {
+        $communication = $this->getCallApiInstance($this->configuration);
         if (!$this->configuration->getNfseDownloadDirectory()) {
             throw new RequiredError('É necessário setar o diretório para download do PDF.');
         }
 
-        $communication = new CallApi($this->configuration);
         return $communication->download(
             'GET',
             "/nfse/pdf/${id}",
@@ -259,20 +256,35 @@ public function downloadPdf($id)
 
     public function downloadPdfByCnpjAndIdIntegracao($cnpj, $idIntegracao)
     {
-        if (!$this->configuration) {
-            throw new ConfigurationRequiredError('É necessário setar a configuração utilizando o método setConfiguration.');
-        }
+        $communication = $this->getCallApiInstance($this->configuration);
 
         if (!$this->configuration->getNfseDownloadDirectory()) {
             throw new RequiredError('É necessário setar o diretório para download do PDF.');
         }
 
-        $communication = new CallApi($this->configuration);
         return $communication->download(
             'GET',
             "/nfse/pdf/${idIntegracao}/${cnpj}",
             null,
             $this->configuration->getNfseDownloadDirectory() . '/' . $cnpj . '-' . $idIntegracao . '.pdf'
         );
     }
+
+    public function cancel($id)
+    {
+        $communication = $this->getCallApiInstance($this->configuration);
+        return $communication->send('POST', "/nfse/cancelar/${id}", null);
+    }
+
+    public function cancelByCnpjAndIdIntegracao($cnpj, $idIntegracao)
+    {
+        $communication = $this->getCallApiInstance($this->configuration);
+        return $communication->send('POST', "/nfse/pdf/${idIntegracao}/${cnpj}", null);
+    }
+
+    public function cancelStatus($id)
+    {
+        $communication = $this->getCallApiInstance($this->configuration);
+        return $communication->send('POST', "/nfse/cancelar/status/${id}", null);
+    }
 }

src/Nfse.php

@@ -4,16 +4,20 @@
 
 use FerFabricio\Hydratator\Hydratate;
 use Respect\Validation\Validator as v;
-use TecnoSpeed\Plugnotas\Configuration;
-use TecnoSpeed\Plugnotas\Communication\CallApi;
+use TecnoSpeed\Plugnotas\Abstracts\BuilderAbstract;
 use TecnoSpeed\Plugnotas\Common\Endereco;
 use TecnoSpeed\Plugnotas\Common\Telefone;
-use TecnoSpeed\Plugnotas\Abstracts\BuilderAbstract;
+use TecnoSpeed\Plugnotas\Communication\CallApi;
+use TecnoSpeed\Plugnotas\Configuration;
 use TecnoSpeed\Plugnotas\Error\InvalidTypeError;
+use TecnoSpeed\Plugnotas\Error\RequiredError;
 use TecnoSpeed\Plugnotas\Error\ValidationError;
+use TecnoSpeed\Plugnotas\Traits\Communication;
 
 class Prestador extends BuilderAbstract
 {
+    use Communication;
+
     private $certificado;
     private $cpfCnpj;
     private $email;
@@ -255,7 +259,7 @@ public function send(Configuration $configuration)
     {
         $this->validate();
 
-        $communication = new CallApi($configuration);
+        $communication = $this->getCallApiInstance($configuration);
         return $communication->send('POST', '/nfse/prestador', $this->toArray(true));
     }
 }

src/Nfse/Prestador.php

@@ -2,7 +2,6 @@
 
 namespace TecnoSpeed\Plugnotas\Nfse;
 
-use Respect\Validation\Validator as v;
 use TecnoSpeed\Plugnotas\Abstracts\BuilderAbstract;
 use TecnoSpeed\Plugnotas\Error\ValidationError;
 
@@ -13,9 +12,6 @@ class Rps extends BuilderAbstract
 
     public function setDataEmissao(\DateTimeInterface $dataEmissao)
     {
-        if (!v::date()->validate($dataEmissao)) {
-            throw new ValidationError('dataEmissao deve ser uma data válida.');
-        }
         $this->dataEmissao = $dataEmissao->format('Y-m-d\TH:i:s');
     }
 
@@ -26,9 +22,6 @@ public function getDataEmissao()
 
     public function setCompetencia(\DateTimeInterface $competencia)
     {
-        if (!v::date()->validate($competencia)) {
-            throw new ValidationError('competencia deve ser uma data válida.');
-        }
         $this->competencia = $competencia->format('Y-m-d');
     }