activity_notification 2.1.3 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a517c56b317fe1705d3666039793aee93ed55c77c2493b70018eb1da4268f97
-  data.tar.gz: ba26afa004950dc8ec175abb6f36a948014f3ff7be81b8d185665f25f22137fe
+  metadata.gz: c77b0e25a955b70ea7753d4591e26eebaa5d8ac3ebd858fc0dbb1457a1443543
+  data.tar.gz: c3f39d43832aca955a9904cc9918ba247bc34b32fb5b9e2a99efdd11fb04fea5
 SHA512:
-  metadata.gz: 88b587552a4c2e1bfeda92759b44f7611309409b3bfb11c7a777739a30e3af4f28f96d532b39c42edfed0b07de274239014d6d117590f51dc1ac09fc8898e8de
-  data.tar.gz: c9e40bf9e14e6c5c0f4898161748e2ab07e9b1e95c8fbb2daaf151a5d94bab9727280f840216c7375819aac2f6564659d9fa9b05ce8a320dd2e3c7b42269acb3
+  metadata.gz: 4ff3b5496a2f94cdc794c5fac124cdeb749738eb3b244f58e4622882dfbfdcddeb35518f41d7f801ad0f4c47d8695cc4c157e6d4244ae394fc2797f08f20a826
+  data.tar.gz: 93cf90f670ebca89d40812870f2e4ad526f5f373609a56ece0199ef50f63383204bd624a1e3af3ac65f31d431494fdac19a7c5b1bc62887fd20c961a3cb8daa2

data/CHANGELOG.md

@@ -1,4 +1,16 @@
-## 2.1.3 / 2020-08-1
+## 2.1.4 / 2020-11-07
+[Full Changelog](http://github.com/simukappu/activity_notification/compare/v2.1.3...v2.1.4)
+
+Enhancements:
+
+* Make *Common#to_class_name* method return base_class name in order to work with STI models - [#89](https://github.com/simukappu/activity_notification/issues/89) [#139](https://github.com/simukappu/activity_notification/pull/139)
+
+Bug Fixes:
+
+* Rename *Notifiable#notification_action_cable_allowed?* to *notifiable_action_cable_allowed?* to fix duplicate method name error - [#138](https://github.com/simukappu/activity_notification/issues/138)
+* Fix hash syntax in swagger schemas - [#146](https://github.com/simukappu/activity_notification/issues/146) [#147](https://github.com/simukappu/activity_notification/pull/147)
+
+## 2.1.3 / 2020-08-11
 [Full Changelog](http://github.com/simukappu/activity_notification/compare/v2.1.2...v2.1.3)
 
 Enhancements:

data/Gemfile

@@ -16,8 +16,6 @@ group :development do
 end
 
 group :test do
-  #TODO https://github.com/rails/rails/issues/35417
-  gem 'rspec-rails', '4.0.0.beta4'
   gem 'rails-controller-testing'
   gem 'ammeter'
   gem 'timecop'

data/activity_notification.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'pg', '>= 1.0.0'
   s.add_development_dependency 'mongoid', '>= 4.0.0'
   s.add_development_dependency 'dynamoid', '3.1.0'
-  s.add_development_dependency 'rspec-rails', '>= 3.8.0', '< 4.0.0'
+  s.add_development_dependency 'rspec-rails', '>= 3.8.0'
   s.add_development_dependency 'factory_bot_rails', '>= 4.11.0', '< 5.0.0'
   s.add_development_dependency 'simplecov', '~> 0'
   s.add_development_dependency 'yard', '>= 0.9.16'

data/docs/Functions.md

@@ -65,9 +65,9 @@ config.mailer_sender = ->(key){ key == 'inquiry.post' ? 'support@example.com' :
 
 #### Email templates
 
-*activity_notification* will look for email template in a similar way as notification views, but the view file name is not start with an underscore. For example, if you have a notification with *:key* set to *"notification.comment.reply"* and target_type *users*, the gem will look for a partial in *app/views/activity_notification/mailer/users/comment/reply.html.(|erb|haml|slim|something_else)*.
+*activity_notification* will look for email template in a similar way as notification views, but the view file name does not start with an underscore. For example, if you have a notification with *:key* set to *"notification.comment.reply"* and target_type *users*, the gem will look for a partial in *app/views/activity_notification/mailer/users/comment/reply.html.(|erb|haml|slim|something_else)*.
 
-If this template is missing, the gem will look for a partial in *default* as the target type which means *activity_notification/mailer/default/_default.html.(|erb|haml|slim|something_else)*.
+If this template is missing, the gem will use *default* as the target type which means *activity_notification/mailer/default/default.html.(|erb|haml|slim|something_else)*.
 
 #### Email subject
 

data/docs/Setup.md

@@ -109,76 +109,189 @@ When **store_with_associated_records** is set to *false* as default, *activity_n
 
 ```json
 {
-    "id": {
-        "S": "f05756ef-661e-4ef5-9e99-5af51243125c"
-    },
-    "target_key": {
-        "S": "User#1"
-    },
-    "notifiable_key": {
-        "S": "Comment#2"
-    },
-    "key": {
-        "S": "comment.default"
-    },
-    "group_key": {
-        "S": "Article#1"
-    },
-    "notifier_key": {
-        "S": "User#2"
-    },
-    "created_at": {
-        "N": "1560085332.689929"
-    },
-    "updated_at": {
-        "N": "1560085332.695515"
-    },
-    "parameters": {
-        "M": {}
-    }
+  "id": {
+    "S": "f05756ef-661e-4ef5-9e99-5af51243125c"
+  },
+  "target_key": {
+    "S": "User#1"
+  },
+  "notifiable_key": {
+    "S": "Comment#2"
+  },
+  "key": {
+    "S": "comment.default"
+  },
+  "group_key": {
+    "S": "Article#1"
+  },
+  "notifier_key": {
+    "S": "User#2"
+  },
+  "created_at": {
+    "S": "2020-03-08T08:22:53+00:00"
+  },
+  "updated_at": {
+    "S": "2020-03-08T08:22:53+00:00"
+  },
+  "parameters": {
+      "M": {}
+  }
 }
 ```
 
-When you set **store_with_associated_records** to *true*, *activity_notification* stores notificaion records including associated target, notifiable and notifier like this:
+When you set **store_with_associated_records** to *true*, *activity_notification* stores notificaion records including associated target, notifiable, notifier and several instance methods like this:
 
 ```json
 {
-    "id": {
-        "S": "f05756ef-661e-4ef5-9e99-5af51243125c"
-    },
-    "target_key": {
-        "S": "User#1"
-    },
-    "target_record": {
-        "S": "{\"id\":1,\"email\":\"ichiro@example.com\",\"name\":\"Ichiro\",\"created_at\":\"2019-06-09T13:10:44.853Z\",\"updated_at\":\"2019-06-09T13:10:44.853Z\"}"
-    },
-    "notifiable_key": {
-        "S": "Comment#2"
-    },
-    "notifiable_record": {
-        "S": "{\"id\":2,\"user_id\":2,\"article_id\":1,\"body\":\"This is the first Stephen's comment to Ichiro's article.\",\"created_at\":\"2019-06-09T13:10:45.677Z\",\"updated_at\":\"2019-06-09T13:10:45.677Z\"}"
-    },
-    "key": {
-        "S": "comment.default"
-    },
-    "group_key": {
-        "S": "Article#1"
-    },
-    "notifier_key": {
-        "S": "User#2"
-    },
-    "notifier_record": {
-        "S": "{\"id\":2,\"email\":\"stephen@example.com\",\"name\":\"Stephen\",\"created_at\":\"2019-06-09T13:10:45.006Z\",\"updated_at\":\"2019-06-09T13:10:45.006Z\"}"
-    },
-    "created_at": {
-        "N": "1560085332.689929"
-    },
-    "updated_at": {
-        "N": "1560085332.695515"
-    },
-    "parameters": {
-        "M": {}
+  "id": {
+    "S": "f05756ef-661e-4ef5-9e99-5af51243125c"
+  },
+  "target_key": {
+    "S": "User#1"
+  },
+  "notifiable_key": {
+    "S": "Comment#2"
+  },
+  "key": {
+    "S": "comment.default"
+  },
+  "group_key": {
+    "S": "Article#1"
+  },
+  "notifier_key": {
+    "S": "User#2"
+  },
+  "created_at": {
+    "S": "2020-03-08T08:22:53+00:00"
+  },
+  "updated_at": {
+    "S": "2020-03-08T08:22:53+00:00"
+  },
+  "parameters": {
+      "M": {}
+  },
+  "stored_target": {
+    "M": {
+      "id": {
+          "N": "1"
+      },
+      "email": {
+          "S": "ichiro@example.com"
+      },
+      "name": {
+        "S": "Ichiro"
+      },
+      "created_at": {
+        "S": "2020-03-08T08:22:23.451Z"
+      },
+      "updated_at": {
+        "S": "2020-03-08T08:22:23.451Z"
+      },
+      // { ... },
+      "printable_type": {
+          "S": "User"
+      },
+      "printable_target_name": {
+          "S": "Ichiro"
+      },
+    }
+  },
+  "stored_notifiable": {
+    "M": {
+      "id": {
+          "N": "2"
+      },
+      "user_id": {
+          "N": "2"
+      },
+      "article_id": {
+          "N": "1"
+      },
+      "body": {
+          "S": "This is the first Stephen's comment to Ichiro's article."
+      },
+      "created_at": {
+          "S": "2020-03-08T08:22:47.683Z"
+      },
+      "updated_at": {
+          "S": "2020-03-08T08:22:47.683Z"
+      },
+      "printable_type": {
+          "S": "Comment"
+      }
+    }
+  },
+  "stored_notifier": {
+    "M": {
+      "id": {
+          "N": "2"
+      },
+      "email": {
+          "S": "stephen@example.com"
+      },
+      "name": {
+          "S": "Stephen"
+      },
+      "created_at": {
+          "S": "2020-03-08T08:22:23.573Z"
+      },
+      "updated_at": {
+        "S": "2020-03-08T08:22:23.573Z"
+      },
+      // { ... },
+      "printable_type": {
+        "S": "User"
+      },
+      "printable_notifier_name": {
+          "S": "Stephen"
+      }
+    }
+  },
+  "stored_group": {
+    "M": {
+      "id": {
+        "N": "1"
+      },
+      "user_id": {
+        "N": "1"
+      },
+      "title": {
+        "S": "Ichiro's first article"
+      },
+      "body": {
+        "S": "This is the first Ichiro's article. Please read it!"
+      },
+      "created_at": {
+        "S": "2020-03-08T08:22:23.952Z"
+      },
+      "updated_at": {
+        "S": "2020-03-08T08:22:23.952Z"
+      },
+      "printable_type": {
+        "S": "Article"
+      },
+      "printable_group_name": {
+        "S": "article \"Ichiro's first article\""
+      }
     }
+  },
+  "stored_notifiable_path": {
+    "S": "/articles/1"
+  },
+  "stored_printable_notifiable_name": {
+    "S": "comment \"This is the first Stephen's comment to Ichiro's article.\""
+  },
+  "stored_group_member_notifier_count": {
+    "N": "2"
+  },
+  "stored_group_notification_count": {
+    "N": "3"
+  },
+  "stored_group_members": {
+    "L": [
+      // { ... }, { ... }, ...
+    ]
+  }
 }
 ```
 

data/gemfiles/Gemfile.rails-5.0

@@ -11,6 +11,7 @@ group :development do
 end
 
 group :test do
+  gem 'rspec-rails', '< 4.0.0'
   gem 'rails-controller-testing'
   gem 'action-cable-testing'
   gem 'ammeter'

data/gemfiles/Gemfile.rails-5.1

@@ -10,6 +10,7 @@ group :development do
 end
 
 group :test do
+  gem 'rspec-rails', '< 4.0.0'
   gem 'rails-controller-testing'
   gem 'action-cable-testing'
   gem 'ammeter'

data/gemfiles/Gemfile.rails-5.2

@@ -10,6 +10,7 @@ group :development do
 end
 
 group :test do
+  gem 'rspec-rails', '< 4.0.0'
   gem 'rails-controller-testing'
   gem 'action-cable-testing'
   gem 'ammeter'

data/gemfiles/Gemfile.rails-6.0

@@ -10,8 +10,6 @@ group :development do
 end
 
 group :test do
-  #TODO https://github.com/rails/rails/issues/35417
-  gem 'rspec-rails', '4.0.0.beta4'
   gem 'rails-controller-testing'
   gem 'ammeter'
   gem 'timecop'

data/lib/activity_notification/apis/notification_api.rb

@@ -495,16 +495,23 @@ module ActivityNotification
 
         notification = new({ target: target, notifiable: notifiable, key: key, group: group, parameters: parameters, notifier: notifier, group_owner: group_owner })
         notification.prepare_to_store.save
+        notification.after_store
         notification
       end
     end
 
+    # :nocov:
     # Returns prepared notification object to store
     # @return [Object] prepared notification object to store
     def prepare_to_store
       self
     end
 
+    # Call after store action with stored notification
+    def after_store
+    end
+    # :nocov:
+
     # Sends notification email to the target.
     #
     # @param [Hash] options Options for notification email

data/lib/activity_notification/common.rb

@@ -98,9 +98,12 @@ module ActivityNotification
     end
 
     # Convets to class name.
+    # This function returns base_class name for STI models if the class responds to base_class method.
+    # @see https://github.com/simukappu/activity_notification/issues/89
+    # @see https://github.com/simukappu/activity_notification/pull/139
     # @return [String] Class name
     def to_class_name
-      self.class.name
+      self.class.respond_to?(:base_class) ? self.class.base_class.name : self.class.name
     end
 
     # Convets to singularized model name (resource name).

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

@@ -25,8 +25,8 @@ module ActivityNotification
                       :_notifier,
                       :_notification_parameters,
                       :_notification_email_allowed,
-                      :_notification_action_cable_allowed,
-                      :_notification_action_cable_api_allowed,
+                      :_notifiable_action_cable_allowed,
+                      :_notifiable_action_cable_api_allowed,
                       :_notifiable_path,
                       :_printable_notifiable_name,
                       :_optional_targets
@@ -55,8 +55,8 @@ module ActivityNotification
         self._notifier                              = {}
         self._notification_parameters               = {}
         self._notification_email_allowed            = {}
-        self._notification_action_cable_allowed     = {}
-        self._notification_action_cable_api_allowed = {}
+        self._notifiable_action_cable_allowed       = {}
+        self._notifiable_action_cable_api_allowed   = {}
         self._notifiable_path                       = {}
         self._printable_notifiable_name             = {}
         self._optional_targets                      = {}
@@ -162,10 +162,10 @@ module ActivityNotification
     # @param [Object] target Target instance to notify
     # @param [String] key Key of the notification
     # @return [Boolean] If publishing WebSocket using ActionCable is allowed for the notifiable
-    def notification_action_cable_allowed?(target, key = nil)
+    def notifiable_action_cable_allowed?(target, key = nil)
       resolve_parameter(
-        "notification_action_cable_allowed_for_#{cast_to_resources_name(target.class)}?",
-        _notification_action_cable_allowed[cast_to_resources_sym(target.class)],
+        "notifiable_action_cable_allowed_for_#{cast_to_resources_name(target.class)}?",
+        _notifiable_action_cable_allowed[cast_to_resources_sym(target.class)],
         ActivityNotification.config.action_cable_enabled,
         target, key)
     end
@@ -176,10 +176,10 @@ module ActivityNotification
     # @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)
+    def notifiable_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)],
+        "notifiable_action_cable_api_allowed_for_#{cast_to_resources_name(target.class)}?",
+        _notifiable_action_cable_api_allowed[cast_to_resources_sym(target.class)],
         ActivityNotification.config.action_cable_api_enabled,
         target, key)
     end

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

@@ -90,7 +90,7 @@ module ActivityNotification
               type: :string
             }
             key :example, {
-              "test_default_param": "1"
+              test_default_param: "1"
             }
           end
           property :opened_at do
@@ -139,28 +139,28 @@ 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,
-                  "provider": "email",
-                  "uid": "",
-                  "printable_type": "User",
-                  "printable_target_name": "Ichiro"
+                  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"
+                  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
@@ -168,14 +168,14 @@ module ActivityNotification
                 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\""
+                  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
@@ -183,15 +183,15 @@ module ActivityNotification
                 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"
+                  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