activity_notification 1.7.1 → 2.0.0

data/Rakefile

@@ -2,18 +2,27 @@ require "bundler/gem_tasks"
 
 task default: :test
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
-desc 'Run RSpec test for the activity_notification plugin.'
-RSpec::Core::RakeTask.new(:test) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+begin
+  require 'rspec/core'
+  require 'rspec/core/rake_task'
+  desc 'Run RSpec test for the activity_notification plugin.'
+  RSpec::Core::RakeTask.new(:test) do |spec|
+    spec.pattern = FileList['spec/**/*_spec.rb']
+  end
+rescue LoadError
 end
 
-require 'yard'
-require 'yard/rake/yardoc_task'
-desc 'Generate documentation for the activity_notification plugin.'
-YARD::Rake::YardocTask.new do |doc|
-  doc.files = ['app/**/*.rb', 'lib/**/*.rb']
+begin
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+  desc 'Generate documentation for the activity_notification plugin.'
+  YARD::Rake::YardocTask.new do |doc|
+    doc.files = ['app/**/*.rb', 'lib/**/*.rb']
+  end
+rescue LoadError
 end
 
 Bundler::GemHelper.install_tasks
+
+require File.expand_path('../spec/rails_app/config/application', __FILE__)
+Rails.application.load_tasks

data/activity_notification.gemspec

@@ -20,14 +20,16 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.required_ruby_version = '>= 2.1.0'
 
-  s.add_dependency 'railties', '>= 4.2.0', '< 5.3'
+  s.add_dependency 'railties', '>= 4.2.0', '< 6.1'
   s.add_dependency 'i18n', '>= 0.5.0'
   s.add_dependency 'jquery-rails', '>= 3.1.1'
 
-  s.add_development_dependency 'sqlite3', '>= 1.3.13', '< 1.4.0'
+  s.add_development_dependency 'puma', '>= 3.12.0'
+  s.add_development_dependency 'sqlite3', '>= 1.3.13'
   s.add_development_dependency 'mysql2', '>= 0.5.2'
   s.add_development_dependency 'pg', '>= 1.0.0'
-  s.add_development_dependency 'mongoid', '>= 4.0.0', '< 7.0.0'
+  s.add_development_dependency 'mongoid', '>= 4.0.0'
+  s.add_development_dependency 'dynamoid', '>= 3.0.0', '< 3.2.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'

data/app/channels/activity_notification/notification_channel.rb

@@ -0,0 +1,37 @@
+if defined?(ActionCable)
+  # Action Cable channel to subscribe broadcasted notifications.
+  class ActivityNotification::NotificationChannel < ActivityNotification.config.parent_channel.constantize
+    before_subscribe :set_target
+    before_subscribe :authenticate_target!
+
+    # ActionCable::Channel::Base#subscribed
+    # @see https://api.rubyonrails.org/classes/ActionCable/Channel/Base.html#method-i-subscribed
+    def subscribed
+      stream_from "#{ActivityNotification.config.notification_channel_prefix}_#{@target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{@target.id}"
+    rescue
+      reject
+    end
+
+    protected
+
+      # Sets @target instance variable from request parameters.
+      # @api protected
+      # @return [Object] Target instance (Reject subscription when request parameters are not enough)
+      def set_target
+        target_type = params[:target_type]
+        target_class = target_type.to_s.to_model_class
+        @target = params[:target_id].present? ?
+          target_class.find_by!(id: params[:target_id]) :
+          target_class.find_by!(id: params["#{target_type.to_s.to_resource_name}_id"])
+        rescue
+        reject
+      end
+
+      # Allow the target to subscribe notification channel if notification_action_cable_with_devise? returns false
+      # @api protected
+      # @return [Responce] Returns connected or rejected
+      def authenticate_target!
+        reject if @target.nil? || @target.notification_action_cable_with_devise?
+      end
+  end
+end

data/app/channels/activity_notification/notification_with_devise_channel.rb

@@ -0,0 +1,51 @@
+if defined?(ActionCable)
+  # Action Cable channel to subscribe broadcasted notifications with Devise authentication.
+  class ActivityNotification::NotificationWithDeviseChannel < ActivityNotification::NotificationChannel
+    # Include PolymorphicHelpers to resolve string extentions
+    include ActivityNotification::PolymorphicHelpers
+
+    protected
+
+      # Find current signed-in target from Devise session data.
+      # @api protected
+      # @param [String] devise_type Class name of authenticated Devise resource
+      # @return [Object] Current signed-in target
+      def find_current_target(devise_type = nil)
+        devise_type = (devise_type || @target.notification_devise_resource.class.name).to_s
+        devise_type.to_model_class.find(session["warden.user.#{devise_type.to_resource_name}.key"][0][0])
+      end
+
+      # Get current session from cookies.
+      # @api protected
+      # @return [Hash] Session from cookies
+      def session
+        @session ||= connection.__send__(:cookies).encrypted[Rails.application.config.session_options[:key]]
+      end
+
+      # Sets @target instance variable from request parameters.
+      # This method override super (ActivityNotiication::NotificationChannel#set_target)
+      # to set devise authenticated target when the target_id params is not specified.
+      # @api protected
+      # @return [Object] Target instance (Reject subscription when request parameters are not enough)
+      def set_target
+        reject and return if (target_type = params[:target_type]).blank?
+        if params[:target_id].blank? && params["#{target_type.to_s.to_resource_name}_id"].blank?
+          reject and return if params[:devise_type].blank?
+          current_target = find_current_target(params[:devise_type])
+          params[:target_id] = target_type.to_model_class.resolve_current_devise_target(current_target)
+          reject and return if params[:target_id].blank?
+        end
+        super
+      end
+
+      # Authenticate the target of requested notification with authenticated devise resource.
+      # @api protected
+      # @return [Responce] Returns connected or rejected
+      def authenticate_target!
+        current_resource = find_current_target
+        reject unless @target.authenticated_with_devise?(current_resource)
+      rescue
+        reject
+      end
+  end
+end

data/app/controllers/activity_notification/notifications_controller.rb

@@ -156,7 +156,7 @@ module ActivityNotification
       end
 
       # Returns controller path.
-      # This method is called from target_view_path method and can be overriden.
+      # This method is called from target_view_path method and can be overridden.
       # @api protected
       # @return [String] "activity_notification/notifications" as controller path
       def controller_path

data/app/controllers/activity_notification/subscriptions_controller.rb

@@ -213,7 +213,7 @@ module ActivityNotification
       end
 
       # Returns controller path.
-      # This method is called from target_view_path method and can be overriden.
+      # This method is called from target_view_path method and can be overridden.
       # @api protected
       # @return [String] "activity_notification/subscriptions" as controller path
       def controller_path

data/app/jobs/activity_notification/notify_all_job.rb

@@ -1,7 +1,23 @@
 if defined?(ActiveJob)
+  # Job to generate notifications by ActivityNotification::Notification#notify_all method.
   class ActivityNotification::NotifyAllJob < ActivityNotification.config.parent_job.constantize
     queue_as ActivityNotification.config.active_job_queue
   
+    # Generates notifications to specified targets with ActiveJob.
+    #
+    # @param [Array<Object>] targets Targets to send notifications
+    # @param [Object] notifiable Notifiable instance
+    # @param [Hash] options Options for notifications
+    # @option options [String]                  :key                      (notifiable.default_notification_key) Key of the notification
+    # @option options [Object]                  :group                    (nil)                                 Group unit of the notifications
+    # @option options [ActiveSupport::Duration] :group_expiry_delay       (nil)                                 Expiry period of a notification group
+    # @option options [Object]                  :notifier                 (nil)                                 Notifier of the notifications
+    # @option options [Hash]                    :parameters               ({})                                  Additional parameters of the notifications
+    # @option options [Boolean]                 :send_email               (true)                                Whether it sends notification email
+    # @option options [Boolean]                 :send_later               (true)                                Whether it sends notification email asynchronously
+    # @option options [Boolean]                 :publish_optional_targets (true)                                Whether it publishes notification to optional targets
+    # @option options [Hash<String, Hash>]      :optional_targets         ({})                                  Options for optional targets, keys are optional target name (:amazon_sns or :slack etc) and values are options
+    # @return [Array<Notificaion>] Array of generated notifications
     def perform(targets, notifiable, options = {})
       ActivityNotification::Notification.notify_all(targets, notifiable, options)
     end

data/app/jobs/activity_notification/notify_job.rb

@@ -1,7 +1,24 @@
 if defined?(ActiveJob)
+  # Job to generate notifications by ActivityNotification::Notification#notify method.
   class ActivityNotification::NotifyJob < ActivityNotification.config.parent_job.constantize
     queue_as ActivityNotification.config.active_job_queue
   
+    # Generates notifications to configured targets with notifiable model with ActiveJob.
+    #
+    # @param [Symbol, String, Class] target_type Type of target
+    # @param [Object] notifiable Notifiable instance
+    # @param [Hash] options Options for notifications
+    # @option options [String]                  :key                      (notifiable.default_notification_key) Key of the notification
+    # @option options [Object]                  :group                    (nil)                                 Group unit of the notifications
+    # @option options [ActiveSupport::Duration] :group_expiry_delay       (nil)                                 Expiry period of a notification group
+    # @option options [Object]                  :notifier                 (nil)                                 Notifier of the notifications
+    # @option options [Hash]                    :parameters               ({})                                  Additional parameters of the notifications
+    # @option options [Boolean]                 :send_email               (true)                                Whether it sends notification email
+    # @option options [Boolean]                 :send_later               (true)                                Whether it sends notification email asynchronously
+    # @option options [Boolean]                 :publish_optional_targets (true)                                Whether it publishes notification to optional targets
+    # @option options [Boolean]                 :pass_full_options        (false)                               Whether it passes full options to notifiable.notification_targets, not a key only
+    # @option options [Hash<String, Hash>]      :optional_targets         ({})                                  Options for optional targets, keys are optional target name (:amazon_sns or :slack etc) and values are options
+    # @return [Array<Notificaion>] Array of generated notifications
     def perform(target_type, notifiable, options = {})
       ActivityNotification::Notification.notify(target_type, notifiable, options)
     end

data/app/jobs/activity_notification/notify_to_job.rb

@@ -1,7 +1,23 @@
 if defined?(ActiveJob)
+  # Job to generate notifications by ActivityNotification::Notification#notify_to method.
   class ActivityNotification::NotifyToJob < ActivityNotification.config.parent_job.constantize
     queue_as ActivityNotification.config.active_job_queue
   
+    # Generates notifications to one target with ActiveJob.
+    #
+    # @param [Object] target Target to send notifications
+    # @param [Object] notifiable Notifiable instance
+    # @param [Hash] options Options for notifications
+    # @option options [String]                  :key                      (notifiable.default_notification_key) Key of the notification
+    # @option options [Object]                  :group                    (nil)                                 Group unit of the notifications
+    # @option options [ActiveSupport::Duration] :group_expiry_delay       (nil)                                 Expiry period of a notification group
+    # @option options [Object]                  :notifier                 (nil)                                 Notifier of the notifications
+    # @option options [Hash]                    :parameters               ({})                                  Additional parameters of the notifications
+    # @option options [Boolean]                 :send_email               (true)                                Whether it sends notification email
+    # @option options [Boolean]                 :send_later               (true)                                Whether it sends notification email asynchronously
+    # @option options [Boolean]                 :publish_optional_targets (true)                                Whether it publishes notification to optional targets
+    # @option options [Hash<String, Hash>]      :optional_targets         ({})                                  Options for optional targets, keys are optional target name (:amazon_sns or :slack etc) and values are options
+    # @return [Notification] Generated notification instance
     def perform(target, notifiable, options = {})
       ActivityNotification::Notification.notify_to(target, notifiable, options)
     end

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

@@ -23,7 +23,7 @@
 
 <div class='<%= "notification_#{notification.id}" %>'>
   <% if notification.unopened? %>
-    <%= link_to open_notification_path_for(notification, parameters.slice(:with_group_members, :routing_scope, :devise_default_routes).merge(reload: false), method: :post, remote: true, class: "unopened_wrapper" do %>
+    <%= link_to open_notification_path_for(notification, parameters.slice(:with_group_members, :routing_scope, :devise_default_routes).merge(reload: false)), method: :post, remote: true, class: "unopened_wrapper" do %>
       <div class="unopned_circle"></div>
       <div class="unopned_description_wrapper">
         <p class="unopned_description">Open</p>

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

@@ -1,13 +1,23 @@
 <div class="notification_wrapper">
   <div class="notification_header">
-    <h1>Notifications to <%= @target.printable_target_name %> <%= link_to open_all_notifications_path_for(@target, @index_options.slice(:routing_scope, :devise_default_routes)), method: :post, remote: true do %><span class="notification_count"><span class="<%= 'unopened' if @target.has_unopened_notifications?(@index_options) %>"><%= @target.unopened_notification_count(@index_options) %></span></span><% end %></h1>
+    <h1>
+      Notifications to <%= @target.printable_target_name %>
+      <%= link_to open_all_notifications_path_for(@target, @index_options.slice(:routing_scope, :devise_default_routes)), method: :post, remote: true do %>
+        <span class="notification_count"><span class="<%= 'unopened' if @target.has_unopened_notifications?(@index_options) %>">
+          <%= @target.unopened_notification_count(@index_options) %>
+        </span></span>
+      <% end %>
+    </h1>
+    <h3>
+      <span class="action_cable_status">Disabled</span>
+    </h3>
   </div>
   <div class="notifications">
     <% if @index_options[:with_group_members] %>
       <%= render_notification @notifications, @index_options.slice(:routing_scope, :devise_default_routes).merge(fallback: :default_without_grouping, with_group_members: true) %>
     <% else %>
       <%= render_notification @notifications, @index_options.slice(:routing_scope, :devise_default_routes).merge(fallback: :default) %>
-      <%#= render_notification @notifications, @index_options.merge(fallback: :text) %>
+      <%#= render_notification @notifications, @index_options.slice(:routing_scope, :devise_default_routes).merge(fallback: :text) %>
     <% end %>
   </div>
 </div>
@@ -28,3 +38,46 @@
     background-color: #f87880;
   }
 </style>
+
+<% if @target.notification_action_cable_allowed? %>
+  <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/push.js/1.0.9/push.min.js"></script>
+  <script>
+    App.activity_notification = App.cable.subscriptions.create(
+      {
+        channel: "<%= @target.notification_action_cable_channel_class_name %>",
+        target_type: "<%= @target.to_class_name %>", target_id: "<%= @target.id %>"
+      },
+      {
+        connected: function() {
+          $(".action_cable_status").html("Online<%= " (authorized)" if @target.notification_action_cable_with_devise? %>");
+        },
+        disconnected: function() {
+          $(".action_cable_status").html("Offline");
+        },
+        rejected: function() {
+          $(".action_cable_status").html("Offline (unauthorized)");
+        },
+        received: function(notification) {
+          // Display notification
+          if (notification.group_owner_id == null) {
+            $(".notifications").prepend(notification.view);
+            $(".notification_count").html("<span class=unopened>" + notification.unopened_notification_count + "</span>");
+          } else {
+            $(".notification_" + notification.group_owner_id).remove();
+            $(".notifications").prepend(notification.group_owner_view);
+            $(".notification_count").html("<span class=unopened>" + notification.unopened_notification_count + "</span>");
+          }
+          // Push notificaion using Web Notification API by Push.js
+          Push.create('ActivityNotification', {
+              body: notification.text,
+              timeout: 5000,
+              onClick: function () {
+                  location.href = notification.notifiable_path;
+                  this.close();
+              }
+          });
+        }
+      }
+    );
+  </script>
+<% end %>

data/bin/_dynamodblocal

@@ -0,0 +1,4 @@
+DIST_DIR=spec/DynamoDBLocal-latest
+PIDFILE=dynamodb.pid
+LISTEN_PORT=8000
+LOG_DIR="logs"

data/{scripts → bin}/bundle_update.sh

@@ -5,3 +5,4 @@ BUNDLE_GEMFILE=gemfiles/Gemfile.rails-4.2 bundle update
 BUNDLE_GEMFILE=gemfiles/Gemfile.rails-5.0 bundle update
 BUNDLE_GEMFILE=gemfiles/Gemfile.rails-5.1 bundle update
 BUNDLE_GEMFILE=gemfiles/Gemfile.rails-5.2 bundle update
+BUNDLE_GEMFILE=gemfiles/Gemfile.rails-6.0.rc bundle update

data/bin/deploy_on_heroku.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+HEROKU_DEPLOYMENT_BRANCH=heroku-deployment
+
+CURRENT_BRANCH=`git symbolic-ref --short HEAD`
+git checkout -b $HEROKU_DEPLOYMENT_BRANCH
+bundle install
+sed -i "" -e "s/^\/Gemfile.lock/# \/Gemfile.lock/g" .gitignore
+git add .gitignore
+git add Gemfile.lock
+git commit -m "Add Gemfile.lock"
+git push heroku ${HEROKU_DEPLOYMENT_BRANCH}:master --force
+git checkout $CURRENT_BRANCH
+git branch -D $HEROKU_DEPLOYMENT_BRANCH

data/bin/install_dynamodblocal.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+wget https://s3-us-west-2.amazonaws.com/dynamodb-local/dynamodb_local_latest.zip --quiet -O spec/dynamodb_temp.zip
+unzip -qq spec/dynamodb_temp.zip -d spec/DynamoDBLocal-latest
+rm spec/dynamodb_temp.zip

data/bin/start_dynamodblocal.sh

@@ -0,0 +1,47 @@
+#!/bin/sh
+
+# Source variables
+. $(dirname $0)/_dynamodblocal
+
+if [ -z $JAVA_HOME ]; then
+  echo >&2 'ERROR: DynamoDBLocal requires JAVA_HOME to be set.'
+  exit 1
+fi
+
+if [ ! -x $JAVA_HOME/bin/java ]; then
+  echo >&2 'ERROR: JAVA_HOME is set, but I do not see the java executable there.'
+  exit 1
+fi
+
+cd $DIST_DIR
+
+if [ ! -f DynamoDBLocal.jar ] || [ ! -d DynamoDBLocal_lib ]; then
+  echo >&2 "ERROR: Could not find DynamoDBLocal files in $DIST_DIR."
+  exit 1
+fi
+
+mkdir -p $LOG_DIR
+echo "DynamoDB Local output will save to ${DIST_DIR}/${LOG_DIR}/"
+hash lsof 2>/dev/null && lsof -i :$LISTEN_PORT && { echo >&2 "Something is already listening on port $LISTEN_PORT; I will not attempt to start DynamoDBLocal."; exit 1; }
+
+NOW=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
+nohup $JAVA_HOME/bin/java -Djava.library.path=./DynamoDBLocal_lib -jar DynamoDBLocal.jar -delayTransientStatuses -port $LISTEN_PORT -inMemory 1>"${LOG_DIR}/${NOW}.out.log" 2>"${LOG_DIR}/${NOW}.err.log" &
+PID=$!
+
+echo 'Verifying that DynamoDBLocal actually started...'
+
+# Allow some seconds for the JDK to start and die.
+counter=0
+while [ $counter -le 5 ]; do
+  kill -0 $PID
+  if [ $? -ne 0 ]; then
+    echo >&2 'ERROR: DynamoDBLocal died after we tried to start it!'
+    exit 1
+  else
+    counter=$(($counter + 1))
+    sleep 1
+  fi
+done
+
+echo "DynamoDB Local started with pid $PID listening on port $LISTEN_PORT."
+echo $PID > $PIDFILE

data/bin/stop_dynamodblocal.sh

@@ -0,0 +1,34 @@
+#!/bin/sh
+
+# Source variables
+. $(dirname $0)/_dynamodblocal
+
+cd $DIST_DIR
+
+if [ ! -f $PIDFILE ]; then
+  echo 'ERROR: There is no pidfile, so if DynamoDBLocal is running you will need to kill it yourself.'
+  exit 1
+fi
+
+pid=$(<$PIDFILE)
+
+echo "Killing DynamoDBLocal at pid $pid..."
+kill $pid
+
+counter=0
+while [ $counter -le 5 ]; do
+  kill -0 $pid 2>/dev/null
+  if [ $? -ne 0 ]; then
+    echo 'Successfully shut down DynamoDBLocal.'
+    rm -f $PIDFILE
+    exit 0
+  else
+    echo 'Still waiting for DynamoDBLocal to shut down...'
+    counter=$(($counter + 1))
+    sleep 1
+  fi
+done
+
+echo 'Unable to shut down DynamoDBLocal; you may need to kill it yourself.'
+rm -f $PIDFILE
+exit 1

data/gemfiles/Gemfile.rails-4.2

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 gemspec path: '../'
 
 gem 'rails', '~> 4.2.0'
+gem 'sqlite3', '~> 1.3.13'
 gem 'mysql2', '~> 0.4.10'
 gem 'pg', '~> 0.21.0'