Otimizações

- Updated comments
- Removed "pt_en" from files name (all files are now in English)
- Simplified response() method in Notification
- Simplified cancel() method in Billet
- Minor improvements

README.md

@@ -59,9 +59,7 @@ Você pode obter a lista de dados que você pode enviar no seguinte link: [https
 use WebMaster\PagHiper\PagHiper;
 
 $pagHiper = new PagHiper();
-$transaction = $pagHiper->billet()->cancel([
-     'transaction_id' => 'JKP03X9KN0RELVLH',
- ]);
+$transaction = $pagHiper->billet()->cancel('JKP03X9KN0RELVLH');
 ```
 
 **Para obter informações do pagamento via retorno automático:**
@@ -70,10 +68,7 @@ $transaction = $pagHiper->billet()->cancel([
 use WebMaster\PagHiper\PagHiper;
 
 $pagHiper = new PagHiper();
-$transaction = $pagHiper->notification()->response([
-    'notification_id' => $_POST['notification_id'],
-    'transaction_id' => $_POST['idTransacao']
-]);
+$transaction = $pagHiper->notification()->response($_POST['notification_id'], $_POST['idTransacao']);
 ``` 
 
 **Para obter a lista de suas contas bancárias:**

src/Core/Interfaces/BankAccountsInterface.php

@@ -5,7 +5,7 @@
 interface BankAccountsInterface
 {
     /**
-     * Lista as contas bancárias para saque via API.
+     * Retrieves a list of bank accounts.
      *
      * @return void
      */

src/Core/Interfaces/BilletInterface.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace WebMaster\PagHiper\Core\Interfaces;
+
+interface BilletInterface
+{
+    /**
+     * Create a new billet.
+     *
+     * @param array $data Billet data. Full list of all available data can be found at: https://dev.paghiper.com/reference#gerar-boleto
+     * @return void
+     */
+    public function create(array $data);
+
+     /**
+    * Cancels a billet.
+    *
+    * @param string $transactionId Transaction ID to cancel.
+    * @return boolean
+    */
+    public function cancel(string $transactionId);
+}

src/Core/Interfaces/NotificationInterface.php

@@ -5,9 +5,11 @@
 interface NotificationInterface
 {
     /**
-     *  Pega a resposta da notificação (retorno automático) do PagHiper.
+     * Get notification's response.
      *
+     * @param string $notificationId  
+     * @param string $transactionId 
      * @return void
      */
-    public function response(array $data);
+    public function response(string $notificationId = '', string $transactionId = '');
 }

src/Core/Request/Request.php

@@ -14,10 +14,10 @@ class Request
     protected $response;
 
     /**
-     * Envia uma requisição para a API do PagHiper
+     * Send a request to PagHiper's API.
      *
-     * @param string $endpoint Recurso da API (exemplo: /transaction/create/)
-     * @param array $params Parâmetros necessários para o endpoint. https://dev.paghiper.com/reference
+     * @param string $endpoint API resource (exemplo: /transaction/create/)
+     * @param array $params Resource params. Can be found at: https://dev.paghiper.com/reference
      */
     public function __construct(string $endpoint = '', array $params = [])
     {
@@ -34,12 +34,13 @@ public function __construct(string $endpoint = '', array $params = [])
             ],
         ]);
 
-        // Acrescenta o token e apiKey
+        //  Add token and apiKey
         $params = array_merge([
             'token' => $credentials::TOKEN,
             'apiKey' => $credentials::API_KEY,
         ], $params);
 
+        // Send the request
         $request = $client->request('POST', $endpoint, [
             'json' => $params,
         ]);
@@ -50,7 +51,7 @@ public function __construct(string $endpoint = '', array $params = [])
     }
 
     /**
-     * Pega a resposta do PagHiper
+     * Get PagHiper's response.
      *
      * @return void
      */

src/PagHiper.php

@@ -8,7 +8,6 @@
 
 class PagHiper
 {
-    protected $request;
     protected $billet;
     protected $bank;
     protected $notification;

src/v1/Bank/Accounts.php

@@ -3,21 +3,28 @@
 namespace WebMaster\PagHiper\v1\Bank;
 
 use WebMaster\PagHiper\Core\Request\Request;
+use WebMaster\PagHiper\Core\Exceptions\PagHiperException;
 use WebMaster\PagHiper\Core\Interfaces\BankAccountsInterface;
 
 class Accounts implements BankAccountsInterface
 {
     protected $accountsUri = '/bank_accounts/list/';
 
     /**
-     * Lista as contas bancárias para saque via API.
+     * Retrieves a list of bank accounts.
      *
      * @return void
      */
     public function accounts()
     {
         $bankAccounts = new Request($this->accountsUri);
 
-        return $bankAccounts->getResponse()['bank_account_list_request'];
+        $response = $bankAccounts->getResponse()['bank_account_list_request'];
+
+        if ($response['result'] === 'reject') {
+            throw new PagHiperException($response['response_message'], $response['http_code']);
+        }
+
+        return $response;
     }
 }

src/v1/Payment/Billet.php

@@ -4,22 +4,21 @@
 
 use GuzzleHttp\Client;
 use WebMaster\PagHiper\Core\Request\Request;
-use WebMaster\PagHiper\Core\Interfaces\BoletoInterface;
+use WebMaster\PagHiper\Core\Interfaces\BilletInterface;
 use WebMaster\PagHiper\Core\Configuration\Configuration;
 use WebMaster\PagHiper\Core\Exceptions\PagHiperException;
 
-class Billet implements BoletoInterface
+class Billet implements BilletInterface
 {
     protected $createUri = '/transaction/create/';
     protected $cancelUri = '/transaction/cancel/';
 
     /**
-     * Realiza a emissão do boleto
-     *
-     * @param array $data Dados para geração do boleto. Os dados necessários para gerar o boleto
-     * podem ser encontrados em: https://dev.paghiper.com/reference#gerar-boleto
-     * @return void
-     */
+    * Create a new billet.
+    *
+    * @param array $data Billet data. Full list of all available data can be found at: https://dev.paghiper.com/reference#gerar-boleto
+    * @return void
+    */
     public function create(array $data)
     {
         $request = new Request($this->createUri, $data);
@@ -34,21 +33,26 @@ public function create(array $data)
     }
 
     /**
-    * Efetua o cancelamento boleto.
+    * Cancels a billet.
     *
-    * @param array $data Dados para cancelamento do boleto. Os dados para cancelar o boleto podem ser encontrados em:
-    * https://dev.paghiper.com/reference#boleto
+    * @param string $transactionId Transaction ID to cancel.
     * @return boolean
     */
-    public function cancel(array $data)
+    public function cancel(string $transactionId)
     {
-        // Define o status da transação com 'canceled'
-        $data = array_merge([
+        $data = [
+            'transaction_id' => $transactionId,
             'status' => 'canceled'
-        ], $data);
+        ];
 
         $request = new Request($this->cancelUri, $data);
 
-        return $request->getResponse()['cancellation_request'];
+        $response = $request->getResponse()['cancellation_request'];
+
+        if ($response['result'] === 'reject') {
+            throw new PagHiperException($response['response_message'], $response['http_code']);
+        }
+
+        return $response;
     }
 }

src/v1/Payment/Notification/Notification.php

@@ -3,16 +3,31 @@
 namespace WebMaster\PagHiper\v1\Payment\Notification;
 
 use WebMaster\PagHiper\Core\Request\Request;
+use WebMaster\PagHiper\Core\Exceptions\PagHiperException;
 use WebMaster\PagHiper\Core\Interfaces\NotificationInterface;
 
 class Notification implements NotificationInterface
 {
     protected $notificationUri = '/transaction/notification/';
 
-    public function response(array $data)
+    /**
+     *  Get notification's response.
+     *
+     * @return void
+     */
+    public function response(string $notificationId = '', string $transactionId = '')
     {
-        $notification = new Request($this->notificationUri, $data);
+        $notification = new Request($this->notificationUri, [
+            'notification_id' => $notificationId,
+            'transaction_id' => $transactionId
+        ]);
 
-        return $notification->getResponse()['status_request'];
+        $response = $notification->getResponse()['status_request'];
+
+        if ($response['result'] === 'reject') {
+            throw new PagHiperException($response['response_message'], $response['http_code']);
+        }
+
+        return $response;
     }
 }