slack_500_revue 1.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d373e223213c3201708bc6539a5ff2ea5a32694701c82093de1ab7cad3be209
+  data.tar.gz: 611a80392ea5fd6ffe1fcc8a2f2b3817cd618db534b3e7098e4196ba3dde5967
+SHA512:
+  metadata.gz: 694928f69907c7551f5622298476fef230dcbeeee117f9fc1b8e5448f606232ee5e31ca050204f05c7f319ba2c02a91f6f181a308a06533e2ff6a496eeee1499
+  data.tar.gz: c614d86d670b803fb8d273afd4b0d1a2db43c06ce1ff99176c47995ff6b1a30cb7b8159a0567b9245c7d10fe684ce759939809a56a6d91daa9ba7d360e97bb08

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.1

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 matsunaga@iarchitect.co.jp. 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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 kazuomatz
+
+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,99 @@
+# Slack500Revue
+
+Slack500Revue is a gem that notifies exceptions raised by Rails to your Slack channel using incomming WebHooks URL.
+
+The following items are displayed in the Slack message.
+
+- http method
+- Controller and Action
+- Query Parameters
+- Body Content (Query / JSON )
+- Remote IP
+- User Agent
+- Error Message
+- Backtrace
+
+<img src="https://user-images.githubusercontent.com/2704723/60161177-ee479980-9831-11e9-9861-360ce28ffdef.png" width="70%"/>
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slack_500_revue'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slack_500_revue
+
+Execute rake task to create configuration file.
+
+    $ rake slack_500_revue:config
+
+
+and edit "/config/initializers/slack_500_revue.rb"
+
+```
+require 'slack_500_revue'
+Slack500Revue.setup do |config|
+    # report pretext of slack message
+    config.pretext = 'Slack Report Title'
+
+    # report title of slack message
+    config.title = 'Rendering 500 with exception.'
+
+    # color of slack message
+    config.color = '#FF0000'
+
+    # footer text of slack message
+    config.footer = 'via Slack 500 Report.'
+
+    # WebHook URL
+    # see https://slack.com/services/new/incoming-webhook
+    config.webhook_url = "https://hooks.slack.com/services/xxxxxxxxx/xxxx"
+end
+```
+
+## Usage
+
+```
+class ApplicationController < ActionController::Base
+
+  if !Rails.env.production?
+    rescue_from Exception, with: :rescue_500
+  end
+
+  :
+  :
+
+  def rescue_500(exception=nil)
+
+    # Report Exception to Slack
+    Slack500Revue.post(request,exception)
+
+    render 'error/500', status: :internal_server_error, layout: 'application'
+    end
+
+  :
+  :
+
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kazuomatz/slack_500_revue. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Slack500Revue projects codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/slack_500_revue/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slack_500_revue"
+
+# 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/slack_500_revue/version.rb

@@ -0,0 +1,3 @@
+module Slack500Revue
+  VERSION = "1.2.1"
+end

data/lib/slack_500_revue.rb

@@ -0,0 +1,122 @@
+require 'rubygems'
+require 'active_support'
+require "slack_500_revue/version"
+
+module Slack500Revue
+
+  class Error < StandardError;
+  end
+
+  ROOT_PATH = File.expand_path "../../", __FILE__
+
+  module ::Rails
+    class Application
+      rake_tasks do
+        Dir[File.join(ROOT_PATH, "/lib/tasks/", "**/*.rake")].each do |file|
+          load file
+        end
+      end
+    end
+  end
+
+  def self.setup
+    yield self
+  end
+
+  mattr_accessor :pretext
+  @@pretext = nil
+
+  mattr_accessor :title
+  @@title = nil
+
+  mattr_accessor :color
+  @@color = nil
+
+  mattr_accessor :footer
+  @@footer = nil
+
+  mattr_accessor :webhook_url
+  @@webhook_url = nil
+
+  def self.post (request, exception, params = {})
+    url = self.webhook_url
+    begin
+      uri = URI.parse(url)
+    rescue
+      Rails.logger.error '** Slack500:: invalid Webhook URL.'
+      return
+    end
+
+    bullet = ':black_small_square:'
+    text = "#{exception.message}\n\n"
+
+    text += "#{bullet}*Request*\n*#{request.method}* #{request.url}\n\n"
+    text += "#{bullet}*User Agent*\n#{request.user_agent}\n\n"
+    text += "#{bullet}*IP*\n#{request.remote_ip}\n\n"
+    text += "#{bullet}*Query*\n#{request.query_parameters}\n\n" unless request.query_parameters.empty?
+
+    request.body.rewind
+    body_text = request.body.read
+
+    begin
+      if body_text.present?
+        body = JSON.parse(body_text)
+      end
+    rescue => e
+      if body_text.present?
+        body_params = {}
+        body_text.split('&').each do |param|
+          kv = param.split("=")
+          if kv.length == 2
+            if kv[0].downcase.index('token').present? || kv[0].downcase.index('password').present?
+              body_params[URI.decode(kv[0])] = '[** FILTERED **]'
+            elsif kv[0] != 'utf8'
+              body_params[URI.decode(kv[0])] = truncate(URI.decode(kv[1]).force_encoding('UTF-8'),100)
+            end
+          end
+        end
+        if body_params.empty?
+          body = body_text
+        else
+          body = body_params
+        end
+      end
+    end
+
+    text += "#{bullet}*Body*\n#{body}\n\n" unless body.nil?
+    text += "#{bullet}*Backtrace*\n#{exception.backtrace.map {|s| "`#{s.gsub('`', '').gsub("'", '').gsub(Rails.root.to_s, '')}`"}.join("\n")}"
+    text = text.force_encoding('UTF-8')
+    default_params = {
+        pretext: self.pretext,
+        title: self.title,
+        color: self.color,
+        footer: self.footer
+    }
+
+    attachments = default_params.merge(params)
+    attachments[:text] = text
+    attachments[:title] = "#{request.parameters[:controller]}##{request.parameters[:action]} - #{attachments[:title]}"
+
+    params = {
+        attachments: [attachments]
+    }
+
+    begin
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.start do
+        request = Net::HTTP::Post.new(uri.path)
+        request.set_form_data(payload: params.to_json)
+        http.request(request)
+      end
+    rescue => e
+      Rails.logger.error "** Slack500:: #{e.full_message}."
+    end
+  end
+
+  private
+  def self.truncate(string, max)
+    string.length > max ? "#{string[0...max]}..." : string
+  end
+
+end

data/lib/tasks/slack_500_revue.rake

@@ -0,0 +1,34 @@
+namespace :slack_500_revue do
+  desc 'configuration slack_500_revue'
+  task :config do
+    file = File.join(Rails.root,'config','initializers','slack_500_revue.rb')
+    if File.exists?(file)
+      puts "#{file} esxits. overwrite? (y/n)"
+      s = STDIN.getc
+      exit unless s[0].downcase == 'y'
+    end
+    File.open(file,'w') do |file|
+      file.puts("require 'slack_500_revue'")
+      file.puts("\nSlack500Revue.setup do |config|")
+
+      file.puts("\n    # report pretext of slack message")
+      file.puts("    config.pretext = 'Slack Report Title'")
+
+      file.puts("\n    # report title of slack message")
+      file.puts("    config.title = 'Rendering 500 with exception.'")
+
+      file.puts("\n    # color of slack message")
+      file.puts("    config.color = '#FF0000'")
+
+      file.puts("\n    # footer text of slack message")
+      file.puts("    config.footer = 'via Slack 500 Report.'")
+
+      file.puts("\n    # WebHook URL")
+      file.puts("    # see https://slack.com/services/new/incoming-webhook")
+      file.puts("    config.webhook_url = '(Your Slack WebHook URL)https://hooks.slack.com/services/xxxxxxxxx/xxxx'")
+
+      file.puts("\nend")
+    end
+    puts "Slack500Revue:: you need edit #{file}."
+  end
+end

data/slack_500_revue.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "slack_500_revue/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "slack_500_revue"
+  spec.version       = Slack500Revue::VERSION
+  spec.authors       = ["Tuan Dang"]
+  spec.email         = ["dangtuan030690@gmail.com"]
+
+  spec.summary       = %q{Post Rails Exceptions to your Slack channel.}
+  spec.description   = %q{Slack500Revue is a gem that notifies exceptions raised by Rails to your Slack channel using incomming WebHooks URL.}
+  spec.homepage      = "https://github.com/dangngoctuan/Slack500Revue"
+  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         = 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.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_runtime_dependency "rails",">= 5.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: slack_500_revue
+version: !ruby/object:Gem::Version
+  version: 1.2.1
+platform: ruby
+authors:
+- Tuan Dang
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-31 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Slack500Revue is a gem that notifies exceptions raised by Rails to your
+  Slack channel using incomming WebHooks URL.
+email:
+- dangtuan030690@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slack_500_revue.rb
+- lib/slack_500_revue/version.rb
+- lib/tasks/slack_500_revue.rake
+- slack_500_revue.gemspec
+homepage: https://github.com/dangngoctuan/Slack500Revue
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Post Rails Exceptions to your Slack channel.
+test_files: []