| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Web.Giphy
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.GiphyConfigapiKey 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
- newtype Key = Key Text
- newtype Query = Query Text
- newtype Phrase = Phrase Text
- newtype Tag = Tag Text
- data Pagination = Pagination {}
- newtype GifId = GifId Text
- data Gif = Gif {}
- data Image = Image {
- _imageUrl :: Maybe URI
- _imageSize :: Maybe Int
- _imageMp4Url :: Maybe URI
- _imageMp4Size :: Maybe Int
- _imageWebpUrl :: Maybe URI
- _imageWebpSize :: Maybe Int
- _imageWidth :: Maybe Int
- _imageHeight :: Maybe Int
- type ImageMap = Map Text Image
- newtype PaginationOffset = PaginationOffset Int
- data SearchResponse = SearchResponse {}
- newtype SingleGifResponse = SingleGifResponse {}
- newtype TranslateResponse = TranslateResponse {}
- newtype RandomResponse = RandomResponse {}
- newtype GiphyConfig = GiphyConfig {
- configApiKey :: Key
- type Giphy = ReaderT GiphyContext ClientM
- runGiphy :: MonadIO m => Giphy a -> GiphyConfig -> m (Either ServantError a)
- runGiphy' :: MonadIO m => Manager -> Giphy a -> GiphyConfig -> m (Either ServantError a)
- gifId :: Lens' Gif Text
- gifImages :: Lens' Gif ImageMap
- gifSlug :: Lens' Gif Text
- gifUrl :: Lens' Gif URI
- imageHeight :: Lens' Image (Maybe Int)
- imageUrl :: Lens' Image (Maybe URI)
- imageSize :: Lens' Image (Maybe Int)
- imageWidth :: Lens' Image (Maybe Int)
- imageMp4Url :: Lens' Image (Maybe URI)
- imageMp4Size :: Lens' Image (Maybe Int)
- imageWebpUrl :: Lens' Image (Maybe URI)
- imageWebpSize :: Lens' Image (Maybe Int)
- paginationCount :: Lens' Pagination Int
- paginationOffset :: Lens' Pagination Int
- paginationTotalCount :: Lens' Pagination Int
- searchItems :: Lens' SearchResponse [Gif]
- searchPagination :: Lens' SearchResponse Pagination
- singleGifItem :: Lens' SingleGifResponse Gif
- translateItem :: Lens' TranslateResponse Gif
- randomGifItem :: Lens' RandomResponse Gif
- search :: Query -> Giphy SearchResponse
- searchOffset :: Query -> PaginationOffset -> Giphy SearchResponse
- translate :: Phrase -> Giphy TranslateResponse
- gif :: GifId -> Giphy SingleGifResponse
- random :: Maybe Tag -> Giphy RandomResponse
Request Data Types
These data types are used to encapsulate otherwise weakly typed arguments.
The API Key. See https://github.com/Giphy/GiphyAPI
A search query.
A phrase or term used for translation.
A tag to retrieve a random GIF for.
data Pagination Source #
Metadata about pagination in a response.
Constructors
| Pagination | |
Fields | |
Instances
A unique gif identifier.
Response Data Types
These data types contain are the parsed JSON responses from the Giphy API.
A search response item.
An image contained in a Giphy response.
Constructors
| Image | |
Fields
| |
data SearchResponse Source #
A collection of GIFs as part of a search response.
Constructors
| SearchResponse | |
Fields
| |
newtype SingleGifResponse Source #
A single gif as part of a response.
Constructors
| SingleGifResponse | |
Fields | |
newtype TranslateResponse Source #
A single GIF as part of a translate response.
Constructors
| TranslateResponse | |
Fields | |
Giphy Monad
newtype GiphyConfig Source #
Contains the key to access the API.
Constructors
| GiphyConfig | |
Fields
| |
Instances
runGiphy :: MonadIO m => Giphy a -> GiphyConfig -> m (Either ServantError a) Source #
You need to provide a GiphyConfig to lift a Giphy computation
into MonadIO.
Arguments
| :: MonadIO m | |
| => Manager | This must be a TLS-enabled Manager |
| -> Giphy a | |
| -> GiphyConfig | |
| -> m (Either ServantError a) |
Lenses
You can use these lenses if you prefer them to manually accessing record fields.
searchItems :: Lens' SearchResponse [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
Arguments
| :: Query | |
| -> PaginationOffset | Offset as a number of items you want to skip. |
| -> Giphy SearchResponse |
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