376 add bizproc scope support in services

CHANGELOG.md

@@ -1,18 +1,63 @@
 # bitrix24-php-sdk change log
 
-## 2.0-beta.2 — 1.04.2024
+## 2.0-beta.3 — 1.05.2024
 
 ### Added
+
+* add dependencies
+    * `symfony/console` version `^6 || ^7`
+    * `symfony/dotenv` version `^6 || ^7`
+    * `symfony/filesystem` version `^6 || ^7`
+    * `symfony/mime` version `^6 || ^7`
+    * `nesbot/carbon` version `3.3.*`
+* add scope `bizproc` and [services](https://github.com/mesilov/bitrix24-php-sdk/issues/376) for work with workflows:
+    * `Activity` – service for work with application activities:
+        * `add` – adds new activity to a workflow
+        * `delete` – delete an activity
+        * `list` – returns list of activities, installed by the application
+        * `log` – records data in the workflow log
+        * `update` – update activity fields
+    * `Robot` – service for work with application automation rules (robots):
+        * `add` – registers new automation rule
+        * `delete` – deletes registered automation rule
+        * `list` – returns list of automation rules, registered by the application
+        * `update` – updates fields of automation rules
+    * `Event` – service for work with return parameters¨
+        * `send` – Returns the output parameters to the activity
+    * `Providers` — deprecated methods, not implemented
+    * `Workflow` — service for work with workflow instances
+        * `instances` – returns list of launched workflows
+        * `kill` – delete a launched workflow
+        * `start` – launches a workflow
+        * `terminate` – stops an active workflow
+    * `Template` — service for work with workflow templates
+        * `add` – add a workflow template
+        * `delete` – delete workflow template
+        * `list` – returns list of workflow templates
+        * `update` – update workflow template
+    * `Tasks` — service for work with workflow tasks
+        * `complete` – Complete workflow task
+        * `list` – List of workflow tasks
+    * add `WorkflowActivityDocumentType`
+* add method `Bitrix24\SDK\Core\Credentials\AccessToken::initFromWorkflowRequest`
+* add `\Bitrix24\SDK\Infrastructure\Filesystem\Base64Encoder` for work with base64 encoding
+* add `\Bitrix24\SDK\Core\Exceptions\FileNotFoundException` if file not found
+* add `IncomingRobotRequest` wrapper for data from crm-robot request
+* add `IncomingWorkflowRequest` wrapper for data from biz proc activity request
+* add [Rector](https://github.com/rectorphp/rector) for improve code quality and speed up releases cycle
+
+## 2.0-beta.2 — 1.04.2024
+
 ### Changed
+
 * updated [dependencies versions](https://github.com/mesilov/bitrix24-php-sdk/issues/373):
-  * require
-    * `psr/log` `1.4.0` → `3.0.*`
-    * `moneyphp/money` `4.3.*` → `4.5.*`
-  * require-dev
-    * `monolog/monolog` `2.9.*` → `3.5.*`
-    * `phpunit/phpunit` `10.5.*` → `11.0.*`
-### Bugfix
-### etc
+    * require
+        * `psr/log` `1.4.0` → `3.0.*`
+        * `moneyphp/money` `4.3.*` → `4.5.*`
+    * require-dev
+        * `monolog/monolog` `2.9.*` → `3.5.*`
+        * `phpunit/phpunit` `10.5.*` → `11.0.*`
+* added enum `DealSemanticStage` for deal field `STAGE_SEMANTIC_ID`
 
 ## 2.0-beta.1 — 18.02.2024
 
@@ -38,13 +83,13 @@
 * add [crm item support](https://github.com/mesilov/bitrix24-php-sdk/issues/330)
 * add enum `DealStageSemanticId`
 * add Duplicate search support for `Bitrix24\SDK\Services\CRM\Duplicates\Service\Duplicate`
-* add `x-request-id` [header support](https://github.com/mesilov/bitrix24-php-sdk/issues/354) 
+* add `x-request-id` [header support](https://github.com/mesilov/bitrix24-php-sdk/issues/354)
 * add CRM multifields support [header support](https://github.com/mesilov/bitrix24-php-sdk/issues/338)
     * `Email`
     * `Phone`
     * `Website`
     * `IM`
-* add [Catalog](https://github.com/mesilov/bitrix24-php-sdk/issues/364) scope services support 
+* add [Catalog](https://github.com/mesilov/bitrix24-php-sdk/issues/364) scope services support
 
 ### Changed
 
@@ -59,7 +104,7 @@
       to `Bitrix24\SDK\Services\Telephony\Requests\Events\OnExternalCallStart\OnExternalCallStart`
     * from `Bitrix24\SDK\Services\Telephony\Requests\Events\OnVoximplantCallEnd`
       to `Bitrix24\SDK\Services\Telephony\Requests\Events\OnVoximplantCallEnd\OnVoximplantCallEnd`
-*  ❗Changes in `Bitrix24\SDK\Application\Contracts\Bitrix24Account\Bitrix24AccountInterface`:
+* ❗Changes in `Bitrix24\SDK\Application\Contracts\Bitrix24Account\Bitrix24AccountInterface`:
     * method `getContactPerson` renamed to `getContactPersonId`
     * added method `getApplicationVersion`
     * added method `updateApplicationVersion`
@@ -69,7 +114,7 @@
     * added method `markAsDeactivated`
     * added method `getBitrix24UserId`
     * removed method `markAccountAsDeleted`
-    * changed method `markAsActive` 
+    * changed method `markAsActive`
 * ❗Changes in `Bitrix24\SDK\Application\Contracts\Bitrix24Account\Bitrix24AccountRepositoryInterface`:
     * method `saveAccount` renamed to `save`
     * method `deleteAccount` renamed to `delete`
@@ -85,7 +130,10 @@
 * fix [typehint at ContactItemResult](https://github.com/mesilov/bitrix24-php-sdk/issues/320)
 * fix [return types in DealCategoryItemResult](https://github.com/mesilov/bitrix24-php-sdk/issues/322)
 * fix [add auth node in telephony voximplant events requests](https://github.com/mesilov/bitrix24-php-sdk/issues/331)
-* fix [add helper metods isError for registerCallResult fortelephony](https://github.com/mesilov/bitrix24-php-sdk/issues/335)
+*
+
+fix [add helper metods isError for registerCallResult fortelephony](https://github.com/mesilov/bitrix24-php-sdk/issues/335)
+
 * fix [add return type for crm multifields phone, email, im](https://github.com/mesilov/bitrix24-php-sdk/issues/338)
 * fix errors in `ShowFieldsDescriptionCommand` metadata reader CLI command
 * fix errors for `ApplicationProfile` with empty scope
@@ -158,9 +206,13 @@
   are [consistent](https://github.com/mesilov/bitrix24-php-sdk/issues/303): `createFromWebhook`, `createFromOAuth`
   , `createFromPlacementRequest`
 *
+
 ❗️deleted [unused class](https://github.com/mesilov/bitrix24-php-sdk/issues/303) `Bitrix24\SDK\Core\Response\DTO\ResponseDataCollection`
+
 *
+
 ❗️deleted [redundant class](https://github.com/mesilov/bitrix24-php-sdk/issues/303) `Bitrix24\SDK\Core\Response\DTO\Result`
+
 * ❗️deleted [method](https://github.com/mesilov/bitrix24-php-sdk/issues/303) `CoreBuilder::withWebhookUrl`, use
   method `CoreBuilder::withCredentials`
 

Makefile

@@ -3,7 +3,11 @@ default:
 	@egrep -e '^\S+' ./Makefile | grep -v default | sed -r 's/://' | sed -r 's/^/ - /'
 
 phpstan:
-	vendor/bin/phpstan analyse
+	vendor/bin/phpstan --memory-limit=1G analyse
+lint-rector:
+	vendor/bin/rector process --dry-run
+lint-rector-fix:
+	vendor/bin/rector process
 
 test-unit:
 	vendor/bin/phpunit --testsuite unit_tests

composer.json

@@ -28,8 +28,13 @@
     "psr/log": "^2 || ^3",
     "fig/http-message-util": "1.1.*",
     "ramsey/uuid": "^3 ||^4",
+    "nesbot/carbon": "3.3.*",
     "moneyphp/money": "^3 || ^4",
     "symfony/http-client": "^6 || ^7",
+    "symfony/console": "^6 || ^7",
+    "symfony/dotenv": "^6 || ^7",
+    "symfony/filesystem": "^6 || ^7",
+    "symfony/mime": "^6 || ^7",
     "symfony/http-client-contracts": "^2 || ^3",
     "symfony/http-foundation": "^6 || ^7",
     "symfony/event-dispatcher": "^6 || ^7",
@@ -39,12 +44,11 @@
     "monolog/monolog": "3.5.*",
     "phpstan/phpstan": "1.10.*",
     "phpunit/phpunit": "11.0.*",
-    "symfony/console": "7.0.*",
-    "symfony/dotenv": "7.0.*",
     "symfony/debug-bundle": "7.0.*",
     "symfony/stopwatch": "7.0.*",
     "roave/security-advisories": "dev-master",
-    "fakerphp/faker": "1.23.*"
+    "fakerphp/faker": "1.23.*",
+    "rector/rector": "^1.0"
   },
   "autoload": {
     "psr-4": {

phpstan.neon.dist

@@ -3,4 +3,10 @@ parameters:
   paths:
     - src/
   bootstrapFiles:
-    - tests/bootstrap.php
+    - tests/bootstrap.php
+  parallel:
+    jobSize: 20
+    maximumNumberOfProcesses: 8
+    minimumNumberOfJobsPerProcess: 2
+  editorUrlTitle: '%%relFile%%:%%line%%'
+  editorUrl: 'phpstorm://open?file=%%file%%&line=%%line%%'

rector.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Set\ValueObject\DowngradeLevelSetList;
+use Rector\TypeDeclaration\Rector\ClassMethod\AddVoidReturnTypeWhereNoReturnRector;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__ . '/src/Services/Workflows',
+    ])
+    ->withSets(
+        [DowngradeLevelSetList::DOWN_TO_PHP_82]
+    )
+    ->withPhpSets(
+        php82: true   // 8.2
+    )
+    ->withRules([
+        AddVoidReturnTypeWhereNoReturnRector::class,
+    ]);

src/Application/ApplicationStatus.php

@@ -24,30 +24,17 @@ class ApplicationStatus
      */
     public function __construct(string $statusShortCode)
     {
-        switch ($statusShortCode) {
-            case self::STATUS_SHORT_FREE:
-                $this->statusCode = 'free';
-                break;
-            case self::STATUS_SHORT_DEMO:
-                $this->statusCode = 'demo';
-                break;
-            case self::STATUS_SHORT_TRIAL:
-                $this->statusCode = 'trial';
-                break;
-            case self::STATUS_SHORT_PAID:
-                $this->statusCode = 'paid';
-                break;
-            case self::STATUS_SHORT_LOCAL:
-                $this->statusCode = 'local';
-                break;
-            case self::STATUS_SHORT_SUBSCRIPTION:
-                $this->statusCode = 'subscription';
-                break;
-            default:
-                throw new InvalidArgumentException(
-                    sprintf('unknown application status code %s', $statusShortCode)
-                );
-        }
+        $this->statusCode = match ($statusShortCode) {
+            self::STATUS_SHORT_FREE => 'free',
+            self::STATUS_SHORT_DEMO => 'demo',
+            self::STATUS_SHORT_TRIAL => 'trial',
+            self::STATUS_SHORT_PAID => 'paid',
+            self::STATUS_SHORT_LOCAL => 'local',
+            self::STATUS_SHORT_SUBSCRIPTION => 'subscription',
+            default => throw new InvalidArgumentException(
+                sprintf('unknown application status code %s', $statusShortCode)
+            ),
+        };
     }
 
     /**

src/Core/ApiLevelErrorHandler.php

@@ -4,18 +4,19 @@
 
 namespace Bitrix24\SDK\Core;
 
+use Bitrix24\SDK\Core\Exceptions\AuthForbiddenException;
 use Bitrix24\SDK\Core\Exceptions\BaseException;
+use Bitrix24\SDK\Core\Exceptions\InvalidArgumentException;
 use Bitrix24\SDK\Core\Exceptions\MethodNotFoundException;
 use Bitrix24\SDK\Core\Exceptions\OperationTimeLimitExceededException;
 use Bitrix24\SDK\Core\Exceptions\QueryLimitExceededException;
+use Bitrix24\SDK\Services\Workflows\Exceptions\ActivityOrRobotAlreadyInstalledException;
+use Bitrix24\SDK\Services\Workflows\Exceptions\ActivityOrRobotValidationFailureException;
+use Bitrix24\SDK\Services\Workflows\Exceptions\WorkflowTaskAlreadyCompletedException;
 use Psr\Log\LoggerInterface;
 
 /**
  * Handle api-level errors and throw related exception
- *
- * Class ApiLevelErrorHandler
- *
- * @package Bitrix24\SDK\Core
  */
 class ApiLevelErrorHandler
 {
@@ -82,14 +83,32 @@ private function handleError(array $responseBody, ?string $batchCommandId = null
         if ($batchCommandId !== null) {
             $batchErrorPrefix = sprintf(' batch command id: %s', $batchCommandId);
         }
+        // fix error code responses
+        if ($errorCode === '' && strtolower($errorDescription) === strtolower('You can delete ONLY templates created by current application')) {
+            $errorCode = 'bizproc_workflow_template_access_denied';
+        }
+        if ($errorCode === '' && strtolower($errorDescription) === strtolower('No fields to update.')) {
+            $errorCode = 'bad_request_no_fields_to_update';
+        }
 
         switch ($errorCode) {
+            case 'error_task_completed':
+                throw new WorkflowTaskAlreadyCompletedException(sprintf('%s - %s', $errorCode, $errorDescription));
+            case 'bad_request_no_fields_to_update':
+                throw new InvalidArgumentException(sprintf('%s - %s', $errorCode, $errorDescription));
+            case 'access_denied':
+            case 'bizproc_workflow_template_access_denied':
+                throw new AuthForbiddenException(sprintf('%s - %s', $errorCode, $errorDescription));
             case 'query_limit_exceeded':
                 throw new QueryLimitExceededException(sprintf('query limit exceeded - too many requests %s', $batchErrorPrefix));
             case 'error_method_not_found':
                 throw new MethodNotFoundException(sprintf('api method not found %s %s', $errorDescription, $batchErrorPrefix));
             case 'operation_time_limit':
                 throw new OperationTimeLimitExceededException(sprintf('operation time limit exceeded %s %s', $errorDescription, $batchErrorPrefix));
+            case 'error_activity_already_installed':
+                throw new ActivityOrRobotAlreadyInstalledException(sprintf('%s - %s', $errorCode, $errorDescription));
+            case 'error_activity_validation_failure':
+                throw new ActivityOrRobotValidationFailureException(sprintf('%s - %s', $errorCode, $errorDescription));
             default:
                 throw new BaseException(sprintf('%s - %s %s', $errorCode, $errorDescription, $batchErrorPrefix));
         }