emissary-ruby 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dc0da3597e9064241a4a1b542ab0fc08ed5241c969fa52e584b90a431844d73
-  data.tar.gz: dd46a45ef2cbb2269f3b73dc8650b6e9de1531b7b3984fd388521244747a49fd
+  metadata.gz: e079c3d6412aec1ff8fafa45be88815d1b7d9d21b2b6e1bdfa73fc7f3877655c
+  data.tar.gz: 11cb0ba431892f25777d7a81cb3d7ed74f80913536147ce5e6a361597e204aec
 SHA512:
-  metadata.gz: 357fca61859ad7445dc30022902ca07ab3688f60801e23be312e8b437fc23c26da6d61c5b8068be586c3af6224000481918f1a85901004be813c05dd361306c1
-  data.tar.gz: '095d257b47d27327e7846879e2e84fd8802d51ad77f47a5736afcdcba421d79adf6ed9f59cfb1d985a18ebcaa237b28cfda27afcfb51511b1adfc136e0220e37'
+  metadata.gz: 910d242d70f9dbd1ed7cc3561b81eb4469d2bb10564d071e7ac2830d3441b22e5d7c21bc0f3cbd644db32eb9b57e73448241fa8747a63932db2e89714ded6e24
+  data.tar.gz: 2d45556b04e7ef17700809d96c01b1dc6b5b28d7addf737d61054c911fe9eeb5e0073a3d31e05c87359489d0ebdc530c361cdf88ba376fa45746c93008b792c1

data/README.md

@@ -2,6 +2,9 @@
 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.
 
+# PRESENTATION
+[![Watch the presentation](https://github.com/MakarovCode/Emissary/raw/main/thumb.png)](https://dms.licdn.com/playlist/C4E05AQHyxbCfCVGHYA/mp4-720p-30fp-crf28/0/1623710691404?e=1623808800&v=beta&t=gUzmyqiD7vgxfWC7KYeU53-us6buF-kf2o60RfZfxuQ)
+
 # 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.
@@ -22,38 +25,26 @@ Receive error catching reports to a Discord Server Channel, and use chatbots to
 * 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
-
+# 2. Install gem and dependencies
 ```ruby
 
-require './emissary'
+#Gemfile
+gem "emissary-ruby"
+gem "discordrb"
+gem "ruby-trello"
 
-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
+#Or install each gem
+gem install "discordrb"
+gem install "ruby-trello"
+gem install "emissary-ruby"
 
 ```
 
-# 4. Configure your log readers and commands in the loggr.json file
+# 3. Configure your log readers and commands by creating a file emissary.json inside your project.
 
 See some examples
 
-```javascript
+```json
 {
   "rails": {
     "name": "Rails Logger",
@@ -109,6 +100,14 @@ See some examples
 }
 ```
 
+# 3. Make it run
+Run the **bundle exec emissary** command and pass as parameter the path to the **emissary.json** file you just created
+
+```ruby
+bundle exec emissary "/path/to/config/file.json"
+
+```
+
 # 5. If everything goes right
 You can type the next commands in your Discord Server Channel and the Chatbot will answer.
 
@@ -121,10 +120,17 @@ You can type the next commands in your Discord Server Channel and the Chatbot wi
 
 !emy rails {id} trello #Add message report to trello list
 ```
+
 # Roadmap
 This tools is in the making
-* Upload as Ruby Gem
+* Multi server with the same BOT
+* Better command params handling
+* Convert the message HASH into a Ruby Class
+* Change the JSON config file to a init class configuration for better customization
+* Title dates formatting
+* Gem dependencies
 * Regex conditioning
 * Slack Integration
 * Email reports Integration
-* Convert the message HASH into a Ruby Class
+* Authy integration for TwoFactor authentication for sensible commands
+* API Keys with ENV variables

data/bin/emissary

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/emissary'
+
+file = File.open ARGV[0]
+c_config = JSON.load file
+
+Emissary.configure do |config|
+  # usuario transacional para sms instantaneos
+  config.server_name = c_config["server_name"]
+  config.header_format = c_config["header_format"]
+  config.webhooks_url  = c_config["webhooks_url"]
+  config.bot_token  = c_config["bot_token"]
+  config.trello_public_key = c_config["trello_public_key"]
+  config.trello_member_token = c_config["trello_member_token"],
+  config.json_file_path = ARGV[0]
+end
+
+
+begin
+  puts "====> Emissary is starting..."
+  puts "====> Server name #{Emissary.server_name}..."
+
+  emi = Emissary.new
+rescue => e
+  puts "#{e}"
+  exit 1
+end

data/emissary.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "emissary-ruby"
-  spec.version       = "0.0.6"
+  spec.version       = "0.0.7"
   spec.authors       = ["MakarovCode"]
   spec.email         = ["simoncorreaocampo@gmail.com"]
 
@@ -14,11 +14,9 @@ Gem::Specification.new do |spec|
 
   # 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('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files         = ["emissary.gemspec", "README.md", "CODE_OF_CONDUCT.md"] + `git ls-files | grep -E '^(bin|lib|web)'`.split("\n")
+  # spec.bindir        = "exe"
+  spec.executables   = ["emissary"]
   spec.require_paths = ["lib"]
 
   # spec.add_development_dependency "bundler", "~> 2.0"

data/lib/emissary.rb

@@ -58,16 +58,24 @@ class Emissary
           if loggr.bash_command == ""
             if args.count > 1
               if args[1] == "report"
-                loggr.report
-                "#{Emissary.header}\nGenerating Last Report"
+                if args[2].nil? || (!args[2].nil? && args[2] == Emissary.server_name)
+                  loggr.report
+                  "#{Emissary.header}\nGenerating Last Report"
+                end
               elsif args[1] == "fetch"
-                loggr.fetch
-                "#{Emissary.header}\nFetching Report"
+                if args[2].nil? || (!args[2].nil? && args[2] == Emissary.server_name)
+                  loggr.fetch
+                  "#{Emissary.header}\nFetching Report"
+                end
               elsif args[1] == "clear"
-                loggr.clear
-                "#{Emissary.header}\nClearing Report"
+                if args[2].nil? || (!args[2].nil? && args[2] == Emissary.server_name)
+                  loggr.clear
+                  "#{Emissary.header}\nClearing Report"
+                end
               elsif args[1] == "last"
-                loggr.message_to_chat loggr.last_message
+                if args[2].nil? || (!args[2].nil? && args[2] == Emissary.server_name)
+                  loggr.message_to_chat loggr.last_message
+                end
               elsif ![nil, ""].include?(args[1]) && args[1].include?(loggr.alias)
                 if args.count > 2
                   if args[2] == "trello"

data/lib/loggr.rb

@@ -72,7 +72,7 @@ class Loggr
         if @messages["#{file_lines[i+1]}"].nil?
           @last_id += 1
           @messages["#{file_lines[i+1]}"] = {
-            id: "#{@alias}-#{@last_id}",
+            id: "#{Emissary.server_name}-#{@alias}-#{@last_id}",
             trigger: "Completed 500 Internal Server Error",
             lines: file_lines[i..(i+@lines)],
             count: 1,
@@ -93,7 +93,7 @@ class Loggr
   end
 
   def last_message
-    message_by_id("#{@alias}-#{@last_id}")
+    message_by_id("#{Emissary.server_name}-#{@alias}-#{@last_id}")
   end
 
   def lines_to_code(message)

metadata

@@ -1,28 +1,26 @@
 --- !ruby/object:Gem::Specification
 name: emissary-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - MakarovCode
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-06-13 00:00:00.000000000 Z
+date: 2021-06-16 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
 - simoncorreaocampo@gmail.com
-executables: []
+executables:
+- emissary
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE
 - README.md
-- Rakefile
+- bin/emissary
 - bin/setup
 - emissary.gemspec
 - lib/emissary.rb

data/.gitignore

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

data/Gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in frm_mercury.gemspec
-gemspec

data/LICENSE

@@ -1,21 +0,0 @@
-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/Rakefile

@@ -1,2 +0,0 @@
-require "bundler/gem_tasks"
-task :default => :spec