activity_notification 1.0.2 → 1.1.0

data/lib/activity_notification/controllers/common_controller.rb

@@ -0,0 +1,118 @@
+module ActivityNotification
+  # Module included in controllers to select target
+  module CommonController
+    extend ActiveSupport::Concern
+
+    included do
+      # Include StoreController to allow ActivityNotification access to controller instance
+      include StoreController
+      # Include PolymorphicHelpers to resolve string extentions
+      include PolymorphicHelpers
+
+      prepend_before_action :set_target
+      before_action :set_view_prefixes
+    end
+
+    DEFAULT_VIEW_DIRECTORY = "default"
+  
+    protected
+
+      # Sets @target instance variable from request parameters.
+      # @api protected
+      # @return [Object] Target instance (Returns HTTP 400 when request parameters are not enough)
+      def set_target
+        if (target_type = params[:target_type]).present?
+          target_class = target_type.to_model_class
+          @target = params[:target_id].present? ?
+            target_class.find_by_id!(params[:target_id]) : 
+            target_class.find_by_id!(params["#{target_type.to_resource_name}_id"])
+        else
+          render plain: "400 Bad Request: Missing parameter", status: 400
+        end
+      end
+
+      # Validate target with belonging model (e.g. Notification and Subscription)
+      # @api protected
+      # @param [Object] belonging_model belonging model (e.g. Notification and Subscription)
+      # @return Nil or render HTTP 403 status
+      def validate_target(belonging_model)
+        if @target.present? && belonging_model.target != @target
+          render plain: "403 Forbidden: Wrong target", status: 403
+        end
+      end
+
+      # Sets options to load resource index from request parameters.
+      # This method is to be overriden.
+      # @api protected
+      # @return [Hash] options to load resource index
+      def set_index_options
+        raise NotImplementedError, "You have to implement #{self.class}##{__method__}"
+      end
+
+      # Loads resource index with request parameters.
+      # This method is to be overriden.
+      # @api protected
+      # @return [Array] Array of resource index
+      def load_index
+        raise NotImplementedError, "You have to implement #{self.class}##{__method__}"
+      end
+
+      # Returns controller path.
+      # This method is called from target_view_path method and can be overriden.
+      # @api protected
+      # @return [String] "activity_notification" as controller path
+      def controller_path
+        raise NotImplementedError, "You have to implement #{self.class}##{__method__}"
+      end
+
+      # Returns path of the target view templates.
+      # Do not make this method public unless Rendarable module calls controller's target_view_path method to render resources.
+      # @api protected
+      def target_view_path
+        target_type = @target.to_resources_name
+        view_path = [controller_path, target_type].join('/')
+        lookup_context.exists?(action_name, view_path) ?
+          view_path :
+          [controller_path, DEFAULT_VIEW_DIRECTORY].join('/')
+      end
+
+      # Sets view prefixes for target view path.
+      # @api protected
+      def set_view_prefixes
+        lookup_context.prefixes.prepend(target_view_path)
+      end
+
+      # Returns JavaScript view for ajax request or redirects to back as default.
+      # @api protected
+      # @return [Responce] JavaScript view for ajax request or redirects to back as default
+      def return_back_or_ajax
+        set_index_options
+        respond_to do |format|
+          if request.xhr?
+            load_index if params[:reload].to_s.to_boolean(true)
+            format.js
+          else
+            compatibly_redirect_back(@index_options) and return
+          end
+        end
+      end
+
+      # Redirect to back.
+      # @api protected
+      # @return [Boolean] True
+      def compatibly_redirect_back(request_params = {})
+        # :skip-rails4:
+        if Rails::VERSION::MAJOR >= 5
+          redirect_back fallback_location: { action: :index }, **request_params
+        # :skip-rails4:
+        # :skip-rails5:
+        elsif request.referer
+          redirect_to :back, **request_params
+        else
+          redirect_to action: :index, **request_params
+        end
+        # :skip-rails5:
+        true
+      end
+  end
+end

data/lib/activity_notification/controllers/devise_authentication_controller.rb

@@ -0,0 +1,41 @@
+module ActivityNotification
+  # Module included in controllers to authenticate with Devise module
+  module DeviceAuthenticationController
+    extend ActiveSupport::Concern
+
+    included do
+      prepend_before_action :authenticate_devise_resource!
+      before_action :authenticate_target!
+    end
+
+    protected
+
+      # Authenticate devise resource by Devise (e.g. calling authenticate_user! method).
+      # @api protected
+      # @todo Needs to call authenticate method by more secure way
+      # @return [Responce] Redirects for unsigned in target by Devise, returns HTTP 403 without neccesary target method or returns 400 when request parameters are not enough
+      def authenticate_devise_resource!
+        if params[:devise_type].present?
+          authenticate_method_name = "authenticate_#{params[:devise_type].to_resource_name}!"
+          if respond_to?(authenticate_method_name)
+            send(authenticate_method_name)
+          else
+            render plain: "403 Forbidden: Unauthenticated", status: 403
+          end
+        else
+          render plain: "400 Bad Request: Missing parameter", status: 400
+        end
+      end
+
+      # Authenticate the target of requested notification with authenticated devise resource.
+      # @api protected
+      # @todo Needs to call authenticate method by more secure way
+      # @return [Responce] Returns HTTP 403 for unauthorized target
+      def authenticate_target!
+        current_resource_method_name = "current_#{params[:devise_type].to_resource_name}"
+        unless @target.authenticated_with_devise?(send(current_resource_method_name))
+          render plain: "403 Forbidden: Unauthorized target", status: 403
+        end
+      end
+  end
+end

data/lib/activity_notification/helpers/view_helpers.rb

@@ -5,7 +5,7 @@ module ActivityNotification
     # View helper for rendering an notification, calls {Notification#render} internally.
     # @see Notification#render
     #
-    # @param [Notification, Array<Notificaion>] Array or single instance of notifications to render
+    # @param [Notification, Array<Notificaion>] notifications Array or single instance of notifications to render
     # @param [Hash] options Options for rendering notifications
     # @option options [String, Symbol] :target       (nil)                     Target type name to find template or i18n text
     # @option options [String]         :partial      ("activity_notification/notifications/#{target}", controller.target_view_path, 'activity_notification/notifications/default') Partial template name
@@ -170,7 +170,7 @@ module ActivityNotification
 
     # Returns open_all_notifications_url for the target of specified notification
     #
-    # @param [Notification] notification Notification instance
+    # @param [Target] target Target instance
     # @param [Hash] params Request parameters
     # @return [String] open_all_notifications_url for the target
     # @todo Needs any other better implementation
@@ -179,6 +179,134 @@ module ActivityNotification
       send("open_all_#{target.to_resource_name}_notifications_url", target, params)
     end
 
+    # Returns subscriptions_path for the target
+    #
+    # @param [Object] target Target instance
+    # @param [Hash] params Request parameters
+    # @return [String] subscriptions_path for the target
+    # @todo Needs any other better implementation
+    def subscriptions_path_for(target, params = {})
+      send("#{target.to_resource_name}_subscriptions_path", target, params)
+    end
+
+    # Returns subscription_path for the subscription
+    #
+    # @param [Subscription] subscription Subscription instance
+    # @param [Hash] params Request parameters
+    # @return [String] subscription_path for the subscription
+    # @todo Needs any other better implementation
+    def subscription_path_for(subscription, params = {})
+      send("#{subscription.target.to_resource_name}_subscription_path", subscription.target, subscription, params)
+    end
+
+    # Returns subscribe_subscription_path for the target of specified subscription
+    #
+    # @param [Subscription] subscription Subscription instance
+    # @param [Hash] params Request parameters
+    # @return [String] subscription_path for the subscription
+    # @todo Needs any other better implementation
+    def subscribe_subscription_path_for(subscription, params = {})
+      send("subscribe_#{subscription.target.to_resource_name}_subscription_path", subscription.target, subscription, params)
+    end
+    alias_method :subscribe_path_for, :subscribe_subscription_path_for
+
+    # Returns unsubscribe_subscription_path for the target of specified subscription
+    #
+    # @param [Subscription] subscription Subscription instance
+    # @param [Hash] params Request parameters
+    # @return [String] subscription_path for the subscription
+    # @todo Needs any other better implementation
+    def unsubscribe_subscription_path_for(subscription, params = {})
+      send("unsubscribe_#{subscription.target.to_resource_name}_subscription_path", subscription.target, subscription, params)
+    end
+    alias_method :unsubscribe_path_for, :unsubscribe_subscription_path_for
+
+    # Returns subscribe_to_email_subscription_path for the target of specified subscription
+    #
+    # @param [Subscription] subscription Subscription instance
+    # @param [Hash] params Request parameters
+    # @return [String] subscription_path for the subscription
+    # @todo Needs any other better implementation
+    def subscribe_to_email_subscription_path_for(subscription, params = {})
+      send("subscribe_to_email_#{subscription.target.to_resource_name}_subscription_path", subscription.target, subscription, params)
+    end
+    alias_method :subscribe_to_email_path_for, :subscribe_to_email_subscription_path_for
+
+    # Returns unsubscribe_to_email_subscription_path for the target of specified subscription
+    #
+    # @param [Subscription] subscription Subscription instance
+    # @param [Hash] params Request parameters
+    # @return [String] subscription_path for the subscription
+    # @todo Needs any other better implementation
+    def unsubscribe_to_email_subscription_path_for(subscription, params = {})
+      send("unsubscribe_to_email_#{subscription.target.to_resource_name}_subscription_path", subscription.target, subscription, params)
+    end
+    alias_method :unsubscribe_to_email_path_for, :unsubscribe_to_email_subscription_path_for
+
+    # Returns subscriptions_url for the target
+    #
+    # @param [Object] target Target instance
+    # @param [Hash] params Request parameters
+    # @return [String] subscriptions_url for the target
+    # @todo Needs any other better implementation
+    def subscriptions_url_for(target, params = {})
+      send("#{target.to_resource_name}_subscriptions_url", target, params)
+    end
+
+    # Returns subscription_url for the subscription
+    #
+    # @param [Subscription] subscription Subscription instance
+    # @param [Hash] params Request parameters
+    # @return [String] subscription_url for the subscription
+    # @todo Needs any other better implementation
+    def subscription_url_for(subscription, params = {})
+      send("#{subscription.target.to_resource_name}_subscription_url", subscription.target, subscription, params)
+    end
+
+    # Returns subscribe_subscription_url for the target of specified subscription
+    #
+    # @param [Subscription] subscription Subscription instance
+    # @param [Hash] params Request parameters
+    # @return [String] subscription_url for the subscription
+    # @todo Needs any other better implementation
+    def subscribe_subscription_url_for(subscription, params = {})
+      send("subscribe_#{subscription.target.to_resource_name}_subscription_url", subscription.target, subscription, params)
+    end
+    alias_method :subscribe_url_for, :subscribe_subscription_url_for
+
+    # Returns unsubscribe_subscription_url for the target of specified subscription
+    #
+    # @param [Subscription] subscription Subscription instance
+    # @param [Hash] params Request parameters
+    # @return [String] subscription_url for the subscription
+    # @todo Needs any other better implementation
+    def unsubscribe_subscription_url_for(subscription, params = {})
+      send("unsubscribe_#{subscription.target.to_resource_name}_subscription_url", subscription.target, subscription, params)
+    end
+    alias_method :unsubscribe_url_for, :unsubscribe_subscription_url_for
+
+    # Returns subscribe_to_email_subscription_url for the target of specified subscription
+    #
+    # @param [Subscription] subscription Subscription instance
+    # @param [Hash] params Request parameters
+    # @return [String] subscription_url for the subscription
+    # @todo Needs any other better implementation
+    def subscribe_to_email_subscription_url_for(subscription, params = {})
+      send("subscribe_to_email_#{subscription.target.to_resource_name}_subscription_url", subscription.target, subscription, params)
+    end
+    alias_method :subscribe_to_email_url_for, :subscribe_to_email_subscription_url_for
+
+    # Returns unsubscribe_to_email_subscription_url for the target of specified subscription
+    #
+    # @param [Subscription] subscription Subscription instance
+    # @param [Hash] params Request parameters
+    # @return [String] subscription_url for the subscription
+    # @todo Needs any other better implementation
+    def unsubscribe_to_email_subscription_url_for(subscription, params = {})
+      send("unsubscribe_to_email_#{subscription.target.to_resource_name}_subscription_url", subscription.target, subscription, params)
+    end
+    alias_method :unsubscribe_to_email_url_for, :unsubscribe_to_email_subscription_url_for
+
 
     private
 
@@ -187,7 +315,7 @@ module ActivityNotification
       #
       # @param [Object] target Notification target instance
       # @param [Symbol] index_content Method to load target notification index, [:simple, :unopened_simple, :opened_simple, :with_attributes, :unopened_with_attributes, :opened_with_attributes, :none] are available
-      # @param [Hash] params Option parameter to load notification index
+      # @param [Hash] options Option parameter to load notification index
       # @return [Array<Notification>] Array of notification index
       def load_notification_index(target, index_content, options = {})
         case index_content

data/lib/activity_notification/mailers/helpers.rb

@@ -23,13 +23,11 @@ module ActivityNotification
         #
         # @param [Object]              target        Target of batch notification email
         # @param [Array<Notification>] notifications Target notifications to send batch notification email
+        # @param [String]              batch_key     Key of the 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
-        def batch_notification_mail(target, notifications, options = {})
+        # @option options [String, Symbol] :fallback (:batch_default) Fallback template to use when MissingTemplate is raised
+        def batch_notification_mail(target, notifications, batch_key, options = {})
           initialize_from_notifications(target, notifications)
-          batch_key = options.delete(:batch_key)
-          batch_key ||= @notification.key
           headers = headers_for(batch_key, options)
           @notification = nil
           send_mail(headers, options[:fallback])
@@ -55,8 +53,8 @@ module ActivityNotification
         # @param [String] key Key of the notification
         # @param [Hash] options Options for email notification
         def headers_for(key, options)
-          if !@batch_email and
-             @notification.notifiable.respond_to?(:overriding_notification_email_key) and 
+          if !@batch_email &&
+             @notification.notifiable.respond_to?(:overriding_notification_email_key) &&
              @notification.notifiable.overriding_notification_email_key(@target, key).present?
             key = @notification.notifiable.overriding_notification_email_key(@target, key)
           end
@@ -126,7 +124,7 @@ module ActivityNotification
         # @param [String] key Key of the notification
         # @return [String] Template name
         def template_name(key)
-          key.gsub('.', '/')
+          key.tr('.', '/')
         end
 
 

data/lib/activity_notification/models/concerns/notifiable.rb

@@ -20,6 +20,7 @@ module ActivityNotification
 
       class_attribute  :_notification_targets,
                        :_notification_group,
+                       :_notification_group_expiry_delay,
                        :_notifier,
                        :_notification_parameters,
                        :_notification_email_allowed,
@@ -44,13 +45,14 @@ module ActivityNotification
       # Sets default values to notifiable class fields.
       # @return [NilClass] nil
       def set_notifiable_class_defaults
-        self._notification_targets        = {}
-        self._notification_group          = {}
-        self._notifier                    = {}
-        self._notification_parameters     = {}
-        self._notification_email_allowed  = {}
-        self._notifiable_path             = {}
-        self._printable_notifiable_name   = {}
+        self._notification_targets            = {}
+        self._notification_group              = {}
+        self._notification_group_expiry_delay = {}
+        self._notifier                        = {}
+        self._notification_parameters         = {}
+        self._notification_email_allowed      = {}
+        self._notifiable_path                 = {}
+        self._printable_notifiable_name       = {}
         nil
       end
     end
@@ -74,12 +76,12 @@ module ActivityNotification
       resolved_parameter
     end
 
-    # Returns group owner of the notification from configured field or overriden method.
+    # Returns group unit of the notifications from configured field or overriden method.
     # This method is able to be overriden.
     #
     # @param [String] target_type Target type to notify
     # @param [String] key Key of the notification
-    # @return [Object] Group owner of the notification
+    # @return [Object] Group unit of the notifications
     def notification_group(target_type, key = nil)
       resolve_parameter(
         "notification_group_for_#{cast_to_resources_name(target_type)}",
@@ -87,6 +89,19 @@ module ActivityNotification
         nil, key)
     end
 
+    # Returns group expiry period of the notifications from configured field or overriden method.
+    # This method is able to be overriden.
+    #
+    # @param [String] target_type Target type to notify
+    # @param [String] key Key of the notification
+    # @return [Object] Group expiry period of the notifications
+    def notification_group_expiry_delay(target_type, key = nil)
+      resolve_parameter(
+        "notification_group_expiry_delay_for_#{cast_to_resources_name(target_type)}",
+        _notification_group_expiry_delay[cast_to_resources_sym(target_type)],
+        nil, key)
+    end
+
     # Returns additional notification parameters from configured field or overriden method.
     # This method is able to be overriden.
     #
@@ -173,12 +188,13 @@ module ActivityNotification
     #
     # @param [Symbol, String, Class] target_type Type of target
     # @param [Hash] options Options for notifications
-    # @option options [String]  :key        (notifiable.default_notification_key) Key of the notification
-    # @option options [Object]  :group      (nil)                                 Group unit of the notifications
-    # @option options [Object]  :notifier   (nil)                                 Notifier of the notifications
-    # @option options [Hash]    :parameters ({})                                  Additional parameters of the notifications
-    # @option options [Boolean] :send_email (true)                                If it sends notification email
-    # @option options [Boolean] :send_later (true)                                If it sends notification email asynchronously
+    # @option options [String]                  :key                (notifiable.default_notification_key) Key of the notification
+    # @option options [Object]                  :group              (nil)                                 Group unit of the notifications
+    # @option options [ActiveSupport::Duration] :group_expiry_delay (nil)                                 Expiry period of a notification group
+    # @option options [Object]                  :notifier           (nil)                                 Notifier of the notifications
+    # @option options [Hash]                    :parameters         ({})                                  Additional parameters of the notifications
+    # @option options [Boolean]                 :send_email         (true)                                Whether it sends notification email
+    # @option options [Boolean]                 :send_later         (true)                                Whether it sends notification email asynchronously        
     # @return [Array<Notificaion>] Array of generated notifications
     def notify(target_type, options = {})
       Notification.notify(target_type, self, options)
@@ -190,12 +206,13 @@ module ActivityNotification
     #
     # @param [Array<Object>] targets Targets to send notifications
     # @param [Hash] options Options for notifications
-    # @option options [String]  :key        (notifiable.default_notification_key) Key of the notification
-    # @option options [Object]  :group      (nil)                                 Group unit of the notifications
-    # @option options [Object]  :notifier   (nil)                                 Notifier of the notifications
-    # @option options [Hash]    :parameters ({})                                  Additional parameters of the notifications
-    # @option options [Boolean] :send_email (true)                                Whether it sends notification email
-    # @option options [Boolean] :send_later (true)                                Whether it sends notification email asynchronously
+    # @option options [String]                  :key                (notifiable.default_notification_key) Key of the notification
+    # @option options [Object]                  :group              (nil)                                 Group unit of the notifications
+    # @option options [ActiveSupport::Duration] :group_expiry_delay (nil)                                 Expiry period of a notification group
+    # @option options [Object]                  :notifier           (nil)                                 Notifier of the notifications
+    # @option options [Hash]                    :parameters         ({})                                  Additional parameters of the notifications
+    # @option options [Boolean]                 :send_email         (true)                                Whether it sends notification email
+    # @option options [Boolean]                 :send_later         (true)                                Whether it sends notification email asynchronously        
     # @return [Array<Notificaion>] Array of generated notifications
     def notify_all(targets, options = {})
       Notification.notify_all(targets, self, options)
@@ -207,12 +224,13 @@ module ActivityNotification
     #
     # @param [Object] target Target to send notifications
     # @param [Hash] options Options for notifications
-    # @option options [String]  :key        (notifiable.default_notification_key) Key of the notification
-    # @option options [Object]  :group      (nil)                                 Group unit of the notifications
-    # @option options [Object]  :notifier   (nil)                                 Notifier of the notifications
-    # @option options [Hash]    :parameters ({})                                  Additional parameters of the notifications
-    # @option options [Boolean] :send_email (true)                                Whether it sends notification email
-    # @option options [Boolean] :send_later (true)                                Whether it sends notification email asynchronously
+    # @option options [String]                  :key                (notifiable.default_notification_key) Key of the notification
+    # @option options [Object]                  :group              (nil)                                 Group unit of the notifications
+    # @option options [ActiveSupport::Duration] :group_expiry_delay (nil)                                 Expiry period of a notification group
+    # @option options [Object]                  :notifier           (nil)                                 Notifier of the notifications
+    # @option options [Hash]                    :parameters         ({})                                  Additional parameters of the notifications
+    # @option options [Boolean]                 :send_email         (true)                                Whether it sends notification email
+    # @option options [Boolean]                 :send_later         (true)                                Whether it sends notification email asynchronously        
     # @return [Notification] Generated notification instance
     def notify_to(target, options = {})
       Notification.notify_to(target, self, options)