Merge pull request #16 from mindbox-moscow/MBM-8

MBM-8

Author: MaximBurcev

.travis.yml

@@ -25,6 +25,9 @@ before_install:
 install:
   - travis_retry composer install --prefer-dist --no-interaction
 
+before_script:
+  - export XDEBUG_MODE=coverage
+
 # Run scripts
 script:
   - vendor/bin/phpcs

docs/structure/Mindbox-DTO-V2-Requests-SubscriptionRequestDTO.md

@@ -190,19 +190,6 @@ Methods
 
 
 
-### getValueByDefault
-
-    string Mindbox\DTO\V2\Requests\SubscriptionRequestDTO::getValueByDefault()
-
-
-
-
-
-* Visibility: **public**
-
-
-
-
 ### setValueByDefault
 
     mixed Mindbox\DTO\V2\Requests\SubscriptionRequestDTO::setValueByDefault(mixed $valueByDefault)

docs/structure/Mindbox-DTO-V3-Requests-SubscriptionRequestDTO.md

@@ -190,18 +190,6 @@ Methods
 
 
 
-### getValueByDefault
-
-    string Mindbox\DTO\V3\Requests\SubscriptionRequestDTO::getValueByDefault()
-
-
-
-
-
-* Visibility: **public**
-
-
-
 
 ### setValueByDefault
 

src/Clients/AbstractMindboxClient.php

@@ -51,6 +51,11 @@ abstract class AbstractMindboxClient
      */
     protected $responseType;
 
+    /**
+     * @var array $headers Поля хедера для запроса.
+     */
+    protected $headers;
+
     /**
      * Конструктор AbstractMindboxClient.
      *
@@ -64,6 +69,7 @@ public function __construct($secretKey, IHttpClient $httpClient, LoggerInterface
         $this->httpClient   = $httpClient;
         $this->logger       = $logger;
         $this->responseType = MindboxResponse::class;
+        $this->headers = $this->getDefaultHeaders();
     }
 
     /**
@@ -184,17 +190,11 @@ abstract protected function prepareUrl($additionalUrl, array $queryParams, $isSy
     /**
      * Подготовка массива заголовков запроса.
      *
-     * @param bool $addDeviceUUID Флаг: добавлять ли в запрос DeviceUUID.
-     *
      * @return array
      */
-    protected function prepareHeaders($addDeviceUUID = true)
+    protected function prepareHeaders()
     {
-        return [
-            'Accept'        => 'application/json',
-            'Content-Type'  => 'application/json',
-            'Authorization' => $this->prepareAuthorizationHeader(),
-        ];
+        return $this->headers;
     }
 
     /**
@@ -378,4 +378,37 @@ public function setResponseType($type)
         }
         $this->responseType = $type;
     }
+
+    /**
+     * Возвращает стандартные заголовки запроса.
+     *
+     * @return array
+     */
+    protected function getDefaultHeaders()
+    {
+        return [
+            'Accept'        => 'application/json',
+            'Content-Type'  => 'application/json',
+            'Authorization' => $this->prepareAuthorizationHeader(),
+            'Mindbox-Integration' => 'PhpSDK',
+            'Mindbox-Integration-Version' => '1.0'
+        ];
+    }
+
+    /**
+     * Добавляет заголовок запроса.
+     *
+     * @param array $headers Заголовок или массив заголовков.
+     *
+     * Пример:
+     *
+     * ['Mindbox-Integration' => 'PhpSDK']
+     *
+     */
+    public function addHeaders(array $headers)
+    {
+        if (is_array($headers)) {
+            $this->headers = array_merge($this->headers, $headers);
+        }
+    }
 }

src/DTO/V2/Requests/SubscriptionRequestDTO.php

@@ -45,14 +45,6 @@ public function setBrand($brand)
         $this->setField('brand', $brand);
     }
 
-    /**
-     * @return string
-     */
-    public function getValueByDefault()
-    {
-        return $this->getField('valueByDefault');
-    }
-
     /**
      * @param mixed $valueByDefault
      */

src/DTO/V3/Requests/SubscriptionRequestDTO.php

@@ -45,14 +45,6 @@ public function setBrand($brand)
         $this->setField('brand', $brand);
     }
 
-    /**
-     * @return string
-     */
-    public function getValueByDefault()
-    {
-        return $this->getField('valueByDefault');
-    }
-
     /**
      * @param mixed $valueByDefault
      */

src/Helpers/CustomerHelper.php

@@ -360,6 +360,32 @@ public function confirmMobile(
      *
      * @return \Mindbox\Clients\AbstractMindboxClient
      */
+    public function subscribeCustomer(
+        CustomerRequestDTO $customer,
+        $operationName,
+        $addDeviceUUID = false,
+        $isSync = true
+    ) {
+        $operation = $this->createOperation();
+        $operation->setCustomer($customer);
+
+        $this->client->setResponseType(MindboxCustomerResponse::class);
+
+        return $this->client->prepareRequest('POST', $operationName, $operation, '', [], $isSync, $addDeviceUUID);
+    }
+
+    /**
+     * Выполняет вызов стандартной операции Website.Subscribe:
+     *
+     * @see https://developers.mindbox.ru/v3.0/docs/json
+     *
+     * @param CustomerRequestDTO $customer      Объект, содержащий данные потребителя для запроса.
+     * @param string             $operationName Название операции.
+     * @param bool               $addDeviceUUID Флаг, сообщающий о необходимости передать в запросе DeviceUUID.
+     * @param bool               $isSync        Флаг, сообщающий о необходимости выполнять запрос синхронно/асинхронно.
+     *
+     * @return \Mindbox\Clients\AbstractMindboxClient
+     */
     public function subscribe(
         CustomerRequestDTO $customer,
         $operationName,

src/Mindbox.php

@@ -102,7 +102,7 @@ public function __construct(array $config, LoggerInterface $logger)
      *
      * @param array $config Массив, содержащий конфигурацию.
      */
-    protected function setConfig(array $config)
+    private function setConfig(array $config)
     {
         $this->config = array_merge($this->getDefaultConfig(), $config);
     }

tests/Clients/AbstractMindboxClientTest.php

@@ -29,7 +29,7 @@ class AbstractMindboxClientTest extends TestCase
     /**
      * @var string
      */
-    private $authHeader = 'authHeader';
+    private $authHeader = null;
 
     /**
      * @var \PHPUnit\Framework\MockObject\MockObject|\Mindbox\HttpClients\AbstractHttpClient
@@ -80,6 +80,8 @@ public function expectedArgsForSendProvider()
                         'Accept'        => 'application/json',
                         'Content-Type'  => 'application/json',
                         'Authorization' => $this->authHeader,
+                        'Mindbox-Integration' => 'PhpSDK',
+                        'Mindbox-Integration-Version' => '1.0'
                     ],
                 ],
             ],
@@ -98,8 +100,11 @@ public function expectedArgsForSendProvider()
                     'body'    => $this->getDTOStub()->toJson(),
                     'headers' => [
                         'Accept'        => 'application/json',
-                        'Content-Type'  => 'application/json',
+                        'Content-Type' => 'application/json',
                         'Authorization' => $this->authHeader,
+                        'Mindbox-Integration' => 'PhpSDK',
+                        'Mindbox-Integration-Version' => '1.0'
+
                     ],
                 ],
             ],

tests/Clients/MindboxClientV2Test.php

@@ -31,6 +31,8 @@ public function expectedArgsForSendProvider()
                         'Accept'        => 'application/xml',
                         'Content-Type'  => 'application/xml',
                         'Authorization' => 'DirectCrm key="' . $this->secret . '"',
+                        'Mindbox-Integration' => 'PhpSDK',
+                        'Mindbox-Integration-Version' => '1.0'
                     ],
                 ],
             ],
@@ -51,6 +53,8 @@ public function expectedArgsForSendProvider()
                         'Accept'        => 'application/xml',
                         'Content-Type'  => 'application/xml',
                         'Authorization' => 'DirectCrm key="' . $this->secret . '"',
+                        'Mindbox-Integration' => 'PhpSDK',
+                        'Mindbox-Integration-Version' => '1.0'
                     ],
                 ],
             ],