calamity: A library for writing discord bots

[ library, mit, network, web ] [ Propose Tags ]

Please see the README on GitHub at https://github.com/nitros12/calamity#readme


[Skip to Readme]
Versions [faq] 0.1.0.0, 0.1.2.0, 0.1.3.0, 0.1.3.1, 0.1.4.0, 0.1.4.1, 0.1.4.2, 0.1.4.3, 0.1.4.4, 0.1.5.0, 0.1.5.1, 0.1.6.0, 0.1.6.1, 0.1.6.2, 0.1.7.0, 0.1.8.0, 0.1.8.1, 0.1.9.0, 0.1.9.1, 0.1.9.2, 0.1.9.3, 0.1.9.4
Change log ChangeLog.md
Dependencies aeson (>=1.4 && <2), async (>=2.2 && <3), base (>=4.12 && <5), bytestring (==0.10.*), concurrent-extra (==0.7.*), containers (==0.6.*), data-default-class (==0.1.*), deepseq (>=1.4.4.0 && <2), deque (==0.4.*), df1 (==0.3.*), di-polysemy (>=0.1.3 && <0.2), exceptions (==0.10.*), fmt (==0.6.*), focus (>=1.0 && <2), generic-lens (>=2.0 && <3), generic-override (>=0.0.0.0 && <0.0.1), generic-override-aeson (>=0.0.0.0 && <0.0.1), hashable (>=1.2 && <2), http-date (>=0.0.8 && <0.1), http-types (==0.12.*), lens (>=4.18 && <5), lens-aeson (>=1.1 && <2), megaparsec (==8.*), mtl (>=2.2 && <3), polysemy (>=1.3 && <2), polysemy-plugin (==0.2.*), reflection (>=2.1 && <3), safe-exceptions (>=0.1 && <2), scientific (==0.3.*), stm (>=2.5 && <3), stm-chans (>=3.0 && <4), stm-containers (>=1.1 && <2), text (>=1.2 && <2), text-show (>=3.8 && <4), time (>=1.8 && <1.11), typerep-map (==0.3.*), unagi-chan (==0.4.*), unordered-containers (==0.2.*), vector (==0.12.*), websockets (==0.12.*), wreq-patchable (>=1.0 && <2), wuss (>=1.1 && <2) [details]
License MIT
Copyright 2020 Ben Simms
Author Ben Simms
Maintainer ben@bensimms.moe
Category Network, Web
Home page https://github.com/nitros12/calamity
Bug tracker https://github.com/nitros12/calamity/issues
Source repo head: git clone https://github.com/nitros12/calamity
Uploaded by nitros12 at 2020-05-26T00:16:11Z
Distributions NixOS:0.1.8.0
Downloads 2871 total (2850 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for calamity-0.1.9.4

[back to package description]
<h1 align="center">Calamity</h1> <!-- [![Hackage](https://img.shields.io/hackage/v/calamity)](https://hackage.haskell.org/package/calamity) --> <!-- [![Gitlab pipeline status](https://img.shields.io/gitlab/pipeline/nitros12/calamity)](https://gitlab.com/nitros12/calamity/pipelines) --> <!-- [![License](https://img.shields.io/github/license/nitros12/calamity)](https://github.com/nitros12/calamity/blob/master/LICENSE) --> <!-- [![Hackage-Deps](https://img.shields.io/hackage-deps/v/calamity)](https://hackage.haskell.org/package/calamity) --> <p align="center"> <a href="https://hackage.haskell.org/package/calamity"><img src="https://img.shields.io/hackage/v/calamity" alt="Hackage"></a> <a href="https://gitlab.com/nitros12/calamity/pipelines"><img src="https://img.shields.io/gitlab/pipeline/nitros12/calamity" alt="Gitlab pipeline status"></a> <a href="https://github.com/nitros12/calamity/blob/master/LICENSE"><img src="https://img.shields.io/github/license/nitros12/calamity" alt="License"></a> <a href="https://hackage.haskell.org/package/calamity"><img src="https://img.shields.io/hackage-deps/v/calamity" alt="Hackage-Deps"></a> </p>

Calamity is a Haskell library for writing discord bots, it uses Polysemy as the core library for handling effects, allowing you to pick and choose how to handle certain features of the library.

The current customisable effects are:

  • Cache: The default cache handler keeps the cache in memory, however you could write a cache handler that stores cache in a database for example.

  • Metrics: The library has counters, gauges, and histograms installed to measure useful things, by default these are not used (and cost nothing), but could be combined with Prometheus. An example of using prometheus as the metrics handler can be found here.

Docs

You can find documentation on hackage: here

Example

An example project can be found at: nitros12/calamity-example

{-# LANGUAGE DataKinds #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE GADTs #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE OverloadedLabels #-}

{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE PolyKinds #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TemplateHaskell #-}
{-# LANGUAGE TypeApplications #-}

{-# LANGUAGE TypeOperators #-}

module Main where

import           Calamity
import           Calamity.Cache.InMemory
import           Calamity.Commands
import qualified Calamity.Commands.Context                  as CommandContext
import           Calamity.Metrics.Noop

import           Control.Concurrent
import           Control.Concurrent.STM.TVar
import           Control.Lens
import           Control.Monad

import           Data.Text.Lazy              ( Text, fromStrict )
import           Data.Text.Strict.Lens

import qualified DiPolysemy                  as DiP

import qualified Polysemy                    as P
import qualified Polysemy.Async              as P
import qualified Polysemy.AtomicState        as P
import qualified Polysemy.Embed              as P
import qualified Polysemy.Fail               as P

import           Prelude                     hiding ( error )

import           TextShow

data Counter m a where
  GetCounter :: Counter m Int

P.makeSem ''Counter

runCounterAtomic :: P.Member (P.Embed IO) r => P.Sem (Counter ': r) a -> P.Sem r a
runCounterAtomic m = do
  var <- P.embed $ newTVarIO (0 :: Int)
  P.runAtomicStateTVar var $ P.reinterpret (\case
                                              GetCounter -> P.atomicState (\v -> (v + 1, v))) m

handleFailByLogging m = do
  r <- P.runFail m
  case r of
    Left e -> DiP.error (e ^. packed)
    _      -> pure ()

info, debug :: BotC r => Text -> P.Sem r ()
info = DiP.info
debug = DiP.info

tellt :: (BotC r, Tellable t) => t -> Text -> P.Sem r (Either RestError Message)
tellt t m = tell t $ L.toStrict m

main :: IO ()
main = do
  token <- view packed <$> getEnv "BOT_TOKEN"
  void . P.runFinal . P.embedToFinal . runCounterAtomic . runCacheInMemory . runMetricsPrometheusIO . useConstantPrefix "!"
    $ runBotIO (BotToken token) $ do
    addCommands $ do
      helpCommand
      command @'[User] "utest" $ \ctx u -> do
        void $ tellt ctx $ "got user: " <> showtl u
      command @'[Named "u" User, Named "u1" User] "utest2" $ \ctx u u1 -> do
        void $ tellt ctx $ "got user: " <> showtl u <> "\nand: " <> showtl u1
      command @'[L.Text, Snowflake User] "test" $ \ctx something aUser -> do
        info $ "something = " <> showt something <> ", aUser = " <> showt aUser
      command @'[] "hello" $ \ctx -> do
        void $ tellt ctx "heya"
      group "testgroup" $ do
        command @'[[L.Text]] "test" $ \ctx l -> do
          void $ tellt ctx ("you sent: " <> showtl l)
        command @'[] "count" $ \ctx -> do
          val <- getCounter
          void $ tellt ctx ("The value is: " <> showtl val)
        group "say" $ do
          command @'[KleeneConcat L.Text] "this" $ \ctx msg -> do
            void $ tellt ctx msg
      command @'[Snowflake Emoji] "etest" $ \ctx e -> do
        void $ tellt ctx $ "got emoji: " <> showtl e
      command @'[] "explode" $ \ctx -> do
        Just x <- pure Nothing
        debug "unreachable!"
      command @'[] "bye" $ \ctx -> do
        void $ tellt ctx "bye!"
        stopBot
      command @'[] "fire-evt" $ \ctx -> do
        fire $ customEvt @"my-event" ("aha" :: L.Text, ctx ^. #message)
      command @'[L.Text] "wait-for" $ \ctx s -> do
        void $ tellt ctx ("waiting for !" <> s)
        waitUntil @'MessageCreateEvt (\msg -> msg ^. #content == ("!" <> s))
        void $ tellt ctx ("got !" <> s)
    react @'MessageCreateEvt $ \msg -> handleFailByLogging $ case msg ^. #content of
      "!say hi" -> replicateM_ 3 . P.async $ do
        info "saying heya"
        Right msg' <- tellt msg "heya"
        info "sleeping"
        P.embed $ threadDelay (5 * 1000 * 1000)
        info "slept"
        void . invoke $ EditMessage (msg ^. #channelID) msg' (Just "lol") Nothing
        info "edited"
      _ -> pure ()
    react @('CustomEvt "command-error" (CommandContext.Context, CommandError)) $ \(ctx, e) -> do
      info $ "Command failed with reason: " <> showt e
      case e of
        ParseError n r -> void . tellt ctx $ "Failed to parse parameter: `" <> L.fromStrict n <> "`, with reason: ```\n" <> r <> "```"
    react @('CustomEvt "my-event" (L.Text, Message)) $ \(s, m) ->
      void $ tellt m ("Somebody told me to tell you about: " <> s)