Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,13 @@
"require": {
"php": "~8.4.0 || ~8.5.0",
"ext-json": "*",
"cardinalby/content-disposition": "^1.1",
"league/uri": "^7.3",
"php-http/client-common": "^2.7",
"php-http/discovery": "^1.19",
"php-http/httplug": "^2.4",
"php-http/logger-plugin": "^1.3",
"php-http/message": "^1.16 || ^2.0",
"php-standard-library/foundation": "^6.1",
"php-standard-library/fun": "^6.1",
"php-standard-library/hash": "^6.1",
Expand All @@ -25,13 +32,7 @@
"php-standard-library/regex": "^6.1",
"php-standard-library/result": "^6.1",
"php-standard-library/type": "^6.1",
"cardinalby/content-disposition": "^1.1",
"league/uri": "^7.3",
"php-http/client-common": "^2.7",
"php-http/discovery": "^1.19",
"php-http/httplug": "^2.4",
"php-http/logger-plugin": "^1.3",
"php-http/message": "^1.16 || ^2.0",
"phpro/resource-stream": "^1.3",
"psr/http-client-implementation": "^1.0",
"psr/http-factory": "^1.0",
"psr/http-factory-implementation": "^1.0",
Expand Down
2 changes: 2 additions & 0 deletions docs/transports.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ This package contains some frequently used encoders / decoders for you:
| `StreamDecoder` | `DecoderInterface<StreamInterface>` | Returns the PSR-7 Stream as response result |
| `RawEncoder` | `EncoderInterface<string>` | Adds raw string as request body |
| `RawDecoder` | `DecoderInterface<string>` | Returns the raw PSR-7 body string as response result |
| `ResourceStreamEncoder` | `EncoderInterface<ResourceStream>` | Adds `phpro/resource-stream` as request body |
| `ResourceStreamDecoder` | `DecoderInterface<ResourceStream>` | Returns `phpro/resource-stream` from response body |
| `ResponseDecoder` | `DecoderInterface<ResponseInterface>` | Returns the received PSR-7 response as result |

## Built-in transport presets:
Expand Down
26 changes: 26 additions & 0 deletions src/Encoding/ResourceStream/ResourceStreamDecoder.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?php

declare(strict_types=1);

namespace Phpro\HttpTools\Encoding\ResourceStream;

use Phpro\HttpTools\Encoding\DecoderInterface;
use Phpro\ResourceStream\Factory\Psr7Stream;
use Phpro\ResourceStream\ResourceStream;
use Psr\Http\Message\ResponseInterface;

/**
* @implements DecoderInterface<ResourceStream<resource>>
*/
final class ResourceStreamDecoder implements DecoderInterface
{
public static function createWithAutodiscoveredPsrFactories(): self
{
return new self();
}

public function __invoke(ResponseInterface $response): ResourceStream
{
return Psr7Stream::createFromResponse($response);
}
}
36 changes: 36 additions & 0 deletions src/Encoding/ResourceStream/ResourceStreamEncoder.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<?php

declare(strict_types=1);

namespace Phpro\HttpTools\Encoding\ResourceStream;

use Http\Discovery\Psr17FactoryDiscovery;
use Phpro\HttpTools\Encoding\EncoderInterface;
use Phpro\ResourceStream\ResourceStream;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\StreamFactoryInterface;

/**
* @implements EncoderInterface<ResourceStream<resource>>
*/
final class ResourceStreamEncoder implements EncoderInterface
{
public function __construct(
private StreamFactoryInterface $streamFactory,
) {
}

public static function createWithAutodiscoveredPsrFactories(): self
{
return new self(
Psr17FactoryDiscovery::findStreamFactory(),
);
}

public function __invoke(RequestInterface $request, $data): RequestInterface
{
return $request->withBody(
$this->streamFactory->createStreamFromResource($data->unwrap()),
);
}
}
29 changes: 29 additions & 0 deletions tests/Unit/Encoding/ResourceStream/ResourceStreamDecoderTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?php

declare(strict_types=1);

namespace Phpro\HttpTools\Tests\Unit\Encoding\ResourceStream;

use Phpro\HttpTools\Encoding\ResourceStream\ResourceStreamDecoder;
use Phpro\HttpTools\Test\UseHttpFactories;
use Phpro\ResourceStream\ResourceStream;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\TestCase;

final class ResourceStreamDecoderTest extends TestCase
{
use UseHttpFactories;

#[Test]
public function it_can_decode_response_to_resource_stream(): void
{
$decoder = ResourceStreamDecoder::createWithAutodiscoveredPsrFactories();
$response = $this->createResponse()
->withBody($this->createStream($content = '{"hello": "world"}'));

$decoded = $decoder($response);

self::assertInstanceOf(ResourceStream::class, $decoded);
self::assertSame($content, $decoded->getContents());
}
}
48 changes: 48 additions & 0 deletions tests/Unit/Encoding/ResourceStream/ResourceStreamEncoderTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<?php

declare(strict_types=1);

namespace Phpro\HttpTools\Tests\Unit\Encoding\ResourceStream;

use Phpro\HttpTools\Encoding\ResourceStream\ResourceStreamEncoder;
use Phpro\HttpTools\Test\UseHttpFactories;
use Phpro\ResourceStream\Factory\MemoryStream;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\TestCase;

final class ResourceStreamEncoderTest extends TestCase
{
use UseHttpFactories;

#[Test]
public function it_can_encode_resource_stream(): void
{
$resourceStream = MemoryStream::create();
$resourceStream->write($content = 'Hello world');
$resourceStream->rewind();

$encoder = ResourceStreamEncoder::createWithAutodiscoveredPsrFactories();
$request = $this->createRequest('POST', '/hello');

$actual = $encoder($request, $resourceStream);

self::assertSame($request->getMethod(), $actual->getMethod());
self::assertSame($request->getUri(), $actual->getUri());
self::assertSame($content, (string) $actual->getBody());
self::assertFalse($actual->hasHeader('Content-Type'));
}

#[Test]
public function it_can_encode_resource_stream_without_rewinding(): void
{
$resourceStream = MemoryStream::create();
$resourceStream->write($content = 'Hello world');

$encoder = ResourceStreamEncoder::createWithAutodiscoveredPsrFactories();
$request = $this->createRequest('POST', '/hello');

$actual = $encoder($request, $resourceStream);

self::assertSame($content, (string) $actual->getBody());
}
}
Loading