error_radar 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e61377f5cc7c807daf772fd90bb0aa7bdde3e5e5ee5f28d189a08330eb63e84f
-  data.tar.gz: 1f3f335da43317a3fe7b14c7cd1b0c7a5a24780ced25800f789d17efd62311f7
+  metadata.gz: 97d73a27edbc8351ce6ff95be373a45ac9213057b332affd769980223a643b37
+  data.tar.gz: d079439643d93715219b0297184f3b595d8cf609a6bb8cd74633d714aa142033
 SHA512:
-  metadata.gz: 868c323dfd34134eb09ba2d4a0a1733d01fa75741f9cbafc015c7be18f3d828110d81b0f11e6f8c190d1c6c6d6623e745a28fea4c93086bd4174f61ec9ee679f
-  data.tar.gz: 7e0c1638239b754944e73b12cf5d832d2873ae643bf363ebe375a36771273106acdbe7c66d1dd8a6797587fba68a0957fab871e040237fd8e6fe0bb7f688c392
+  metadata.gz: f55e7e0ca86fb47c6d739fdc13816380cfbc58378f8fea6b75b2db8867393a537ced7d50bca30e81025c5fb5cc2c5fe5ff9c12956b7314eaa16ab8962690da09
+  data.tar.gz: 77610793d856a3dbc46621ad99edb937724a8280edaa90e03bc3a65e7b2e180b4ddc77ae1476699b5129d11b63b00aa5daca4f5db88f8596ae7322b21db04957

data/app/controllers/error_radar/settings_controller.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ErrorRadar
+  class SettingsController < ApplicationController
+    before_action :authenticate_request!
+
+    CHATWORK_KEYS = %w[chatwork_api_token chatwork_room_id chatwork_notify_sources].freeze
+
+    def show
+      @settings = CHATWORK_KEYS.each_with_object({}) do |key, h|
+        h[key] = Setting.get(key)
+      end
+      # notify_sources is stored as an array; join for the textarea
+      @settings['chatwork_notify_sources'] = Array(@settings['chatwork_notify_sources']).join("\n")
+    end
+
+    def update
+      CHATWORK_KEYS.each do |key|
+        value = settings_params[key]
+        next if value.nil?
+
+        if key == 'chatwork_notify_sources'
+          lines = value.split(/[\n,]+/).map(&:strip).reject(&:empty?)
+          Setting.set(key, lines)
+        else
+          Setting.set(key, value.strip.presence)
+        end
+      end
+
+      redirect_to settings_path, notice: 'Settings saved.'
+    end
+
+    private
+
+    def settings_params
+      params.require(:settings).permit(*CHATWORK_KEYS)
+    rescue ActionController::ParameterMissing
+      {}
+    end
+  end
+end

data/app/models/error_radar/setting.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ErrorRadar
+  # Key-value store for UI-configurable settings (e.g. ChatWork credentials).
+  # Values are JSON-encoded so arrays/booleans survive the round-trip.
+  class Setting < ApplicationRecord
+    validates :key, presence: true, uniqueness: true
+
+    CHATWORK_KEYS = %w[
+      chatwork_api_token
+      chatwork_room_id
+      chatwork_notify_sources
+    ].freeze
+
+    def self.get(key)
+      row = find_by(key: key.to_s)
+      return nil if row.nil? || row.value.nil?
+
+      JSON.parse(row.value)
+    rescue JSON::ParserError
+      row.value
+    end
+
+    def self.set(key, value)
+      row = find_or_initialize_by(key: key.to_s)
+      row.value = value.nil? ? nil : value.to_json
+      row.save!
+    end
+
+    def self.chatwork_settings
+      CHATWORK_KEYS.each_with_object({}) do |key, hash|
+        hash[key] = get(key)
+      end
+    end
+  end
+end

data/app/views/error_radar/settings/show.html.erb

@@ -0,0 +1,59 @@
+<h1>Settings</h1>
+<p class="sub">Configure notification channels. Changes take effect immediately — no deploy needed.</p>
+
+<% if notice.present? %>
+  <div style="background:#d1fae5;border:1px solid #6ee7b7;color:#065f46;padding:10px 14px;border-radius:8px;margin-bottom:16px;font-size:13px;">
+    <%= notice %>
+  </div>
+<% end %>
+
+<%= form_with url: settings_path, method: :patch, html: { style: 'max-width:640px' } do |f| %>
+  <div class="panel" style="margin-bottom:20px;">
+    <h2>ChatWork Notifications</h2>
+    <p style="font-size:12px;color:#6b7280;margin:0 0 16px;">
+      Send error alerts to a ChatWork room. Leave Token or Room ID blank to disable.
+    </p>
+
+    <div style="margin-bottom:14px;">
+      <label style="display:block;font-size:13px;font-weight:600;margin-bottom:4px;" for="chatwork_api_token">
+        API Token
+      </label>
+      <%= f.text_field 'settings[chatwork_api_token]',
+            value: @settings['chatwork_api_token'],
+            id: 'chatwork_api_token',
+            placeholder: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+            style: 'width:100%;padding:8px 10px;border:1px solid #d1d5db;border-radius:6px;font-size:13px;font-family:monospace;' %>
+    </div>
+
+    <div style="margin-bottom:14px;">
+      <label style="display:block;font-size:13px;font-weight:600;margin-bottom:4px;" for="chatwork_room_id">
+        Room ID
+      </label>
+      <%= f.text_field 'settings[chatwork_room_id]',
+            value: @settings['chatwork_room_id'],
+            id: 'chatwork_room_id',
+            placeholder: '123456789',
+            style: 'width:100%;padding:8px 10px;border:1px solid #d1d5db;border-radius:6px;font-size:13px;font-family:monospace;' %>
+    </div>
+
+    <div style="margin-bottom:20px;">
+      <label style="display:block;font-size:13px;font-weight:600;margin-bottom:4px;" for="chatwork_notify_sources">
+        Notify Sources <span style="font-weight:400;color:#6b7280;">(one per line — leave blank to notify all sources)</span>
+      </label>
+      <%= f.text_area 'settings[chatwork_notify_sources]',
+            value: @settings['chatwork_notify_sources'],
+            id: 'chatwork_notify_sources',
+            placeholder: "Token::ValidatorService\nPostScheduler::",
+            rows: 5,
+            style: 'width:100%;padding:8px 10px;border:1px solid #d1d5db;border-radius:6px;font-size:13px;font-family:monospace;resize:vertical;' %>
+      <p style="font-size:11px;color:#6b7280;margin:4px 0 0;">
+        Substring match. An error is sent to ChatWork only when its <strong>source</strong> contains one of these strings.
+      </p>
+    </div>
+
+    <div>
+      <%= f.submit 'Save settings',
+            style: 'background:#2563eb;color:#fff;border:none;padding:9px 20px;border-radius:6px;font-size:13px;cursor:pointer;font-weight:600;' %>
+    </div>
+  </div>
+<% end %>

data/app/views/layouts/error_radar/application.html.erb

@@ -57,6 +57,7 @@
         <a href="<%= root_path %>" class="nav-link <%= 'active' if controller_name == 'dashboard' %>">Dashboard</a>
         <a href="<%= errors_path %>" class="nav-link <%= 'active' if controller_name == 'errors' %>">All Errors</a>
         <a href="<%= guide_path %>" class="nav-link <%= 'active' if controller_name == 'guide' %>">Guide</a>
+        <a href="<%= settings_path %>" class="nav-link <%= 'active' if controller_name == 'settings' %>">Settings</a>
       </div>
     </nav>
     <div class="wrap"><%= yield %></div>

data/config/routes.rb

@@ -22,4 +22,7 @@ ErrorRadar::Engine.routes.draw do
   delete 'errors/:id',                       to: 'errors#destroy'
 
   post 'maintenance/purge', to: 'dashboard#purge', as: :maintenance_purge
+
+  get   'settings', to: 'settings#show',   as: :settings
+  patch 'settings', to: 'settings#update'
 end

data/lib/error_radar/configuration.rb

@@ -57,6 +57,16 @@ module ErrorRadar
     # One or more plain HTTPS URLs that receive a POST with JSON body on each alert.
     attr_accessor :webhook_urls
 
+    # ChatWork ────────────────────────────────────────────────────────────────
+    # API token from https://www.chatwork.com/service/packages/chatwork/subpackages/api/apply_token.php
+    attr_accessor :chatwork_api_token
+    # Room ID to post messages into (numeric string).
+    attr_accessor :chatwork_room_id
+    # Filter by source: array of strings/regexps. Only errors whose `source`
+    # matches at least one entry are sent to ChatWork. nil or [] = notify all.
+    # Example: ['Maintain::CheckSidekiqServ', /FetchInsights/]
+    attr_accessor :chatwork_notify_sources
+
     # App name shown in notification subject/title. Defaults to Rails app name.
     attr_accessor :app_name
     # Base URL used to build deep-links (e.g. "https://myapp.com").
@@ -165,6 +175,9 @@ module ErrorRadar
       @email_recipients     = []
       @email_from           = nil
       @webhook_urls         = []
+      @chatwork_api_token      = nil
+      @chatwork_room_id        = nil
+      @chatwork_notify_sources = []
       @app_name             = nil
       @app_host             = nil
       @error_callbacks      = []

data/lib/error_radar/notifications/chatwork.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+
+module ErrorRadar
+  module Notifications
+    module Chatwork
+      API_BASE = 'https://api.chatwork.com/v2'.freeze
+
+      def self.deliver(log, event = :recurring)
+        cfg             = ErrorRadar.config
+        token, room_id, = ErrorRadar::Notifier.chatwork_db_settings(cfg)
+        return if token.empty? || room_id.empty?
+
+        uri               = URI("#{API_BASE}/rooms/#{room_id}/messages")
+        http              = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl      = true
+        http.open_timeout = 5
+        http.read_timeout = 5
+
+        req                    = Net::HTTP::Post.new(uri)
+        req['X-ChatWorkToken'] = token
+        req['Content-Type']    = 'application/x-www-form-urlencoded'
+        req.body               = URI.encode_www_form(body: build_message(log, event))
+
+        http.request(req)
+      rescue StandardError => e
+        ErrorRadar::Tracking.warn_internal("ChatWork notification failed: #{e.message}")
+      end
+
+      def self.build_message(log, event)
+        app  = ErrorRadar::Notifier.app_name
+        link = ErrorRadar::Notifier.error_url(log)
+
+        title = case event
+                when :spike
+                  spike = log.instance_variable_get(:@spike_data)
+                  "Spike — #{spike[:count]} hits in #{spike[:window_minutes]} min: #{log.error_class}"
+                when :new_error
+                  "New error: #{log.error_class}"
+                else
+                  "#{log.severity.capitalize} error: #{log.error_class}"
+                end
+
+        body_lines = []
+        body_lines << "Source:      #{log.source || 'unknown'}"
+        body_lines << "Category:    #{log.category}"
+        body_lines << "Severity:    #{log.severity}"
+        body_lines << "Occurrences: #{log.occurrences}"
+        body_lines << "Message:     #{log.message.to_s.truncate(300)}"
+        body_lines << "URL:         #{link}" if link
+
+        "[info][title][#{app}] #{title}[/title]#{body_lines.join("\n")}[/info]"
+      end
+    end
+  end
+end

data/lib/error_radar/notifier.rb

@@ -82,6 +82,7 @@ module ErrorRadar
       send_slack(log, event)                     if cfg.slack_webhook_url.to_s.start_with?('http')
       send_discord(log, event)                   if cfg.discord_webhook_url.to_s.start_with?('http')
       send_email(log, event)                     if cfg.email_recipients.any?
+      send_chatwork(log, event)                  if chatwork_enabled?(cfg, log)
       cfg.webhook_urls.each { |url| send_webhook(log, url, event) }
       cfg.error_callbacks.each { |cb| safe_call(cb, log) }
     end
@@ -106,6 +107,42 @@ module ErrorRadar
       Notifications::Webhook.deliver(log, url: url, event: event)
     end
 
+    def self.send_chatwork(log, event)
+      require 'error_radar/notifications/chatwork'
+      Notifications::Chatwork.deliver(log, event)
+    end
+
+    def self.chatwork_enabled?(cfg, log)
+      token, room_id, sources = chatwork_db_settings(cfg)
+      return false if token.empty? || room_id.empty?
+
+      return true if sources.empty?
+
+      source = log.source.to_s
+      sources.any? { |filter| filter.is_a?(Regexp) ? filter.match?(source) : source.include?(filter.to_s) }
+    end
+
+    # Returns [token, room_id, sources_array] — DB settings take priority over config.
+    def self.chatwork_db_settings(cfg)
+      if defined?(ErrorRadar::Setting) && ErrorRadar::Setting.table_exists?
+        token   = ErrorRadar::Setting.get('chatwork_api_token').to_s
+        room_id = ErrorRadar::Setting.get('chatwork_room_id').to_s
+        sources = Array(ErrorRadar::Setting.get('chatwork_notify_sources')).compact
+        # Fall back to config when DB row is empty
+        token   = cfg.chatwork_api_token.to_s   if token.empty?
+        room_id = cfg.chatwork_room_id.to_s     if room_id.empty?
+        sources = Array(cfg.chatwork_notify_sources).compact if sources.empty?
+      else
+        token   = cfg.chatwork_api_token.to_s
+        room_id = cfg.chatwork_room_id.to_s
+        sources = Array(cfg.chatwork_notify_sources).compact
+      end
+      [token, room_id, sources]
+    rescue StandardError
+      [cfg.chatwork_api_token.to_s, cfg.chatwork_room_id.to_s,
+       Array(cfg.chatwork_notify_sources).compact]
+    end
+
     def self.safe_call(cb, log)
       cb.call(log)
     rescue StandardError => e

data/lib/error_radar/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ErrorRadar
-  VERSION = '1.0.6'
+  VERSION = '1.0.7'
 end

data/lib/generators/error_radar/upgrade_v107/templates/create_error_radar_settings.rb.tt

@@ -0,0 +1,10 @@
+class CreateErrorRadarSettings < ActiveRecord::Migration[7.0]
+  def change
+    create_table :error_radar_settings do |t|
+      t.string :key,   null: false
+      t.text   :value
+      t.timestamps
+    end
+    add_index :error_radar_settings, :key, unique: true
+  end
+end

data/lib/generators/error_radar/upgrade_v107/upgrade_v107_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record'
+
+module ErrorRadar
+  module Generators
+    class UpgradeV107Generator < ActiveRecord::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      argument :name, type: :string, default: 'upgrade_v107'
+
+      desc 'Creates the error_radar_settings table for UI-configurable notification settings (v1.0.7).'
+
+      def create_migration
+        migration_template 'create_error_radar_settings.rb.tt',
+                           'db/migrate/create_error_radar_settings.rb'
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: error_radar
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - chienbn9x
@@ -64,6 +64,7 @@ files:
 - app/controllers/error_radar/dashboard_controller.rb
 - app/controllers/error_radar/errors_controller.rb
 - app/controllers/error_radar/guide_controller.rb
+- app/controllers/error_radar/settings_controller.rb
 - app/mailers/error_radar/digest_mailer.rb
 - app/mailers/error_radar/error_mailer.rb
 - app/models/error_radar/application_record.rb
@@ -71,6 +72,7 @@ files:
 - app/models/error_radar/error_comment.rb
 - app/models/error_radar/error_log.rb
 - app/models/error_radar/error_occurrence.rb
+- app/models/error_radar/setting.rb
 - app/views/error_radar/dashboard/index.html.erb
 - app/views/error_radar/dashboard/show.html.erb
 - app/views/error_radar/digest_mailer/digest.html.erb
@@ -80,6 +82,7 @@ files:
 - app/views/error_radar/errors/index.html.erb
 - app/views/error_radar/errors/show.html.erb
 - app/views/error_radar/guide/index.html.erb
+- app/views/error_radar/settings/show.html.erb
 - app/views/layouts/error_radar/application.html.erb
 - config/routes.rb
 - lib/error_radar.rb
@@ -94,6 +97,7 @@ files:
 - lib/error_radar/integrations/rake.rb
 - lib/error_radar/integrations/sidekiq.rb
 - lib/error_radar/middleware.rb
+- lib/error_radar/notifications/chatwork.rb
 - lib/error_radar/notifications/discord.rb
 - lib/error_radar/notifications/email.rb
 - lib/error_radar/notifications/slack.rb
@@ -112,6 +116,8 @@ files:
 - lib/generators/error_radar/upgrade_v060/upgrade_v060_generator.rb
 - lib/generators/error_radar/upgrade_v100/templates/upgrade_to_v100.rb.tt
 - lib/generators/error_radar/upgrade_v100/upgrade_v100_generator.rb
+- lib/generators/error_radar/upgrade_v107/templates/create_error_radar_settings.rb.tt
+- lib/generators/error_radar/upgrade_v107/upgrade_v107_generator.rb
 - lib/tasks/error_radar.rake
 homepage: https://github.com/chienbn9x/error_radar
 licenses: