dlnk_error_notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2178d7bb0a7c5153f80e8d5dc8d442e00c5ab2d927afe686f043e1eff2014d74
+  data.tar.gz: 833f685e21a4f5c2c9fdf57d4603e95e9e1784f965e85fcc034da521f9dbedd1
+SHA512:
+  metadata.gz: 88502ec1c3810b695a3cd13e6fe1504e08893cc7f2743466d186d82ce967cfb4c7dbdbbadbaf1a75dae5d47959b516c8607a96f555816d5d4a38eec99f8e0443
+  data.tar.gz: cf01907227f3466529aeefe905394156e77f3f65a4affab8d4f36a2c8d58a4329337e71a54f29f4a42a8e7500e866b09fa2241201f34f6408c4ca67a782c2c45

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 dalink
+
+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,43 @@
+# ErrorNotifier
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/error_notifier`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/error_notifier. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/error_notifier/blob/main/CODE_OF_CONDUCT.md).
+
+## 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 ErrorNotifier project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/error_notifier/blob/main/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "error_notifier"
+
+# 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.
+
+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/error_notifier/jobs/http_post_job.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "active_job"
+require "httparty"
+
+module ErrorNotifier
+  # HttpPostJob is an ActiveJob that performs an HTTP POST request.
+  # This job is enqueued to run in the background, preventing the main thread
+  # from being blocked by the HTTP request.
+  #
+  # @example Enqueue the job
+  #   ErrorNotifier::HttpPostJob.perform_later('https://your-webhook-url.com', { key: 'value' }.to_json)
+  #
+  # @param url [String] the URL to which the POST request is sent
+  # @param body [String] the body of the POST request, typically in JSON format
+  class HttpPostJob < ActiveJob::Base
+    queue_as :default
+
+    def perform(url, body)
+      HTTParty.post(
+        url,
+        body: body,
+        headers: { "Content-Type" => "application/json" }
+      )
+    end
+  end
+end

data/lib/error_notifier/middleware.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "rack/request"
+require "error_notifier/jobs/http_post_job"
+
+module ErrorNotifier
+  # Middleware to catch exceptions and send them to a webhook
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @app.call(env)
+    rescue Exception => e
+      notify_error(env, e)
+      raise e
+    end
+
+    private
+
+    def notify_error(env, exception)
+      request = Rack::Request.new(env)
+      error_details = {
+        webhook_event: {
+          # name: "error",
+          error: exception.message,
+          application_trace: application_trace(exception),
+          method: env["REQUEST_METHOD"],
+          path: env["PATH_INFO"],
+          params: request.params
+          # headers: env.select { |k, _| k.start_with?("HTTP_") }
+        }
+      }
+
+      send_webhook(error_details)
+    end
+
+    def send_webhook(error_details)
+      ErrorNotifier::HttpPostJob.perform_later(
+        ENV["WEBHOOK_URL"] || "http://localhost:3000/webhook",
+        error_details.to_json
+      )
+    end
+
+    def application_trace(exception)
+      exception.backtrace.select { |line| line.include?(Rails.root.to_s) }
+    end
+  end
+end

data/lib/error_notifier/version.rb

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

data/lib/error_notifier.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "error_notifier/version"
+require_relative "error_notifier/middleware"
+require "error_notifier/jobs/http_post_job"
+
+module ErrorNotifier
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: dlnk_error_notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dalink
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+description: Send a mail (coming soon) or a webhook when an error occurs in your Rails
+  application.
+email:
+- cyril@dalink.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/setup
+- lib/error_notifier.rb
+- lib/error_notifier/jobs/http_post_job.rb
+- lib/error_notifier/middleware.rb
+- lib/error_notifier/version.rb
+homepage: https://github.com/dalink/error_notifier
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/dalink/error_notifier
+  source_code_uri: https://github.com/dalink/error_notifier
+  changelog_uri: https://github.com/dalink/error_notifier/changelog.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: Simple error notifier for Rails applications.
+test_files: []