General refactoring for v1.0.0

Ricardo Fiorani · Ricardo Fiorani · commit 7904e78c3c13 · 2018-04-17T17:58:25.000+02:00
diff --git a/src/Adapter/AbstractServiceAdapter.php b/src/Adapter/AbstractServiceAdapter.php
@@ -5,9 +5,11 @@
  * Date: 29/08/2015
  * Time: 19:37.
  */
+
 namespace RicardoFiorani\Adapter;
 
-use RicardoFiorani\Exception\NotEmbeddableException;
+use RicardoFiorani\Adapter\Exception\InvalidUrlException;
+use RicardoFiorani\Adapter\Exception\NotEmbeddableException;
 use RicardoFiorani\Renderer\EmbedRendererInterface;
 
 abstract class AbstractServiceAdapter implements VideoAdapterInterface
@@ -123,8 +125,10 @@ public function setRenderer($renderer)
      */
     public function getEmbedCode($width, $height, $forceAutoplay = false, $forceSecure = false)
     {
-        if (false == $this->isEmbeddable()) {
-            throw new NotEmbeddableException();
+        if (false === $this->isEmbeddable()) {
+            throw new NotEmbeddableException(
+                sprintf('The service "%s" does not provide embeddable videos', $this->getServiceName())
+            );
         }
 
         return $this->getRenderer()->renderVideoEmbedCode(
@@ -139,13 +143,25 @@ public function getEmbedCode($width, $height, $forceAutoplay = false, $forceSecu
      *
      * @param bool|false $forceSecure
      * @return string
+     * @throws InvalidUrlException
      */
     public function getScheme($forceSecure = false)
     {
         if ($forceSecure) {
             return 'https';
         }
 
-        return parse_url($this->rawUrl, PHP_URL_SCHEME);
+        $parsedUrlSchema = parse_url($this->rawUrl, PHP_URL_SCHEME);
+
+        if (false !== $parsedUrlSchema) {
+            return $parsedUrlSchema;
+        }
+
+        throw new InvalidUrlException(sprintf('The URL %s is not valid', $this->rawUrl));
+    }
+
+    public function isThumbnailSizeAvailable($intendedSize)
+    {
+        return in_array($intendedSize, $this->getThumbNailSizes());
     }
 }
diff --git a/src/Adapter/Dailymotion/DailymotionServiceAdapter.php b/src/Adapter/Dailymotion/DailymotionServiceAdapter.php
@@ -8,7 +8,7 @@
 namespace RicardoFiorani\Adapter\Dailymotion;
 
 use RicardoFiorani\Adapter\AbstractServiceAdapter;
-use RicardoFiorani\Exception\InvalidThumbnailSizeException;
+use RicardoFiorani\Adapter\Exception\InvalidThumbnailSizeException;
 use RicardoFiorani\Renderer\EmbedRendererInterface;
 
 class DailymotionServiceAdapter extends AbstractServiceAdapter
@@ -68,6 +68,7 @@ public function getThumbNailSizes()
      *
      * @return string
      * @throws InvalidThumbnailSizeException
+     * @throws \RicardoFiorani\Adapter\Exception\InvalidUrlException
      */
     public function getThumbnail($size, $forceSecure = false)
     {
@@ -84,6 +85,7 @@ public function getThumbnail($size, $forceSecure = false)
      * @param bool $forceSecure
      * @return string
      * @throws InvalidThumbnailSizeException
+     * @throws \RicardoFiorani\Adapter\Exception\InvalidUrlException
      */
     public function getSmallThumbnail($forceSecure = false)
     {
@@ -97,6 +99,7 @@ public function getSmallThumbnail($forceSecure = false)
      * @param bool $forceSecure
      * @return string
      * @throws InvalidThumbnailSizeException
+     * @throws \RicardoFiorani\Adapter\Exception\InvalidUrlException
      */
     public function getMediumThumbnail($forceSecure = false)
     {
@@ -110,6 +113,7 @@ public function getMediumThumbnail($forceSecure = false)
      * @param bool $forceSecure
      * @return string
      * @throws InvalidThumbnailSizeException
+     * @throws \RicardoFiorani\Adapter\Exception\InvalidUrlException
      */
     public function getLargeThumbnail($forceSecure = false)
     {
@@ -122,6 +126,7 @@ public function getLargeThumbnail($forceSecure = false)
      * @param bool $forceSecure
      * @return string
      * @throws InvalidThumbnailSizeException
+     * @throws \RicardoFiorani\Adapter\Exception\InvalidUrlException
      */
     public function getLargestThumbnail($forceSecure = false)
     {
@@ -133,6 +138,7 @@ public function getLargestThumbnail($forceSecure = false)
      * @param bool $forceAutoplay
      * @param bool $forceSecure
      * @return string
+     * @throws \RicardoFiorani\Adapter\Exception\InvalidUrlException
      */
     public function getEmbedUrl($forceAutoplay = false, $forceSecure = false)
     {
diff --git a/src/Adapter/Exception/InvalidThumbnailSizeException.php b/src/Adapter/Exception/InvalidThumbnailSizeException.php
@@ -5,7 +5,7 @@
  * Date: 29/08/2015
  * Time: 20:17.
  */
-namespace RicardoFiorani\Exception;
+namespace RicardoFiorani\Adapter\Exception;
 
 use Exception;
 
diff --git a/src/Adapter/Exception/InvalidUrlException.php b/src/Adapter/Exception/InvalidUrlException.php
@@ -0,0 +1,12 @@
+<?php
+/**
+ * @author Ricardo Fiorani
+ */
+
+namespace RicardoFiorani\Adapter\Exception;
+
+use Exception;
+
+class InvalidUrlException extends Exception
+{
+}
diff --git a/src/Adapter/Exception/NotEmbeddableException.php b/src/Adapter/Exception/NotEmbeddableException.php
@@ -5,7 +5,7 @@
  * Date: 30/08/2015
  * Time: 01:25.
  */
-namespace RicardoFiorani\Exception;
+namespace RicardoFiorani\Adapter\Exception;
 
 use Exception;
 
diff --git a/src/Adapter/Exception/ServiceApiNotAvailable.php b/src/Adapter/Exception/ServiceApiNotAvailable.php
@@ -5,7 +5,7 @@
  * Date: 10/02/2016
  * Time: 18:13.
  */
-namespace RicardoFiorani\Exception;
+namespace RicardoFiorani\Adapter\Exception;
 
 use Exception;
 
diff --git a/src/Adapter/Facebook/FacebookServiceAdapter.php b/src/Adapter/Facebook/FacebookServiceAdapter.php
@@ -8,7 +8,7 @@
 namespace RicardoFiorani\Adapter\Facebook;
 
 use RicardoFiorani\Adapter\AbstractServiceAdapter;
-use RicardoFiorani\Exception\InvalidThumbnailSizeException;
+use RicardoFiorani\Adapter\Exception\InvalidThumbnailSizeException;
 use RicardoFiorani\Exception\ThumbnailSizeNotAvailable;
 use RicardoFiorani\Renderer\EmbedRendererInterface;
 
diff --git a/src/Adapter/Vimeo/VimeoServiceAdapter.php b/src/Adapter/Vimeo/VimeoServiceAdapter.php
@@ -8,8 +8,9 @@
 namespace RicardoFiorani\Adapter\Vimeo;
 
 use RicardoFiorani\Adapter\AbstractServiceAdapter;
-use RicardoFiorani\Exception\InvalidThumbnailSizeException;
-use RicardoFiorani\Exception\ServiceApiNotAvailable;
+use RicardoFiorani\Adapter\Exception\InvalidThumbnailSizeException;
+use RicardoFiorani\Adapter\Exception\InvalidUrlException;
+use RicardoFiorani\Adapter\Exception\ServiceApiNotAvailable;
 use RicardoFiorani\Renderer\EmbedRendererInterface;
 
 class VimeoServiceAdapter extends AbstractServiceAdapter
@@ -37,6 +38,7 @@ class VimeoServiceAdapter extends AbstractServiceAdapter
      * @param string $url
      * @param string $pattern
      * @param EmbedRendererInterface $renderer
+     * @throws ServiceApiNotAvailable
      */
     public function __construct($url, $pattern, EmbedRendererInterface $renderer)
     {
@@ -120,10 +122,11 @@ private function setThumbnails(array $thumbnails)
 
     /**
      * @param string $size
-     *
+     * @param bool $forceSecure
      * @return string
      *
      * @throws InvalidThumbnailSizeException
+     * @throws InvalidUrlException
      */
     public function getThumbnail($size, $forceSecure = false)
     {
@@ -143,6 +146,7 @@ public function getThumbnail($size, $forceSecure = false)
      * @param bool $forceAutoplay
      *
      * @return string
+     * @throws InvalidUrlException
      */
     public function getEmbedUrl($forceAutoplay = false, $forceSecure = false)
     {
@@ -169,6 +173,7 @@ public function getThumbNailSizes()
      * @param bool $forceSecure
      * @return string
      * @throws InvalidThumbnailSizeException
+     * @throws InvalidUrlException
      */
     public function getSmallThumbnail($forceSecure = false)
     {
@@ -181,6 +186,7 @@ public function getSmallThumbnail($forceSecure = false)
      * @param bool $forceSecure
      * @return string
      * @throws InvalidThumbnailSizeException
+     * @throws InvalidUrlException
      */
     public function getMediumThumbnail($forceSecure = false)
     {
@@ -191,9 +197,9 @@ public function getMediumThumbnail($forceSecure = false)
      * Returns the large thumbnail's url.
      *
      * @param bool $forceSecure
-     * @param $forceSecure
      * @return string
      * @throws InvalidThumbnailSizeException
+     * @throws InvalidUrlException
      */
     public function getLargeThumbnail($forceSecure = false)
     {
@@ -204,9 +210,9 @@ public function getLargeThumbnail($forceSecure = false)
      * Returns the largest thumnbnaail's url.
      *
      * @param bool $forceSecure
-     * @param $forceSecure
      * @return string
      * @throws InvalidThumbnailSizeException
+     * @throws InvalidUrlException
      */
     public function getLargestThumbnail($forceSecure = false)
     {
@@ -249,7 +255,10 @@ private function getVideoDataFromServiceApi()
     {
         $contents = file_get_contents('http://vimeo.com/api/v2/video/' . $this->getVideoId() . '.php');
         if (false === $contents) {
-            throw new ServiceApiNotAvailable('Vimeo Service Adapter could not reach Vimeo API Service. Check if your server has file_get_contents() function available.');
+            throw new ServiceApiNotAvailable(
+                'Service "%s" could not reach it\'s API. Check if file_get_contents() function is available.',
+                $this->getServiceName()
+            );
         }
         $hash = unserialize($contents);
 
diff --git a/src/Adapter/Youtube/YoutubeServiceAdapter.php b/src/Adapter/Youtube/YoutubeServiceAdapter.php
@@ -9,7 +9,7 @@
 namespace RicardoFiorani\Adapter\Youtube;
 
 use RicardoFiorani\Adapter\AbstractServiceAdapter;
-use RicardoFiorani\Exception\InvalidThumbnailSizeException;
+use RicardoFiorani\Adapter\Exception\InvalidThumbnailSizeException;
 use RicardoFiorani\Renderer\EmbedRendererInterface;
 
 class YoutubeServiceAdapter extends AbstractServiceAdapter
diff --git a/src/Container/Exception/DuplicatedServiceNameException.php b/src/Container/Exception/DuplicatedServiceNameException.php
@@ -5,7 +5,7 @@
  * Date: 29/08/2015
  * Time: 23:28.
  */
-namespace RicardoFiorani\Exception;
+namespace RicardoFiorani\Container\Exception;
 
 use Exception;
 
diff --git a/src/Container/ServicesContainer.php b/src/Container/ServicesContainer.php
@@ -8,7 +8,7 @@
 namespace RicardoFiorani\Container;
 
 use RicardoFiorani\Adapter\CallableServiceAdapterFactoryInterface;
-use RicardoFiorani\Exception\DuplicatedServiceNameException;
+use RicardoFiorani\Container\Exception\DuplicatedServiceNameException;
 use RicardoFiorani\Renderer\EmbedRendererInterface;
 
 class ServicesContainer
@@ -47,6 +47,7 @@ class ServicesContainer
      * ServicesContainer constructor.
      *
      * @param array $config
+     * @throws DuplicatedServiceNameException
      */
     public function __construct(array $config = array())
     {
@@ -82,7 +83,9 @@ private function registerFromConfig(array $config)
     public function registerService($serviceName, array $regex, $factory)
     {
         if ($this->hasService($serviceName)) {
-            throw new DuplicatedServiceNameException();
+            throw new DuplicatedServiceNameException(
+                'The service "%s" is already registered in the container.', $serviceName
+            );
         }
 
         $this->services[] = $serviceName;
diff --git a/src/Matcher/Exception/VideoServiceNotCompatibleException.php b/src/Matcher/Exception/VideoServiceNotCompatibleException.php
@@ -5,10 +5,10 @@
  * Date: 29/08/2015
  * Time: 23:44.
  */
-namespace RicardoFiorani\Exception;
+namespace RicardoFiorani\Matcher\Exception;
 
 use Exception;
 
-class ServiceNotAvailableException extends Exception
+class VideoServiceNotCompatibleException extends Exception
 {
 }
diff --git a/src/Matcher/VideoServiceMatcher.php b/src/Matcher/VideoServiceMatcher.php
@@ -5,7 +5,7 @@
 use RicardoFiorani\Adapter\VideoAdapterInterface;
 use RicardoFiorani\Container\Factory\ServicesContainerFactory;
 use RicardoFiorani\Container\ServicesContainer;
-use RicardoFiorani\Exception\ServiceNotAvailableException;
+use RicardoFiorani\Matcher\Exception\VideoServiceNotCompatibleException;
 
 /**
  * @author Ricardo Fiorani
@@ -35,13 +35,14 @@ public function __construct()
      *
      * @return VideoAdapterInterface
      *
-     * @throws ServiceNotAvailableException
+     * @throws VideoServiceNotCompatibleException
      */
     public function parse($url)
     {
         if (isset($this->parsedUrls[$url])) {
             return $this->parsedUrls[$url];
         }
+
         /** @var array $patterns */
         /** @var string $serviceName */
         foreach ($this->getServiceContainer()->getPatterns() as $serviceName => $patterns) {
@@ -55,8 +56,10 @@ public function parse($url)
                 }
             }
         }
-        throw new ServiceNotAvailableException(sprintf('The url "%s" could not be parsed by any of the services available.',
-            $url));
+
+        throw new VideoServiceNotCompatibleException(
+            sprintf('The url "%s" could not be parsed by any of the services available.', $url)
+        );
     }
 
     /**
diff --git a/test/Adapter/AbstractServiceAdapterTest.php b/test/Adapter/AbstractServiceAdapterTest.php
@@ -10,7 +10,7 @@
 
 use PHPUnit_Framework_TestCase;
 use RicardoFiorani\Adapter\Facebook\FacebookServiceAdapter;
-use RicardoFiorani\Exception\ServiceNotAvailableException;
+use RicardoFiorani\Matcher\Exception\VideoServiceNotCompatibleException;
 use RicardoFiorani\Matcher\VideoServiceMatcher;
 use RicardoFiorani\Renderer\DefaultRenderer;
 
@@ -116,7 +116,7 @@ public function exampleUrlDataProvider()
     /**
      * @param $url
      * @return FacebookServiceAdapter
-     * @throws ServiceNotAvailableException
+     * @throws VideoServiceNotCompatibleException
      */
     public function getMockingObject($url)
     {
diff --git a/test/Adapter/DailymotionServiceAdapterTest.php b/test/Adapter/DailymotionServiceAdapterTest.php
@@ -11,7 +11,7 @@
 use PHPUnit_Framework_TestCase;
 use RicardoFiorani\Adapter\Dailymotion\DailymotionServiceAdapter;
 use RicardoFiorani\Matcher\VideoServiceMatcher;
-use RicardoFiorani\Exception\ServiceNotAvailableException;
+use RicardoFiorani\Matcher\Exception\VideoServiceNotCompatibleException;
 
 
 class DailymotionServiceAdapterTest extends PHPUnit_Framework_TestCase
@@ -69,7 +69,7 @@ public function testIfGetThumbnailIsString($url)
     public function testThrowsExceptionOnRequestThumbnailWithAnInvalidSize($url)
     {
         $dailymotionVideo = $this->getMockingObject($url);
-        $this->setExpectedException('\\RicardoFiorani\\Exception\\InvalidThumbnailSizeException');
+        $this->setExpectedException('\\RicardoFiorani\\Adapter\\Exception\\InvalidThumbnailSizeException');
         $dailymotionVideo->getThumbnail('This Size does not exists :)');
     }
 
@@ -122,7 +122,7 @@ public function exampleUrlDataProvider()
     /**
      * @param $url
      * @return DailymotionServiceAdapter
-     * @throws ServiceNotAvailableException
+     * @throws VideoServiceNotCompatibleException
      */
     public function getMockingObject($url)
     {
diff --git a/test/Adapter/FacebookServiceAdapterTest.php b/test/Adapter/FacebookServiceAdapterTest.php
diff --git a/test/Adapter/VimeoServiceAdapterTest.php b/test/Adapter/VimeoServiceAdapterTest.php
diff --git a/test/Adapter/YoutubeServiceAdapterTest.php b/test/Adapter/YoutubeServiceAdapterTest.php
diff --git a/test/Container/ServicesContainerTest.php b/test/Container/ServicesContainerTest.php
diff --git a/test/Detector/VideoServiceMatcherTest.php b/test/Detector/VideoServiceMatcherTest.php
