activity_notification 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21216d2e8404074f8d41386c1efd69e5807fe1a0
-  data.tar.gz: a7f47206261d82ab891c26b11a75d2651ac181ad
+  metadata.gz: 0a5bab367f956293fdbc2bab7e9b2ad767d2c582
+  data.tar.gz: bd432e9c7d6800f63d79f681584db7ca0bf619af
 SHA512:
-  metadata.gz: 8a17fcd05b829941cf7c0ab09d384d13ef18946aaee3df1e21e9798a9dc170fc4e905b36feeaa33b86785f26830eccc8950105162c2d1ef5f56ec84777e74ded
-  data.tar.gz: 3763b40e578293462beb8a92227cd18e0e907ceae53c9bba5b3981d07a7c2ecb4a065dd4e11bd820b38adfd52f58b42cb965b5fe8223a9111c1ec188b0cf6439
+  metadata.gz: 7d70c2d58b4ff931e361db55bbd34194cd365e28e7fed65b4bab413de5cae2670f8cc56e8beb24a89af88afbaec34f3143884e9717e77ec019404a63f54b332b
+  data.tar.gz: b4b5f443a364f3d0e90d3f67cae2b5d0befe222bca969e3085ebcc5ec91d8840ef4df6b6b94b6638c31c5d282b38f9f8228aa2729ddd8bf18bfbbe15cd9ae4cc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activity_notification (0.0.8)
+    activity_notification (0.0.9)
       activerecord (>= 3.0)
       i18n (>= 0.5.0)
       rails (~> 4.2)
@@ -44,6 +44,10 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
+    ammeter (1.1.3)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-rails (>= 2.2)
     arel (6.0.3)
     bcrypt (3.1.11)
     builder (3.2.2)
@@ -71,6 +75,10 @@ GEM
     globalid (0.3.6)
       activesupport (>= 4.1.0)
     i18n (0.7.0)
+    jquery-rails (4.1.1)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
     json (1.8.3)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
@@ -162,9 +170,11 @@ PLATFORMS
 
 DEPENDENCIES
   activity_notification!
+  ammeter (~> 1.1.3)
   coveralls
   devise (~> 4.2.0)
   factory_girl_rails (~> 4.7.0)
+  jquery-rails (~> 4.1.1)
   rspec-rails (~> 3.5.1)
   simplecov (~> 0.12.0)
   sqlite3 (~> 1.3.11)

data/README.md

@@ -6,7 +6,7 @@
 [![Gem Version](https://badge.fury.io/rb/activity_notification.svg)](https://badge.fury.io/rb/activity_notification)
 [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](MIT-LICENSE)
 
-`activity_notification` provides integrated user activity notifications for Rails. You can easily use it to configure multiple notification targets and make activity notifications with notifiable models, like adding comments, responding etc.
+`activity_notification` provides integrated user activity notifications for Ruby on Rails. You can easily use it to configure multiple notification targets and make activity notifications with notifiable models, like adding comments, responding etc.
 
 Currently, `activity_notification` is only supported with ActiveRecord ORM in Rails 4.
 
@@ -89,51 +89,49 @@ $ rake db:migrate
 #### Configuring target model
 
 Configure your target model (e.g. app/models/user.rb).
-Add including statement and `acts_as_target` configuration to your target model to get notifications.
+Add `acts_as_notification_target` configuration to your target model to get notifications.
 
 ```ruby
 class User < ActiveRecord::Base
-  include ActivityNotification::Target
   # Example using confirmed_at of Device field
   # to decide whether activity_notification sends notification email to this user
-  acts_as_target email: :email, email_allowed: :confirmed_at
+  acts_as_notification_target email: :email, email_allowed: :confirmed_at
 end
 ```
 
+*Note*: `acts_as_target` is an alias for `acts_as_notification_target` and does the same.
+
 You can override several methods in your target model (e.g. `notification_index` or `notification_email_allowed?`).
 
 #### Configuring notifiable model
 
 Configure your notifiable model (e.g. app/models/comment.rb).
-Add including statement and `acts_as_notifiable` configuration to your notifiable model representing activity to notify.
+Add `acts_as_notifiable` configuration to your notifiable model representing activity to notify.
 You have to define notification targets for all notifications from this notifiable model by `:targets` option. Other configurations are options.
 
 ```ruby
+class Article < ActiveRecord::Base
+  belongs_to :user
+  has_many :comments, dependent: :delete_all
+  has_many :commented_users, through: :comments, source: :user
+end
+
 class Comment < ActiveRecord::Base
   belongs_to :article
   belongs_to :user
 
-  include ActivityNotification::Notifiable
-  # Example that ActivityNotification::Notifiable is configured with custom methods in your model as symbol
+  # Example that ActivityNotification::Notifiable is configured with custom methods in your model as lambda or symbol
   acts_as_notifiable :users,
-    targets: :custom_notification_users,
+    # Notify to users who commented to the same article and article auther, except comment owner self
+    targets: ->(comment, key) { (comment.article.commented_users.to_a - [comment.user] + [comment.article.user]).uniq },
     group: :article,
     notifier: :user,
-    email_allowed: :custom_notification_email_to_users_allowed?,
+    email_allowed: true,
     notifiable_path: :custom_notifiable_path
 
-  def custom_notification_users(key)
-    User.where(id: self.article.comments.pluck(:user_id))
-  end
-
-  def custom_notification_email_to_users_allowed?(user, key)
-    true
-  end
-
   def custom_notifiable_path
     article_path(article)
   end
-
 end
 ```
 
@@ -226,13 +224,13 @@ You can trigger notifications by setting all your required parameters and trigge
 on the notifiable model, like this:
 
 ```ruby
-@comment.notify User key: 'article.commented_on', group: @comment.article
+@comment.notify :users key: 'comment.reply', group: @comment.article
 ```
 
 Or, you can call public API as `ActivityNotification::Notification.notify`
 
 ```ruby
-ActivityNotification::Notification.notify User, @comment, group: @comment.article
+ActivityNotification::Notification.notify :users, @comment, group: @comment.article
 ```
 
 ### Displaying notifications
@@ -342,17 +340,25 @@ If a view file does not exist then ActionView::MisingTemplate will be raised. If
 
 Translations are used by the `#text` method, to which you can pass additional options in form of a hash. `#render` method uses translations when view templates have not been provided. You can render pure i18n strings by passing `{i18n: true}` to `#render_notification` or `#render`.
 
-Translations should be put in your locale `.yml` files. To render pure strings from I18n example structure:
+Translations should be put in your locale `.yml` files as `text` field. To render pure strings from I18n example structure:
 
 ```yaml
 notification:
   user:
     article:
-      create: 'Article has been created'
-      update: 'Someone has edited the article'
-      destroy: 'Some user removed an article!'
-      comment:
-        replied: "<p>%{notifier_name} posted comment to your article %{article_title}</p>"
+      create:
+        text: 'Article has been created'
+      destroy:
+        text: 'Some user removed an article!'
+    comment:
+      post:
+        text: "<p>%{notifier_name} posted comments to your article %{article_title}</p>"
+      reply:
+        text: "<p>%{notifier_name} and %{group_member_count} people replied for your comments</p>"
+  admin:
+    article:
+      post:
+        text: '[Admin] Article has been created'
 ```
 
 This structure is valid for notifications with keys `"notification.article.comment.replied"` or `"article.comment.replied"`. As mentioned before, `"notification."` part of the key is optional. In addition for above example, `%{notifier_name}` and `%{article_title}` are used from parameter field in the notification record.
@@ -362,7 +368,7 @@ This structure is valid for notifications with keys `"notification.article.comme
 `activity_notification` provides the function for automatically grouping notifications. When you created a notification like this, all *unopened* notifications to the same target will be grouped by `article` set as `:group` options:
 
 ```ruby
-@comment.notify User key: 'article.commented_on', group: @comment.article
+@comment.notify :users key: 'comment.reply', group: @comment.article
 ```
 
 You can use `group_owners_only` scope to filter owner notifications representing each group:
@@ -397,6 +403,34 @@ First, you need to set up the default URL options for the `activity_notification
 config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
 ```
 
+Email notification is disabled as default. You can configure to enable email notification in initializer `activity_notification.rb`.
+
+```ruby
+config.email_enabled = true
+config.mailer_sender = 'your_notification_sender@example.com'
+```
+
+You can also configure them for each model by acts_as roles like these.
+
+```ruby
+class User < ActiveRecord::Base
+  acts_as_notification_target email: :email, email_allowed: true
+end
+```
+
+```ruby
+class Comment < ActiveRecord::Base
+  acts_as_notifiable :users,
+    targets: :custom_notification_users,
+    email_allowed: :custom_notification_email_allowed?
+
+  def custom_notification_email_allowed?(target, key)
+    # You can add enabled conditions from target and key
+    true
+  end
+end
+```
+
 #### Email templates
 
 `activity_notification` will look for email template in the same way as notification views. For example, if you have an notification with `:key` set to `"notification.article.comment.replied"` and target_type `users`, the gem will look for a partial in `app/views/activity_notification/mailer/users/article/comment/_replied.html.(|erb|haml|slim|something_else)`.
@@ -412,7 +446,8 @@ notification:
   user:
     article:
       comment:
-        replied: "<p>%{notifier_name} posted comment to your article %{article_title}</p>"
+        reply:
+          text "<p>%{notifier_name} and %{group_member_count} people replied for your comments</p>"
           mail_subject: 'New comment to your article'
 ```
 

data/activity_notification.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |s|
   s.authors       = ["Shota Yamazaki"]
   s.email         = ["shota.yamazaki.8@gmail.com"]
   s.homepage      = "https://github.com/simukappu/activity_notification"
-  s.summary       = "Integrated user activity notifications for Rails"
-  s.description   = "Integrated user activity notifications for Rails. Provides functions to configure multiple notification targets and make activity notifications with notifiable models, like adding comments, responding etc."
+  s.summary       = "Integrated user activity notifications for Ruby on Rails"
+  s.description   = "Integrated user activity notifications for Ruby on Rails. Provides functions to configure multiple notification targets and make activity notifications with notifiable models, like adding comments, responding etc."
   s.license       = "MIT"
 
   s.files         = `git ls-files`.split("\n")
@@ -26,8 +26,10 @@ Gem::Specification.new do |s|
   s.add_dependency 'activerecord', '>= 3.0'
 
   s.add_development_dependency 'sqlite3', '~> 1.3.11'
+  s.add_development_dependency "jquery-rails", '~> 4.1.1'
   s.add_development_dependency "rspec-rails", '~> 3.5.1'
   s.add_development_dependency "factory_girl_rails", '~> 4.7.0'
   s.add_development_dependency 'simplecov', '~> 0.12.0'
+  s.add_development_dependency 'ammeter',  '~> 1.1.3'
   s.add_development_dependency "devise", '~> 4.2.0'
 end

data/app/controllers/activity_notification/notifications_controller.rb

@@ -47,7 +47,7 @@ module ActivityNotification
     # GET /:target_type/:target_id/notifcations/:id/move
     def move
       @notification.open! if params[:open].to_s.to_boolean(false)
-      redirect_to @notification.notifiale_path
+      redirect_to @notification.notifiable_path
     end
   
     # No action routing

data/app/controllers/activity_notification/notifications_with_devise_controller.rb

@@ -6,22 +6,22 @@ module ActivityNotification
     protected
 
       def authenticate_devise_resource!
-        authenticate_method_name = "authenticate_#{params[:devise_type].to_resource_name}!"
-        if respond_to?(authenticate_method_name)
-          send(authenticate_method_name)
+        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 text: "403 Forbidden: Unauthenticated", status: 403
+          end
         else
-          render text: "403 Forbidden: Unauthenticated", status: 403
+          render text: "400 Bad Request: Missing parameter", status: 400
         end
       end
 
       def authenticate_target!
         current_resource_method_name = "current_#{params[:devise_type].to_resource_name}"
-        if respond_to?(current_resource_method_name)
-          unless @target.authenticate_with_devise?(send(current_resource_method_name))
-            render text: "403 Forbidden: Unauthorized target", status: 403
-          end
-        else
-          render text: "403 Forbidden: Unauthenticated", status: 403
+        unless @target.authenticated_with_devise?(send(current_resource_method_name))
+          render text: "403 Forbidden: Unauthorized target", status: 403
         end
       end
 

data/app/views/activity_notification/notifications/default/_index.html.erb

@@ -1,9 +1,14 @@
 <div>
-  <%= link_to open_all_notifications_path_for(@target), method: :post, remote: true do %>
+  <%= link_to open_all_notifications_path_for(@target), method: :post, remote: true,
+      class: "dropdown-toggle", data: {toggle: "dropdown"} do %>
     <div id="notification_count"><%= @target.unopened_notification_count %></div>
   <% end %>
 
-  <div id="notification_index">
-    <%= yield :notification_index %>
-  </div>
+  <!-- Make this dropdown -->
+  <ul class="dropdown-menu">
+    <div id="notification_index">
+      <p>Notifications</p>
+      <%= yield :notification_index %>
+    </div>
+  </ul>
 </div>

data/lib/activity_notification.rb

@@ -6,13 +6,12 @@ module ActivityNotification
   extend ActiveSupport::Concern
   extend ActiveSupport::Autoload
 
+  autoload :NotificationApi,  'activity_notification/apis/notification_api'
   autoload :Notification,     'activity_notification/models/notification'
-  autoload :Target,           'activity_notification/models/target'
-  autoload :Notifiable,       'activity_notification/models/notifiable'
-  autoload :ActsAsTarget,     'activity_notification/roles/acts_as_target'
-  autoload :ActsAsNotifiable, 'activity_notification/roles/acts_as_notifiable'
+  autoload :Target,           'activity_notification/models/concerns/target'
+  autoload :Notifiable,       'activity_notification/models/concerns/notifiable'
+  autoload :Notifier,         'activity_notification/models/concerns/notifier'
   autoload :StoreController,  'activity_notification/controllers/store_controller'
-  autoload :NotificationApi,  'activity_notification/apis/notification_api'
   autoload :Common
   autoload :Config
   autoload :Renderable
@@ -47,6 +46,8 @@ end
 require 'activity_notification/helpers/polymorphic_helpers'
 require 'activity_notification/helpers/view_helpers'
 
+# Load role for models
+require 'activity_notification/models'
+
 # Define Rails::Engine
 require 'activity_notification/rails'
-

data/lib/activity_notification/apis/notification_api.rb

@@ -17,9 +17,7 @@ module ActivityNotification
       end
     
       def notify_all(targets, notifiable, options = {})
-        targets.each do |target|
-          notify_to(target, notifiable, options)
-        end
+        Array(targets).map { |target| notify_to(target, notifiable, options) }
       end
     
       def notify_to(target, notifiable, options = {})
@@ -29,19 +27,20 @@ module ActivityNotification
         notification = store_notification(target, notifiable, options)
         # Send notification email
         notification.send_notification_email(send_later) if send_email
+        # Return created notification
         notification
       end
   
       # Open all notifications of specified target
       def open_all_of(target, opened_at = nil)
         opened_at = DateTime.now if opened_at.blank?
-        Notification.where(target: target, opened_at: nil).update_all(opened_at: opened_at)
+        where(target: target, opened_at: nil).update_all(opened_at: opened_at)
       end
   
       #TODO description
       # Call from controllers or views to avoid N+1
       def group_member_exists?(notifications)
-        Notification.where(group_owner_id: notifications.pluck(:id)).exists?
+        notifications.present? && where(group_owner_id: notifications.pluck(:id)).exists?
       end
     
       def available_options
@@ -61,8 +60,8 @@ module ActivityNotification
   
         # Bundle notification group by target, notifiable_type, group and key
         # Defferent notifiable.id can be made in a same group
-        group_owner = Notification.where(target: target, notifiable_type: notifiable.to_class_name, key: key, group: group)
-                                  .where(group_owner_id: nil, opened_at: nil).earliest
+        group_owner = where(target: target, notifiable_type: notifiable.to_class_name, key: key, group: group)
+                     .where(group_owner_id: nil, opened_at: nil).earliest
         if group.present? and group_owner.present?
           create(target: target, notifiable: notifiable, key: key, group: group, group_owner: group_owner, parameters: parameters, notifier: notifier)
         else
@@ -85,7 +84,7 @@ module ActivityNotification
     def open!(opened_at = nil)
       opened_at = DateTime.now if opened_at.blank?
       update(opened_at: opened_at)
-      group_members.update_all(opened_at: opened_at)
+      group_members.update_all(opened_at: opened_at) + 1
     end
 
     def unopened?
@@ -117,7 +116,7 @@ module ActivityNotification
         notification.unopened_group_member_count
     end
 
-    def notifiale_path
+    def notifiable_path
       notifiable.notifiable_path(target_type)
     end
 
@@ -128,18 +127,18 @@ module ActivityNotification
       def unopened_group_member_count
         # Cache group-by query result to avoid N+1 call
         unopened_group_member_counts = target.notifications
-                                              .unopened_index_group_members_only
-                                              .group(:group_owner_id)
-                                              .count
+                                             .unopened_index_group_members_only
+                                             .group(:group_owner_id)
+                                             .count
         unopened_group_member_counts[id] || 0
       end
     
       def opened_group_member_count(limit = ActivityNotification.config.opened_limit)
         # Cache group-by query result to avoid N+1 call
         opened_group_member_counts   = target.notifications
-                                              .opened_index_group_members_only(limit)
-                                              .group(:group_owner_id)
-                                              .count
+                                             .opened_index_group_members_only(limit)
+                                             .group(:group_owner_id)
+                                             .count
         opened_group_member_counts[id] || 0
       end
 

data/lib/activity_notification/common.rb

@@ -8,15 +8,23 @@ module ActivityNotification
     case thing
     when Symbol
       begin
-        context.__send__(thing, *args)
-      rescue ArgumentError => e
-        context.__send__(thing)
+        context.__send__(thing, ActivityNotification.get_controller, *args)
+      rescue ArgumentError
+        begin
+          context.__send__(thing, ActivityNotification.get_controller)
+        rescue ArgumentError
+          context.__send__(thing)
+        end
       end
     when Proc
       begin
         thing.call(ActivityNotification.get_controller, context, *args)
-      rescue ArgumentError => e
-        thing.call(ActivityNotification.get_controller, context)
+      rescue ArgumentError
+        begin
+          thing.call(ActivityNotification.get_controller, context)
+        rescue ArgumentError
+          thing.call(context)
+        end
       end
     when Hash
       thing.dup.tap do |hash|
@@ -40,13 +48,13 @@ module ActivityNotification
       when Symbol
         begin
           __send__(thing, *args)
-        rescue ArgumentError => e
+        rescue ArgumentError
           __send__(thing)
         end
       when Proc
         begin
           thing.call(self, *args)
-        rescue ArgumentError => e
+        rescue ArgumentError
           thing.call(self)
         end
       when Hash