From 06fa33877bc53f898cbe23d050086d3f30273b65 Mon Sep 17 00:00:00 2001
From: Alejandro Celaya <alejandro@alejandrocelaya.com>
Date: Wed, 20 Jul 2016 10:13:53 +0200
Subject: [PATCH] Moved some exceptions from core to common

---
 module/Common/config/services.config.php                    | 2 ++
 module/Common/src/Exception/ExceptionInterface.php          | 6 ++++++
 .../src/Exception/InvalidArgumentException.php              | 2 +-
 module/{Core => Common}/src/Exception/RuntimeException.php  | 2 +-
 module/Core/src/Exception/ExceptionInterface.php            | 6 ------
 module/Core/src/Exception/InvalidShortCodeException.php     | 2 ++
 module/Core/src/Exception/InvalidUrlException.php           | 2 ++
 module/Core/src/Service/UrlShortener.php                    | 2 +-
 module/Core/src/Service/UrlShortenerInterface.php           | 2 +-
 module/Core/src/Service/VisitsTracker.php                   | 2 +-
 module/Rest/src/Action/GetVisitsMiddleware.php              | 2 +-
 module/Rest/src/Exception/AuthenticationException.php       | 2 +-
 .../Rest/src/Middleware/CheckAuthenticationMiddleware.php   | 2 +-
 module/Rest/src/Service/RestTokenService.php                | 2 +-
 module/Rest/src/Service/RestTokenServiceInterface.php       | 2 +-
 module/Rest/src/Util/RestUtils.php                          | 3 ++-
 16 files changed, 24 insertions(+), 17 deletions(-)
 create mode 100644 module/Common/src/Exception/ExceptionInterface.php
 rename module/{Core => Common}/src/Exception/InvalidArgumentException.php (70%)
 rename module/{Core => Common}/src/Exception/RuntimeException.php (67%)
 delete mode 100644 module/Core/src/Exception/ExceptionInterface.php

diff --git a/module/Common/config/services.config.php b/module/Common/config/services.config.php
index b3c4e14d..838b7896 100644
--- a/module/Common/config/services.config.php
+++ b/module/Common/config/services.config.php
@@ -4,6 +4,7 @@ use Doctrine\Common\Cache\Cache;
 use Doctrine\ORM\EntityManager;
 use Shlinkio\Shlink\Common\Factory\CacheFactory;
 use Shlinkio\Shlink\Common\Factory\EntityManagerFactory;
+use Shlinkio\Shlink\Common\Service\IpLocationResolver;
 use Zend\ServiceManager\Factory\InvokableFactory;
 
 return [
@@ -13,6 +14,7 @@ return [
             EntityManager::class => EntityManagerFactory::class,
             GuzzleHttp\Client::class => InvokableFactory::class,
             Cache::class => CacheFactory::class,
+            IpLocationResolver::class => AnnotatedFactory::class,
         ],
         'aliases' => [
             'em' => EntityManager::class,
diff --git a/module/Common/src/Exception/ExceptionInterface.php b/module/Common/src/Exception/ExceptionInterface.php
new file mode 100644
index 00000000..81255f6a
--- /dev/null
+++ b/module/Common/src/Exception/ExceptionInterface.php
@@ -0,0 +1,6 @@
+<?php
+namespace Shlinkio\Shlink\Common\Exception;
+
+interface ExceptionInterface
+{
+}
diff --git a/module/Core/src/Exception/InvalidArgumentException.php b/module/Common/src/Exception/InvalidArgumentException.php
similarity index 70%
rename from module/Core/src/Exception/InvalidArgumentException.php
rename to module/Common/src/Exception/InvalidArgumentException.php
index 5ebcab2e..79bfc9cb 100644
--- a/module/Core/src/Exception/InvalidArgumentException.php
+++ b/module/Common/src/Exception/InvalidArgumentException.php
@@ -1,5 +1,5 @@
 <?php
-namespace Shlinkio\Shlink\Core\Exception;
+namespace Shlinkio\Shlink\Common\Exception;
 
 class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface
 {
diff --git a/module/Core/src/Exception/RuntimeException.php b/module/Common/src/Exception/RuntimeException.php
similarity index 67%
rename from module/Core/src/Exception/RuntimeException.php
rename to module/Common/src/Exception/RuntimeException.php
index 195284f5..fbed3d68 100644
--- a/module/Core/src/Exception/RuntimeException.php
+++ b/module/Common/src/Exception/RuntimeException.php
@@ -1,5 +1,5 @@
 <?php
-namespace Shlinkio\Shlink\Core\Exception;
+namespace Shlinkio\Shlink\Common\Exception;
 
 class RuntimeException extends \RuntimeException implements ExceptionInterface
 {
diff --git a/module/Core/src/Exception/ExceptionInterface.php b/module/Core/src/Exception/ExceptionInterface.php
deleted file mode 100644
index 4d61c4d3..00000000
--- a/module/Core/src/Exception/ExceptionInterface.php
+++ /dev/null
@@ -1,6 +0,0 @@
-<?php
-namespace Shlinkio\Shlink\Core\Exception;
-
-interface ExceptionInterface
-{
-}
diff --git a/module/Core/src/Exception/InvalidShortCodeException.php b/module/Core/src/Exception/InvalidShortCodeException.php
index 32e5b2d4..b1e23d0b 100644
--- a/module/Core/src/Exception/InvalidShortCodeException.php
+++ b/module/Core/src/Exception/InvalidShortCodeException.php
@@ -1,6 +1,8 @@
 <?php
 namespace Shlinkio\Shlink\Core\Exception;
 
+use Shlinkio\Shlink\Common\Exception\RuntimeException;
+
 class InvalidShortCodeException extends RuntimeException
 {
     public static function fromShortCode($shortCode, $charSet, \Exception $previous = null)
diff --git a/module/Core/src/Exception/InvalidUrlException.php b/module/Core/src/Exception/InvalidUrlException.php
index 864c6575..ba90943e 100644
--- a/module/Core/src/Exception/InvalidUrlException.php
+++ b/module/Core/src/Exception/InvalidUrlException.php
@@ -1,6 +1,8 @@
 <?php
 namespace Shlinkio\Shlink\Core\Exception;
 
+use Shlinkio\Shlink\Common\Exception\RuntimeException;
+
 class InvalidUrlException extends RuntimeException
 {
     public static function fromUrl($url, \Exception $previous = null)
diff --git a/module/Core/src/Service/UrlShortener.php b/module/Core/src/Service/UrlShortener.php
index 1f83a120..01a8d4b6 100644
--- a/module/Core/src/Service/UrlShortener.php
+++ b/module/Core/src/Service/UrlShortener.php
@@ -7,10 +7,10 @@ use Doctrine\ORM\ORMException;
 use GuzzleHttp\ClientInterface;
 use GuzzleHttp\Exception\GuzzleException;
 use Psr\Http\Message\UriInterface;
+use Shlinkio\Shlink\Common\Exception\RuntimeException;
 use Shlinkio\Shlink\Core\Entity\ShortUrl;
 use Shlinkio\Shlink\Core\Exception\InvalidShortCodeException;
 use Shlinkio\Shlink\Core\Exception\InvalidUrlException;
-use Shlinkio\Shlink\Core\Exception\RuntimeException;
 
 class UrlShortener implements UrlShortenerInterface
 {
diff --git a/module/Core/src/Service/UrlShortenerInterface.php b/module/Core/src/Service/UrlShortenerInterface.php
index 6cbb6723..07d45401 100644
--- a/module/Core/src/Service/UrlShortenerInterface.php
+++ b/module/Core/src/Service/UrlShortenerInterface.php
@@ -2,9 +2,9 @@
 namespace Shlinkio\Shlink\Core\Service;
 
 use Psr\Http\Message\UriInterface;
+use Shlinkio\Shlink\Common\Exception\RuntimeException;
 use Shlinkio\Shlink\Core\Exception\InvalidShortCodeException;
 use Shlinkio\Shlink\Core\Exception\InvalidUrlException;
-use Shlinkio\Shlink\Core\Exception\RuntimeException;
 
 interface UrlShortenerInterface
 {
diff --git a/module/Core/src/Service/VisitsTracker.php b/module/Core/src/Service/VisitsTracker.php
index 7a7b5b67..2fd053c1 100644
--- a/module/Core/src/Service/VisitsTracker.php
+++ b/module/Core/src/Service/VisitsTracker.php
@@ -3,9 +3,9 @@ namespace Shlinkio\Shlink\Core\Service;
 
 use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
 use Doctrine\ORM\EntityManagerInterface;
+use Shlinkio\Shlink\Common\Exception\InvalidArgumentException;
 use Shlinkio\Shlink\Core\Entity\ShortUrl;
 use Shlinkio\Shlink\Core\Entity\Visit;
-use Shlinkio\Shlink\Core\Exception\InvalidArgumentException;
 use Zend\Paginator\Paginator;
 
 class VisitsTracker implements VisitsTrackerInterface
diff --git a/module/Rest/src/Action/GetVisitsMiddleware.php b/module/Rest/src/Action/GetVisitsMiddleware.php
index 02f8df63..148053ee 100644
--- a/module/Rest/src/Action/GetVisitsMiddleware.php
+++ b/module/Rest/src/Action/GetVisitsMiddleware.php
@@ -4,7 +4,7 @@ namespace Shlinkio\Shlink\Rest\Action;
 use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
 use Psr\Http\Message\ResponseInterface as Response;
 use Psr\Http\Message\ServerRequestInterface as Request;
-use Shlinkio\Shlink\Core\Exception\InvalidArgumentException;
+use Shlinkio\Shlink\Common\Exception\InvalidArgumentException;
 use Shlinkio\Shlink\Core\Service\VisitsTracker;
 use Shlinkio\Shlink\Core\Service\VisitsTrackerInterface;
 use Shlinkio\Shlink\Rest\Util\RestUtils;
diff --git a/module/Rest/src/Exception/AuthenticationException.php b/module/Rest/src/Exception/AuthenticationException.php
index e650636e..ec4d0a4b 100644
--- a/module/Rest/src/Exception/AuthenticationException.php
+++ b/module/Rest/src/Exception/AuthenticationException.php
@@ -1,7 +1,7 @@
 <?php
 namespace Shlinkio\Shlink\Rest\Exception;
 
-use Shlinkio\Shlink\Core\Exception\ExceptionInterface;
+use Shlinkio\Shlink\Common\Exception\ExceptionInterface;
 
 class AuthenticationException extends \RuntimeException implements ExceptionInterface
 {
diff --git a/module/Rest/src/Middleware/CheckAuthenticationMiddleware.php b/module/Rest/src/Middleware/CheckAuthenticationMiddleware.php
index 2910aad8..9120e2c6 100644
--- a/module/Rest/src/Middleware/CheckAuthenticationMiddleware.php
+++ b/module/Rest/src/Middleware/CheckAuthenticationMiddleware.php
@@ -4,7 +4,7 @@ namespace Shlinkio\Shlink\Rest\Middleware;
 use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
 use Psr\Http\Message\ResponseInterface as Response;
 use Psr\Http\Message\ServerRequestInterface as Request;
-use Shlinkio\Shlink\Core\Exception\InvalidArgumentException;
+use Shlinkio\Shlink\Common\Exception\InvalidArgumentException;
 use Shlinkio\Shlink\Rest\Service\RestTokenService;
 use Shlinkio\Shlink\Rest\Service\RestTokenServiceInterface;
 use Shlinkio\Shlink\Rest\Util\RestUtils;
diff --git a/module/Rest/src/Service/RestTokenService.php b/module/Rest/src/Service/RestTokenService.php
index 83585404..c452af2a 100644
--- a/module/Rest/src/Service/RestTokenService.php
+++ b/module/Rest/src/Service/RestTokenService.php
@@ -3,8 +3,8 @@ namespace Shlinkio\Shlink\Rest\Service;
 
 use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
 use Doctrine\ORM\EntityManagerInterface;
+use Shlinkio\Shlink\Common\Exception\InvalidArgumentException;
 use Shlinkio\Shlink\Core\Entity\RestToken;
-use Shlinkio\Shlink\Core\Exception\InvalidArgumentException;
 use Shlinkio\Shlink\Rest\Exception\AuthenticationException;
 
 class RestTokenService implements RestTokenServiceInterface
diff --git a/module/Rest/src/Service/RestTokenServiceInterface.php b/module/Rest/src/Service/RestTokenServiceInterface.php
index d70973fb..1e03cbaa 100644
--- a/module/Rest/src/Service/RestTokenServiceInterface.php
+++ b/module/Rest/src/Service/RestTokenServiceInterface.php
@@ -1,8 +1,8 @@
 <?php
 namespace Shlinkio\Shlink\Rest\Service;
 
+use Shlinkio\Shlink\Common\Exception\InvalidArgumentException;
 use Shlinkio\Shlink\Core\Entity\RestToken;
-use Shlinkio\Shlink\Core\Exception\InvalidArgumentException;
 use Shlinkio\Shlink\Rest\Exception\AuthenticationException;
 
 interface RestTokenServiceInterface
diff --git a/module/Rest/src/Util/RestUtils.php b/module/Rest/src/Util/RestUtils.php
index ca24fbbe..82082dcd 100644
--- a/module/Rest/src/Util/RestUtils.php
+++ b/module/Rest/src/Util/RestUtils.php
@@ -1,6 +1,7 @@
 <?php
 namespace Shlinkio\Shlink\Rest\Util;
 
+use Shlinkio\Shlink\Common\Exception as Common;
 use Shlinkio\Shlink\Core\Exception as Core;
 use Shlinkio\Shlink\Rest\Exception as Rest;
 
@@ -13,7 +14,7 @@ class RestUtils
     const INVALID_AUTH_TOKEN_ERROR = 'INVALID_AUTH_TOKEN_ERROR';
     const UNKNOWN_ERROR = 'UNKNOWN_ERROR';
 
-    public static function getRestErrorCodeFromException(Core\ExceptionInterface $e)
+    public static function getRestErrorCodeFromException(Common\ExceptionInterface $e)
     {
         switch (true) {
             case $e instanceof Core\InvalidShortCodeException: