Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A ruby wrapper for the bit.ly API

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 lib
Octocat-spinner-32 test
Octocat-spinner-32 .gitignore
Octocat-spinner-32 Gemfile
Octocat-spinner-32 Gemfile.lock
Octocat-spinner-32 History.txt
Octocat-spinner-32 README.mdown
Octocat-spinner-32 Rakefile
Octocat-spinner-32 bitly.gemspec
README.mdown

The Bitly Gem

A Ruby API for the http://bit.ly (and now http://j.mp) shortener apis. This gem also works for Bit.ly Pro.

To read more on the Bit.ly api, visit the api documentation at google code.

Installation:

gem install bitly

or, if you need to use sudo,

sudo gem install bitly

A quick note on the API versions:

Bitly recently released their version 3 API. From this 0.5.0 release, the gem will continue to work the same but also provide a V3 module, using the version 3 API. The standard module will become deprecated, as Bitly do not plan to keep the version 2 API around forever.

To move to using the version 3 API, call:

Bitly.use_api_version_3

Then, when you call Bitly.new(username, api_key) you will get a Bitly::V3::Client instead, which provides the version 3 api calls (shorten, expand, clicks, validate and bitly_pro_domain). See http://api.bit.ly for details.

Eventually, this will become the default version used and finally, the V2 module will disappear.

(Please excuse the lack of tests for the v3 classes, they are fully tested and ready to replace this whole codebase in the v3 branch of the github repo, until I realised it would break everything.)

Using the Bitly gem:

Create a Bitly client using your username and api key as follows:

bitly = Bitly.new(username, api_key)

You can then use that client to shorten or expand urls or return more information or statistics as so:

bitly.shorten('http://www.google.com')

bitly.shorten('http://www.google.com', :history => 1) # adds the url to the api user's history

bitly.expand('wQaT')

bitly.info('http://bit.ly/wQaT')

bitly.stats('http://bit.ly/wQaT')

Each can be used in all the methods described in the API docs, the shorten function, for example, takes a url or an array of urls.

All four functions return a Bitly::V2::Url or Bitly::V3::Url object (or an array of objects if you supplied an array as the input), depending which version of the api you are using. You can then get all the information required from that object.

u = bitly.shorten('http://www.google.com') #=> Bitly::V2::Url

u.long_url #=> "http://www.google.com"

u.short_url #=> "http://bit.ly/Ywd1"

u.bitly_url #=> "http://bit.ly/Ywd1"

u.jmp_url #=> "http://j.mp/Ywd1"

u.user_hash #=> "Ywd1"

u.hash #=> "2V6CFi"

u.info #=> a ruby hash of the JSON returned from the API

u.stats #=> a ruby hash of the JSON returned from the API

bitly.shorten('http://www.google.com', 'keyword')

LICENSE:

(The MIT License)

Copyright (c) 2009 Phil Nash

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.

Something went wrong with that request. Please try again.