feat: Refactor moderation into strategies and add tests

Refactor the moderation into strategies to be customized.
Add a bunch of tests.

Author: biximilien

Gemfile

@@ -4,8 +4,14 @@ source "https://rubygems.org"
 
 ruby "2.7.7"
 
+# discord api for ruby
 gem "discordrb"
 
+# load environment variables from .env file
+gem 'dotenv'
+
+# redis is used as backend
 gem "redis"
 
+# testing
 gem "rspec", group: :test

Gemfile.lock

@@ -13,6 +13,7 @@ GEM
       rest-client (>= 2.1.0.rc1)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.8.1)
     event_emitter (0.2.6)
     ffi (1.15.5)
     http-accept (1.7.0)
@@ -59,6 +60,7 @@ PLATFORMS
 
 DEPENDENCIES
   discordrb
+  dotenv
   redis
   rspec
 

bot.rb

@@ -5,6 +5,7 @@
 require "./lib/discord"
 require "./lib/discord/permission"
 require "./lib/backend"
+require "./lib/moderation_strategy"
 
 # setup logging
 $logger = Logger.new(STDOUT)
@@ -24,6 +25,11 @@
 
 initialize_backend()
 
+strategies = []
+strategies << WatchListStrategy.new(self)
+strategies << RemoveMessageStrategy.new(self)
+# strategies << RewriteMessageStrategy.new
+
 # bot commands
 bot.message do |event|
   $logger.info("Message from #{event.user.name} (#{event.user.id})")
@@ -55,20 +61,10 @@
       end
     end
   else
-    # watched users loop
-    if get_watch_list_users(event.server.id.to_i).include?(event.user.id.to_i)
-      case analysed = sentiment_analysis(event.message.content)
-      when /Positive/i
-        $logger.info("Sentiment Analysis: Positive")
-      when /Negative/i
-        $logger.info("Sentiment Analysis: Negative")
-        edited = moderation_rewrite(event.message.content)
-        $logger.info(edited)
-        reason = "Moderation (rewriting due to negative sentiment)"
-        event.message.delete(reason)
-        event.respond("~~#{event.message.content}~~" + "\n" + edited)
-      else
-        $logger.info("Sentiment Analysis: Neutral")
+    # execute enabled strategies
+    strategies.each do |strategy|
+      if strategy.condition(event)
+        strategy.execute(event)
       end
     end
   end
@@ -96,7 +92,10 @@
   end
 end
 
-# This method call has to be put at the end of your script, it is what makes the bot actually connect to Discord. If you
-# leave it out (try it!) the script will simply stop and the bot will not appear online.
-at_exit { bot.stop }
-bot.run
+begin
+  at_exit { bot.stop }
+  bot.run
+rescue Interrupt
+  $logger.info("Exiting...")
+  exit
+end

environment.rb

@@ -1,3 +1,6 @@
+require "dotenv"
+Dotenv.load
+
 # Environment variables
 OPENAI_API_KEY = ENV["OPENAI_API_KEY"]
 DISCORD_BOT_TOKEN = ENV["DISCORD_BOT_TOKEN"]

lib/backend.rb

@@ -3,6 +3,7 @@
 module Backend
   def initialize_backend()
     @redis ||= Redis.new(url: REDIS_URL)
+    raise "Redis connection failed" unless @redis.ping == "PONG"
   end
 
   def add_user_to_watch_list(server_id, user_id)

lib/moderation_strategy.rb

@@ -0,0 +1,61 @@
+class ModerationStrategy
+  def initialize(bot)
+    @bot = bot
+  end
+
+  def condition(event)
+    false
+  end
+
+  def execute(event)
+    nil
+  end
+end
+
+class RemoveMessageStrategy < ModerationStrategy
+  def condition(event)
+    case analysed = sentiment_analysis(event.message.content)
+    when /Positive/i
+      $logger.info("Sentiment Analysis: Positive")
+      false
+    when /Negative/i
+      $logger.info("Sentiment Analysis: Negative")
+      true
+    else
+      $logger.info("Sentiment Analysis: Neutral")
+      false
+    end
+  end
+
+  def execute(event)
+    reason = "Moderation (removing message)"
+    event.message.delete(reason)
+  end
+end
+
+class WatchListStrategy < ModerationStrategy
+  def condition(event)
+    # watched users loop
+    if @bot.get_watch_list_users(event.server.id.to_i).include?(event.user.id.to_i)
+      case analysed = sentiment_analysis(event.message.content)
+      when /Positive/i
+        $logger.info("Sentiment Analysis: Positive")
+        false
+      when /Negative/i
+        $logger.info("Sentiment Analysis: Negative")
+        true
+      else
+        $logger.info("Sentiment Analysis: Neutral")
+        false
+      end
+    end
+  end
+
+  def execute(event)
+    edited = moderation_rewrite(event.message.content)
+    $logger.info(edited)
+    reason = "Moderation (rewriting due to negative sentiment)"
+    event.message.delete(reason)
+    event.respond("~~<@#{event.user.id}>: #{event.message.content}~~" + "\n" + edited)
+  end
+end

lib/open_ai.rb

@@ -11,18 +11,19 @@ def query(url, params)
     request["Content-Type"] = "application/json"
     request["Authorization"] = "Bearer #{OPENAI_API_KEY}"
     request.body = params.to_json
-    $logger.info(request.body)
+    $logger.debug(request.body)
 
     response = http.request(request)
-    $logger.info(response.body)
+    $logger.debug(response.body)
 
     ret = JSON.parse(response.body)
-
     if ret.include?("error")
       ret["error"]
     else
       ret["choices"][0]["text"].strip
     end
+  rescue Net::ReadTimeout
+    "Timeout"
   end
 
   # query OpenAI completions API for sentiment analysis
@@ -38,6 +39,18 @@ def sentiment_analysis(text)
     })
   end
 
+  def qualify_toxicity(text)
+    query("https://api.openai.com/v1/completions", {
+      model: "text-davinci-003",
+      prompt: "Is the statement : \"#{text}\" is toxic or non-toxic?",
+      temperature: 0.7,
+      max_tokens: 256,
+      top_p: 1,
+      frequency_penalty: 0,
+      presence_penalty: 0,
+    })
+  end
+
   # moderation request
   def moderation_rewrite(text)
     query("https://api.openai.com/v1/completions", {

spec/backend_spec.rb

@@ -0,0 +1,61 @@
+require "backend"
+
+describe Backend do
+  include Backend
+
+  let(:server_id) { 123 }
+  let(:user_id) { 456 }
+
+  before do
+    @redis = Redis.new(url: REDIS_URL)
+    @redis.flushall
+  end
+
+  describe "#add_user_to_watch_list" do
+    it "adds a user to the watch list" do
+      add_user_to_watch_list(server_id, user_id)
+      expect(@redis.smembers("server_#{server_id}_users")).to include(user_id.to_s)
+    end
+  end
+
+  describe "#remove_user_from_watch_list" do
+    it "removes a user from the watch list" do
+      add_user_to_watch_list(server_id, user_id)
+      remove_user_from_watch_list(server_id, user_id)
+      expect(@redis.smembers("server_#{server_id}_users")).not_to include(user_id.to_s)
+    end
+  end
+
+  describe "#get_watch_list_users" do
+    it "returns the watch list users" do
+      add_user_to_watch_list(server_id, user_id)
+      expect(get_watch_list_users(server_id)).to include(user_id)
+    end
+  end
+
+  describe "#add_server" do
+    it "adds a server" do
+      add_server(server_id)
+      expect(@redis.smembers("servers")).to include(server_id.to_s)
+    end
+  end
+
+  describe "#remove_server" do
+    it "removes a server" do
+      add_server(server_id)
+      remove_server(server_id)
+      expect(@redis.smembers("servers")).not_to include(server_id.to_s)
+    end
+  end
+
+  describe "#get_servers" do
+    it "returns the servers" do
+      add_server(server_id)
+      expect(get_servers).to include(server_id)
+    end
+  end
+
+  after do
+    @redis.flushall
+  end
+end

spec/discord/permission_spec.rb

@@ -0,0 +1,10 @@
+require "discord"
+require "discord/permission"
+
+describe Discord::Permission do
+  describe "#ADMINISTRATOR" do
+    it "returns the administrator permission" do
+      expect(Discord::Permission::ADMINISTRATOR).to eq(8)
+    end
+  end
+end

spec/discord_spec.rb

@@ -0,0 +1,4 @@
+require "discord"
+
+describe Discord do
+end