Contents

#
# Any model you wish to invite users to join should extend this concern. This is typically an
# organization or resource with limited membership like an "account" or "project".
#
# Your code is responsible for managing associations between your Invitable and your user model.
#
# For example, to make the model class Account an organization that can receive an invitation
#
#     class Account < ActiveRecord::Base
#       invitable named_by: :name
#
#       has_many :account_memberships
#       has_many :users, through: :account_memberships
#     end
#
#
module Invitation
  module Invitable

    def invitable(options = {})
      has_many :invites, as: :invitable
      class_attribute :invitable_options

      self.invitable_options = options.dup # named_by: :name, named: 'Gug'
      self.invitable_options[:named_by] = options[:named_by] if options[:named_by]
      self.invitable_options[:named] = options[:named] if options[:named]

      unless self.invitable_options[:named] || self.invitable_options[:named_by]
        raise <<-eos
invitable requires options be set, either :name or :named_by.
  invitable named: "string"
or
  invitable named_by: :method_name
eos
      end

      include Invitation::Invitable::InstanceMethods
    end


    module InstanceMethods

      # Add the invited user to the organization. Called by InvitesController.
      def add_invited_user(user)
        method = Invitation.configuration.user_model.name.underscore.pluralize
        self.send(method).push(user)
      end

      # Get the name of the organization for use in invitations.
      def invitable_name
        if invitable_options[:named_by]
          self.send(invitable_options[:named_by])
        elsif invitable_options[:named]
          invitable_options[:named]
        else
          raise 'Invitation runtime error: invitable does not have name: or named_by: set, should not be possible! ' +
              self.inspect
        end
      end
    end

  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
invitation-0.1.1	lib/invitation/invitable.rb
invitation-0.1.0	lib/invitation/invitable.rb
invitation-0.0.2	lib/invitation/invitable.rb
invitation-0.0.1	lib/invitation/invitable.rb