feat(slack-bot): add comments

oxenprogrammer · oxenprogrammer · commit e8b2705ad02b · 2021-02-01T21:15:52.000+03:00
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,2 +1,6 @@
 Style/FrozenStringLiteralComment:
+  Enable: false
+Style/FrozenStringLiteralComment:
+  Enable: false
+Naming/FileName:
   Enable: false
diff --git a/lib/command/slack_command.rb b/lib/command/slack_command.rb
@@ -1,8 +1,10 @@
+#!/usr/bin/env ruby
 require 'httparty'
 require 'nokogiri'
 
 module JokerTheNerd
   module Commands
+    # Slack bot commands
     class Jokes < SlackRubyBot::Commands::Base
       command 'jokes_image' do |client, data, _match|
         client.say(channel: data.channel, text: JokesImage.image_random_joke)
@@ -18,12 +20,14 @@ class Jokes < SlackRubyBot::Commands::Base
     end
   end
 
+  # Say hello class implementation
   class HelloText
     def self.say_hello
       'Heyyy, ready for some humors?'
     end
   end
 
+  # Text based jokes implementation
   class JokesText
     def self.text_jokes
       @text_url = 'https://upjoke.com/programmer-jokes'
@@ -37,6 +41,7 @@ def self.text_random_joke
     end
   end
 
+  # Image based jokes implentation
   class JokesImage
     def self.image_jokes
       @base_url = 'https://www.hongkiat.com/blog/programming-jokes/'
diff --git a/lib/slack-bot.rb b/lib/slack-bot.rb
@@ -4,10 +4,22 @@ class SlackBot < SlackRubyBot::Bot
       title 'Joker The Nerd Bot'
       desc 'This bot serves you with some programming humors'
 
-      command :get_all_humors do
-        title 'get_all_humors'
-        desc 'Images of humor'
-        long_desc 'Images of programming humors'
+      command :say_hello do
+        title 'Greet the Bot'
+        desc 'The Bot greets back'
+        long_desc 'The bot responds with a greeting string'
+      end
+
+      command :jokes_text do
+        title 'Joke Text'
+        desc 'Get random Programming Jokes as Text'
+        long_desc 'The Bot craws and scraps the web, returning a random joke texts'
+      end
+
+      command :jokes_image do
+        title 'Joke Image'
+        desc 'Get random Programming Jokes as Image'
+        long_desc 'The Bot craws and scraps the web, returning a random joke image'
       end
     end
   end
