activity_notification 1.0.2 → 1.1.0

data/activity_notification.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
 
   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 'factory_girl_rails', '~> 4.8.0'
   s.add_development_dependency 'simplecov', '~> 0.12.0'
   s.add_development_dependency 'yard', '~> 0.9.5'
   s.add_development_dependency 'yard-activesupport-concern', '~> 0.0.1'

data/app/controllers/activity_notification/notifications_controller.rb

@@ -1,19 +1,13 @@
 module ActivityNotification
   # Controller to manage notifications.
   class NotificationsController < ActivityNotification.config.parent_controller.constantize
-    # Include StoreController to allow ActivityNotification access to controller instance
-    include ActivityNotification::StoreController
-    # Include PolymorphicHelpers to resolve string extentions
-    include ActivityNotification::PolymorphicHelpers
-    prepend_before_action :set_target
+    # Include CommonController to select target and define common methods
+    include CommonController
     before_action :set_notification, except: [:index, :open_all]
-    before_action :set_view_prefixes, except: [:move]
-  
-    DEFAULT_VIEW_DIRECTORY = "default"
-  
+
     # Shows notification index of the target.
     #
-    # GET /:target_type/:target_id/notifcations
+    # GET /:target_type/:target_id/notifications
     # @overload index(params)
     #   @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')
@@ -29,7 +23,7 @@ module ActivityNotification
     #   @return [Responce] HTML view as default or JSON of notification index with json format parameter
     def index
       set_index_options
-      @notifications = load_notification_index(@index_options) if params[:reload].to_s.to_boolean(true)
+      load_index 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]) }
@@ -38,7 +32,7 @@ module ActivityNotification
 
     # Opens all notifications of the target.
     #
-    # POST /:target_type/:target_id/notifcations/open_all
+    # POST /:target_type/:target_id/notifications/open_all
     # @overload open_all(params)
     #   @param [Hash] params Request parameters
     #   @option params [String] :filter  (nil)     Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
@@ -58,7 +52,7 @@ module ActivityNotification
   
     # Shows a notification.
     #
-    # GET /:target_type/:target_id/notifcations/:id
+    # GET /:target_type/:target_id/notifications/:id
     # @overload show(params)
     #   @param [Hash] params Request parameters
     #   @return [Responce] HTML view as default
@@ -67,7 +61,7 @@ module ActivityNotification
   
     # Deletes a notification.
     #
-    # DELETE /:target_type/:target_id/notifcations/:id
+    # DELETE /:target_type/:target_id/notifications/:id
     #
     # @overload destroy(params)
     #   @param [Hash] params Request parameters
@@ -84,7 +78,7 @@ module ActivityNotification
   
     # Opens a notification.
     #
-    # POST /:target_type/:target_id/notifcations/:id/open
+    # POST /:target_type/:target_id/notifications/: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
@@ -104,7 +98,7 @@ module ActivityNotification
 
     # Moves to notifiable_path of the notification.
     #
-    # GET /:target_type/:target_id/notifcations/:id/move
+    # GET /:target_type/:target_id/notifications/:id/move
     # @overload open(params)
     #   @param [Hash] params Request parameters
     #   @option params [String] :open    ('false') Whether the notification will be opened
@@ -117,48 +111,19 @@ module ActivityNotification
       redirect_to @notification.notifiable_path
     end
   
-    # Returns controller path.
-    # This method has no action routing and is called from target_view_path method.
-    # This method can be overriden.
-    # @return [String] "activity_notification/notifications" as controller path
-    def controller_path
-      "activity_notification/notifications"
-    end
-
     # Returns path of the target view templates.
     # This method has no action routing and needs to be public since it is called from view helper.
     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('/')
+      super
     end
 
     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
-  
       # Sets @notification instance variable from request parameters.
       # @api protected
       # @return [Object] Notification instance (Returns HTTP 403 when the target of notification is different from specified target by request parameter)
       def set_notification
-        @notification = Notification.find_by_id!(params[:id])
-        if @target.present? and @notification.target != @target
-          render plain: "403 Forbidden: Wrong target", status: 403
-        end
+        validate_target(@notification = Notification.includes(:target).find_by_id!(params[:id]))
       end
 
       # Sets options to load notification index from request parameters.
@@ -170,71 +135,32 @@ module ActivityNotification
                                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)
+        @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 [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(options = {})
-        case options[:filter]
-        when 'opened'
-          @target.opened_notification_index_with_attributes(options)
-        when 'unopened'
-          @target.unopened_notification_index_with_attributes(options)
-        else
-          @target.notification_index_with_attributes(options)
-        end
+      def load_index
+        @notifications = 
+          case @index_options[:filter]
+          when :opened, 'opened'
+            @target.opened_notification_index_with_attributes(@index_options)
+          when :unopened, 'unopened'
+            @target.unopened_notification_index_with_attributes(@index_options)
+          else
+            @target.notification_index_with_attributes(@index_options)
+          end
       end
 
-      # Sets view prefixes for target view path.
+      # Returns controller path.
+      # This method is called from target_view_path method and can be overriden.
       # @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
-      # @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
-        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 }, **@index_options and return
-          # :skip-rails4:
-          # :skip-rails5:
-          elsif request.referer
-            redirect_to :back, **@index_options and return
-          else
-            redirect_to action: :index, **@index_options and return
-          end
-          # :skip-rails5:
-        end
+      # @return [String] "activity_notification/notifications" as controller path
+      def controller_path
+        "activity_notification/notifications"
       end
 
   end

data/app/controllers/activity_notification/notifications_with_devise_controller.rb

@@ -1,38 +1,6 @@
 module ActivityNotification
   # Controller to manage notifications with Devise authentication.
   class NotificationsWithDeviseController < NotificationsController
-    prepend_before_action :authenticate_devise_resource!
-    before_action :authenticate_target!
-    
-    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
-
+    include DeviceAuthenticationController
   end
 end

data/app/controllers/activity_notification/subscriptions_controller.rb

@@ -0,0 +1,184 @@
+module ActivityNotification
+  # Controller to manage subscriptions.
+  class SubscriptionsController < ActivityNotification.config.parent_controller.constantize
+    # Include CommonController to select target and define common methods
+    include CommonController
+    before_action :set_subscription, except: [:index, :create]
+
+    # Shows subscription index of the target.
+    #
+    # GET /:target_type/:target_id/subscriptions
+    # @overload index(params)
+    #   @param [Hash] params Request parameter options for subscription index
+    #   @option params [String] :filter          (nil)     Filter option to load subscription index (Nothing as all, 'configured' or 'unconfigured')
+    #   @option params [String] :limit           (nil)     Limit to query for subscriptions
+    #   @option params [String] :reverse         ('false') If subscription index and unconfigured notification keys will be ordered as earliest first
+    #   @option params [String] :filtered_by_key (nil)     Key of the subscription for filter
+    #   @return [Responce] HTML view as default or JSON of subscription index with json format parameter
+    def index
+      set_index_options
+      load_index if params[:reload].to_s.to_boolean(true)
+      respond_to do |format|
+        format.html # index.html.erb
+        format.json { render json: { subscriptions: @subscriptions, unconfigured_notification_keys: @notification_keys } }
+      end
+    end
+
+    # Creates a subscription.
+    #
+    # POST /:target_type/:target_id/subscriptions
+    #
+    # @overload create(params)
+    #   @param [Hash] params Request parameters
+    #   @option params [String] :subscription                              Subscription parameters
+    #   @option params [String] :subscription[:key]                        Key of the subscription
+    #   @option params [String] :subscription[:subscribing]          (nil) If the target will subscribe to the notification
+    #   @option params [String] :subscription[:subscribing_to_email] (nil) If the target will subscribe to the notification email
+    #   @option params [String] :filter          (nil)     Filter option to load subscription index (Nothing as all, 'configured' or 'unconfigured')
+    #   @option params [String] :limit           (nil)     Limit to query for subscriptions
+    #   @option params [String] :reverse         ('false') If subscription index and unconfigured notification keys will be ordered as earliest first
+    #   @option params [String] :filtered_by_key (nil)     Key of the subscription for filter
+    #   @return [Responce] JavaScript view for ajax request or redirects to back as default
+    def create
+      @target.create_subscription(subscription_params)
+      return_back_or_ajax
+    end
+
+    # Shows a subscription.
+    #
+    # GET /:target_type/:target_id/subscriptions/:id
+    # @overload show(params)
+    #   @param [Hash] params Request parameters
+    #   @return [Responce] HTML view as default
+    def show
+    end
+  
+    # Deletes a subscription.
+    #
+    # DELETE /:target_type/:target_id/subscriptions/:id
+    #
+    # @overload destroy(params)
+    #   @param [Hash] params Request parameters
+    #   @option params [String] :filter          (nil)     Filter option to load subscription index (Nothing as all, 'configured' or 'unconfigured')
+    #   @option params [String] :limit           (nil)     Limit to query for subscriptions
+    #   @option params [String] :reverse         ('false') If subscription index and unconfigured notification keys will be ordered as earliest first
+    #   @option params [String] :filtered_by_key (nil)     Key of the subscription for filter
+    #   @return [Responce] JavaScript view for ajax request or redirects to back as default
+    def destroy
+      @subscription.destroy
+      return_back_or_ajax
+    end
+
+    # Subscribes to the notification.
+    #
+    # POST /:target_type/:target_id/subscriptions/:id/subscribe
+    # @overload open(params)
+    #   @param [Hash] params Request parameters
+    #   @option params [String] :with_email_subscription ('true')  If the subscriber also subscribes notification email
+    #   @option params [String] :filter                  (nil)     Filter option to load subscription index (Nothing as all, 'configured' or 'unconfigured')
+    #   @option params [String] :limit                   (nil)     Limit to query for subscriptions
+    #   @option params [String] :reverse                 ('false') If subscription index and unconfigured notification keys will be ordered as earliest first
+    #   @option params [String] :filtered_by_key         (nil)     Key of the subscription for filter
+    #   @return [Responce] JavaScript view for ajax request or redirects to back as default
+    def subscribe
+      @subscription.subscribe(with_email_subscription: params[:with_email_subscription].to_s.to_boolean(true))
+      return_back_or_ajax
+    end
+
+    # Unsubscribes to the notification.
+    #
+    # POST /:target_type/:target_id/subscriptions/:id/unsubscribe
+    # @overload open(params)
+    #   @param [Hash] params Request parameters
+    #   @option params [String] :filter          (nil)     Filter option to load subscription index (Nothing as all, 'configured' or 'unconfigured')
+    #   @option params [String] :limit           (nil)     Limit to query for subscriptions
+    #   @option params [String] :reverse         ('false') If subscription index and unconfigured notification keys will be ordered as earliest first
+    #   @option params [String] :filtered_by_key (nil)     Key of the subscription for filter
+    #   @return [Responce] JavaScript view for ajax request or redirects to back as default
+    def unsubscribe
+      @subscription.unsubscribe
+      return_back_or_ajax
+    end
+
+    # Subscribes to the notification email.
+    #
+    # POST /:target_type/:target_id/subscriptions/:id/subscribe_email
+    # @overload open(params)
+    #   @param [Hash] params Request parameters
+    #   @option params [String] :filter          (nil)     Filter option to load subscription index (Nothing as all, 'configured' or 'unconfigured')
+    #   @option params [String] :limit           (nil)     Limit to query for subscriptions
+    #   @option params [String] :reverse         ('false') If subscription index and unconfigured notification keys will be ordered as earliest first
+    #   @option params [String] :filtered_by_key (nil)     Key of the subscription for filter
+    #   @return [Responce] JavaScript view for ajax request or redirects to back as default
+    def subscribe_to_email
+      @subscription.subscribe_to_email
+      return_back_or_ajax
+    end
+
+    # Unsubscribes to the notification email.
+    #
+    # POST /:target_type/:target_id/subscriptions/:id/unsubscribe_email
+    # @overload open(params)
+    #   @param [Hash] params Request parameters
+    #   @option params [String] :filter          (nil)     Filter option to load subscription index (Nothing as all, 'configured' or 'unconfigured')
+    #   @option params [String] :limit           (nil)     Limit to query for subscriptions
+    #   @option params [String] :reverse         ('false') If subscription index and unconfigured notification keys will be ordered as earliest first
+    #   @option params [String] :filtered_by_key (nil)     Key of the subscription for filter
+    #   @return [Responce] JavaScript view for ajax request or redirects to back as default
+    def unsubscribe_to_email
+      @subscription.unsubscribe_to_email
+      return_back_or_ajax
+    end
+
+    protected
+
+      # Sets @subscription instance variable from request parameters.
+      # @api protected
+      # @return [Object] Subscription instance (Returns HTTP 403 when the target of subscription is different from specified target by request parameter)
+      def set_subscription
+        validate_target(@subscription = Subscription.includes(:target).find_by_id!(params[:id]))
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def subscription_params
+        params.require(:subscription).permit(:key, :subscribing, :subscribing_to_email)
+      end
+
+      # Sets options to load subscription index from request parameters.
+      # @api protected
+      # @return [Hash] options to load subscription 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
+        @index_options = params.permit(:filter, :filtered_by_key)
+                               .to_h.symbolize_keys.merge(limit: limit, reverse: reverse)
+      end
+
+      # Loads subscription index with request parameters.
+      # @api protected
+      # @return [Array] Array of subscription index
+      def load_index
+        case @index_options[:filter]
+        when :configured, 'configured'
+          @subscriptions = @target.subscription_index(@index_options.merge(with_target: true))
+          @notification_keys = nil
+        when :unconfigured, 'unconfigured'
+          @subscriptions = nil
+          @notification_keys = @target.notification_keys(@index_options.merge(filter: :unconfigured))
+        else
+          @subscriptions = @target.subscription_index(@index_options.merge(with_target: true))
+          @notification_keys = @target.notification_keys(@index_options.merge(filter: :unconfigured))
+        end
+      end
+
+      # Returns controller path.
+      # This method is called from target_view_path method and can be overriden.
+      # @api protected
+      # @return [String] "activity_notification/subscriptions" as controller path
+      def controller_path
+        "activity_notification/subscriptions"
+      end
+
+  end
+end