Merge pull request #125 from Laurgrin/SUPPORT-106898

Update util raml generator to allow for 202 response to return a body.

Author: mSprunskas

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 11.11.0
+### Added
+- 202 responses can now return a body.
+
 ## 11.10.1
 ### Removed
 - Removed PHP `7.2` and `7.3` from Travis includes

src/Paysera/Bundle/CodeGeneratorBundle/Service/BodyResolver.php

@@ -9,6 +9,7 @@
 use Raml\Body;
 use Raml\BodyInterface;
 use Raml\Method;
+use Raml\Response;
 use Raml\Types\ArrayType;
 use Raml\Types\StringType;
 
@@ -41,32 +42,31 @@ public function getRequestBody(Method $method)
      */
     public function getResponseBody(Method $method)
     {
-        $okResponse = $method->getResponse(StatusCodeInterface::STATUS_OK);
-
-        if ($okResponse === null) {
+        $successfulResponse = $this->getSuccessfulResponse($method);
+        if ($successfulResponse === null) {
             return null;
         }
 
         try {
-            return $okResponse->getBodyByType(self::BODY_JSON);
+            return $successfulResponse->getBodyByType(self::BODY_JSON);
         } catch (Exception $exception) {}
 
         try {
-            $body = $okResponse->getBodyByType(self::BODY_JAVASCRIPT);
+            $body = $successfulResponse->getBodyByType(self::BODY_JAVASCRIPT);
             $body->setType(new StringType('string'));
 
             return $body;
         } catch (Exception $exception) {}
 
         try {
-            return $okResponse->getBodyByType(self::BODY_OCTET_STREAM);
+            return $successfulResponse->getBodyByType(self::BODY_OCTET_STREAM);
         } catch (Exception $exception) {}
 
         try {
-            return $okResponse->getBodyByType(self::BODY_TEXT_CSV);
+            return $successfulResponse->getBodyByType(self::BODY_TEXT_CSV);
         } catch (Exception $exception) {}
 
-        throw new Exception('No body found');
+        return null;
     }
 
     public function isRawResponse(Method $method)
@@ -103,4 +103,16 @@ public function isIterableResponse(Method $method, ApiDefinition $api)
 
         return false;
     }
+
+    private function getSuccessfulResponse(Method $method): ?Response
+    {
+        foreach ($method->getResponses() as $response) {
+            $statusCode = $response->getStatusCode();
+            if (in_array($statusCode, [200, 202], true)) {
+                return $method->getResponse($statusCode);
+            }
+        }
+
+        return null;
+    }
 }

tests/PhpGeneratorBundle/RestClient/Fixtures/expected/sky-net/README.md

@@ -0,0 +1,69 @@
+
+## vendor-sky-net-client
+
+Provides methods to manipulate `SkyNetClient` API.
+It automatically authenticates all requests and maps required data structure for you.
+
+#### Usage
+
+This library provides `ClientFactory` class, which you should use to get the API client itself:
+
+```php
+use Paysera\Test\SkyNetClient\ClientFactory;
+
+$clientFactory = new ClientFactory([
+    'base_url' => 'http://example.com/sky-net/rest/v1/', // optional, in case you need a custom one.
+    'mac' => [                                          // use this, if API requires Mac authentication.
+        'mac_id' => 'my-mac-id',
+        'mac_secret' => 'my-mac-secret',
+    ],
+    'basic' => [                                        // use this, if API requires Basic authentication.
+        'username' => 'username',
+        'password' => 'password',
+    ],
+    'oauth' => [                                        // use this, if API requires OAuth v2 authentication.
+        'token' => [
+            'access_token' => 'my-access-token',
+            'refresh_token' => 'my-refresh-token',
+        ],
+    ],
+    // other configuration options, if needed
+]);
+
+$skyNetClient = $clientFactory->getSkyNetClient();
+```
+
+Please use only one authentication mechanism, provided by `Vendor`.
+
+Now, that you have instance of `SkyNetClient`, you can use following methods
+### Methods
+
+    
+Set the target of termination
+
+
+```php
+use Paysera\Test\SkyNetClient\Entity as Entities;
+
+$terminationInput = new Entities\TerminationInput();
+
+$terminationInput->setTargetName($targetName);
+    
+$result = $skyNetClient->createTermination($terminationInput);
+```
+---
+
+Change the target of termination
+
+
+```php
+use Paysera\Test\SkyNetClient\Entity as Entities;
+
+$terminationInput = new Entities\TerminationInput();
+
+$terminationInput->setTargetName($targetName);
+    
+$skyNetClient->updateTermination($terminationInput);
+```
+---
+

tests/PhpGeneratorBundle/RestClient/Fixtures/expected/sky-net/composer.json

@@ -0,0 +1,16 @@
+{
+    "name": "vendor/lib-sky-net-client",
+    "description": "SkyNetClient",
+    "version": "1.0",
+    "autoload": {
+        "psr-4": {
+            "Paysera\\Test\\SkyNetClient\\": "src"
+        }
+    },
+    "require": {
+        "php": ">=5.5",
+        "paysera/lib-rest-client-common": "^1.0 | ^2.5",
+        "fig/http-message-util": "^1.0"
+    },
+    "minimum-stability": "stable"
+}

tests/PhpGeneratorBundle/RestClient/Fixtures/expected/sky-net/src/ClientFactory.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Paysera\Test\SkyNetClient;
+
+use Paysera\Component\RestClientCommon\Util\ClientFactoryAbstract;
+use Paysera\Component\RestClientCommon\Client\ApiClient;
+
+class ClientFactory extends ClientFactoryAbstract
+{
+    const DEFAULT_BASE_URL = 'http://example.com/sky-net/rest/v1/';
+
+    protected $apiClient;
+
+    public function __construct($options)
+    {
+        if ($options instanceof ApiClient) {
+            $this->apiClient = $options;
+            return;
+        }
+
+        $defaultUrlParameters = [];
+        
+        $options['url_parameters'] = $this->resolveDefaultUrlParameters($defaultUrlParameters, $options);
+        $this->apiClient = $this->createApiClient($options);
+    }
+
+    public function getSkyNetClient()
+    {
+        return new SkyNetClient($this->apiClient);
+    }
+
+    private function resolveDefaultUrlParameters(array $defaults, array $options)
+    {
+        $params = [];
+        if (isset($options['url_parameters'])) {
+            $params = $options['url_parameters'];
+        }
+
+        return $params + $defaults;
+    }
+}

tests/PhpGeneratorBundle/RestClient/Fixtures/expected/sky-net/src/Entity/TerminationInput.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Paysera\Test\SkyNetClient\Entity;
+
+use Paysera\Component\RestClientCommon\Entity\Entity;
+
+class TerminationInput extends Entity
+{
+    public function __construct(array $data = [])
+    {
+        parent::__construct($data);
+    }
+
+    /**
+     * @return string
+     */
+    public function getTargetName()
+    {
+        return $this->get('target_name');
+    }
+    /**
+     * @param string $targetName
+     * @return $this
+     */
+    public function setTargetName($targetName)
+    {
+        $this->set('target_name', $targetName);
+        return $this;
+    }
+}

tests/PhpGeneratorBundle/RestClient/Fixtures/expected/sky-net/src/Entity/TerminationOutput.php

@@ -0,0 +1,99 @@
+<?php
+
+namespace Paysera\Test\SkyNetClient\Entity;
+
+use Paysera\Component\RestClientCommon\Entity\Entity;
+
+class TerminationOutput extends Entity
+{
+    const REFERENCE_TYPE_INFORMATION_REQUEST = 'information_request';
+    const STATUS_ACCEPTED = 'accepted';
+    const STATUS_PROCESSING = 'processing';
+    const STATUS_COMPLETED = 'completed';
+
+    public function __construct(array $data = [])
+    {
+        parent::__construct($data);
+    }
+
+    /**
+     * @return string
+     */
+    public function getId()
+    {
+        return $this->get('id');
+    }
+    /**
+     * @param string $id
+     * @return $this
+     */
+    public function setId($id)
+    {
+        $this->set('id', $id);
+        return $this;
+    }
+    /**
+     * @return string
+     */
+    public function getReferenceId()
+    {
+        return $this->get('reference_id');
+    }
+    /**
+     * @param string $referenceId
+     * @return $this
+     */
+    public function setReferenceId($referenceId)
+    {
+        $this->set('reference_id', $referenceId);
+        return $this;
+    }
+    /**
+     * @return string
+     */
+    public function getReferenceType()
+    {
+        return $this->get('reference_type');
+    }
+    /**
+     * @param string $referenceType
+     * @return $this
+     */
+    public function setReferenceType($referenceType)
+    {
+        $this->set('reference_type', $referenceType);
+        return $this;
+    }
+    /**
+     * @return string
+     */
+    public function getStatus()
+    {
+        return $this->get('status');
+    }
+    /**
+     * @param string $status
+     * @return $this
+     */
+    public function setStatus($status)
+    {
+        $this->set('status', $status);
+        return $this;
+    }
+    /**
+     * @return \DateTimeImmutable
+     */
+    public function getCreatedAt()
+    {
+        return (new \DateTimeImmutable())->setTimestamp($this->get('created_at'));
+    }
+    /**
+     * @param \DateTimeInterface $createdAt
+     * @return $this
+     */
+    public function setCreatedAt(\DateTimeInterface $createdAt)
+    {
+        $this->set('created_at', $createdAt->getTimestamp());
+        return $this;
+    }
+}

tests/PhpGeneratorBundle/RestClient/Fixtures/expected/sky-net/src/SkyNetClient.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace Paysera\Test\SkyNetClient;
+
+use Paysera\Test\SkyNetClient\Entity as Entities;
+use Fig\Http\Message\RequestMethodInterface;
+use Paysera\Component\RestClientCommon\Entity\Entity;
+use Paysera\Component\RestClientCommon\Client\ApiClient;
+
+class SkyNetClient
+{
+    private $apiClient;
+
+    public function __construct(ApiClient $apiClient)
+    {
+        $this->apiClient = $apiClient;
+    }
+
+    public function withOptions(array $options)
+    {
+        return new SkyNetClient($this->apiClient->withOptions($options));
+    }
+
+    /**
+     * Set the target of termination
+     * POST /termination
+     *
+     * @param Entities\TerminationInput $terminationInput
+     * @return Entities\TerminationOutput
+     */
+    public function createTermination(Entities\TerminationInput $terminationInput)
+    {
+        $request = $this->apiClient->createRequest(
+            RequestMethodInterface::METHOD_POST,
+            'termination',
+            $terminationInput
+        );
+        $data = $this->apiClient->makeRequest($request);
+
+        return new Entities\TerminationOutput($data);
+    }
+
+    /**
+     * Change the target of termination
+     * PUT /termination
+     *
+     * @param Entities\TerminationInput $terminationInput
+     * @return null
+     */
+    public function updateTermination(Entities\TerminationInput $terminationInput)
+    {
+        $request = $this->apiClient->createRequest(
+            RequestMethodInterface::METHOD_PUT,
+            'termination',
+            $terminationInput
+        );
+        $data = $this->apiClient->makeRequest($request);
+
+        return null;
+    }
+}