lib-giphy

A library that makes it easy to interact with the GIPHY API.

Requirements

To get the API key that is required to create a new Giphy::Client you need to create a GIPHY app.

Installation

1. Add the dependency to your shard.yml:

   dependencies:
     lib-giphy:
       github: henrikac/lib-giphy

2. Run shards install

Usage

require "lib-giphy"

giphy = Giphy::Client.new <api_key>

gifs = giphy.search("cats") # => returns 25 gifs
trend_gifs = giphy.trending() # => returns 25 gifs
translated = giphy.translate("cats") # => returns 1 gif
random_gif = giphy.random() # => returns 1 gif

gifs.data.each do |gif|
  puts gif.title
end

The Giphy::Client methods in the example above can also take a Param object as a second argument.
Different types of Param:

• SearchParam
• TrendingParam
• TranslateParam
• RandomParam

Supported endpoints

• [X] Trending
• [X] Search
• [X] Translate
• [X] Random
• [ ] Action Register
• [X] Random ID
• [X] Get GIF by ID
• [X] Get GIFs by ID
• [ ] Upload
• [X] Categories
• [ ] Autocomplete
• [ ] Channel Search
• [ ] Search Suggestions
• [ ] Trending Search Terms

Contributing

1. Fork it (https://github.com/henrikac/lib-giphy/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• Henrik Christensen - creator and maintainer