Rename namespaces

Author: veewee

.gitignore

@@ -1,3 +1,4 @@
 composer.lock
 vendor
 .php-cs-fixer.cache
+.phpunit.cache

README.md

@@ -28,9 +28,9 @@ This middleware is used to add attachments to your SOAP request:
 ```php
 use Http\Client\Common\PluginClient;
 use Soap\Psr18Transport\Psr18Transport;
-use Soap\Psr18AttachmentMiddleware\Middleware\AttachmentsMiddleware;
-use Soap\Psr18AttachmentMiddleware\Multipart\AttachmentType;
-use Soap\Psr18AttachmentMiddleware\Storage\AttachmentStorage;
+use Soap\Psr18AttachmentsMiddleware\Middleware\AttachmentsMiddleware;
+use Soap\Psr18AttachmentsMiddleware\Multipart\AttachmentType;
+use Soap\Psr18AttachmentsMiddleware\Storage\AttachmentStorage;
 
 // You should store this attachment storage in a central place in your application e.g. inside a service container.
 // It is used to store the attachments that are being sent and received.
@@ -54,8 +54,8 @@ Adding attachments to your request is done by using the `AttachmentsStorage` bef
 use Http\Client\Common\PluginClient;
 use Phpro\ResourceStream\Factory\FileStream;
 use Soap\Psr18Transport\Psr18Transport;
-use Soap\Psr18AttachmentMiddleware\Attachment\Attachment;
-use Soap\Psr18AttachmentMiddleware\Storage\AttachmentStorage;
+use Soap\Psr18AttachmentsMiddleware\Attachment\Attachment;
+use Soap\Psr18AttachmentsMiddleware\Storage\AttachmentStorage;
 
 // You should store this attachment storage in a central place in your application.
 // It is used to store the attachments that are being sent and received.
@@ -78,8 +78,8 @@ Receiving attachments is done by using the `AttachmentsStorage` after receiving
 use Http\Client\Common\PluginClient;
 use Phpro\ResourceStream\Factory\FileStream;
 use Soap\Psr18Transport\Psr18Transport;
-use Soap\Psr18AttachmentMiddleware\Attachment\Attachment;
-use Soap\Psr18AttachmentMiddleware\Storage\AttachmentStorage;
+use Soap\Psr18AttachmentsMiddleware\Attachment\Attachment;
+use Soap\Psr18AttachmentsMiddleware\Storage\AttachmentStorage;
 
 // You should store this attachment storage in a central place in your application.
 // It is used to store the attachments that are being sent and received.
@@ -106,7 +106,7 @@ composer require php-soap/encoder
 
 ```php
 use Soap\Encoding\EncoderRegistry;
-use Soap\Psr18AttachmentMiddleware\Encoding\Xop\XopIncludeEncoder
+use Soap\Psr18AttachmentsMiddleware\Encoding\Xop\XopIncludeEncoder
 
 // You should store this attachment storage in a central place in your application.
 // It is used to store the attachments that are being sent and received.
@@ -120,7 +120,7 @@ This will allow you to use attachments directly from within your SOAP request an
 
 ```php
 use Phpro\ResourceStream\Factory\FileStream;
-use Soap\Psr18AttachmentMiddleware\Attachment\Attachment;
+use Soap\Psr18AttachmentsMiddleware\Attachment\Attachment;
 
 // Your request can now contain Attachments directly:
 // These attachments will be automatically added to the AttachmentStorageInterface and a <xop:Include> element will be added to your request instead.

composer.json

@@ -8,6 +8,11 @@
             "Soap\\Psr18AttachmentsMiddleware\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "SoapTest\\Psr18AttachmentsMiddleware\\": "tests/"
+        }
+    },
     "authors": [
         {
             "name": "Toon Verwerft",
@@ -27,7 +32,8 @@
         "nyholm/psr7": "^1.8",
         "php-soap/encoding": "^0.16.0",
         "vimeo/psalm": "^5.26",
-        "php-standard-library/psalm-plugin": "^2.3"
+        "php-standard-library/psalm-plugin": "^2.3",
+        "phpunit/phpunit": "^10.5.40"
     },
     "config": {
         "allow-plugins": {

phpunit.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheDirectory=".phpunit.cache"
+         executionOrder="depends,defects"
+         requireCoverageMetadata="false"
+         beStrictAboutCoverageMetadata="false"
+         beStrictAboutOutputDuringTests="true"
+         displayDetailsOnTestsThatTriggerDeprecations="true"
+         failOnRisky="true"
+         failOnWarning="true">
+    <testsuites>
+        <testsuite name="unit">
+            <directory>tests/Unit</directory>
+        </testsuite>
+    </testsuites>
+
+    <source restrictDeprecations="true" restrictNotices="true" restrictWarnings="true">
+        <include>
+            <directory>src</directory>
+        </include>
+    </source>
+</phpunit>

src/Attachment/Attachment.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Soap\Psr18AttachmentMiddleware\Attachment;
+namespace Soap\Psr18AttachmentsMiddleware\Attachment;
 
 use Http\Message\MultipartStream\ApacheMimetypeHelper;
 use Phpro\ResourceStream\ResourceStream;

src/Attachment/AttachmentsCollection.php

@@ -1,10 +1,10 @@
 <?php declare(strict_types=1);
 
-namespace Soap\Psr18AttachmentMiddleware\Attachment;
+namespace Soap\Psr18AttachmentsMiddleware\Attachment;
 
 use Countable;
 use IteratorAggregate;
-use Soap\Psr18AttachmentMiddleware\Exception\AttachmentNotFoundException;
+use Soap\Psr18AttachmentsMiddleware\Exception\AttachmentNotFoundException;
 
 /**
  * @template-implements \IteratorAggregate<int, Attachment>

src/Attachment/IdGenerator.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Soap\Psr18AttachmentMiddleware\Attachment;
+namespace Soap\Psr18AttachmentsMiddleware\Attachment;
 
 use function Psl\SecureRandom\string;
 

src/Encoding/Xop/XopIncludeEncoder.php

@@ -1,12 +1,12 @@
 <?php declare(strict_types=1);
 
-namespace Soap\Psr18AttachmentMiddleware\Encoding\Xop;
+namespace Soap\Psr18AttachmentsMiddleware\Encoding\Xop;
 
 use Soap\Encoding\Encoder\Context;
 use Soap\Encoding\Encoder\XmlEncoder;
 use Soap\Encoding\Xml\Node\Element;
-use Soap\Psr18AttachmentMiddleware\Attachment\Attachment;
-use Soap\Psr18AttachmentMiddleware\Storage\AttachmentStorageInterface;
+use Soap\Psr18AttachmentsMiddleware\Attachment\Attachment;
+use Soap\Psr18AttachmentsMiddleware\Storage\AttachmentStorageInterface;
 use VeeWee\Reflecta\Iso\Iso;
 use VeeWee\Xml\Writer\Writer;
 use function VeeWee\Xml\Writer\Builder\attribute;

src/Exception/AttachmentNotFoundException.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Soap\Psr18AttachmentMiddleware\Exception;
+namespace Soap\Psr18AttachmentsMiddleware\Exception;
 
 use Soap\Engine\Exception\RuntimeException;
 

src/Exception/SoapMessageNotFoundException.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Soap\Psr18AttachmentMiddleware\Exception;
+namespace Soap\Psr18AttachmentsMiddleware\Exception;
 
 use Soap\Engine\Exception\RuntimeException;
 

src/Middleware/AttachmentsMiddleware.php

@@ -1,17 +1,17 @@
 <?php declare(strict_types=1);
 
-namespace Soap\Psr18AttachmentMiddleware\Middleware;
+namespace Soap\Psr18AttachmentsMiddleware\Middleware;
 
 use Http\Client\Common\Plugin;
 use Http\Promise\Promise;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
-use Soap\Psr18AttachmentMiddleware\Multipart\AttachmentType;
-use Soap\Psr18AttachmentMiddleware\Multipart\RequestBuilder;
-use Soap\Psr18AttachmentMiddleware\Multipart\RequestBuilderInterface;
-use Soap\Psr18AttachmentMiddleware\Multipart\ResponseBuilder;
-use Soap\Psr18AttachmentMiddleware\Multipart\ResponseBuilderInterface;
-use Soap\Psr18AttachmentMiddleware\Storage\AttachmentStorageInterface;
+use Soap\Psr18AttachmentsMiddleware\Multipart\AttachmentType;
+use Soap\Psr18AttachmentsMiddleware\Multipart\RequestBuilder;
+use Soap\Psr18AttachmentsMiddleware\Multipart\RequestBuilderInterface;
+use Soap\Psr18AttachmentsMiddleware\Multipart\ResponseBuilder;
+use Soap\Psr18AttachmentsMiddleware\Multipart\ResponseBuilderInterface;
+use Soap\Psr18AttachmentsMiddleware\Storage\AttachmentStorageInterface;
 
 final readonly class AttachmentsMiddleware implements Plugin
 {

src/Multipart/AttachmentType.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Soap\Psr18AttachmentMiddleware\Multipart;
+namespace Soap\Psr18AttachmentsMiddleware\Multipart;
 
 enum AttachmentType : string
 {

src/Multipart/RequestBuilder.php

@@ -1,14 +1,14 @@
 <?php declare(strict_types=1);
 
-namespace Soap\Psr18AttachmentMiddleware\Multipart;
+namespace Soap\Psr18AttachmentsMiddleware\Multipart;
 
 use Http\Discovery\Psr17FactoryDiscovery;
 use Http\Message\MultipartStream\MultipartStreamBuilder;
 use Psr\Http\Message\RequestFactoryInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\StreamFactoryInterface;
-use Soap\Psr18AttachmentMiddleware\Attachment\Attachment;
-use Soap\Psr18AttachmentMiddleware\Storage\AttachmentStorageInterface;
+use Soap\Psr18AttachmentsMiddleware\Attachment\Attachment;
+use Soap\Psr18AttachmentsMiddleware\Storage\AttachmentStorageInterface;
 
 final readonly class RequestBuilder implements RequestBuilderInterface
 {
@@ -39,7 +39,7 @@ public function __invoke(
         $builder = new MultipartStreamBuilder($this->streamFactory);
 
         $builder->addData($request->getBody(), [
-            'Content-Type' => match ($transportType) {
+            'Content-Type' => match ($attachmentType) {
                 AttachmentType::Swa => 'text/xml; charset=UTF-8',
                 AttachmentType::Mtom => 'application/xop+xml; charset=UTF-8; type=application/soap+xml',
             },
@@ -68,15 +68,15 @@ public function __invoke(
                 $request->getMethod(),
                 $request->getUri(),
             )
-            ->withAddedHeader('Content-Type', match($transportType) {
+            ->withAddedHeader('Content-Type', match($attachmentType) {
                 AttachmentType::Swa => 'multipart/related; type="text/xml"; boundary="' . $boundary. '"; start="soaprequest"',
                 AttachmentType::Mtom => 'multipart/related; type="application/xop+xml"; boundary="' . $boundary . '"; start="soaprequest"; start-info="application/soap+xml"',
             })
             ->withBody(
                 $builder->build()
             );
 
-        if ($transportType === AttachmentType::Swa) {
+        if ($attachmentType === AttachmentType::Swa) {
             $multipartRequest = $multipartRequest->withAddedHeader('SoapAction', $request->getHeaderLine('SoapAction'));
         }
 

src/Multipart/RequestBuilderInterface.php

@@ -1,9 +1,9 @@
 <?php declare(strict_types=1);
 
-namespace Soap\Psr18AttachmentMiddleware\Multipart;
+namespace Soap\Psr18AttachmentsMiddleware\Multipart;
 
 use Psr\Http\Message\RequestInterface;
-use Soap\Psr18AttachmentMiddleware\Storage\AttachmentStorageInterface;
+use Soap\Psr18AttachmentsMiddleware\Storage\AttachmentStorageInterface;
 
 interface RequestBuilderInterface
 {

src/Multipart/ResponseBuilder.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Soap\Psr18AttachmentMiddleware\Multipart;
+namespace Soap\Psr18AttachmentsMiddleware\Multipart;
 
 use Http\Discovery\Psr17FactoryDiscovery;
 use Phpro\ResourceStream\Factory\TmpStream;
@@ -9,10 +9,10 @@
 use Psr\Http\Message\StreamFactoryInterface;
 use Riverline\MultiPartParser\Converters\PSR7;
 use Riverline\MultiPartParser\StreamedPart;
-use Soap\Psr18AttachmentMiddleware\Attachment\Attachment;
-use Soap\Psr18AttachmentMiddleware\Attachment\IdGenerator;
-use Soap\Psr18AttachmentMiddleware\Exception\SoapMessageNotFoundException;
-use Soap\Psr18AttachmentMiddleware\Storage\AttachmentStorageInterface;
+use Soap\Psr18AttachmentsMiddleware\Attachment\Attachment;
+use Soap\Psr18AttachmentsMiddleware\Attachment\IdGenerator;
+use Soap\Psr18AttachmentsMiddleware\Exception\SoapMessageNotFoundException;
+use Soap\Psr18AttachmentsMiddleware\Storage\AttachmentStorageInterface;
 use function Psl\Type\string;
 
 final readonly class ResponseBuilder implements ResponseBuilderInterface

src/Multipart/ResponseBuilderInterface.php

@@ -1,9 +1,9 @@
 <?php declare(strict_types=1);
 
-namespace Soap\Psr18AttachmentMiddleware\Multipart;
+namespace Soap\Psr18AttachmentsMiddleware\Multipart;
 
 use Psr\Http\Message\ResponseInterface;
-use Soap\Psr18AttachmentMiddleware\Storage\AttachmentStorageInterface;
+use Soap\Psr18AttachmentsMiddleware\Storage\AttachmentStorageInterface;
 
 interface ResponseBuilderInterface
 {

src/Storage/AttachmentStorage.php

@@ -1,8 +1,8 @@
 <?php declare(strict_types=1);
 
-namespace Soap\Psr18AttachmentMiddleware\Storage;
+namespace Soap\Psr18AttachmentsMiddleware\Storage;
 
-use Soap\Psr18AttachmentMiddleware\Attachment\AttachmentsCollection;
+use Soap\Psr18AttachmentsMiddleware\Attachment\AttachmentsCollection;
 
 final class AttachmentStorage implements AttachmentStorageInterface
 {

src/Storage/AttachmentStorageInterface.php

@@ -1,8 +1,8 @@
 <?php declare(strict_types=1);
 
-namespace Soap\Psr18AttachmentMiddleware\Storage;
+namespace Soap\Psr18AttachmentsMiddleware\Storage;
 
-use Soap\Psr18AttachmentMiddleware\Attachment\AttachmentsCollection;
+use Soap\Psr18AttachmentsMiddleware\Attachment\AttachmentsCollection;
 
 interface AttachmentStorageInterface
 {

tests/.gitignore

@@ -0,0 +1,41 @@
+<?php declare(strict_types=1);
+
+namespace SoapTest\Psr18AttachmentsMiddleware\Unit\Attachment;
+
+use Phpro\ResourceStream\Factory\MemoryStream;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Soap\Psr18AttachmentsMiddleware\Attachment\Attachment;
+
+final class AttachmentTest extends TestCase
+{
+    #[Test]
+    public function it_can_load_attachment(): void
+    {
+        $attachment = new Attachment(
+            'id',
+            'filename',
+            'mimeType',
+            $stream = MemoryStream::create()
+        );
+
+        static::assertSame('id', $attachment->id);
+        static::assertSame('filename', $attachment->filename);
+        static::assertSame('mimeType', $attachment->mimeType);
+        static::assertSame($stream, $attachment->content);
+    }
+
+    #[Test]
+    public function it_can_create_an_attachment(): void
+    {
+        $attachment = Attachment::create(
+            'filename.pdf',
+            $stream = MemoryStream::create(),
+        );
+
+        static::assertNotEmpty($attachment->id);
+        static::assertSame('filename.pdf', $attachment->filename);
+        static::assertSame('application/pdf', $attachment->mimeType);
+        static::assertSame($stream, $attachment->content);
+    }
+}