emissary-ruby 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6027531fa65f64344606200f289efe2fc218fc9424c628dfc2cb5e6c4393a095
-  data.tar.gz: ff0c4c8ef3afe0bde5f1c2ce06f5c06e00a3cae5de51ac0d6899e4ee99e7ce78
+  metadata.gz: e079c3d6412aec1ff8fafa45be88815d1b7d9d21b2b6e1bdfa73fc7f3877655c
+  data.tar.gz: 11cb0ba431892f25777d7a81cb3d7ed74f80913536147ce5e6a361597e204aec
 SHA512:
-  metadata.gz: 628c743051894f063c89effed6d752a4790be51b68e702040e601f9f13ec6f059a50c5cfd518bb5092d62d6f76ca393ca203579dd28d5d4e2c9ba73f1443fa11
-  data.tar.gz: 8189472f28905e98cc8e7196f58c2dc64a7e5980b52cdeb22dcadbff258a05f628358cb20f9df40bb6b9f8c42ea7dfdd6429bd819849680cfe1548cd4fd4e036
+  metadata.gz: 910d242d70f9dbd1ed7cc3561b81eb4469d2bb10564d071e7ac2830d3441b22e5d7c21bc0f3cbd644db32eb9b57e73448241fa8747a63932db2e89714ded6e24
+  data.tar.gz: 2d45556b04e7ef17700809d96c01b1dc6b5b28d7addf737d61054c911fe9eeb5e0073a3d31e05c87359489d0ebdc530c361cdf88ba376fa45746c93008b792c1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at simoncorreaocampo@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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/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/emissary.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "emissary-ruby"
+  spec.version       = "0.0.7"
+  spec.authors       = ["MakarovCode"]
+  spec.email         = ["simoncorreaocampo@gmail.com"]
+
+  spec.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."
+  spec.homepage      = "https://github.com/MakarovCode/Emissary"
+  spec.license       = "MIT"
+
+  # 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         = ["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"
+  # spec.add_development_dependency "rake", "~> 13.0"
+  # spec.add_development_dependency "discordrb", "~> 3.4.2"
+  # spec.add_development_dependency "ruby-trello", "~> 3.0.0"
+  #
+  # spec.add_runtime_dependency "bundler", "~> 2.0"
+  # spec.add_runtime_dependency "rake", "~> 13.0"
+  # spec.add_runtime_dependency "discordrb", "~> 3.4.2"
+  # spec.add_runtime_dependency "ruby-trello", "~> 3.0.0"
+end

data/lib/emissary.rb

@@ -1,14 +1,11 @@
 require 'discordrb'
-
 require "json"
-
-
-require './lib/loggr';
+require 'loggr';
 
 class Emissary
 
   class << self
-    attr_accessor :webhooks_url, :bot_token, :trello_public_key, :trello_member_token, :server_name, :header_format
+    attr_accessor :webhooks_url, :bot_token, :trello_public_key, :trello_member_token, :server_name, :header_format, :json_file_path
     def configure(&block)
       block.call(self)
     end
@@ -38,7 +35,7 @@ class Emissary
 
   def read_loggrs
 
-    file = File.open "./lib/loggr.json"
+    file = File.open Emissary.json_file_path
     raw_loggrs = JSON.load file
     raw_loggrs.each do |k, v|
       loggr = Loggr.new v
@@ -61,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,81 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: emissary-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.7
 platform: ruby
 authors:
 - MakarovCode
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-06-13 00:00:00.000000000 Z
-dependencies:
-- !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: 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
+date: 2021-06-16 00:00:00.000000000 Z
+dependencies: []
 description: 
 email:
 - simoncorreaocampo@gmail.com
-executables: []
+executables:
+- emissary
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- LICENSE
+- CODE_OF_CONDUCT.md
 - README.md
+- bin/emissary
+- bin/setup
+- emissary.gemspec
 - lib/emissary.rb
 - lib/loggr.json
 - lib/loggr.rb

data/.gitignore

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

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.