Safe Haskell	None
Language	Haskell2010

Web.Giphy

Contents

Request Data Types
Response Data Types
Giphy Monad
Lenses
API calls

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

Eq Key Source
Show Key Source
FromText Key Source
ToText Key Source

newtype Query Source

A search query.

Constructors

Query Text

Instances

Eq Query Source
Show Query Source
FromText Query Source
ToText Query Source

newtype Phrase Source

A phrase or term used for translation.

Constructors

Phrase Text

Instances

Eq Phrase Source
Show Phrase Source
FromText Phrase Source
ToText Phrase Source

newtype Tag Source

A tag to retrieve a random GIF for.

Constructors

Tag Text

Instances

Eq Tag Source
Show Tag Source
FromText Tag Source
ToText Tag Source

data Pagination Source

Metadata about pagination in a response.

Constructors

Pagination
Fields _paginationTotalCount :: Int _paginationCount :: Int _paginationOffset :: Int

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

Eq Gif Source
Ord Gif Source
Show Gif Source
Generic Gif Source
FromJSON Gif Source
type Rep Gif Source

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

Eq Image Source
Ord Image Source
Show Image Source
Generic Image Source
FromJSON Image Source
type Rep Image Source

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

Eq PaginationOffset Source
Show PaginationOffset Source
FromText PaginationOffset Source
ToText PaginationOffset Source

data SearchResponse Source

A collection of GIFs as part of a search response.

Constructors

SearchResponse
Fields _searchItems :: [Gif] _searchPagination :: Pagination

Instances

Eq SearchResponse Source
Ord SearchResponse Source
Show SearchResponse Source
Generic SearchResponse Source
FromJSON SearchResponse Source
type Rep SearchResponse Source

newtype SingleGifResponse Source

A single gif as part of a response.

Constructors

SingleGifResponse
Fields _singleGifItem :: Gif

Instances

Eq SingleGifResponse Source
Ord SingleGifResponse Source
Show SingleGifResponse Source
Generic SingleGifResponse Source
FromJSON SingleGifResponse Source
type Rep SingleGifResponse Source

newtype TranslateResponse Source

A single GIF as part of a translate response.

Constructors

TranslateResponse
Fields _translateItem :: Gif

Instances

Eq TranslateResponse Source
Ord TranslateResponse Source
Show TranslateResponse Source
Generic TranslateResponse Source
FromJSON TranslateResponse Source
type Rep TranslateResponse Source

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

Eq GiphyConfig Source
Show GiphyConfig Source

type Giphy = ReaderT GiphyConfig (EitherT 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. http://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. http://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. http://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. http://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. http://api.giphy.com/v1/gifs/random?api_key=dc6zaTOxFJmzC&tag=american+psycho

Eq Pagination Source
Ord Pagination Source
Show Pagination Source
Generic Pagination Source
FromJSON Pagination Source
type Rep Pagination Source