Switch to generic HTTP client

Using the Laravel Http facade limits us to Laravel 7+. Since we want to support Laravel 6, we'll use the generic Http client solution for now since it should work in all releases.

Add Laravel 6 to GitHub workflow matrix

Also update documentation to include developer notes.

Author: tepeds

.github/workflows/run-tests.yml

@@ -9,8 +9,10 @@ jobs:
         strategy:
             matrix:
                 php: [7.4, 7.3]
-                laravel: [8.*]
+                laravel: [6.*, 8.*]
                 include:
+                    - laravel: 6.*
+                      testbench: 4.*
                     - laravel: 8.*
                       testbench: 6.*
 

.gitignore

@@ -4,3 +4,4 @@
 .idea
 .php_cs.cache
 .phpunit.result.cache
+composer.lock

README.md

@@ -1,4 +1,4 @@
-# Introduction
+# Laravel SNS Handler
 This package provides an easy way of adding AWS SNS message handling to your Laravel application as a REST endpoint. The package can automatically confirm subscription requests and dispatches events when a message is received.
 
 ## How to create an SNS topic
@@ -75,3 +75,14 @@ This package adds a route to your application for incoming SNS requests. Note th
 
 **Note: You will only be able to subscribe your endpoint if it can be reached from the AWS SNS service**
 
+## Development
+This package is expected to work with supported versions of Laravel, including LTS releases. During development, you should be sure to run tests and validate expected behaviors under different releases. Since we use the `orchestra/testbench` package, you can easily switch between installed Laravel framework releases using `composer`:
+
+```bash
+# Laravel 6
+composer require --dev orchestra/testbench:^4.0 -W
+# Laravel 8
+composer require --dev orchestra/testbench:^6.0 -W
+```
+
+New releases of Laravel should be added to the GitHub workflow matrix in `.github/workflows/run-tests.yml`.

composer.json

@@ -16,12 +16,16 @@
     "require": {
         "php": ">=7.3",
       	"ext-json": "*",
-        "aws/aws-php-sns-message-validator": "^1.6"
+        "aws/aws-php-sns-message-validator": "^1.6",
+        "php-http/discovery": "^1.14",
+        "psr/http-factory": "^1.0",
+        "psr/http-client": "^1.0"
     },
     "require-dev" : {
         "roave/security-advisories": "dev-latest",
-        "guzzlehttp/guzzle": "^7.2",
-        "orchestra/testbench": "^6.0"
+        "orchestra/testbench": "^6.0",
+        "http-interop/http-factory-guzzle": "^1.2",
+        "php-http/guzzle6-adapter": "^2.0"
     },
     "autoload": {
         "psr-4": {

src/Listeners/SnsConfirmationRequestListener.php

@@ -3,39 +3,67 @@
 
 namespace Nipwaayoni\SnsHandler\Listeners;
 
-use Illuminate\Support\Facades\Http;
+use Http\Discovery\HttpClientDiscovery;
+use Http\Discovery\Psr17FactoryDiscovery;
 use Illuminate\Support\Facades\Log;
 use Nipwaayoni\SnsHandler\Events\SnsConfirmationRequestReceived;
 use Nipwaayoni\SnsHandler\SnsConfirmSubscriptionException;
 use Nipwaayoni\SnsHandler\SnsException;
+use Nipwaayoni\SnsHandler\SnsMessage;
+use Psr\Http\Client\ClientExceptionInterface;
+use Psr\Http\Client\ClientInterface;
+use Psr\Http\Message\RequestFactoryInterface;
+use Psr\Http\Message\ResponseInterface;
 
 class SnsConfirmationRequestListener
 {
+    /**
+     * @var ClientInterface
+     */
+    private $client;
+
+    /**
+     * @var RequestFactoryInterface
+     */
+    private $requestFactory;
+
+    /**
+     * @param ClientInterface|null $client
+     * @param RequestFactoryInterface|null $requestFactory
+     */
+    public function __construct(
+        ClientInterface $client = null,
+        RequestFactoryInterface $requestFactory = null
+    ) {
+        $this->client = $client ?? HttpClientDiscovery::find();
+        $this->requestFactory = $requestFactory ?? Psr17FactoryDiscovery::findRequestFactory();
+    }
+
     public function handle(SnsConfirmationRequestReceived $event)
     {
         $message = $event->message();
-        //TODO Make this work with Laravel 6, as the Http facade was introduced in Laravel 7
+
         $response = $this->getResponse($message);
-        if ($response->successful()) {
-            $info = sprintf('Subscription confirmation for %s succeeded with status %s', $message->topicArn(), $response->status());
-            Log::info($info);
-            return;
-        }
-        $error = sprintf('Subscription confirmation for %s failed with status %s', $message->topicArn(), $response->status());
-        Log::error($error);
-        throw new SnsConfirmSubscriptionException($error);
+
+        Log::info(sprintf('Subscription confirmation for %s succeeded with status %s', $message->topicArn(), $response->getStatusCode()));
     }
 
     /**
-     * @param \Nipwaayoni\SnsHandler\SnsMessage $message
-     * @return \Illuminate\Http\Client\Response
-     * @throws \Nipwaayoni\SnsHandler\SnsException
+     * @param SnsMessage $message
+     * @return ResponseInterface
+     * @throws SnsConfirmSubscriptionException
+     * @throws SnsException
      */
-    private function getResponse(\Nipwaayoni\SnsHandler\SnsMessage $message): \Illuminate\Http\Client\Response
+    private function getResponse(SnsMessage $message): ResponseInterface
     {
-        if (class_exists(Http::class)) {
-            return Http::get($message->subscribeUrl());
+        try {
+            return $this->client->sendRequest(
+                $this->requestFactory->createRequest('GET', $message->subscribeUrl())
+            );
+        } catch (ClientExceptionInterface $e) {
+            throw new SnsConfirmSubscriptionException(
+                sprintf('Subscription confirmation for %s failed with status %s', $message->topicArn(), $e->getCode())
+            );
         }
-        throw new SnsException("Unable to determine HTTP method");
     }
 }

tests/HttpTransaction.php

@@ -0,0 +1,30 @@
+<?php
+
+
+namespace Nipwaayoni\Tests\SnsHandler;
+
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+class HttpTransaction
+{
+    /**
+     * @var array
+     */
+    private $transaction;
+
+    public function __construct(array $transaction)
+    {
+        $this->transaction = $transaction;
+    }
+
+    public function request(): RequestInterface
+    {
+        return $this->transaction['request'];
+    }
+
+    public function response(): ResponseInterface
+    {
+        return $this->transaction['response'];
+    }
+}

tests/HttpTransactionContainer.php

@@ -0,0 +1,45 @@
+<?php
+
+
+namespace Nipwaayoni\Tests\SnsHandler;
+
+class HttpTransactionContainer implements \ArrayAccess, \Countable
+{
+    /**
+     * @var array
+     */
+    private $container = [];
+
+    public function offsetExists($offset): bool
+    {
+        return isset($this->container[$offset]);
+    }
+
+    public function offsetGet($offset): HttpTransaction
+    {
+        if (!isset($this->container[$offset])) {
+            throw new \Exception('Undefined transaction offset');
+        }
+
+        return new HttpTransaction($this->container[$offset]);
+    }
+
+    public function offsetSet($offset, $value): void
+    {
+        if (is_null($offset)) {
+            $this->container[] = $value;
+        } else {
+            $this->container[$offset] = $value;
+        }
+    }
+
+    public function offsetUnset($offset): void
+    {
+        unset($this->container[$offset]);
+    }
+
+    public function count(): int
+    {
+        return count($this->container);
+    }
+}

tests/SnsHttpTestHelperTrait.php

@@ -3,27 +3,41 @@
 
 namespace Nipwaayoni\Tests\SnsHandler;
 
-use Illuminate\Http\Client\Request;
-use Illuminate\Support\Facades\Http;
-use Nipwaayoni\SnsHandler\SnsException;
+use GuzzleHttp\Handler\MockHandler;
+use GuzzleHttp\HandlerStack;
+use GuzzleHttp\Middleware;
+use GuzzleHttp\Psr7\Response;
+use Http\Client\HttpClient;
 
 trait SnsHttpTestHelperTrait
 {
-    public function httpExpects(array $content = null): void
+    /** @var HttpClient  */
+    private $client;
+
+    /** @var HttpTransactionContainer */
+    private $container;
+
+    public function httpExpects(Response ...$responses): void
     {
-        if (class_exists(Http::class)) {
-            Http::fake($content);
-            return;
-        }
-        throw new SnsException("Unable to determine HTTP method");
+        $this->container = new HttpTransactionContainer();
+
+        $history = Middleware::history($this->container);
+
+        $mock = new MockHandler($responses);
+
+        $handlerStack = HandlerStack::create($mock);
+        $handlerStack->push($history);
+
+        $client = new \GuzzleHttp\Client(['handler' => $handlerStack]);
+        $this->client = new \Http\Adapter\Guzzle6\Client($client);
     }
 
     public function httpAssertSent(callable $function): void
     {
-        if (class_exists(Http::class)) {
-            Http::assertSent($function);
-            return;
-        }
-        throw new SnsException("Unable to determine HTTP method");
+        $this->assertCount(1, $this->container);
+
+        $request = $this->container[0]->request();
+
+        $function($request);
     }
 }

tests/Unit/SnsConfirmationRequestListenerTest.php

@@ -4,9 +4,8 @@
 namespace Nipwaayoni\Tests\SnsHandler\Unit;
 
 use Aws\Sns\Message;
-use Illuminate\Http\Client\Request;
+use GuzzleHttp\Psr7\Response;
 use Illuminate\Support\Facades\Event;
-use Illuminate\Support\Facades\Http;
 use Illuminate\Support\Facades\Log;
 use Nipwaayoni\SnsHandler\Events\SnsConfirmationRequestReceived;
 use Nipwaayoni\SnsHandler\Listeners\SnsConfirmationRequestListener;
@@ -29,8 +28,6 @@ public function setUp(): void
         parent::setUp();
 
         Event::fake();
-
-        $this->listener = new SnsConfirmationRequestListener();
     }
 
     public function testThrowsExceptionIfConfirmSubscriptionFails(): void
@@ -40,36 +37,41 @@ public function testThrowsExceptionIfConfirmSubscriptionFails(): void
             'SubscribeURL' => 'https://aws.amazon.com/subscribe/123',
         ]));
 
-        $this->httpExpects([
-            'https://aws.amazon.com/subscribe/123' => Http::response([], 404, [])
-        ]);
+        $this->httpExpects(
+            new Response(404)
+        );
+
+        $this->listener = new SnsConfirmationRequestListener($this->client);
 
         $event = new SnsConfirmationRequestReceived(new SnsMessage($message));
 
         $this->expectException(SnsConfirmSubscriptionException::class);
         $this->expectExceptionMessage('Subscription confirmation for arn:aws:sns:us-west-2:123456789012:MyTopic failed with status 404');
-        Log::shouldReceive('error')->once();
 
         $this->listener->handle($event);
     }
 
     public function testConfirmsSubscriptionUsingSubscribeUrl(): void
     {
-        $this->httpExpects(['https://aws.amazon.com/subscribe/123' => Http::response([], 200, [])]);
+        $this->httpExpects(
+            new Response(200)
+        );
 
         $message = Message::fromJsonString($this->makeSnsMessageJson([
             'Type' => SnsMessage::SUBSCRIBE_TYPE,
             'SubscribeURL' => 'https://aws.amazon.com/subscribe/123',
         ]));
 
+        $this->listener = new SnsConfirmationRequestListener($this->client);
+
         $event = new SnsConfirmationRequestReceived(new SnsMessage($message));
 
         Log::shouldReceive('info')->once();
 
         $this->listener->handle($event);
 
-        $this->httpAssertSent(function (Request $request) {
-            return $request->url() === 'https://aws.amazon.com/subscribe/123';
+        $this->httpAssertSent(function (\Psr\Http\Message\RequestInterface $request) {
+            $this->assertEquals('https://aws.amazon.com/subscribe/123', $request->getUri());
         });
     }
 }