penland365 / balaam Goto Github PK

We need this project to pass Flint inspection, which it decidedly does not.

Building off @pengwynn 's first commit, I'm going to start by moving the script folder back to the top level. I need to create a handful of scripts to manage starting up the important components.

My preference for this is to rely on Docker to manage each module independently.

What about Slack integration? At a super high level, I'd love to see something like

That keeps track of how man active mentions you have in your rooms so you can see if you've been pinged.

What else?

This is a test issue for notifications.

What is the best way to design data routes for this? At the moment, we're leaning into balaam acting as a cache and collator tool for various data sources ( github / weather / slack / etc ). Our current routes are

POST /users
GET /redirect/slack

GET /:username/slack/auth
GET /status-lines/slack

The first two require no authentication, while the next 2 do require authentication ( right now, basic auth via header ).

What I'm leaning towards is placing all routes retuning data under a /data/slack, /data/weather namespace. Then, we examine the Accept header to determine the format of the response. Default would be json, but a text/plain would return a simply string that could be placed directly into a status line. For example, a call to /data/slack with Accept: application/json would result in

{
  "mentions": 3,
  "unread" : 72
}

while a call to /data/slack with Accept: text/plain would result in

Mentions: 5 Unread 72

The downside to this is that the idea of creating a resource via POST / data/slack doesn't really make a lot of sense. How do we design a resource that can be created / deleted that results in /data/slack?

What all do we want for a Github Status Bar? Here is the worlds ugliest little mockup to physically show what I mean

Thoughts @pengwynn ?