update 1.0.8.0

Commits for version update

vendor/mremi/url-shortener/README.md

@@ -0,0 +1,148 @@
+URL shortener library
+=====================
+
+This library allows you to shorten a URL, reverse is also possible.
+
+[![SensioLabsInsight](https://insight.sensiolabs.com/projects/c4e06c9d-547c-47bb-8abb-fccc68b7df7a/big.png)](https://insight.sensiolabs.com/projects/c4e06c9d-547c-47bb-8abb-fccc68b7df7a)
+
+[![Build Status](https://api.travis-ci.org/mremi/UrlShortener.png?branch=master)](https://travis-ci.org/mremi/UrlShortener)
+[![Total Downloads](https://poser.pugx.org/mremi/url-shortener/downloads.png)](https://packagist.org/packages/mremi/url-shortener)
+[![Latest Stable Version](https://poser.pugx.org/mremi/url-shortener/v/stable.png)](https://packagist.org/packages/mremi/url-shortener)
+[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/mremi/UrlShortener/badges/quality-score.png?s=34c4ba6b0cd272673fa121c32a63e1ce668b9b2a)](https://scrutinizer-ci.com/g/mremi/UrlShortener/)
+[![Code Coverage](https://scrutinizer-ci.com/g/mremi/UrlShortener/badges/coverage.png?s=7a8c3388ae7b50f35fd548b4b7874526c634e8c5)](https://scrutinizer-ci.com/g/mremi/UrlShortener/)
+
+**Basic Docs**
+
+* [Installation](#installation)
+* [Bit.ly API](#bitly-api)
+* [Google API](#google-api)
+* [Chain providers](#chain-providers)
+* [Retrieve link](#retrieve-link)
+* [Contribution](#contribution)
+
+<a name="installation"></a>
+
+## Installation
+
+Only 1 step:
+
+### Download UrlShortener using composer
+
+Add UrlShortener in your composer.json:
+
+```js
+{
+    "require": {
+        "mremi/url-shortener": "dev-master"
+    }
+}
+```
+
+Now tell composer to download the library by running the command:
+
+``` bash
+$ php composer.phar update mremi/url-shortener
+```
+
+Composer will install the library to your project's `vendor/mremi` directory.
+
+<a name="bitly-api"></a>
+
+## Bit.ly API
+
+```php
+<?php
+
+use Mremi\UrlShortener\Model\Link;
+use Mremi\UrlShortener\Provider\Bitly\BitlyProvider;
+use Mremi\UrlShortener\Provider\Bitly\OAuthClient;
+
+$link = new Link;
+$link->setLongUrl('http://www.google.com');
+
+$bitlyProvider = new BitlyProvider(
+    new OAuthClient('username', 'password'),
+    array('connect_timeout' => 1, 'timeout' => 1)
+);
+
+$bitlyProvider->shorten($link);
+
+$bitlyProvider->expand($link);
+```
+
+<a name="google-api"></a>
+
+## Google API
+
+```php
+<?php
+
+use Mremi\UrlShortener\Model\Link;
+use Mremi\UrlShortener\Provider\Google\GoogleProvider;
+
+$link = new Link;
+$link->setLongUrl('http://www.google.com');
+
+$googleProvider = new GoogleProvider(
+    'api_key',
+    array('connect_timeout' => 1, 'timeout' => 1)
+);
+
+$googleProvider->shorten($link);
+
+$googleProvider->expand($link);
+```
+
+<a name="chain-providers"></a>
+
+## Chain providers
+
+```php
+<?php
+
+use Mremi\UrlShortener\Model\Link;
+use Mremi\UrlShortener\Provider\ChainProvider;
+
+$chainProvider = new ChainProvider;
+$chainProvider->addProvider($bitlyProvider);
+$chainProvider->addProvider($googleProvider);
+// add yours...
+
+$link = new Link;
+$link->setLongUrl('http://www.google.com');
+
+$chainProvider->getProvider('bitly')->shorten($link);
+
+$chainProvider->getProvider('google')->expand($link);
+```
+
+<a name="retrieve-link"></a>
+
+## Retrieve link
+
+You can retrieve some links using these finders:
+
+```php
+<?php
+
+use Mremi\UrlShortener\Model\LinkManager;
+
+$linkManager = new LinkManager($chainProvider);
+
+$shortened = $linkManager->findOneByProviderAndShortUrl('bitly', 'http://bit.ly/ze6poY');
+
+$expanded = $linkManager->findOneByProviderAndLongUrl('google', 'http://www.google.com');
+```
+
+<a name="contribution"></a>
+
+## Contribution
+
+Any question or feedback? Open an issue and I will try to reply quickly.
+
+A feature is missing here? Feel free to create a pull request to solve it!
+
+I hope this has been useful and has helped you. If so, share it and recommend
+it! :)
+
+[@mremitsme](https://twitter.com/mremitsme)