├── .gitignore ├── LICENSE ├── README.md ├── docs ├── CREATE_BOT.md ├── api_token.png └── create_bot.png ├── index.js ├── package.json └── plugins └── welcome.js /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | 6 | # Runtime data 7 | pids 8 | *.pid 9 | *.seed 10 | 11 | # Directory for instrumented libs generated by jscoverage/JSCover 12 | lib-cov 13 | 14 | # Coverage directory used by tools like istanbul 15 | coverage 16 | 17 | # nyc test coverage 18 | .nyc_output 19 | 20 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 21 | .grunt 22 | 23 | # node-waf configuration 24 | .lock-wscript 25 | 26 | # Compiled binary addons (http://nodejs.org/api/addons.html) 27 | build/Release 28 | 29 | # Dependency directories 30 | node_modules 31 | jspm_packages 32 | 33 | # Optional npm cache directory 34 | .npm 35 | 36 | # Optional REPL history 37 | .node_repl_history 38 | 39 | .idea 40 | .env 41 | db/ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # pizza-bot 2 | Learn how to order :pizza: from Slack 3 | 4 | ## Welcome Pizza Botter 5 | 6 | Howdy :wave: We're going to build a bot today. An awesome bot that will order you hot, delicious pizza. 7 | From Domino's. So, hot pizza. Well, maybe not hot, but definitely at least warm pizza. From Domino's. 8 | OK, let's not get hung up on the definitions of "pizza" or "food". The bot will be awesome, I promise. 9 | 10 | Whether or not you actually want to _eat_ Domino's "pizza", this project will show us how to take a fun idea (a Slack bot that delivers pizza), break it down into small and manageable steps, and work with real-life (sometimes messy) external libraries to make your idea become a real thing. 11 | 12 | Before we begin, let's do a little set up. 13 | 14 | ## Things You Need Before We Start 15 | 16 | ### Node 17 | 18 | You will need to have Node installed on your machine. The libraries we use require Node 4+ (the examples in this repo use the current release, Node 6). 19 | If you have an older version, check out [nvm](https://github.com/creationix/nvm) to upgrade. 20 | 21 | Check if you have Node installed by typing `node --version` in your terminal. If you get an error, download it here: https://nodejs.org/en/download/ 22 | 23 | ### Git 24 | 25 | You will need to have Git installed as well. One quick way to do this is to install GitHub Desktop. 26 | 27 | Check if you have Git installed by typing `git --version` in your terminal. If you get an error, download it here: https://desktop.github.com/ 28 | 29 | ### GitHub Account 30 | 31 | https://github.com/join 32 | 33 | Sign up for a GitHub account. If you want to clone the code locally and push changes, you'll 34 | need to [generate](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/) an SSH key 35 | and [upload](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/) it to GitHub. 36 | 37 | 38 | ## Break Into Teams 39 | 40 | Get into teams of 2-3. 41 | 42 | Once you are in teams, pick your team name and create a public Slack channel. Invite the workshop instructor, assistants and everyone on your team using the `/invite` command. 43 | 44 | Once you have your team channel set up, DM your team name to the instructor, and they will give you a Slack API token. 45 | 46 | ## Set Up The Project 47 | 48 | We will be pair programming during this workshop. One person on the team should fork the repo (see below). Everyone else on the team can clone that copy to their machines and follow the setup steps below. 49 | 50 | ### Fork this repo 51 | 52 | You won't be able to make changes to this example repo, so you will need to fork it (make a copy of it). Have one person click the "Fork" button in the upper right hand corner of this repo. This will give you your own copy of this example repo to work with in your Github account. 53 | 54 | You will be using one repo for your team so add everyone on your team as a "collaborator". You can do that at `https://github.com//pizza-bot/settings/collaboration`. 55 | 56 | ### Clone Your Forked Version 57 | 58 | Make a local copy of your version using the `git clone` command. Use the "Clone or Download" button to get the URL to your copy of the project. 59 | 60 | Type `cd pizza-bot` to change your working directory into your copy of the repo. 61 | 62 | ### Create a .env File 63 | 64 | Create a file named `.env` in the root of your project. Add this line to the file: 65 | 66 | ```bash 67 | export SLACK_TOKEN=replace_me 68 | ``` 69 | 70 | If you are comfortable creating your own Slack API token, you can follow [these instructions](./docs/CREATE_BOT.md). Otherwise, ask a mentor to create one for you. Once you have a Slack API token, replace `replace_me` with the token. 71 | 72 | Once you have your token, open a terminal and type: 73 | 74 | ```bash 75 | source .env 76 | ``` 77 | 78 | This will expose the variables in your `.env` file to the current terminal session. **You will need to 79 | type `source .env` for each new terminal window you open.** If you see this error `Missing configuration. Config must 80 | include either slackToken AND/OR clientId, clientSecret, and port` you forgot to type `source .env` :smile: 81 | 82 | ### Install Depedencies 83 | 84 | Use `npm install` in the root of your project to install all the project dependencies. 85 | 86 | ## Start Your Bot 87 | 88 | This project uses `npm` scripts to perform tasks. You can find them in the `package.json` file. 89 | 90 | Type `npm start` in a terminal window to start your bot. Find your bot in Slack and it should have a green active icon next to it. If you don't see that, check your terminal for logs (did you remember to `source .env`?). 91 | 92 | In Slack type `hello bot` and see if it responds. You can also type `@ help` to see what help commands it has. 93 | 94 | Heads up: your bot will restart on every code change. This is a great feature for development, not so useful in production :smile: 95 | 96 | ## First Exercise 97 | 98 | Once you have your bot running, it's time to dig in! Take a look at the README in this branch for the first exercise: 99 | https://github.com/SparkPost/pizza-bot/tree/01-plugin 100 | -------------------------------------------------------------------------------- /docs/CREATE_BOT.md: -------------------------------------------------------------------------------- 1 | # Creating a Slack Bot 2 | Follow these steps to generate a Slack API Token needed to create your Slack Bot. 3 | 4 | 1. Go to [Bot New Configuration Page](https://sparkpostpizzabot.slack.com/apps/new/A0F7YS25R-bots). 5 | 2. Enter your team name + '-bot' for the bot name. 6 | ![Create Bot Screenshot](./create_bot.png) 7 | 3. Click "Add bot integration" 8 | 4. Copy the API Token and paste it in your .env file. 9 | ![API Token Screenshot](./api_token.png) 10 | 5. Scroll to the bottom of the page and click "Save Integration" 11 | -------------------------------------------------------------------------------- /docs/api_token.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SparkPost/pizza-bot/920e078686488eb798de2d7a5b02d4ef65e3d54f/docs/api_token.png -------------------------------------------------------------------------------- /docs/create_bot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SparkPost/pizza-bot/920e078686488eb798de2d7a5b02d4ef65e3d54f/docs/create_bot.png -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | 3 | require('skellington')({ 4 | slackToken: process.env.SLACK_TOKEN, 5 | plugins: [require('./plugins/welcome')] 6 | }) 7 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "pizza-bot", 3 | "version": "0.0.1", 4 | "description": "Order 🍕 from Slack", 5 | "main": "index.js", 6 | "scripts": { 7 | "start": "nodemon --ignore db/ index", 8 | "test": "standard index.js plugins/*.js --fix" 9 | }, 10 | "repository": { 11 | "type": "git", 12 | "url": "git+https://github.com/SparkPost/pizza-bot.git" 13 | }, 14 | "keywords": [ 15 | "pizza", 16 | "slack", 17 | "bot" 18 | ], 19 | "author": "SparkPost", 20 | "license": "Apache-2.0", 21 | "bugs": { 22 | "url": "https://github.com/SparkPost/pizza-bot/issues" 23 | }, 24 | "homepage": "https://github.com/SparkPost/pizza-bot#readme", 25 | "dependencies": { 26 | "dominos": "^2.1.1", 27 | "skellington": "^1.1.1", 28 | "skellington-logger": "^1.1.0" 29 | }, 30 | "devDependencies": { 31 | "nodemon": "^1.11.0", 32 | "standard": "^9.0.1" 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /plugins/welcome.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | init: (controller) => { 3 | controller.hears([/hello bot/], ['direct_message', 'ambient'], (bot, message) => { 4 | bot.reply(message, `Howdy! My name is <@${bot.identity.id}>, good to meet you <@${message.user}>.`) 5 | }) 6 | }, 7 | help: { 8 | command: 'welcome', 9 | text: `Say "hello bot" and I'll give ya a shout` 10 | } 11 | } 12 | --------------------------------------------------------------------------------