activity_notification 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 428fe6b5adf0df335cd293284bfaa4ef7edcd415
-  data.tar.gz: 10d9652b853e719fd4f50886682446fabac270a6
+  metadata.gz: eafbddc7c4427310930baf3d6f23464f4d0c2baa
+  data.tar.gz: 38dce4c34e4e22e06be7132d588906500127c017
 SHA512:
-  metadata.gz: 974b2c19ee0e9fec32dd9853325076300c0b31c0c38c5516ae3c51a0122966bbb65ed442d2eca1fa53a2fd81d61e0372622679849fe32d77b09c983068d40c95
-  data.tar.gz: e40bc4f0b7c8570a493fd325c73937db18f7223068278ef8da5348591ffb0417bdf624c1f6ac7fda7405a2e726efcfdeedfe7599d454ba3943c6b43c91b860b9
+  metadata.gz: 4da1eff72e8906c9398bb43f9273ca1c788ce91debeccfc4ec9d371fa6032b11c12fb60594c5191e37717f88df4b1d020b82506357c469c9f1894ba0930ac992
+  data.tar.gz: 08ce06b4beaf320607e276d7dabd9486c58b7f979aa29ee522da90a7c9972eda2bc8148cadad1b90c66dd46bbead0fa819a0bff43a5fd17b9c8b9a1db5e4c113

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activity_notification (1.0.0)
+    activity_notification (1.0.1)
       activerecord (>= 4.2.0)
       i18n (>= 0.5.0)
       jquery-rails (>= 3.1.1)
@@ -164,7 +164,7 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    sqlite3 (1.3.11)
+    sqlite3 (1.3.12)
     term-ansicolor (1.4.0)
       tins (~> 1.0)
     thor (0.19.1)
@@ -197,7 +197,7 @@ DEPENDENCIES
   rails-controller-testing
   rspec-rails (~> 3.5.1)
   simplecov (~> 0.12.0)
-  sqlite3 (~> 1.3.11)
+  sqlite3 (~> 1.3.12)
   timecop
   yard (~> 0.9.5)
   yard-activesupport-concern (~> 0.0.1)

data/README.md

@@ -21,6 +21,7 @@
 * Notification views (presentation of notifications)
 * Grouping notifications (grouping like `"Kevin and 7 other users posted comments to this article"`)
 * Email notification
+* Batch email notification
 * Integration with [Devise](https://github.com/plataformatec/devise) authentication
 
 ### Notification index
@@ -55,8 +56,11 @@
     1. [Setup mailer](#setup-mailer)
     2. [Email templates](#email-templates)
     3. [i18n for email](#i18n-for-email)
-  2. [Grouping notifications](#grouping-notifications)
-  3. [Integration with Devise](#integration-with-devise)
+  2. [Batch email notification](#batch-email-notification)
+    1. [Batch email templates](#batch-email-templates)
+    2. [i18n for batch email](#i18n-for-batch-email)
+  3. [Grouping notifications](#grouping-notifications)
+  4. [Integration with Devise](#integration-with-devise)
 4. [Testing](#testing)
 5. [Documentation](#documentation)
 6. **[Common examples](#common-examples)**
@@ -308,7 +312,7 @@ If you want to set notification index in the common layout, such as common heade
 <%= render_notifications_of current_user, index_content: :with_attributes %>
 ```
 
-Then, content named :notification_index will be prepared and you can use it in your partial template.
+Then, content named `:notification_index` will be prepared and you can use it in your partial template.
 
 ```activity_notifications/notifications/users/_index.html.erb
 ...
@@ -330,29 +334,29 @@ For example, if you have an notification with `:key` set to `"notification.comme
 
 *Hint*: the `"notification."` prefix in `:key` is completely optional, you can skip it in your projects or use this prefix only to make namespace.
 
-If you would like to fallback to a partial, you can utilize the `fallback` parameter to specify the path of a partial to use when one is missing:
+If you would like to fallback to a partial, you can utilize the `:fallback` parameter to specify the path of a partial to use when one is missing:
 
 ```erb
-<%= render_notification(@notification, target: :users, fallback: 'default') %>
+<%= render_notification(@notification, target: :users, fallback: :default) %>
 ```
 
-When used in this manner, if a partial with the specified `:key` cannot be located it will use the partial defined in the `fallback` instead. In the example above this would resolve to `activity_notification/notifications/users/_default.html.(|erb|haml|slim|something_else)`.
+When used in this manner, if a partial with the specified `:key` cannot be located it will use the partial defined in the `:fallback` instead. In the example above this would resolve to `activity_notification/notifications/users/_default.html.(|erb|haml|slim|something_else)`.
 
 If you do not specify `:target` option like this,
 
 ```erb
-<%= render_notification(@notification, fallback: 'default') %>
+<%= render_notification(@notification, fallback: :default) %>
 ```
 
 the gem will look for a partial in `default` as the target type which means `activity_notification/notifications/default/_default.html.(|erb|haml|slim|something_else)`.
 
-If a view file does not exist then ActionView::MisingTemplate will be raised. If you wish to fallback to the old behaviour and use an i18n based translation in this situation you can specify a `:fallback` parameter of `text` to fallback to this mechanism like such:
+If a view file does not exist then ActionView::MisingTemplate will be raised. If you wish to fallback to the old behaviour and use an i18n based translation in this situation you can specify a `:fallback` parameter of `:text` to fallback to this mechanism like such:
 
 ```erb
 <%= render_notification(@notification, fallback: :text) %>
 ```
 
-Default views of `activity_notification` depends on jQuery and you have to add requirements to `application.js` in your apps:
+Finally, default views of `activity_notification` depends on jQuery and you have to add requirements to `application.js` in your apps:
 
 ```app/assets/javascripts/application.js
 //= require jquery
@@ -456,6 +460,42 @@ notification:
         mail_subject: 'New comment to your article'
 ```
 
+### Batch email notification
+
+`activity_notification` provides batch email notification to the notification targets. You can send notification daily or hourly with scheduler like `whenever`.
+
+You can automatically send batch notification email for unopened notifications only to the all specified targets with `batch_key`.
+
+```ruby
+# Send batch notification email to the users with unopened notifications
+User.send_batch_unopened_notification_email(batch_key: 'batch.comment.post')
+```
+
+You can also add conditions to filter notifications, like this:
+
+```ruby
+# Send batch notification email to the users with unopened notifications of specified key in 1 hour
+User.send_batch_unopened_notification_email(batch_key: 'batch.comment.post', filtered_by_key: 'comment.post', custom_filter: ["created_at >= ?", time.hour.ago])
+```
+
+#### Batch email templates
+
+`activity_notification` will look for batch email template in the same way as email notification using `batch_key`.
+`batch_key` is specified by `:batch_key` option. If the option is not specified, The key of the first notification will be used as `batch_key`.
+
+#### i18n for batch email
+
+The subject of batch notification email also can be put in your locale `.yml` files as `mail_subject` field for `batch_key`.
+
+```yaml
+notification:
+  user:
+    batch:
+      comment:
+        post:
+          mail_subject: 'New comments to your article'
+```
+
 ### Grouping notifications
 
 `activity_notification` provides the function for automatically grouping notifications. When you created a notification like this, all *unopened* notifications to the same target will be grouped by `article` set as `:group` options:

data/activity_notification.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'activerecord', '>= 4.2.0'
   s.add_dependency 'jquery-rails', '>= 3.1.1'
 
-  s.add_development_dependency 'sqlite3', '~> 1.3.11'
+  s.add_development_dependency 'sqlite3', '~> 1.3.12'
   s.add_development_dependency 'rspec-rails', '~> 3.5.1'
   s.add_development_dependency 'factory_girl_rails', '~> 4.7.0'
   s.add_development_dependency 'simplecov', '~> 0.12.0'

data/app/controllers/activity_notification/notifications_controller.rb

@@ -15,13 +15,21 @@ module ActivityNotification
     #
     # GET /:target_type/:target_id/notifcations
     # @overload index(params)
-    #   @param [Hash] params Request parameters
-    #   @option params [String] :filter  (nil)     Filter option to load notification index. Nothing means auto loading. 'opened' means opened only and 'unopened' means unopened only.
-    #   @option params [String] :limit   (nil)     Limit to query for notifications
-    #   @option params [String] :reload  ('true')  Whether notification index will be reloaded
+    #   @param [Hash] params Request parameter options for notification index
+    #   @option params [String] :filter                 (nil)     Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
+    #   @option params [String] :limit                  (nil)     Limit to query for notifications
+    #   @option params [String] :reverse                ('false') If notification index will be ordered as earliest first
+    #   @option params [String] :without_grouping       ('false') If notification index will include group members
+    #   @option params [String] :with_group_members     ('false') If notification index will include group members
+    #   @option params [String] :filtered_by_type       (nil)     Notifiable type for filter
+    #   @option params [String] :filtered_by_group_type (nil)     Group type for filter, valid with :filtered_by_group_id
+    #   @option params [String] :filtered_by_group_id   (nil)     Group instance id for filter, valid with :filtered_by_group_type
+    #   @option params [String] :filtered_by_key        (nil)     Key of the notification for filter
+    #   @option params [String] :reload                 ('true')  Whether notification index will be reloaded
     #   @return [Responce] HTML view as default or JSON of notification index with json format parameter
     def index
-      @notifications = load_notification_index(params[:filter], params[:limit]) if params[:reload].to_s.to_boolean(true)
+      set_index_options
+      @notifications = load_notification_index(@index_options) if params[:reload].to_s.to_boolean(true)
       respond_to do |format|
         format.html # index.html.erb
         format.json { render json: @notifications.to_json(include: [:target, :notifiable, :group]) }
@@ -36,6 +44,8 @@ module ActivityNotification
     #   @option params [String] :filter  (nil)     Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
     #   @option params [String] :limit   (nil)     Limit to query for notifications
     #   @option params [String] :reload  ('true')  Whether notification index will be reloaded
+    #   @option params [String] :without_grouping       ('false') If notification index will include group members
+    #   @option params [String] :with_group_members     ('false') If notification index will include group members
     #   @option params [String] :filtered_by_type       (nil) Notifiable type for filter
     #   @option params [String] :filtered_by_group_type (nil) Group type for filter, valid only :filtered_by_group_id
     #   @option params [String] :filtered_by_group_id   (nil) Group instance id for filter, valid only :filtered_by_group_type
@@ -43,7 +53,7 @@ module ActivityNotification
     #   @return [Responce] JavaScript view for ajax request or redirects to back as default
     def open_all
       @target.open_all_notifications(params)
-      return_back_or_ajax(params[:filter], params[:limit])
+      return_back_or_ajax
     end
   
     # Shows a notification.
@@ -61,13 +71,15 @@ module ActivityNotification
     #
     # @overload destroy(params)
     #   @param [Hash] params Request parameters
-    #   @option params [String] :filter  (nil)     Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
-    #   @option params [String] :limit   (nil)     Limit to query for notifications
-    #   @option params [String] :reload  ('true')  Whether notification index will be reloaded
+    #   @option params [String] :filter             (nil)     Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
+    #   @option params [String] :limit              (nil)     Limit to query for notifications
+    #   @option params [String] :reload             ('true')  Whether notification index will be reloaded
+    #   @option params [String] :without_grouping   ('false') If notification index will include group members
+    #   @option params [String] :with_group_members ('false') If notification index will include group members
     #   @return [Responce] JavaScript view for ajax request or redirects to back as default
     def destroy
       @notification.destroy
-      return_back_or_ajax(params[:filter], params[:limit])
+      return_back_or_ajax
     end
   
     # Opens a notification.
@@ -75,16 +87,19 @@ module ActivityNotification
     # POST /:target_type/:target_id/notifcations/:id/open
     # @overload open(params)
     #   @param [Hash] params Request parameters
-    #   @option params [String] :move    ('false') Whether redirects to notifiable_path after the notification is opened
-    #   @option params [String] :filter  (nil)     Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
-    #   @option params [String] :limit   (nil)     Limit to query for notifications
-    #   @option params [String] :reload  ('true')  Whether notification index will be reloaded
+    #   @option params [String] :move               ('false') Whether redirects to notifiable_path after the notification is opened
+    #   @option params [String] :filter             (nil)     Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
+    #   @option params [String] :limit              (nil)     Limit to query for notifications
+    #   @option params [String] :reload             ('true')  Whether notification index will be reloaded
+    #   @option params [String] :without_grouping   ('false') If notification index will include group members
+    #   @option params [String] :with_group_members ('false') If notification index will include group members
     #   @return [Responce] JavaScript view for ajax request or redirects to back as default
     def open
-      @notification.open!
+      with_members = !(params[:with_group_members].to_s.to_boolean(false) || params[:without_grouping].to_s.to_boolean(false))
+      @notification.open!(with_members: with_members)
       params[:move].to_s.to_boolean(false) ? 
         move : 
-        return_back_or_ajax(params[:filter], params[:limit])
+        return_back_or_ajax
     end
 
     # Moves to notifiable_path of the notification.
@@ -146,20 +161,40 @@ module ActivityNotification
         end
       end
 
+      # Sets options to load notification index from request parameters.
+      # @api protected
+      # @return [Hash] options to load notification index
+      def set_index_options
+        limit              = params[:limit].to_i > 0 ? params[:limit].to_i : nil
+        reverse            = params[:reverse].present? ?
+                               params[:reverse].to_s.to_boolean(false) : nil
+        with_group_members = params[:with_group_members].present? || params[:without_grouping].present? ?
+                               params[:with_group_members].to_s.to_boolean(false) || params[:without_grouping].to_s.to_boolean(false) : nil
+        @index_options = params.permit(:filter, :filtered_by_type, :filtered_by_group_type, :filtered_by_group_id, :filtered_by_key)
+                               .to_h.symbolize_keys
+                               .merge(limit: limit, reverse: reverse, with_group_members: with_group_members)
+      end
+
       # Loads notification index with request parameters.
       # @api protected
-      # @param [String] filter Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
-      # @param [String] limit Limit to query for notifications
+      # @param [Hash] params Request parameter options for notification index
+      # @option params [String]  :filter                 (nil)   Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
+      # @option params [Integer] :limit                  (nil)   Limit to query for notifications
+      # @option params [Boolean] :reverse                (false) If notification index will be ordered as earliest first
+      # @option params [Boolean] :without_grouping       (false) If notification index will include group members
+      # @option params [String]  :filtered_by_type       (nil)   Notifiable type for filter
+      # @option params [String]  :filtered_by_group_type (nil)   Group type for filter, valid with :filtered_by_group_id
+      # @option params [String]  :filtered_by_group_id   (nil)   Group instance id for filter, valid with :filtered_by_group_type
+      # @option params [String]  :filtered_by_key        (nil)   Key of the notification for filter
       # @return [Array] Array of notification index
-      def load_notification_index(filter, limit)
-        limit = limit.to_i > 0 ? limit.to_i : nil
-        case filter
+      def load_notification_index(options = {})
+        case options[:filter]
         when 'opened'
-          @target.opened_notification_index_with_attributes({ limit: limit })
+          @target.opened_notification_index_with_attributes(options)
         when 'unopened'
-          @target.unopened_notification_index_with_attributes({ limit: limit })
+          @target.unopened_notification_index_with_attributes(options)
         else
-          @target.notification_index_with_attributes({ limit: limit })
+          @target.notification_index_with_attributes(options)
         end
       end
 
@@ -171,23 +206,32 @@ module ActivityNotification
   
       # Returns JavaScript view for ajax request or redirects to back as default.
       # @api protected
-      # @param [String] filter Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
-      # @param [String] limit Limit to query for notifications
+      # @option params [String]  :filter                 (nil)   Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
+      # @option params [Integer] :limit                  (nil)   Limit to query for notifications
+      # @option params [Boolean] :reverse                (false) If notification index will be ordered as earliest first
+      # @option params [Boolean] :without_grouping       (false) If notification index will include group members
+      # @option params [String]  :filtered_by_type       (nil)   Notifiable type for filter
+      # @option params [String]  :filtered_by_group_type (nil)   Group type for filter, valid with :filtered_by_group_id
+      # @option params [String]  :filtered_by_group_id   (nil)   Group instance id for filter, valid with :filtered_by_group_type
+      # @option params [String]  :filtered_by_key        (nil)   Key of the notification for filter
       # @return [Responce] JavaScript view for ajax request or redirects to back as default
-      def return_back_or_ajax(filter, limit)
-        @notifications = load_notification_index(params[:filter], params[:limit]) if params[:reload].to_s.to_boolean(true)
+      def return_back_or_ajax
+        set_index_options
+        if params[:reload].to_s.to_boolean(true)
+          @notifications = load_notification_index(@index_options) 
+        end
         respond_to do |format|
           if request.xhr?
             format.js
           # :skip-rails4:
           elsif Rails::VERSION::MAJOR >= 5
-            redirect_back fallback_location: { action: :index }, filter: filter, limit: limit and return
+            redirect_back fallback_location: { action: :index }, **@index_options and return
           # :skip-rails4:
           # :skip-rails5:
           elsif request.referer
-            redirect_to :back, filter: filter, limit: limit and return
+            redirect_to :back, **@index_options and return
           else
-            redirect_to action: :index, filter: filter, limit: limit and return
+            redirect_to action: :index, **@index_options and return
           end
           # :skip-rails5:
         end

data/app/mailers/activity_notification/mailer.rb

@@ -4,18 +4,33 @@ if defined?(ActionMailer)
     include ActivityNotification::Mailers::Helpers
 
     # Sends notification email.
+    #
     # @param [Notification] notification Notification instance to send email
-    # @param [Hash] options Options for notification email
+    # @param [Hash]         options      Options for notification email
     # @option options [String, Symbol] :fallback (:default) Fallback template to use when MissingTemplate is raised
+    # @return [Mail::Message|ActionMailer::DeliveryJob] Email message or its delivery job, return NilClass for wrong target
     def send_notification_email(notification, options = {})
       options[:fallback] ||= :default
       if options[:fallback] == :none
         options.delete(:fallback)
       end
-      if notification.target.notification_email_allowed?(notification.notifiable, notification.key) and 
-         notification.notifiable.notification_email_allowed?(notification.target, notification.key)
-        notification_mail(notification, options)
+      notification_mail(notification, options)
+    end
+
+    # Sends batch notification email.
+    #
+    # @param [Object]              target        Target of batch notification email
+    # @param [Array<Notification>] notifications Target notifications to send batch notification email
+    # @param [Hash]                options       Options for notification email
+    # @option options [String, Symbol] :fallback    (:batch_default) Fallback template to use when MissingTemplate is raised
+    # @option options [String]         :batch_key   (nil)            Key of the batch notification email, a key of the first notification will be used if not specified
+    # @return [Mail::Message|ActionMailer::DeliveryJob] Email message or its delivery job, return NilClass for wrong target
+    def send_batch_notification_email(target, notifications, options = {})
+      options[:fallback] ||= :batch_default
+      if options[:fallback] == :none
+        options.delete(:fallback)
       end
+      batch_notification_mail(target, notifications, options)
     end
 
   end

data/app/views/activity_notification/mailer/default/batch_default.html.erb

@@ -0,0 +1,79 @@
+<!doctype html>
+<html lang="ja">
+<head>
+  <meta content="text/html; charset=UTF-8" />
+  <style>
+    body {
+      font-family: 'Lucida Grande', 'Hiragino Kaku Gothic ProN', Meiryo, sans-serif;
+      color: #4f4f4f;
+      font-weight: normal;
+      font-style: normal;
+    }
+    p{
+      font-size: 14px;
+    }
+    .activity_wrapper {
+      padding: 15px 10px;
+      position: relative;
+    }
+    .activity_wrapper:after{
+      content: "";
+      clear: both;
+      display: block;
+    }
+    .activity_wrapper .user_image {
+      float: left;
+      width: 40px;
+      height: 40px;
+      background-position: center;
+      background-repeat: no-repeat;
+      background-size: cover;
+      background-color: #979797;
+    }
+    .activity_wrapper .user_desc_wrapper {
+      float: left;
+      width: calc(100% - 130px);
+      margin-top: 0;
+      margin-left: 10px;
+    }
+    .activity_wrapper .user_desc_wrapper .user_desc {
+      font-size: 12px;
+      line-height: 1.6;
+      margin-top: 0;
+      margin-bottom: 0;
+    }
+    .activity_wrapper .user_desc_wrapper .user_desc span{
+      color: #979797;
+      font-weight: bold;
+    }
+    .activity_wrapper .user_desc_wrapper .user_desc strong{
+      font-weight: bold;
+    }
+  </style>
+  <%= yield :head %>
+</head>
+<body>
+<p>Dear <%= @target.printable_target_name %></p>
+<% @notifications.each do |notification| %>
+  <div class="activity_wrapper">
+    <div class="user_image"></div>
+    <div class="user_desc_wrapper">
+      <p class="user_desc">
+        <strong><%= notification.notifier.present? ? notification.notifier.printable_notifier_name : 'Someone' %></strong>
+        notified you of
+        <%= notification.notifiable.printable_notifiable_name(notification.target) %><%= notification.group.present? ? " in #{notification.group.printable_group_name}." : "." %><br>
+        <span><%= notification.created_at.strftime("%b %d %H:%M") %></span>
+      </p>
+      <p class="user_desc">
+        <span>
+          <%= link_to "Move to notified #{notification.notifiable.printable_type.downcase}", move_notification_url_for(notification, open: true) %>
+        </span>
+      </p>
+    </div>
+  </div>
+<% end %>
+<p>Thank you!</p>
+</body>
+</html>
+
+