email_error_reporter 0.1.0.pre → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b5bd625697e275051c8d51cee4ccbbe14faf8aa2cf2a09c18c225292d7dbf52
-  data.tar.gz: 762d0ec2963ea8fe672a35732699a02c0d9da507b10e5cd100b2d5ea48650f04
+  metadata.gz: 8e8f1858125082a54222230c31cc9f86977225bb52e4d58250415c6b0cb7c47d
+  data.tar.gz: 2c6a173d38e6d7b58cfea1291dfd5aa2dce6dd5b31e5907fe72772c96055ab8f
 SHA512:
-  metadata.gz: '0824b30d48460da923cadca8d6cb3ef9a2f3ec60f1ce1bba25a45cedc7c610331c477ea022a1929fc80091e4edf7bb3d5d0f02460b91488c7f0dfcac17166467'
-  data.tar.gz: 5dd1577971dbcd095b4a3a4658433c98cd850a07c2521dae1bf0e9d513da36370ddc9ab6866f0c1fc14c4be7b81da03b3d596a795866eaefa314fe77dee03f58
+  metadata.gz: 928f4ed5561244626c6968949f531931ac2d24daa8d85912346d6c80ea4b06789a678af0f03767c4170fe8d0021392a09ab60dafa1a5d4a50827e41893460376
+  data.tar.gz: e4c5f4044e603434cd92504f37c386af900cbb1351abc6b7270a34268aed6d4a2d73a05b138f583b37ff9229583bd6d2c899c0fa8bf8321a989b833eadee5c74

data/README.md

@@ -1,43 +1,28 @@
 # EmailErrorReporter
+Short description and motivation.
 
-> [!CAUTION]
-> This is a very early prototype
-
-`email_error_reporter` uses the new [Rails error reporting API](https://guides.rubyonrails.org/error_reporting.html#error-reporting) to send emails whenever an exception is being reported. It works out of the box with HTTP requests, jobs and the rails runner.
+## Usage
+How to use my plugin.
 
 ## Installation
+Add this line to your application's Gemfile:
 
-Add the gem:
+```ruby
+gem "email_error_reporter"
+```
 
+And then execute:
 ```bash
-bundle add email_error_reporter && bundle install
+$ bundle
 ```
 
-and configure the email addresses that should receive an email in the case of an exception:
-
-```ruby
-# application.rb
-config.email_error_reporter.to = ["youremail@example.com"]
+Or install it yourself as:
+```bash
+$ gem install email_error_reporter
 ```
 
-`email_error_reporter` will reuse your environment specific ActionMailer configuration for delivering emails.
-
-## Usage
-
-All exceptions are reported automatically. No additional code required.
-
-Please consult the [official guides](https://guides.rubyonrails.org/error_reporting.html) for an introduction to the error reporting API.
-
-## Test your setup
-
-You can use the built-in rake task `rake email_error_reporter:check` to check if everything works correctly in your setup.
-
-If you're using Kamal, you can run the following command to test the setup in production:
-
-```
-kamal app exec -p 'bundle exec rake email_error_reporter:test_email'
-```
+## Contributing
+Contribution directions go here.
 
 ## License
-
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/email_error_reporter/railtie.rb

@@ -0,0 +1,4 @@
+module EmailErrorReporter
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/email_error_reporter/version.rb

@@ -1,3 +1,3 @@
 module EmailErrorReporter
-  VERSION = "0.1.0.pre"
+  VERSION = "0.1.0"
 end

data/lib/email_error_reporter.rb

@@ -1,10 +1,6 @@
 require "email_error_reporter/version"
-require "email_error_reporter/engine"
+require "email_error_reporter/railtie"
 
 module EmailErrorReporter
-  extend ActiveSupport::Autoload
-
-  autoload :ErrorMailer
-  autoload :Subscriber
-  autoload :ExceptionSerializer
+  # Your code goes here...
 end

data/lib/tasks/email_error_reporter_tasks.rake

@@ -1,12 +1,4 @@
-desc "Report a test exception"
-namespace :email_error_reporter do
-  task check: :environment do
-    Rails.error.handle { raise "This is a test!" }
-    $stdout.puts <<~TXT
-      Test exception triggered.
-
-      Recipients:
-      #{Rails.application.config.email_error_reporter.to.join("\n").gsub(/^/, "* ")}
-    TXT
-  end
-end
+# desc "Explaining what the task does"
+# task :email_error_reporter do
+#   # Task goes here
+# end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: email_error_reporter
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.1.0
 platform: ruby
 authors:
 - Niklas Haeusele
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-03 00:00:00.000000000 Z
+date: 2024-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -34,14 +34,8 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/views/email_error_reporter/error_mailer/_frame.html.erb
-- app/views/email_error_reporter/error_mailer/_no_backtrace.html.erb
-- app/views/email_error_reporter/error_mailer/error.html.erb
 - lib/email_error_reporter.rb
-- lib/email_error_reporter/engine.rb
-- lib/email_error_reporter/error_mailer.rb
-- lib/email_error_reporter/exception_serializer.rb
-- lib/email_error_reporter/subscriber.rb
+- lib/email_error_reporter/railtie.rb
 - lib/email_error_reporter/version.rb
 - lib/tasks/email_error_reporter_tasks.rake
 homepage: https://github.com/codergeek121/email_error_reporter

data/app/views/email_error_reporter/error_mailer/_frame.html.erb

@@ -1 +0,0 @@
-<li><%= frame %></li>

data/app/views/email_error_reporter/error_mailer/_no_backtrace.html.erb

@@ -1 +0,0 @@
-<p>No backtrace available</p>

data/app/views/email_error_reporter/error_mailer/error.html.erb

@@ -1,6 +0,0 @@
-<h1><%= @error.class %></h1>
-<p><%= @error.message %></p>
-
-<div>
-<%= render(partial: "frame", collection: @backtrace) || render("no_backtrace") -%>
-</div>

data/lib/email_error_reporter/engine.rb

@@ -1,17 +0,0 @@
-module EmailErrorReporter
-  class Engine < ::Rails::Engine
-    isolate_namespace EmailErrorReporter
-
-    config.email_error_reporter = ActiveSupport::OrderedOptions.new
-    config.email_error_reporter.to = []
-
-    initializer "email_error_reporter.error_subscribe" do
-      Rails.error.subscribe(Subscriber.new)
-    end
-
-    # ActiveJob cannot (de)-serialize exceptions by default
-    initializer "email_error_reporter.exception_serializer" do |app|
-      app.config.active_job.custom_serializers << ExceptionSerializer
-    end
-  end
-end

data/lib/email_error_reporter/error_mailer.rb

@@ -1,18 +0,0 @@
-module EmailErrorReporter
-  class ErrorMailer < ActionMailer::Base
-    def error(error, handled:, severity:, context:, source: nil)
-      @error = error
-      @handled = handled
-      @severity = severity
-      @context = context
-      @source = source
-
-      @backtrace = Array.wrap(error.backtrace)
-
-      mail(
-        subject: "#{error.class}",
-        to: Rails.application.config.email_error_reporter.to
-      )
-    end
-  end
-end

data/lib/email_error_reporter/exception_serializer.rb

@@ -1,23 +0,0 @@
-module EmailErrorReporter
-  class ExceptionSerializer < ActiveJob::Serializers::ObjectSerializer
-    def serialize(exception)
-      super(
-        exception_class: exception.class.to_s,
-        message: exception.message,
-        backtrace: exception.backtrace
-      )
-    end
-
-    def deserialize(hash)
-      hash[:exception_class].constantize.new(hash[:message]).tap do |e|
-        e.set_backtrace(hash[:backtrace])
-      end
-    end
-
-    private
-
-    def klass
-      Exception
-    end
-  end
-end

data/lib/email_error_reporter/subscriber.rb

@@ -1,11 +0,0 @@
-module EmailErrorReporter
-  class Subscriber
-    def report(error, handled:, severity:, context:, source: nil)
-      ErrorMailer.error(error, 
-        handled: handled,
-        context: context,
-        severity: severity,
-        source: source).deliver_later
-    end
-  end
-end