npm/captain-hook

slack bot that provides subscription service for npm webhooks

captain-hook

a slack bot to subscribe to npm webhook notifications

usage

/captain-hook subscribe <type: package||organization> <name> <sharedsecret>

local dev

captain-hook is a NodeJS application. if you don't have NodeJS you'll need to download it.

captain-hook uses a Postgres database.

up and running

1. Fork and clone this repo
2. cd captain-hook
3. npm install
4. Copy .envsample to .env and fill it out

variable	description
SLACK_API_TOKEN	Bot API token. You can find this on the Slack Developers site by navigating: Browse Apps > Custom Integrations > Bots Configurations on {{team_name}} > Edit configuration
SLACK_CHANNEL_ID	Name of the channel, i.e. #testing. Can also be ID number retrieved from the Slack API.
SHARED_SECRET	Any string.
DATABASE_URL	URL of your Postgres database. defaults to localhost:5432/dev

5. npm db:setup, creates a Postgres db, then runs Knex migrations and seeds
6. npm run dev, runs npm start and pipes output to nice logging You now have a service running on localhost:6666. You'll probably want to expose that to the internet for local development. ngrok is a great, free option.

web interface

the captain hook web interface is an express app. it servers basic CRUD functionality for the two resources: users and subscriptions.

to start it, run npm run start:web and then visit http://localhost:8080.

captain-hook's Issues

we want users to be able to list their hooks

Add support for `help`

Someone typing /captain-hook help should give them the syntax back

Web interface

Currently, working on captain hook largely would be nicer if we had a web interface that gives us a CRUD api for what we keep in the DB

Access said API, at this point, is wired up as an express app (see: https://github.com/npm/captain-hook/blob/master/src/lib/api.js)

Express is a pretty good solution for this (though we could keep restify around for consistency).

General things needed:

Something to handle views.
Something to handle deployment of both apps at once (likely another port)

MORE STUFF WHEN I REMEMBER TO COME BACK TO THIS ISSUE LATER

when a user tries to subscribe to a package we should verify that it is exists/they have access

Not found: `@npmcorp/npm-hook-receiver`

I received this error message when I executed npm install in the project's directory:

Not found : @npmcorp/npm-hook-receiver

I checked the status of the module on npmjs.org and realised it hasn't been downloaded yet.

Does this mean it hasn't been made public yet?

we need to know the user's npm credentials

https://gist.github.com/ashleygwilliams/3d56726ea014675b9bceac8754042906#authenticating-a-request

currently auth using bearer token in .env

we want users to be able to unsubscribe

we need to persist users subscriptions

we want to DM users

in order to DM users we need to, on user creation:

• get user id (https://api.slack.com/methods/users.identity)
• open im with user (https://api.slack.com/methods/im.open)
• save im id as slack_im_id in users model

update hooks endpoint when hooks/5 lands

https://github.com/npm/hooks/pull/5