activity_notification 1.5.1 → 1.6.0

data/lib/activity_notification/roles/acts_as_target.rb

@@ -37,7 +37,7 @@ module ActivityNotification
       # * :devise_resource
       #   * Integrated resource with devise authentication.
       #     This parameter is a optional since `self` is used as default value.
-      #     You also have to configure routing for devise inroutes.rb
+      #     You also have to configure routing for devise in routes.rb
       # @example No :devise_resource is needed when notification target is the same as authenticated resource
       #   # config/routes.rb
       #   devise_for :users
@@ -68,6 +68,42 @@ module ActivityNotification
       #       devise_resource: :user
       #   end
       #
+      # * :current_devise_target
+      #   * Current authenticated target by devise authentication.
+      #     This parameter is a optional since `current_<devise_resource_name>` is used as default value.
+      #     In addition, this parameter is only needed when :devise_default_route in your route.rb is enabled.
+      #     You also have to configure routing for devise in routes.rb
+      # @example No :current_devise_target is needed when notification target is the same as authenticated resource
+      #   # config/routes.rb
+      #   devise_for :users
+      #   notify_to :users
+      #
+      #   # app/models/user.rb
+      #   class User < ActiveRecord::Base
+      #     devise :database_authenticatable, :registerable, :confirmable
+      #     acts_as_target email: :email, email_allowed: :confirmed_at
+      #   end
+      #
+      # @example Send Admin model and use associated User model with devise authentication
+      #   # config/routes.rb
+      #   devise_for :users
+      #   notify_to :admins, with_devise: :users
+      #
+      #   # app/models/user.rb
+      #   class User < ActiveRecord::Base
+      #     devise :database_authenticatable, :registerable, :confirmable
+      #   end
+      #
+      #   # app/models/admin.rb
+      #   class Admin < ActiveRecord::Base
+      #     belongs_to :user
+      #     validates :user, presence: true
+      #     acts_as_notification_target email: :email,
+      #       email_allowed: ->(admin, key) { admin.user.confirmed_at.present? },
+      #       devise_resource: :user,
+      #       current_devise_target: ->(current_user) { current_user.admin }
+      #   end
+      #
       # * :printable_name or :printable_notification_target_name
       #   * Printable notification target name.
       #     This parameter is a optional since `ActivityNotification::Common.printable_name` is used as default value.
@@ -85,19 +121,20 @@ module ActivityNotification
       #   end
       #
       # @param [Hash] options Options for notifiable model configuration
-      # @option options [Symbol, Proc, String]  :email                (nil)                                              Email address to send notification email
-      # @option options [Symbol, Proc, Boolean] :email_allowed        (ActivityNotification.config.email_enabled)        Whether activity_notification sends notification email to this target
-      # @option options [Symbol, Proc, Boolean] :batch_email_allowed  (ActivityNotification.config.email_enabled)        Whether activity_notification sends batch notification email to this target
-      # @option options [Symbol, Proc, Boolean] :subscription_allowed (ActivityNotification.config.subscription_enabled) Whether activity_notification manages subscriptions of this target
-      # @option options [Symbol, Proc, Object]  :devise_resource      (nil)                                              Integrated resource with devise authentication
-      # @option options [Symbol, Proc, String]  :printable_name       (ActivityNotification::Common.printable_name)      Printable notification target name
+      # @option options [Symbol, Proc, String]  :email                 (nil)                                              Email address to send notification email
+      # @option options [Symbol, Proc, Boolean] :email_allowed         (ActivityNotification.config.email_enabled)        Whether activity_notification sends notification email to this target
+      # @option options [Symbol, Proc, Boolean] :batch_email_allowed   (ActivityNotification.config.email_enabled)        Whether activity_notification sends batch notification email to this target
+      # @option options [Symbol, Proc, Boolean] :subscription_allowed  (ActivityNotification.config.subscription_enabled) Whether activity_notification manages subscriptions of this target
+      # @option options [Symbol, Proc, Object]  :devise_resource       (->(model) { model })                              Integrated resource with devise authentication
+      # @option options [Symbol, Proc, Object]  :current_devise_target (->(current_resource) { current_resource })        Current authenticated target by devise authentication
+      # @option options [Symbol, Proc, String]  :printable_name        (ActivityNotification::Common.printable_name)      Printable notification target name
       # @return [Hash] Configured parameters as target model
       def acts_as_target(options = {})
         include Target
 
         options[:printable_notification_target_name] ||= options.delete(:printable_name)
         options[:batch_notification_email_allowed] ||= options.delete(:batch_email_allowed)
-        acts_as_params = set_acts_as_parameters([:email, :email_allowed, :subscription_allowed, :devise_resource], options, "notification_")
+        acts_as_params = set_acts_as_parameters([:email, :email_allowed, :subscription_allowed, :devise_resource, :current_devise_target], options, "notification_")
                            .merge set_acts_as_parameters([:batch_notification_email_allowed, :printable_notification_target_name], options)
         include Subscriber if subscription_enabled?
         acts_as_params

data/lib/activity_notification/version.rb

@@ -1,3 +1,3 @@
 module ActivityNotification
-  VERSION = "1.5.1"
+  VERSION = "1.6.0"
 end

data/spec/controllers/notifications_with_devise_controller_spec.rb

@@ -78,6 +78,21 @@ describe ActivityNotification::NotificationsWithDeviseController, type: :control
     end
   end
 
+  context "without target_id and (typed_target)_id parameters for devise integrated controller with devise_type option" do
+    let(:target_params) { { target_type: target_type, devise_type: :users } }
+
+    describe "GET #index" do
+      before do
+        sign_in test_target.user
+        get_with_compatibility :index, target_params, valid_session
+      end
+
+      it "returns 200 as http status code" do
+        expect(response.status).to eq(200)
+      end
+    end
+  end
+
   private
 
     def get_with_compatibility action, params, session

data/spec/controllers/subscriptions_controller_shared_examples.rb

@@ -273,9 +273,10 @@ shared_examples_for :subscription_controller do
 
       it "creates new subscription of the target" do
         expect(test_target.subscriptions.reload.size).to      eq(1)
-        expect(test_target.subscriptions.reload.first.key).to eq("new_subscription_key")
-        expect(test_target.subscriptions.reload.first.subscribing_to_optional_target?("base1")).to be_truthy
-        expect(test_target.subscriptions.reload.first.subscribing_to_optional_target?("base2")).to be_falsey
+        created_subscription = test_target.subscriptions.reload.first
+        expect(created_subscription.key).to eq("new_subscription_key")
+        expect(created_subscription.subscribing_to_optional_target?("base1")).to be_truthy
+        expect(created_subscription.subscribing_to_optional_target?("base2")).to be_falsey
       end
 
       it "redirects to :index" do

data/spec/controllers/subscriptions_with_devise_controller_spec.rb

@@ -78,6 +78,21 @@ describe ActivityNotification::SubscriptionsWithDeviseController, type: :control
     end
   end
 
+  context "without target_id and (typed_target)_id parameters for devise integrated controller with devise_type option" do
+    let(:target_params) { { target_type: target_type, devise_type: :users } }
+
+    describe "GET #index" do
+      before do
+        sign_in test_target.user
+        get_with_compatibility :index, target_params, valid_session
+      end
+
+      it "returns 200 as http status code" do
+        expect(response.status).to eq(200)
+      end
+    end
+  end
+
   private
 
     def get_with_compatibility action, params, session

data/spec/helpers/view_helpers_spec.rb

@@ -42,7 +42,7 @@ describe ActivityNotification::ViewHelpers, type: :helper do
         expect(render_notification notification, fallback: :default)
           .to eq(
             render partial: 'activity_notification/notifications/default/default',
-                   locals: { notification: notification }
+                   locals: { notification: notification, parameters: {} }
           )
       end
 

data/spec/rails_app/app/controllers/articles_controller.rb

@@ -4,6 +4,8 @@ class ArticlesController < ApplicationController
 
   # GET /articles
   def index
+    @exists_user_notification_routes  = respond_to?('user_notification_path')
+    @exists_admin_notification_routes = respond_to?('admin_notification_path')
     @articles = Article.all.includes(:user)
   end
 

data/spec/rails_app/app/models/admin.rb

@@ -6,6 +6,7 @@ unless ENV['AN_TEST_DB'] == 'mongodb'
     acts_as_notification_target email_allowed: false,
       subscription_allowed: true,
       devise_resource: :user,
+      current_devise_target: ->(current_user) { current_user.admin },
       printable_name: ->(admin) { "admin (#{admin.user.name})" }
   end
 else
@@ -25,6 +26,7 @@ else
     acts_as_notification_target email_allowed: false,
       subscription_allowed: true,
       devise_resource: :user,
+      current_devise_target: ->(current_user) { current_user.admin },
       printable_name: ->(admin) { "admin (#{admin.user.name})" }
   end
 end

data/spec/rails_app/app/views/activity_notification/optional_targets/admins/amazon_sns/comment/_default.text.erb

@@ -5,6 +5,6 @@ Dear <%= @target.printable_target_name %>
 <%= @notification.notifier.present? ? @notification.notifier.printable_notifier_name : 'Someone' %> notified you of <%= @notification.notifiable.printable_notifiable_name(@notification.target) %><%= " in #{@notification.group.printable_group_name}" if @notification.group.present? %>.
 
 <%= "Move to notified #{@notification.notifiable.printable_type.downcase}:" %>
-  <%= move_notification_url_for(@notification, open: true) %>
+  <%= move_notification_url_for(@notification, parameters.slice(:routing_scope, :devise_default_routes).merge(open: true)) %>
 
 Thank you!

data/spec/rails_app/app/views/articles/index.html.erb

@@ -1,38 +1,42 @@
-<section>
-  <h1>Listing Users</h1>
-  <% User.all.each do |user| %>
-    <div class="list_wrapper">
-      <div class="list_image"></div>
-      <div class="list_description_wrapper">
-        <p class="list_description">
-          <span><%= user.name %></span> · <%= user.email %><br>
-          <%= link_to 'Notifications', user_notifications_path(user) %>
-          <% if User.subscription_enabled? %>
-            <%= link_to 'Subscriptions', user_subscriptions_path(user) %>
-          <% end %>
-        </p>
+<% if @exists_user_notification_routes %>
+  <section>
+    <h1>Listing Users</h1>
+    <% User.all.each do |user| %>
+      <div class="list_wrapper">
+        <div class="list_image"></div>
+        <div class="list_description_wrapper">
+          <p class="list_description">
+            <span><%= user.name %></span> · <%= user.email %><br>
+            <%= link_to 'Notifications', user_notifications_path(user) %>
+            <% if User.subscription_enabled? %>
+              <%= link_to 'Subscriptions', user_subscriptions_path(user) %>
+            <% end %>
+          </p>
+        </div>
       </div>
-    </div>
-  <% end %>
-</section>
+    <% end %>
+  </section>
+<% end %>
 
-<section>
-  <h1>Listing Admins</h1>
-  <% Admin.all.each do |admin| %>
-    <div class="list_wrapper">
-      <div class="list_image"></div>
-      <div class="list_description_wrapper">
-        <p class="list_description">
-          <span><%= admin.user.name %></span> · <%= admin.user.email %><br>
-          <%= link_to 'Notifications', admin_notifications_path(admin) %>
-          <% if Admin.subscription_enabled? %>
-            <%= link_to 'Subscriptions', admin_subscriptions_path(admin) %>
-          <% end %>
-        </p>
+<% if @exists_admin_notification_routes %>
+  <section>
+    <h1>Listing Admins</h1>
+    <% Admin.all.each do |admin| %>
+      <div class="list_wrapper">
+        <div class="list_image"></div>
+        <div class="list_description_wrapper">
+          <p class="list_description">
+            <span><%= admin.user.name %></span> · <%= admin.user.email %><br>
+            <%= link_to 'Notifications', admin_notifications_path(admin) %>
+            <% if Admin.subscription_enabled? %>
+              <%= link_to 'Subscriptions', admin_subscriptions_path(admin) %>
+            <% end %>
+          </p>
+        </div>
       </div>
-    </div>
-  <% end %>
-</section>
+    <% end %>
+  </section>
+<% end %>
 
 <section>
   <div class="create_button_wrapper">

data/spec/rails_app/app/views/layouts/_header.html.erb

@@ -24,12 +24,20 @@
     </div>
     <div class="header_notification_wrapper">
       <% if user_signed_in? %>
-        <%= render_notifications_of current_user, fallback: :default, index_content: :with_attributes %>
+        <%= render_notifications_of current_user, fallback: :default, index_content: :with_attributes, devise_default_routes: respond_to?('notifications_path') %>
         <%#= render_notifications_of current_user, fallback: :default, index_content: :unopened_with_attributes, reverse: true %>
         <%#= render_notifications_of current_user, fallback: :default, index_content: :with_attributes, as_latest_group_member: true %>
         <%#= render_notifications_of current_user, fallback: :default_without_grouping, index_content: :with_attributes, with_group_members: true %>
       <% end %>
     </div>
+    <% if user_signed_in? and current_user.admin? and respond_to?('admins_notifications_path') %>
+      <div class="header_menu_wrapper">
+        <p>
+          <%= link_to "Admin notifications", admins_notifications_path %> /
+          <%= link_to "subscriptions", admins_subscriptions_path %>
+        </p>
+      </div>
+    <% end %>
     <div class="header_menu_wrapper">
       <p>
         <%= link_to 'Preview email', "/rails/mailers" %>

data/spec/rails_app/config/routes.rb

@@ -5,5 +5,10 @@ Rails.application.routes.draw do
   resources :comments, only: [:create, :destroy]
 
   notify_to :users, with_subscription: true
+  notify_to :users, with_devise: :users, devise_default_routes: true, with_subscription: true
+
   notify_to :admins, with_devise: :users, with_subscription: true
+  scope :admins, as: :admins do
+    notify_to :admins, with_devise: :users, devise_default_routes: true, with_subscription: true, routing_scope: :admins
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activity_notification
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Shota Yamazaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-25 00:00:00.000000000 Z
+date: 2018-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties