Merge pull request #242 from leoneparise/balances

Obtém saldos de uma conta moip

Author: mbnakaya

src/Moip.php

@@ -4,6 +4,7 @@
 
 use Moip\Contracts\Authentication;
 use Moip\Resource\Account;
+use Moip\Resource\Balances;
 use Moip\Resource\BankAccount;
 use Moip\Resource\Customer;
 use Moip\Resource\Entry;
@@ -257,6 +258,16 @@ public function bankaccount()
         return new BankAccount($this);
     }
 
+    /**
+     * Create a new Balances instance.
+     *
+     * @return Balances
+     */
+    public function balances()
+    {
+        return new Balances($this);
+    }
+
     /**
      * Get the endpoint.
      *

src/Resource/Balances.php

@@ -0,0 +1,87 @@
+<?php
+
+namespace Moip\Resource;
+
+use stdClass;
+
+/**
+ * Class Balances.
+ */
+class Balances extends MoipResource
+{
+    /**
+     * Path balances API.
+     *
+     * @const string
+     */
+    const PATH = 'balances';
+
+    /**
+     * Initialize a new instance.
+     */
+    public function initialize()
+    {
+        $this->data = new stdClass();
+        $this->data->unavailable = [];
+        $this->data->future = [];
+        $this->data->current = [];
+    }
+
+    /**
+     * Populate this instance.
+     *
+     * @param stdClass $response response object
+     *
+     * @return mixed|Balances
+     */
+    protected function populate(stdClass $response)
+    {
+        $balances = clone $this;
+        $balances->data->unavailable = $this->getIfSet('unavailable', $response) ?: [];
+        $balances->data->future = $this->getIfSet('future', $response) ?: [];
+        $balances->data->current = $this->getIfSet('current', $response) ?: [];
+
+        return $balances;
+    }
+
+    /**
+     * Get all balances.
+     *
+     * @return stdClass
+     */
+    public function get()
+    {
+        $path = sprintf('/%s/%s', MoipResource::VERSION, self::PATH);
+        return $this->getByPath($path, ['Accept' => static::ACCEPT_VERSION]);
+    }
+
+    /**
+     * Get unavailable balances. Returns an array of objects with the amount and currency.
+     *
+     * @return array
+     */
+    public function getUnavailable()
+    {
+        return $this->data->unavailable;
+    }
+
+    /**
+     * Get future balances. Returns an array of objects with the amount and currency.
+     *
+     * @return array
+     */
+    public function getFuture()
+    {
+        return $this->data->future;
+    }
+
+    /**
+     * Get current balances. Returns an array of objects with the amount and currency.
+     *
+     * @return array
+     */
+    public function getCurrent()
+    {
+        return $this->data->current;
+    }
+}

src/Resource/MoipResource.php

@@ -24,6 +24,13 @@ abstract class MoipResource implements JsonSerializable
      */
     const VERSION = 'v2';
 
+    /**
+     * Api version content type.
+     *
+     * @cont string
+     */
+    const ACCEPT_VERSION = 'application/json;version=2.1';
+
     /**
      * @var \Moip\Moip
      */
@@ -210,25 +217,27 @@ public function generateListPath(Pagination $pagination = null, Filters $filters
      * Execute a http request. If payload == null no body will be sent. Empty body ('{}') is supported by sending a
      * empty stdClass.
      *
-     * @param string     $path
-     * @param string     $method
-     * @param mixed|null $payload
+     * @param string     $path    request path
+     * @param string     $method  http method
+     * @param mixed|null $payload request body
+     * @param array      $headers request headers
      *
      * @throws Exceptions\ValidationException  if the API returns a 4xx http status code. Usually means invalid data was sent.
      * @throws Exceptions\UnautorizedException if the API returns a 401 http status code. Check API token and key.
      * @throws Exceptions\UnexpectedException  if the API returns a 500 http status code or something unexpected happens (ie.: Network error).
      *
      * @return stdClass
      */
-    protected function httpRequest($path, $method, $payload = null)
+    protected function httpRequest($path, $method, $payload = null, $headers = [])
     {
         $http_sess = $this->moip->getSession();
-        $headers = [];
         $body = null;
         if ($payload !== null) {
             $body = json_encode($payload, JSON_UNESCAPED_SLASHES);
-            if ($body) {// if it's json serializable
-                $headers['Content-Type'] = 'application/json';
+            if ($body) { // if it's json serializable
+                if (!isset($headers['Content-Type'])) {
+                    $headers['Content-Type'] = 'application/json';
+                }
             } else {
                 $body = null;
             }
@@ -258,13 +267,14 @@ protected function httpRequest($path, $method, $payload = null)
     /**
      * Find by path.
      *
-     * @param string $path
+     * @param string $path    resource path
+     * @param array  $headers request headers
      *
      * @return stdClass
      */
-    public function getByPath($path)
+    public function getByPath($path, $headers = [])
     {
-        $response = $this->httpRequest($path, Requests::GET);
+        $response = $this->httpRequest($path, Requests::GET, null, $headers);
 
         if (is_array($response)) {
             $response = (object) $response;

tests/Resource/BalancesTest.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Moip\Tests\Resource;
+
+use Moip\Tests\TestCase;
+
+class BalancesTest extends TestCase
+{
+    public function testShouldGetBalances()
+    {
+        $this->mockHttpSession($this->body_balances);
+
+        $balances = $this->moip->balances()->get();
+        $current = $balances->getCurrent();
+        $future = $balances->getFuture();
+        $unavailable = $balances->getUnavailable();
+
+        $this->assertNotEmpty($current);
+        $this->assertNotEmpty($future);
+        $this->assertNotEmpty($unavailable);
+        $this->assertEquals(44592168, $current[0]->amount);
+    }
+}

tests/TestCase.php

@@ -141,6 +141,11 @@ abstract class TestCase extends BaseTestCase
      */
     protected $body_bank_account_update;
 
+    /**
+     * @var string response from moip API.
+     */
+    protected $body_balances;
+
     /**
      * @var string holds the last generated customer ownId. In mock mode it'll be always the default, but it changes on sandbox mode.
      */
@@ -243,6 +248,8 @@ public function __construct()
         $this->body_bank_account_list = $this->readJsonFile('jsons/bank_account/list');
 
         $this->body_bank_account_update = $this->readJsonFile('jsons/bank_account/update');
+
+        $this->body_balances = $this->readJsonFile('jsons/balances/get');
     }
 
     /**

tests/jsons/balances/get.json

@@ -0,0 +1 @@
+{"unavailable": [{"amount": 0, "currency": "BRL"}], "future": [{"amount": 0, "currency": "BRL"}], "current": [{"amount": 44592168, "currency": "BRL"}]}