Skip to content
This repository has been archived by the owner on Aug 1, 2023. It is now read-only.

Commit

Permalink
Synchronization with WrikePhpLibrary changes + general refactoring.
Browse files Browse the repository at this point in the history
  • Loading branch information
zibios committed Mar 2, 2017
1 parent db47432 commit 506f67e
Show file tree
Hide file tree
Showing 11 changed files with 70 additions and 24 deletions.
54 changes: 51 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
Wrike PHP JMSSERIALIZER
================================

**Proof of Concept - NOT YET USABLE!!!**

**First usable version around 2017-03-01**
**Alpha version, first usable version around 2017-03-06**

Introduction
------------
Expand Down Expand Up @@ -52,6 +50,56 @@ Run PHPUnit tests:
./vendor/bin/phpunit
```

Usage
------------
All \GuzzleHttp\Client methods plus methods for \Zibios\WrikePhpLibrary\Client\ClientInterface.

```php
/**
* Standard usage
*/
$serializer = SerializerFactory::create(); // \JMS\Serializer\SerializerInterface
```

```php
$resourceModelTransformer = TransformerFactory::createResourceModelTransformer($serializer);

/**
* @param ResponseInterface $response
* @param string $resourceClass
*
* @return ResourceModelInterface
*/
$result = $resourceModelTransformer->transform($response, $resourceClass);

$result => [
<ResourceModelInterface>,
<ResourceModelInterface>,
...
]
```

```php
$responseModelTransformer = TransformerFactory::createResponseModelTransformer($serializer);

/**
* @param ResponseInterface $response
* @param string $resourceClass
*
* @return ResponseModelInterface
*/
$result = $responseModelTransformer->transform($response, $resourceClass);

$result => ResponseModelInterface {
kind: <ResponseType>;
data:
[
<ResourceModelInterface>,
<ResourceModelInterface>,
...
]
}
```

Reference
---------
Expand Down
2 changes: 1 addition & 1 deletion src/SerializerFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class SerializerFactory
/**
* @return SerializerInterface
*/
public static function createSerializer()
public static function create()
{
AnnotationRegistry::registerAutoloadNamespace(
'JMS\Serializer\Annotation',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
* file that was distributed with this source code.
*/

namespace Zibios\WrikePhpJmsserializer\Transformer;
namespace Zibios\WrikePhpJmsserializer\Transformer\Response;

use JMS\Serializer\SerializerInterface;
use Zibios\WrikePhpJmsserializer\Model\Account\AccountResponseModel;
Expand Down Expand Up @@ -44,7 +44,7 @@
use Zibios\WrikePhpLibrary\Resource\UserResource;
use Zibios\WrikePhpLibrary\Resource\VersionResource;
use Zibios\WrikePhpLibrary\Resource\WorkflowResource;
use Zibios\WrikePhpLibrary\Transformer\AbstractResponseTransformer as BaseAbstractResponseTransformer;
use Zibios\WrikePhpLibrary\Transformer\Response\Psr\AbstractPsrResponseTransformer as BaseAbstractResponseTransformer;

/**
* Response Transformer Abstract.
Expand Down
3 changes: 1 addition & 2 deletions src/Transformer/Response/ResourceModelTransformer.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
use Psr\Http\Message\ResponseInterface;
use Zibios\WrikePhpJmsserializer\Model\ResourceModelInterface;
use Zibios\WrikePhpJmsserializer\Model\ResponseModelInterface;
use Zibios\WrikePhpJmsserializer\Transformer\AbstractResponseTransformer;

/**
* Resource Model Transformer.
Expand All @@ -30,7 +29,7 @@ class ResourceModelTransformer extends AbstractResponseTransformer
*
* @return array|ResourceModelInterface[]|null
*/
public function transform(ResponseInterface $response, $resourceClass)
public function transform($response, $resourceClass)
{
$stringBody = $this->transformToStringBody($response);
/** @var ResponseModelInterface $responseModel */
Expand Down
3 changes: 1 addition & 2 deletions src/Transformer/Response/ResponseModelTransformer.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@

use Psr\Http\Message\ResponseInterface;
use Zibios\WrikePhpJmsserializer\Model\ResponseModelInterface;
use Zibios\WrikePhpJmsserializer\Transformer\AbstractResponseTransformer;

/**
* Response Model Transformer.
Expand All @@ -29,7 +28,7 @@ class ResponseModelTransformer extends AbstractResponseTransformer
*
* @return ResponseModelInterface
*/
public function transform(ResponseInterface $response, $resourceClass)
public function transform($response, $resourceClass)
{
$stringBody = $this->transformToStringBody($response);
/** @var ResponseModelInterface $responseModel */
Expand Down
2 changes: 1 addition & 1 deletion src/TransformerFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public static function createResponseModelTransformer(SerializerInterface $seria
protected static function prepareSerializer(SerializerInterface $serializer = null)
{
if ($serializer === null) {
$serializer = SerializerFactory::createSerializer();
$serializer = SerializerFactory::create();
}

return $serializer;
Expand Down
4 changes: 2 additions & 2 deletions tests/SerializerFactoryTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@
*/
class SerializerFactoryTest extends TestCase
{
public function test_createSerializer()
public function test_create()
{
$serializer = SerializerFactory::createSerializer();
$serializer = SerializerFactory::create();
self::assertInstanceOf(SerializerInterface::class, $serializer);
self::assertInstanceOf(Serializer::class, $serializer);
}
Expand Down
8 changes: 4 additions & 4 deletions tests/Transformer/Response/ResourceModelTransformerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
use Zibios\WrikePhpJmsserializer\Model\Version\VersionResourceModel;
use Zibios\WrikePhpJmsserializer\Model\Workflow\WorkflowResourceModel;
use Zibios\WrikePhpJmsserializer\SerializerFactory;
use Zibios\WrikePhpJmsserializer\Tests\Transformer\ResponseTransformerTestCase;
use Zibios\WrikePhpJmsserializer\Transformer\Response\ResourceModelTransformer;
use Zibios\WrikePhpLibrary\Api;
use Zibios\WrikePhpLibrary\Resource\AccountResource;
Expand Down Expand Up @@ -59,7 +58,7 @@ class ResourceModelTransformerTest extends ResponseTransformerTestCase

public function setUp()
{
$serializer = SerializerFactory::createSerializer();
$serializer = SerializerFactory::create();
$this->object = new ResourceModelTransformer($serializer);
}

Expand Down Expand Up @@ -134,8 +133,9 @@ public function test_testNormalizeInstancesProviderCoverAllMethods()

$excludedMethods = [
'__construct',
'getBearerToken',
'setBearerToken',
'recreateForNewAccessToken',
'recreateForNewApiExceptionTransformer',
'recreateForNewResponseTransformer',
];

foreach ($expectedMethodNames as $expectedMethodName) {
Expand Down
8 changes: 4 additions & 4 deletions tests/Transformer/Response/ResponseModelTransformerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@
use Zibios\WrikePhpJmsserializer\Model\Workflow\WorkflowResourceModel;
use Zibios\WrikePhpJmsserializer\Model\Workflow\WorkflowResponseModel;
use Zibios\WrikePhpJmsserializer\SerializerFactory;
use Zibios\WrikePhpJmsserializer\Tests\Transformer\ResponseTransformerTestCase;
use Zibios\WrikePhpJmsserializer\Transformer\Response\ResponseModelTransformer;
use Zibios\WrikePhpLibrary\Api;
use Zibios\WrikePhpLibrary\Resource\AccountResource;
Expand Down Expand Up @@ -76,7 +75,7 @@ class ResponseModelTransformerTest extends ResponseTransformerTestCase

public function setUp()
{
$serializer = SerializerFactory::createSerializer();
$serializer = SerializerFactory::create();
$this->object = new ResponseModelTransformer($serializer);
}

Expand Down Expand Up @@ -152,8 +151,9 @@ public function test_testNormalizeInstancesProviderCoverAllMethods()

$excludedMethods = [
'__construct',
'getBearerToken',
'setBearerToken',
'recreateForNewAccessToken',
'recreateForNewApiExceptionTransformer',
'recreateForNewResponseTransformer',
];

foreach ($expectedMethodNames as $expectedMethodName) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
* file that was distributed with this source code.
*/

namespace Zibios\WrikePhpJmsserializer\Tests\Transformer;
namespace Zibios\WrikePhpJmsserializer\Tests\Transformer\Response;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\StreamInterface;
Expand Down
4 changes: 2 additions & 2 deletions tests/TransformerFactoryTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public function test_createResourceModelTransformer()
self::assertInstanceOf(ResponseTransformerInterface::class, $transformer);
self::assertInstanceOf(ResourceModelTransformer::class, $transformer);

$serializer = SerializerFactory::createSerializer();
$serializer = SerializerFactory::create();
$transformer = TransformerFactory::createResourceModelTransformer($serializer);
self::assertInstanceOf(ResponseTransformerInterface::class, $transformer);
self::assertInstanceOf(ResourceModelTransformer::class, $transformer);
Expand All @@ -40,7 +40,7 @@ public function test_createResponseModelTransformer()
self::assertInstanceOf(ResponseTransformerInterface::class, $transformer);
self::assertInstanceOf(ResponseModelTransformer::class, $transformer);

$serializer = SerializerFactory::createSerializer();
$serializer = SerializerFactory::create();
$transformer = TransformerFactory::createResponseModelTransformer($serializer);
self::assertInstanceOf(ResponseTransformerInterface::class, $transformer);
self::assertInstanceOf(ResponseModelTransformer::class, $transformer);
Expand Down

0 comments on commit 506f67e

Please sign in to comment.