advanced_ruby_command_handler 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 29ce9948b2b75e95125369d796c72f092a42892bffc7a66a768dc52d6bebaf18
+  data.tar.gz: 74cc5f8f368f366335e011a07de894dcabe6a59a613d552651de81485a881683
+SHA512:
+  metadata.gz: 7c08da956a0b831f157c37b79cbe251f0176a6b57f8f65b0f153031547411d5b809bf872e8f6e5da60257676bcce72ecf190ddd8eb8ad26a158f9091545cc8f4
+  data.tar.gz: 4f6c83b2a00a332d20e1e7c6e5048fa1fdb4dc71620171064c0febe7adb619e22e8ae7d8810e44693f382c71b23a651adb4c3f7dff5eb684bdcca277623a8b11

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/.rubocop.yml

@@ -0,0 +1,38 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 200
+
+Style/HashSyntax:
+  Enabled: true
+  EnforcedStyle: hash_rockets
+
+Layout/EndOfLine:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Lint/RedundantStringCoercion:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metris/AbcSize:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-07-20
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in advanced_ruby_command_handler.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.7"
+
+gem "discordrb"

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    advanced_ruby_command_handler (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    discordrb (3.4.0)
+      discordrb-webhooks (~> 3.3.0)
+      ffi (>= 1.9.24)
+      opus-ruby
+      rest-client (>= 2.0.0)
+      websocket-client-simple (>= 0.3.0)
+    discordrb-webhooks (3.3.0)
+      rest-client (>= 2.1.0.rc1)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    event_emitter (0.2.6)
+    ffi (1.15.0-x64-mingw32)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.1104)
+    netrc (0.11.0)
+    opus-ruby (1.0.1)
+      ffi
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rest-client (2.1.0-x64-mingw32)
+      ffi (~> 1.9)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.5)
+    rubocop (1.18.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    unicode-display_width (2.0.0)
+    websocket (1.2.9)
+    websocket-client-simple (0.3.0)
+      event_emitter
+      websocket
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  advanced_ruby_command_handler!
+  discordrb
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 senchuu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# AdvancedRubyCommandHandler
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'advanced_ruby_command_handler'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install advenced_ruby_command_handler
+
+## Usage
+
+### Base Usage
+
+Firstly, you have to create a ruby file, where you put the followwing line:
+```rb
+require "advanced_ruby_command_handler"
+```
+
+Then, initialize the command handler. Specifying the directories and the config file path
+
+```rb
+client = CommandHandler.new(commands_dir: "src/commands", events_dir: "src/events", config_file: "src/private/config.yml")
+```
+Note: if these files dose not exist, the command handler will create them
+
+And run the bot:
+```ruby
+client.run
+```
+
+### Events&Commands
+
+The command handler have base events as message or ready, but you can create your owns events (in events directory).
+
+Create a file with the name of your event (see https://www.rubydoc.info/github/meew0/discordrb/Discordrb/Events)
+
+And use the following template:
+```ruby
+# frozen_string_literal: true
+
+module Events
+  def self.<event>(client)
+    client.<event> do
+      client.console_logger.info("Event!")
+    end
+  end
+end
+```
+Now, when the event will be emitted, the program will puts "Event!"
+
+If you want to add some commands in your bot, you can create sub directories in your command directory.
+In these directories, you can create ruby files for commands, here's an example:
+
+```ruby
+# frozen_string_literal: true
+
+require_relative "advanced_ruby_command_handler"
+
+module Commands
+  def self.hello
+    CommandHandler::Command.new({
+                                  :name => "hello"
+                                }) do |message, client|
+      message.respond "Hello Discord!"
+    end
+  end
+end
+```
+
+Now you can create events and commands ! ;)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Senchuu/Advanced-Bot.rb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task :default => :rubocop

data/advanced_ruby_command_handler.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/advanced_ruby_command_handler/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "advanced_ruby_command_handler"
+  spec.version       = AdvancedRubyCommandHandler::VERSION
+  spec.authors       = ["senchuu"]
+  spec.email         = ["senchuuuu@gmail.com"]
+
+  spec.summary       = "an advanced discord bot command handler"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/Senchuu/Advanced-Bot.rb"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Senchuu/Advanced-Bot.rb"
+  spec.metadata["changelog_uri"] = "https://github.com/Senchuu/Advanced-Bot.rb"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features|logs)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "advanced_ruby_command_handler"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/advanced_ruby_command_handler/app/app.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "../version"
+require_relative "logger"
+require_relative "client"
+
+module AdvancedRubyCommandHandler; end

data/lib/advanced_ruby_command_handler/app/client.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "discordrb"
+require "fileutils"
+require "yaml"
+require_relative "command_handler"
+require_relative "event_handler"
+
+module AdvancedRubyCommandHandler
+  class Client < Discordrb::Bot
+    attr_reader :commands_dir, :events_dir, :commands, :config, :console_logger, :file_logger
+
+    def initialize(commands_dir: "commands", events_dir: "events", config_file: "config.yml")
+      FileUtils.mkdir_p [commands_dir, events_dir]
+      @commands_dir = commands_dir
+      @events_dir = events_dir
+      @file_logger = AdvancedRubyCommandHandler::Logger.new(:file)
+      @console_logger = AdvancedRubyCommandHandler::Logger.new(:console)
+
+      base_data = YAML.dump({
+                              :token => "",
+                              :prefix => "",
+                              :owners => []
+                            })
+
+      File.open(config_file, "w+") { |file| file.write(base_data) } unless File.exist? config_file
+
+      @config = YAML.load_file(config_file)
+
+      %i[token prefix owners].each do |prop|
+        next if @config[prop] && !@config[prop].empty?
+
+        @console_logger.error("You have to add '#{prop.to_s}' value in your config file")
+        raise "'#{prop}' missing or empty"
+      end
+
+      super(:token => @config[:token])
+
+      @commands = AdvancedRubyCommandHandler::CommandHandler.load_commands(self)
+      AdvancedRubyCommandHandler::EventHandler.load_events(self)
+                                              .each do |event|
+        Events.method(event).call(self)
+      end
+    end
+
+    def run
+      @console_logger.info("Client login!")
+
+      Thread.new do
+        @console_logger.info("Type '.exit' to turn off the bot")
+        # @console_logger.info("Type '.reload' to reload the bot")
+
+        exit if $stdin.gets.chomp == ".exit"
+      end
+
+      super.run
+    end
+  end
+end

data/lib/advanced_ruby_command_handler/app/command.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CommandHandler
+  class Command
+    attr_reader :props, :run
+
+    def initialize(props, &run)
+      @props = props
+      @run = run
+    end
+  end
+end

data/lib/advanced_ruby_command_handler/app/command_handler.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "app"
+
+module AdvancedRubyCommandHandler
+  module CommandHandler
+    def self.load_commands(client)
+      commands = []
+      Dir.entries(client.commands_dir).each do |dir|
+        next if %w[. ..].include?(dir)
+
+        Dir.entries("#{client.commands_dir}/#{dir}").each do |file|
+          next if %w(. ..).include?(file)
+
+          load "#{client.commands_dir}/#{dir}/#{file}"
+
+          commands << File.basename(file, ".rb")
+        end
+      end
+      commands
+    end
+  end
+end

data/lib/advanced_ruby_command_handler/app/event_handler.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "app"
+
+module AdvancedRubyCommandHandler
+  module EventHandler
+    def self.load_events(client)
+      events = []
+      Dir.entries(client.events_dir).each do |file|
+        next if %w[. ..].include?(file)
+
+        load "#{client.events_dir}/#{file}"
+        events << File.basename(file, ".rb")
+      end
+
+      Dir.entries("lib/advanced_ruby_command_handler/defaults/events").each do |file|
+        next if %w(. ..).include?(file)
+
+        next if events.include?(File.basename(file, ".rb"))
+
+        load "lib/advanced_ruby_command_handler/defaults/events/#{file}"
+
+        events << File.basename(file, ".rb")
+      end
+
+      events
+    end
+  end
+end

data/lib/advanced_ruby_command_handler/app/logger.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module AdvancedRubyCommandHandler
+  class Logger
+    attr_reader :mode
+    attr_accessor :write_targets
+
+    COLORS = {
+      :default => "\e[38m",
+      :white => "\e[39m",
+      :black => "\e[30m",
+      :red => "\e[31m",
+      :green => "\e[32m",
+      :brown => "\e[33m",
+      :blue => "\e[34m",
+      :magenta => "\e[35m",
+      :cyan => "\e[36m",
+      :gray => "\e[37m",
+      :yellow => "\e[33m"
+    }.freeze
+    MODES = {
+      :info => :cyan,
+      :error => :red,
+      :warn => :yellow,
+      :check => :green
+    }.freeze
+    def initialize(mode = :console, write_targets = { :errors => "logs/errors.txt", :informations => "logs/infos.txt" })
+      @mode = mode.to_sym
+      @write_targets = write_targets if @mode == :file
+    end
+
+    def console_color(color, message)
+      "#{COLORS[color]}#{message}\e[0m"
+    end
+
+    def write(message, write_target = :informations)
+      return Logger.new(:console).warn("The file logs aren't available on #{@mode} mode") unless @mode == :file
+
+      time = Time.now.strftime("%Y-%m-%d-%H:%M:%S")
+
+      FileUtils.mkdir_p File.dirname @write_targets[write_target]
+
+      File.open(@write_targets[write_target], "w") unless File.exist? @write_targets[write_target]
+
+      File.open(@write_targets[write_target], "a+") do |file|
+        file.write("#{time} - #{write_target.to_s.upcase} : #{message}\n")
+      end
+    end
+
+    MODES.each do |mode, color|
+      define_method(mode) do |message|
+        return Logger.new(:console).warn("The console logs aren't available on #{@mode} mode") unless @mode == :console
+
+        time = Time.now.strftime("%Y-%m-%d-%H:%M:%S")
+        puts "[#{console_color(:magenta, time)}] - [#{console_color(color, mode.to_s.upcase)}] : #{message.to_s}"
+      end
+    end
+
+    private :console_color
+  end
+end

data/lib/advanced_ruby_command_handler/app/utils.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CommandHandler
+  module Utils
+    def self.get_command(command_name)
+      return Commands.method(command_name).call if defined?(Commands) && Commands.respond_to?(command_name)
+
+      false
+    end
+  end
+end

data/lib/advanced_ruby_command_handler/defaults/events/message.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "../../app/utils"
+
+module Events
+  def self.message(client)
+    client.message(:start_with => client.config[:prefix]) do |message|
+      args = message.content.slice(client.config[:prefix].size, message.content.size).split(" ")
+      name = args.shift
+      command = CommandHandler::Utils.get_command(name)
+
+      next unless command
+
+      command.run.call(message, client)
+    end
+  end
+end

data/lib/advanced_ruby_command_handler/defaults/events/ready.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Events
+  def self.ready(client)
+    client.ready do
+      client.console_logger.info("Client ready!")
+    end
+  end
+end

data/lib/advanced_ruby_command_handler/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AdvancedRubyCommandHandler
+  VERSION = "0.1.1"
+end

data/lib/advanced_ruby_command_handler.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "advanced_ruby_command_handler/app/app"
+require_relative "advanced_ruby_command_handler/app/command"
+require_relative "advanced_ruby_command_handler/app/utils"
+
+
+module CommandHandler
+  def self.new(commands_dir: "commands", events_dir: "events", config_file: "config.yml")
+    AdvancedRubyCommandHandler::Client.new(:commands_dir => commands_dir, :events_dir => events_dir, :config_file => config_file)
+  end
+end

data/tests/commands/test/test.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "../../../lib/advanced_ruby_command_handler/app/command"
+
+module Commands
+  def self.test
+    CommandHandler::Command.new({
+                                  :name => "test"
+                                }) do |message, client|
+      message.respond "Command test!"
+    end
+  end
+end

data/tests/config.yml

@@ -0,0 +1,4 @@
+---
+:token: 'NzEwMTIxODk2OTM0NjM3NjY5.Xrv2jQ.4v9551dYI5nqRSIGfYy19APUmbA'
+:prefix: '!'
+:owners: [123456789]

data/tests/index.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "../lib/advanced_ruby_command_handler"
+
+CommandHandler.new(:commands_dir => "tests/commands", :events_dir => "tests/events", :config_file => "tests/config.yml")
+              .run

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: advanced_ruby_command_handler
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- senchuu
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-08-26 00:00:00.000000000 Z
+dependencies: []
+description: an advanced discord bot command handler
+email:
+- senchuuuu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- advanced_ruby_command_handler.gemspec
+- bin/console
+- bin/setup
+- lib/advanced_ruby_command_handler.rb
+- lib/advanced_ruby_command_handler/app/app.rb
+- lib/advanced_ruby_command_handler/app/client.rb
+- lib/advanced_ruby_command_handler/app/command.rb
+- lib/advanced_ruby_command_handler/app/command_handler.rb
+- lib/advanced_ruby_command_handler/app/event_handler.rb
+- lib/advanced_ruby_command_handler/app/logger.rb
+- lib/advanced_ruby_command_handler/app/utils.rb
+- lib/advanced_ruby_command_handler/defaults/events/message.rb
+- lib/advanced_ruby_command_handler/defaults/events/ready.rb
+- lib/advanced_ruby_command_handler/version.rb
+- tests/commands/test/test.rb
+- tests/config.yml
+- tests/index.rb
+homepage: https://github.com/Senchuu/Advanced-Bot.rb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/Senchuu/Advanced-Bot.rb
+  source_code_uri: https://github.com/Senchuu/Advanced-Bot.rb
+  changelog_uri: https://github.com/Senchuu/Advanced-Bot.rb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.26
+signing_key:
+specification_version: 4
+summary: an advanced discord bot command handler
+test_files: []