Update readme

Author: nsaliu

.gitignore

@@ -0,0 +1,3 @@
+vendor
+composer.lock
+.phpunit.result.cache

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2020 Nicola Saliu, https://github.com/nsaliu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,270 @@
+# Laravel URI package
+
+[![MIT Licensed](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
+![PHP from Packagist](https://img.shields.io/packagist/php-v/nsaliu/laravel-uri?label=php&style=flat-square)
+![GitHub repo size](https://img.shields.io/github/repo-size/nsaliu/laravel-uri?style=flat-square)
+
+A simple and useful URI package for Laravel framework.
+
+## Installation
+
+This package requires PHP 7.2 and Laravel 5.8 or higher.
+
+Install with composer: 
+
+``` composer require nsaliu/laravel-uri ```
+
+## Methods
+
+### createFromString
+
+Creates a new instance with the specified URI. 
+
+```
+$uri = new Uri();
+$uri->createFromString('https://test.test');
+```
+
+### getScheme
+
+Return the scheme part of the URI.
+
+```
+$uri = new Uri();
+$uri->createFromString('https://test.test');
+$uri->getScheme();
+```
+
+Return the scheme part of URI: ```https```
+
+### getUsername
+
+Return the user part from the URI.
+
+```
+$uri = new Uri();
+$uri->createFromString('https://fakeuser:fakepass@test.test');
+$uri->getUsername();
+```
+
+If a user is set returns ```fakeuser```, otherwise return an empty string.
+
+### getPassword
+
+Return the pass part from the URI.
+
+```
+$uri = new Uri();
+$uri->createFromString('https://fakeuser:fakepass@test.test');
+$uri->getPassword();
+```
+
+If a password is set return ```fakepass```, otherwise return an empty string.
+
+### getAuthority
+
+Return the authority part of the URI.
+
+```
+$uri = new Uri();
+$uri->createFromString('https://fakeuser:fakepass@test.test');
+$uri->getAuthority();
+```
+
+If no authority information is present, this method return an ```empty string```.
+
+If authority is set return it in form of: ```jhon:doe@test.com```. 
+
+If the port is a standard port for scheme, the port is not included, otherwise yes. 
+
+Example:
+
+```
+// Create a URI with 'https' scheme and '80' as port (not default for https) 
+$uri = new Uri();
+$uri->createFromString('https://fakeuser:fakepass@test.test');
+$uri->getAuthority();
+```
+
+Results in: ```jhon:doe@test.com:80```
+
+### getAuthorityWithPort
+
+Return the authority part of the URI with the port too, even if it's the default.
+
+```
+$uri = new Uri();
+$uri->createFromString('https://fakeuser:fakepass@test.test:443');
+$uri->getAuthorityWithPort();
+```
+
+Return: ```jhon:doe@test.com:443```
+
+### getUserInfo
+
+Return the user part of the URI.
+
+```
+$uri = new Uri();
+$uri->createFromString('https://fakeuser:fakepass@test.test:443');
+$uri->getUserInfo();
+```
+
+Return:
+- if no user information is present return an empty string.
+- if a user is present in the URI returns that value: ```fakeuser```
+- if a password is present it returns the password too separated by ':' from the username: ```fakeuser:fakepass```
+
+### getHost
+
+Return the host part of the URI.
+
+```
+$uri = new Uri();
+$uri->createFromString('https://test.test:443');
+$uri->getHost();
+```
+
+Results in: ```test.test```
+
+### getPort
+
+Return the port part of the URI.
+
+```
+$uri = new Uri();
+$uri->createFromString('https://fakeuser:fakepass@test.test:443');
+$uri->getPort();
+```
+Return:
+- if the port is present return the port as an integer: ```443```. 
+- if the port is not present, return ```null```.
+
+### isDefaultPort
+
+Get whether the port value of the URI is the default for given scheme.
+
+```
+$uri = new Uri();
+$uri->createFromString('https://fakeuser:fakepass@test.test:80');
+$uri->isDefaultPort();
+
+// return false because 80 isn't the default port for https scheme 
+```
+
+Return:
+- ```true``` if the port is default for this scheme.
+- ```false``` if the port isn't the default.
+
+### getPath
+
+Get the path value of the URI.
+
+```
+$uri = new Uri();
+$uri->createFromString('https://test.test/path1/path2/page.html');
+$uri->getPath();
+```
+
+Return:
+- if a path is present return ```/path1/path2/page.html```.
+- if the path is not present return an ```empty string```.
+
+### getPathAsArray
+
+Get the path value of the URI as an array.
+
+```
+$uri = new Uri();
+$uri->createFromString('https://test.test/path1/path2/page.html');
+$uri->getPathAsArray();
+```
+
+Return:
+- if the path is present return the path portion of the URI as an array:
+```
+[
+    'path1',
+    'path2',
+    'page.html',    
+]
+```
+- if path is not present return an ```empty string```.
+
+### getQuery
+
+Get the query part of the URI.
+
+```
+$uri = new Uri();
+$uri->createFromString('https://test.test/path1/path2/page.html?key1=value1&key2=value2');
+$uri->getQuery();
+```
+
+Return:
+- if the query part of the URI is present: ```key1=value1&key2=value2```.
+- if the query part of the URI is not present return an ```empty string```.
+
+### getQueryValue
+
+Get the query value given a query key.
+
+```
+$uri = new Uri();
+$uri->createFromString('https://test.test/path1/path2/page.html?key1=value1&key2=value2');
+$uri->getQueryValue('key1');
+```
+
+Return:
+- if the key exists in query part return: ```value1```.
+- if the key not exists in query part return an ```empty string```.
+
+### getQueryAsArray
+
+Get the query part as an array.
+
+```
+$uri = new Uri();
+$uri->createFromString('https://test.test/path1/path2/page.html?key1=value1&key2=value2');
+$uri->getQueryAsArray();
+```
+
+Return:
+- if the query part exists return:
+```
+[
+    'key1' => 'value1',
+    'key2' => 'value2',
+]
+```
+- if the query part not exists return an ```empty array```.
+
+### getPathAndQuery
+
+Get the path and query part of the URI.
+
+```
+$uri = new Uri();
+$uri->createFromString('https://test.test/path1/path2/page.html?key1=value1&key2=value2');
+$uri->getPathAndQuery();
+```
+
+Return:
+- if the path and query exists return ```/path1/path2/page.html?key1=value1&key2=value2```.
+- if the path exists and query not exists return ```/path1/path2/page.html```.
+- if the path not exists and query too return an ```empty string```.
+
+### getFragment
+
+Get the fragment part of the URI.
+
+```
+$uri = new Uri();
+$uri->createFromString('https://test.test/path1/path2/page.html?key1=value1&key2=value2#fragment-1');
+$uri->getFragment();
+```
+
+Return:
+- if the path and query exists return ```/path1/path2/page.html?key1=value1&key2=value2```.
+- if the path exists and query not exists return ```/path1/path2/page.html```.
+- if the path not exists and query too return an ```empty string```.

composer.json

@@ -0,0 +1,38 @@
+{
+    "name": "nsaliu/laravel-uri",
+    "description": "A URI component for Laravel framework",
+    "homepage": "https://github.com/nsaliu/laravel-uri",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Nicola Saliu",
+            "email": "nicola.saliu@gmail.com",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php" : "^7.2"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^8.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Nsaliu\\Uri\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Nsaliu\\Uri\\Tests\\": "tests/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Nsaliu\\Uri\\UriComponentServiceProvider"
+            ]
+        }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
+}

phpunit.xml.dist

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         verbose="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="URI Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+    <php>
+        <env name="CACHE_DRIVER" value="array"/>
+    </php>
+</phpunit>

src/CurlWrapper.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Nsaliu\Uri;
+
+use Nsaliu\Uri\Exceptions\CurlExtensionNotLoaded;
+
+class CurlWrapper
+{
+    /**
+     * @param string $uri
+     * @return int
+     * @throws CurlExtensionNotLoaded
+     */
+    public function getReturnCode(string $uri): int
+    {
+        if (!extension_loaded('curl')) {
+            throw new CurlExtensionNotLoaded();
+        }
+
+        $ch = \curl_init($uri);
+
+        \curl_setopt($ch, CURLOPT_NOBODY, true);
+        \curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
+        \curl_exec($ch);
+
+        $returnCode = \curl_getinfo($ch, CURLINFO_HTTP_CODE);
+        \curl_close($ch);
+
+        return (int)$returnCode;
+    }
+}

src/Exceptions/CurlExtensionNotLoaded.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Nsaliu\Uri\Exceptions;
+
+class CurlExtensionNotLoaded extends \Exception
+{
+    /**
+     * @var string
+     */
+    protected $message = 'cURL extension is not loaded';
+}

src/Exceptions/InvalidUriException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Nsaliu\Uri\Exceptions;
+
+class InvalidUriException extends \Exception
+{
+    protected $message = 'Given URI is invalid';
+}

src/Exceptions/PortOutOfRangeException.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Nsaliu\Uri\Exceptions;
+
+use Throwable;
+
+class PortOutOfRangeException extends \Exception
+{
+    /**
+     * @var string
+     */
+    protected $message = "A valid port must be between 0 and 65535, [%s] given";
+
+    /**
+     * PortOutOfRangeException constructor.
+     * @param int $port
+     * @param int $code
+     * @param Throwable|null $previous
+     */
+    public function __construct(int $port, $code = 0, Throwable $previous = null)
+    {
+        parent::__construct(sprintf($this->message, $port), $code, $previous);
+    }
+}

src/Exceptions/QueryCannotContainFragmentException.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Nsaliu\Uri\Exceptions;
+
+class QueryCannotContainFragmentException extends \Exception
+{
+    /**
+     * @var string
+     */
+    protected $message = 'Query can not contains fragment parts';
+}

src/Exceptions/QueryKeyAlreadyExistsException.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Nsaliu\Uri\Exceptions;
+
+use Throwable;
+
+class QueryKeyAlreadyExistsException extends \Exception
+{
+    /**
+     * @var string
+     */
+    protected $message = 'Given query key [%s] already exists';
+
+    /**
+     * QueryKeyAlreadyExists constructor.
+     * @param string $key
+     * @param int $code
+     * @param Throwable|null $previous
+     */
+    public function __construct(string $key, $code = 0, Throwable $previous = null)
+    {
+        parent::__construct(sprintf($this->message, $key), $code, $previous);
+    }
+}

src/Exceptions/QueryKeyMustHaveAtLeastOneCharException.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Nsaliu\Uri\Exceptions;
+
+class QueryKeyMustHaveAtLeastOneCharException extends \Exception
+{
+    /**
+     * @var string
+     */
+    protected $message = 'Query key must have at least one character';
+}

src/Uri.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Nsaliu\Uri;
+
+use Illuminate\Support\ServiceProvider;
+
+class UriComponentServiceProvider extends ServiceProvider
+{
+    /**
+     * Register services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        //
+    }
+
+    /**
+     * Bootstrap services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        //
+    }
+}

src/UriComponentServiceProvider.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Nsaliu\Uri\Tests;
+
+use Nsaliu\Uri\CurlWrapper;
+use PHPUnit\Framework\TestCase;
+
+class CurlWrapperTest extends TestCase
+{
+    /**
+     * @var CurlWrapper
+     */
+    private $sut;
+
+    protected function setUp(): void
+    {
+        $this->sut = $this->createMock(CurlWrapper::class);
+    }
+
+    public function testGetReturnCode()
+    {
+        $uri = 'https://github.com';
+
+        $this->sut
+            ->expects($this->once())
+            ->method('getReturnCode')
+            ->with($uri)
+            ->willReturn(200);
+
+        $this->assertEquals(200, $this->sut->getReturnCode($uri));
+    }
+}