OperationCode Bot is a bot built to deal with the Slack Events API. When a subscribed event occurs:

• Slack sends a POST to this bot
• The bot processes the event and calls a method with the same name as the event passed in
• The event named method does whatever tasks are needed

In the current case when a new user signs up they are sent a welcome message with keywords. The user can respond to this message with one of the keywords to get more info on that subject. In the one specific case of joining our mentorship program if the user replies in the affirmative they are invited to a mentorship squad and added to our airtables base.

• Clone this repo

• Run

  $ bundle

• Run the tests with

  $ rake

When a user messages the bot the code in lib/event/message.rb is executed. To add a new keyword we'll start there.

Add your new keyword to the KEYWORDS constant. The name key is what the user will type to access this keyword, and the help_text key will be displayed when someone types 'help' and in the welcome message.

Next navigate to views/event/message. Create a new file called $NAME_message.txt.erb, where $NAME is the name of your keyword above. Now just create the text you'd like to be sent to the user in this file and create a PR with your changes. The text in this file can use the features of the Slack message formatting guide.

To create a new event simply define a new method with the same name as the method you want to handle. For example, if you wanted to write some code any time someone pins an item (the pin_added event) you would define a new method like so:

def pin_added(data, token: nil)
  logger.add "Got pin_added event with data: #{data}"
  empty_response
end

You can now write your business logic inside of this method. If your logic is complex (more than a 5-10 lines) I'd recommend using a ruby object. There is an Event class that can be inherited from to make your life a bit easier. See Event::TeamJoin as a reference.

Bug reports and pull requests are welcome on GitHub at https://github.com/OperationCode/operation_code_bot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.