commandrb 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6822eef019c15386f6d8915e2f4652ed22ce977f
-  data.tar.gz: d99a5734a08845743616e3bd3921e68ea83456e1
+  metadata.gz: 5e9df314b41310e8efa2142d628ed0c7ecbf9c4c
+  data.tar.gz: b79dbcade06d8c7cf39c6a974b5b0257f6126c5d
 SHA512:
-  metadata.gz: 66ad55bd73df84f41c3f9cd102ea10f0e4f8aa346400bc552ffcca999217585245502bade76c52f0d5f11fe5e60498780ff006d28d297dcc31814638a7257e32
-  data.tar.gz: 63369fdb6ab5ed5b4e1d737701a8f13e14c4c9b70b1e87b9ada5b1e2642ee1721e4bdccb4f8b0fa39980431533e45e5e9e2fc6a82b595d62d476320cb99845c2
+  metadata.gz: 25a2630312374f10a2d30986c9bf130102b7bba611a0f5efca17e53de67b0aad5cf4ed1a5382f786fcfa8e62ed33d044426209d5280917488380ed7198d89753
+  data.tar.gz: e9cc3ba89ec2457186d6548621753a82e03fb675f5b4f7851b9b71c0047c80bce9301b900e57738bc2ce95786c652701c6cd43205241743762a9fb0d0c86e6e7

data/lib/commandrb.rb

@@ -1,278 +1,278 @@
-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
-
-  # Needed to run the bot, or create custom events.
-  attr_accessor :bot
-
-  # Can manually manipulate commands using this.
-  attr_accessor :commands
-
-  # 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
-
-  def remove_command(name)
-    begin
-      @commands.delete(name)
-    rescue
-      return false
-    end
-    true
-  end
-
-  def initialize(init_hash)
-
-    # Setup the variables for first use.
-    @commands = {}
-    @prefixes = []
-    @config = init_hash
-
-    # 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
-
-    init_parse_self = init_hash[:parse_self] rescue nil
-    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
-    end
-
-    @config[:owners] = init_hash[:owners]
-    @config[:owners] = [] if @config[:owners].nil?
-
-    @prefixes = init_hash[:prefixes]
-
-    @bot = Discordrb::Bot.new(
-        token: @config[:token],
-        client_id: @config[:client_id],
-        parse_self: init_parse_self,
-        type: @config[:type]
-    )
-
-    unless init_hash[:ready].nil?
-      @bot.ready do |event|
-        event.bot.game = @config[:game] unless config[:game].nil?
-        init_hash[:ready].call(event)
-      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
-          }
-        end
-      }
-    end
-  end
-end
+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
+
+  # Needed to run the bot, or create custom events.
+  attr_accessor :bot
+
+  # Can manually manipulate commands using this.
+  attr_accessor :commands
+
+  # 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
+
+  def remove_command(name)
+    begin
+      @commands.delete(name)
+    rescue
+      return false
+    end
+    true
+  end
+
+  def initialize(init_hash)
+
+    # Setup the variables for first use.
+    @commands = {}
+    @prefixes = []
+    @config = init_hash
+
+    # 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!'
+    end
+
+    init_parse_self = init_hash[:parse_self] rescue nil
+    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!'
+      end
+    end
+
+    @config[:owners] = init_hash[:owners]
+    @config[:owners] = [] if @config[:owners].nil?
+
+    @prefixes = init_hash[:prefixes]
+
+    @bot = Discordrb::Bot.new(
+        token: @config[:token],
+        client_id: @config[:client_id],
+        parse_self: init_parse_self,
+        type: @config[:type]
+    )
+
+    unless init_hash[:ready].nil?
+      @bot.ready do |event|
+        event.bot.game = @config[:game] unless config[:game].nil?
+        init_hash[:ready].call(event)
+      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.
+                if @chosen.nil?
+                  puts "First match obtained!" if @debug_mode
+                  @continue = true
+                  @chosen = @activator
+                else
+                  # 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!
+                end
+              end
+            }
+            
+            puts "Result: #{@chosen}" if @debug_mode
+
+            unless @continue
+              next
+            end
+            puts "Final result: #{@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?
+            command[:owner_override] = false if command[:owner_override].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]
+              unless @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]
+                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) || (command[:owner_override] && @config[:owners].include?(event.user.id) )
+                  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
+          }
+        end
+      }
+    end
+  end
+end

data/lib/helper.rb

@@ -1,37 +1,37 @@
-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
-end
+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
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: commandrb
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Erisa Komuro (Seriel)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-15 00:00:00.000000000 Z
+date: 2017-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: discordrb
@@ -58,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Commandrb