feat: data api client added, namespace changed

Author: pashamesh

README.md

@@ -1,14 +1,15 @@
-# [UIS](https://www.uiscom.ru/) & [CoMagic](https://main.comagic.ru/) API PHP client
+# [UIScom](https://www.uiscom.ru/) (formerly [CoMagic](https://main.comagic.ru/)) API PHP client
 UIS and CoMagic PHP client for the following APIs:
 - [Call API](https://www.uiscom.ru/academiya/spravochnyj-centr/dokumentatsiya-api/call_api/)
+- [Data API](https://www.uiscom.ru/academiya/spravochnyj-centr/dokumentatsiya-api/data_api/)
 
 ## Requirements
 This package requires PHP 7.4 or above.
 
 ## Installation
 To get started, install package via the Composer package manager:
 
-`composer require pashamesh/comagic-api`
+`composer require pashamesh/uiscom-api-client`
 
 ## Usage
 
@@ -26,8 +27,9 @@ $config = [
 ```
 
 You also need to change domain if you client of Uiscom by specifying `endpoint`:
+
 ```php
-use CoMagic\CallApiConfig;
+use Uiscom\CallApiConfig;
 
 $config = new CallApiConfig('login', 'password', 'access_token')
 ```
@@ -37,9 +39,10 @@ password authorization for Call API.
 
 ### Call API
 API Methods names need to be specified in CamelCase
+
 ```php
-use CoMagic\CallApiConfig;
-use CoMagic\CallApiClient;
+use Uiscom\CallApiConfig;
+use Uiscom\CallApiClient;
 
 $config = new CallApiConfig('login', 'password', 'access_token');
 $callApi = new CallApiClient($config);
@@ -50,3 +53,27 @@ It's possible to get response metadata after API request is made
 ```php
 var_dump($callApi->metadata());
 ```
+
+### Data API
+
+API Methods names need to be specified in CamelCase
+
+```php
+use Uiscom\DataApiConfig;
+use Uiscom\DataApiClient;
+
+$config = new DataApiConfig('access_token');
+$dataApi = new DataApiClient($config);
+var_dump(
+    $dataApi->getCallsReport([
+        'date_from' => '2025-01-10 00:00:00',
+        'date_till' => '2025-01-13 23:59:59'
+    ])
+);
+```
+
+It's possible to get response metadata after API request is made
+
+```php
+var_dump($dataApi->metadata());
+```

composer.json

@@ -1,15 +1,30 @@
 {
-    "name": "pashamesh/comagic-api",
-    "description": "php binding for UIScom and CoMagic API",
+    "name": "pashamesh/uiscom-api-client",
+    "description": "PHP binding for UIScom (formerly CoMagic) API",
     "type": "library",
+    "license": "MIT",
+    "keywords": [
+        "uis",
+        "uiscom",
+        "comagic",
+        "sdk",
+        "php",
+        "api",
+        "package",
+        "uiscom sdk",
+        "uiscom api",
+        "uiscom dataapi",
+        "uiscom callapi",
+        "uiscom package"
+    ],
     "require": {
         "php": ">=7.4",
         "ext-json": "*",
         "guzzlehttp/guzzle": "^6.2|^7.0"
     },
     "autoload": {
         "psr-4": {
-            "CoMagic\\": "src/CoMagic/"
+            "Uiscom\\": "src/Uiscom/"
         }
     },
     "authors": [

src/CoMagic/CallApiClient.php renamed to src/Uiscom/CallApiClient.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace CoMagic;
+namespace Uiscom;
 
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\TransferException;

src/CoMagic/CallApiConfig.php renamed to src/Uiscom/CallApiConfig.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace CoMagic;
+namespace Uiscom;
 
 use InvalidArgumentException;
 

src/Uiscom/DataApiClient.php

@@ -0,0 +1,95 @@
+<?php
+
+namespace Uiscom;
+
+use GuzzleHttp\Client;
+use GuzzleHttp\Exception\TransferException;
+use stdClass;
+
+class DataApiClient
+{
+    private string $version = 'v2.0';
+    private DataApiConfig $config;
+    private Client $client;
+
+    public function __construct(DataApiConfig $config, ?Client $client = null)
+    {
+        $this->client = $client ?? new Client([
+            'headers' => [
+                'Accept' => 'application/json',
+                'Content-type' => 'application/json; charset=UTF-8',
+            ],
+        ]);
+        $this->config = $config;
+    }
+
+    private function getBaseUri(): string
+    {
+        return rtrim($this->config->getEntryPoint(), '/') .
+            '/' . $this->version;
+    }
+
+    /**
+     * Get last response metadata
+     *
+     */
+    public function metadata(): ?stdClass
+    {
+        return $this->metadata;
+    }
+
+    /**
+     * Magic method for API calls
+     *
+     */
+    public function __call(string $camelCaseMethod, array $arguments)
+    {
+        $camelCaseMethod = preg_replace(
+            '~(.)(?=[A-Z])~',
+            '$1_',
+            $camelCaseMethod
+        );
+
+        $method = strtolower(preg_replace('~_~', '.', $camelCaseMethod, 1));
+
+        $params = ['access_token' => $this->config->getAccessToken()];
+        if (isset($arguments[0])) {
+            $params = array_merge($params, $arguments[0]);
+        }
+
+        return $this->doRequest($method, $params);
+    }
+
+    /**
+     * @throws \Exception
+     */
+    private function doRequest(string $method, array $params)
+    {
+        $payload = [
+            'jsonrpc' => '2.0',
+            'id' => time(),
+            'method' => $method,
+            'params' => $params,
+        ];
+
+        try {
+            $response = $this->client->post($this->getBaseUri(), ['json' => $payload]);
+
+            $responseBody = json_decode($response->getBody()->getContents());
+
+            if (isset($responseBody->result)) {
+                $this->metadata = $responseBody->result->metadata;
+            }
+
+            if (isset($responseBody->error)) {
+                throw new \Exception(
+                    "{$responseBody->error->code} {$responseBody->error->message}"
+                );
+            }
+
+            return $responseBody->result->data;
+        } catch (TransferException $e) {
+            throw new \Exception($e->getMessage());
+        }
+    }
+}

src/Uiscom/DataApiConfig.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Uiscom;
+
+use InvalidArgumentException;
+
+final class DataApiConfig
+{
+    private ?string $accessToken;
+
+    private string $entryPoint;
+
+    public function __construct(
+        ?string $accessToken = null,
+        ?string $entryPoint = null
+    ) {
+        if (empty($accessToken)) {
+            throw new InvalidArgumentException(
+                'Access token is required'
+            );
+        }
+
+        $this->accessToken = $accessToken;
+        $this->entryPoint = $entryPoint ?: 'https://dataapi.comagic.ru/';
+    }
+
+    public function getAccessToken(): ?string
+    {
+        return $this->accessToken;
+    }
+
+    public function getEntryPoint(): ?string
+    {
+        return $this->entryPoint;
+    }
+}

tests/CallApiClientTest.php

@@ -2,8 +2,8 @@
 
 declare(strict_types=1);
 
-use CoMagic\CallApiClient;
-use CoMagic\CallApiConfig;
+use Uiscom\CallApiClient;
+use Uiscom\CallApiConfig;
 use GuzzleHttp\Client;
 use GuzzleHttp\Psr7\Response;
 use PHPUnit\Framework\TestCase;

tests/CallApiConfigTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use CoMagic\CallApiConfig;
+use Uiscom\CallApiConfig;
 use PHPUnit\Framework\TestCase;
 
 /** @covers CallApiConfig */