chat_notifier 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11bbd1390ca03c1f99d0ff66a5e3a361f259f40704575db73ae255e67e48b94b
-  data.tar.gz: 24781a89995cf1384962fb46b5a60d8ed5095e442af92162a85e5e82489007ee
+  metadata.gz: 622357edb937d16bc4374115ad8d67e022fca33fee0544106af820797848fe17
+  data.tar.gz: 15d105331090d2dc981d56dd4a598040dab9ba392fb66c496469c851df06bac8
 SHA512:
-  metadata.gz: a2584238466e94fc1efba40198f83761464f6bf399b9e99b8b640eb21a074a13699fe18bb42a4c1be049e1d0ccdb5950d721ce1342c04f1bfbc277f4195be189
-  data.tar.gz: f6e4ac759352ba03f7a21a283f3e43eb4202f0fad8ddd7125b1024713fe96bdac3b283a9bc3f5555495005c96bc92b5438307f55cf1b318556b79674c7143f32
+  metadata.gz: 74bb8fd9d9fded6a20097d8bdc04bd1f6178f61ec28ffb191579f73833f8eeaadbd6012034abea92f23db803db23d963d3a0e96b007f14883d7304eaa76d98fa
+  data.tar.gz: c87f9c544e476ba0f5afe182cb1f729a7687fea615fff51398ec288b1b85a7779cfa3d2b7e988298af28ba3c09b3de7506ea1374add5e665d8afe90d39522500

data/CHANGELOG.md

@@ -5,8 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## 0.1.0
+## [0.2.1] - 2024-07-01
 
 ### Added
 
-- Initial code
+- Version and release management with reissue gem.
+
+### Changed
+
+- Slack chatter looks for NOTIFY_SLACK ENV variables instead of just SLACK
+
+## [0.2.0] - 2023-04-24
+
+### Changed
+
+- Renamed ENV variables to prefix `NOTIFY_`
+
+## [0.1.0] - 2023-04-19
+
+### Added
+
+- Initial code

data/README.md

@@ -4,16 +4,51 @@ Notify a chat room with data from your test run.
 
 ## Installation
 
-```
+```ruby
 gem "chat_notifier", git: "https://github.com/SOFware/chat_notifier.git"
 ```
 
 ## Usage
 
+### Minitest
+
+Your minitest suite should pick up the formatter automatically.
+
+### RSpec
+
 Add to your `spec_helper.rb` or `rails_helper.rb`:
 
-```
+```ruby
 require "chat_notifier/rspec_formatter"
+
+config.add_formatter "ChatNotifier::RspecFormatter" if ENV["CI"]
+```
+
+Add to your config/application.rb within your namespaced module
+
+```ruby
+  def self.sha
+    `git rev-parse --short HEAD`.chomp
+  end
+
+  def self.branch
+    `git branch --show-current`.chomp
+  end
+```
+
+Add these variables to your env files
+
+```
+      NOTIFY_SLACK_WEBHOOK_URL
+      NOTIFY_SLACK_NOTIFY_CHANNEL
+      NOTIFY_CURRENT_REPOSITORY_URL
+      NOTIFY_TEST_RUN_ID
+```
+
+If you are _not_ using Rails, you will need to add this ENV variable:
+
+```
+      NOTIFY_APP_NAME
 ```
 
 ### Debug your Slack setup
@@ -22,14 +57,16 @@ Create rake task to test the connection to your Slack channel
 
 ```ruby
 namespace :chat_notifier do
+  desc "Tests chat notifier"
   task debug: :environment do
-    unless ENV["SLACK_WEBHOOK_URL"]
-      puts "You MUST set the environment variables for:\nSLACK_WEBHOOK_URL"
+    unless ENV["NOTIFY_SLACK_WEBHOOK_URL"]
+      puts "You MUST set the environment variables for:\nNOTIFY_SLACK_WEBHOOK_URL"
       return
     end
     ENV["DEBUG"] = "1"
-    ENV["CURRENT_REPOSITORY_URL"] = "https://example.com"
-    ENV["TEST_RUN_ID"] = "9999"
+    ENV["NOTIFY_CURRENT_REPOSITORY_URL"] = "https://example.com"
+    ENV["NOTIFY_TEST_RUN_ID"] = "9999"
+    ENV["NOTIFY_APP_NAME"] = "Example App" # Defaults to your Rails app name
     require "chat_notifier"
 
     failure = ChatNotifier::DebugExceptionLocation.new(location: "fake/path.rb")

data/lib/chat_notifier/chatter/slack.rb

@@ -7,16 +7,16 @@ module ChatNotifier
 
       class << self
         def handles?(settings)
-          !settings.keys.grep(/SLACK/).empty?
+          !settings.keys.grep(/NOTIFY_SLACK/).empty?
         end
       end
 
       def webhook_url
-        settings.fetch("SLACK_WEBHOOK_URL", nil)
+        settings.fetch("NOTIFY_SLACK_WEBHOOK_URL", nil)
       end
 
       def channel
-        settings.fetch("SLACK_NOTIFY_CHANNEL", nil)
+        settings.fetch("NOTIFY_SLACK_NOTIFY_CHANNEL", nil)
       end
 
       def payload(data)

data/lib/chat_notifier/repository/github.rb

@@ -4,7 +4,7 @@ module ChatNotifier
   class Repository
     class Github < self
       def url
-        settings.fetch("CURRENT_REPOSITORY_URL", nil)
+        settings.fetch("NOTIFY_CURRENT_REPOSITORY_URL", nil)
       end
 
       def link(sha)

data/lib/chat_notifier/test_environment/github.rb

@@ -8,7 +8,7 @@ module ChatNotifier
       end
 
       def run_id
-        settings.fetch("TEST_RUN_ID")
+        settings.fetch("NOTIFY_TEST_RUN_ID")
       end
     end
   end

data/lib/chat_notifier/test_environment.rb

@@ -22,7 +22,7 @@ module ChatNotifier
     end
 
     def url
-      settings.fetch("CURRENT_REPOSITORY_URL")
+      settings.fetch("NOTIFY_CURRENT_REPOSITORY_URL")
     end
 
     def test_run_url

data/lib/chat_notifier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ChatNotifier
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/chat_notifier.rb

@@ -12,6 +12,18 @@ module ChatNotifier
   DebugSummary = Data.define(:failed_examples)
 
   class << self
+    require "logger"
+    @logger = Logger.new($stdout)
+    attr_accessor :logger
+
+    def app
+      if defined?(::Rails)
+        Rails.application.class.module_parent
+      else
+        ENV.fetch("NOTIFY_APP_NAME")
+      end
+    end
+
     # In order to test this locally see `rake chat_notifier:debug`
     def debug!(env, summary:, notifier: :Debug)
       repository = Repository.for(env)
@@ -24,9 +36,9 @@ module ChatNotifier
       )
       messenger = Messenger.for(
         summary,
-        app: Rails.application.class.module_parent,
-        repository: repository,
-        environment: environment
+        app:,
+        repository:,
+        environment:
       )
 
       chatter.post(messenger)
@@ -43,13 +55,17 @@ module ChatNotifier
 
       messenger = Messenger.for(
         summary,
-        app: Rails.application.class.module_parent,
+        app:,
         repository:,
         environment:
       )
 
       chatter.each do |box|
-        box.conditional_post(messenger)
+        begin
+          box.conditional_post(messenger)
+        rescue => exception
+          logger.error("ChatNotifier: #{box.webhook_url} #{exception.class}: #{exception.message}")
+        end
       end
     end
   end

data/lib/minitest/chat_notifier_plugin.rb

@@ -0,0 +1,14 @@
+module Minitest
+  def self.plugin_chat_notifier_init(options)
+    Minitest.reporter << ChatNotifierPlugin.new(options[:io], options)
+  end
+
+  class ChatNotifierPlugin < SummaryReporter
+    ExceptionLocation = Data.define(:location)
+    Summary = Data.define(:failed_examples)
+    def report
+      summary = Summary[(results.map{ |result| ExceptionLocation[result.source_location] })]
+      ChatNotifier.call(summary:)
+    end
+  end
+end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: chat_notifier
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jim Gay
+- Savannah Albanez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-19 00:00:00.000000000 Z
+date: 2024-07-01 00:00:00.000000000 Z
 dependencies: []
 description: Send test results to chat
 email:
 - jim@saturnflyer.com
+- sealbanez@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -33,6 +35,7 @@ files:
 - lib/chat_notifier/test_environment/debug.rb
 - lib/chat_notifier/test_environment/github.rb
 - lib/chat_notifier/version.rb
+- lib/minitest/chat_notifier_plugin.rb
 homepage:
 licenses: []
 metadata:
@@ -53,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Notify chat of test results