exceptify 1.0.0

data/Rakefile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+require "irb"
+require "exceptify"
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+task default: [:test]
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.warning = false
+end
+
+desc "Start a console with the gem"
+task :console do
+  ARGV.clear
+  puts "Exceptify #{Exceptify::VERSION} loaded."
+  IRB.start
+end

data/docs/notifiers/custom.md

@@ -0,0 +1,42 @@
+### Custom notifier
+
+Simply put, notifiers are objects which respond to `#call(exception, options)` method. Thus, a lambda can be used as a notifier as follow:
+
+```ruby
+Exceptify.add_notifier :custom_notifier_name,
+  ->(exception, options) { puts "Something goes wrong: #{exception.message}"}
+```
+
+More advanced users or third-party framework developers, also can create notifiers to be shipped in gems and take advantage of Exceptify's notifier API to standardize the [various](https://github.com/airbrake/airbrake) [solutions](https://www.honeybadger.io) [out](http://www.exceptional.io) [there](https://bugsnag.com). For this, beyond the `#call(exception, options)` method, the notifier class MUST BE defined under the Exceptify namespace and its name sufixed by `Notifier`, e.g: Exceptify::SimpleNotifier.
+
+#### Example
+
+Define the custom notifier:
+
+```ruby
+module Exceptify
+  class SimpleNotifier
+    def initialize(options)
+      # do something with the options...
+    end
+
+    def call(exception, options={})
+      # send the notification
+    end
+  end
+end
+```
+
+Using it:
+
+```ruby
+Rails.application.config.middleware.use Exceptify::Rack,
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com}
+                                        },
+                                        simple: {
+                                          # simple notifier options
+                                        }
+```

data/docs/notifiers/datadog.md

@@ -0,0 +1,51 @@
+### Datadog notifier
+
+This notifier sends error events to Datadog using the [Dogapi](https://github.com/DataDog/dogapi-rb) gem.
+
+#### Usage
+
+Just add the [Dogapi](https://github.com/DataDog/dogapi-rb) gem to your `Gemfile`:
+
+```ruby
+gem 'dogapi'
+```
+
+To use datadog notifier, you first need to create a `Dogapi::Client` with your datadog api and application keys, like this:
+
+```ruby
+client = Dogapi::Client.new(api_key, application_key)
+```
+
+You then need to set the `client` option, like this:
+
+```ruby
+Rails.application.config.middleware.use Exceptify::Rack,
+  email: {
+    email_prefix: "[PREFIX] ",
+    sender_address: %{"notifier" <notifier@example.com>},
+    exception_recipients: %w{exceptions@example.com}
+  },
+  datadog: {
+    client: client
+  }
+```
+
+#### Options
+
+##### client
+
+*DogApi::Client, required*
+
+The API client to send events to Datadog.
+
+##### title_prefix
+
+*String, optional*
+
+Prefix for event title in Datadog.
+
+##### tags
+
+*Array of Strings, optional*
+
+Optional tags for events in Datadog.

data/docs/notifiers/email.md

@@ -0,0 +1,195 @@
+### Email notifier
+
+The Email notifier sends notifications by email. The notifications/emails sent includes information about the current request, session, and environment, and also gives a backtrace of the exception.
+
+After an exception notification has been delivered the rack environment variable `exceptify.delivered` will be set to true.
+
+#### ActionMailer configuration
+
+For the email to be sent, there must be a default ActionMailer `delivery_method` setting configured. If you do not have one, you can use the following code (assuming your app server machine has `sendmail`). Depending on the environment you want Exceptify to run in, put the following code in your `config/environments/production.rb` and/or `config/environments/development.rb`:
+
+```ruby
+config.action_mailer.delivery_method = :sendmail
+# Defaults to:
+# config.action_mailer.sendmail_settings = {
+#   location: '/usr/sbin/sendmail',
+#   arguments: '-i -t'
+# }
+config.action_mailer.perform_deliveries = true
+config.action_mailer.raise_delivery_errors = true
+```
+
+#### Options
+
+##### sender_address
+
+*String, default: %("Exceptify" <notifier@example.com>)*
+
+Who the message is from.
+
+##### exception_recipients
+
+*String/Array of strings/Proc, default: []*
+
+Who the message is destined for, can be a string of addresses, an array of addresses, or it can be a proc that returns a string of addresses or an array of addresses. The proc will be evaluated when the mail is sent.
+
+##### email_prefix
+
+*String, default: [ERROR]*
+
+The subject's prefix of the message.
+
+##### sections
+
+*Array of strings, default: %w(request session environment backtrace)*
+
+By default, the notification email includes four parts: request, session, environment, and backtrace (in that order). You can customize how each of those sections are rendered by placing a partial named for that part in your `app/views/exceptify` directory (e.g., `_session.rhtml`). Each partial has access to the following variables:
+
+```ruby
+@kontroller     # the controller that caused the error
+@request        # the current request object
+@exception      # the exception that was raised
+@backtrace      # a sanitized version of the exception's backtrace
+@data           # a hash of optional data values that were passed to the notifier
+@sections       # the array of sections to include in the email
+```
+
+You can reorder the sections, or exclude sections completely, by using `sections` option. You can even add new sections that
+describe application-specific data--just add the section's name to the list (wherever you'd like), and define the corresponding partial. Like the following example with two new added sections:
+
+```ruby
+Rails.application.config.middleware.use Exceptify::Rack,
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com},
+                                          sections: %w{my_section1 my_section2}
+                                        }
+```
+
+Place your custom sections under `./app/views/exceptify/` with the suffix `.text.erb`, e.g. `./app/views/exceptify/_my_section1.text.erb`.
+
+If your new section requires information that isn't available by default, make sure it is made available to the email using the `exception_data` macro:
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :log_additional_data
+  ...
+  protected
+
+  def log_additional_data
+    request.env['exceptify.exception_data'] = {
+      document: @document,
+      person: @person
+    }
+  end
+  ...
+end
+```
+
+In the above case, `@document` and `@person` would be made available to the email renderer, allowing your new section(s) to access and display them. See the existing sections defined by the plugin for examples of how to write your own.
+
+##### background_sections
+
+*Array of strings, default: %w(backtrace data)*
+
+When using [background notifications](#background-notifications) some variables are not available in the views, like `@kontroller` and `@request`. Thus, you may want to include different sections for background notifications:
+
+```ruby
+Rails.application.config.middleware.use Exceptify::Rack,
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com},
+                                          background_sections: %w{my_section1 my_section2 backtrace data}
+                                        }
+```
+
+##### email_headers
+
+*Hash of strings, default: {}*
+
+Additionally, you may want to set customized headers on the outcoming emails. To do so, simply use the `:email_headers` option:
+
+```ruby
+Rails.application.config.middleware.use Exceptify::Rack,
+                                        email: {
+                                          email_prefix: "[PREFIX] ",
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com},
+                                          email_headers: { "X-Custom-Header" => "foobar" }
+                                        }
+```
+
+##### verbose_subject
+
+*Boolean, default: true*
+
+If enabled, include the exception message in the subject. Use `verbose_subject: false` to exclude it.
+
+##### normalize_subject
+
+*Boolean, default: false*
+
+If enabled, remove numbers from subject so they thread as a single one. Use `normalize_subject: true` to enable it.
+
+##### include_controller_and_action_names_in_subject
+
+*Boolean, default: true*
+
+If enabled, include the controller and action names in the subject. Use `include_controller_and_action_names_in_subject: false` to exclude them.
+
+##### email_format
+
+*Symbol, default: :text*
+
+By default, Exceptify sends emails in plain text. To send multipart notifications (aka HTML emails), use `email_format: :html`.
+
+##### delivery_method
+
+*Symbol, default: :smtp*
+
+By default, Exceptify sends emails using the ActionMailer configuration of the application. In order to send emails by another delivery method, use the `delivery_method` option:
+
+```ruby
+Rails.application.config.middleware.use Exceptify::Rack,
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com},
+                                          delivery_method: :postmark,
+                                          postmark_settings: {
+                                            api_key: ENV['POSTMARK_API_KEY']
+                                          }
+                                        }
+```
+
+Besides the `delivery_method` option, you also can customize the mailer settings by passing a hash under an option named `DELIVERY_METHOD_settings`. Thus, you can use override specific SMTP settings for notifications using:
+
+```ruby
+Rails.application.config.middleware.use Exceptify::Rack,
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com},
+                                          delivery_method: :smtp,
+                                          smtp_settings: {
+                                            user_name: 'bob',
+                                            password: 'password',
+                                          }
+                                        }
+```
+
+A complete list of `smtp_settings` options can be found in the [ActionMailer Configuration documentation](http://api.rubyonrails.org/classes/ActionMailer/Base.html#class-ActionMailer::Base-label-Configuration+options).
+
+##### mailer_parent
+
+*String, default: ActionMailer::Base*
+
+The parent mailer which the Exceptify mailer inherits from.
+
+##### deliver_with
+
+*Symbol, default: :deliver_now
+
+The method name to send emalis using ActionMailer.

data/docs/notifiers/slack.md

@@ -0,0 +1,154 @@
+### Slack notifier
+
+This notifier sends notifications to a slack channel using the slack-notifier gem.
+
+#### Usage
+
+Just add the [slack-notifier](https://github.com/stevenosloan/slack-notifier) gem to your `Gemfile`:
+
+```ruby
+gem 'slack-notifier'
+```
+
+To configure it, you need to set at least the 'webhook_url' option, like this:
+
+```ruby
+Rails.application.config.middleware.use Exceptify::Rack,
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com}
+                                        },
+                                        slack: {
+                                          webhook_url: '[Your webhook url]',
+                                          additional_parameters: {
+                                            icon_url: 'http://image.jpg',
+                                            mrkdwn: true
+                                          }
+                                        }
+```
+
+The slack notification will include any data saved under `env['exceptify.exception_data']`.
+
+An example of how to send the server name to Slack in Rails (put this code in application_controller.rb):
+
+```ruby
+before_action :set_notification
+
+def set_notification
+  request.env['exceptify.exception_data'] = { 'server' => request.env['SERVER_NAME'] }
+  # can be any key-value pairs
+end
+```
+
+If you find this too verbose, you can determine to exclude certain information by doing the following:
+
+```ruby
+Rails.application.config.middleware.use Exceptify::Rack,
+                                        slack: {
+                                          webhook_url: '[Your webhook url]',
+                                          channel: '#exceptions',
+                                          additional_parameters: {
+                                            icon_url: 'http://image.jpg',
+                                            mrkdwn: true
+                                          },
+                                          ignore_data_if: lambda {|key, value|
+                                            "#{key}" == 'key_to_ignore' || value.is_a?(ClassToBeIgnored)
+                                          }
+                                        }
+```
+
+Any evaluation to `true` will cause the key / value pair not be be sent along to Slack.
+
+
+the `slack-notifier` gem allows to override the channel default value, if you ever
+need to send a notification to a different slack channel. Simply add the
+`channel` option when calling `.notify_exception`
+
+```ruby
+Exceptify.notify_exception(
+  exception,
+  env: request.env,
+  channel: '#my-custom-channel', # Make sure the channel name starts with `#`
+  data: {
+    error: error_variable,
+    server: server_name
+  }
+)
+```
+
+If you ever need to add more `slack-notifier` specific options, and
+particularly to the `#ping` method of the slack notifier, you can use
+the `pre_callback` option when defining the middleware.
+```ruby
+ pre_callback: proc { |opts, _notifier, _backtrace, _message, message_opts|
+   message_opts[:channel] = opts[:channel] if opts.key?(:channel)
+ }
+
+```
+- `message_opts` is the hash you want to append to if you need to add an option.
+- `options` is the hash containing the values when you call
+  `Exceptify.notify_exception`
+
+An example implementation would be:
+```ruby
+config.middleware.use Exceptify::Rack,
+  slack: {
+    webhook_url: '[Your webhook url]',
+    pre_callback: proc { |opts, _notifier, _backtrace, _message, message_opts|
+      message_opts[:ping_option] = opts[:ping_option] if
+      opts.key?(:ping_option)
+    }
+  },
+  error_grouping: true
+```
+Then when calling from within your application code:
+```ruby
+Exceptify.notify_exception(
+  exception,
+  env: request.env,
+  ping_option: 'value',
+  # this will be passed to the slack notifier's `#ping`
+  # method, as a parameter. The `:pre_callback` hook will catch it
+  # and do that for you.
+  # Helpful, if the API evolves, you only need to update
+  # the `slack-notifier` gem
+  data: {
+    error: error_variable,
+    server: server_name
+  }
+)
+
+```
+#### Options
+
+##### webhook_url
+
+*String, required*
+
+The Incoming WebHook URL on slack.
+
+##### username
+
+*String, optional*
+
+Username of the bot. Defaults to the name you set as such on slack
+
+##### custom_hook
+
+*String, optional*
+
+Custom hook name. See [slack-notifier](https://github.com/stevenosloan/slack-notifier#custom-hook-name) for
+more information. Default: 'incoming-webhook'
+
+##### additional_parameters
+
+*Hash of strings, optional*
+
+Contains additional payload for a message (e.g avatar, attachments, etc). See [slack-notifier](https://github.com/stevenosloan/slack-notifier#additional-parameters) for more information.. Default: '{}'
+
+##### additional_fields
+
+*Array of Hashes, optional*
+
+Contains additional fields that will be added to the attachement. See [Slack documentation](https://api.slack.com/docs/message-attachments).

data/docs/notifiers/sns.md

@@ -0,0 +1,37 @@
+### Amazon SNS Notifier
+
+Notify all exceptions Amazon - Simple Notification Service: [SNS](https://aws.amazon.com/sns/).
+
+#### Usage
+
+Add the [aws-sdk-sns](https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-sns) gem to your `Gemfile`:
+
+```ruby
+  gem 'aws-sdk-sns', '~> 1.5'
+```
+
+To configure it, you **need** to set 3 required options for aws: `region`, `access_key_id` and `secret_access_key`, and one more option for sns: `topic_arn`.
+
+```ruby
+Rails.application.config.middleware.use Exceptify::Rack,
+                                        sns: {
+                                          region: 'us-east-x',
+                                          access_key_id: 'access_key_id',
+                                          secret_access_key: 'secret_access_key',
+                                          topic_arn: 'arn:aws:sns:us-east-x:XXXX:my-topic'
+                                        }
+```
+
+##### sns_prefix
+*String, optional *
+
+Prefix in the notification subject, by default: "[Error]"
+
+##### backtrace_lines
+*Integer, optional *
+
+Number of backtrace lines to be displayed in the notification message. By default: 10
+
+#### Note:
+* You may need to update your previous `aws-sdk-*` gems in order to setup `aws-sdk-sns` correctly.
+* If you need any further information about the available regions or any other SNS related topic consider: [SNS faqs](https://aws.amazon.com/sns/faqs/)

data/docs/notifiers/teams.md

@@ -0,0 +1,54 @@
+### Teams notifier
+
+Post notification in a Microsoft Teams channel via [Incoming Webhook Connector](https://docs.microsoft.com/en-us/outlook/actionable-messages/actionable-messages-via-connectors)
+Just add the [HTTParty](https://github.com/jnunemaker/httparty) gem to your `Gemfile`:
+
+```ruby
+gem 'httparty'
+```
+
+To configure it, you **need** to set the `webhook_url` option.
+If you are using GitLab for issue tracking, you can specify `git_url` as follows to add a *Create issue* button in your notification.
+By default this will use your Rails application name to match the git repository. If yours differs, you can specify `app_name`.
+By that same notion, you may also set a `jira_url` to get a button that will send you to the New Issue screen in Jira.
+
+```ruby
+Rails.application.config.middleware.use Exceptify::Rack,
+  email: {
+    email_prefix: "[PREFIX] ",
+    sender_address: %{"notifier" <notifier@example.com>},
+    exception_recipients: %w{exceptions@example.com}
+  },
+  teams: {
+    webhook_url: 'https://outlook.office.com/webhook/your-guid/IncomingWebhook/team-guid',
+    git_url: 'https://your-gitlab.com/Group/Project',
+    jira_url: 'https://your-jira.com'
+  }
+```
+
+#### Options
+
+##### webhook_url
+
+*String, required*
+
+The Incoming WebHook URL on Teams.
+
+##### git_url
+
+*String, optional*
+
+Url of your gitlab or github with your organisation name for issue creation link (Eg: `github.com/aschen`). Defaults to nil and doesn't add link to the notification.
+
+##### jira_url
+
+*String, optional*
+
+Url of your Jira instance, adds button for Create Issue screen. Defaults to nil and doesn't add a button to the card.
+
+##### app_name
+
+*String, optional*
+
+Your application name used for git issue creation link. Defaults to `Rails.application.class.module_parent_name.underscore` for Rails versions >= 6;
+`Rails.application.class.parent_name.underscore` otherwise.

data/docs/notifiers/webhook.md

@@ -0,0 +1,60 @@
+### WebHook notifier
+
+This notifier ships notifications over the HTTP protocol.
+
+#### Usage
+
+Just add the [HTTParty](https://github.com/jnunemaker/httparty) gem to your `Gemfile`:
+
+```ruby
+gem 'httparty'
+```
+
+To configure it, you need to set the `url` option, like this:
+
+```ruby
+Rails.application.config.middleware.use Exceptify::Rack,
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com}
+                                        },
+                                        webhook: {
+                                          url: 'http://domain.com:5555/hubot/path'
+                                        }
+```
+
+By default, the WebhookNotifier will call the URLs using the POST method. But, you can change this using the `http_method` option.
+
+```ruby
+Rails.application.config.middleware.use Exceptify::Rack,
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com}
+                                        },
+                                        webhook: {
+                                          url: 'http://domain.com:5555/hubot/path',
+                                          http_method: :get
+                                        }
+```
+
+Besides the `url` and `http_method` options, all the other options are passed directly to HTTParty. Thus, if the HTTP server requires authentication, you can include the following options:
+
+```ruby
+Rails.application.config.middleware.use Exceptify::Rack,
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com}
+                                        },
+                                        webhook: {
+                                          url: 'http://domain.com:5555/hubot/path',
+                                          basic_auth: {
+                                            username: 'alice',
+                                            password: 'password'
+                                          }
+                                        }
+```
+
+For more HTTParty options, check out the [documentation](https://github.com/jnunemaker/httparty).

data/exceptify.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require File.expand_path("lib/exceptify/version", __dir__)
+
+Gem::Specification.new do |s|
+  s.name = "exceptify"
+  s.version = Exceptify::VERSION
+  s.authors = ["lukin.io"]
+  s.summary = "Exception notification for Ruby applications"
+  s.homepage = "https://github.com/lukin-io/exceptify"
+  s.license = "MIT"
+  s.metadata = {
+    "bug_tracker_uri" => "https://github.com/lukin-io/exceptify/issues",
+    "changelog_uri" => "https://github.com/lukin-io/exceptify/blob/main/CHANGELOG.rdoc",
+    "source_code_uri" => "https://github.com/lukin-io/exceptify"
+  }
+
+  s.required_ruby_version = ">= 3.4.4"
+
+  s.files = Dir[
+    "lib/**/*",
+    "docs/**/*",
+    "MIT-LICENSE",
+    "exceptify.gemspec",
+    "Rakefile",
+    "*.md",
+    "*.rdoc"
+  ].reject { |f| File.directory?(f) }
+  s.require_path = "lib"
+
+  s.add_dependency("actionmailer", ">= 7.1", "< 9")
+  s.add_dependency("activesupport", ">= 7.1", "< 9")
+  s.add_dependency("cgi", "~> 0.5")
+
+  s.add_development_dependency "aws-sdk-sns", "~> 1"
+  s.add_development_dependency "dogapi", ">= 1.23.0", "< 2"
+  s.add_development_dependency "httparty", "~> 0.10.2"
+  s.add_development_dependency "mocha", ">= 2.7.1", "< 4"
+  s.add_development_dependency "mock_redis", "~> 0.19.0"
+  s.add_development_dependency "net-smtp", "~> 0.5"
+  s.add_development_dependency "ostruct", "~> 0.6"
+  s.add_development_dependency "rails", ">= 8.0.2", "< 9"
+  s.add_development_dependency "resque", "~> 1.8.0"
+  s.add_development_dependency "sidekiq", ">= 7.1.0", "< 9"
+  s.add_development_dependency "slack-notifier", ">= 1.0.0", "< 3"
+  s.add_development_dependency "standard", "~> 1.54"
+  s.add_development_dependency "timecop", "~> 0.9.0"
+end