correspondent 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed9caf9e54953e0f3dba66aa26746a76ac5acaf5d8921b5390f9614b48e2ccb1
+  data.tar.gz: 24f21fb0868aabed63abfb1c04fa24820d259161761d96cccbeda1d787e1c166
+SHA512:
+  metadata.gz: 2e55c96ecf807357426baec8ed78c20ceabd900e38e239efa0fd0896a4565036992536038d00f0e59ceed27294952c7f5f2cdca613ff37333221d49eb7835927
+  data.tar.gz: a1ecdedc87db4a93cdee1717fdadc1d970e1e61e90070664f763a38935a6768326ef1430f457bf970395a9c23054bb2a1a623da066f28d2299f513e7963cb480

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Vinicius Stock
+
+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,253 @@
+This unfinished experiment is no longer active.
+
+# Correspondent
+
+Dead simple configurable user notifications using the Correspondent engine!
+
+Configure subscribers and publishers and let Correspondent deal with all notification work with very little overhead.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'correspondent'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Create the necessary migrations:
+
+```bash
+$ rails g correspondent:install
+```
+
+## Usage
+
+### Model configuration
+
+Notifications can easily be setup using Correspondent. The following example goes through the basic usage. There are only two steps for the basic configuration:
+
+1. Invoke notifies and configure the subscriber (user in this case), the triggers (method purchase in this case) and desired options
+2. Define the to_notification method to configure information that needs to be used to create notifications
+
+```ruby
+# Example model using Correspondent
+# app/models/purchase.rb
+class Purchase < ApplicationRecord
+  belongs_to :user
+  belongs_to :store
+
+  # Notifies configuration
+  # First argument is the subscriber (the one that receives a notification). Can be an NxN association as well (e.g.: users) which will create a notification for each associated record.
+  # Second argument are the triggers (the method inside that model that triggers notifications). Can be an array of symbols for multiple triggers for the same entity.
+  # Third argument are generic options as a hash
+  notifies :user, :purchase, avoid_duplicates: true
+
+  # Many notifies definitions can be used for different subscribers
+  # In the following case, every time purchase is invoked the following will happen:
+  # 1. A notification will be created for `user`
+  # 2. A notification will be created for `store`
+  # 3. An email will be triggered using the `StoreMailer` (invoking a method called purchase_email)
+  notifies :store, :purchase, avoid_duplicates: true, mailer: StoreMailer
+
+  # `notifies` will hook into the desired triggers.
+  # Every time this method is invoked by an instance of Purchase
+  # a notification will be created in the database using the
+  # `to_notification` method. The handling of notifications is
+  # done asynchronously to cause as little overhead as possible.
+  def purchase
+    # some business logic
+  end
+
+  # The to_notification method returns the information to be
+  # used for creating a notification. This will be invoked automatically
+  # by the gem when a trigger occurs.
+  # When calling this method, entity and trigger will be passed. Entity
+  # is the subscriber (in this example, `user`). Trigger is the method
+  # that triggered the notification. With this approach, the hash
+  # built to pass information can vary based on different triggers.
+  # If entity and trigger will not be used, this can simply be defined as
+  #
+  # def to_notification(*)
+  #   # some hash
+  # end
+  def to_notification(entity:, trigger:)
+    {
+      title: "Purchase ##{id} for #{entity} #{send(entity).name}",
+      content: "Congratulations on your recent #{trigger} of #{name}",
+      image_url: "",
+      link_url: "/purchases/#{id}",
+      referrer_url: "/stores/#{store.id}"
+    }
+  end
+end
+```
+
+Correspondent can also trigger emails if desired. To trigger emails, the mailer class should be passed as an object and should implement a method follwing the naming convention.
+
+```ruby
+# app/models/purchase.rb
+
+class Purchase < ApplicationRecord
+  belongs_to :user
+
+  # Pass the desired mailer in the `mailer:` option
+  notifies :user, :purchase, mailer: ApplicationMailer
+
+  def purchase
+    # some business logic
+  end
+end
+
+# app/mailers/application_mailer.rb
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+
+  # The mailer should implement methods following the naming convention of
+  # #{trigger}_email(triggering_instance)
+  #
+  # In this case, the `trigger` is the method purchase, so Correspondent will look for
+  # the purchase_email method. It will always pass the instance that triggered the email
+  # as an argument.
+  def purchase_email(purchase)
+    @purchase = purchase
+    mail(to: purchase.user.email, subject: "Congratulations on the purchase of #{purchase.name}")
+  end
+end
+```
+
+To reference the created notifications in the desired model, use the following association:
+
+```ruby
+# app/models/purchase.rb
+
+class User < ApplicationRecord
+  has_many :purchases
+  has_many :notifications, class_name: "Correspondent::Notification", as: :subscriber
+end
+
+class Purchase < ApplicationRecord
+  belongs_to :user
+  has_many :notifications, class_name: "Correspondent::Notification", as: :publisher
+end
+```
+
+If a specific column is not needed for your project, remove them from the generated migrations and don't return the respective attribute inside the to_notification method.
+
+### Options
+
+The available options, their default values and their explanations are listed below.
+
+```ruby
+# Avoid duplicates
+# Prevents creating new notifications if a non dismissed notification for the same publisher and same subscriber already exists
+notifies :some_resouce, :trigger, avoid_duplicates: false
+
+# Mailer
+# The Mailer class that implements the desired mailer triggers to send emails. Default is nil (doesn't send emails).
+notifies :some_resouce, :trigger, mailer: nil
+
+# Email only
+# For preventing the creation of notifications and only trigger emails, add the email_only option
+notifies :some_resouce, :trigger, email_only: false
+
+# Conditionals
+# If or unless options can be passed either as procs/lambdas or symbols representing the name of a method
+# These will be evaluated in an instance context, every time trigger is invoked
+notifies :some_resource, :trigger, if: :should_be_notified?
+
+notifies :some_resource, :trigger, unless: -> { should_be_notified? && is_eligible? }
+```
+
+### JSON API
+
+Correspondent exposes a few APIs to be used for handling notification logic in the application.
+
+All APIs use the `stale?` check. So if passing the If-None-Match header, the API will support returning 304 (not modified) if the collection hasn't changed.
+
+```json
+Parameters
+
+:subscriber_type -> The subscriber resource name - not in plural (e.g.: user)
+:subscriber_id   -> The id of the subscriber
+
+Index
+
+Retrieves all non dismissed notifications for a given subscriber.
+
+Request
+GET /correspondent/:subscriber_type/:subscriber_id/notifications
+
+Response
+[
+    {
+        "id":20,
+        "title":"Purchase #1 for user user",
+        "content":"Congratulations on your recent purchase of purchase",
+        "image_url":"",
+        "dismissed":false,
+        "publisher_type":"Purchase",
+        "publisher_id":1,
+        "created_at":"2019-03-01T14:19:31.273Z",
+        "link_url":"/purchases/1",
+        "referrer_url":"/stores/1"
+    }
+]
+
+Preview
+
+Returns total number of non dismissed notifications and the newest notification.
+
+Request
+GET /correspondent/:subscriber_type/:subscriber_id/notifications/preview
+
+Response
+{
+    "count": 3,
+    "notification": {
+        "id":20,
+        "title":"Purchase #1 for user user",
+        "content":"Congratulations on your recent purchase of purchase",
+        "image_url":"",
+        "dismissed":false,
+        "publisher_type":"Purchase",
+        "publisher_id":1,
+        "created_at":"2019-03-01T14:22:31.649Z",
+        "link_url":"/purchases/1",
+        "referrer_url":"/stores/1"
+    }
+}
+
+
+Dismiss
+
+Dismisses a given notification.
+
+Resquest
+PUT /correspondent/:subscriber_type/:subscriber_id/notifications/:notification_id/dismiss
+
+Response
+STATUS no_content (204)
+
+Destroy
+
+Destroys a given notification.
+
+Resquest
+DELETE /correspondent/:subscriber_type/:subscriber_id/notifications/:notification_id
+
+Response
+STATUS no_content (204)
+```
+
+## Contributing
+
+Contributions are very welcome! Don't hesitate to ask if you wish to contribute, but don't yet know how. Please refer to this simple [guideline].
+
+[guideline]: https://github.com/vinistock/correspondent/blob/master/CONTRIBUTING.md

data/Rakefile

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Correspondent"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = Dir["test/**/*_test.rb"].reject { |path| path.include?("benchmarks") }
+  t.verbose = false
+end
+
+task default: :test
+
+namespace :test do
+  Rake::TestTask.new(:benchmark) do |t|
+    t.libs << "test"
+    t.pattern = "test/benchmarks/**/*_test.rb"
+    t.verbose = false
+  end
+end
+
+task all: :environment do
+  system(
+    "brakeman && "\
+    "rake && "\
+    "rubocop --auto-correct && "\
+    "rails_best_practices"
+  )
+end

data/app/controllers/correspondent/application_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Correspondent
+  class ApplicationController < ActionController::API # :nodoc:
+  end
+end

data/app/controllers/correspondent/notifications_controller.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_dependency "correspondent/application_controller"
+
+module Correspondent
+  # NotificationsController
+  #
+  # API for all notifications related
+  # endpoints.
+  class NotificationsController < ApplicationController
+    before_action :find_notification, only: %i[dismiss destroy]
+
+    # index
+    #
+    # Returns all notifications for a given subscriber.
+    def index
+      notifications = Correspondent::Notification.for_subscriber(params[:subscriber_type], params[:subscriber_id])
+      render(json: notifications) if stale?(notifications)
+    end
+
+    # preview
+    #
+    # Returns the newest notification and the total
+    # number of notifications for the given subscriber.
+    def preview
+      notifications = Correspondent::Notification.for_subscriber(params[:subscriber_type], params[:subscriber_id])
+
+      if stale?(notifications)
+        render(
+          json: {
+            count: notifications.count,
+            notification: notifications.limit(1).first
+          }
+        )
+      end
+    end
+
+    # dismiss
+    #
+    # Dismisses a given notification.
+    def dismiss
+      @notification&.dismiss!
+      head(:no_content)
+    end
+
+    # destroy
+    #
+    # Destroys a given notification.
+    def destroy
+      @notification&.destroy
+      head(:no_content)
+    end
+
+    private
+
+    def find_notification
+      @notification = Correspondent::Notification
+                      .select(:id, :subscriber_type, :subscriber_id, :publisher_id, :publisher_type)
+                      .find_by(id: params[:id])
+    end
+  end
+end

data/app/jobs/correspondent/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Correspondent
+  class ApplicationJob < ActiveJob::Base # :nodoc:
+  end
+end

data/app/models/correspondent/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Correspondent
+  class ApplicationRecord < ActiveRecord::Base # :nodoc:
+    self.abstract_class = true
+  end
+end

data/app/models/correspondent/notification.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Correspondent
+  # Notification
+  #
+  # Model to hold all notification logic.
+  class Notification < ApplicationRecord
+    belongs_to :subscriber, polymorphic: true
+    belongs_to :publisher, polymorphic: true
+
+    validates :publisher, :subscriber, presence: true
+    before_destroy :delete_cache_entry
+
+    scope :not_dismissed, -> { where(dismissed: false) }
+    scope :by_parents, lambda { |subscriber, publisher|
+      select(:id)
+        .where(subscriber: subscriber, publisher: publisher)
+        .not_dismissed
+    }
+
+    scope :for_subscriber, lambda { |type, id|
+      not_dismissed
+        .where(subscriber_type: type.capitalize, subscriber_id: id)
+        .order(id: :desc)
+    }
+
+    class << self
+      # create_for!
+      #
+      # Creates notification(s) for the given
+      # +instance+ of the publisher and given
+      # +entity+ (subscriber).
+      def create_for!(attrs, options = {})
+        attributes = attrs[:instance].to_notification(entity: attrs[:entity], trigger: attrs[:trigger])
+        attributes[:publisher] = attrs[:instance]
+
+        relation = attrs[:instance].send(attrs[:entity])
+
+        if relation.respond_to?(:each)
+          create_many!(attributes, relation, options)
+        else
+          create_single!(attributes, relation, options)
+        end
+      end
+
+      # create_many!
+      #
+      # Creates a notification for each
+      # record of the +relation+ so that
+      # a many to many relationship can
+      # notify all associated objects.
+      def create_many!(attributes, relation, options)
+        relation.each do |record|
+          unless options[:avoid_duplicates] && by_parents(record, attributes[:publisher]).exists?
+            create!(attributes.merge(subscriber: record))
+          end
+        end
+      end
+
+      # create_single!
+      #
+      # Creates a single notification for the
+      # passed entity.
+      def create_single!(attributes, relation, options)
+        attributes[:subscriber] = relation
+        create!(attributes) unless options[:avoid_duplicates] && by_parents(relation, attributes[:publisher]).exists?
+      end
+    end
+
+    private_class_method :create_many!, :create_single!
+
+    def as_json(*)
+      Rails.cache.fetch("correspondent_notification_#{id}") do
+        attributes.except("updated_at", "subscriber_type", "subscriber_id")
+      end
+    end
+
+    def dismiss!
+      delete_cache_entry
+      update!(dismissed: true)
+    end
+
+    private
+
+    def delete_cache_entry
+      Rails.cache.delete("correspondent_notification_#{id}")
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+Correspondent::Engine.routes.draw do
+  scope path: ":subscriber_type/:subscriber_id" do
+    resources :notifications, only: %i[index destroy] do
+      collection do
+        get :preview
+      end
+
+      member do
+        put :dismiss
+      end
+    end
+  end
+end

data/lib/correspondent/engine.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Correspondent
+  class Engine < ::Rails::Engine # :nodoc:
+    isolate_namespace Correspondent
+    config.generators.api_only = true
+  end
+end

data/lib/correspondent/version.rb

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

data/lib/correspondent.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require "correspondent/engine"
+require "async"
+
+module Correspondent # :nodoc:
+  LAMBDA_PROC_REGEX = /(->.*})|(->.*end)|(proc.*})|(proc.*end)|(Proc\.new.*})|(Proc\.new.*end)/.freeze
+
+  class << self
+    attr_writer :patched_methods
+
+    # patched_methods
+    #
+    # Hash with information about methods
+    # that need to be patched.
+    def patched_methods
+      @patched_methods ||= {}.with_indifferent_access
+    end
+
+    # trigger_email
+    #
+    # Calls the method of a given mailer using the
+    # trigger. Triggering only happens if a mailer
+    # has been passed as an option.
+    #
+    # Will invoke methods in this manner:
+    #
+    # MyMailer.send("make_purchase_email", #<Purchase id: 1...>)
+    def trigger_email(data)
+      data.dig(:options, :mailer).send("#{data[:trigger]}_email", data[:instance]).deliver_now
+    end
+
+    # <<
+    #
+    # Adds the notification creation and email sending
+    # as asynchronous tasks.
+    def <<(data)
+      Async do
+        unless data.dig(:options, :email_only)
+          Correspondent::Notification.create_for!(data.except(:options), data[:options])
+        end
+
+        trigger_email(data) if data.dig(:options, :mailer)
+      end
+    end
+
+    # should_notify?
+    #
+    # Evaluates the if and unless options within
+    # the context of a model instance.
+    def should_notify?(context, opt)
+      if opt[:if].present?
+        evaluate_conditional(context, opt[:if])
+      elsif opt[:unless].present?
+        !evaluate_conditional(context, opt[:unless])
+      end
+    end
+
+    # evaluate_conditional
+    #
+    # Evaluates if or unless regardless of
+    # whether it is a proc or a symbol.
+    def evaluate_conditional(context, if_or_unless)
+      if if_or_unless.is_a?(Proc)
+        context.instance_exec(&if_or_unless)
+      else
+        context.method(if_or_unless).call
+      end
+    end
+  end
+
+  # notifies
+  #
+  # Save trigger info and options into the patched_methods
+  # hash.
+  def notifies(entity, triggers, options = {})
+    triggers = Array(triggers)
+
+    triggers.each do |trigger|
+      Correspondent.patched_methods[trigger] ||= []
+      Correspondent.patched_methods[trigger] << { entity: entity, options: options }
+    end
+  end
+
+  # method_added
+  #
+  # Callback to patch methods once they are defined.
+  # 1. Create an alias of the original method
+  # 2. Override method by calling the original
+  # 3. Add Correspondent calls for notifications
+  def method_added(name)
+    patch_info = Correspondent.patched_methods.delete(name)
+    return unless patch_info
+
+    class_eval(<<~PATCH, __FILE__, __LINE__ + 1)
+      alias_method :original_#{name}, :#{name}
+
+      def #{name}(*args, &block)
+        result = original_#{name}(*args, &block)
+        #{build_async_calls(patch_info, name)}
+        result
+      end
+    PATCH
+
+    super
+  end
+
+  # ActiveRecord on load hook
+  #
+  # Extend the module after load so that
+  # model class methods are available.
+  ActiveSupport.on_load(:active_record) do
+    extend Correspondent
+  end
+
+  private
+
+  # build_async_calls
+  #
+  # Builds all async call strings needed
+  # to patch the method.
+  def build_async_calls(patch_info, name) # rubocop:disable Metrics/AbcSize
+    patch_info.map do |info|
+      info[:options][:unless] = stringify_lambda(info[:options][:unless]) if info[:options][:unless].is_a?(Proc)
+      info[:options][:if] = stringify_lambda(info[:options][:if]) if info[:options][:if].is_a?(Proc)
+
+      async_call_string(info, name)
+    end.join("\n")
+  end
+
+  # async_call_string
+  #
+  # Builds the string for an Async call
+  # to send data to Correspondent callbacks.
+  def async_call_string(info, name)
+    <<~ASYNC_CALL
+      if Correspondent.should_notify?(self, #{info[:options].to_s.delete('"')})
+        Async do
+          Correspondent << {
+            instance: self,
+            entity: :#{info[:entity]},
+            trigger: :#{name},
+            options: #{info[:options].to_s.delete('"')}
+          }
+        end
+      end
+    ASYNC_CALL
+  end
+
+  # stringify_lambda
+  #
+  # Transform lambda into a string to be used
+  # in method patching.
+  def stringify_lambda(lambda)
+    lambda.source.scan(LAMBDA_PROC_REGEX).flatten.compact.first
+  end
+end

data/lib/generators/correspondent/install/install_generator.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "rails/generators/migration"
+
+module Correspondent
+  module Generators
+    # InstallGenerator
+    #
+    # Creates the necessary migrations to be able to
+    # use the engine.
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+      desc "Create Correspondent migrations"
+
+      def self.next_migration_number(_path)
+        if @prev_migration_nr
+          @prev_migration_nr += 1
+        else
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        end
+
+        @prev_migration_nr.to_s
+      end
+
+      def copy_migrations
+        migration_template "create_correspondent_notifications.rb",
+                           "db/migrate/create_correspondent_notifications.rb",
+                           migration_version: migration_version
+
+        say "\n"
+        say <<~POST_INSTALL_MESSAGE
+          Make sure to edit the generated migration and adapt the notifications
+          attributes according to the application's need. The only attributes
+          that must be kept are the one listed below and the indices.
+
+          Any other desired attributes can be added and then referenced in the
+          `to_notification` method.
+
+            publisher_type
+            publisher_id
+            subscriber_type
+            subscriber_id
+        POST_INSTALL_MESSAGE
+      end
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/generators/correspondent/install/templates/create_correspondent_notifications.rb

@@ -0,0 +1,19 @@
+class CreateCorrespondentNotifications < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :correspondent_notifications do |t|
+      t.string :title
+      t.string :content
+      t.string :image_url
+      t.string :link_url
+      t.string :referrer_url
+      t.boolean :dismissed, default: false
+      t.string :publisher_type, null: false
+      t.integer :publisher_id, null: false
+      t.string :subscriber_type, null: false
+      t.integer :subscriber_id, null: false
+      t.index [:publisher_type, :publisher_id], name: "index_correspondent_on_publisher"
+      t.index [:subscriber_type, :subscriber_id], name: "index_correspondent_on_subscriber"
+      t.timestamps
+    end
+  end
+end

data/lib/tasks/correspondent_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :correspondent do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,226 @@
+--- !ruby/object:Gem::Specification
+name: correspondent
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Vinicius Stock
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: purdytest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails_best_practices
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Dead simple configurable user notifications with little overhead.
+email:
+- vinicius.stock@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/correspondent/application_controller.rb
+- app/controllers/correspondent/notifications_controller.rb
+- app/jobs/correspondent/application_job.rb
+- app/models/correspondent/application_record.rb
+- app/models/correspondent/notification.rb
+- config/routes.rb
+- lib/correspondent.rb
+- lib/correspondent/engine.rb
+- lib/correspondent/version.rb
+- lib/generators/correspondent/install/install_generator.rb
+- lib/generators/correspondent/install/templates/create_correspondent_notifications.rb
+- lib/tasks/correspondent_tasks.rake
+homepage: https://github.com/vinistock/correspondent
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.27
+signing_key:
+specification_version: 4
+summary: Dead simple configurable user notifications with little overhead.
+test_files: []