Add initial test case

Author: bryanadamloh97

LICENSE renamed to LICENSE.md

@@ -32,13 +32,21 @@
     },
     "require-dev": {
         "illuminate/routing": "^5.1 || ^6.0 || ^7.0",
-        "phpunit/phpunit": "^7.0"
+        "phpunit/phpunit": "^8.2"
     },
     "autoload": {
         "psr-4": {
             "CodeOfDigital\\LaravelUrlShortener\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "CodeOfDigital\\LaravelUrlShortener\\Tests\\": "tests/"
+        }
+    },
+    "scripts": {
+        "tests": "./vendor/bin/phpunit --colors=always"
+    },
     "extra": {
         "laravel": {
             "providers": [

composer.json

@@ -0,0 +1,19 @@
+<?php
+
+use GuzzleHttp\Psr7\Message;
+
+return Message::parseResponse(trim('
+HTTP/1.1 200 OK
+Server: nginx
+Date: Mon, 14 Jun 2021 16:55:09 GMT
+Content-Type: application/json
+Content-Length: 263
+Connection: keep-alive
+Strict-Transport-Security: max-age=31536000; includeSubDomains
+X-XSS-Protection: 1; mode=blockFilter
+X-Content-Type-Options: nosniff
+X-Frame-Options: DENY
+Content-Security-Policy: default-src \'none
+
+{"created_at":"2021-06-14T13:46:33+0000","id":"bit.ly/3iSAOvF","link":"https://bit.ly/3iSAOvF","custom_bitlinks":[],"long_url":"https://laravel.com/","archived":false,"tags":[],"deeplinks":[],"references":{"group":"https://api-ssl.bitly.com/v4/groups/Bl6a5s21gp1"}}
+'));

tests/Responses/bit_ly/http-200.php

@@ -0,0 +1,19 @@
+<?php
+
+use GuzzleHttp\Psr7\Message;
+
+return Message::parseResponse(trim('
+HTTP/1.1 403 Forbidden
+Server: nginx
+Date: Mon, 14 Jun 2021 16:55:09 GMT
+Content-Type: application/json
+Content-Length: 23
+Connection: keep-alive
+Strict-Transport-Security: max-age=31536000; includeSubDomains
+X-XSS-Protection: 1; mode=blockFilter
+X-Content-Type-Options: nosniff
+X-Frame-Options: DENY
+Content-Security-Policy: default-src \'none
+
+{"message":"FORBIDDEN"}
+'));

tests/Responses/bit_ly/http-403.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace CodeOfDigital\LaravelUrlShortener\Tests\Unit;
+
+use CodeOfDigital\LaravelUrlShortener\Drivers\BitLyDriverShortener;
+use CodeOfDigital\LaravelUrlShortener\Exceptions\InvalidApiTokenException;
+use CodeOfDigital\LaravelUrlShortener\Exceptions\ShortUrlException;
+
+class BitLyShortenerTest extends TestCase
+{
+    protected $shortener;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->shortener = new BitLyDriverShortener($this->client, 'API_TOKEN', false);
+    }
+
+    /**
+     * Test the URL Shortening through Bit.ly
+     *
+     * @throws \CodeOfDigital\LaravelUrlShortener\Exceptions\ShortUrlException
+     */
+    public function testUrlShortening()
+    {
+        $this->client->queue(require __DIR__ . '/../Responses/bit_ly/http-200.php');
+
+        $shortUrl = $this->shortener->shorten('https://laravel.com');
+        $request = $this->client->getRequest(0);
+
+        $this->assertNotNull($request);
+        $this->assertEquals('POST', $request->getMethod());
+        $this->assertEquals('api-ssl.bitly.com', $request->getUri()->getHost());
+        $this->assertEquals('/v4/shorten', $request->getRequestTarget());
+        $this->assertEquals('Bearer API_TOKEN', $request->getHeader('Authorization')[0]);
+        $this->assertEquals('application/json', $request->getHeader('Content-Type')[0]);
+
+        $this->assertEquals('https://bit.ly/3iSAOvF', $shortUrl);
+    }
+
+    /**
+     * Test failure to authenticate with Bit.ly
+     *
+     * @throws \CodeOfDigital\LaravelUrlShortener\Exceptions\ShortUrlException
+     */
+    public function testUnauthorized()
+    {
+        $this->client->queue(require __DIR__ . '/../Responses/bit_ly/http-403.php');
+        $this->expectException(InvalidApiTokenException::class);
+        $this->shortener->shorten('https://laravel.com');
+    }
+
+    /**
+     * Test failure if parsed URL is invalid or incorrect format
+     *
+     * @throws ShortUrlException
+     */
+    public function testInvalidUrl()
+    {
+        $this->expectException(ShortUrlException::class);
+        $this->shortener->shorten('some-string.com');
+    }
+}

tests/Unit/BitLyShortenerTest.php

@@ -0,0 +1,97 @@
+<?php
+
+namespace CodeOfDigital\LaravelUrlShortener\Tests\Unit;
+
+use GuzzleHttp\Client;
+use GuzzleHttp\Handler\MockHandler;
+use GuzzleHttp\HandlerStack;
+use GuzzleHttp\Middleware;
+use GuzzleHttp\Utils;
+use Psr\Http\Message\ResponseInterface;
+
+class MockClient extends Client
+{
+    protected $handler;
+    protected $history;
+
+    public function __construct(array $config = [])
+    {
+        $this->handler = new MockHandler();
+        $this->history = [];
+
+        parent::__construct($config + ['handler' => $this->newHandlerStack($this->handler)]);
+    }
+
+    /**
+     * Get the client history
+     *
+     * @param int|null $at
+     * @return array|mixed|null
+     */
+    public function getHistory(int $at = null)
+    {
+        if (is_null($at)) {
+            return $this->history;
+        }
+
+        return $this->history[$at] ?? null;
+    }
+
+    /**
+     * Get a previously made request
+     *
+     * @param int $at
+     * @return mixed|null
+     */
+    public function getRequest(int $at)
+    {
+        return $this->getHistory($at)['request'] ?? null;
+    }
+
+    /**
+     * Get the amount of messages waiting in the queue.
+     *
+     * @return int
+     */
+    public function getQueueSize()
+    {
+        return $this->handler->count();
+    }
+
+    /**
+     * Determine if there are queued messages.
+     *
+     * @return bool
+     */
+    public function hasQueuedMessages()
+    {
+        return $this->getQueueSize() > 0;
+    }
+
+    /**
+     * Get a fresh handler stack
+     *
+     * @param null $handler
+     * @return HandlerStack
+     */
+    protected function newHandlerStack($handler = null)
+    {
+        $stack = new HandlerStack($handler ?: Utils::chooseHandler());
+        $stack->push(Middleware::history($this->history));
+        $stack->push(Middleware::httpErrors());
+        return $stack;
+    }
+
+    /**
+     * Queue the given response
+     *
+     * @param ResponseInterface ...$responses
+     * @return $this
+     */
+    public function queue(ResponseInterface ...$responses)
+    {
+        $this->handler->append(...$responses);
+
+        return $this;
+    }
+}

tests/Unit/MockClient.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace CodeOfDigital\LaravelUrlShortener\Tests\Unit;
+
+use PHPUnit\Framework\TestCase as PHPTestCase;
+
+abstract class TestCase extends PHPTestCase
+{
+    protected $client;
+
+    protected function setUp(): void
+    {
+        $this->client = new MockClient();
+    }
+
+    protected function tearDown(): void
+    {
+        if ($this->client->hasQueuedMessages())
+            $this->fail(sprintf('HTTP Client contains %d unused message(s)', $this->client->getQueueSize()));
+    }
+}