Ruby Slack Bot

In this particular project, i have decided to build a bot based in Ruby. The main theme of this project is to apply best ruby coding practice.

Built With

• Ruby

Getting Started

• if you don't want to start from scratch jump to clone section

• Prerequisites

  • make sure you have Ruby installed locally
  • make sure you have a code edditor.
  • make sure you have a slack workspace if not create a new slack workspace here

• Starting the project from scratch

  • if you are about to start the project from scratch you need to do a few following steps.

  1. First navigate to your Terminal in your machine and type mkdir followed by the name you want your project to be.
  2. Then navigate to that directory by typing cd followed by the name you have given the project previously.
  3. Type bundle init on your Terminal to create a Gemfile.
  4. Type code . if you are using Visual Studio Code or subl . if you are using Sublime or atom . if you are using Atom(this is done to open your project in the code edditor)

  5. You need to add the following gems to the Gemfile

  gem 'slack-ruby-bot'
  gem 'dotenv'
  gem 'wolfram', '~> 0.2.1'
  gem 'http'
  gem 'screencap'
  gem 'imgur2'
  gem 'async-websocket', '~> 0.8.0'
  gem 'rack'
  gem 'rss'

  6. run bundle install to install all the gems to your project.
  7. Create two directories named lib and bin
  8. In you bin folder add a file named .env and add your slack api token SLACK_API_TOKEN=your_token_from_slack
  • In that same folder with the .env file add a .gitignore file and add .env to it.
    
  • In that same folder add config.ru file and add the following code to it.
    

    require 'slack-ruby-bot'
    require 'dotenv'
    Dotenv.load
    require 'uri'
    require 'http'
    require 'json'
    require 'screencap'
    require 'imgur2'
    require 'rss'
    require 'open-uri'
    
    require_relative '../lib/rubybot'
    
    RubyBot::App.instance.run

  9. in the lib folder create the following files

  • 1. rubybot.rb which contains the follwing code

  module RubyBot
    require_relative './greetings'
    require_relative './inspirations'
    require_relative './insults'
    require_relative './help'
    class App < SlackRubyBot::App
    end
  
    class Hi < SlackRubyBot::Commands::Base
      command 'hi' do |client, data, _match|
        client.say(channel: data.channel, text: HelloText.say_hello)
      end
    end
  
    class PassGreeting < SlackRubyBot::Commands::Base
      command 'greet' do |client, data, _match|
        greeting_quotes = ['good morning user! how can i help you?', 'good evening user! how can i help you']
        greets = Greetings.new(greeting_quotes)
        client.say(channel: data.channel, text: greets.greet(greeting_quotes))
      end
    end
  
    class Screenshot < SlackRubyBot::Commands::Base
      command 'screenshot' do |client, data, match|
        url = URI(match[:expression].match(/<(.*)/)[1])
  
        if url
          fetcher_object = Screencap::Fetcher.new(url.to_s)
          screenshot = fetcher_object.fetch width: 1700, height: 850
          imgur_client = Imgur2.new ENV['IMGUR_API']
          url = imgur_client.upload screenshot
          image_url = url['upload']['links']['original']
          client.message text: image_url, channel: data.channel
        else
          client.message text: "#{_match[:expression]}  isn't a URL", channel: data.channel
        end
      end
    end
  
    class Insulting < SlackRubyBot::Commands::Base
      command 'insult' do |client, data, _match|
        # rubocop:disable Layout/LineLength
        insults = ['My battery lasts longer than your relationships.', 'Im surprised at your level of stupidity.', 'Life is good you should get one.', 'Please don’t interupt me when Im ignoring you.', 'You are known as an idiot savant minus the savant.', 'I never insult any people I only tell them what they are.', 'Did you forget your brain in your mothers womb? Cause I’m pretty sure you did.', 'The degree of your stupidity is enough to boil water.', 'Of course I talk like an idiot. How else could you understand me?', 'I respect those who hate me by showing my middle finger.', 'If you look up the definition of moron in the dictionary there will be a picture of you.']
        # rubocop:enable Layout/LineLength
        insult = Insults.new(insults)
        client.say(channel: data.channel, text: insult.insult(insults))
      end
    end
  
    class Inspiring < SlackRubyBot::Commands::Base
      command 'inspire_me' do |client, data, _match|
        # rubocop:disable Layout/LineLength
        inspiration_quotes = ['Experience is the name everyone gives to their mistakes.', 'When to use iterative development? You should use iterative development on projects that you want to succeed.', 'Code is like humor. When you have to explain it. its bad.', 'Fix the cause not the symptom.', 'Make it work make it right make it fast.', 'Simplicity is the soul of efficiency.', 'Sometimes it pays to stay in bed on Monday rather than spending the rest of the week debugging Monday code.', 'Write it. Shoot it. Publish it. Crochet it saute it whatever. MAKE.']
        # rubocop:enable Layout/LineLength
        inspiree = Inspiration.new(inspiration_quotes)
        client.say(channel: data.channel, text: inspiree.inspire(inspiration_quotes))
      end
    end
  end

  • 2. greetings.rb which contains the following code

    class HelloText
      def self.say_hello
        'Hie this is a bot built by Tongoona Mujera'
      end
    end
    
    class Greetings
      attr_accessor :greeting
    
      def initialize(greeting)
        @greeting = greeting
      end
    
      def greet(_greeting)
        greet_help
      end
    
      private
      def greet_help
        t = Time.new
        if t.hour.to_i >= 1 && t.hour.to_i < 11
          @greeting.first
        elsif t.hour.to_i >= 11 && t.hour.to_i <= 15
          'good afternoon user, how can i help you?'
        else
          @greeting.last
        end
      end
    end

  • 3. inspirations.rb Which contains the following code

  class Inspiration
    attr_accessor :inspirations
  
    def initialize(inspirations)
      @inspirations = inspirations
    end
  
    def inspire(_inspirations)
      inspire_priv
    end
  
    private
    def inspire_priv
      @inspirations.sample
    end
  end

  • 4. insults.rb which contains the following code

  class Insults
    attr_accessor :insults
  
    def initialize(insults)
      @insults = insults
    end
  
    def insult(_insults)
      insult_priv
    end
  
    private
    def insult_priv
      @insults.sample
    end
  end

Clone

 git clone https://github.com/tongoonamujera/Slack_bot_ruby.git

• To get a local copy up and running, follow these simple example steps.
• Open a terminal window and enter git clone https://github.com/tongoonamujera/Slack_bot_ruby.git
• Make your new cloned directory your active directory by typing cd Slack_bot_ruby
• Currently, you are in the "development branch."
• Enter git checkout feature to navigate to feature branch
• Remember to run bundle to install gems to your cloned project

Usage

• Create a new slack bot (you can use this link to create a slack bot)
• You can choose a name of your choice and then click the green button (Add Bot Intergration)
• You can be redirected to a new page remember to copy your SLACK_API_TOKEN and paste it to your .env file in the bin folder.
• Now you can click the green button to Save Bot Intergration
• Navigate to your slack workspace and invite your_bot to any channel of your choice
• To test your code make sure you are i the directory containing config.ru file
• To intergrate your local server with slack just run bundle exec rackup in your Terminal
• navigate to your slack workspace to the channel you have added your bot @name_of_your_bot followed by the command help to get list of commands you can enter to interact with your bot

Authors

👤 Tongoona Mujera

• Github: @tongoonamujera
• Twitter: @tongomujera
• Linkedin: tongoona-mujera
• Email: tongoonamujera@gmail.com

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project.!

📝 License

This project is MIT licensed.