A Ruby interface to the Giphy API. http://api.giphy.com/
Ruby
Latest commit 77ea1cc Aug 27, 2015 @sebasoga Prepare version 3.0.0

README.md

Giphy

Build Status Code Climate

Because GIFs make life fun! Use Giphy API from your Ruby programs and command line. Check out Giphy Labs for inspiration.

Installation

Add this line to your application's Gemfile:

gem 'giphy'

And then execute:

$ bundle

Or install it yourself as:

$ gem install giphy

Usage

Set the API version and api_key:

Giphy::Configuration.configure do |config|
  config.version = THE_API_VERSION
  config.api_key = YOUR_API_KEY
end

Important: Giphy API is currently in public beta. Unless version and api_key are set to specific values the default values for the beta period will be used. Check Giphy's API for updates.

That's it, you're ready to have fun!

Trending

Giphy.trending(limit: 5)

Translate

Giphy.translate('geek')

Search

Giphy.search('funny cat', {limit: 50, offset: 25})

Flagged

Write

Giphy.flag('m5QHf0caAwgMw')

Read

Giphy.flagged

Favorites

Write

Giphy.favorite('12HoHdqnDxz5NS')

Read

Giphy.favorites('absurdnoise', {limit: 50, offset: 25})

Screensaver

Giphy.screensaver('surprise')

Random

Giphy.random

For getting random gifs with a specific tag:

Giphy.random('american psycho')

Artists

Giphy.artists

GIFs by artist

Giphy.gif_by_artist('89a', {limit: 5, offset: 10})

GIFs by ID

Giphy.gif_by_id('feqkVgjJpYtjy', '12HoHdqnDxz5NS', '7rzbxdu0ZEXLy')

Command Line Tool

There is a small command line tool that let's you search for GIFs from the command line and opens it on your browser. Just for fun.

$ giphy 'dance'

Supported Ruby Versions

This library aims to support and is tested against the following Ruby implementations:

  • Ruby 1.9
  • Ruby 2.0
  • Ruby 2.1
  • Ruby 2.2

Contributing

  1. Fork it
  2. Create your feature branch: git checkout -b my-new-feature
  3. Run tests: rake
  4. Commit your changes: git commit -am 'Add some feature'
  5. Push to the branch: git push origin my-new-feature
  6. Create new Pull Request

License

See LICENSE for details.