Feature/adiciona novas features (#43)

* Adiciona pasta de configuração do PHPStorm no .gitignore * Adiciona opção de passar VINDI_API_URI e VINDI_API_KEY como argumentos Opção de passar VINDI_API_URI e VINDI_API_KEY como argumentos nas instancias de classes filhas de Resource * Atualiza versão 1.1.0 na classe Vindi * Volta o código original * Retira .idea do gitignore * Adiciona opção de passar VINDI_API_URI e VINDI_API_KEY como argumentos Opção de passar VINDI_API_URI e VINDI_API_KEY como argumentos nas instâncias de classes filhas de Resource Refatora código da classe Vindi para melhor adequar as mudanças realizadas nessa feature * Refatora README para melhor entendimento da nova feature * Refatora CHANGELOG para melhor entendimento * Altera idioma de uma frase no CHANGELOG * Refatora para melhor entendimento do README * Refatora ordem de importância de VINDI_API_KEY e VINDI_API_URI * Adiciona exemplo de API URI * Refatora teste da classe Vindi * Altera ênfase na explicação sobre outra instancia * Adiciona classe Notifications e testes * Adiciona novos métodos * Separa os meios de autenticação do README * Retira menção sobre .env * Adiciona docblock do PHP * Ajusta teste da classe Vindi
vindi · May 28, 2018 · 71ed9ba · 71ed9ba
1 parent 34ae45e
commit 71ed9ba
Show file tree

Hide file tree

Showing 35 changed files with 380 additions and 25 deletions.
diff --git a/src/ApiRequester.php b/src/ApiRequester.php
@@ -9,6 +9,11 @@
 use Vindi\Exceptions\RequestException;
 use Vindi\Exceptions\RateLimitException;
 
+/**
+ * Class ApiRequester
+ *
+ * @package Vindi
+ */
 class ApiRequester
 {
     /**
@@ -17,7 +22,7 @@ class ApiRequester
     public $client;
 
     /**
-     * @var \Psr\Http\Message\ResponseInterface
+     * @var ResponseInterface
      */
     public $lastResponse;
 
@@ -40,6 +45,9 @@ public function __construct()
      * @param array  $options  Options for the request.
      *
      * @return mixed
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Vindi\Exceptions\RateLimitException
+     * @throws \Vindi\Exceptions\RequestException
      */
     public function request($method, $endpoint, array $options = [])
     {
@@ -54,9 +62,11 @@ public function request($method, $endpoint, array $options = [])
     }
 
     /**
-     * @param \Psr\Http\Message\ResponseInterface $response
+     * @param ResponseInterface $response
      *
      * @return object
+     * @throws RateLimitException
+     * @throws \Vindi\Exceptions\RequestException
      */
     public function response(ResponseInterface $response)
     {
@@ -75,10 +85,10 @@ public function response(ResponseInterface $response)
     }
 
     /**
-     * @param \Psr\Http\Message\ResponseInterface $response
+     * @param ResponseInterface $response
      *
      * @return $this
-     * @throws \Vindi\Exceptions\RateLimitException
+     * @throws RateLimitException
      */
     private function checkRateLimit(ResponseInterface $response)
     {
@@ -90,8 +100,8 @@ private function checkRateLimit(ResponseInterface $response)
     }
 
     /**
-     * @param \Psr\Http\Message\ResponseInterface $response
-     * @param mixed                     $data
+     * @param ResponseInterface $response
+     * @param mixed             $data
      *
      * @return $this
      * @throws \Vindi\Exceptions\RequestException
@@ -100,9 +110,9 @@ private function checkForErrors(ResponseInterface $response, $data)
     {
         $status = $response->getStatusCode();
 
-        $data = (array) $data;
+        $data = (array)$data;
 
-        $statusClass = (int) ($status / 100);
+        $statusClass = (int)($status / 100);
 
         if (($statusClass === 4) || ($statusClass === 5)) {
             switch ($status) {

diff --git a/src/Bill.php b/src/Bill.php
@@ -2,6 +2,11 @@
 
 namespace Vindi;
 
+/**
+ * Class Bill
+ *
+ * @package Vindi
+ */
 class Bill extends Resource
 {
     /**
@@ -20,9 +25,42 @@ public function endpoint()
      * @param int $id The resource's id.
      *
      * @return mixed
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Vindi\Exceptions\RateLimitException
+     * @throws \Vindi\Exceptions\RequestException
      */
     public function approve($id)
     {
         return $this->post($id, 'approve');
     }
+
+    /**
+     * Make a POST request to bills/{id}/charge.
+     *
+     * @param int $id The resource's id.
+     *
+     * @return mixed
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Vindi\Exceptions\RateLimitException
+     * @throws \Vindi\Exceptions\RequestException
+     */
+    public function charge($id)
+    {
+        return $this->post($id, 'charge');
+    }
+
+    /**
+     * Make a POST request to bills/{id}/invoice.
+     *
+     * @param int $id The resource's id.
+     *
+     * @return mixed
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Vindi\Exceptions\RateLimitException
+     * @throws \Vindi\Exceptions\RequestException
+     */
+    public function invoice($id)
+    {
+        return $this->post($id, 'invoice');
+    }
 }
diff --git a/src/BillItem.php b/src/BillItem.php
@@ -2,6 +2,11 @@
 
 namespace Vindi;
 
+/**
+ * Class BillItem
+ *
+ * @package Vindi
+ */
 class BillItem extends Resource
 {
     /**

diff --git a/src/Charge.php b/src/Charge.php
@@ -2,6 +2,11 @@
 
 namespace Vindi;
 
+/**
+ * Class Charge
+ *
+ * @package Vindi
+ */
 class Charge extends Resource
 {
     /**
@@ -21,6 +26,9 @@ public function endpoint()
      * @param array $form_params
      *
      * @return mixed
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Vindi\Exceptions\RateLimitException
+     * @throws \Vindi\Exceptions\RequestException
      */
     public function reissue($id, array $form_params = [])
     {
@@ -34,6 +42,9 @@ public function reissue($id, array $form_params = [])
      * @param array $form_params
      *
      * @return mixed
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Vindi\Exceptions\RateLimitException
+     * @throws \Vindi\Exceptions\RequestException
      */
     public function charge($id, array $form_params = [])
     {
@@ -43,12 +54,30 @@ public function charge($id, array $form_params = [])
     /**
      * Make a POST request to charges/{id}/refund.
      *
-     * @param int   $id The resource's id.
+     * @param int $id The resource's id.
      *
      * @return mixed
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Vindi\Exceptions\RateLimitException
+     * @throws \Vindi\Exceptions\RequestException
      */
     public function refund($id)
     {
         return $this->post($id, 'refund');
     }
+
+    /**
+     * Make a POST request to charges/{id}/fraud_review.
+     *
+     * @param int $id The resource's id.
+     *
+     * @return mixed
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Vindi\Exceptions\RateLimitException
+     * @throws \Vindi\Exceptions\RequestException
+     */
+    public function fraudReview($id)
+    {
+        return $this->post($id, 'fraud_review');
+    }
 }
diff --git a/src/Customer.php b/src/Customer.php
@@ -2,6 +2,11 @@
 
 namespace Vindi;
 
+/**
+ * Class Customer
+ *
+ * @package Vindi
+ */
 class Customer extends Resource
 {
     /**
@@ -13,4 +18,19 @@ public function endpoint()
     {
         return 'customers';
     }
+
+    /**
+     * Make a POST request to customers/{id}/unarchive.
+     *
+     * @param int $id The resource's id.
+     *
+     * @return mixed
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Vindi\Exceptions\RateLimitException
+     * @throws \Vindi\Exceptions\RequestException
+     */
+    public function unarchive($id)
+    {
+        return $this->post($id, 'unarchive');
+    }
 }
diff --git a/src/Discount.php b/src/Discount.php
@@ -2,6 +2,11 @@
 
 namespace Vindi;
 
+/**
+ * Class Discount
+ *
+ * @package Vindi
+ */
 class Discount extends Resource
 {
     /**

diff --git a/src/Exceptions/RateLimitException.php b/src/Exceptions/RateLimitException.php
@@ -2,6 +2,11 @@
 
 use Exception;
 
+/**
+ * Class RateLimitException
+ *
+ * @package Vindi\Exceptions
+ */
 class RateLimitException extends Exception
 {
     /**
@@ -45,7 +50,7 @@ public function __construct($response)
      * @param mixed  $response API response.
      * @param string $name     Header name.
      *
-     * @returns int
+     * @return int
      */
     private function getHeaderValue($response, $name)
     {

diff --git a/src/Exceptions/RequestException.php b/src/Exceptions/RequestException.php
@@ -2,6 +2,11 @@
 
 use Exception;
 
+/**
+ * Class RequestException
+ *
+ * @package Vindi\Exceptions
+ */
 class RequestException extends Exception
 {
     /**

diff --git a/src/Exceptions/ValidationException.php b/src/Exceptions/ValidationException.php
@@ -1,5 +1,10 @@
 <?php namespace Vindi\Exceptions;
 
+/**
+ * Class ValidationException
+ *
+ * @package Vindi\Exceptions
+ */
 class ValidationException extends RequestException
 {
     /**

diff --git a/src/Exceptions/WebhookHandleException.php b/src/Exceptions/WebhookHandleException.php
@@ -1,5 +1,10 @@
 <?php namespace Vindi\Exceptions;
 
+/**
+ * Class WebhookHandleException
+ *
+ * @package Vindi\Exceptions
+ */
 class WebhookHandleException extends \Exception
 {
 }
diff --git a/src/Http/Client.php b/src/Http/Client.php
@@ -5,6 +5,11 @@
 use GuzzleHttp\Client as Guzzle;
 use Vindi\Vindi;
 
+/**
+ * Class Client
+ *
+ * @package Vindi\Http
+ */
 class Client extends Guzzle
 {
     /**

diff --git a/src/ImportBatch.php b/src/ImportBatch.php
@@ -2,6 +2,11 @@
 
 namespace Vindi;
 
+/**
+ * Class ImportBatch
+ *
+ * @package Vindi
+ */
 class ImportBatch extends Resource
 {
     /**
@@ -16,9 +21,12 @@ public function endPoint()
 
     /**
      * @param string $filePath
-     * @param array $options
+     * @param array  $options
      *
      * @return mixed
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Vindi\Exceptions\RateLimitException
+     * @throws \Vindi\Exceptions\RequestException
      */
     public function import($filePath, array $options)
     {

diff --git a/src/Invoice.php b/src/Invoice.php
@@ -2,6 +2,11 @@
 
 namespace Vindi;
 
+/**
+ * Class Invoice
+ *
+ * @package Vindi
+ */
 class Invoice extends Resource
 {
     /**
@@ -20,6 +25,9 @@ public function endpoint()
      * @param  int $id The resource's id.
      *
      * @return mixed
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws \Vindi\Exceptions\RateLimitException
+     * @throws \Vindi\Exceptions\RequestException
      */
     public function retry($id)
     {

diff --git a/src/Issue.php b/src/Issue.php
@@ -2,6 +2,11 @@
 
 namespace Vindi;
 
+/**
+ * Class Issue
+ *
+ * @package Vindi
+ */
 class Issue extends Resource
 {
     /**

diff --git a/src/Merchant.php b/src/Merchant.php
@@ -2,6 +2,11 @@
 
 namespace Vindi;
 
+/**
+ * Class Merchant
+ *
+ * @package Vindi
+ */
 class Merchant extends Resource
 {
     /**