Merge branch 'develop'

.env.dist

@@ -8,3 +8,7 @@ SHORTCODE_CHARS=
 DB_USER=
 DB_PASSWORD=
 DB_NAME=
+
+# Rest authentication
+REST_USER=
+REST_PASSWORD=

.travis.yml

@@ -6,7 +6,6 @@ branches:
     - develop
 
 php:
-  - 5.5
   - 5.6
   - 7
   - hhvm

CHANGELOG.md

@@ -0,0 +1,13 @@
+## CHANGELOG
+
+### 0.2.0
+
+**Enhancements:**
+
+* [9: Use symfony/console to dispatch console requests, instead of trying to integrate the process with expressive](https://github.com/acelaya/url-shortener/issues/9)
+* [8: Create a REST API](https://github.com/acelaya/url-shortener/issues/8)
+* [10: Add more CLI functionality](https://github.com/acelaya/url-shortener/issues/10)
+
+**Tasks**
+
+* [5: Create CHANGELOG file](https://github.com/acelaya/url-shortener/issues/5)

bin/cli

@@ -1,17 +1,10 @@
 #!/usr/bin/env php
 <?php
 use Interop\Container\ContainerInterface;
-use Zend\Diactoros\ServerRequestFactory;
-use Zend\Diactoros\Uri;
-use Zend\Expressive\Application;
+use Symfony\Component\Console\Application as CliApp;
 
 /** @var ContainerInterface $container */
 $container = include __DIR__ . '/../config/container.php';
-/** @var Application $app */
-$app = $container->get(Application::class);
 
-$command = count($_SERVER['argv']) > 1 ? $_SERVER['argv'][1] : '';
-$request = ServerRequestFactory::fromGlobals()
-                                ->withMethod('CLI')
-                                ->withUri(new Uri(sprintf('/%s', $command)));
-$app->run($request);
+$app = $container->get(CliApp::class);
+$app->run();

composer.json

@@ -11,19 +11,21 @@
         }
     ],
     "require": {
-        "php": "^5.5 || ^7.0",
+        "php": "^5.6 || ^7.0",
         "zendframework/zend-expressive": "^1.0",
         "zendframework/zend-expressive-helpers": "^2.0",
         "zendframework/zend-expressive-fastroute": "^1.1",
         "zendframework/zend-expressive-twigrenderer": "^1.0",
         "zendframework/zend-stdlib": "^2.7",
         "zendframework/zend-servicemanager": "^3.0",
+        "zendframework/zend-paginator": "^2.6",
         "doctrine/orm": "^2.5",
         "guzzlehttp/guzzle": "^6.2",
-        "acelaya/zsm-annotated-services": "^0.2.0"
+        "acelaya/zsm-annotated-services": "^0.2.0",
+        "symfony/console": "^3.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^4.8",
+        "phpunit/phpunit": "^5.0",
         "squizlabs/php_codesniffer": "^2.3",
         "roave/security-advisories": "dev-master",
         "filp/whoops": "^2.0",

config/autoload/cli.global.php

@@ -0,0 +1,15 @@
+<?php
+use Acelaya\UrlShortener\CLI\Command;
+
+return [
+
+    'cli' => [
+        'commands' => [
+            Command\GenerateShortcodeCommand::class,
+            Command\ResolveUrlCommand::class,
+            Command\ListShortcodesCommand::class,
+            Command\GetVisitsCommand::class,
+        ]
+    ],
+
+];

config/autoload/errorhandler.local.php.dist

@@ -0,0 +1,21 @@
+<?php
+
+return [
+    'services' => [
+        'invokables' => [
+            'Zend\Expressive\Whoops' => Whoops\Run::class,
+            'Zend\Expressive\WhoopsPageHandler' => Whoops\Handler\PrettyPageHandler::class,
+        ],
+        'factories' => [
+            'Zend\Expressive\FinalHandler' => Zend\Expressive\Container\WhoopsErrorHandlerFactory::class,
+        ],
+    ],
+
+    'whoops' => [
+        'json_exceptions' => [
+            'display'    => true,
+            'show_trace' => true,
+            'ajax_only'  => true,
+        ],
+    ],
+];

config/autoload/middleware-pipeline.global.php

@@ -1,5 +1,5 @@
 <?php
-use Acelaya\UrlShortener\Middleware\CliParamsMiddleware;
+use Acelaya\UrlShortener\Middleware;
 use Zend\Expressive\Container\ApplicationFactory;
 use Zend\Expressive\Helper;
 
@@ -16,7 +16,21 @@
         'routing' => [
             'middleware' => [
                 ApplicationFactory::ROUTING_MIDDLEWARE,
-                CliParamsMiddleware::class,
+            ],
+            'priority' => 10,
+        ],
+
+        'rest' => [
+            'path' => '/rest',
+            'middleware' => [
+                Middleware\CheckAuthenticationMiddleware::class,
+                Middleware\CrossDomainMiddleware::class,
+            ],
+            'priority' => 5,
+        ],
+
+        'post-routing' => [
+            'middleware' => [
                 Helper\UrlHelperMiddleware::class,
                 ApplicationFactory::DISPATCH_MIDDLEWARE,
             ],

config/autoload/rest.global.php

@@ -0,0 +1,9 @@
+<?php
+return [
+
+    'rest' => [
+        'username' => getenv('REST_USER'),
+        'password' => getenv('REST_PASSWORD'),
+    ],
+
+];

config/autoload/routes.global.php

@@ -1,5 +1,6 @@
 <?php
 use Acelaya\UrlShortener\Middleware\Routable;
+use Acelaya\UrlShortener\Middleware\Rest;
 
 return [
 
@@ -10,6 +11,38 @@
             'middleware' => Routable\RedirectMiddleware::class,
             'allowed_methods' => ['GET'],
         ],
+
+        // Rest
+        [
+            'name' => 'rest-authenticate',
+            'path' => '/rest/authenticate',
+            'middleware' => Rest\AuthenticateMiddleware::class,
+            'allowed_methods' => ['POST', 'OPTIONS'],
+        ],
+        [
+            'name' => 'rest-create-shortcode',
+            'path' => '/rest/short-codes',
+            'middleware' => Rest\CreateShortcodeMiddleware::class,
+            'allowed_methods' => ['POST', 'OPTIONS'],
+        ],
+        [
+            'name' => 'rest-resolve-url',
+            'path' => '/rest/short-codes/{shortCode}',
+            'middleware' => Rest\ResolveUrlMiddleware::class,
+            'allowed_methods' => ['GET', 'OPTIONS'],
+        ],
+        [
+            'name' => 'rest-list-shortened-url',
+            'path' => '/rest/short-codes',
+            'middleware' => Rest\ListShortcodesMiddleware::class,
+            'allowed_methods' => ['GET'],
+        ],
+        [
+            'name' => 'rest-get-visits',
+            'path' => '/rest/visits/{shortCode}',
+            'middleware' => Rest\GetVisitsMiddleware::class,
+            'allowed_methods' => ['GET', 'OPTIONS'],
+        ],
     ],
 
 ];

config/autoload/services.global.php

@@ -1,12 +1,14 @@
 <?php
+use Acelaya\UrlShortener\CLI;
 use Acelaya\UrlShortener\Factory\CacheFactory;
 use Acelaya\UrlShortener\Factory\EntityManagerFactory;
 use Acelaya\UrlShortener\Middleware;
 use Acelaya\UrlShortener\Service;
 use Acelaya\ZsmAnnotatedServices\Factory\V3\AnnotatedFactory;
 use Doctrine\Common\Cache\Cache;
 use Doctrine\ORM\EntityManager;
-use Zend\Expressive\Application;
+use Symfony\Component\Console;
+use Zend\Expressive;
 use Zend\Expressive\Container;
 use Zend\Expressive\Helper;
 use Zend\Expressive\Router;
@@ -18,7 +20,8 @@
 
     'services' => [
         'factories' => [
-            Application::class => Container\ApplicationFactory::class,
+            Expressive\Application::class => Container\ApplicationFactory::class,
+            Console\Application::class => CLI\Factory\ApplicationFactory::class,
 
             // Url helpers
             Helper\UrlHelper::class => Helper\UrlHelperFactory::class,
@@ -36,17 +39,31 @@
             GuzzleHttp\Client::class => InvokableFactory::class,
             Service\UrlShortener::class => AnnotatedFactory::class,
             Service\VisitsTracker::class => AnnotatedFactory::class,
+            Service\ShortUrlService::class => AnnotatedFactory::class,
+            Service\RestTokenService::class => AnnotatedFactory::class,
             Cache::class => CacheFactory::class,
 
+            // Cli commands
+            CLI\Command\GenerateShortcodeCommand::class => AnnotatedFactory::class,
+            CLI\Command\ResolveUrlCommand::class => AnnotatedFactory::class,
+            CLI\Command\ListShortcodesCommand::class => AnnotatedFactory::class,
+            CLI\Command\GetVisitsCommand::class => AnnotatedFactory::class,
+
             // Middleware
-            Middleware\CliRoutable\GenerateShortcodeMiddleware::class => AnnotatedFactory::class,
             Middleware\Routable\RedirectMiddleware::class => AnnotatedFactory::class,
-            Middleware\CliParamsMiddleware::class => Middleware\Factory\CliParamsMiddlewareFactory::class,
+            Middleware\Rest\AuthenticateMiddleware::class => AnnotatedFactory::class,
+            Middleware\Rest\CreateShortcodeMiddleware::class => AnnotatedFactory::class,
+            Middleware\Rest\ResolveUrlMiddleware::class => AnnotatedFactory::class,
+            Middleware\Rest\GetVisitsMiddleware::class => AnnotatedFactory::class,
+            Middleware\Rest\ListShortcodesMiddleware::class => AnnotatedFactory::class,
+            Middleware\CrossDomainMiddleware::class => InvokableFactory::class,
+            Middleware\CheckAuthenticationMiddleware::class => AnnotatedFactory::class,
         ],
         'aliases' => [
             'em' => EntityManager::class,
             'httpClient' => GuzzleHttp\Client::class,
             Router\RouterInterface::class => Router\FastRouteRouter::class,
+            AnnotatedFactory::CACHE_SERVICE => Cache::class,
         ]
     ],