shortener/shorty

Google Url Shortener API Package for Laravel 5.1

Shorty

![Software License][ico-license] , _(*1)

Google Url Shortener API Package for Laravel 5.*. Library to shorten URLs, expand URLs, and get stats for shortened URLs. e.g. goo.gl/XXXXX, _(*2)

Installation

To install, run the following in your project directory, _(*3)

``` bash $ composer require mbarwick83/shorty, <sub>(*4)</sub>

Then in `config/app.php` add the following to the `providers` array:

Mbarwick83\Shorty\ShortyServiceProvider::class, <sub>(*5)</sub>

Also in `config/app.php`, add the Facade class to the `aliases` array:

'Shorty' => Mbarwick83\Shorty\Facades\Shorty::class, <sub>(*6)</sub>

## Configuration

To publish Shorty's configuration file, run the following `vendor:publish` command:

php artisan vendor:publish --provider="Mbarwick83\Shorty\ShortyServiceProvider", <sub>(*7)</sub>

This will create a shorty.php in your config directory. Here you **must** enter your Google Shortener URL API Key. Get an API key at [https://developers.google.com/url-shortener/v1/getting_started#APIKey](https://developers.google.com/url-shortener/v1/getting_started#APIKey).

## Usage

**Be sure to include the namespace for the class wherever you plan to use this library**

use Mbarwick83\Shorty\Facades\Shorty;, <sub>(*8)</sub>

#####To shorten a URL:

``` php
$url = "http://google.com";

Shorty::shorten($url);

// returns, http://goo.gl/XXXXX

To expand a shortened URL:

``` php $url = "http://goo.gl/XXXXX";, <sub>(*9)</sub>

Shorty::expand($url);, <sub>(*10)</sub>

// returns, http://google.com, <sub>(*11)</sub>

#####To get stats on shortened URL:

``` php
$url = "http://goo.gl/XXXXX";

Shorty::stats($url);

If successful, stats response will return:, <sub>(*12)</sub>

{
 "kind": "urlshortener#url",
 "id": "http://goo.gl/fbsS",
 "longUrl": "http://www.google.com/",
 "status": "OK",
 "created": "2009-12-13T07:22:55.000+00:00",
 "analytics": {
  "allTime": {
   "shortUrlClicks": "3227",
   "longUrlClicks": "9358",
   "referrers": [ { "count": "2160", "id": "Unknown/empty" } /* , ... */ ],
   "countries": [ { "count": "1022", "id": "US" } /* , ... */ ],
   "browsers": [ { "count": "1025", "id": "Firefox" } /* , ... */ ],
   "platforms": [ { "count": "2278", "id": "Windows" } /* , ... */ ]
  },
  "month": { /* ... */ },
  "week": { /* ... */ },
  "day": { /* ... */ },
  "twoHours": { /* ... */ }
 }
}

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*13)</sub>

Testing

bash $ composer test, <sub>(*14)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*15)</sub>

Security

If you discover any security related issues, please email :author_email instead of using the issue tracker., <sub>(*16)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*17)</sub>