rails_error_notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e043018bdbcd628ab70a6da7152c49045be430fbdbe84b3abbb24cb9731f31ec
+  data.tar.gz: '021292217b6100ea47d1660e21c2f19e19b703fea4b2d4b8662241ce2cdb6e7c'
+SHA512:
+  metadata.gz: 4aaa456e26009a3ce7dbfc8afd7c7ef5d18f576385707d2c825841e2f4efa9872aef813ff77cbaeb54e3e9514c8aae603dbe6b622aeb8077b3bdbb7435d47e85
+  data.tar.gz: 977f95bc1c6ed0db06a1567d458c08c41f34eeabae9e6ff773b0d90adf4774505c3df8f98c48c3ae90e94f9d5ea25e1da07f6555cc227dbc02e4fcbf48d6d080

data/.github/workflows/rubyonrails.yml

@@ -0,0 +1,26 @@
+name: Ruby CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@78c01b705fd9d5ad960d432d3a0cfa341d50e410 # v1.179.1
+        with:
+          ruby-version: 3.2.0
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run RSpec tests
+        run: bundle exec rspec

data/.ruby-version

@@ -0,0 +1 @@
+3.2.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 mrmalvi
+
+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,160 @@
+# 🚨 RailsErrorNotifier
+
+RailsErrorNotifier is a Ruby gem that automatically captures and notifies about errors in your Rails applications.
+It integrates with **Slack** and **Discord** out of the box, so you never miss a critical error in production.
+
+---
+
+## ✨ Features
+- 🔥 Capture unhandled exceptions in Rails automatically via Rack middleware.
+- 📩 Send error notifications to **Slack** and **Discord**.
+- ⚙️ Easy configuration through Rails initializers.
+- 📝 Add custom context (e.g., current user, request path).
+- 🛡️ Safe when disabled (no crashes if webhooks are missing).
+
+---
+
+## 📦 Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'rails_error_notifier', git: 'https://github.com/mrmalvi/rails_error_notifier.git'
+```
+
+Then execute:
+
+```bash
+bundle install
+```
+
+Or install it manually:
+
+```bash
+gem install rails_error_notifier
+```
+
+---
+
+## ⚙️ Configuration
+
+Generate an initializer in your Rails app:
+
+```bash
+bin/rails generate rails_error_notifier:install
+```
+
+This creates `config/initializers/rails_error_notifier.rb`:
+
+```ruby
+# frozen_string_literal: true
+
+RailsErrorNotifier.configure do |config|
+  # Configure your Slack and Discord webhooks via ENV variables
+  config.slack_webhook   = ENV["SLACK_WEBHOOK_URL"]
+  config.discord_webhook = ENV["DISCORD_WEBHOOK_URL"]
+
+  # Optional: disable in development/test
+  config.enabled = !Rails.env.development? && !Rails.env.test?
+end
+```
+
+---
+
+## 🚀 Usage
+
+### Automatic Error Notifications
+Once installed, `RailsErrorNotifier` automatically hooks into Rails middleware.
+Whenever an exception occurs, a notification is sent to your configured services.
+
+### Manual Notifications
+```ruby
+begin
+  risky_operation
+rescue => e
+  RailsErrorNotifier.notify(e, context: { user_id: current_user.id, path: request.path })
+end
+```
+
+---
+
+## 🔔 Example Notifications
+
+### Slack
+```
+🚨 Rails Error Notifier
+Message: undefined method `foo' for nil:NilClass
+Context: {:user_id=>42, :path=>"/dashboard"}
+Backtrace:
+app/controllers/dashboard_controller.rb:12:in `index'
+```
+
+### Discord
+```
+⚡ Rails Error Notifier
+Error: PG::ConnectionBad
+Message: could not connect to server: Connection refused
+Context: {:host=>"db.example.com", :env=>"production"}
+```
+
+---
+
+## 🧪 Testing & Development
+
+Clone the repository and install dependencies:
+
+```bash
+git clone https://github.com/mrmalvi/rails_error_notifier.git
+cd rails_error_notifier
+bundle install
+```
+
+Run the test suite:
+
+```bash
+bundle exec rspec
+```
+
+Start an interactive console to experiment:
+
+```bash
+bin/console
+```
+
+Build and install the gem locally:
+
+```bash
+bundle exec rake install
+```
+
+Release a new version (update `version.rb` first):
+
+```bash
+bundle exec rake release
+```
+
+This will:
+- Create a Git tag for the version
+- Push commits and tags
+- Publish the `.gem` file to [rubygems.org](https://rubygems.org)
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome!
+
+1. Fork the repo
+2. Create a new branch (`git checkout -b my-feature`)
+3. Commit your changes (`git commit -am 'Add feature'`)
+4. Push to the branch (`git push origin my-feature`)
+5. Open a Pull Request
+
+Bug reports and pull requests are welcome on GitHub:
+👉 [https://github.com/mrmalvi/rails_error_notifier](https://github.com/mrmalvi/rails_error_notifier)
+
+---
+
+## 📜 License
+
+This gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/generators/rails_error_notifier/install_generator.rb

@@ -0,0 +1,16 @@
+# lib/generators/rails_error_notifier/install_generator.rb
+require "rails/generators"
+
+module RailsErrorNotifier
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Creates a RailsErrorNotifier initializer in config/initializers"
+
+      def copy_initializer
+        template "rails_error_notifier.rb", "config/initializers/rails_error_notifier.rb"
+      end
+    end
+  end
+end

data/lib/generators/rails_error_notifier/templates/rails_error_notifier.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# This is the initializer for RailsErrorNotifier
+RailsErrorNotifier.configure do |config|
+  # Configure your Slack and Discord webhooks via ENV variables
+  config.slack_webhook   = ENV["SLACK_WEBHOOK_URL"]
+  config.discord_webhook = ENV["DISCORD_WEBHOOK_URL"]
+
+  # Optional: disable in development/test
+  config.enabled = !Rails.env.development? && !Rails.env.test?
+end

data/lib/rails_error_notifier/configuration.rb

@@ -0,0 +1,9 @@
+module RailsErrorNotifier
+  class Configuration
+    attr_accessor :slack_webhook, :discord_webhook, :enabled
+
+    def initialize
+      @enabled = true
+    end
+  end
+end

data/lib/rails_error_notifier/middleware.rb

@@ -0,0 +1,14 @@
+module RailsErrorNotifier
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @app.call(env)
+    rescue => e
+      RailsErrorNotifier.notify(e, context: { rack_env: env["PATH_INFO"] })
+      raise
+    end
+  end
+end

data/lib/rails_error_notifier/notifier.rb

@@ -0,0 +1,35 @@
+require "net/http"
+require "json"
+
+module RailsErrorNotifier
+  class Notifier
+    attr_reader :exception, :context
+
+    def initialize(exception, context = {})
+      @exception = exception
+      @context   = context
+    end
+
+    def deliver
+      return unless RailsErrorNotifier.configuration&.enabled
+
+      payload = {
+        error: exception.message,
+        backtrace: exception.backtrace,
+        context: context
+      }
+
+      send_to_webhook(RailsErrorNotifier.configuration.slack_webhook, payload)
+      send_to_webhook(RailsErrorNotifier.configuration.discord_webhook, payload)
+    end
+
+    private
+
+    def send_to_webhook(url, payload)
+      return unless url
+
+      uri = URI(url)
+      Net::HTTP.post(uri, payload.to_json, "Content-Type" => "application/json")
+    end
+  end
+end

data/lib/rails_error_notifier/railtie.rb

@@ -0,0 +1,9 @@
+require "rails"
+
+module RailsErrorNotifier
+  class Railtie < Rails::Railtie
+    initializer "rails_error_notifier.configure_middleware" do |app|
+      app.middleware.use RailsErrorNotifier::Middleware
+    end
+  end
+end

data/lib/rails_error_notifier/version.rb

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

data/lib/rails_error_notifier.rb

@@ -0,0 +1,19 @@
+require "rails_error_notifier/configuration"
+require "rails_error_notifier/notifier"
+require "rails_error_notifier/middleware"
+require "rails_error_notifier/railtie" if defined?(Rails::Railtie)
+
+module RailsErrorNotifier
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+  end
+
+  def self.notify(exception, context: {})
+    Notifier.new(exception, context).deliver
+  end
+end

data/sig/rails_error_notifier.rbs

@@ -0,0 +1,4 @@
+module RailsErrorNotifier
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "rails_error_notifier"
+
+require "minitest/autorun"

data/test/test_rails_error_notifier.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class TestRailsErrorNotifier < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::RailsErrorNotifier::VERSION
+  end
+
+  def test_it_does_something_useful
+    assert false
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: rails_error_notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mrmalvi
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A gem to send Rails exceptions to Slack and Discord
+email:
+- malviyak00@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rubyonrails.yml"
+- ".ruby-version"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/rails_error_notifier/install_generator.rb
+- lib/generators/rails_error_notifier/templates/rails_error_notifier.rb
+- lib/rails_error_notifier.rb
+- lib/rails_error_notifier/configuration.rb
+- lib/rails_error_notifier/middleware.rb
+- lib/rails_error_notifier/notifier.rb
+- lib/rails_error_notifier/railtie.rb
+- lib/rails_error_notifier/version.rb
+- sig/rails_error_notifier.rbs
+- test/test_helper.rb
+- test/test_rails_error_notifier.rb
+homepage: https://github.com/mrmalvi/rails_error_notifier
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mrmalvi/rails_error_notifier
+  source_code_uri: https://github.com/mrmalvi/rails_error_notifier
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Notify Rails errors to Slack and Discord
+test_files: []