slack_webhook_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a171da397b47aa75106d933b8569c53c2e4030c8f2e862a5e97619b76930a1c
+  data.tar.gz: d356b7f9f480004281b65b8531520f94de86edef6d25304e0cf4cf4fb2528070
+SHA512:
+  metadata.gz: 5604f4ebd14b80aaa29aa4ac5189c706fa0643ea4d0e7f1fc901bf5a3463ed8439089022b4d3304635901b7ddf1b412043ec32bd179d7850e2724d883174d958
+  data.tar.gz: 4b59ab65a5ddef012752238629a8f303096d99ad2f6b0a96210fd524d0b4907ae8fbde86528af5de299c94a16084d259fc6db1bb4bf582e71fe044dd79f9b2d4

data/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: gjtorikian
+patreon: gjtorikian
+open_collective: garen-torikian
+#ko_fi: # Replace with a single Ko-fi username
+#tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+#community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+#liberapay: # Replace with a single Liberapay username
+issuehunt: gjtorikian
+#otechie: # Replace with a single Otechie username
+#custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: Ruby CI
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: [2.7.2, 2.6.6, 2.5.8]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec rake

data/.github/workflows/lint.yml

@@ -0,0 +1,21 @@
+name: Linting
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - run: bundle install
+      - name: Rubocop
+        run: bundle exec rake rubocop

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_gem:
+  rubocop-standard:
+    - config/default.yml
+    - config/minitest.yml
+
+AllCops:
+  TargetRubyVersion: 2.5

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 gjtorikian@users.noreply.github.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in slack-webhooklogger.gemspec
+gemspec
+
+gem 'awesome_print', '~> 1.8'
+gem 'minitest', '~> 5.0'
+gem 'rake', '~> 12.0'
+gem 'rubocop', '~> 1.6'
+gem 'rubocop-performance', '~> 1.9'
+gem 'rubocop-standard', '~> 5.1'

data/Gemfile.lock

@@ -0,0 +1,114 @@
+PATH
+  remote: .
+  specs:
+    slack_webhook_logger (0.1.0)
+      activesupport (>= 5.0, < 7.0)
+      railties (>= 5.0, < 7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.4.4)
+      actionview (= 5.2.4.4)
+      activesupport (= 5.2.4.4)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.4.4)
+      activesupport (= 5.2.4.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.1)
+    awesome_print (1.8.0)
+    builder (3.2.4)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    erubi (1.10.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.8.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    minitest (5.14.2)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.2.4.4)
+      actionpack (= 5.2.4.4)
+      activesupport (= 5.2.4.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.0.0)
+    rexml (3.2.4)
+    rubocop (1.6.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    rubocop-minitest (0.10.1)
+      rubocop (>= 0.87)
+    rubocop-performance (1.9.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.9.0)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 0.90.0, < 2.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-standard (5.1.2)
+      rubocop
+      rubocop-minitest
+      rubocop-performance
+      rubocop-rails
+      rubocop-rake
+    ruby-progressbar (1.10.1)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print (~> 1.8)
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rubocop (~> 1.6)
+  rubocop-performance (~> 1.9)
+  rubocop-standard (~> 5.1)
+  slack_webhook_logger!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Garen J. Torikian
+
+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,41 @@
+# Slack::WebhookLogger
+
+A simple Slack logger using ActiveSupport broadcast and a slim HTTPS call.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slack-webhooklogger'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install slack-webhooklogger
+```
+
+Then, run the install generator:
+
+```
+$ rails generate slack-webhooklogger:install
+```
+
+Provide the webhook URL in the config, and finally, extend the logger:
+
+```ruby
+config.after_initialize do
+  Rails.logger.extend ActiveSupport::Logger.broadcast(SlackWebhookLogger.logger)
+end
+```
+
+## Configuration
+
+You can change the log level or the format of the logging text if you wish. See the generated slack_webhook_logger.rb file for more infomation on that.

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slack/webhook_logger"
+
+# 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/generators/slack_webhook_logger/install_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module SlackWebhookLogger
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("..#{File::SEPARATOR}..#{File::SEPARATOR}templates", __FILE__)
+
+    desc 'Create a Slack::WebhookLogger initializer'
+
+    def copy_initializer
+      template 'slack_webhook_logger.rb', 'config/initializers/slack_webhook_logger.rb'
+    end
+  end
+end

data/lib/generators/templates/slack_webhook_logger.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+SlackWebhookLogger.setup do |config|
+  # The URL where messages will be sent. This is required.
+  config.webhook_url = 'https://hooks.slack.com/services/xxx/yyy/zzz'
+
+  # The minimum error level to see in Slack. This is optional; the default is :WARN.
+  #
+  # All log levels are supported, but don't rely on anything less then :WARN
+  # since Slack only allows one message per minute.
+  # config.level = :WARN
+
+  # You can provide a custom log formatter if you want to. This is optional.
+  # The formatter must construct a JSON blob that adheres to Slack's expected
+  # POST payload for `chat.postMessage`: https://api.slack.com/methods/chat.postMessage
+  # config.formatter =  SomeOtherFormatter.new
+end

data/lib/slack_webhook_logger.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'active_support/logger'
+require 'active_support/core_ext/module/attribute_accessors'
+
+require 'net/http'
+require 'net/https'
+require 'uri'
+
+require 'slack_webhook_logger/logger'
+require 'slack_webhook_logger/formatter'
+require 'slack_webhook_logger/request_io'
+
+module SlackWebhookLogger
+  # Can be modified in Rails app
+  mattr_accessor :webhook_url
+  mattr_accessor :level
+  mattr_accessor :formatter
+
+  # Used internally
+  mattr_reader :webhook_uri
+  mattr_reader :logger
+  mattr_reader :https
+
+  # rubocop:disable Style/ClassVars
+  def self.setup
+    @@logger = SlackWebhookLogger::Logger.new(SlackWebhookLogger::RequestIO)
+
+    yield self
+
+    @@logger.formatter = @@formatter || SlackWebhookLogger::Formatter.new
+    @@logger.level = @@level || :warn
+
+    @@webhook_uri = URI.parse(@@webhook_url)
+    https = Net::HTTP.new(@@webhook_uri.host, @@webhook_uri.port)
+    https.use_ssl = true
+    https.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+    @@https = https
+  end
+  # rubocop:enable Style/ClassVars
+end

data/lib/slack_webhook_logger/formatter.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module SlackWebhookLogger
+  class Formatter < ::Logger::Formatter
+    attr_writer :format
+
+    def format
+      @format ||= proc { |severity, time, _progname, msg|
+        heading = case severity
+                  when 'FATAL'
+                    "📛 *#{severity}*"
+                  when 'ERROR'
+                    "🛑 *#{severity}*"
+                  when 'WARN'
+                    "⚠️ *#{severity}*"
+                  when 'INFO'
+                    "ℹ️ *#{severity}*"
+                  when 'DEBUG'
+                    "🐛 *#{severity}*"
+                  else
+                    '🪵 *Logger*'
+                  end
+
+        title = "#{heading} (#{time})"
+
+        text = <<~MSG
+          #{msg2str(msg)}
+        MSG
+
+        {
+          text: [title, text].join("\n").to_s,
+          blocks: [
+            {
+              type: 'section',
+              text: {
+                type: 'mrkdwn',
+                text: title
+              }
+            },
+            {
+              type: 'divider'
+            },
+            {
+              type: 'section',
+              text: {
+                "type": 'plain_text',
+                "text": text
+              }
+            }
+          ]
+        }
+      }
+    end
+
+    def call(severity, time, progname, msg)
+      format.call(severity, time, progname, msg)
+    end
+
+    private def msg2str(msg)
+      case msg
+      when ::String
+        msg
+      when ::Exception
+        "#{msg.message} (#{msg.class})\n" <<
+        (msg.backtrace || []).join("\n")
+      else
+        msg.inspect
+      end
+    end
+  end
+end

data/lib/slack_webhook_logger/logger.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/delegation'
+
+module SlackWebhookLogger
+  class Logger < ::ActiveSupport::Logger
+    class << self
+      delegate :fatal, :error, :warn, :info, :debug, \
+               :add, :log, to: :instance
+    end
+  end
+end

data/lib/slack_webhook_logger/request_io.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'json'
+
+module SlackWebhookLogger
+  class RequestIO
+    def self.close
+      true
+    end
+
+    def self.write(payload)
+      return if payload.blank?
+
+      req = Net::HTTP::Post.new(SlackWebhookLogger.webhook_uri.path)
+      req.set_form_data(payload: payload.to_json)
+      SlackWebhookLogger.https.request(req)
+    end
+  end
+end

data/lib/slack_webhook_logger/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SlackWebhookLogger
+  VERSION = '0.1.0'
+end

data/slack_webhook_logger.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'lib/slack_webhook_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'slack_webhook_logger'
+  spec.version       = SlackWebhookLogger::VERSION
+  spec.authors       = ['Garen J. Torikian']
+  spec.email         = ['gjtorikian@gmail.com']
+
+  spec.summary       = 'A slim wrapper for posting to Rails logs to Slack'
+  spec.homepage      = 'https://github.com/gjtorikian/slack_webhook_logger'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('~> 2.5')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # 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{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 5.0', '< 7.0'
+  spec.add_dependency 'railties', '>= 5.0', '< 7.0' # for the generators
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: slack_webhook_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garen J. Torikian
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description:
+email:
+- gjtorikian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/FUNDING.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/lint.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/slack_webhook_logger/install_generator.rb
+- lib/generators/templates/slack_webhook_logger.rb
+- lib/slack_webhook_logger.rb
+- lib/slack_webhook_logger/formatter.rb
+- lib/slack_webhook_logger/logger.rb
+- lib/slack_webhook_logger/request_io.rb
+- lib/slack_webhook_logger/version.rb
+- slack_webhook_logger.gemspec
+homepage: https://github.com/gjtorikian/slack_webhook_logger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gjtorikian/slack_webhook_logger
+  source_code_uri: https://github.com/gjtorikian/slack_webhook_logger
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: A slim wrapper for posting to Rails logs to Slack
+test_files: []