Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pathoschild/webscript-helpers
A collection of generic scripts for writing Webscript.io webhooks.
https://github.com/pathoschild/webscript-helpers
Last synced: 14 days ago
JSON representation
A collection of generic scripts for writing Webscript.io webhooks.
- Host: GitHub
- URL: https://github.com/pathoschild/webscript-helpers
- Owner: Pathoschild
- Created: 2015-10-19T18:26:05.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2015-11-05T22:12:34.000Z (about 9 years ago)
- Last Synced: 2024-10-27T22:46:40.596Z (2 months ago)
- Language: Lua
- Size: 168 KB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
A collection of simple Lua modules for writing Webscript.io webhooks. They
[can be imported directly on Webscript.io](https://www.webscript.io/documentation#modules)
using the module name. For example:
```lua
local tokeniser = require('Pathoschild/webscript-helpers/tokeniser')
```
This is an early experiment for my own use; it has few features and may change
at any time.
### Tokeniser
This module extracts tokens from arbitrary text. It's mainly intended for
webhooks that need to parse text payloads.
For example, Amazon Web Services sends alert emails that look like this:
> **AWS Elastic Beanstalk Notification - New application version was deployed
> to running EC2 instances**
>
> Timestamp: Fri Oct 16 15:40:00 UTC 2015
> Message: New application version was deployed to running EC2 instances.
> Environment: sample-api-edge
> Application: sample-api
> Environment URL: http://sample-api-edge.elasticbeanstalk.com
This module lets you tokenise simple strings like the subject:
```lua
local service, subject = tokeniser.capture(payload.subject, "^AWS ([^-]+) Notification - (.+)")
```
Or tokenise complex strings:
```lua
local tokens = {}
tokeniser.parse(tokens, payload.body, {
timestamp = "Timestamp: ([^\r\n]+)",
message = "Message: ([^\r\n]+)",
environment = "Environment: ([^\r\n]+)",
environmentUrl = "Environment URL: ([^\r\n]+)",
application = "Application: ([^\r\n]+)"
})
```
(See docstrings in the Lua file for details.)
### Slack
This module provides a minimal Slack client for using an 'Incoming WebHooks'
integration configured via Slack.
Basic usage:
```lua
local client = slack.getClient('https://incoming-webhook-url')
client.post('Hi there!')
```
You can also customise the display name, avatar URL, and channel. (See
docstrings in the Lua file for details.)
### Error monitoring
This module provides utilities for error-monitoring webhooks on Webscript.io.
The most basic usage sends an email alert to the webhook owner when an error occurs:
```lua
return monitoring.get('AWS event', request).monitor(function()
-- webhook code goes here
end)
```
You can also specify error handlers, which are just functions that accept three
arguments (error, request, webhook name), and return `true` (handled) or `false`
(not handled). For example, this code notifies a Slack channel when a webhook
throws an error:
```lua
monitoring.get('AWS event', request, {monitoring.getSlackNotifier(slack)}).monitor(function()
-- webhook code goes here
end)
```
(See docstrings in the Lua file for details.)