Referable

Referable provides you with a generator that happily creates a multi-tenant referral system for your app with rewards, in just two steps.

rails g referable user && rails db:migrate

ReferableReward.create! reward: 'A new car',
                        referrals_required: 10,
                        acquireable_by: 'user'

aaand... you're done!

user = User.first

user.recruits
#=> #<ActiveRecord::Associations::CollectionProxy [...]>

user.recruits << User.create(name: 'Dan')
#=> #<ActiveRecord::Associations::CollectionProxy [...]>

user.referrals.count
#=> 1

user.distance_to_next_reward
#=> 9

user.percent_to_next_reward
#=> 10.0

user.last_acquired_reward.name
#=> 'nothing'

Installation

Add this line to your application's Gemfile:

gem 'referable'

And then execute:

$ bundle

Or install it yourself:

gem install referable

Usage

The generator modifies an existing Rails model to allow referral functionality. The model does not need to have any other dependencies.

To enable referrals for a specific model, run

rails generate referable name_of_model

This will create the necessary migration(s). Next, check the contents of the migrations. Notably, the add_referral_fields_to_XXX migration, as this updates each record for your model with a referral slug.

Then,

rails db:migrate

This can be added for any number of models in your application.

Creating rewards

Rewards are set for each model type individually. IE a President will have a different set of rewards to a PrimeMinister.

Creating rewards is as simple as:

ReferableReward.create! reward: 'A new car',
                        referrals_required: 10,
                        acquireable_by: 'user'

Callback when model reaches a reward

Want to notify someone or do something when a user acquires a new reward? Just hook in to Referable#acquired_reward!

Adding a recruit in devise

At eola, we hook in to the Devise::RegistrationsController#post action, checking for the referral slug in the params. If it exists, the user is given the new recruit.

Development

There are currently no tests 😭 as this was ported over from tested code in another app. Coming soon TM.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/eola/referable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Referable project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.