notify_user 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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.rdoc

@@ -0,0 +1,3 @@
+= NotifyUser
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler"
+require 'rake'
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+def cmd(command)
+  puts command
+  raise unless system command
+end
+
+# Import all our rake tasks
+FileList['tasks/**/*.rake'].each { |task| import task }

data/app/assets/javascripts/notify_user/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/notify_user/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/notify_user/notifications_controller.rb

@@ -0,0 +1,33 @@
+class NotifyUser::NotificationsController < ApplicationController
+
+  before_filter :authenticate!
+
+  def index
+    @notifications = NotifyUser::BaseNotification.for_target(@user)
+                                                  .order("created_at DESC")
+                                                  .limit(30)
+                                                  .page(params[:page])
+
+    render json: @notifications
+  end
+
+  def mark_read
+    @notifications = NotifyUser::BaseNotification.for_target(@user).where('id IN (?)', params[:ids])
+    @notifications.update_all(state: :read)
+    render json: @notifications
+  end
+
+  protected
+
+  def default_serializer_options
+    {
+      each_serializer: NotifyUser::NotificationSerializer,
+      template_renderer: self
+    }
+  end
+
+  def authenticate!
+    method(NotifyUser.authentication_method).call
+    @user = method(NotifyUser.current_user_method).call
+  end
+end

data/app/helpers/notify_user/application_helper.rb

@@ -0,0 +1,4 @@
+module NotifyUser
+  module ApplicationHelper
+  end
+end

data/app/mailers/notify_user/notification_mailer.rb

@@ -0,0 +1,28 @@
+module NotifyUser
+  class NotificationMailer < ActionMailer::Base
+
+    layout "notify_user/layouts/action_mailer"
+  
+    def notification_email(notification, options)
+      @notification = notification
+
+      mail to: notification.target.email,
+           subject: options[:subject],
+           template_name: "notification",
+           template_path: "notify_user/action_mailer",
+           from: NotifyUser.mailer_sender
+    end
+
+    def aggregate_notifications_email(notifications, options)
+      @notifications = notifications
+
+      mail to: @notifications.first.target.email,
+           template_name: "aggregate_notification",
+           template_path: ["notify_user/#{notifications.first.class.name.underscore}/action_mailer", "notify_user/action_mailer"],
+           subject: options[:aggregate][:subject],
+           from: NotifyUser.mailer_sender
+    end
+
+    protected
+  end
+end

data/app/models/notify_user/base_notification.rb

@@ -0,0 +1,187 @@
+require 'state_machine'
+require 'sidekiq'
+
+module NotifyUser
+  class BaseNotification < ActiveRecord::Base
+
+    if ActiveRecord::VERSION::MAJOR < 4
+      attr_accessible :params, :target, :type, :state
+    end
+
+    # Override point in case of collisions, plus keeps the table name tidy.
+    self.table_name = "notify_user_notifications"
+
+    # Params for creating the notification message.
+    serialize :params, Hash
+
+    # The user to send the notification to
+    belongs_to :target, polymorphic: true
+
+    validates_presence_of :target_id, :target_type, :target, :type, :state
+
+    state_machine :state, initial: :pending do
+
+      # Created, not sent yet. Possibly waiting for aggregation.
+      state :pending do
+      end
+
+      # Email/SMS/APNS has been sent.
+      state :sent do
+      end
+
+      # The user has seen this notification.
+      state :read do
+      end
+
+      # Record that we have sent message(s) to the user about this notification.
+      event :mark_as_sent do
+        transition :pending => :sent
+      end
+
+      # Record that the user has seen this notification, usually on a page or in the app.
+      # A notification can go straight from pending to read if it's seen in a view before
+      # sent in an email.
+      event :mark_as_read do
+        transition [:pending, :sent] => :read
+      end
+    end
+
+    ## Public Interface
+
+    def to(user)
+      self.target = user
+      self
+    end
+
+    def with(*args)
+      self.params = args.reduce({}, :update)
+      self
+    end
+
+    def notify!
+      save!
+
+      # Bang version of 'notify' ignores aggregation
+      self.deliver!
+    end
+
+    # Send any Emails/SMS/APNS
+    def notify
+
+      save!
+
+      if self.class.aggregate_per
+
+        # Schedule to send later if there aren't already any scheduled.
+        # Otherwise ignore, as the already-scheduled aggregate job will pick this one up when it runs.
+        if not aggregation_pending?
+
+          # Send in X minutes, along with any others created in the intervening times.
+          self.class.delay_for(self.class.aggregate_per).notify_aggregated(self.id)
+        end
+      else
+        # No aggregation, send immediately.
+        self.deliver
+      end
+
+    end
+
+    ## Channels
+
+    mattr_accessor :channels
+    @@channels = {
+      action_mailer: {},
+    }
+
+    # Not sure about this. The JSON and web feeds don't fit into channels, because nothing is broadcast through
+    # them. Not sure if they really need another concept though, they could just be formats on the controller.
+    mattr_accessor :views
+    @@views = {
+      mobile_sdk: {
+        template_path: Proc.new {|n| "notify_user/#{n.class.name.underscore}/mobile_sdk/notification" }
+      }
+    }
+
+    # Configure a channel
+    def self.channel(name, options={})
+      channels[name] = options
+    end
+
+    ## Aggregation
+
+    mattr_accessor :aggregate_per
+    @@aggregate_per = 1.minute
+
+    ## Sending
+
+    def self.for_target(target)
+      where(target_id: target.id)
+      .where(target_type: target.class.name)
+    end
+
+    def self.pending_aggregation_with(notification)
+      where(type: notification.type)
+      .for_target(notification.target)
+      .where(state: :pending)
+    end
+
+    def aggregation_pending?
+      # A notification of the same type, that would have an aggregation job associated with it,
+      # already exists.
+      return (self.class.pending_aggregation_with(self).where('id != ?', id).count > 0)
+    end
+
+    def deliver
+      self.mark_as_sent
+      self.save
+
+      self.class.delay.deliver_channels(self.id)
+    end
+
+    def deliver!
+      self.mark_as_sent
+      self.save
+      self.class.deliver_channels(self.id)
+    end
+
+    # Deliver a single notification across each channel.
+    def self.deliver_channels(notification_id)
+      notification = self.where(id: notification_id).first
+      return unless notification
+
+      self.channels.each do |channel_name, options|
+        channel = (channel_name.to_s + "_channel").camelize.constantize
+        channel.deliver(notification, options)
+      end
+    end
+
+    # Deliver multiple notifications across each channel as an aggregate message.
+    def self.deliver_channels_aggregated(notifications)
+      self.channels.each do |channel_name, options|
+        channel = (channel_name.to_s + "_channel").camelize.constantize
+        channel.deliver_aggregated(notifications, options)
+      end
+    end
+
+    def self.notify_aggregated(notification_id)
+      notification = self.find(notification_id) # Raise an exception if not found.
+
+      # Find any pending notifications with the same type and target, which can all be sent in one message.
+      notifications = self.pending_aggregation_with(notification)
+      
+      notifications.map(&:mark_as_sent)
+      notifications.map(&:save)
+
+      return if notifications.empty?
+
+      if notifications.length == 1
+        # Despite waiting for more to aggregate, we only got one in the end.
+        self.deliver_channels(notifications.first.id)
+      else
+        # We got several notifications while waiting, send them aggregated.
+        self.deliver_channels_aggregated(notifications)
+      end
+    end
+
+  end
+end

data/app/serializers/notify_user/notification_serializer.rb

@@ -0,0 +1,15 @@
+class NotifyUser::NotificationSerializer < ActiveModel::Serializer
+  root :notifications
+
+  attributes :id, :message, :read
+
+  def message
+    options[:template_renderer].render_to_string(:template => object.class.views[:mobile_sdk][:template_path].call(object),
+                                                 :locals => {params: object.params},
+                                                 :layout => false)
+  end
+
+  def read
+    object.read?
+  end
+end

data/app/views/layouts/notify_user/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>NotifyUser</title>
+  <%= stylesheet_link_tag    "notify_user/application", :media => "all" %>
+  <%= javascript_include_tag "notify_user/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/notify_user/action_mailer/aggregate_notification.html.erb

@@ -0,0 +1,5 @@
+<% @notifications.each do |notification| %>
+<div>
+  <%= render template: "notify_user/#{notification.class.name.underscore}/action_mailer/notification", locals: { notification: notification, params: notification.params } %>  
+</div>
+<% end %>

data/app/views/notify_user/action_mailer/notification.html.erb

@@ -0,0 +1 @@
+<%= render template: "notify_user/#{@notification.class.name.underscore}/action_mailer/notification", locals: { notification: @notification, params: @notification.params } %>

data/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do
+  namespace :notify_user do
+    resources :notifications, only: [:index]
+    put 'notifications/mark_read' => 'notifications#mark_read'
+  end
+end

data/lib/generators/notify_user/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Creates a migration to set up the notifications table.
+
+Example:
+    rails generate notify_user:install
+
+    This will create:
+        db/migrate/create_notifications.rb

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

@@ -0,0 +1,28 @@
+require 'rails/generators/active_record'
+
+class NotifyUser::InstallGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_migration
+    migration_template "migration.rb", "db/migrate/create_notify_user_notifications"
+    puts "Installation successful. You can now run:"
+    puts "  rake db:migrate"
+  end
+
+  def copy_initializer
+    template "initializer.rb", "config/initializers/notify_user.rb"
+  end
+
+  # This is defined in ActiveRecord::Generators::Base, but that inherits from NamedBase, so it expects a name argument
+  # which we don't want here. So we redefine it here. Yuck.
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+end

data/lib/generators/notify_user/install/templates/initializer.rb

@@ -0,0 +1,12 @@
+NotifyUser.setup do |config|
+
+  # Override the email address from which notifications appear to be sent.
+  config.mailer_sender = "please-change-me-at-config-initializers-notify-user@example.com"
+
+  # NotifyUser will call this within NotificationsController to ensure the user is authenticated.
+  config.authentication_method = :authenticate_user!
+
+  # NotifyUser will call this within NotificationsController to return the current logged in user.
+  config.current_user_method = :current_user
+
+end

data/lib/generators/notify_user/install/templates/migration.rb

@@ -0,0 +1,13 @@
+class CreateNotifyUserNotifications < ActiveRecord::Migration
+  def change
+    create_table :notify_user_notifications do |t|
+      t.string :type
+      t.integer :target_id
+      t.string :target_type
+      t.text :params
+      t.string :state
+
+      t.timestamps
+    end
+  end
+end