[Notifier] [Esendex] [BC BREAK] Change constructor signature

OskarStark · OskarStark · commit 767e498686f9 · 2020-12-21T13:41:27.000+01:00
| Q | A | ------------- | --- | Branch? | 5.x, but BC BREAK for experimental bridge | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | --- | License | MIT | Doc PR | --- Based on symfony#39428 (comment) * [ ] Update recipe * [ ] Update documentation cc @odolbeau as you provided the bridge
diff --git a/src/Symfony/Component/Notifier/Bridge/Esendex/CHANGELOG.md b/src/Symfony/Component/Notifier/Bridge/Esendex/CHANGELOG.md
@@ -1,6 +1,14 @@
 CHANGELOG
 =========
 
+5.3.0
+-----
+
+* [BC BREAK] Changed signature of `EsendexTransport::__construct()` method from:
+  `public function __construct(string $token, string $accountReference, string $from, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null)`
+  to:
+  `public function __construct(string $email, string $password, string $accountReference, string $from, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null)`
+
 5.2.0
 -----
 
diff --git a/src/Symfony/Component/Notifier/Bridge/Esendex/EsendexTransport.php b/src/Symfony/Component/Notifier/Bridge/Esendex/EsendexTransport.php
@@ -29,13 +29,15 @@ final class EsendexTransport extends AbstractTransport
 {
     protected const HOST = 'api.esendex.com';
 
-    private $token;
+    private $email;
+    private $password;
     private $accountReference;
     private $from;
 
-    public function __construct(string $token, string $accountReference, string $from, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null)
+    public function __construct(string $email, string $password, string $accountReference, string $from, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null)
     {
-        $this->token = $token;
+        $this->email = $email;
+        $this->password = $password;
         $this->accountReference = $accountReference;
         $this->from = $from;
 
@@ -44,7 +46,7 @@ public function __construct(string $token, string $accountReference, string $fro
 
     public function __toString(): string
     {
-        return sprintf('esendex://%s', $this->getEndpoint());
+        return sprintf('esendex://%s?accountreference=%s&from=%s', $this->getEndpoint(), $this->accountReference, $this->from);
     }
 
     public function supports(MessageInterface $message): bool
@@ -68,18 +70,20 @@ protected function doSend(MessageInterface $message): SentMessage
         }
 
         $response = $this->client->request('POST', 'https://'.$this->getEndpoint().'/v1.0/messagedispatcher', [
-            'auth_basic' => $this->token,
+            'auth_basic' => sprintf('%s:%s', $this->email, $this->password),
             'json' => [
                 'accountreference' => $this->accountReference,
                 'messages' => [$messageData],
             ],
         ]);
 
-        if (200 === $response->getStatusCode()) {
+        $statusCode = $response->getStatusCode();
+
+        if (200 === $statusCode) {
             return new SentMessage($message, (string) $this);
         }
 
-        $message = sprintf('Unable to send the SMS: error %d.', $response->getStatusCode());
+        $message = sprintf('Unable to send the SMS: error %d.', $statusCode);
 
         try {
             $result = $response->toArray(false);
diff --git a/src/Symfony/Component/Notifier/Bridge/Esendex/EsendexTransportFactory.php b/src/Symfony/Component/Notifier/Bridge/Esendex/EsendexTransportFactory.php
@@ -33,7 +33,8 @@ public function create(Dsn $dsn): TransportInterface
             throw new UnsupportedSchemeException($dsn, 'esendex', $this->getSupportedSchemes());
         }
 
-        $token = $this->getUser($dsn).':'.$this->getPassword($dsn);
+        $email = $this->getUser($dsn);
+        $password = $this->getPassword($dsn);
         $accountReference = $dsn->getOption('accountreference');
 
         if (!$accountReference) {
@@ -49,7 +50,7 @@ public function create(Dsn $dsn): TransportInterface
         $host = 'default' === $dsn->getHost() ? null : $dsn->getHost();
         $port = $dsn->getPort();
 
-        return (new EsendexTransport($token, $accountReference, $from, $this->client, $this->dispatcher))->setHost($host)->setPort($port);
+        return (new EsendexTransport($email, $password, $accountReference, $from, $this->client, $this->dispatcher))->setHost($host)->setPort($port);
     }
 
     protected function getSupportedSchemes(): array
diff --git a/src/Symfony/Component/Notifier/Bridge/Esendex/Tests/EsendexTransportFactoryTest.php b/src/Symfony/Component/Notifier/Bridge/Esendex/Tests/EsendexTransportFactoryTest.php
@@ -25,7 +25,25 @@ public function testCreateWithDsn()
 
         $transport = $factory->create(Dsn::fromString('esendex://email:password@host.test?accountreference=testAccountreference&from=testFrom'));
 
-        $this->assertSame('esendex://host.test', (string) $transport);
+        $this->assertSame('esendex://host.test?accountreference=testAccountreference&from=testFrom', (string) $transport);
+    }
+
+    public function testCreateWithMissingEmailThrowsIncompleteDsnException()
+    {
+        $factory = $this->createFactory();
+
+        $this->expectException(IncompleteDsnException::class);
+
+        $factory->create(Dsn::fromString('esendex://:password@host?accountreference=testAccountreference&from=FROM'));
+    }
+
+    public function testCreateWithMissingPasswordThrowsIncompleteDsnException()
+    {
+        $factory = $this->createFactory();
+
+        $this->expectException(IncompleteDsnException::class);
+
+        $factory->create(Dsn::fromString('esendex://email:@host?accountreference=testAccountreference&from=FROM'));
     }
 
     public function testCreateWithMissingOptionAccountreferenceThrowsIncompleteDsnException()
diff --git a/src/Symfony/Component/Notifier/Bridge/Esendex/Tests/EsendexTransportTest.php b/src/Symfony/Component/Notifier/Bridge/Esendex/Tests/EsendexTransportTest.php
@@ -27,7 +27,7 @@ public function testToString()
     {
         $transport = $this->createTransport();
 
-        $this->assertSame('esendex://host.test', (string) $transport);
+        $this->assertSame('esendex://host.test?accountreference=testAccountReference&from=testFrom', (string) $transport);
     }
 
     public function testSupportsSmsMessage()

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,8 @@ public function create(Dsn $dsn): TransportInterface`
`33`	`33`	`throw new UnsupportedSchemeException($dsn, 'esendex', $this->getSupportedSchemes());`
`34`	`34`	`}`
`35`	`35`
`36`		`- $token = $this->getUser($dsn).':'.$this->getPassword($dsn);`
	`36`	`+ $email = $this->getUser($dsn);`
	`37`	`+ $password = $this->getPassword($dsn);`
`37`	`38`	`$accountReference = $dsn->getOption('accountreference');`
`38`	`39`
`39`	`40`	`if (!$accountReference) {`
`@@ -49,7 +50,7 @@ public function create(Dsn $dsn): TransportInterface`
`49`	`50`	`$host = 'default' === $dsn->getHost() ? null : $dsn->getHost();`
`50`	`51`	`$port = $dsn->getPort();`
`51`	`52`
`52`		`- return (new EsendexTransport($token, $accountReference, $from, $this->client, $this->dispatcher))->setHost($host)->setPort($port);`
	`53`	`+ return (new EsendexTransport($email, $password, $accountReference, $from, $this->client, $this->dispatcher))->setHost($host)->setPort($port);`
`53`	`54`	`}`
`54`	`55`
`55`	`56`	`protected function getSupportedSchemes(): array`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ public function testToString()`
`27`	`27`	`{`
`28`	`28`	`$transport = $this->createTransport();`
`29`	`29`
`30`		`- $this->assertSame('esendex://host.test', (string) $transport);`
	`30`	`+ $this->assertSame('esendex://host.test?accountreference=testAccountReference&from=testFrom', (string) $transport);`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`public function testSupportsSmsMessage()`