Merge pull request #1 from zhooravell/develop

Develop

Author: zhooravell

.gitignore

@@ -1,4 +1,5 @@
 /vendor
 composer.lock
 /coverage
-/phpmetrics
+/phpmetrics
+/example

README.md

@@ -1,8 +1,46 @@
 # Monobank open API client
 PHP client for Monobank open API 
 
+[![License][license-image]][license-link] [![Build Status][travis-image]][travis-link] [![codecov][codecov-image]][codecov-link] [![scrutinizer][scrutinizer-image]][scrutinizer-link] [![intelligence][intelligence-image]][intelligence-link] 
+
 ![](https://api.monobank.ua/docs/images/logo.png)
 
+## Examples
+
+```php
+<?php
+
+include 'vendor/autoload.php';
+
+use GuzzleHttp\Client;
+use Monobank\MonobankClient;
+use Monobank\ValueObject\Token;
+
+$httpClient = new Client();
+$token = new Token('...');
+$client = new MonobankClient($httpClient, $token);
+
+var_dump($client->getExchangeRates());
+
+var_dump($client->getClientInfo());
+
+var_dump($client->getPersonalStatement(new PersonalStatementRequest(new DateTime('2019-06-20'), new DateTime())));
+```
 ## Source(s)
 
 * [Monobank API docs](https://api.monobank.ua/docs/)
+
+[license-link]: https://github.com/zhooravell/php-monobank/blob/master/LICENSE
+[license-image]: https://img.shields.io/dub/l/vibe-d.svg
+
+[travis-link]: https://travis-ci.com/zhooravell/php-monobank
+[travis-image]: https://travis-ci.com/zhooravell/php-monobank.svg?branch=master
+
+[codecov-link]: https://codecov.io/gh/zhooravell/php-monobank
+[codecov-image]: https://codecov.io/gh/zhooravell/php-monobank/branch/master/graph/badge.svg
+
+[scrutinizer-link]: https://scrutinizer-ci.com/g/zhooravell/php-monobank/?branch=master
+[scrutinizer-image]: https://scrutinizer-ci.com/g/zhooravell/php-monobank/badges/quality-score.png?b=master
+
+[intelligence-link]: https://scrutinizer-ci.com/code-intelligence
+[intelligence-image]: https://scrutinizer-ci.com/g/zhooravell/php-monobank/badges/code-intelligence.svg?b=master

composer.json

@@ -11,9 +11,9 @@
     ],
     "require": {
         "php": ">=7.1",
-        "ext-mbstring": "*",
-        "ext-json": "*",
         "ext-filter": "*",
+        "ext-json": "*",
+        "ext-mbstring": "*",
         "guzzlehttp/guzzle": "^6.3"
     },
     "require-dev": {
@@ -22,7 +22,10 @@
     "autoload": {
         "psr-4": {
             "Monobank\\": "src/"
-        }
+        },
+        "files": [
+            "src/constants.php"
+        ]
     },
     "autoload-dev": {
         "psr-4": {

src/.gitkeep

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Monobank\Exception;
+
+use Exception;
+
+/**
+ * Class AccountException.
+ */
+class AccountException extends Exception implements MonobankException
+{
+    /**
+     * @return AccountException
+     */
+    public static function emptyID(): self
+    {
+        return new self('Account ID should not be blank.');
+    }
+}

src/Exception/AccountException.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Monobank\Exception;
+
+use Exception;
+
+/**
+ * Class InvalidResponseException.
+ */
+class InvalidResponseException extends Exception implements MonobankException
+{
+    /**
+     * @return InvalidResponseException
+     */
+    public static function wrongFormat(): self
+    {
+        return new self('Wrong response body format.');
+    }
+}

src/Exception/InvalidResponseException.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Monobank\Exception;
+
+use Exception;
+
+/**
+ * Class InvalidTokenException.
+ */
+class InvalidTokenException extends Exception implements MonobankException
+{
+    /**
+     * @return InvalidTokenException
+     */
+    public static function emptyToken(): self
+    {
+        return new self('Monobank API token should not be blank.');
+    }
+}

src/Exception/InvalidTokenException.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Monobank\Exception;
+
+/**
+ * Interface MonobankException.
+ */
+interface MonobankException
+{
+}

src/Exception/MonobankException.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Monobank\Exception;
+
+use Exception;
+
+/**
+ * Class RequestException.
+ */
+class RequestException extends Exception implements MonobankException
+{
+    /**
+     * @return RequestException
+     */
+    public static function maxPersonalStatementPeriod(): self
+    {
+        return new self('The maximum period is 31 days (2678400 seconds).');
+    }
+
+    /**
+     * @return RequestException
+     */
+    public static function invalidPersonalStatementPeriod(): self
+    {
+        return new self('"Date to" should be greater than "date from".');
+    }
+}

src/Exception/RequestException.php

@@ -0,0 +1,122 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Monobank;
+
+use GuzzleHttp\RequestOptions;
+use Monobank\ValueObject\Token;
+use GuzzleHttp\ClientInterface;
+use Psr\Http\Message\ResponseInterface;
+use GuzzleHttp\Exception\GuzzleException;
+use Monobank\Request\PersonalStatementRequest;
+use Monobank\Exception\InvalidResponseException;
+
+/**
+ * Monobank HTTP client.
+ */
+class MonobankClient implements MonobankPublicDataClientInterface, MonobankPrivateDataClientInterface
+{
+    private const HOST = 'https://api.monobank.ua';
+
+    /**
+     * @var ClientInterface
+     */
+    private $client;
+
+    /**
+     * @var Token
+     */
+    private $token;
+
+    /**
+     * @var string
+     */
+    private $host;
+
+    /**
+     * @param ClientInterface $client
+     * @param Token           $token
+     * @param string          $host
+     */
+    public function __construct(ClientInterface $client, Token $token, string $host = self::HOST)
+    {
+        $this->client = $client;
+        $this->token = $token;
+        $this->host = rtrim($host, '/');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getExchangeRates(): array
+    {
+        return $this->decode($this->request('GET', '/bank/currency'));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getClientInfo(): array
+    {
+        return $this->decode($this->request('GET', '/personal/client-info', $this->token));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getPersonalStatement(PersonalStatementRequest $request): array
+    {
+        $endpoint = sprintf(
+            '/personal/statement/%s/%d/%d',
+            null === $request->getAccountID() ? '0' : strval($request->getAccountID()), // 0 - default account
+            $request->getFrom()->getTimestamp(),
+            $request->getTo()->getTimestamp()
+        );
+
+        return $this->decode($this->request('GET', $endpoint, $this->token));
+    }
+
+    /**
+     * @param string     $method
+     * @param string     $endpoint
+     * @param Token|null $token
+     *
+     * @return ResponseInterface
+     *
+     * @throws GuzzleException
+     */
+    private function request(string $method, string $endpoint, Token $token = null): ResponseInterface
+    {
+        $headers = [
+            'Accept' => 'application/json',
+            'User-Agent' => sprintf('%s MonobankPHPClient/%s', $this->client->getConfig('headers')['User-Agent'], MONOBANK_CLIENT_VERSION),
+        ];
+
+        if (null !== $token) {
+            $headers['X-Token'] = strval($token);
+        }
+
+        return $this->client->request($method, $this->host.$endpoint, [
+            RequestOptions::HEADERS => $headers,
+        ]);
+    }
+
+    /**
+     * @param ResponseInterface $response
+     *
+     * @return array
+     *
+     * @throws InvalidResponseException
+     */
+    private function decode(ResponseInterface $response): array
+    {
+        $decodedContents = json_decode($response->getBody()->getContents(), true);
+
+        if (!is_array($decodedContents)) {
+            throw InvalidResponseException::wrongFormat();
+        }
+
+        return $decodedContents;
+    }
+}

src/MonobankClient.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Monobank;
+
+use GuzzleHttp\Exception\GuzzleException;
+use Monobank\Request\PersonalStatementRequest;
+use Monobank\Exception\InvalidResponseException;
+
+/**
+ * Private data.
+ *
+ * @see https://api.monobank.ua/docs/
+ * @see https://api.monobank.ua/docs/corporate.html
+ */
+interface MonobankPrivateDataClientInterface
+{
+    /**
+     * Obtaining information about the client and the list of his accounts.
+     * Limit on the use of the function no more than 1 time in 60 seconds.
+     *
+     * @return array
+     *
+     * @throws GuzzleException
+     * @throws InvalidResponseException
+     */
+    public function getClientInfo(): array;
+
+    /**
+     * Receive an extract for the time {from} to {to} time in seconds Unix time format.
+     * The maximum time for which it is possible to extract is 31 days (2678400 seconds).
+     * Limit on the use of the function no more than 1 time in 60 seconds.
+     *
+     * @param PersonalStatementRequest $request
+     *
+     * @return array
+     *
+     * @throws GuzzleException
+     * @throws InvalidResponseException
+     */
+    public function getPersonalStatement(PersonalStatementRequest $request): array;
+}

src/MonobankPrivateDataClientInterface.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Monobank;
+
+use GuzzleHttp\Exception\GuzzleException;
+use Monobank\Exception\InvalidResponseException;
+
+/**
+ * Public data.
+ *
+ * @see https://api.monobank.ua/docs/
+ */
+interface MonobankPublicDataClientInterface
+{
+    /**
+     * Get a basic list of monobank currency rates.
+     * Information is cached and updated no more than once every 5 minutes.
+     *
+     * @return array
+     *
+     * @throws GuzzleException
+     * @throws InvalidResponseException
+     */
+    public function getExchangeRates(): array;
+}