Skip to content
This repository has been archived by the owner on Aug 24, 2022. It is now read-only.

Commit

Permalink
Added .gitattributes for lineendings normalization and included featu…
Browse files Browse the repository at this point in the history
…re add for #3 in the readme.
  • Loading branch information
jelovac committed Apr 12, 2014
1 parent 39e2230 commit e96caf8
Show file tree
Hide file tree
Showing 2 changed files with 121 additions and 118 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Set default behaviour, in case users don't have core.autocrlf set.
* text=auto
237 changes: 119 additions & 118 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,119 +1,120 @@
bitly4laravel
=============
[![Build Status](https://travis-ci.org/jelovac/bitly4laravel.png?branch=master)](https://travis-ci.org/jelovac/bitly4laravel) [![Latest Stable Version](https://poser.pugx.org/jelovac/bitly4laravel/v/stable.png)](https://packagist.org/packages/jelovac/bitly4laravel) [![Total Downloads](https://poser.pugx.org/jelovac/bitly4laravel/downloads.png)](https://packagist.org/packages/jelovac/bitly4laravel) [![Latest Unstable Version](https://poser.pugx.org/jelovac/bitly4laravel/v/unstable.png)](https://packagist.org/packages/jelovac/bitly4laravel) [![License](https://poser.pugx.org/jelovac/bitly4laravel/license.png)](https://packagist.org/packages/jelovac/bitly4laravel)

Provides basic bitly API to use with Laravel 4.

In order to use this API you need to get [OAuth Generic Access Token](https://bitly.com/a/oauth_apps) from Bitly website.

Instalation
===========

Add bitly4laravel to your composer.json file.

require : {
"laravel/framework": "4.1.*",
"jelovac/bitly4laravel": "dev-master"
}

Or with composer command:

composer require "jelovac/bitly4laravel": "dev-master"

Add provider to your app/config/app.php providers

'Jelovac\Bitly4laravel\Bitly4laravelServiceProvider',

Publish config

php artisan config:publish jelovac/bitly4laravel

Optional (recommended)
======================

Add alias to app/config/app.php aliases

'Bitly' => 'Jelovac\Bitly4laravel\Facades\Bitly4laravel',

Usage
=====

Shorten links

Bitly::shorten('http://spea.rs')->getResponseData();
Output: array

Array
(
[status_code] => 200
[status_txt] => OK
[data] => Array
(
[url] => http://bit.ly/9PCy42
[hash] => 9PCy42
[global_hash] => 25iRBL
[long_url] => http://www.betaworks.com
[new_hash] => 0
)
)

Expand links

Bitly::expand('http://bit.ly/1RmnUT')->getResponseData();

Output: array

Array
(
[status_code] => 200
[status_txt] => OK
[data] => Array
(
[entry] => Array
(
[short_url] => http://bit.ly/1RmnUT
[long_url] => http://google.com
[user_hash] => 1RmnUT
[global_hash] => 1RmnUT
)

)
)

To specifiy alternative Access Token, Format or VariableOutput you have following public setters which can be chained.

Bitly::setAccessToken('my-access-token')
->setFormat('json')
->setVariableOutput('array')
->expand('http://bit.ly/1RmnUT')
->getResponseData();

About
=====

Converted bitly-url-shortener yii framework extension to a Laravel package.

The original YII extension you can download here:
http://www.yiiframework.com/extension/bitly-url-shortener

Credits
=======

bitly-url-shortener - [Vadim Gabriel](https://github.com/VinceG "Github profile")

bitly4laravel - [Vladimir Jelovac](https://github.com/jelovac "Github profile")

License
=======

Copyright (c) 2013, Vladimir Jelovac
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

bitly4laravel
=============
[![Build Status](https://travis-ci.org/jelovac/bitly4laravel.png?branch=master)](https://travis-ci.org/jelovac/bitly4laravel) [![Latest Stable Version](https://poser.pugx.org/jelovac/bitly4laravel/v/stable.png)](https://packagist.org/packages/jelovac/bitly4laravel) [![Total Downloads](https://poser.pugx.org/jelovac/bitly4laravel/downloads.png)](https://packagist.org/packages/jelovac/bitly4laravel) [![Latest Unstable Version](https://poser.pugx.org/jelovac/bitly4laravel/v/unstable.png)](https://packagist.org/packages/jelovac/bitly4laravel) [![License](https://poser.pugx.org/jelovac/bitly4laravel/license.png)](https://packagist.org/packages/jelovac/bitly4laravel)

Provides basic bitly API to use with Laravel 4.

In order to use this API you need to get [OAuth Generic Access Token](https://bitly.com/a/oauth_apps) from Bitly website.

Instalation
===========

Add bitly4laravel to your composer.json file.

require : {
"laravel/framework": "4.1.*",
"jelovac/bitly4laravel": "dev-master"
}

Or with composer command:

composer require "jelovac/bitly4laravel": "dev-master"

Add provider to your app/config/app.php providers

'Jelovac\Bitly4laravel\Bitly4laravelServiceProvider',

Publish config

php artisan config:publish jelovac/bitly4laravel

Optional (recommended)
======================

Add alias to app/config/app.php aliases

'Bitly' => 'Jelovac\Bitly4laravel\Facades\Bitly4laravel',

Usage
=====

Shorten links

Bitly::shorten('http://spea.rs')->getResponseData();
Output: array

Array
(
[status_code] => 200
[status_txt] => OK
[data] => Array
(
[url] => http://bit.ly/9PCy42
[hash] => 9PCy42
[global_hash] => 25iRBL
[long_url] => http://www.betaworks.com
[new_hash] => 0
)
)

Expand links

Bitly::expand('http://bit.ly/1RmnUT')->getResponseData();

Output: array

Array
(
[status_code] => 200
[status_txt] => OK
[data] => Array
(
[entry] => Array
(
[short_url] => http://bit.ly/1RmnUT
[long_url] => http://google.com
[user_hash] => 1RmnUT
[global_hash] => 1RmnUT
)

)
)

To specifiy alternative Access Token, Format, Variable Output and Connection Options you have following public setters which can be chained.

Bitly::setAccessToken('my-access-token')
->setFormat('json')
->setVariableOutput('array')
->setConnectionOptions(array(CURLOPT_PORT => 443, CURLOPT_SSL_VERIFYHOST => 0, CURLOPT_SSL_VERIFYPEER => 0))
->expand('http://bit.ly/1RmnUT')
->getResponseData();

About
=====

Converted bitly-url-shortener yii framework extension to a Laravel package.

The original YII extension you can download here:
http://www.yiiframework.com/extension/bitly-url-shortener

Credits
=======

bitly-url-shortener - [Vadim Gabriel](https://github.com/VinceG "Github profile")

bitly4laravel - [Vladimir Jelovac](https://github.com/jelovac "Github profile")

License
=======

Copyright (c) 2013, Vladimir Jelovac
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

0 comments on commit e96caf8

Please sign in to comment.