Hogyan készítsünk SlackBot-ot a Node.js és a SlackBots.js fájlokkal

A Slack egy amerikai felhőalapú, saját fejlesztésű csapat-együttműködési szoftvereszköz és online szolgáltatás, amelyet a Slack Technologies fejlesztett ki. A Slack egy olyan munkaterület, ahol a csapatok kommunikálhatnak és együttműködhetnek.

A Slack-ben végzett csapatmunka csatornákban történik - egyetlen helyen az üzenetküldéshez, eszközökhöz és fájlokhoz -, ezzel mindenkinek segítséget nyújtva az időmegtakarításban és az együttműködésben.

A Slack egyik félelmetes jellemzője a Slack Apps, az integrációk és a Slack Bots.

A Slack bot egyfajta Slack alkalmazás, amelyet arra terveztek, hogy beszélgetést folytasson a felhasználókkal. Botja DM-eket küldhet, a felhasználók megemlíthetik, üzeneteket küldhet vagy fájlokat tölthet fel, és meghívható csatornákra. Hűvös, igaz?

Ha már használja a Slack szolgáltatást, ismernie kell néhány kreatív Slack botot, például a Standupbot, a Birthdaybot és még sok mást.

Ebben a cikkben áttekintem az első Slack botot az elejétől a végéig a Node.js és a SlackBots.js használatával.

PS: Ez a cikk először a blogomon jelent meg.

SlackBot leírás

Építünk egy egyszerű Slackbot-ot, amely véletlenszerű inspiráló technikus idézeteket és vicceket jelenít meg a fejlesztők / tervezők számára.

Építettem egy króm kiterjesztést, amely véletlenszerű inspiráló technikus idézeteket jelenít meg a fejlesztők / tervezők számára az új fülön (innen letöltheti). A JSON idézeteket ebből a kiterjesztésből fogjuk használni, mint az árajánlatok API-ját és a Chuck Norris Jokes API-t a poénokhoz.

Amikor egy felhasználó megemlíti a botunkat és inspirál , a bot egy véletlenszerű idézetet ad vissza az inspireNuggets-ból. Amikor a felhasználó véletlenszerű viccet ír be , akkor véletlenszerű viccet ad vissza a Chuck Norris API-ból. És amikor a felhasználó beírja a segítséget, visszaadja az útmutatót.

@inspirenuggets inspirál

@inspirenuggets véletlenszerű vicc

@inspirenuggets segítség

Ez a cikk valójában nem arról szól, hogy mit fogunk építeni - csak azért, hogy bemutassuk a Slack botok koncepcióját és a sajátod felépítését. Miután végigcsinálta, gondolkodhat valami máson, és létrehozhat egy másik botot, mivel sok lehetőség kínálkozik rá.

A végleges projektet itt klónozhatja vagy elágazhat.

Nagyon érdekes, igaz? Kezdjük el.

Előfeltételek

Ezt a botot a Node.js és a SlackBots.js fájlokkal építjük fel. Nem kell tudnia, hogyan kell írni a Node.js fájlt, mivel végigvezetek rajta. Ennek ellenére annak ismerete előny. Neked is kellene

  • Alapvető JavaScript ismeretek
  • ES6 JavaScript
  • Laza munkaterület
  • Némi tapasztalat a Slackről
  • Néhány verziókezelő képesség

Beállítási környezet

Először állítsuk be és telepítsük a Node.js-t és az Npm-et.

  • Töltse le a csomópontot innen. Ha már telepítette, hagyja ki ezt a lépést. Ha a csomagkezelőt szeretné telepíteni, olvassa el ezt az összes operációs rendszer esetében.
  • Ellenőrizze, hogy telepítve van-e a Node
node -v 
  • A Node.js az Npm szolgáltatással érkezik, így nem kell újra telepítenie.
npm -v 

Most, hogy a Node.js telepítése megtörtént, inicializáljuk a projektünket.

Hozza létre a projektkönyvtárát (én Slackbot-nak hívtam), és inicializálja a git-t:

git init 

Ezután hozzon létre egy index.jsfájlt:

touch index.js 

És inicializálja az Npm-et:

npm init 

Egyszerűen válaszoljon az utána következő kérdésekre. Ha problémái vannak, itt van a sajátom package.json:

{ "name": "slackbot", "version": "1.0.0", "description": "A simple Slackbot that displays random inspiring techie quotes for developers/designers.", "main": "index.js", "scripts": { "start": "index.js" }, "repository": { "type": "git", "url": "git+//github.com/BolajiAyodeji/slackbot.git" }, "author": "Bolaji Ayodeji", "license": "MIT", "bugs": { "url": "//github.com/BolajiAyodeji/slackbot/issues" }, "homepage": "//github.com/BolajiAyodeji/slackbot#readme" } 

Telepítse a függőségeket

Telepítsük és állítsuk be az összes szükséges könyvtárat.

SlackBots.js

A SlackBots.js egy Node.js könyvtár, a Slack API-val való egyszerű kezeléshez.

npm install slackbots 

In index.js:

const SlackBot = require('slackbots'); 

Axios

Az Axios egy ígéretalapú HTTP kliens a böngésző és a node.js számára. Ha ismeri a Fetch-et vagy az AJAX-ot, ez csak egy könyvtár, amely ugyanazt csinálja a hűvösebb funkciókkal. Itt láthatja őket.

npm install axios 

In index.js:

const axios = require('axios') 

Nodemon

To run a script in Node.js, you have to run node index.js. Whenever you make changes to this file, you have to rerun node index.js. This sucks when you're making so many changes like we'll be doing. That's why we need nodemon, a tool that helps develop node.js based applications by automatically restarting the node application when file changes in the directory are detected.

npm install -g nodemon 

In package.json, locate the scripts section and add a new start script:

"scripts": { "start": "node index.js" } 

If you run npm start, the file will run but won't restart on change. To fix this, use the nodemon we installed instead of node like so:

"scripts": { "start": "nodemon index.js" } 

Dotenv

I won't explain this in-depth. In a few days, I'll publish an article around environmental variables, but for now just know that we use this to hide secret keys and tokens like the Slack Access Token we would be using. This way you don't have to push your secret keys to GitHub.

There are several ways to do this, but I prefer using dotenv. Dotenv is a zero-dependency module that loads environment variables from a .env file into process.env.

npm install dotenv 

In index.js:

const dotenv = require('dotenv') dotenv.config() 

After all installation, your package.json should look like this:

{ "name": "inspireNuggetsSlackBot", "version": "1.0.0", "description": "A simple Slackbot that displays random inspiring techie quotes and jokes for developers/designers.", "main": "index.js", "scripts": { "start": "nodemon index.js" }, "repository": { "type": "git", "url": "git+//github.com/BolajiAyodeji/inspireNuggetsSlackBot.git" }, "author": "Bolaji Ayodeji", "license": "MIT", "bugs": { "url": "//github.com/BolajiAyodeji/inspireNuggetsSlackBot/issues" }, "homepage": "//github.com/BolajiAyodeji/inspireNuggetsSlackBot#readme", "devDependencies": { "dotenv": "^8.0.0" }, "dependencies": { "axios": "^0.19.0", "slackbots": "^1.2.0" } } 

Create your Slack workspace

Now that we have that all set up, we need a Slack workspace to run our bot in development. Creating a workspace is pretty easy, read this to learn more.

Register your Slack Bot

Now that you have a workspace, you should have a Slack URL with your workspace name. Mine is mekafindteam.slack.com.

Now you'll need to create a Slack App. Create one here.

Enter your App name and ensure you're in the workspace you created if you're in multiple workspaces.

Now you'll see the settings > Basic Information page. Click the first tab Add features and functionality:

Since we're building a bot, select the Bots field.

Now you'll see the Bot user page:

Click the Add a Bot User button.

Your display name will automatically be filled in from your already chosen App name. You can update it, but I'll advise you use the same name everywhere with the same alphabet case to avoid errors.

Now, toggle the Always Show My Bot as Online switch to always show your bot as Online. Remember this bot is just like a user in your workspace. Afterwards, click the Add Bot User button.

Save all changes now:

Next, return to the Basic Information page and select the Install your app to your workspace tab.

Click the Install App to Workspace:

Click allow and wait to be redirected back to the Basic Information page.

Note the Manage distribution tab: this section is needed when you want to make your Bot available for installation by others. For now we're just building in development and I won't be covering distribution in this article. In my next article, I'll show you how to deploy your Slack bot and make it available as an App to other workspaces.

If you check your Slack workspace now, you should see the App installed in the Apps section.

For now, it's offline - once we start building the bot, we'll turn this on.

Customize your Slack bot

Now we've created our bot, let's do some customization.

Still, on the Basic Information page, scroll down to the Display Information section:

This is basic stuff: just upload a logo, change your background color, and add a short description.

Your icon should be 512x512px or bigger and your background color should be in HEX. Read more on the App guidelines here.

Here's what mine looks like after customization:

Slack bot OAuth Tokens

Now that we have our Slack bot setup, let's grab out token keys.

In the navigation bar, locate the Features section and click the OAuth & Permission tab:

You'll see two Access Tokens:

  • OAuth Access Token
  • Bot User OAuth Access Token

Copy the Bot User OAuth Access Token.

Ez minden alkalommal megváltozik, amikor újratelepíti ezt az alkalmazást, vagy ha egy másik munkaterületre telepíti. A jelzőnek ezzel kell kezdődnie xoxb-.

A hitelesítő adatok biztonságának megőrzése fontos, függetlenül attól, hogy nyílt forráskódú könyvtárakat és eszközöket fejleszt, belső integrációkat biztosít a munkaterülethez, vagy a Slack alkalmazásokat terjeszti a munkaterületekre az egész világon. - Laza

Ezért telepítettük a Dotenv-t - ezt a következő szakaszban állítjuk be.

A bot építése

Most építsük fel a botunkat :).

Először tartsuk valahol az Access Tokenünket.

Hozzon létre egy .envfájlt, és adja hozzá ezt:

BOT_TOKEN=YOUR_SLACK_ACCESS_TOKEN_HERE 

Most kezdjük el a SlackBot.js-t:

const bot = new SlackBot({ token: `${process.env.BOT_TOKEN}`, name: 'inspirenuggets' }) 

Nemrég hoztunk létre egy bot változót, amely inicializálja az új SlackBot példányt, amelynek két értéke van, a tokenünk és az alkalmazásunk neve.

I used the ES6 template string syntax to bring in our token key from our .env file. dotenv has this covered for us.

Make sure you use the same name you used while creating your Slack app, or else you'll have authentication errors.

Now start the app:

npm start 

nodemon should be running now and our Slack app should be online too.

Start handler

Our Bot does nothing now even though it's running. Let's return a message.

bot.on('start', () => { const params = { icon_emoji: ':robot_face:' } bot.postMessageToChannel( 'random', 'Get inspired while working with @inspirenuggets', params ); }) 

The bot.on handler sends the welcome message. We passed two parameters, the 'start' and a function which holds a params variable which also holds the slack emoji. Slack emoji have codes, and you can find them here. I used :robot_face:, but you can change this to your preferred emoji.

We also initialized the bot.postMessageToChannel function which is a SlackBot.js method to post a message to a channel. In this function, we pass the channel name we want to post to, the message in a string, and the params variable we declared earlier for the emoji. I used the #random channel and sent Get inspired while working with @inspirenuggets to it. Your app should restart automatically and your bot should do this:

Cool right?

You can also post messages to users and groups.

 // define existing username instead of 'user_name' bot.postMessageToUser('user_name', 'Hello world!', params); // define private group instead of 'private_group', where bot exist bot.postMessageToGroup('private_group', 'Hello world!', params); 

Error Handler

Let's also write a function to check for errors and return them:

bot.on('error', (err) => { console.log(err); }) 

Message Handler

Now let's build the main bot functionality.

Like I said earlier, we'll be using the quotes JSON from the extension I built as our quotes API. The JSON can be found with this URL: //raw.githubusercontent.com/BolajiAyodeji/inspireNuggets/master/src/quotes.json

When a user mentions our bot and adds inspire me, the bot returns a random quote from inspireNuggets. When the user types random joke, it returns a random joke from the Chuck Norris API. And when the user types help, it returns the instruction guide.

First, let's check for our command words from the user message (inspire me, random joke, and help):

function handleMessage(message) { if(message.includes(' inspire me')) { inspireMe() } else if(message.includes(' random joke')) { randomJoke() } else if(message.includes(' help')) { runHelp() } } 

Now let's create the three function we need

inspireMe()

Our demo JSON is not really an API, it's just some JSON I used in the Chrome Extension. We're only accessing it from GitHub raw contents. You can use any API you prefer, you'll just have to iterate differently to get your data depending on if your API returns an array or object - whichever it returns, it's not a big deal.

Check out my previous articles on:

  • Manipulating Arrays in JavaScript and
  • Iterating through JavaScript Objects  -  5 Techniques and Performance Tests.
function inspireMe() { axios.get('//raw.githubusercontent.com/BolajiAyodeji/inspireNuggets/master/src/quotes.json') .then(res => { const quotes = res.data; const random = Math.floor(Math.random() * quotes.length); const quote = quotes[random].quote const author = quotes[random].author const params = { icon_emoji: ':male-technologist:' } bot.postMessageToChannel( 'random', `:zap: ${quote} - *${author}*`, params ); }) } 

We just used Axios to get the JSON file which returns some data:

[ { "number": "1", "author": "Von R. Glitschka", "quote": "The client may be king, but he's not the art director." }, { "number": "2", "author": "Frank Capra", "quote": "A hunch is creativity trying to tell you something." }, . . . . ] 

This JSON currently contains 210 quotes and I update them frequently. So we want to get a random quote plus the author name every time the user request it. From our Axios response, we just do this:

 const quotes = res.data; const random = Math.floor(Math.random() * quotes.length); const quote = quotes[random].quote const author = quotes[random].author 

And just like we did with the welcome message, we just return the quote and author instead of a string message:

`:zap: ${quote} - *${author}*`

Let's test this:

Type @inspirenuggets inspire me

Yayyy! It worked!

PS: You can always change the emoji type for every request. If you noticed I changed the inspireMe() to :male-technologist:

randomJoke()

We're getting the jokes from the Chuck Norris API from this endpoint //api.chucknorris.io/jokes/random.

{ "categories": [], "created_at": "2016-05-01 10:51:41.584544", "icon_url": "//assets.chucknorris.host/img/avatar/chuck-norris.png", "id": "6vUvusBeSVqdsU9C5-ZJZw", "updated_at": "2016-05-01 10:51:41.584544", "url": "//api.chucknorris.io/jokes/6vUvusBeSVqdsU9C5-ZJZw", "value": "Chuck Norris once choked a wildcat to death with his sphincter muscle." } 

This is a real API that returns a random joke on every request, so we don't have to do Math.floor() again.

function randomJoke() { axios.get('//api.chucknorris.io/jokes/random') .then(res => { const joke = res.data.value; const params = { icon_emoji: ':smile:' } bot.postMessageToChannel( 'random', `:zap: ${joke}`, params ); }) } 

By now, you should understand how this works already. Make a post with the channel name, message and params.

runHelp()

This is similar to our welcome message: we just want to return a custom text when the user adds help to the request.

function runHelp() { const params = { icon_emoji: ':question:' } bot.postMessageToChannel( 'random', `Type *@inspirenuggets* with *inspire me* to get an inspiring techie quote, *random joke* to get a Chuck Norris random joke and *help* to get this instruction again`, params ); } 

Now let's test all three commands:

Everything works fine now, congratulations!!!! You just built your SlackBot.

There are an endless number of possibilities of Bots you can build with this to automate your own work or teamwork.

You can build a bot that:

  • Fetches your tasks from somewhere and reminds you when you type hey what next,
  • Welcomes every user to your workspace (I built this during one of the HNG Internship's),
  • Gives you football matches updates while you're working,
  • Tells your team when you hit a milestone in number of registered users,

and many more...

It's just about having somewhere to get the data from, and some basic iteration skills and the bot.postMessageToChannel() method.

Automation is one thing we should learn as developers. We have a lot to do, so we should automate the simpler tasks so we have time for the more difficult ones. I hope with this you can automate your tasks and I look forward to the creative ideas you'll bring to life.

Final Code

Here's our final index.js

const SlackBot = require('slackbots'); const axios = require('axios') const dotenv = require('dotenv') dotenv.config() const bot = new SlackBot({ token: `${process.env.BOT_TOKEN}`, name: 'inspirenuggets' }) // Start Handler bot.on('start', () => { const params = { icon_emoji: ':robot_face:' } bot.postMessageToChannel( 'random', 'Get inspired while working with @inspirenuggets', params ); }) // Error Handler bot.on('error', (err) => { console.log(err); }) // Message Handler bot.on('message', (data) => { if(data.type !== 'message') { return; } handleMessage(data.text); }) // Response Handler function handleMessage(message) { if(message.includes(' inspire me')) { inspireMe() } else if(message.includes(' random joke')) { randomJoke() } else if(message.includes(' help')) { runHelp() } } // inspire Me function inspireMe() { axios.get('//raw.githubusercontent.com/BolajiAyodeji/inspireNuggets/master/src/quotes.json') .then(res => { const quotes = res.data; const random = Math.floor(Math.random() * quotes.length); const quote = quotes[random].quote const author = quotes[random].author const params = { icon_emoji: ':male-technologist:' } bot.postMessageToChannel( 'random', `:zap: ${quote} - *${author}*`, params ); }) } // Random Joke function randomJoke() { axios.get('//api.chucknorris.io/jokes/random') .then(res => { const joke = res.data.value; const params = { icon_emoji: ':smile:' } bot.postMessageToChannel( 'random', `:zap: ${joke}`, params ); }) } // Show Help function runHelp() { const params = { icon_emoji: ':question:' } bot.postMessageToChannel( 'random', `Type *@inspirenuggets* with *inspire me* to get an inspiring techie quote, *random joke* to get a Chuck Norris random joke and *help* to get this instruction again`, params ); }

What Next?

Our bot only runs in development now, and to use it we always have to npm start.

This isn't cool, right? We'll want to host it somewhere it can run every time. In my next article, I'll show you how to host this on either Heroku, Zeit or Netlify and publish it to the Slack Apps store so anyone around the world can use it.

Also, don't forget to add this in your .gitignore before pushing to GitHub:

 /.env /node_modules 
Subscribe to my newsletter to get updated.

Useful Resources

  • Slack API
  • Slack API Docs
  • SlackBot.js
  • Slack Apps
  • Slack Apps Guidelines
  • An introduction to Slack apps
  • inspireNuggets
  • inspireNuggetsSlackBot