shlink/module/Rest/test/Action/Visit/GetVisitsActionTest.php

<?php

declare(strict_types=1);

namespace ShlinkioTest\Shlink\Rest\Action\Visit;

use Cake\Chronos\Chronos;
use PHPUnit\Framework\TestCase;
use Prophecy\Argument;
use Prophecy\Prophecy\ObjectProphecy;
use Shlinkio\Shlink\Common\Exception\InvalidArgumentException;
use Shlinkio\Shlink\Common\Util\DateRange;
use Shlinkio\Shlink\Core\Model\VisitsParams;
use Shlinkio\Shlink\Core\Service\VisitsTracker;
use Shlinkio\Shlink\Rest\Action\Visit\GetVisitsAction;
use Zend\Diactoros\ServerRequest;
use Zend\Paginator\Adapter\ArrayAdapter;
use Zend\Paginator\Paginator;

class GetVisitsActionTest extends TestCase
{
    /** @var GetVisitsAction */
    private $action;
    /** @var ObjectProphecy */
    private $visitsTracker;

    public function setUp(): void
    {
        $this->visitsTracker = $this->prophesize(VisitsTracker::class);
        $this->action = new GetVisitsAction($this->visitsTracker->reveal());
    }

    /** @test */
    public function providingCorrectShortCodeReturnsVisits()
    {
        $shortCode = 'abc123';
        $this->visitsTracker->info($shortCode, Argument::type(VisitsParams::class))->willReturn(
            new Paginator(new ArrayAdapter([]))
        )->shouldBeCalledOnce();

        $response = $this->action->handle((new ServerRequest())->withAttribute('shortCode', $shortCode));
        $this->assertEquals(200, $response->getStatusCode());
    }

    /** @test */
    public function providingInvalidShortCodeReturnsError()
    {
        $shortCode = 'abc123';
        $this->visitsTracker->info($shortCode, Argument::type(VisitsParams::class))->willThrow(
            InvalidArgumentException::class
        )->shouldBeCalledOnce();

        $response = $this->action->handle((new ServerRequest())->withAttribute('shortCode', $shortCode));
        $this->assertEquals(404, $response->getStatusCode());
    }

    /** @test */
    public function paramsAreReadFromQuery()
    {
        $shortCode = 'abc123';
        $this->visitsTracker->info($shortCode, new VisitsParams(
            new DateRange(null, Chronos::parse('2016-01-01 00:00:00')),
            3,
            10
        ))
            ->willReturn(new Paginator(new ArrayAdapter([])))
            ->shouldBeCalledOnce();

        $response = $this->action->handle(
            (new ServerRequest())->withAttribute('shortCode', $shortCode)
                                 ->withQueryParams([
                                     'endDate' => '2016-01-01 00:00:00',
                                     'page' => '3',
                                     'itemsPerPage' => '10',
                                 ])
        );
        $this->assertEquals(200, $response->getStatusCode());
    }
}