activity_notification 2.1.3 → 2.1.4

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

@@ -90,15 +90,15 @@ module ActivityNotification
                   }
                 }
                 key :example, {
-                  "action_cable_channel": {
-                    "subscribing": true,
-                    "subscribed_at": Time.current,
-                    "unsubscribed_at": nil
+                  action_cable_channel:  {
+                    subscribing:  true,
+                    subscribed_at:  Time.current,
+                    unsubscribed_at:  nil
                   },
-                  "slack": {
-                    "subscribing": false,
-                    "subscribed_at": nil,
-                    "unsubscribed_at": Time.current
+                  slack:  {
+                    subscribing:  false,
+                    subscribed_at:  nil,
+                    unsubscribed_at:  Time.current
                   }
                 }
               end
@@ -114,11 +114,11 @@ module ActivityNotification
                 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
+                  id:  1,
+                  email:  "ichiro@example.com",
+                  name:  "Ichiro",
+                  created_at:  Time.current,
+                  updated_at:  Time.current
                 }
               end
             end
@@ -145,11 +145,11 @@ module ActivityNotification
                   }
                 }
                 key :example, {
-                  "action_cable_channel": {
-                    "subscribing": true
+                  action_cable_channel:  {
+                    subscribing:  true
                   },
-                  "slack": {
-                    "subscribing": false
+                  slack:  {
+                    subscribing:  false
                   }
                 }
               end

data/lib/activity_notification/optional_targets/action_cable_api_channel.rb

@@ -26,7 +26,7 @@ module ActivityNotification
       # @return [Boolean] Whether Action Cable notification API is allowed
       def notification_action_cable_api_allowed?(notification)
         notification.target.notification_action_cable_allowed?(notification.notifiable, notification.key) &&
-          notification.notifiable.notification_action_cable_api_allowed?(notification.target, notification.key)
+          notification.notifiable.notifiable_action_cable_api_allowed?(notification.target, notification.key)
       end
 
       # Format message to broadcast

data/lib/activity_notification/optional_targets/action_cable_channel.rb

@@ -44,7 +44,7 @@ module ActivityNotification
       # @return [Boolean] Whether Action Cable notification is allowed
       def notification_action_cable_allowed?(notification)
         notification.target.notification_action_cable_allowed?(notification.notifiable, notification.key) &&
-          notification.notifiable.notification_action_cable_allowed?(notification.target, notification.key)
+          notification.notifiable.notifiable_action_cable_allowed?(notification.target, notification.key)
       end
 
       # Format message to broadcast

data/lib/activity_notification/orm/dynamoid.rb

@@ -22,8 +22,8 @@ module ActivityNotification
         association_name     = name.to_s.singularize.underscore
         composite_field = "#{association_name}_key".to_sym
         field composite_field, :string
-        associated_record_field = "#{association_name}_record".to_sym
-        field associated_record_field, :string if ActivityNotification.config.store_with_associated_records && _options[:store_with_associated_records]
+        associated_record_field = "stored_#{association_name}".to_sym
+        field associated_record_field, :raw if ActivityNotification.config.store_with_associated_records && _options[:store_with_associated_records]
 
         self.instance_eval do
           define_method(name) do |reload = false|
@@ -43,7 +43,14 @@ module ActivityNotification
               self.send("#{composite_field}=", nil)
             else
               self.send("#{composite_field}=", "#{new_instance.class.name}#{ActivityNotification.config.composite_key_delimiter}#{new_instance.id}")
-              self.send("#{associated_record_field}=", new_instance.to_json) if ActivityNotification.config.store_with_associated_records && _options[:store_with_associated_records]
+              associated_record_json = new_instance.as_json(_options[:as_json_options] || {})
+              # Cast Time and DateTime field to String to handle Dynamoid unsupported type error
+              if associated_record_json.present?
+                associated_record_json.each do |k, v|
+                  associated_record_json[k] = v.to_s if v.is_a?(Time) || v.is_a?(DateTime)
+                end
+              end
+              self.send("#{associated_record_field}=", associated_record_json) if ActivityNotification.config.store_with_associated_records && _options[:store_with_associated_records]
             end
             self.instance_variable_set("@#{name}", nil)
           end

data/lib/activity_notification/orm/dynamoid/notification.rb

@@ -20,17 +20,17 @@ module ActivityNotification
         # Belongs to target instance of this notification as polymorphic association using composite key.
         # @scope instance
         # @return [Object] Target instance of this notification
-        belongs_to_composite_xdb_record :target, store_with_associated_records: true
+        belongs_to_composite_xdb_record :target, store_with_associated_records: true, as_json_options: { methods: [:printable_type, :printable_target_name] }
 
         # Belongs to notifiable instance of this notification as polymorphic association using composite key.
         # @scope instance
         # @return [Object] Notifiable instance of this notification
-        belongs_to_composite_xdb_record :notifiable, store_with_associated_records: true
+        belongs_to_composite_xdb_record :notifiable, store_with_associated_records: true, as_json_options: { methods: [:printable_type] }
 
         # Belongs to group instance of this notification as polymorphic association using composite key.
         # @scope instance
         # @return [Object] Group instance of this notification
-        belongs_to_composite_xdb_record :group
+        belongs_to_composite_xdb_record :group, store_with_associated_records: true, as_json_options: { methods: [:printable_type, :printable_group_name] }
 
         field :key,            :string
         field :parameters,     :raw,      default: {}
@@ -64,14 +64,54 @@ module ActivityNotification
         # Belongs to :otifier instance of this notification.
         # @scope instance
         # @return [Object] Notifier instance of this notification
-        belongs_to_composite_xdb_record :notifier, store_with_associated_records: true
+        belongs_to_composite_xdb_record :notifier, store_with_associated_records: true, as_json_options: { methods: [:printable_type, :printable_notifier_name] }
+
+        # Additional fields to store from instance method when config.store_with_associated_records is enabled
+        if ActivityNotification.config.store_with_associated_records
+          field :stored_notifiable_path,             :string
+          field :stored_printable_notifiable_name,   :string
+          field :stored_group_member_notifier_count, :integer
+          field :stored_group_notification_count,    :integer
+          field :stored_group_members,               :array
+
+          # Returns prepared notification object to store
+          # @return [Object] prepared notification object to store
+          def prepare_to_store
+            self.stored_notifiable_path           = notifiable_path
+            self.stored_printable_notifiable_name = printable_notifiable_name
+            if group_owner?
+              self.stored_group_notification_count    = 0
+              self.stored_group_member_notifier_count = 0
+              self.stored_group_members               = []
+            end
+            self
+          end
+
+          # Call after store action with stored notification
+          def after_store
+            if group_owner?
+              self.stored_group_notification_count    = group_notification_count
+              self.stored_group_member_notifier_count = group_member_notifier_count
+              self.stored_group_members               = group_members.as_json
+              self.stored_group_members.each do |group_member|
+                # Cast Time and DateTime field to String to handle Dynamoid unsupported type error
+                group_member.each do |k, v|
+                  group_member[k] = v.to_s if v.is_a?(Time) || v.is_a?(DateTime)
+                end
+              end
+              save
+            else
+              group_owner.after_store
+            end
+          end
+        end
 
         # Mandatory global secondary index to query effectively
-        global_secondary_index hash_key: :target_key,     range_key: :created_at, projected_attributes: :all
-        global_secondary_index hash_key: :group_owner_id, range_key: :created_at, projected_attributes: :all
+        global_secondary_index name: :index_target_key_created_at,     hash_key: :target_key,     range_key: :created_at, projected_attributes: :all
+        global_secondary_index name: :index_group_owner_id_created_at, hash_key: :group_owner_id, range_key: :created_at, projected_attributes: :all
         # Optional global secondary index to sort by created_at
-        global_secondary_index hash_key: :notifier_key,   range_key: :created_at, projected_attributes: :all
-        global_secondary_index hash_key: :notifiable_key, range_key: :created_at, projected_attributes: :all
+        global_secondary_index name: :index_notifier_key_created_at,   hash_key: :notifier_key,   range_key: :created_at, projected_attributes: :all
+        global_secondary_index name: :index_notifiable_key_created_at, hash_key: :notifiable_key, range_key: :created_at, projected_attributes: :all
 
         validates  :target,     presence: true
         validates  :notifiable, presence: true
@@ -122,11 +162,6 @@ module ActivityNotification
           raise ActivityNotification::DeleteRestrictionError, error_text
         end
 
-        # Returns prepared notification object to store
-        # @return [Object] prepared notification object to store
-        # def prepare_to_store
-        # end
-
         protected
 
           # Returns count of group members of the unopened notification.

data/lib/activity_notification/orm/dynamoid/subscription.rb

@@ -28,7 +28,7 @@ module ActivityNotification
         field :unsubscribed_to_email_at,  :datetime
         field :optional_targets,          :raw,     default: {}
 
-        global_secondary_index hash_key: :target_key, range_key: :created_at, projected_attributes: :all
+        global_secondary_index name: :index_target_key_created_at, hash_key: :target_key, range_key: :created_at, projected_attributes: :all
 
         validates  :target,               presence: true
         validates  :key,                  presence: true, uniqueness: { scope: :target_key }

data/lib/activity_notification/orm/mongoid.rb

@@ -24,8 +24,8 @@ module ActivityNotification
         id_field, type_field = "#{association_name}_id", "#{association_name}_type"
         field id_field,   type: String
         field type_field, type: String
-        associated_record_field = "#{association_name}_record"
-        field associated_record_field, type: String if ActivityNotification.config.store_with_associated_records && _options[:store_with_associated_records]
+        associated_record_field = "stored_#{association_name}"
+        field associated_record_field, type: Hash if ActivityNotification.config.store_with_associated_records && _options[:store_with_associated_records]
 
         self.instance_eval do
           define_method(name) do |reload = false|
@@ -43,7 +43,14 @@ module ActivityNotification
             if new_instance.nil? then instance_id, instance_type = nil, nil else instance_id, instance_type = new_instance.id, new_instance.class.name end
             self.send("#{id_field}=", instance_id)
             self.send("#{type_field}=", instance_type)
-            self.send("#{associated_record_field}=", new_instance.to_json) if ActivityNotification.config.store_with_associated_records && _options[:store_with_associated_records]
+            associated_record_json = new_instance.as_json(_options[:as_json_options] || {})
+            # Cast Hash $oid field to String id to handle BSON::String::IllegalKey
+            if associated_record_json.present?
+              associated_record_json.each do |k, v|
+                associated_record_json[k] = v['$oid'] if v.is_a?(Hash) && v.has_key?('$oid')
+              end
+            end
+            self.send("#{associated_record_field}=", associated_record_json) if ActivityNotification.config.store_with_associated_records && _options[:store_with_associated_records]
             self.instance_variable_set("@#{name}", nil)
           end
         end

data/lib/activity_notification/orm/mongoid/notification.rb

@@ -19,17 +19,17 @@ module ActivityNotification
         # Belongs to target instance of this notification as polymorphic association.
         # @scope instance
         # @return [Object] Target instance of this notification
-        belongs_to_polymorphic_xdb_record :target, store_with_associated_records: true
+        belongs_to_polymorphic_xdb_record :target, store_with_associated_records: true, as_json_options: { methods: [:printable_type, :printable_target_name] }
 
         # Belongs to notifiable instance of this notification as polymorphic association.
         # @scope instance
         # @return [Object] Notifiable instance of this notification
-        belongs_to_polymorphic_xdb_record :notifiable, store_with_associated_records: true
+        belongs_to_polymorphic_xdb_record :notifiable, store_with_associated_records: true, as_json_options: { methods: [:printable_type] }
 
         # Belongs to group instance of this notification as polymorphic association.
         # @scope instance
         # @return [Object] Group instance of this notification
-        belongs_to_polymorphic_xdb_record :group
+        belongs_to_polymorphic_xdb_record :group, as_json_options: { methods: [:printable_type, :printable_group_name] }
 
         field :key,            type: String
         field :parameters,     type: Hash,     default: {}
@@ -53,7 +53,7 @@ module ActivityNotification
         # Belongs to :otifier instance of this notification.
         # @scope instance
         # @return [Object] Notifier instance of this notification
-        belongs_to_polymorphic_xdb_record :notifier, store_with_associated_records: true
+        belongs_to_polymorphic_xdb_record :notifier, store_with_associated_records: true, as_json_options: { methods: [:printable_type, :printable_notifier_name] }
 
         validates  :target,        presence: true
         validates  :notifiable,    presence: true

data/lib/activity_notification/roles/acts_as_notifiable.rb

@@ -265,7 +265,8 @@ module ActivityNotification
 
         options[:printable_notifiable_name] ||= options.delete(:printable_name)
         configured_params
-          .merge set_acts_as_parameters_for_target(target_type, [:targets, :group, :group_expiry_delay, :parameters, :email_allowed, :action_cable_allowed, :action_cable_api_allowed], options, "notification_")
+          .merge set_acts_as_parameters_for_target(target_type, [:targets, :group, :group_expiry_delay, :parameters, :email_allowed], options, "notification_")
+          .merge set_acts_as_parameters_for_target(target_type, [:action_cable_allowed, :action_cable_api_allowed], options, "notifiable_")
           .merge set_acts_as_parameters_for_target(target_type, [:notifier, :notifiable_path, :printable_notifiable_name, :optional_targets], options)
       end
 

data/lib/activity_notification/version.rb

@@ -1,3 +1,3 @@
 module ActivityNotification
-  VERSION = "2.1.3"
+  VERSION = "2.1.4"
 end

data/spec/concerns/models/notifiable_spec.rb

@@ -21,7 +21,7 @@ shared_examples_for :notifiable do
         expect(described_class._notifier).to                        eq({})
         expect(described_class._notification_parameters).to         eq({})
         expect(described_class._notification_email_allowed).to      eq({})
-        expect(described_class._notification_action_cable_allowed).to      eq({})
+        expect(described_class._notifiable_action_cable_allowed).to eq({})
         expect(described_class._notifiable_path).to                 eq({})
         expect(described_class._printable_notifiable_name).to       eq({})
       end
@@ -410,130 +410,130 @@ shared_examples_for :notifiable do
       end
     end
 
-    describe "#notification_action_cable_allowed?" do
+    describe "#notifiable_action_cable_allowed?" do
       context "without any configuration" do
         it "returns ActivityNotification.config.action_cable_enabled" do
-          expect(test_instance.notification_action_cable_allowed?(test_target, 'dummy_key'))
+          expect(test_instance.notifiable_action_cable_allowed?(test_target, 'dummy_key'))
             .to eq(ActivityNotification.config.action_cable_enabled)
         end
 
         it "returns false as default" do
-          expect(test_instance.notification_action_cable_allowed?(test_target, 'dummy_key')).to be_falsey
+          expect(test_instance.notifiable_action_cable_allowed?(test_target, 'dummy_key')).to be_falsey
         end
       end
 
       context "configured with overridden method" do
         it "returns specified value" do
           module AdditionalMethods
-            def notification_action_cable_allowed_for_users?(target, key)
+            def notifiable_action_cable_allowed_for_users?(target, key)
               true
             end
           end
           test_instance.extend(AdditionalMethods)
-          expect(test_instance.notification_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
+          expect(test_instance.notifiable_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
         end
       end
 
       context "configured with a field" do
         it "returns specified value" do
-          described_class._notification_action_cable_allowed[:users] = true
-          expect(test_instance.notification_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
+          described_class._notifiable_action_cable_allowed[:users] = true
+          expect(test_instance.notifiable_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
         end
 
         it "returns specified symbol without arguments" do
           module AdditionalMethods
-            def custom_notification_action_cable_allowed?
+            def custom_notifiable_action_cable_allowed?
               true
             end
           end
           test_instance.extend(AdditionalMethods)
-          described_class._notification_action_cable_allowed[:users] = :custom_notification_action_cable_allowed?
-          expect(test_instance.notification_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
+          described_class._notifiable_action_cable_allowed[:users] = :custom_notifiable_action_cable_allowed?
+          expect(test_instance.notifiable_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
         end
 
         it "returns specified symbol with target and key arguments" do
           module AdditionalMethods
-            def custom_notification_action_cable_allowed?(target, key)
+            def custom_notifiable_action_cable_allowed?(target, key)
               true
             end
           end
           test_instance.extend(AdditionalMethods)
-          described_class._notification_action_cable_allowed[:users] = :custom_notification_action_cable_allowed?
-          expect(test_instance.notification_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
+          described_class._notifiable_action_cable_allowed[:users] = :custom_notifiable_action_cable_allowed?
+          expect(test_instance.notifiable_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
         end
 
         it "returns specified lambda with single notifiable argument" do
-          described_class._notification_action_cable_allowed[:users] = ->(notifiable){ true }
-          expect(test_instance.notification_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
+          described_class._notifiable_action_cable_allowed[:users] = ->(notifiable){ true }
+          expect(test_instance.notifiable_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
         end
 
         it "returns specified lambda with notifiable, target and key arguments" do
-          described_class._notification_action_cable_allowed[:users] = ->(notifiable, target, key){ true }
-          expect(test_instance.notification_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
+          described_class._notifiable_action_cable_allowed[:users] = ->(notifiable, target, key){ true }
+          expect(test_instance.notifiable_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
         end
       end
     end
 
-    describe "#notification_action_cable_api_allowed?" do
+    describe "#notifiable_action_cable_api_allowed?" do
       context "without any configuration" do
         it "returns ActivityNotification.config.action_cable_api_enabled" do
-          expect(test_instance.notification_action_cable_api_allowed?(test_target, 'dummy_key'))
+          expect(test_instance.notifiable_action_cable_api_allowed?(test_target, 'dummy_key'))
             .to eq(ActivityNotification.config.action_cable_api_enabled)
         end
 
         it "returns false as default" do
-          expect(test_instance.notification_action_cable_api_allowed?(test_target, 'dummy_key')).to be_falsey
+          expect(test_instance.notifiable_action_cable_api_allowed?(test_target, 'dummy_key')).to be_falsey
         end
       end
 
       context "configured with overridden method" do
         it "returns specified value" do
           module AdditionalMethods
-            def notification_action_cable_api_allowed_for_users?(target, key)
+            def notifiable_action_cable_api_allowed_for_users?(target, key)
               true
             end
           end
           test_instance.extend(AdditionalMethods)
-          expect(test_instance.notification_action_cable_api_allowed?(test_target, 'dummy_key')).to eq(true)
+          expect(test_instance.notifiable_action_cable_api_allowed?(test_target, 'dummy_key')).to eq(true)
         end
       end
 
       context "configured with a field" do
         it "returns specified value" do
-          described_class._notification_action_cable_api_allowed[:users] = true
-          expect(test_instance.notification_action_cable_api_allowed?(test_target, 'dummy_key')).to eq(true)
+          described_class._notifiable_action_cable_api_allowed[:users] = true
+          expect(test_instance.notifiable_action_cable_api_allowed?(test_target, 'dummy_key')).to eq(true)
         end
 
         it "returns specified symbol without arguments" do
           module AdditionalMethods
-            def custom_notification_action_cable_api_allowed?
+            def custom_notifiable_action_cable_api_allowed?
               true
             end
           end
           test_instance.extend(AdditionalMethods)
-          described_class._notification_action_cable_api_allowed[:users] = :custom_notification_action_cable_api_allowed?
-          expect(test_instance.notification_action_cable_api_allowed?(test_target, 'dummy_key')).to eq(true)
+          described_class._notifiable_action_cable_api_allowed[:users] = :custom_notifiable_action_cable_api_allowed?
+          expect(test_instance.notifiable_action_cable_api_allowed?(test_target, 'dummy_key')).to eq(true)
         end
 
         it "returns specified symbol with target and key arguments" do
           module AdditionalMethods
-            def custom_notification_action_cable_api_allowed?(target, key)
+            def custom_notifiable_action_cable_api_allowed?(target, key)
               true
             end
           end
           test_instance.extend(AdditionalMethods)
-          described_class._notification_action_cable_api_allowed[:users] = :custom_notification_action_cable_api_allowed?
-          expect(test_instance.notification_action_cable_api_allowed?(test_target, 'dummy_key')).to eq(true)
+          described_class._notifiable_action_cable_api_allowed[:users] = :custom_notifiable_action_cable_api_allowed?
+          expect(test_instance.notifiable_action_cable_api_allowed?(test_target, 'dummy_key')).to eq(true)
         end
 
         it "returns specified lambda with single notifiable argument" do
-          described_class._notification_action_cable_api_allowed[:users] = ->(notifiable){ true }
-          expect(test_instance.notification_action_cable_api_allowed?(test_target, 'dummy_key')).to eq(true)
+          described_class._notifiable_action_cable_api_allowed[:users] = ->(notifiable){ true }
+          expect(test_instance.notifiable_action_cable_api_allowed?(test_target, 'dummy_key')).to eq(true)
         end
 
         it "returns specified lambda with notifiable, target and key arguments" do
-          described_class._notification_action_cable_api_allowed[:users] = ->(notifiable, target, key){ true }
-          expect(test_instance.notification_action_cable_api_allowed?(test_target, 'dummy_key')).to eq(true)
+          described_class._notifiable_action_cable_api_allowed[:users] = ->(notifiable, target, key){ true }
+          expect(test_instance.notifiable_action_cable_api_allowed?(test_target, 'dummy_key')).to eq(true)
         end
       end
     end