hjerpbakk/slackprofilebot

Simple Slackbot for validating user profiles.

Profilebot - the profile checking Slackbot for you!

In a large Slack team, it's important that user profiles are completed enough for the users to recognise each other. Profilebot is a simple bot used for validating Slack user profiles. It is written in C# and it's easy to extend for all your profile checking needs. It runs out of the box either as a console app (Windows) or a Windows service.

Usage in Slack

Profilebot runs like any other Slackbot. Open a direct message to Profilebot and start talking.

As admin

If you are the admin of Profilebot, the following commands are available for you:

• validate all users
• notify all users
• validate @user
• notify @user
• whitelist @user

Validating will inform you of the user's profile status, while notify will also send a direct message to the specific user(s).

As a regular user

As a regular user, anything you say will have the same effect: Profilebot will look at your profile and tell you if any information is missing.

Download & setup

1. Clone the repository: git clone https://github.com/Sankra/SlackProfilebot.git

2. Go to Hjerpbakk.Profilebot.Runner/Configuration and create a copy of config.default.json.

3. Rename the copy to config.json.

4. Go to your Team's Slack bot integration page.

5. Enter 'profilebot' as the Username and click the 'Add Bot Integration' button.

6. Copy the generated API token and paste it as your apiToken in config.json:

   {
   	"apiToken": "xxxx-00000000000-xxxxxxxxxxxxxxxxxxxxxxxx",
   	"adminUserId": ""  
   }
   

7. One user must be configured to be Profilebots admin user. This need not be an actual Slack admin, but the id must be a valid user id in the Slack team. Run https://api.slack.com/methods/users.list/test to find the user id you want to use.

8. Copy the user id and paste it as your adminUserId in config.json:

   {
   	"apiToken": "xxxx-00000000000-xxxxxxxxxxxxxxxxxxxxxxxx",
   	"adminUserId": "x0xxx0000"  
   }
   

9. Build and run Hjerpbakk.Profilebot.sln.

You should now be able to send direct messages to Profilebot in your team's Slack.

Customize the profile validation

At my company, DIPS AS we use the following validation rules:

• The email used must be a DIPS AS email
• Username must be the same as in all other internal systems
• Both first name and last name must be given
• What I do must tell others what you do
• A profile image must be set and be a picture of a human face

Customising the profile validation is easy, and you have two choices for how to do this.

1. Extend SlackProfileValidator

Open Hjerpbakk.ProfileBot.SlackProfileValidator and edit the ProfileValidationResult ValidateProfile(SlackUser user) method.

2. Inherit from ISlackProfileValidator and create your own validator

1. Create a new class and inherit from ISlackProfileValidator.
2. In Hjerpbakk.ProfileBot.Runner.ProfileBotHost, edit the IServiceContainer CompositionRoot(string slackToken, string adminUserId) method. Instead of serviceContainer.Register<ISlackProfileValidator, SlackProfileValidator>();, register your own validation class.

Running

Thanks to Topshelf, running Profilebot either as a service or a console app is super easy.

To run as a console app, just run Hjerpbakk.Profilebot.Runner.exe. To exit, press CTRL + C.

To install as a service, simply run the following in command prompt:

Hjerpbakk.Profilebot.Runner.exe install
Hjerpbakk.Profilebot.Runner.exe start

slackprofilebot's Issues

Show whitelist

Create an automated build

Improve config handling

People on vacation should not be notified

Build Docker image as part of build process

List of available commands should automatically be populated based on available commands

Saved by accident

XUnit test should be runnable from VS' default test runner

Clone into @dipsasa repo and upload the SlackProfileChecker that we use internally

Find a correct collection of packages, removing the need for redirects in app.config

Remove user from whitelist

Create a readme at least as good as this: https://github.com/noobot/noobot

Use Azure cognitive services to verify the image is of a human

Link @dipsasa internal SlackProfileChecker from the documentation

Move logic from MessageReceived into the specific command classes?

Guests should not be validated as thoroughly as regular employees