commandrb 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6822eef019c15386f6d8915e2f4652ed22ce977f
-  data.tar.gz: d99a5734a08845743616e3bd3921e68ea83456e1
+SHA256:
+  metadata.gz: a71ccd55615cb29fa0a400e3fd29b543d3ce8d52d264646be9e50d2b824790bd
+  data.tar.gz: cc5f60c22142653ac2b9b3a2504c083329ea382738c07c9bc6f9c6f4966e519c
 SHA512:
-  metadata.gz: 66ad55bd73df84f41c3f9cd102ea10f0e4f8aa346400bc552ffcca999217585245502bade76c52f0d5f11fe5e60498780ff006d28d297dcc31814638a7257e32
-  data.tar.gz: 63369fdb6ab5ed5b4e1d737701a8f13e14c4c9b70b1e87b9ada5b1e2642ee1721e4bdccb4f8b0fa39980431533e45e5e9e2fc6a82b595d62d476320cb99845c2
+  metadata.gz: 23cc6f6e1cf7f67c05d555794cd700c9a8ab8d0a5e329543e1c58e8219c61ef3e64a02b9de45b020cd22b7bed21639124ecf60f196e154c2f49398c3dc1ee364
+  data.tar.gz: 1fdd79b3754dc7e156ac365723efdb2589b56f4a04adda1309b04ce62e69cfa23641ae1dd48631cc461bf3495367e80e5a765df48443dd9d52b9f4f6c3f93ff0

data/lib/commandrb.rb

@@ -1,9 +1,8 @@
+# frozen_string_literal: true
+
 require_relative 'helper'
 
 class CommandrbBot
-  
-  ENV['COMMANDRB_MODE'] == 'debug' ? @debug_mode = true : @debug_mode = false
-
   # Be able to adjust the config on the fly.
   attr_accessor :config
 
@@ -16,7 +15,6 @@ class CommandrbBot
   # Lets you change global prefixes while the bot is running (Not recommended!)
   attr_accessor :prefixes
 
-
   def add_command(name, attributes = {})
     @commands[name.to_sym] = attributes
   end
@@ -24,13 +22,22 @@ class CommandrbBot
   def remove_command(name)
     begin
       @commands.delete(name)
-    rescue
+    rescue StandardError
       return false
     end
     true
   end
 
+  # By defining this separately, we allow you to overwrite it and use your own owner list.
+  # Your checks will instead be run by commandrb and allow you to use :owner_only as normal.
+  def owner?(id)
+    @config[:owners].include?(id)
+  end
+
+  alias is_owner? owner?
+
   def initialize(init_hash)
+    @debug_mode = ENV['COMMANDRB_MODE'] == 'debug'
 
     # Setup the variables for first use.
     @commands = {}
@@ -39,24 +46,20 @@ class CommandrbBot
 
     # Load sane defaults for options that aren't specified.
 
-    # @config[:prefix_type] = 'rescue' if @config[:prefix_type].nil?
     @config[:typing_default] = false if @config[:typing_default].nil?
-    @config[:selfbot] =  false if  @config[:selfbot].nil?
     @config[:delete_activators] = false if @config[:delete_activators].nil?
 
-    if @config[:token].nil? or init_hash[:token] == ''
-      raise 'No token supplied in init hash!'
-      return false
-    end
+    raise 'No token supplied in init hash!' if @config[:token].nil? || (init_hash[:token] == '')
 
-    init_parse_self = init_hash[:parse_self] rescue nil
+    init_parse_self = begin
+      init_hash[:parse_self]
+    rescue StandardError
+      nil
+    end
     init_type = @config[:type]
 
-    if init_type == :bot
-      if init_hash[:client_id].nil?
-        raise 'No client ID or invalid client ID supplied in init hash!'
-        return false
-      end
+    if init_type == :bot && init_hash[:client_id].nil?
+      raise 'No client ID or invalid client ID supplied in init hash!'
     end
 
     @config[:owners] = init_hash[:owners]
@@ -65,10 +68,10 @@ class CommandrbBot
     @prefixes = init_hash[:prefixes]
 
     @bot = Discordrb::Bot.new(
-        token: @config[:token],
-        client_id: @config[:client_id],
-        parse_self: init_parse_self,
-        type: @config[:type]
+      token: @config[:token],
+      client_id: @config[:client_id],
+      parse_self: init_parse_self,
+      type: @config[:type]
     )
 
     unless init_hash[:ready].nil?
@@ -78,201 +81,147 @@ class CommandrbBot
       end
     end
 
-
     # Command processing
     @bot.message do |event|
-      @finished = false
-      @command = nil
-      @event = nil
-      @chosen = nil
-      @args = nil
-      @rawargs = nil
-      @continue = false
-      @prefixes.each { |prefix|
-        break if @finished
-        if event.message.content.start_with?(prefix)
-
-          @commands.each { | key, command |
-            break if @finished
-            puts ":: Considering #{key.to_s}"  if @debug_mode
-            triggers =  command[:triggers].nil? ? [key.to_s] : command[:triggers]
-
-            triggers.each { |trigger|
-              @activator = prefix + trigger.to_s
-              puts @activator if @debug_mode
-              @activator = @activator.downcase
-              if event.message.content.downcase.start_with?(@activator)
-                puts "Prefix matched! #{@activator}" if @debug_mode
-
-                # Continue only if you've already chosen a choice.
-                unless @chosen.nil?
-                  # If the new activator begins with the chosen one, then override it.
-                  # Example: sh is chosen, shell is the new one.
-                  # In this example, shell would override sh, preventing ugly bugs.
-                  if @activator.start_with?(@chosen)
-                    puts "#{@activator} just overrode #{@chosen}" if @debug_mode
-                    @chosen = @activator
-                  # Otherwhise, just give up.
-                  else
-                    puts "Match failed..." if @debug_mode
-                    next
-                  end
-                # If you haven't chosen yet, get choosing!
-                else
-                    puts "First match obtained!" if @debug_mode
-                    @continue = true
-                    @chosen = @activator
-                end
-              end
-            }
-            
-            puts "Result: #{@chosen}" if @debug_mode
-
-            next if !@continue
-            puts "Final esult: #{@chosen}" if @debug_mode
-
-            break if @config[:selfbot] && event.user.id != @bot.profile.id
-
-            # Command flag defaults
-            command[:catch_errors] = @config[:catch_errors] if command[:catch_errors].nil?
-            command[:owners_only] = false if command[:owners_only].nil?
-            command[:max_args] = 2000 if command[:max_args].nil?
-            command[:server_only] = false if command[:server_only].nil?
-            command[:typing] = @config[:typing_default] if command[:typing_default].nil?
-            command[:delete_activator] = @config[:delete_activators] if command[:delete_activator].nil?
-
-            # If the command is set to owners only and the user is not the owner, show error and abort.
-            puts "[DEBUG] Command being processed: '#{command}'" if @debug_mode
-            puts "[DEBUG] Owners only? #{command[:owners_only]}" if @debug_mode
-            if command[:owners_only]
-              if !@config[:owners].include?(event.user.id)
-                event.channel.send_message('', false,
-                  Helper.error_embed(
-                   error: "You don't have permission for that!\nOnly owners are allowed to access this command.",
-                   footer: "Command: `#{event.message.content}`",
-                   colour: 0xFA0E30,
-                   code_error: false
-                  )
-                )
-                puts 'Were returning!'
-                @finished = true
-                next
-              end
-            end
-
-            # If the settings are to delete activating messages, then do that.
-            # I'm *hoping* this doesn't cause issues with argument extraction.
-            event.message.delete if command[:delete_activator]
-
-            # If the command is only for use in servers, display error and abort.
-            if command[:server_only] && event.channel.private?
-              # For selfbots, a fancy embed will be used. WIP.
-              if @config[:selfbot]
-                event.channel.send_embed do |embed|
-                  embed.colour = 0x221461
-                  embed.title = '❌ An error has occured!'
-                  embed.description = 'This command can only be used in servers!'
-                  embed.footer = Discordrb::Webhooks::EmbedFooter.new(text: "Command: '#{event.message.content}'")
-                end
-              else
-                # If its not a selfbot, an ordinary message will be shown, may be changed to embed later.
-                event.respond('❌ This command will only work in servers!')
-              end
-              # Abort!
-              @finished = true
-              next
-            end
-
-            # If the user is a bot and the command is set to not pass bots OR the user is a bot and the global config is to not parse bots...
-            # ...then abort :3
-            if (event.user.bot_account? && command[:parse_bots] == false) || (event.user.bot_account? && @config[:parse_bots] == false)
-              # Abort!
-              @finished = true
-              next
-            end
-
-            # If the config is setup to show typing messages, then do so.
-            event.channel.start_typing if command[:typing]
-
-            args = event.message.content.split(' ')
-            # Parse args if args exist !
-            begin 
-              spaces = 1
-              # Prefixes with spaces are special and need to be parsed differently : )
-              if prefix.include? " "
-                spaces += prefix.count(' ')
-                args = event.message.content.slice!(args[0].size + args[1].size + spaces, event.message.content.size)
-              else
-                args = event.message.content.slice!(args[0].size + spaces, event.message.content.size)
-              end
-              # Split the argmuents into an array for easy usage but keep the raw args !!
-              rawargs = args
-              args = args.split(/ /)
-            rescue NoMethodError # Not the most elegant solution but it'll do. TODO: Make a more elegant solution.
-              args = []
-            end
-
-
-            # Check the number of args for the command.
-            unless command[:max_args].nil?
-              if command[:max_args] > 0 && args.length > command[:max_args]
-                # May be replaced with an embed.
-                event.channel.send_message('', false,
-                    Helper.error_embed(
-                     error: "Too many arguments! \nMax arguments: `#{command[:max_args]}`",
-                     footer: "Command: `#{event.message.content}`",
-                     colour: 0xFA0E30,
-                     code_error: false
-                    )
-                  )
-                @finished = true
-                break
-              end
-            end
-            
-            unless command[:required_permissions].nil?
-              command[:required_permissions].each { |x|
-                unless event.user.on(event.server).permission?(x,event.channel)
-                  event.channel.send_message('', false,
-                    Helper.error_embed(
-                     error: "You don't have permission for that!\nPermission required: `#{x.to_s}`",
-                     footer: "Command: `#{event.message.content}`",
-                     colour: 0xFA0E30,
-                     code_error: false
-                    )
-                  )
-                  @finished = true
-                  break
-                end
-              }
-            end
-            
-            unless @finished
-              # If the command is configured to catch all errors, thy shall be done.
-              if !command[:catch_errors] || @config['catch_errors']
-                # Run the command code!
-                command[:code].call(event, args, rawargs)
-              else
-                # Run the command code, but catch all errors and output accordingly.
-                begin
-                  command[:code].call(event, args, rawargs)
-                rescue Exception => e
-                  event.respond("❌ An error has occured!! ```ruby\n#{e}```Please contact the bot owner with the above message for assistance.")
-                end
-              end
-            end
-
-            # All done here.
-            puts "Finished!! Executed command: #{@chosen}" if @debug_mode
-            @command = command
-            @event = event
-            @args = args
-            @rawargs = rawargs
-            @finished = true
-            break
-          }
+      chosen_activator = nil
+      message_content = nil
+      chosen_command = nil
+      used_prefix = ''
+
+      # If we have a usable prefix, get the raw arguments for this command.
+      @prefixes.each do |prefix|
+        next unless event.message.content.start_with?(prefix)
+
+        # Store the message's content, sans its prefix.
+        # Strip leading spaces in the event a prefix ends with a space.
+        message_content = event.message.content
+        used_prefix = message_content.slice! prefix
+        break
+      end
+
+      # Otherwise, do not continue processing.
+      next if message_content.nil?
+
+      @commands.each do |key, command|
+        puts ":: Considering #{key}" if @debug_mode == true
+        triggers = command[:triggers].nil? ? [key.to_s] : command[:triggers]
+
+        triggers.each do |trigger|
+          activator = trigger.to_s.downcase
+          puts activator if @debug_mode == true
+          next unless event.message.content.downcase.start_with?(activator)
+
+          puts "Prefix matched! #{activator}" if @debug_mode == true
+
+          # Continue only if you've already chosen a choice.
+          if chosen_activator.nil?
+            puts 'First match obtained!' if @debug_mode == true
+            chosen_activator = activator
+            chosen_command = command
+
+            # If the new activator begins with the chosen one, then override it.
+            # Example: sh is chosen, shell is the new one.
+            # In this example, shell would override sh, preventing ugly bugs.
+          elsif activator.start_with?(chosen_activator)
+            puts "#{activator} just overrode #{chosen_activator}" if @debug_mode == true
+            chosen_activator = activator
+            chosen_command = command
+          # Otherwise, just give up.
+          elsif @debug_mode == true
+            puts 'Match failed...'
+          end
+          # If you haven't chosen yet, get choosing!
         end
-      }
+
+        puts "Result: #{chosen_activator}" if @debug_mode == true
+      end
+
+      # If we have no chosen activator, it is likely the command does not exist
+      # or the prefix itself was run.
+      next if chosen_activator.nil?
+
+      command_run = used_prefix + chosen_activator
+      puts "Final result: #{command_run}" if @debug_mode == true
+
+      # Command flag defaults
+      chosen_command[:owners_only] = false if chosen_command[:owners_only].nil?
+      chosen_command[:server_only] = false if chosen_command[:server_only].nil?
+      chosen_command[:typing] = @config[:typing_default] if chosen_command[:typing_default].nil?
+      if chosen_command[:delete_activator].nil?
+        chosen_command[:delete_activator] =
+          @config[:delete_activators]
+      end
+      chosen_command[:owner_override] = false if chosen_command[:owner_override].nil?
+
+      # If the settings are to delete activating messages, then do that.
+      # I'm *hoping* this doesn't cause issues with argument extraction.
+      event.message.delete if chosen_command[:delete_activator]
+
+      # If the command is only for use in servers, display error and abort.
+      if chosen_command[:server_only] && event.channel.private?
+        event.channel.send_embed error_embed(
+          error: 'This command can only be used in servers!',
+          footer: "Command: `#{command_run}`"
+        )
+        break
+      end
+
+      # If the user is a bot and the command is set to not pass bots
+      # OR the user is a bot and the global config is to not parse bots...
+      # ...then abort :3
+      if event.user.bot_account? && \
+         (chosen_command[:parse_bots] == false || @config[:parse_bots] == false)
+        # Abort!
+        break
+      end
+
+      # If the config is setup to show typing messages, then do so.
+      event.channel.start_typing if chosen_command[:typing]
+
+      # Our arguments are the message's contents, minus the activator.
+      args = message_content
+      args.slice! chosen_activator
+      args = args.split
+
+      no_permission = false
+
+      chosen_command[:required_permissions]&.each do |x|
+        if event.user.on(event.server).permission?(x, event.channel) \
+          || (chosen_command[:owner_override] && @config[:owners].include?(event.user.id))
+          next
+        end
+
+        event.channel.send_embed '', error_embed(
+          error: "You don't have permission for that!\nPermission required: `#{x}`",
+          footer: "Command: `#{command_run}`"
+        )
+        no_permission = true
+        break
+      end
+
+      next if no_permission
+
+      # If the command is set to owners only and the user is not the owner,
+      # show an error and abort.
+      puts "[DEBUG] Command being processed: '#{chosen_command}'" if @debug_mode == true
+      puts "[DEBUG] Owners only? #{chosen_command[:owners_only]}" if @debug_mode == true
+      if chosen_command[:owners_only] && !owner?(event.user.id)
+        event.channel.send_embed '', error_embed(
+          error: "You don't have permission for that!\n"\
+                 'Only owners are allowed to access this command.',
+          footer: "Command: `#{command_run}`"
+        )
+        next
+      end
+
+      # Run the command code!
+      # TODO: determine a good method to log other errors as made via the command.
+      # Without, we will simply log to console.
+      chosen_command[:code].call(event, args, message_content)
+
+      # All done here.
+      puts "Finished!! Executed command: #{chosen_activator}" if @debug_mode == true
+      next
     end
   end
 end

data/lib/helper.rb

@@ -1,37 +1,48 @@
+# frozen_string_literal: true
+
 class CommandrbBot
-    module Helper
-        def self.error_embed(error: nil, footer: nil, colour: nil, color: nil, code_error: true)
-          if error.nil? or footer.nil?
-            raise 'Invalid arguments for Helper.error_embed!'
-          else
-            if color.nil? and colour.nil?
-              colour = 0x22ef1f
-            end
-            Discordrb::Webhooks::Embed.new(
-                title:  '❌ An error has occured!',
-                description: code_error ?  "```ruby\n#{error}```" :  error,
-                colour: colour || color,
-                footer: Discordrb::Webhooks::EmbedFooter.new(text: footer)
-            )
-          end
-        end
-    
-        def self.avatar_embed(color: nil, colour: nil, url: nil, username: nil, time: Time.now.getutc.asctime)
-          if url.nil?
-            raise 'Invalid arguments for Helper.avatar_embed!'
-          else
-            if color.nil? and colour.nil?
-              colour = 0x22ef1f
-            end
-            username = username.nil? ? 'Unknown User' : username
-            Discordrb::Webhooks::Embed.new(
-                colour: colour || color,
-                image: Discordrb::Webhooks::EmbedImage.new(url: url),
-                author: Discordrb::Webhooks::EmbedAuthor.new(name: "Avatar for #{username}", url: url),
-                footer: Discordrb::Webhooks::EmbedFooter.new(text: "Avatar correct as of #{time}")
-            )
-          end
-        end
-        
-    end
+  # Utilizes several methods to attempt to determine a user.
+  def user_parse(context)
+    # Can't do anything if there's nothing to begin with.
+    return nil if context.nil?
+
+    # Catches cases such as "0": obviously invalid, attempted nonetheless.
+    context = context.to_s
+
+    # If it's an ID.
+    id_check = bot.user(context)
+    return id_check unless id_check.nil?
+
+    # If it's a mention!
+    matches = /<@!?(\d+)>/.match(context)
+    return bot.user(matches[1]) unless matches.nil?
+
+    # Might be a username...
+    return bot.find_user(context)[0] unless bot.find_user(context).nil?
+
+    nil
+  end
+
+  # Generates a usable error embed with defaults.
+  def error_embed(error: nil, footer: nil, colour: nil, color: nil)
+    raise 'Invalid arguments for Helper.error_embed!' if error.nil? || footer.nil?
+
+    colour = 0xFA0E30 if color.nil? && colour.nil?
+    Discordrb::Webhooks::Embed.new(
+      title: '❌ An error has occurred!',
+      description: error,
+      colour: colour || color,
+      footer: Discordrb::Webhooks::EmbedFooter.new(text: footer)
+    )
+  end
+
+  # Generates a usable error embed with defaults, and a formatted error.
+  def code_embed(error: nil, footer: nil, colour: nil, color: nil)
+    raise 'Invalid arguments for Helper.code_embed!' if error.nil? || footer.nil?
+
+    # Format to have a code block with formatting.
+    error = "```ruby\n#{error}```"
+
+    error_embed(error: error, footer: footer, colour: colour, color: color)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: commandrb
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
-- Erisa Komuro (Seriel)
-autorequire: 
+- Erisa A
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-15 00:00:00.000000000 Z
+date: 2022-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: discordrb
@@ -31,18 +31,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.1.0
 description: A customisable and easy to use Commands System for Discordrb.
-email: seriel@fl0.co
+email: erisa@erisa.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/commandrb.rb
 - lib/helper.rb
-homepage: https://github.com/Seriell/commandrb
+homepage: https://github.com/Yuuki-Discord/commandrb
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -50,16 +51,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Commandrb
 test_files: []