Mirrors/shlink
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2026-03-06 23:33:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

Migrated rest actions to psr-15 middleware

Browse Source
This commit is contained in:
Alejandro Celaya
2017-03-25 10:04:48 +01:00
parent 288249d0b8
commit 2e5a7d76df
13 changed files with 93 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
module/Rest/src/Action/AbstractRestAction.php
View File

@@ -1,13 +1,17 @@
<?php
namespace Shlinkio\Shlink\Rest\Action;
use Fig\Http\Message\RequestMethodInterface;
use Fig\Http\Message\StatusCodeInterface;
use Interop\Http\ServerMiddleware\DelegateInterface;
use Interop\Http\ServerMiddleware\MiddlewareInterface;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use Zend\Stratigility\MiddlewareInterface;
use Zend\Diactoros\Response\EmptyResponse;
abstract class AbstractRestAction implements MiddlewareInterface
abstract class AbstractRestAction implements MiddlewareInterface, RequestMethodInterface, StatusCodeInterface
{
/**
* @var LoggerInterface
@@ -20,44 +24,27 @@ abstract class AbstractRestAction implements MiddlewareInterface
}
/**
* Process an incoming request and/or response.
*
* Accepts a server-side request and a response instance, and does
* something with them.
*
* If the response is not complete and/or further processing would not
* interfere with the work done in the middleware, or if the middleware
* wants to delegate to another process, it can use the `$out` callable
* if present.
*
* If the middleware does not return a value, execution of the current
* request is considered complete, and the response instance provided will
* be considered the response to return.
*
* Alternately, the middleware may return a response instance.
*
* Often, middleware will `return $out();`, with the assumption that a
* later middleware will return a response.
* Process an incoming server request and return a response, optionally delegating
* to the next middleware component to create the response.
*
* @param Request $request
* @param Response $response
* @param null|callable $out
* @return null|Response
* @param DelegateInterface $delegate
*
* @return Response
*/
public function __invoke(Request $request, Response $response, callable $out = null)
public function process(Request $request, DelegateInterface $delegate)
{
if ($request->getMethod() === 'OPTIONS') {
return $response;
if ($request->getMethod() === self::METHOD_OPTIONS) {
return new EmptyResponse();
}
return $this->dispatch($request, $response, $out);
return $this->dispatch($request, $delegate);
}
/**
* @param Request $request
* @param Response $response
* @param callable|null $out
* @param DelegateInterface $delegate
* @return null|Response
*/
abstract protected function dispatch(Request $request, Response $response, callable $out = null);
abstract protected function dispatch(Request $request, DelegateInterface $delegate);
}

19
module/Rest/src/Action/AuthenticateAction.php
View File

@@ -2,9 +2,10 @@
namespace Shlinkio\Shlink\Rest\Action;
use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
use Firebase\JWT\JWT;
use Interop\Http\ServerMiddleware\DelegateInterface;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Log\LoggerInterface;
use Shlinkio\Shlink\Rest\Authentication\JWTService;
use Shlinkio\Shlink\Rest\Authentication\JWTServiceInterface;
use Shlinkio\Shlink\Rest\Service\ApiKeyService;
@@ -33,14 +34,17 @@ class AuthenticateAction extends AbstractRestAction
* @param ApiKeyServiceInterface|ApiKeyService $apiKeyService
* @param JWTServiceInterface|JWTService $jwtService
* @param TranslatorInterface $translator
* @param LoggerInterface|null $logger
*
* @Inject({ApiKeyService::class, JWTService::class, "translator"})
* @Inject({ApiKeyService::class, JWTService::class, "translator", "Logger_Shlink"})
*/
public function __construct(
ApiKeyServiceInterface $apiKeyService,
JWTServiceInterface $jwtService,
TranslatorInterface $translator
TranslatorInterface $translator,
LoggerInterface $logger = null
) {
parent::__construct($logger);
$this->translator = $translator;
$this->apiKeyService = $apiKeyService;
$this->jwtService = $jwtService;
@@ -48,11 +52,10 @@ class AuthenticateAction extends AbstractRestAction
/**
* @param Request $request
* @param Response $response
* @param callable|null $out
* @param DelegateInterface $delegate
* @return null|Response
*/
public function dispatch(Request $request, Response $response, callable $out = null)
public function dispatch(Request $request, DelegateInterface $delegate)
{
$authData = $request->getParsedBody();
if (! isset($authData['apiKey'])) {
@@ -61,7 +64,7 @@ class AuthenticateAction extends AbstractRestAction
'message' => $this->translator->translate(
'You have to provide a valid API key under the "apiKey" param name.'
),
], 400);
], self::STATUS_BAD_REQUEST);
}
// Authenticate using provided API key
@@ -70,7 +73,7 @@ class AuthenticateAction extends AbstractRestAction
return new JsonResponse([
'error' => RestUtils::INVALID_API_KEY_ERROR,
'message' => $this->translator->translate('Provided API key does not exist or is invalid.'),
], 401);
], self::STATUS_UNAUTHORIZED);
}
// Generate a JSON Web Token that will be used for authorization in next requests

12
module/Rest/src/Action/CreateShortcodeAction.php
View File

@@ -2,6 +2,7 @@
namespace Shlinkio\Shlink\Rest\Action;
use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
use Interop\Http\ServerMiddleware\DelegateInterface;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Log\LoggerInterface;
@@ -52,18 +53,17 @@ class CreateShortcodeAction extends AbstractRestAction
/**
* @param Request $request
* @param Response $response
* @param callable|null $out
* @param DelegateInterface $delegate
* @return null|Response
*/
public function dispatch(Request $request, Response $response, callable $out = null)
public function dispatch(Request $request, DelegateInterface $delegate)
{
$postData = $request->getParsedBody();
if (! isset($postData['longUrl'])) {
return new JsonResponse([
'error' => RestUtils::INVALID_ARGUMENT_ERROR,
'message' => $this->translator->translate('A URL was not provided'),
], 400);
], self::STATUS_BAD_REQUEST);
}
$longUrl = $postData['longUrl'];
$tags = isset($postData['tags']) && is_array($postData['tags']) ? $postData['tags'] : [];
@@ -87,13 +87,13 @@ class CreateShortcodeAction extends AbstractRestAction
$this->translator->translate('Provided URL %s is invalid. Try with a different one.'),
$longUrl
),
], 400);
], self::STATUS_BAD_REQUEST);
} catch (\Exception $e) {
$this->logger->error('Unexpected error creating shortcode.' . PHP_EOL . $e);
return new JsonResponse([
'error' => RestUtils::UNKNOWN_ERROR,
'message' => $this->translator->translate('Unexpected error occurred'),
], 500);
], self::STATUS_INTERNAL_SERVER_ERROR);
}
}
}

10
module/Rest/src/Action/EditTagsAction.php
View File

@@ -2,6 +2,7 @@
namespace Shlinkio\Shlink\Rest\Action;
use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
use Interop\Http\ServerMiddleware\DelegateInterface;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Log\LoggerInterface;
@@ -43,11 +44,10 @@ class EditTagsAction extends AbstractRestAction
/**
* @param Request $request
* @param Response $response
* @param callable|null $out
* @param DelegateInterface $delegate
* @return null|Response
*/
protected function dispatch(Request $request, Response $response, callable $out = null)
protected function dispatch(Request $request, DelegateInterface $delegate)
{
$shortCode = $request->getAttribute('shortCode');
$bodyParams = $request->getParsedBody();
@@ -56,7 +56,7 @@ class EditTagsAction extends AbstractRestAction
return new JsonResponse([
'error' => RestUtils::INVALID_ARGUMENT_ERROR,
'message' => $this->translator->translate('A list of tags was not provided'),
], 400);
], self::STATUS_BAD_REQUEST);
}
$tags = $bodyParams['tags'];
@@ -67,7 +67,7 @@ class EditTagsAction extends AbstractRestAction
return new JsonResponse([
'error' => RestUtils::getRestErrorCodeFromException($e),
'message' => sprintf($this->translator->translate('No URL found for short code "%s"'), $shortCode),
], 404);
], self::STATUS_NOT_FOUND);
}
}
}

10
module/Rest/src/Action/GetVisitsAction.php
View File

@@ -2,6 +2,7 @@
namespace Shlinkio\Shlink\Rest\Action;
use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
use Interop\Http\ServerMiddleware\DelegateInterface;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Log\LoggerInterface;
@@ -44,11 +45,10 @@ class GetVisitsAction extends AbstractRestAction
/**
* @param Request $request
* @param Response $response
* @param callable|null $out
* @param DelegateInterface $delegate
* @return null|Response
*/
public function dispatch(Request $request, Response $response, callable $out = null)
public function dispatch(Request $request, DelegateInterface $delegate)
{
$shortCode = $request->getAttribute('shortCode');
$startDate = $this->getDateQueryParam($request, 'startDate');
@@ -70,13 +70,13 @@ class GetVisitsAction extends AbstractRestAction
$this->translator->translate('Provided short code %s does not exist'),
$shortCode
),
], 404);
], self::STATUS_NOT_FOUND);
} catch (\Exception $e) {
$this->logger->error('Unexpected error while parsing short code'. PHP_EOL . $e);
return new JsonResponse([
'error' => RestUtils::UNKNOWN_ERROR,
'message' => $this->translator->translate('Unexpected error occurred'),
], 500);
], self::STATUS_INTERNAL_SERVER_ERROR);
}
}

8
module/Rest/src/Action/ListShortcodesAction.php
View File

@@ -2,6 +2,7 @@
namespace Shlinkio\Shlink\Rest\Action;
use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
use Interop\Http\ServerMiddleware\DelegateInterface;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Log\LoggerInterface;
@@ -46,11 +47,10 @@ class ListShortcodesAction extends AbstractRestAction
/**
* @param Request $request
* @param Response $response
* @param callable|null $out
* @param DelegateInterface $delegate
* @return null|Response
*/
public function dispatch(Request $request, Response $response, callable $out = null)
public function dispatch(Request $request, DelegateInterface $delegate)
{
try {
$params = $this->queryToListParams($request->getQueryParams());
@@ -61,7 +61,7 @@ class ListShortcodesAction extends AbstractRestAction
return new JsonResponse([
'error' => RestUtils::UNKNOWN_ERROR,
'message' => $this->translator->translate('Unexpected error occurred'),
], 500);
], self::STATUS_INTERNAL_SERVER_ERROR);
}
}

12
module/Rest/src/Action/ResolveUrlAction.php
View File

@@ -2,6 +2,7 @@
namespace Shlinkio\Shlink\Rest\Action;
use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
use Interop\Http\ServerMiddleware\DelegateInterface;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Log\LoggerInterface;
@@ -43,11 +44,10 @@ class ResolveUrlAction extends AbstractRestAction
/**
* @param Request $request
* @param Response $response
* @param callable|null $out
* @param DelegateInterface $delegate
* @return null|Response
*/
public function dispatch(Request $request, Response $response, callable $out = null)
public function dispatch(Request $request, DelegateInterface $delegate)
{
$shortCode = $request->getAttribute('shortCode');
@@ -57,7 +57,7 @@ class ResolveUrlAction extends AbstractRestAction
return new JsonResponse([
'error' => RestUtils::INVALID_ARGUMENT_ERROR,
'message' => sprintf($this->translator->translate('No URL found for short code "%s"'), $shortCode),
], 404);
], self::STATUS_NOT_FOUND);
}
return new JsonResponse([
@@ -71,13 +71,13 @@ class ResolveUrlAction extends AbstractRestAction
$this->translator->translate('Provided short code "%s" has an invalid format'),
$shortCode
),
], 400);
], self::STATUS_BAD_REQUEST);
} catch (\Exception $e) {
$this->logger->error('Unexpected error while resolving the URL behind a short code.' . PHP_EOL . $e);
return new JsonResponse([
'error' => RestUtils::UNKNOWN_ERROR,
'message' => $this->translator->translate('Unexpected error occurred'),
], 500);
], self::STATUS_INTERNAL_SERVER_ERROR);
}
}
}