Class: ActionDispatch::Routing::Mapper

Inherits:
Object
  • Object
show all
Defined in:
lib/activity_notification/rails/routes.rb

Overview

Extended ActionDispatch::Routing::Mapper implementation to add routing method of ActivityNotification.

Instance Method Summary collapse

Instance Method Details

#notify_to(*resources, *options) ⇒ ActionDispatch::Routing::Mapper

Includes notify_to method for routes, which is responsible to generate all necessary routes for activity_notification.

When you have an User model configured as a target (e.g. defined acts_as_target), you can create as follows in your routes:

notify_to :users

This method creates the needed routes:

# Notification routes
  user_notifications          GET    /users/:user_id/notifications(.:format)
    { controller:"activity_notification/notifications", action:"index", target_type:"users" }
  user_notification           GET    /users/:user_id/notifications/:id(.:format)
    { controller:"activity_notification/notifications", action:"show", target_type:"users" }
  user_notification           DELETE /users/:user_id/notifications/:id(.:format)
    { controller:"activity_notification/notifications", action:"destroy", target_type:"users" }
  open_all_user_notifications POST   /users/:user_id/notifications/open_all(.:format)
    { controller:"activity_notification/notifications", action:"open_all", target_type:"users" }
  move_user_notification      POST   /users/:user_id/notifications/:id/move(.:format)
    { controller:"activity_notification/notifications", action:"move", target_type:"users" }
  open_user_notification      POST   /users/:user_id/notifications/:id/open(.:format)
    { controller:"activity_notification/notifications", action:"open", target_type:"users" }

When you use devise authentication and you want make notification targets assciated with devise, you can create as follows in your routes:

notify_to :users, with_devise: :users

This with_devise option creates the needed routes assciated with devise authentication:

# Notification with devise routes
  user_notifications          GET    /users/:user_id/notifications(.:format)
    { controller:"activity_notification/notifications_with_devise", action:"index", target_type:"users", devise_type:"users" }
  user_notification           GET    /users/:user_id/notifications/:id(.:format)
    { controller:"activity_notification/notifications_with_devise", action:"show", target_type:"users", devise_type:"users" }
  user_notification           DELETE /users/:user_id/notifications/:id(.:format)
    { controller:"activity_notification/notifications_with_devise", action:"destroy", target_type:"users", devise_type:"users" }
  open_all_user_notifications POST   /users/:user_id/notifications/open_all(.:format)
    { controller:"activity_notification/notifications_with_devise", action:"open_all", target_type:"users", devise_type:"users" }
  move_user_notification      POST   /users/:user_id/notifications/:id/move(.:format)
    { controller:"activity_notification/notifications_with_devise", action:"move", target_type:"users", devise_type:"users" }
  open_user_notification      POST   /users/:user_id/notifications/:id/open(.:format)
    { controller:"activity_notification/notifications_with_devise", action:"open", target_type:"users", devise_type:"users" }

Examples:

Define notify_to in config/routes.rb

notify_to :users

Define notify_to with options

notify_to :users, only: [:open, :open_all, :move]

Integrated with Devise authentication

notify_to :users, with_devise: :users

Parameters:

  • resources (Symbol) —

    Resources to notify

Options Hash (*options):

  • :with_devise (Symbol) —

    Devise resources name for devise integration. Devise integration will be enabled by this option.

  • :controller (String) —

    controller option as resources routing

  • :as (Symbol) —

    as option as resources routing

  • :only (Array) —

    only option as resources routing

  • :except (Array) —

    except option as resources routing

Returns:



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/activity_notification/rails/routes.rb', line 60

def notify_to(*resources)
  options = resources.extract_options!
  
  #TODO check resources if it includes target module

  if (with_devise = options.delete(:with_devise)).present?
    options[:controller] ||= "activity_notification/notifications_with_devise"
    options[:as]         ||= "notifications"
    #TODO check devise configuration in model
    devise_defaults        = { devise_type: with_devise.to_s }
  else
    options[:controller] ||= "activity_notification/notifications"
  end
  options[:except]       ||= []
  options[:except].concat( [:new, :create, :edit, :update] )
  notification_resources   = options[:model] || :notifications

  #TODO other options
  # :as, :path_prefix, :path_names ...

  resources.each do |resource|
    self.resources resource, only: :none do
      options[:defaults] = (devise_defaults || {}).merge({ target_type: resource.to_s })
      self.resources notification_resources, options do
        collection do
          post :open_all unless ignore_path?(:open_all, options)
        end
        member do
          get  :move     unless ignore_path?(:move, options)
          post :open     unless ignore_path?(:open, options)
        end
      end
    end
  end

  self
end