giphy-api-0.3.0.0: Giphy HTTP API wrapper and CLI search tool.

Safe HaskellNone
LanguageHaskell2010

Web.Giphy

Contents

Description

Provides a Giphy monad that can be used to issue selected API calls under a selected API key.

import qualified Web.Giphy as Giphy

let apiKey = Giphy.Key "dc6zaTOxFJmzC"
let config = Giphy.GiphyConfig apiKey
resp <- Giphy.runGiphy (Giphy.search $ Giphy.query "puppies") config
let fstUrl = resp ^? _Right
                   . Giphy.searchItems
                   . _head
                   . Giphy.gifImages
                   . at "original"
                   . traverse
                   . Giphy.imageUrl
                   . traverse
print fstUrl

Synopsis

Request Data Types

These data types are used to encapsulate otherwise weakly typed arguments.

newtype Key Source

The API Key. See https://github.com/Giphy/GiphyAPI

Constructors

Key Text 

Instances

newtype Query Source

A search query.

Constructors

Query Text 

Instances

newtype Phrase Source

A phrase or term used for translation.

Constructors

Phrase Text 

Instances

newtype Tag Source

A tag to retrieve a random GIF for.

Constructors

Tag Text 

Instances

data Pagination Source

Metadata about pagination in a response.

Constructors

Pagination 

Fields

_paginationTotalCount :: Int
 
_paginationCount :: Int
 
_paginationOffset :: Int
 

Instances

newtype GifId Source

A unique gif identifier.

Constructors

GifId Text 

Instances

Response Data Types

These data types contain are the parsed JSON responses from the Giphy API.

data Gif Source

A search response item.

Constructors

Gif 

Fields

_gifId :: Text
 
_gifSlug :: Text
 
_gifUrl :: URI
 
_gifImages :: ImageMap
 

Instances

data Image Source

An image contained in a Giphy response.

Constructors

Image 

Fields

_imageUrl :: Maybe URI
 
_imageSize :: Maybe Int
 
_imageMp4Url :: Maybe URI
 
_imageMp4Size :: Maybe Int
 
_imageWebpUrl :: Maybe URI
 
_imageWebpSize :: Maybe Int
 
_imageWidth :: Maybe Int
 
_imageHeight :: Maybe Int
 

Instances

type ImageMap = Map Text Image Source

Mapping from a Text identifier to an Image.

newtype PaginationOffset Source

Offset for paginated requests.

Constructors

PaginationOffset Int 

Instances

data SearchResponse Source

A collection of GIFs as part of a search response.

Constructors

SearchResponse 

Fields

_searchItems :: [Gif]
 
_searchPagination :: Pagination
 

Instances

newtype SingleGifResponse Source

A single gif as part of a response.

Constructors

SingleGifResponse 

Fields

_singleGifItem :: Gif
 

Instances

newtype TranslateResponse Source

A single GIF as part of a translate response.

Constructors

TranslateResponse 

Fields

_translateItem :: Gif
 

Instances

newtype RandomResponse Source

A single gif as part of a response.

Constructors

RandomResponse 

Fields

_randomGifItem :: Gif
 

Instances

Giphy Monad

Use runGiphy to lift the Giphy monad into IO.

data GiphyConfig Source

Contains the key to access the API.

Constructors

GiphyConfig 

Fields

configApiKey :: Key
 

Instances

type Giphy = ReaderT GiphyConfig (ExceptT ServantError IO) Source

The Giphy monad contains the execution context.

runGiphy :: MonadIO m => Giphy a -> GiphyConfig -> m (Either ServantError a) Source

You need to provide a GiphyConfig to lift a Giphy computation into MonadIO.

Lenses

You can use these lenses if you prefer them to manually accessing record fields.

gifId :: Lens' Gif Text Source

gifImages :: Lens' Gif ImageMap Source

gifSlug :: Lens' Gif Text Source

gifUrl :: Lens' Gif URI Source

imageHeight :: Lens' Image (Maybe Int) Source

imageUrl :: Lens' Image (Maybe URI) Source

imageSize :: Lens' Image (Maybe Int) Source

imageWidth :: Lens' Image (Maybe Int) Source

imageMp4Url :: Lens' Image (Maybe URI) Source

imageMp4Size :: Lens' Image (Maybe Int) Source

imageWebpUrl :: Lens' Image (Maybe URI) Source

imageWebpSize :: Lens' Image (Maybe Int) Source

paginationCount :: Lens' Pagination Int Source

paginationOffset :: Lens' Pagination Int Source

paginationTotalCount :: Lens' Pagination Int Source

searchItems :: Lens' SearchResponse [Gif] Source

searchPagination :: Lens' SearchResponse Pagination Source

singleGifItem :: Lens' SingleGifResponse Gif Source

translateItem :: Lens' TranslateResponse Gif Source

randomGifItem :: Lens' RandomResponse Gif Source

API calls

Functions that directly access the Giphy API. All these functions run in the Giphy monad.

search :: Query -> Giphy SearchResponse Source

Issue a search request for the given query without specifying an offset. E.g. https://api.giphy.com/v1/gifs/search?q=funny+cat&api_key=dc6zaTOxFJmzC

searchOffset :: Query -> PaginationOffset -> Giphy SearchResponse Source

Issue a search request for the given query by specifying a pagination offset. E.g. https://api.giphy.com/v1/gifs/search?q=funny+cat&api_key=dc6zaTOxFJmzC&offset=25

translate :: Phrase -> Giphy TranslateResponse Source

Issue a translate request for a given phrase or term. E.g. https://api.giphy.com/v1/gifs/translate?s=superman&api_key=dc6zaTOxFJmzC

gif :: GifId -> Giphy SingleGifResponse Source

Issue a request for a single GIF identified by its GifId. E.g. https://api.giphy.com/v1/gifs/feqkVgjJpYtjy?api_key=dc6zaTOxFJmzC

random :: Maybe Tag -> Giphy RandomResponse Source

Issue a request for a random GIF for the given (optional) tag. E.g. https://api.giphy.com/v1/gifs/random?api_key=dc6zaTOxFJmzC&tag=american+psycho