emissary-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 42928a4cf26e93718721e9d26b393e7613b76ccd2f95b8dec440c964f6d7d0a0
+  data.tar.gz: 2e7279d53f1301c3a9a2dfaa5950f019e04f9ba5c1590a74e9c1a0e78be420b1
+SHA512:
+  metadata.gz: 1ca10786e85582c824f5d9b293678f7af222ee43117dc0cfdc5253826209c63b91e641b88e30846372ba6d92723c0da4355da28d99458bf9c6ac7ad47bc95c01
+  data.tar.gz: e901fa214fed00c8a27a8719a20aede77353fa2d95335a2a3e160e8f67fb9776ac12f1da73cfbce39b2929a9c19592fe7d33a8eaa97d34da2787fe6ec908d984

data/.gitignore

@@ -0,0 +1,10 @@
+/runner.rb
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Simón
+
+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,130 @@
+# Emissary
+Simple error catcher integrated with services like Discord and Trello, use chatbots to monitor your application and server.
+Receive error catching reports to a Discord Server Channel, and use chatbots to send commands and fetch reports.
+
+# Features
+* This tools allows you to configurate the errors or lines you want to capture from any log file, in this example you will find a configuration for catching HTTP ERROR 500.
+* You can configurate the timeframes in which the logs will be read, the conditions that triggers the errores, the lines to fetch from the files, the language to markup the error to discord, characters to ignore, how often the errors fetched would be clear, and how often you want a receive reports with error ocurrences.
+* You can also use chatbots to fetch and generate reports any time outside the timeframes configurated.
+* You can also configurate linux commands and receive in discord the outputs or results.
+
+# Setup your Discord Server, Channel, Application and Bot
+* 1. Go To [Discord Developers](https://discord.com/developers)
+* 2. Create a new application and under the Bot option create a new bot
+* 3. Add your new bot to your server Channel
+* 4. Create a **webhook** in you server channel
+* 5. Paste the **webhooks url** and chat bot token in the Emissary configuration file.
+
+# Setup your Trello Board and List
+* 1. Go To [Trello App Key Generator](https://trello.com/app-key)
+* 2. Click in **Token** to create your member token *(be aware of expiration time)*
+* 3. Copy both your **public_key** and **member_token** into the initializer file or runner
+* 4. Find your Trello **ListID**, you can do this by openning the web tools in your browser, click on the navigation tab and watch for the navigation log when editing the name of your list, the ID will be visible under the **Preview Tab**
+* 5. Use the Trello **ListID** in the loggr.json file under the configuration you want trello to work with.
+
+# 2. Download / Clone the code
+```bash
+
+git clone git@github.com:MakarovCode/Emissary.git
+
+```
+
+# 3. Make it run
+create runner.rb or config/initializer/emissary.rb file
+
+```ruby
+
+require './emissary'
+
+Emissary.configure do |config|
+  config.server_name = "A name for chat titles"
+  config.header_format = "__***{title}***__" #Any markup
+  config.webhooks_url  = '{discord webhooks_url}'
+  config.bot_token  = '{discord bot_token}'
+  config.trello_public_key = '{trello public_key}'
+  config.trello_member_token = '{trello member_token}'
+end
+
+emi = Emissary.new
+
+```
+
+# 4. Configure your log readers and commands in the loggr.json file
+
+See some examples
+
+```javascript
+{
+  "rails": {
+    "name": "Rails Logger",
+    "path": "path/to/rails/log",
+    "condition": "Completed 500 Internal Server Error",
+    "lines": 10,
+    "fetch_each": 10,
+    "language": "ruby",
+    "ignore": ["", " ", "  "],
+    "command": "rails",
+    "bash_command": "",
+    "clear_each": 48,
+    "report_each": 12,
+    "trello_list_id": "",
+    "color": "#FF0000",
+    "alias": "ror",
+    "format": ""
+  },
+  "disk": {
+    "name": "Disk Usage",
+    "path": "",
+    "condition": "",
+    "lines": 0,
+    "fetch_each": 0,
+    "language": "text",
+    "ignore": ["", " ", "  "],
+    "command": "disk",
+    "bash_command": "df -h",
+    "clear_each": 0,
+    "report_each": 0,
+    "trello_list_id": "",
+    "color": "#00FF00",
+    "alias": "",
+    "format": {"from": "  ", "to": "|"}
+  },
+  "cpu": {
+    "name": "CPU Usage",
+    "path": "",
+    "condition": "",
+    "lines": 0,
+    "fetch_each": 0,
+    "language": "text",
+    "ignore": ["", " ", "  "],
+    "command": "cpu",
+    "bash_command": "mpstat",
+    "clear_each": 0,
+    "report_each": 0,
+    "trello_list_id": "",
+    "color": "#00FF00",
+    "alias": "",
+    "format": {"from": "  ", "to": "|"}
+  }
+}
+```
+
+# 5. If everything goes right
+You can type the next commands in your Discord Server Channel and the Chatbot will answer.
+
+```ruby
+!emy rails fetch #This will read the log file for the setup with command rails
+
+!emy rails report #this will send to the discord general reports of errors catched
+
+!emy disk #This will send back to discord the usage of the server disk partitions
+
+!emy rails {id} trello #Add message report to trello list
+```
+# Roadmap
+This tools is in the making
+* Upload as Ruby Gem
+* Regex conditioning
+* Slack Integration
+* Email reports Integration
+* Convert the message HASH into a Ruby Class

data/lib/emissary.rb

@@ -0,0 +1,105 @@
+require 'discordrb'
+
+require "json"
+
+
+require './lib/loggr';
+
+class Emissary
+
+  class << self
+    attr_accessor :webhooks_url, :bot_token, :trello_public_key, :trello_member_token, :server_name, :header_format
+    def configure(&block)
+      block.call(self)
+    end
+
+    def header
+      header_format.gsub("{title}", server_name)
+    end
+  end
+
+  attr_accessor :loggrs
+
+  def configure(&block)
+    block.call(self)
+  end
+
+  def initialize
+    @loggrs = {}
+    read_loggrs
+    init_bot
+  end
+
+  def get_message
+  end
+
+  def respond
+  end
+
+  def read_loggrs
+
+    file = File.open "./lib/loggr.json"
+    raw_loggrs = JSON.load file
+    raw_loggrs.each do |k, v|
+      loggr = Loggr.new v
+      loggrs[loggr.command] = loggr
+    end
+    file.close
+  end
+
+  def init_bot
+
+
+    bot = Discordrb::Commands::CommandBot.new token: Emissary.bot_token, prefix: '!'
+
+    bot.command :emy do |event, *args|
+      puts "===> Receiving request bot"
+      if args.count > 0
+        command = args[0]
+        loggr = loggrs[command]
+        unless loggr.nil?
+          if loggr.bash_command == ""
+            if args.count > 1
+              if args[1] == "report"
+                loggr.report
+                "#{Emissary.header}\nGenerating Last Report"
+              elsif args[1] == "fetch"
+                loggr.fetch
+                "#{Emissary.header}\nFetching Report"
+              elsif args[1] == "clear"
+                loggr.clear
+                "#{Emissary.header}\nClearing Report"
+              elsif args[1] == "last"
+                loggr.message_to_chat loggr.last_message
+              elsif ![nil, ""].include?(args[1]) && args[1].include?(loggr.alias)
+                if args.count > 2
+                  if args[2] == "trello"
+                    card_url = loggr.create_trello_card loggr.message_by_id(args[1])
+                    "#{Emissary.header}\n**Trello card added.**\n#{card_url}"
+                  end
+                else
+                  loggr.message_to_chat loggr.message_by_id(args[1])
+                end
+              else
+                "#{Emissary.header}\nWrong arguments for command #{command}:\n**last**: Last Message.\n**report**: Generate report before time.\n**{id}**: Message with ID"
+              end
+            else
+              "#{Emissary.header}\nYou didn't write an argument:\n**last**: Last Message.\n**report**: Generate report before time.\n**{id}**: Message with ID"
+            end
+          else
+            "#{Emissary.header}\n#{loggr.syscall}"
+          end
+        else
+          "#{Emissary.header}\nCommand not found: #{command}"
+        end
+      else
+        "#{Emissary.header}\nYou didn't write a command"
+      end
+    end
+
+    bot.run
+  end
+
+
+
+end

data/lib/loggr.json

@@ -0,0 +1,55 @@
+{
+  "rails": {
+    "name": "Rails Logger",
+    "path": "../Zaiko/log/development.log",
+    "condition": "Completed 500 Internal Server Error",
+    "lines": 10,
+    "fetch_each": 10,
+    "language": "ruby",
+    "ignore": ["", " ", "  "],
+    "command": "rails",
+    "bash_command": "",
+    "clear_each": 48,
+    "report_each": 12,
+    "trello_list_id": "60c54865ddeb95815a4b8993",
+    "trello_labels": "",
+    "trello_members_ids": "",
+    "color": "#FF0000",
+    "alias": "ror",
+    "format": ""
+  },
+  "disk": {
+    "name": "Disk Usage",
+    "path": "",
+    "condition": "",
+    "lines": 0,
+    "fetch_each": 0,
+    "language": "text",
+    "ignore": ["", " ", "  "],
+    "command": "disk",
+    "bash_command": "df -h",
+    "clear_each": 0,
+    "report_each": 0,
+    "trello_list_id": "",
+    "color": "#00FF00",
+    "alias": "",
+    "format": {"from": "", "to": ""}
+  },
+  "cpu": {
+    "name": "CPU Usage",
+    "path": "",
+    "condition": "",
+    "lines": 0,
+    "fetch_each": 0,
+    "language": "text",
+    "ignore": ["", " ", "  "],
+    "command": "cpu",
+    "bash_command": "mpstat",
+    "clear_each": 0,
+    "report_each": 0,
+    "trello_list_id": "",
+    "color": "#00FF00",
+    "alias": "",
+    "format": {"from": "", "to": ""}
+  }
+}

data/lib/loggr.rb

@@ -0,0 +1,174 @@
+require 'thread'
+require 'discordrb/webhooks'
+require 'trello'
+require 'open3'
+
+class Loggr
+
+  attr_accessor :messages, :path, :condition, :lines, :fetch_each, :language, :ignore, :command, :bash_command, :clear_each, :trello_list_id, :trello_labels, :trello_members_ids, :color, :name, :report_each, :timer, :config, :last_id, :alias, :format
+
+  def initialize(config={})
+    @config = config
+    init_config
+    if @bash_command == ""
+      start
+    end
+  end
+
+  def init_config
+    @timer = 0
+    @messages = {}
+    @name = config["name"]
+    @path = config["path"]
+    @condition = config["condition"]
+    @lines = config["lines"]
+    @language = config["language"]
+    @ignore = config["ignore"]
+    @command = config["command"]
+    @bash_command = config["bash_command"]
+    @fetch_each = config["fetch_each"]
+    @clear_each = config["clear_each"]
+    @report_each = config["report_each"]
+    @trello_list_id = config["trello_list_id"]
+    @trello_labels = config["trello_labels"].downcase.split(',').map(&:strip).map(&:to_sym) if config["trello_labels"]
+    @trello_members_ids = config["trello_members_ids"].split(',').map(&:strip) if config["trello_members_ids"]
+    @color = config["color"]
+    @alias = config["alias"]
+    @last_id = 0
+    @format = config["format"]
+  end
+
+  def start
+
+    one_at_a_time = Mutex.new
+
+    Thread.new do
+      loop do
+        one_at_a_time.synchronize do
+          if @timer % @fetch_each == 0
+            fetch
+          end
+          if @timer % @clear_each == 0
+            clear
+          end
+          if @timer % @report_each == 0
+            report
+          end
+          @timer += 1
+          sleep 1*60
+        end
+      end
+    end
+
+  end
+
+  def fetch
+    file = File.open(@path)
+    file_lines = file.readlines.map(&:chomp)
+    @ignore.each{|i| file_lines.delete(i) }
+
+    file_lines.each_with_index do |line, i|
+      if line.include? @condition
+        if @messages["#{file_lines[i+1]}"].nil?
+          @last_id += 1
+          @messages["#{file_lines[i+1]}"] = {
+            id: "#{@alias}-#{@last_id}",
+            trigger: "Completed 500 Internal Server Error",
+            lines: file_lines[i..(i+@lines)],
+            count: 1,
+            reported: false,
+            index: i
+          }
+        else
+          @messages["#{file_lines[i+1]}"][:count] += 1
+        end
+      end
+    end
+  end
+
+  def message_by_id(id)
+    @messages.each do |k, v|
+      return v if v[:id] == id
+    end
+  end
+
+  def last_message
+    message_by_id("#{@alias}-#{@last_id}")
+  end
+
+  def lines_to_code(message)
+    "#{message[:lines].join("\n")}"
+  end
+
+  def truncate_lines(lines, length)
+    lines.gsub(/^(.{50,}?).*/m,'\1...')
+  end
+
+  def report
+
+    client = Discordrb::Webhooks::Client.new(url: Emissary.webhooks_url)
+    client.execute do |builder|
+      builder.content = "__**#{Emissary.server_name}**__\n**Report Alert** from **#{@name}** at #{Time.now}"
+      builder.add_embed do |embed|
+        embed.title = "#{@condition}"
+        embed.description = "**Ocurrences: **\n#{@messages.count{|k,v| v[:reported] == false}}"
+        embed.color = @color
+        embed.timestamp = Time.now
+        embed.fields = []
+        @messages.each do |k, v|
+          unless v[:reported]
+            embed.fields.push({
+              "name": "**ID: #{v[:id]}**\n\nOcurrences: #{v[:count]}",
+              "value": formatted("```#{@language}\n#{v[:lines][0]}\n#{v[:lines][1]}```")
+              })
+              v[:reported] = true
+            end
+          end
+        end
+      end
+    end
+
+    def message_to_chat(message)
+      formatted("#{Emissary.header}\n**ID: #{message[:id]}**\nOcurrences: #{message[:count]}\n\n```#{@language}\n#{lines_to_code(message)}```")
+    end
+
+    def clear
+      init_config
+    end
+
+    def create_trello_card(message)
+      client = Trello::Client.new(
+        developer_public_key: Emissary.trello_public_key,
+        member_token: Emissary.trello_member_token
+      )
+
+      card = client.create(:card,
+        {
+          'name' => message[:lines][1],
+          'desc' => "Ocurrences: #{message[:count]}\n\n```#{@language}\n#{lines_to_code(message)}```",
+          'idList' => @trello_list_id,
+          'labels' => @trello_labels,
+          'idMembers' => @trello_members_ids,
+        }
+      )
+
+      card.url
+    end
+
+    def formatted(text)
+      if @format != ""
+        text.gsub(@format["from"], @format["to"])
+      else
+        text
+      end
+    end
+
+    def syscall
+      begin
+        stdout, stderr, status = Open3.capture3(@bash_command)
+        status.success? && formatted(stdout.slice!(0..-(1 + $/.size)).gsub(/^(.{1500,}?).*/m,'\1...'))# strip trailing eol
+      rescue
+        "The command #{@bash_command} could not be executed"
+      end
+    end
+  end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: emissary-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- MakarovCode
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: discordrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+- !ruby/object:Gem::Dependency
+  name: ruby-trello
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: discordrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+- !ruby/object:Gem::Dependency
+  name: ruby-trello
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: 
+email:
+- simoncorreaocampo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- lib/emissary.rb
+- lib/loggr.json
+- lib/loggr.rb
+homepage: https://github.com/MakarovCode/Emissary
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Simple error catcher integrated with services like Discord and Trello, use
+  chatbots to monitor your application and server. Receive error catching reports
+  to a Discord Server Channel, and use chatbots to send commands and fetch reports.
+test_files: []