activity_notification 0.0.9 → 0.0.10

data/Rakefile

@@ -1,19 +1,19 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
+require "bundler/gem_tasks"
 
-require 'rdoc/task'
+task default: :test
 
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ActivityNotification'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+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
 
+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
 
 Bundler::GemHelper.install_tasks
-

data/activity_notification.gemspec

@@ -20,16 +20,14 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.required_ruby_version = '>= 2.1.0'
 
-  s.add_dependency 'rails', '~> 4.2'
-  #s.add_dependency 'railties', '>= 3.0.0'
+  s.add_dependency 'railties', '>= 4.2.0', '< 5.1'
   s.add_dependency 'i18n', '>= 0.5.0'
-  s.add_dependency 'activerecord', '>= 3.0'
+  s.add_dependency 'activerecord', '>= 4.2.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 '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 'yard', '~> 0.9.5'
+  s.add_development_dependency 'yard-activesupport-concern', '~> 0.0.1'
   s.add_development_dependency "devise", '~> 4.2.0'
 end

data/app/controllers/activity_notification/notifications_controller.rb

@@ -1,6 +1,9 @@
 module ActivityNotification
+  # Controller to manage notifications.
   class NotificationsController < ActivityNotification.config.parent_controller.constantize
+    # Include StoreController to allow ActivityNotification access to controller instance
     include ActivityNotification::StoreController
+    # Include PolymorphicHelpers to resolve string extentions
     include ActivityNotification::PolymorphicHelpers
     prepend_before_action :set_target
     before_action :set_notification, except: [:index, :open_all]
@@ -8,7 +11,15 @@ module ActivityNotification
   
     DEFAULT_VIEW_DIRECTORY = "default"
   
+    # Shows notification index of the target.
+    #
     # GET /:target_type/:target_id/notifcations
+    # @overload index(params)
+    #   @param [Hash] params Request parameters
+    #   @option params [String] :filter  (nil)     Filter option to load notification index. Nothing means auto loading. 'opened' means opened only and 'unopened' means unopened only.
+    #   @option params [String] :limit   (nil)     Limit to query for notifications
+    #   @option params [String] :reload  ('true')  Whether notification index will be reloaded
+    #   @return [Responce] HTML view as default or JSON of notification index with json format parameter
     def index
       @notifications = load_notification_index(params[:filter], params[:limit]) if params[:reload].to_s.to_boolean(true)
       respond_to do |format|
@@ -17,48 +28,90 @@ module ActivityNotification
       end
     end
 
+    # Opens all notifications of the target.
+    #
     # POST /:target_type/:target_id/notifcations/open_all
+    # @overload open_all(params)
+    #   @param [Hash] params Request parameters
+    #   @option params [String] :filter  (nil)     Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
+    #   @option params [String] :limit   (nil)     Limit to query for notifications
+    #   @option params [String] :reload  ('true')  Whether notification index will be reloaded
+    #   @option params [String] :filtered_by_type       (nil) Notifiable type for filter
+    #   @option params [String] :filtered_by_group_type (nil) Group type for filter, valid only :filtered_by_group_id
+    #   @option params [String] :filtered_by_group_id   (nil) Group instance id for filter, valid only :filtered_by_group_type
+    #   @option params [String] :filtered_by_key        (nil) Key of the notification for filter 
+    #   @return [Responce] JavaScript view for ajax request or redirects to back as default
     def open_all
-      @target.open_all_notifications
-      @notifications = load_notification_index(params[:filter], params[:limit]) if params[:reload].to_s.to_boolean(true)
+      @target.open_all_notifications(params)
       return_back_or_ajax(params[:filter], params[:limit])
     end
   
+    # Shows a notification.
+    #
     # GET /:target_type/:target_id/notifcations/:id
+    # @overload show(params)
+    #   @param [Hash] params Request parameters
+    #   @return [Responce] HTML view as default
     def show
     end
   
+    # Deletes a notification.
+    #
     # DELETE /:target_type/:target_id/notifcations/:id
+    #
+    # @overload destroy(params)
+    #   @param [Hash] params Request parameters
+    #   @option params [String] :filter  (nil)     Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
+    #   @option params [String] :limit   (nil)     Limit to query for notifications
+    #   @option params [String] :reload  ('true')  Whether notification index will be reloaded
+    #   @return [Responce] JavaScript view for ajax request or redirects to back as default
     def destroy
       @notification.destroy
-      @notifications = load_notification_index(params[:filter], params[:limit]) if params[:reload].to_s.to_boolean(true)
       return_back_or_ajax(params[:filter], params[:limit])
     end
   
+    # Opens a notification.
+    #
     # POST /:target_type/:target_id/notifcations/:id/open
+    # @overload open(params)
+    #   @param [Hash] params Request parameters
+    #   @option params [String] :move    ('false') Whether redirects to notifiable_path after the notification is opened
+    #   @option params [String] :filter  (nil)     Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
+    #   @option params [String] :limit   (nil)     Limit to query for notifications
+    #   @option params [String] :reload  ('true')  Whether notification index will be reloaded
+    #   @return [Responce] JavaScript view for ajax request or redirects to back as default
     def open
       @notification.open!
-      @notifications = load_notification_index(params[:filter], params[:limit]) if params[:reload].to_s.to_boolean(true)
       params[:move].to_s.to_boolean(false) ? 
         move : 
         return_back_or_ajax(params[:filter], params[:limit])
     end
 
+    # Moves to notifiable_path of the notification.
+    #
     # GET /:target_type/:target_id/notifcations/:id/move
+    # @overload open(params)
+    #   @param [Hash] params Request parameters
+    #   @option params [String] :open    ('false') Whether the notification will be opened
+    #   @option params [String] :filter  (nil)     Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
+    #   @option params [String] :limit   (nil)     Limit to query for notifications
+    #   @option params [String] :reload  ('true')  Whether notification index will be reloaded
+    #   @return [Responce] JavaScript view for ajax request or redirects to back as default
     def move
       @notification.open! if params[:open].to_s.to_boolean(false)
       redirect_to @notification.notifiable_path
     end
   
-    # No action routing
-    # This method is called from target_view_path method
-    # This method can be overriden
+    # Returns controller path.
+    # This method has no action routing and is called from target_view_path method.
+    # This method can be overriden.
+    # @return [String] "activity_notification/notifications" as controller path
     def controller_path
       "activity_notification/notifications"
     end
 
-    # No action routing
-    # This method needs to be public since it is called from view helper
+    # Returns path of the target view templates.
+    # This method has no action routing and needs to be public since it is called from view helper.
     def target_view_path
       target_type = @target.to_resources_name
       view_path = [controller_path, target_type].join('/')
@@ -69,6 +122,9 @@ module ActivityNotification
 
     protected
 
+      # Sets @target instance variable from request parameters.
+      # @api protected
+      # @return [Object] Target instance (Returns HTTP 400 when request parameters are not enough)
       def set_target
         if (target_type = params[:target_type]).present?
           target_class = target_type.to_model_class
@@ -76,17 +132,25 @@ module ActivityNotification
             target_class.find_by_id!(params[:target_id]) : 
             target_class.find_by_id!(params["#{target_type.to_resource_name}_id"])
         else
-          render text: "400 Bad Request: Missing parameter", status: 400
+          render plain: "400 Bad Request: Missing parameter", status: 400
         end
       end
   
+      # Sets @notification instance variable from request parameters.
+      # @api protected
+      # @return [Object] Notification instance (Returns HTTP 403 when the target of notification is different from specified target by request parameter)
       def set_notification
         @notification = Notification.find_by_id!(params[:id])
         if @target.present? and @notification.target != @target
-          render text: "403 Forbidden: Wrong target", status: 403
+          render plain: "403 Forbidden: Wrong target", status: 403
         end
       end
 
+      # Loads notification index with request parameters.
+      # @api protected
+      # @param [String] filter Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
+      # @param [String] limit Limit to query for notifications
+      # @return [Array] Array of notification index
       def load_notification_index(filter, limit)
         limit = nil unless limit.to_i > 0
         case filter
@@ -99,19 +163,33 @@ module ActivityNotification
         end
       end
 
+      # Sets view prefixes for target view path.
+      # @api protected
       def set_view_prefixes
         lookup_context.prefixes.prepend(target_view_path)
       end
   
+      # Returns JavaScript view for ajax request or redirects to back as default.
+      # @api protected
+      # @param [String] filter Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
+      # @param [String] limit Limit to query for notifications
+      # @return [Responce] JavaScript view for ajax request or redirects to back as default
       def return_back_or_ajax(filter, limit)
+        @notifications = load_notification_index(params[:filter], params[:limit]) if params[:reload].to_s.to_boolean(true)
         respond_to do |format|
           if request.xhr?
             format.js
+          # :skip-rails4:
+          elsif Rails::VERSION::MAJOR >= 5
+            redirect_back fallback_location: { action: :index }, filter: filter, limit: limit and return
+          # :skip-rails4:
+          # :skip-rails5:
           elsif request.referer
             redirect_to :back, filter: filter, limit: limit and return
           else
             redirect_to action: :index, filter: filter, limit: limit and return
           end
+          # :skip-rails5:
         end
       end
 

data/app/controllers/activity_notification/notifications_with_devise_controller.rb

@@ -1,27 +1,36 @@
 module ActivityNotification
+  # Controller to manage notifications with Devise authentication.
   class NotificationsWithDeviseController < NotificationsController
     prepend_before_action :authenticate_devise_resource!
     before_action :authenticate_target!
     
     protected
 
+      # Authenticate devise resource by Devise (e.g. calling authenticate_user! method).
+      # @api protected
+      # @todo Needs to call authenticate method by more secure way
+      # @return [Responce] Redirects for unsigned in target by Devise, returns HTTP 403 without neccesary target method or returns 400 when request parameters are not enough
       def authenticate_devise_resource!
         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
+            render plain: "403 Forbidden: Unauthenticated", status: 403
           end
         else
-          render text: "400 Bad Request: Missing parameter", status: 400
+          render plain: "400 Bad Request: Missing parameter", status: 400
         end
       end
 
+      # Authenticate the target of requested notification with authenticated devise resource.
+      # @api protected
+      # @todo Needs to call authenticate method by more secure way
+      # @return [Responce] Returns HTTP 403 for unauthorized target
       def authenticate_target!
         current_resource_method_name = "current_#{params[:devise_type].to_resource_name}"
         unless @target.authenticated_with_devise?(send(current_resource_method_name))
-          render text: "403 Forbidden: Unauthorized target", status: 403
+          render plain: "403 Forbidden: Unauthorized target", status: 403
         end
       end
 

data/app/mailers/activity_notification/mailer.rb

@@ -1,7 +1,10 @@
 if defined?(ActionMailer)
+  # Mailer for email notification of ActivityNotificaion.
   class ActivityNotification::Mailer < ActivityNotification.config.parent_mailer.constantize
     include ActivityNotification::Mailers::Helpers
 
+    # Sends notification email.
+    # @param [Notification] notification Notification instance to send email
     def send_notification_email(notification)
       if notification.target.notification_email_allowed?(notification.notifiable, notification.key) and 
          notification.notifiable.notification_email_allowed?(notification.target, notification.key)

data/gemfiles/Gemfile.rails-4.2

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'rails', '~> 4.2.0'
+gem 'sqlite3'
+gem 'jquery-rails'
+
+group :test do
+  gem 'ammeter'
+  gem 'timecop'
+  gem 'coveralls', require: false
+end

data/gemfiles/Gemfile.rails-4.2.lock

@@ -0,0 +1,190 @@
+PATH
+  remote: ../
+  specs:
+    activity_notification (0.0.9)
+      activerecord (>= 4.2.0)
+      i18n (>= 0.5.0)
+      railties (>= 4.2.0, < 5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.7.1)
+      actionview (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+    activerecord (4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      arel (~> 6.0)
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      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)
+    concurrent-ruby (1.0.2)
+    coveralls (0.8.15)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (>= 1.6.0, < 2)
+    devise (4.2.0)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 4.1.0, < 5.1)
+      responders
+      warden (~> 1.2.3)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    factory_girl (4.7.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.7.0)
+      factory_girl (~> 4.7.0)
+      railties (>= 3.0.0)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    jquery-rails (4.2.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)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.9.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    orm_adapter (0.5.0)
+    pkg-config (1.1.7)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.7.1)
+      actionmailer (= 4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activerecord (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.7.1)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (11.2.2)
+    responders (2.3.0)
+      railties (>= 4.2.0, < 5.1)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-rails (3.5.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sprockets (3.7.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.1.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    timecop (0.8.1)
+    tins (1.12.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    warden (1.2.6)
+      rack (>= 1.0)
+    yard (0.9.5)
+    yard-activesupport-concern (0.0.1)
+      yard (>= 0.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activity_notification!
+  ammeter
+  coveralls
+  devise (~> 4.2.0)
+  factory_girl_rails (~> 4.7.0)
+  jquery-rails
+  rails (~> 4.2.0)
+  rspec-rails (~> 3.5.1)
+  simplecov (~> 0.12.0)
+  sqlite3
+  timecop
+  yard (~> 0.9.5)
+  yard-activesupport-concern (~> 0.0.1)
+
+BUNDLED WITH
+   1.12.5