activity_notification 2.0.0 → 2.1.0

data/lib/activity_notification/controllers/concerns/swagger/subscriptions_parameters.rb

@@ -0,0 +1,50 @@
+module ActivityNotification
+  module Swagger::SubscriptionsParameters #:nodoc:
+    module TargetParameters #:nodoc:
+      def self.extended(base)
+        base.parameter do
+          key :name, :target_type
+          key :in, :path
+          key :description, "Target type of subscriptions: e.g. 'users'"
+          key :required, true
+          key :type, :string
+          key :example, "users"
+        end
+        base.parameter do
+          key :name, :target_id
+          key :in, :path
+          key :description, "Target ID of subscriptions. This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs."
+          key :required, true
+          key :type, :string
+          key :example, 1
+        end
+      end
+    end
+
+    module IdParameter #:nodoc:
+      def self.extended(base)
+        base.parameter do
+          key :name, :id
+          key :in, :path
+          key :description, 'ID of subscription record. This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs.'
+          key :required, true
+          key :type, :string
+          key :example, 123
+        end
+      end
+    end
+
+    module FilterByParameters #:nodoc:
+      def self.extended(base)
+        base.parameter do
+          key :name, :filtered_by_key
+          key :in, :query
+          key :description, "Key of subscriptions to filter subscription index: e.g. 'comment.default'"
+          key :required, false
+          key :type, :string
+          key :example, "comment.default"
+        end
+      end
+    end
+  end
+end

data/lib/activity_notification/controllers/devise_authentication_controller.rb

@@ -2,6 +2,7 @@ module ActivityNotification
   # Module included in controllers to authenticate with Devise module
   module DeviseAuthenticationController
     extend ActiveSupport::Concern
+    include CommonController
 
     included do
       prepend_before_action :authenticate_devise_resource!
@@ -13,17 +14,17 @@ module ActivityNotification
       # 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
+      # @return [Response] 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
+            render status: 403, json: error_response(code: 403, message: "Unauthenticated with Devise")
           end
         else
-          render plain: "400 Bad Request: Missing parameter", status: 400
+          render status: 400, json: error_response(code: 400, message: "Invalid parameter", type: "Missing devise_type")
         end
       end
 
@@ -38,7 +39,7 @@ module ActivityNotification
           target_class = target_type.to_model_class
           current_resource_method_name = "current_#{params[:devise_type].to_resource_name}"
           params[:target_id] = target_class.resolve_current_devise_target(send(current_resource_method_name))
-          render(plain: "403 Forbidden: Unauthenticated as default target", status: 403) and return if params[:target_id].blank?
+          render status: 403, json: error_response(code: 403, message: "Unauthenticated as default target") and return if params[:target_id].blank?
         end
         super
       end
@@ -46,11 +47,11 @@ module ActivityNotification
       # 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
+      # @return [Response] 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
+          render status: 403, json: error_response(code: 403, message: "Unauthorized target")
         end
       end
   end

data/lib/activity_notification/gem_version.rb

@@ -0,0 +1,14 @@
+module ActivityNotification
+  # Returns the version of the currently loaded ActivityNotification as a Gem::Version
+  def self.gem_version
+    Gem::Version.new VERSION
+  end
+
+  # Manages individual gem version from Gem::Version
+  module GEM_VERSION
+    MAJOR = VERSION.split(".")[0]
+    MINOR = VERSION.split(".")[1]
+    TINY  = VERSION.split(".")[2]
+    PRE   = VERSION.split(".")[3]
+  end
+end

data/lib/activity_notification/helpers/errors.rb

@@ -1,4 +1,6 @@
 module ActivityNotification
   class ConfigError < StandardError; end
   class DeleteRestrictionError < StandardError; end
+  class NotifiableNotFoundError < StandardError; end
+  class RecordInvalidError < StandardError; end
 end

data/lib/activity_notification/helpers/view_helpers.rb

@@ -13,6 +13,8 @@ module ActivityNotification
     # @option options [String]         :layout       (nil)                     Layout template name
     # @option options [String]         :layout_root  ('layouts')               Root path of layout template
     # @option options [String, Symbol] :fallback     (nil)                     Fallback template to use when MissingTemplate is raised. Set :text to use i18n text as fallback.
+    # @option options [Hash]           :assigns      (nil)                     Parameters to be set as assigns
+    # @option options [Hash]           :locals       (nil)                     Parameters to be set as locals
     # @return [String] Rendered view or text as string
     def render_notification(notifications, options = {})
       if notifications.is_a? ActivityNotification::Notification
@@ -51,6 +53,8 @@ module ActivityNotification
     # @option options [String]         :filtered_by_group_type (nil)       Group type for filter, valid with :filtered_by_group_id
     # @option options [String]         :filtered_by_group_id   (nil)       Group instance id for filter, valid with :filtered_by_group_type
     # @option options [String]         :filtered_by_key        (nil)       Key of the notification for filter
+    # @option options [String]         :later_than             (nil)       ISO 8601 format time to filter notification index later than specified time
+    # @option options [String]         :earlier_than           (nil)       ISO 8601 format time to filter notification index earlier than specified time
     # @option options [Array]          :custom_filter          (nil)       Custom notification filter (e.g. ["created_at >= ?", time.hour.ago])
     # @return [String] Rendered view or text as string
     def render_notification_of(target, options = {})

data/lib/activity_notification/mailers/helpers.rb

@@ -58,21 +58,28 @@ module ActivityNotification
              @notification.notifiable.overriding_notification_email_key(@target, key).present?
             key = @notification.notifiable.overriding_notification_email_key(@target, key)
           end
-          if @notification.notifiable.respond_to?(:overriding_notification_email_subject) &&
-              @notification.notifiable.overriding_notification_email_subject(@target, key).present?
-            subject = @notification.notifiable.overriding_notification_email_subject(@target, key)
-          else
-            subject = subject_for(key)
-          end
           headers = {
-            subject: subject,
             to: mailer_to(@target),
-            from: mailer_from(key),
-            reply_to: mailer_reply_to(key),
             template_path: template_paths,
             template_name: template_name(key)
           }.merge(options)
-  
+          {
+            subject: :subject_for,
+            from: :mailer_from,
+            reply_to: :mailer_reply_to,
+            message_id: nil
+          }.each do |header_name, default_method|
+            overridding_method_name = "overriding_notification_email_#{header_name.to_s}"
+            header_value = if @notification.notifiable.respond_to?(overridding_method_name) &&
+                @notification.notifiable.send(overridding_method_name, @target, key).present?
+              @notification.notifiable.send(overridding_method_name, @target, key)
+            elsif default_method
+              send(default_method, key)
+            else
+              nil
+            end
+            headers[header_name] = header_value if header_value
+          end
           @email = headers[:to]
           headers
         end

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

@@ -26,6 +26,7 @@ module ActivityNotification
                       :_notification_parameters,
                       :_notification_email_allowed,
                       :_notification_action_cable_allowed,
+                      :_notification_action_cable_api_allowed,
                       :_notifiable_path,
                       :_printable_notifiable_name,
                       :_optional_targets
@@ -48,16 +49,17 @@ module ActivityNotification
       # Sets default values to notifiable class fields.
       # @return [NilClass] nil
       def set_notifiable_class_defaults
-        self._notification_targets              = {}
-        self._notification_group                = {}
-        self._notification_group_expiry_delay   = {}
-        self._notifier                          = {}
-        self._notification_parameters           = {}
-        self._notification_email_allowed        = {}
-        self._notification_action_cable_allowed = {}
-        self._notifiable_path                   = {}
-        self._printable_notifiable_name         = {}
-        self._optional_targets                  = {}
+        self._notification_targets                  = {}
+        self._notification_group                    = {}
+        self._notification_group_expiry_delay       = {}
+        self._notifier                              = {}
+        self._notification_parameters               = {}
+        self._notification_email_allowed            = {}
+        self._notification_action_cable_allowed     = {}
+        self._notification_action_cable_api_allowed = {}
+        self._notifiable_path                       = {}
+        self._printable_notifiable_name             = {}
+        self._optional_targets                      = {}
         nil
       end
     end
@@ -168,6 +170,20 @@ module ActivityNotification
         target, key)
     end
 
+    # Returns if publishing WebSocket API using ActionCable is allowed for the notifiable from configured field or overridden method.
+    # This method is able to be overridden.
+    #
+    # @param [Object] target Target instance to notify
+    # @param [String] key Key of the notification
+    # @return [Boolean] If publishing WebSocket API using ActionCable is allowed for the notifiable
+    def notification_action_cable_api_allowed?(target, key = nil)
+      resolve_parameter(
+        "notification_action_cable_api_allowed_for_#{cast_to_resources_name(target.class)}?",
+        _notification_action_cable_api_allowed[cast_to_resources_sym(target.class)],
+        ActivityNotification.config.action_cable_api_enabled,
+        target, key)
+    end
+
     # Returns notifiable_path to move after opening notification from configured field or overridden method.
     # This method is able to be overridden.
     #

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

@@ -46,8 +46,19 @@ module ActivityNotification
     # Creates new subscription of the target.
     #
     # @param [Hash] subscription_params Parameters to create subscription record
+    # @raise [ActivityNotification::RecordInvalidError] Failed to save subscription due to model validation
     # @return [Subscription] Created subscription instance
     def create_subscription(subscription_params = {})
+      subscription = build_subscription(subscription_params)
+      raise RecordInvalidError, subscription.errors.full_messages.first unless subscription.save
+      subscription
+    end
+
+    # Builds new subscription of the target.
+    #
+    # @param [Hash] subscription_params Parameters to build subscription record
+    # @return [Subscription] Built subscription instance
+    def build_subscription(subscription_params = {})
       created_at = Time.current
       if subscription_params[:subscribing] == false && subscription_params[:subscribing_to_email].nil?
         subscription_params[:subscribing_to_email] = subscription_params[:subscribing] 
@@ -74,7 +85,7 @@ module ActivityNotification
           )
       end
       subscription.assign_attributes(optional_targets: optional_targets)
-      subscription.save ? subscription : nil
+      subscription
     end
 
     # Gets configured subscription index of the target.

data/lib/activity_notification/models/concerns/swagger/error_schema.rb

@@ -0,0 +1,36 @@
+module ActivityNotification
+  module Swagger::ErrorSchema #:nodoc:
+    extend ActiveSupport::Concern
+    include ::Swagger::Blocks
+
+    included do
+      swagger_component do
+        schema :Error do
+          key :required, [:gem, :error]
+          property :gem do
+            key :type, :string
+            key :description, "Name of gem generating this error"
+            key :default, "activity_notification"
+            key :example, "activity_notification"
+          end
+          property :error do
+            key :type, :object
+            key :description, "Error information"
+            property :code do
+              key :type, :integer
+              key :description, "Error code: default value is HTTP status code"
+            end
+            property :message do
+              key :type, :string
+              key :description, "Error message"
+            end
+            property :type do
+              key :type, :string
+              key :description, "Error type describing error message"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activity_notification/models/concerns/swagger/notification_schema.rb

@@ -0,0 +1,209 @@
+module ActivityNotification
+  module Swagger::NotificationSchema #:nodoc:
+    extend ActiveSupport::Concern
+    include ::Swagger::Blocks
+  
+    included do
+      swagger_component do
+        schema :NotificationAttributes do
+          key :type, :object
+          property :id do
+            key :oneOf, [
+              { type: :integer },
+              { type: :string }
+            ]
+            key :description, "This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs."
+            key :example, 123
+          end
+          property :target_type do
+            key :type, :string
+            key :example, "User"
+          end
+          property :target_id do
+            key :oneOf, [
+              { type: :integer },
+              { type: :string }
+            ]
+            key :description, "This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs."
+            key :example, 1
+          end
+          property :notifiable_type do
+            key :type, :string
+            key :example, "Comment"
+          end
+          property :notifiable_id do
+            key :oneOf, [
+              { type: :integer },
+              { type: :string }
+            ]
+            key :description, "This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs."
+            key :example, 22
+          end
+          property :key do
+            key :type, :string
+            key :example, "comment.default"
+          end
+          property :group_type do
+            key :type, :string
+            key :nullable, true
+            key :example, "Article"
+          end
+          property :group_id do
+            key :oneOf, [
+              { type: :integer },
+              { type: :string },
+              { nullable: true }
+            ]
+            key :description, "This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs."
+            key :nullable, true
+            key :example, 11
+          end
+          property :group_owner_id do
+            key :oneOf, [
+              { type: :integer },
+              { type: :string },
+              { type: :object },
+              { nullable: true }
+            ]
+            key :description, "This parameter type is integer with ActiveRecord, but will be string or object including $oid with Mongoid or Dynamoid ORMs."
+            key :nullable, true
+            key :example, 123
+          end
+          property :notifier_type do
+            key :type, :string
+            key :nullable, true
+            key :example, "User"
+          end
+          property :notifier_id do
+            key :oneOf, [
+              { type: :integer },
+              { type: :string },
+              { nullable: true }
+            ]
+            key :description, "This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs."
+            key :nullable, true
+            key :example, 2
+          end
+          property :parameters do
+            key :type, :object
+            key :additionalProperties, {
+              type: :string
+            }
+            key :example, {
+              "test_default_param": "1"
+            }
+          end
+          property :opened_at do
+            key :type, :string
+            key :format, :'date-time'
+            key :nullable, true
+          end
+          property :created_at do
+            key :type, :string
+            key :format, :'date-time'
+          end
+          property :updated_at do
+            key :type, :string
+            key :format, :'date-time'
+          end
+        end
+
+        schema :Notification do
+          key :type, :object
+          key :required, [ :id, :target_type, :target_id, :notifiable_type, :notifiable_id, :key, :created_at, :updated_at, :target, :notifiable ]
+          allOf do
+            schema do
+              key :'$ref', :NotificationAttributes
+            end
+            schema do
+              key :type, :object
+              property :notifiable_path do
+                key :type, :string
+                key :format, :uri
+                key :example, "/articles/11"
+              end
+              property :printable_notifiable_name do
+                key :type, :string
+                key :format, :uri
+                key :example, "comment \"This is the first Stephen's comment to Ichiro's article.\""
+              end
+              property :group_member_notifier_count do
+                key :type, :integer
+                key :example, 1
+              end
+              property :group_notification_count do
+                key :type, :integer
+                key :example, 2
+              end
+              property :target do
+                key :type, :object
+                key :description, "Associated target model in your application"
+                key :example, {
+                  "id": 1,
+                  "email": "ichiro@example.com",
+                  "name": "Ichiro",
+                  "created_at": Time.current,
+                  "updated_at": Time.current,
+                  "provider": "email",
+                  "uid": "",
+                  "printable_type": "User",
+                  "printable_target_name": "Ichiro"
+                }
+              end
+              property :notifiable do
+                key :type, :object
+                key :description, "Associated notifiable model in your application"
+                key :example, {
+                  "id": 22,
+                  "user_id": 2,
+                  "article_id": 11,
+                  "body": "This is the first Stephen's comment to Ichiro's article.",
+                  "created_at": Time.current,
+                  "updated_at": Time.current,
+                  "printable_type": "Comment"
+              }
+              end
+              property :group do
+                key :type, :object
+                key :description, "Associated group model in your application"
+                key :nullable, true
+                key :example, {
+                  "id": 11,
+                  "user_id": 4,
+                  "title": "Ichiro's great article",
+                  "body": "This is Ichiro's great article. Please read it!",
+                  "created_at": Time.current,
+                  "updated_at": Time.current,
+                  "printable_type": "Article",
+                  "printable_group_name": "article \"Ichiro's great article\""
+                }
+              end
+              property :notifier do
+                key :type, :object
+                key :description, "Associated notifier model in your application"
+                key :nullable, true
+                key :example, {
+                  "id": 2,
+                  "email": "stephen@example.com",
+                  "name": "Stephen",
+                  "created_at": Time.current,
+                  "updated_at": Time.current,
+                  "provider": "email",
+                  "uid": "",
+                  "printable_type": "User",
+                  "printable_notifier_name": "Stephen"
+                }
+              end
+              property :group_members do
+                key :type, :array
+                items do
+                  key :'$ref', :NotificationAttributes
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end