Home / Ruby / Miscellaneous

Noticed - Notifications for your Ruby on Rails app.

Notifications for Ruby on Rails applications

README
Issues 12

Noticed - Notifications for your Ruby on Rails app.

Currently, we support these notification delivery methods out of the box:

Database
Email
Websocket (realtime)
Twilio (SMS)
Vonage / Nexmo (SMS)

And you can easily add new notification types for any other delivery methods.

Installation

Add this line to your application's Gemfile:

gem 'noticed'

And then execute:

$ bundle

Or install it yourself as:

$ gem install noticed

Usage

You can define a Notification as a class that inherits from Noticed::Base. To add delivery methods, simply include the module for the delivery methods you would like to use.

class CommentNotification < Noticed::Base
  include Noticed::Database
  include Noticed::Websocket
end

To send a notification to a user:

notification = CommentNotification.with(comment: @comment.to_gid)

# Deliver notification in background job
notification.deliver_later(@comment.post.author)

# Deliver notification immediately
notification.deliver(@comment.post.author)

This will instantiate a new notification with the comment global ID stored in the metadata.

Each delivery method is able to transfrom this metadata that's best for the format. For example, the database may simply store the comment so it can be linked when rendering in the navbar. The websocket mechanism may transform this into a browser notification or insert it into the navbar.

Delivery Methods

The delivery methods are designed to be overriden so that you can customi1ze the notification for each medium.

For example, emails will require a subject, body, and email address while an SMS requires a phone number and simple message. You can define the formats for each of these in your Notification and the delivery method will handle the processing of it.

Simply include any of these modules in your notification to add it as a delivery method.

`Noticed::Database`

Writes notification to the database.

`Noticed::Email`

Sends an email notification.

`Noticed::Slack`

Sends a Slack notification via webhook.

`Noticed::Twilio`

Sends an SMS notification via Twilio.

`Noticed::Vonage`

Sends an SMS notification vai Vonage / Nexmo.

`Noticed::Websocket`

Sends a notification to the browser via websockets (typically ActionCable channels).

User Preferences

Each delivery method implements a deliver_with_#{name} method that receives the recipient as the first argument. You can override this method to check the user's preferences and skip processing if they have disabled that type of notification.

For example:

class CommentNotification < Noticed::Base
  deliver_by :email, if: :email_notifications?

  def email_notifications?
    recipient.email_notifications?
  end
end

Custom Delivery Methods

Coming soon!

Contributing

Contribution directions go here.

License

The gem is available as open source under the terms of the MIT License.

2 Open More issues

Closed

Add option to delay the delivery

Add an option to delay the delivery of a delivery method. To use it, just add the delay option with a valid duration

class CommentNotification < Noticed::Base
  deliver_by :database
  deliver_by :email, mailer: 'CommentMailer', delay: 5.minutes, unless: :read?

  def read?
    record.read?
  end
end

I've had to create a new job instead of using the delivery method one so the if and unless options run after the given delay, otherwise they would be triggered the moment the notification is delivered.

Closes #50

enhancement

opened Nov 5, 2020 by rbague 12

Closed

wrong number of arguments (given 0, expected 1) on mailers

Can you show an example mailer that works with this, please? I'm unable to get it working correctly as I'm getting the error

wrong number of arguments (given 0, expected 1)
/app/app/mailers/engineer_mailer.rb:48:in `timesheet_reminder'

My mailer looks like this:

class EngineerMailer < ApplicationMailer
  def timesheet_reminder(recipient)
    timesheet = Timesheet.new(
      date: Date.current.beginning_of_week,
      account: recipient
    )

    @timesheet_title = timesheet.to_label
    @timesheet_url = engineers_timesheet_url(timesheet.slug)
    mail to: timesheet.account.email
  end
end

And I'm guessing the missing arguments relates to the recipient I want to pass in.

My notification looks like this:

class EngineerTimesheetReminderNotification < BaseNotification
  deliver_by :database
  deliver_by :email,
             mailer: "EngineerMailer",
             method: "timesheet_reminder"

  deliver_by :twilio,
             credentials: :get_twilio_credentials

  param :engineer

  def url
    timesheet = Timesheet.new(
      date: Date.current.beginning_of_week,
      account: engineer
    )

    engineers_timesheet_url(timesheet.slug)
  end
end

What am I missing? Thanks.

opened Aug 12, 2020 by LimeBlast 9

Closed

Naming of the notification param in the 'email' delivery method

I hope this doesn't come off as nit-picky, but I wanted to bring up/suggest a tweak to the naming of one of the mailer params in the email delivery method.

Since in my case I'm utilizing a polymorphic relationship to link up to the subject of my notifications, I was trying to find the best way to refer back to the notification record itself while building out my mailer action. Turns out there's a way to do this, and it's by referencing params[:record].

In my head it seems a bit confusing to build out my mailer with a param called :record as opposed to :notification.

As it currently stands this is what I need to do:

class CommentMailer < ApplicationMailer
  before_action do
    @recipient, @notification = params[:recipient], params[:record]
    @comment = @notification.notifiable
  ...
end

My proposal would be to change the params name to :notification so that in my mailers I could do this:

class CommentMailer < ApplicationMailer
  before_action do
    @recipient, @notification = params[:recipient], params[:notification]
    @comment = @notification.notifiable
  ...
end

As I mentioned above I know this is a bit pedantic, but sometimes I feel that's half of what being a programmer is all about :)

I'm happy to submit a PR for this if you agree. From the looks of it I'd just need to make a change on this line: https://github.com/excid3/noticed/blob/7c8c8b47fd45d92b2eb38d7561dd75614211894e/lib/noticed/delivery_methods/email.rb#L24

question

opened Aug 17, 2020 by kylekeesling 8

Closed

`mark_as_unread!` does not work for association collections

Hey!

This gem is a blessing and saved so much time already. I ran into this obscure use case where I'd need to mark a bunch of notifications as unread and the gem doesn't seem to support it (yet). 🤷‍♂️

Gem version: 1.2.19

Expected Behavior

Running user.notifications.mark_as_unread! should mark the notification records as not read.

Actual Behavior

Running user.notifications.mark_as_unread! throws an undefined method 'mark_as_unread!' for #<Notification::ActiveRecord_Associations_CollectionProxy:0x0000000000000> error.

Additional Information

Running user.notifications.mark_as_read! works as one would expect.
Documenting association methods would be a great add as well! 📚

enhancement

opened Nov 23, 2020 by elvinaspredkelis 8

Closed

Send to multiple recipients

Allow passing multiple users into deliver and deliver_later. We can loop through each of them and send notifications for them.

We will need to figure out what to do with callbacks. They could run once for each recipient or for the entire block? Or do we introduce a different interface for sending to multiple?

[x] Accepts one or many recipients (use Array.wrap to make them consistent)
[x] Calls uniq on the list of recipients
[x] Correctly handle with callbacks

enhancement help wanted

opened Aug 3, 2020 by excid3 8

Closed

Compatibility for Rails 5.2

Resolves #104

Motivation: Many projects are on older versions of Rails, and because some level of support for ActiveJob and ActionCable are found in Rails 5.2, there isn't too much fiddling around that's necessary in order for Noticed to support this older environment.

Implementation: From Rails 6, port over the ActionCable test adapter and test helpers, and also the Serializer support in ActiveJob, along with the SymbolSerializer and DurationSerializer. And use a freeze_time block for the one time-sensitive test that expects an exact five minute interval to elapse before sending notification.

Sample test run of Noticed 1.3.2 running under Ruby 2.6.5 and Rails 5.2.5:

opened Mar 27, 2021 by lorint 7

Open

Bulk insert `deliver_by :database`

Hi, is it possible to bulk insert to the database? as of right now when I tried to send a notification to 5 users, there are 5 insert queries, and if there are 10000 users, I think it will execute 10000 queries, so if possible I want to bulk the insert to the database, let's say 1000 users each query.

I already tried using deliver_later, but it only does execute the send notification in the background.

I already read about this, but it's mentioning that even though it's a batch delivery for Postmark, it still executes deliver to database 5.000 times

opened Jul 19, 2021 by khrisnagunanasurya-iav 0

Open

Unable to make Twillio work

Hi guys,

I do apologise if this has been raised before. I could only find https://github.com/excid3/noticed/issues/26 that relates to my problem, but it doesn't fix it.

Maybe I'm not understanding the documentation

class RefreshErrorNotification < Noticed::Base
  deliver_by :twilio, debug: true

  def message
    t('.message')
  end
end

My understanding is that by creating

en:
  notifications:
    refresh_error_notification:
      message: 'My Message'

Twillio should pick that message. It doesn't. Looking at the code https://github.com/excid3/noticed/blob/master/lib/noticed/delivery_methods/twilio.rb#L17 I can't see where Noticed tries to call that method at all and instead its looking at notification.params[:message]

#<RefreshErrorNotification:0x00007f98ce4dbc28
 @params=
  {:resource=>
    #<Stat::Fortnite::Identity:0x00007f98cdeb7810
     id: 1,
     user_id: 1,
     account_id: nil,
     username: "pacMakaveli90",
     platform: 0,
     created_at: Tue, 29 Jun 2021 09:39:59.389578000 BST +01:00,
     updated_at: Tue, 29 Jun 2021 09:39:59.389578000 BST +01:00,
     authorization_code: nil,
     refresh_token: nil,
     refresh_token_expires_at: nil,
     access_token: nil,
     access_token_expires_at: nil,
     remote_session_id: nil,
     tenure_level: nil,
     older_than_one_month: nil,
     older_than_two_months: nil,
     remote_created_at: nil,
     remote_profile_status: "available",
     refreshed_at: nil>,
   :error=>
    "Sorry the authorization code you supplied was not found. It is possible that it was no longer valid"},
 @recipient=
  #<Partner:0x00007f98c529ac10
   id: 1,
   user_id: 1,
   token: nil,
   domain: "games.directory",
   name: "games.directory",
   description: "Y",
   subdomain: "gd",
   access: "full",
   requests: 0,
   period: "second",
   uuid: "50364aed-b5d2-40e9-a63b-1f16d5631145",
   created_at: Wed, 07 Apr 2021 11:45:29.638000000 BST +01:00,
   updated_at: Mon, 10 May 2021 00:29:50.107000000 BST +01:00,
   accepted_partner_agreement: true,
   accepted_partner_agreement_at: Mon, 10 May 2021 00:29:45.000000000 BST +01:00,
   accepted_acceptable_use_policy: true,
   accepted_acceptable_use_policy_at: Mon, 10 May 2021 00:29:50.000000000 BST +01:00,
   accepted_privacy_policy: false,
   accepted_privacy_policy_at: nil,
   accepted_terms_of_service: false,
   accepted_terms_of_service_at: nil>,
 @record=nil>

I can fix this by doing either:

Body: notification.params[:message] || notification.message

or passing another value to: ::RefreshErrorNotification.with(resource: resource, error: e.to_s).deliver(user.partner) of message: "my twillio message here"

I personally would've thought that Noticed should automatically call the message method first and perhaps fallback to the message param or check if there is a param of message and then fallback to the message.

Am I doing something wrong?

enhancement good first issue help wanted

opened Jul 5, 2021 by pacMakaveli 2

Open

Uninitialized Constant Error

Thanks for this brilliant and useful gem first of all .

I just wanted to know if there is something to do after generating a notification, i've runned the migrations and generated one notification as in the exemple in the doc rails g noticed:notification ProjectInvitationNotification.

class ProjectInvitationNotification < Noticed::Base
  # Add your delivery methods
  #
  deliver_by :database
  # deliver_by :email, mailer: "UserMailer"
  # deliver_by :slack
  # deliver_by :custom, class: "MyDeliveryMethod"

  # Add required params
  #
  param :project_invitation

  # Define helper methods to make rendering easier.
  def message
    'Vous avez recu une nouvelle invitation à un projet'
  end


  # def url
  #   post_path(params[:post])
  # end
end

But when i use the delivering method ProjectInvitationNotification.with(project_invitation: @invitation).deliver(current_user) i'm always getting the error of "uninitialized constant ProjectInvitationNotification", even in the rails console Can you guys help me please !

opened Jun 30, 2021 by shinobi017 0

Open

Notification without recipient

Hi!

I'm using this this gem in production app and recently I've met a case when I need to send notification without specific recipient (slack notification + email to support).

Currently gem requires recipient object to be passed to #deliver or #deliver_later. I think that for some cases this is not necessary.

What do you think about making recipient not required?

I achieved this with simple monkey patch, but I'm not sure that it will play well with database notifications:

  def deliver(recipient = :default_recipient)
    super
  end

  def deliver_later(recipient = :default_recipient)
    super
  end

enhancement

opened Jun 17, 2021 by pavelbonda 5

Open

Introduce Bulk deliveries

Introduces bulk deliveries mentioned in https://github.com/excid3/noticed/issues/89

Usage

class CommentNotification < Noticed::Base
  deliver_by :database
  deliver_by :postmark
  deliver_by :postmark, bulk: { group_size: 1000 }
end

class DeliveryMethods::Postmark < Noticed::DeliveryMethods::Base
 # A custom delivery method can deliver both individually and in bulk
 # For individual delivery, use `deliver` and for bulk delivery use `bulk_deliver`

  def deliver
     # you will have access to a single`recipient` here

     post "https://api.postmarkapp.com/email/send", {
        to: recipient.email,
        subject: 'Something'
      }
  end

  def bulk_deliver
     # you will have access to one batch of `recipients` here

       post "https://api.postmarkapp.com/email/send", {
         to: recipients.map(&:email),
         subject: 'Something'
       }
  end
end

User.all.count
# => 5000

CommentNotification.deliver_later(User.all)
# => Enqueues DeliveryMethods::Database.deliver 5,000 times.
# => Enqueues DeliveryMethods::PostMark.deliver 5,000 times.
# => Enqueues DeliveryMethods::Postmark.bulk_deliver 5 times.

opened May 31, 2021 by manojmj92 1

Open

Rescuing from database connection errors during the bootstrapping/com…

…pilation phase.

This PR attempts to extend https://github.com/excid3/noticed/commit/0cfcebe4c399fae8b5624235ba4641fc2c4ba153

opened May 13, 2021 by adriancb 0

Information

Category: Ruby / Miscellaneous
Watchers: 5
Star: 24
Fork: 1
Last update: Jul 31, 2020

Resource links

https://github.com/excid3/noticed

Share this repo

Related Repos

Miscellaneous

308

System for building screencasts and video presentations

Castaway Want to create an online presentation or screencast, but are frustrated by complicated interfaces or expensive tools? Maybe you're using one that almost does what you need, but that one feature it's missing is a deal-bre

Miscellaneous

Composable method objects in ruby.

Functo Composable method objects in ruby. Usage class AddsOne include Functo.call :add, :number def add number + 1 end end AddsOne[1] # `.call` or `.()` also work # => 2 class Multiplies include Fu

Miscellaneous

Easily Translate Enums in Rails

TranslateEnum Simple, zero-dependant enum translation gem for Rails Installation gem install translate_enum Usage Here is a regular use case. ActiveRecord model: class Post < ActiveRecord::Base

Miscellaneous

126

Visualize different Unicode encodings in the terminal

unibits | Reveal the Unicode Ruby library and CLI command that visualizes various Unicode and ASCII/single byte encodings in the terminal: Makes analyzing encodings easier Helps you with debugging strings Highlights inv

Miscellaneous

Start, monitor, and observe background worker processes, from Ruby.

Kamisama Start, monitor, and observe background worker processes, from Ruby. Based on Unicorn, God, and Sidekiq. Usage Kamisama is useful for starting multiple background workers. For example, let's say that you ha

Miscellaneous

112

Server Timing headers for Rails apps

rails_server_timings Rails support for returning Server Timing headers on requests providing instrumentation information to in-browser developer tools. Download Github: https://github.com/dpogue/rails_server_timin

Miscellaneous

404

Manage your Ruby On Rails models, relations, and migrations from a simple UI.

See the schema Create a model Create a many to many relation Create a migration Using the Capture plugin INSTALL Only tested with Rails 4.2 and Rails 5.1 (shoul

Miscellaneous

Simple containerized development environments directly from the command line

Kapten Create simple and containerized development environments from the command line. Say goodbye to dependency issues, language version management, and complicated setups. Supports: Ruby Python Node.js Elixir PHP