Invitable

Rails 3 generic mail invitation manager.

NOTE: You should have a User model, that identify the sender of invite.

Installation

Add this line to your application's Gemfile:

gem 'invitable'

And then execute:

$ bundle

Or install it yourself as:

$ gem install invitable

Configure

• Run migration generator

  rails generate invitable:migration
  

• Run the migrations

  rake db:migrate
  

• Include the module Invitable::Base on User model.

  class User < ActiveRecord::Base
    include Invitable::Base
  end

• Define a method process_invitation! on your invitable model. This method contains the business logic related to acceptance of invitations

class User < ActiveRecord::Base
  include Invitable::Base

  # invitee => User instance
  # invitation => Invitation instance
  def process_invitation!(invitee, invitation)
    # invitations between users are friendships invitations
    self.friends << invitee
  end
end

Usage

• Create invitation with send email logic. When invitation is accepted, the block is executed.

Invitation.invite(:user => user,
                  :hostable => user,
                  :email => email) do |invitation|
  UserMailer.friendship_confirmation(invitation).deliver
end

• Accept invitation The parameter of method accept! represents an instance of invited user.

invitation = Invitation.first()
invitation.accept!(new_user)

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Este projeto é financiado e mantido pelo Redu Educational Techologies.

Copyright

Copyright (c) 2012 Redu Educational Technologies

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.