fix method name in ContactsResult

Author: mesilov

CHANGELOG.md

@@ -6,6 +6,9 @@
 * change in scope «CRM» Product service and integration tests
 * add `AddedItemIdResultInterface` for batch-queries result
 * fix method name in `ContactsResult`
+* add interface `ApiClientInterface`
+* bump phpunit version
+* bump phpstan version
 
 ## 2.0-alpha.2 (31.01.2021)
 

composer.json

@@ -32,8 +32,8 @@
     "symfony/console": "5.2.*",
     "symfony/dotenv": "5.2.*",
     "symfony/debug-bundle": "5.2.*",
-    "phpstan/phpstan": "0.12.59",
-    "phpunit/phpunit": "9.3.*",
+    "phpstan/phpstan": "1.1.*",
+    "phpunit/phpunit": "9.5.*",
     "roave/security-advisories": "dev-master"
   },
   "autoload": {

src/Core/ApiClient.php

@@ -4,32 +4,19 @@
 
 namespace Bitrix24\SDK\Core;
 
+use Bitrix24\SDK\Core\Contracts\ApiClientInterface;
 use Bitrix24\SDK\Core\Exceptions\InvalidArgumentException;
 use Bitrix24\SDK\Core\Response\DTO\RenewedAccessToken;
 use Psr\Log\LoggerInterface;
 use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 
-/**
- * Class ApiClient
- *
- * @package Bitrix24\SDK\Core
- */
-class ApiClient
+class ApiClient implements ApiClientInterface
 {
-    /**
-     * @var HttpClientInterface
-     */
-    protected $client;
-    /**
-     * @var LoggerInterface
-     */
-    protected $logger;
-    /**
-     * @var Credentials\Credentials
-     */
-    protected $credentials;
+    protected HttpClientInterface $client;
+    protected LoggerInterface $logger;
+    protected Credentials\Credentials $credentials;
     /**
      * @const string
      */
@@ -90,12 +77,12 @@ public function getCredentials(): Credentials\Credentials
      */
     public function getNewAccessToken(): RenewedAccessToken
     {
-        $this->logger->debug(sprintf('getNewAccessToken.start'));
+        $this->logger->debug('getNewAccessToken.start');
         if ($this->getCredentials()->getApplicationProfile() === null) {
-            throw new InvalidArgumentException(sprintf('application profile not set'));
+            throw new InvalidArgumentException('application profile not set');
         }
         if ($this->getCredentials()->getAccessToken() === null) {
-            throw new InvalidArgumentException(sprintf('access token in credentials not set'));
+            throw new InvalidArgumentException('access token in credentials not set');
         }
 
         $method = 'GET';
@@ -119,7 +106,7 @@ public function getNewAccessToken(): RenewedAccessToken
         $result = $response->toArray(false);
         $newAccessToken = RenewedAccessToken::initFromArray($result);
 
-        $this->logger->debug(sprintf('getNewAccessToken.finish'));
+        $this->logger->debug('getNewAccessToken.finish');
 
         return $newAccessToken;
     }

src/Core/ApiLevelErrorHandler.php

@@ -18,10 +18,7 @@
  */
 class ApiLevelErrorHandler
 {
-    /**
-     * @var LoggerInterface
-     */
-    protected $logger;
+    protected LoggerInterface $logger;
     protected const ERROR_KEY = 'error';
     protected const ERROR_DESCRIPTION_KEY = 'error_description';
 
@@ -58,9 +55,9 @@ public function handle(array $responseBody): void
         );
         switch ($errorCode) {
             case 'query_limit_exceeded':
-                throw new QueryLimitExceededException(sprintf('query limit exceeded - too many requests'));
+                throw new QueryLimitExceededException('query limit exceeded - too many requests');
             case 'error_method_not_found':
-                throw new MethodNotFoundException(sprintf('api method not found'));
+                throw new MethodNotFoundException('api method not found');
             default:
                 throw new BaseException(sprintf('%s - %s', $errorCode, $errorDescription));
         }

src/Core/Contracts/ApiClientInterface.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Core\Contracts;
+
+use Bitrix24\SDK\Core\Credentials\Credentials;
+use Bitrix24\SDK\Core\Exceptions\InvalidArgumentException;
+use Bitrix24\SDK\Core\Response\DTO\RenewedAccessToken;
+use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
+use Symfony\Contracts\HttpClient\ResponseInterface;
+
+interface ApiClientInterface
+{
+    /**
+     * @param string $apiMethod
+     * @param array  $parameters
+     *
+     * @return ResponseInterface
+     * @throws TransportExceptionInterface
+     * @throws InvalidArgumentException
+     */
+    public function getResponse(string $apiMethod, array $parameters = []): ResponseInterface;
+
+    /**
+     * @return RenewedAccessToken
+     * @throws InvalidArgumentException
+     * @throws TransportExceptionInterface
+     */
+    public function getNewAccessToken(): RenewedAccessToken;
+
+    /**
+     * @return Credentials
+     */
+    public function getCredentials(): Credentials;
+}

src/Core/Contracts/CoreInterface.php

@@ -24,4 +24,9 @@ interface CoreInterface
      * @throws TransportException
      */
     public function call(string $apiMethod, array $parameters = []): Response;
+
+    /**
+     * @return \Bitrix24\SDK\Core\Contracts\ApiClientInterface
+     */
+    public function getApiClient(): ApiClientInterface;
 }

src/Core/Core.php

@@ -5,6 +5,7 @@
 namespace Bitrix24\SDK\Core;
 
 use Bitrix24\SDK\Core\Commands\Command;
+use Bitrix24\SDK\Core\Contracts\ApiClientInterface;
 use Bitrix24\SDK\Core\Contracts\CoreInterface;
 use Bitrix24\SDK\Core\Exceptions\BaseException;
 use Bitrix24\SDK\Core\Exceptions\TransportException;
@@ -22,33 +23,21 @@
  */
 class Core implements CoreInterface
 {
-    /**
-     * @var ApiClient
-     */
-    protected ApiClient $apiClient;
-    /**
-     * @var LoggerInterface
-     */
+    protected ApiClientInterface $apiClient;
     protected LoggerInterface $logger;
-    /**
-     * @var EventDispatcherInterface
-     */
     protected EventDispatcherInterface $eventDispatcher;
-    /**
-     * @var ApiLevelErrorHandler
-     */
     protected ApiLevelErrorHandler $apiLevelErrorHandler;
 
     /**
      * Main constructor.
      *
-     * @param ApiClient                $apiClient
+     * @param ApiClientInterface       $apiClient
      * @param ApiLevelErrorHandler     $apiLevelErrorHandler
      * @param EventDispatcherInterface $eventDispatcher
      * @param LoggerInterface          $logger
      */
     public function __construct(
-        ApiClient $apiClient,
+        ApiClientInterface $apiClient,
         ApiLevelErrorHandler $apiLevelErrorHandler,
         EventDispatcherInterface $eventDispatcher,
         LoggerInterface $logger
@@ -179,4 +168,12 @@ public function call(string $apiMethod, array $parameters = []): Response
 
         return $response;
     }
+
+    /**
+     * @return \Bitrix24\SDK\Core\Contracts\ApiClientInterface
+     */
+    public function getApiClient(): ApiClientInterface
+    {
+        return $this->apiClient;
+    }
 }

src/Core/CoreBuilder.php

@@ -4,6 +4,7 @@
 
 namespace Bitrix24\SDK\Core;
 
+use Bitrix24\SDK\Core\Contracts\ApiClientInterface;
 use Bitrix24\SDK\Core\Contracts\CoreInterface;
 use Bitrix24\SDK\Core\Credentials\Credentials;
 use Bitrix24\SDK\Core\Credentials\WebhookUrl;
@@ -22,34 +23,13 @@
  */
 class CoreBuilder
 {
-    /**
-     * @var ApiClient|null
-     */
-    protected $apiClient;
-    /**
-     * @var HttpClientInterface
-     */
-    protected $httpClient;
-    /**
-     * @var EventDispatcherInterface
-     */
-    protected $eventDispatcher;
-    /**
-     * @var LoggerInterface
-     */
-    protected $logger;
-    /**
-     * @var WebhookUrl|null
-     */
-    protected $webhookUrl;
-    /**
-     * @var Credentials|null
-     */
-    protected $credentials;
-    /**
-     * @var ApiLevelErrorHandler
-     */
-    protected $apiLevelErrorHandler;
+    protected ?ApiClientInterface $apiClient;
+    protected HttpClientInterface $httpClient;
+    protected EventDispatcherInterface $eventDispatcher;
+    protected LoggerInterface $logger;
+    protected ?WebhookUrl $webhookUrl;
+    protected ?Credentials $credentials;
+    protected ApiLevelErrorHandler $apiLevelErrorHandler;
 
     /**
      * CoreBuilder constructor.
@@ -83,11 +63,11 @@ public function withWebhookUrl(string $webhookUrl): self
     }
 
     /**
-     * @param ApiClient $apiClient
+     * @param ApiClientInterface $apiClient
      *
      * @return $this
      */
-    public function withApiClient(ApiClient $apiClient): self
+    public function withApiClient(ApiClientInterface $apiClient): self
     {
         $this->apiClient = $apiClient;
 
@@ -127,7 +107,7 @@ public function build(): CoreInterface
         if ($this->webhookUrl !== null) {
             $this->credentials = Credentials::createForWebHook($this->webhookUrl);
         } elseif ($this->credentials === null) {
-            throw new InvalidArgumentException(sprintf('you must set webhook url or oauth credentials'));
+            throw new InvalidArgumentException('you must set webhook url or oauth credentials');
         }
 
         if ($this->apiClient === null) {

src/Core/Credentials/Credentials.php

@@ -11,23 +11,10 @@
  */
 class Credentials
 {
-    /**
-     * @var WebhookUrl|null
-     */
-    protected $webhookUrl;
-    /**
-     * @var AccessToken|null
-     */
-    protected $accessToken;
-    /**
-     * @var ApplicationProfile|null
-     */
-    protected $applicationProfile;
-
-    /**
-     * @var string|null
-     */
-    protected $domainUrl;
+    protected ?WebhookUrl $webhookUrl;
+    protected ?AccessToken $accessToken;
+    protected ?ApplicationProfile $applicationProfile;
+    protected ?string $domainUrl;
 
     /**
      * Credentials constructor.
@@ -48,10 +35,10 @@ public function __construct(
         $this->applicationProfile = $applicationProfile;
         $this->domainUrl = $domainUrl;
         if ($this->accessToken === null && $this->webhookUrl === null) {
-            throw new \LogicException(sprintf('you must set on of auth type: webhook or OAuth 2.0'));
+            throw new \LogicException('you must set on of auth type: webhook or OAuth 2.0');
         }
         if ($this->accessToken !== null && $this->domainUrl === null) {
-            throw new \LogicException(sprintf('for oauth type you must set domain url'));
+            throw new \LogicException('for oauth type you must set domain url');
         }
     }
 
@@ -77,7 +64,9 @@ public function getApplicationProfile(): ?ApplicationProfile
     public function getDomainUrl(): string
     {
         if ($this->getWebhookUrl() !== null) {
-            $url = parse_url($this->getWebhookUrl()->getUrl())['host'];
+            $arUrl = parse_url($this->getWebhookUrl()->getUrl());
+
+            $url = sprintf('%s://%s', $arUrl['scheme'], $arUrl['host']);
         } else {
             $url = $this->domainUrl;
         }

src/Services/AbstractService.php

@@ -4,7 +4,6 @@
 
 namespace Bitrix24\SDK\Services;
 
-use Bitrix24\SDK\Core\Contracts\BatchInterface;
 use Bitrix24\SDK\Core\Contracts\CoreInterface;
 use Psr\Log\LoggerInterface;
 
@@ -15,7 +14,10 @@
  */
 abstract class AbstractService
 {
-    protected CoreInterface $core;
+    /**
+     * @property-read CoreInterface $core
+     */
+    public CoreInterface $core;
     protected LoggerInterface $log;
 
     /**