Take control of your rails app's invitation system using a set of model unique callbacks.
Add this line to your application's Gemfile:
gem 'inviter'And then execute:
$ bundleOr install it yourself as:
$ gem install inviterRun the Installer:
rails g inviter:initializer installRun new migrations:
rails db:migrateinclude the Inviterable module into your application controller
class ApplicationRecord < ActiveRecord::Base
include Inviterablethis gives you access to three 'acts_as' methods you can use to set up your invitation relations.
- acts_as_inviter
- acts_as_invitee
- acts_as_invited_to
place the acts_as_inviter method at the top of any model with the ability to send invitations
class User < ApplicationRecord
acts_as_inviterlike wise place the acts_as_invitee method wthin any model that can recieive invites. A model will frequently contain both acts_as_inviter and acts_as_invitee.
class User < ApplicationRecord
acts_as_inviter
acts_as_inviteeall invitee models have access to .invitations which returns an active record collection of all their invitee associated Invitations.
invitee = User.first
invitee.invitations == Invitations.where(invitee: invitee)Inviter models can also view there invitations using .sent_invitations
inviter = User.first
inviter.sent_invitations == Invitations.where(inviter: inviter)An inviter can use the .send_invitation method to create an invitation. The method takes a an invitee resource and invited_to model as arguments.
inviter = User.first
invitee = User.second
invited_to = Party.first
inviter.send_invitation(invitee, invited_to)place the acts_as_invited_to method in any model meant to show relation between an inviter and an invitee
class Party < ApplicationRecord
acts_as_invited_toLike an invitee, the invited_to model can access its associated invitations using .invitations
invited_to = Party.first
invited_to.invitations == Invitations.where(invited_to: invited_to)The invitation model gives you options to manipulate created invitations.
accepted? # Returns true if accepted_at IS NOT NIL
declined? # Returns true if declined_at IS NOT NIL
accepted_or_declined? #Returns true if the invitation has been accepted or declined
accept #Accepts an invitation not already accepted or declined
decline #Declines an invitation not already accepted or declined
reset #Sets the declined_at and accepted_at timestamps to nilWhen an valid action is done on an invitation, all invitee, inviter, and invited_to models are sent an associated _callback method for response. The valid actions are create, accept, declined and reset. To view the method name that each action will create use the Inviter::InvitationCallbacks module. The Inviter::InvitationCallbacks module contains a callback generator for each available valid action.
Inviter::InvitationCallbacks.invitation_created_callback
Inviter::InvitationCallbacks.invitation_accepted_callback
Inviter::InvitationCallbacks.invitation_declined_callback
Inviter::InvitationCallbacks.invitation_reset_callbackThese methods take an inviter, invitee, and invited_to instance class as arguments and return a method name string. For example:
args = [User.first, User.second, Party.first]
Inviter::InvitationCallbacks.invitation_created_callback(*args)
#=> 'user_invited_user_to_party'
Inviter::InvitationCallbacks.invitation_accepted_callback(*args)
#=> 'user_accepted_invite_from_user_to_party'
Inviter::InvitationCallbacks.invitation_declined_callback(*args)
#=> 'user_declined_invite_from_user_to_party'
Inviter::InvitationCallbacks.invitation_reset_callback
#=> 'user_reset_invite_from_user_to_partyclass Party < ApplicationRecord
acts_as_invited_to
has_many :user_parties
has_many :users, through: :user_parties
endclass UserParty < ApplicationRecord
belongs_to :user
belongs_to :party
endclass User < ApplicationRecord
acts_as_inviter
acts_as_invitee
has_many :user_parties
has_many :parties, through: :user_parties
private
class << self
def user_invited_user_to_party(invitation)
# Do Something when user invites user to party
UserMailer.invitatation_sent_email
end
def user_accepted_invite_from_user_to_party(invitation)
# Add user to party users collection
invitation.invited_to.users << invitation.invitee
end
def user_declined_invite_from_user_to_party(invitation)
# Do Something when user declined invite from user to party
UserMailer.invitation_declined_email
end
def user_reset_invite_from_user_to_party(invitation)
# Do Something when user resets invite from user to party
UserMailer.invitation_reset_email
end
end
endThese same methods would also be executed on the Party Model if they existed. Each callback method also brings its associated invitation through the invitations variable.
TBA
The gem is available as open source under the terms of the MIT License.