https://github.com/passy/giphy-api

Giphy HTTP API Wrapper for Haskell
https://github.com/passy/giphy-api

giphy haskell lenses

Last synced: 19 days ago
JSON representation

Giphy HTTP API Wrapper for Haskell

• Host: GitHub
• URL: https://github.com/passy/giphy-api
• Owner: passy
• License: bsd-3-clause
• Created: 2016-03-05T22:24:13.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-03-06T15:05:56.000Z (over 4 years ago)
• Last Synced: 2024-04-25T03:20:53.369Z (7 months ago)
• Topics: giphy, haskell, lenses
• Language: Haskell
• Homepage: https://hackage.haskell.org/package/giphy-api
• Size: 87.9 KB
• Stars: 27
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# giphy-api

[![Build Status](https://travis-ci.org/passy/giphy-api.svg?branch=master)](https://travis-ci.org/passy/giphy-api)

[![Hackage](http://img.shields.io/hackage/v/giphy-api.svg)](https://hackage.haskell.org/package/giphy-api)

[![Stackage 8](http://stackage.org/package/giphy-api/badge/lts-8)](http://stackage.org/lts-8/package/giphy-api)

[![Stackage 9](http://stackage.org/package/giphy-api/badge/lts-9)](http://stackage.org/lts-9/package/giphy-api)

[![Stackage Nightly](http://stackage.org/package/giphy-api/badge/nightly)](http://stackage.org/nightly/package/giphy-api)

A Haskell wrapper for the [Giphy HTTP API](https://github.com/Giphy/GiphyAPI)

using [servant-client](https://hackage.haskell.org/package/servant-client).

## Usage

The module provides a `Giphy` monad which can be run with `runGiphy` to lift it

into IO. Here's a simple usage example:

```hs

{-# LANGUAGE OverloadedStrings #-}

import qualified Data.Text as T

import qualified Web.Giphy as Giphy

apiKey :: Giphy.Key

apiKey = Giphy.Key "dc6zaTOxFJmzC"

sample :: IO ()

sample = do

  let config = Giphy.GiphyConfig apiKey

  resp <- Giphy.runGiphy (app "puppies") config

  print resp

  where

    app :: T.Text -> Giphy.Giphy [Giphy.Gif]

    app q = do

      resp <- Giphy.search $ Giphy.Query q

      return $ Giphy._searchItems resp

```

For a slightly more complex example, check out the [sample app](app/Main.hs),

which also features the use of lenses.

## Building

Use [stack](http://haskellstack.org) to build this library.

```bash

$ stack setup

$ stack test

# Drop the flag if you don't want the sample app to be built.

$ stack build --flag=giphy-api:buildSample

# To install the sample tool

$ stack install

```

## Sample CLI Tool Usage

```bash

$ giphy-search --help

giphy-search

Usage: giphy-search ([-s|--search ARG] | [-t|--translate ARG] | [RANDOM_TAG])

  Find GIFs on the command line.

Available options:

  -h,--help                Show this help text

  -s,--search ARG          Use search to find a matching GIF.

  -t,--translate ARG       Use translate to find a matching GIF.

  -V,--version             Show version information

$ giphy-search puppies

Just https://media2.giphy.com/media/PjQFtJnmdOlwI/giphy.gif

$ giphy-search --translate superman

Just https://media3.giphy.com/media/eOewytQL4tOOA/giphy.gif

$ giphy-search "1C4D539A-B787-497F-B1DC-8FCF8D2C026D"

Nothing

```

## Missing features

- There is no compiler flag at the moment to disable lenses if those aren't

  needed. The library, however, uses `microlens` so the overhead should be

  minimal.

- The "Stickers" API endpoints are currently not covered. If you need them, let

  me know. PRs obviously very welcome.

- Some fields are currently not exposed. Again, if you need them, open an issue.

  For example, I have never seen a type value other than "gif" so I decided

  to skip it.