proposal

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 12 Open GitHub ↗

Simple unobtrusive token invitation engine for rails

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Proposal [![Build Status](https://travis-ci.org/mynameisrufus/proposal.png?branch=master)](https://travis-ci.org/mynameisrufus/proposal) [![Code Climate](https://codeclimate.com/github/mynameisrufus/proposal/badges/gpa.svg)](https://codeclimate.com/github/mynameisrufus/proposal)

Simple unobtrusive token invitation engine for use with any authentication
framework. Makes no fuss and no redundant records.

## Installation

Add this line to your application's Gemfile:

gem 'proposal'

And then execute:

$ bundle

Then run migrations to add the `proposal_tokens` table:

$ rake proposal:install:migrations
    $ rake db:migrate

## Proposable Models

```ruby
class User < ActiveRecord::Base
  can_propose
end

class Project < ActiveRecord::Base
  has_proposals
end
```

## Making Proposals

For a basic proposal to the application you simply call:

```ruby
@proposal = User.propose.to('user@example.com')
```

```ruby
@proposal = @user.propose.to('user@example.com')
@proposal.proposer # => User
```

When your token is returned you need to check what to do next, for example if
the user does not exist they then need to get sent an invitation.

```ruby
@proposal = User.propose(@project).to('user@example.com')
@proposal.action #=> :invite
if @proposal.save
  @url = acceptance_url(token: @proposal)
  # send out invitation
end
```

Conversely if they are already a user then they need to get an email inviting
them or an email notifying that they have been added to something.

```ruby
@proposal = User.propose(@project).to('user@example.com')
@proposal.action #=> :notify
if @proposal.save
  @project.users << proposal.recipient
  # send out notification
end
```

Finally if the user already has an outstanding invitation they may just need a
reminder.

```ruby
@proposal = User.propose(@project).to('user@example.com')
@proposal.action #=> :invite_remind
if @proposal.reminded
  # send out reminder
end
```

All actions have convenience methods for example:

```ruby
@proposal.notify?
```

## Accepting Proposals

```ruby
@proposal = User.proposals.find_by_token 'pVBJYdr3zH4B9yXWwsmy'

@proposal.accepted? #= false
@proposal.expired? #=> false
@proposal.acceptable? #=> true

if @proposal.accept!
  @proposal.resource.users << @proposal.recipient
end
```

## Proposal Arguments

You may need to store custom arguments such as the role a user may get upon
acceptance. It also has a validator that takes an array, hash or proc.

```ruby
class User < ActiveRecord::Base
  can_propose expects: :role
end

@proposal = User.propose.with(role: 'admin').to('user@example.com')
@proposal.arguments # => :role => 'admin'
```

## Token Expiry

The default tokens expire in one year, however you can change this.

```ruby
class User < ActiveRecord::Base
  can_propose expires: -> { Time.now + 10.days }
end

@proposal = User.propose.to('user@example.com', expires_at: Time.now - 1.day)
@proposal.expired? # => true
```

## Supported Ruby Versions

* Ruby 2.2.2+
* Stick to proposal version 1.0.0 for older Ruby versions

## Supported Rails Versions

* Rails 5
* Stick to proposal version 1.0.0 for Rails 4.x
* Stick to proposal version 0.0.6 for Rails 3.x

## 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

proposal

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README