Skip to content

Latest commit

 

History

History
135 lines (106 loc) · 3.07 KB

README.md

File metadata and controls

135 lines (106 loc) · 3.07 KB
Raw

Kue Workers

A KueJS queue for common async tasks. This repo exposes an API that you can call to do some of the following:

  • Facebook Bots (coming soon)
  • Mailgun - send emails, (more coming soon)
  • Slack (coming soon)
  • Telegram (coming soon)
  • Trello - create cards, (more coming soon)
  • Twilio (coming soon)

Why use this?

For many of the same benefits that any queue will give you:

  • offloading long-running tasks
  • centralised logging
  • retry abilities
  • delaying tasks (eg, sending follow-up emails after 10 mins)
  • It can help to keep your core projects thinner since this repo will contain all the heavy third-party libraries.

Getting started

Usage

It's recommended that you fork this repo so that you can pull updates at any time.

# If you downloaded or cloned, you should create an upstream branch with the original repo
git remote add upstream https://github.com/pollygot/workers-kue

# Keep updated at any time
git fetch upstream # fetch changes from Pollygot
git checkout master # switch to your local master branch
git merge upstream/master # update local master with changes from Pollygot

# Set up your own config for each app
cp config/sample.json5 config/default.json5 # <-- Fill this with your own config
npm run dev # start a dev server that will watch for any changes and recompile

Running with Docker

docker-compose up

API

All jobs are created by POSTing to the /job endpoint

// POST 'localhost:3000/job'
{
   "type": "<MODULE_AND_METHOD_NAME>",
   "data": { <PAYLOAD_DATA> },
   "options" : { // not required
     "attempts": 1, // Defaults to 3 attemps
     "delay": 0, // Default will process the job immediately
     "priority": "normal" // Defaults to normal priority
   }
 }

Facebook

Post to a Facebook page feed

// POST 'localhost:3000/job'
{
   "type": "FACEBOOK_POST_TO_PAGE_FEED",
   "data": {
     "feed_id": "123456789087654",
     "message": "Hello world",
     "access_token": "XXXXXXXXXXXXXXXXXXXX"
   }
 }

Mailgun

Send a new email

// POST 'localhost:3000/job'
{
   "type": "MAILGUN_SEND_MESSAGE",
   "data": {
     "to": "[email protected]",
     "from": "[email protected]",
     "sender": "Sender Name",
     "text": "Testing some Mailgun awesomeness!"
   }
 }

Trello

Create a new card

// POST 'localhost:3000/job'
{
   "type": "TRELLO_CREATE_CARD",
   "data": {
     "list_id": "XXXX", // Trello List ID
     "name": "Card name",
     "desc": "Card description"
   }
 }

Slack

Create a new card

// POST 'localhost:3000/job'
{
   "type": "SLACK_POST_MESSAGE",
   "data": {
     "webhook": "XXXX", // Webhook for your channel
     "payload": {} // Slack message payload - see https://api.slack.com/docs/messages/builder
   }
 }

Development

git clone https://github.com/pollygot/workers-kue # clone this repo
npm install # install dependencies
cp config/sample.json5 config/default.json5 # <-- Fill this with you own config
npm run dev # start a dev server that will watch for any changes and recompile