Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mseri/fbmessenger-api-hs
High-level bindings to the Messenger Platform API based on servant library.
https://github.com/mseri/fbmessenger-api-hs
Last synced: about 2 months ago
JSON representation
High-level bindings to the Messenger Platform API based on servant library.
- Host: GitHub
- URL: https://github.com/mseri/fbmessenger-api-hs
- Owner: mseri
- License: bsd-3-clause
- Created: 2016-06-09T14:15:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-01T17:21:33.000Z (almost 8 years ago)
- Last Synced: 2024-10-13T21:29:55.358Z (2 months ago)
- Language: Haskell
- Homepage:
- Size: 92.8 KB
- Stars: 13
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# FBMessenger API
[](https://travis-ci.org/mseri/fbmessenger-api-hs)
High-level bindings to the [Messenger Platform API](https://developers.facebook.com/docs/messenger-platform/) based on [servant](https://haskell-servant.github.io/) library.
We try to maintain the overall structure compatible with [telegram-api](https://github.com/klappvisor/haskell-telegram-api).
There was an incongruence between the spec and the actual serialization of the webhook requests that became apparent when testing an actual messenger bot. For this reason you should **use only versions of the library that are `>= 0.1.1`**!
This library is alpha software and the API design could change to improve composability, ergonomicity and ease of use. We recommend using `stack` for dealing with this library (you will need to add it to the `extra-deps` in `stack.yaml`).
NOTE (1.6.2016): the WelcomeMessageSendAPI recently changed. The Platform no-longer accepts any welcome message api-wise (only a custom payload is now allowed). The library will be updated to reflect this change as soon as I can (otherwise you are welcome to submit a PR). To setup/modify the Welcome Message you have to use the online interface.
# Usage
Before being able to test and use the bot, you will need to verify your key.
The example app in `example-app/example.hs` contains a servant server that implements the verification and a trivial echo-server.
You can run it with
```{.bash}
VERIFY_TOKEN="your_token_goes_here" stack exec example
```
and pass it some data (here assuming you have `httpie` installed)
```{.bash}
http get 'localhost:3000/webhook/?hub.verify_token=your_token_goes_here&hub.challenge=test'
http post :3000/webhook < test-files/wsTextMessageRequest.json
```
Otherwise run `stack ghci` then copy and paste the following
```{.haskell}
:m +Network.HTTP.Client
:m +Network.HTTP.Client.TLS
:m +Data.Text
let token = Token $ Data.Text.pack "your_token_goes_here"
let manager = newManager tlsManagerSettings
manager >>= \m -> subscribedApps $ Just token m
```
You should get a positive response or (in case of inactive token):
```{.haskell}
Left (FailureResponse {responseStatus = Status {statusCode = 400, statusMessage = "Bad Request"}, responseContentType = application/json, responseBody = "{\"error\":{\"message\":\"Invalid OAuth access token.\",\"type\":\"OAuthException\",\"code\":190,\"fbtrace_id\":\"ESxHmUos2B+\"}}"})
```
# Contribution
1. Fork repository
2. Do some changes
3. Create pull request
4. Wait for CI build and review
You can use stack to build the project
stack build
To run tests
stack test
# TODO
- Tests for the network part of the api (hard, requires a bot setted up and permanently running just for the tests)
- Check if assumption on https://github.com/mseri/fbmessenger-api-hs/blob/master/src/Web/FBMessenger/API/Bot/WebhookAPI.hs#L99 is safe
- Cleanup Webhooks API Requests and add higher level helpers