https://github.com/kayak/spjall
An Akka based chatbot framework written in Scala
https://github.com/kayak/spjall
akka scala slack
Last synced: about 2 months ago
JSON representation
An Akka based chatbot framework written in Scala
- Host: GitHub
- URL: https://github.com/kayak/spjall
- Owner: kayak
- License: apache-2.0
- Created: 2019-10-07T11:22:42.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2021-02-17T04:36:04.000Z (over 5 years ago)
- Last Synced: 2025-05-30T00:42:10.251Z (about 1 year ago)
- Topics: akka, scala, slack
- Language: Scala
- Size: 60.5 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Spjall
Spjall is an open source, reactive Slack chat bot framework using Akka. "Spjall" is the Icelandic word for "chat".
The proper pronunciation can be found here: https://forvo.com/word/spjall/#is
_*Spjall is experimental and incomplete at the moment.*_
## Slack WebAPI methods
Supported Slack API methods return a `Future` and can be found in the package `com.r9.spjall.web`. All WebAPI
methods can be found in an `object` matching the API method family name with the specific method matching the actual
method name, for example the Slack WebAPI method `rtm.connect` can be found at `com.r9.spjall.web.Rtm#connect`
## Contributing
### Git-Flow
This repository uses the `git-flow` conventions for branching, releasing, etc. Installation instructions can be found
here: https://github.com/nvie/gitflow/wiki/Installation
After installing, be sure you have both the `master` and `develop` branches locally and run `git flow init`.
### Using
**Spjall** needs your bot OAuth tokens to operate. These can be specified in config, but it is recommended to instead
store them in environment variables for better data security. Here is an example you might put in your bash profile:
```bash
export USER_TOKEN=xoxp-**********-**********-************-********************************
export BOT_TOKEN=xoxb-**********-************-************************
```
Here is example code calling the `Rtm.connect` method
```scala
import akka.actor.ActorSystem
import scala.concurrent._
import com.r9.spjall.web._
implicit val as: ActorSystem = ActorSystem("test")
implicit val executionContext: ExecutionContext = as.dispatcher
val res = Rtm.connect()
res.foreach(println)
```
## Contact
For questions or comments, contact Paul Thordarson - thor@kayak.com