An open API service indexing awesome lists of open source software.

https://github.com/sixarm/sixarm_ruby_sign_out_simple

SixArm.com » Ruby » SignOutSimple provides typical sign out for a Rails web application
https://github.com/sixarm/sixarm_ruby_sign_out_simple

authentication gem rails ruby

Last synced: 2 months ago
JSON representation

SixArm.com » Ruby » SignOutSimple provides typical sign out for a Rails web application

Awesome Lists containing this project

README

          

# SixArm.com → Ruby →
SignOutSimple gem for typical Rails user sign out

[![Gem Version](https://badge.fury.io/rb/sixarm_ruby_sign_out_simple.svg)](http://badge.fury.io/rb/sixarm_ruby_sign_out_simple)
[![Build Status](https://travis-ci.org/SixArm/sixarm_ruby_sign_out_simple.png)](https://travis-ci.org/SixArm/sixarm_ruby_sign_out_simple)
[![Code Climate](https://api.codeclimate.com/v1/badges/1073c786b54e72b32fe2/maintainability)](https://codeclimate.com/github/SixArm/sixarm_ruby_sign_out_simple/maintainability)

* Git:
* Doc:
* Gem:
* Contact: Joel Parker Henderson,
* Project: [changes](CHANGES.md), [license](LICENSE.md), [contributing](CONTRIBUTING.md).

## Introduction

SignInSimple provides methods for authentication in apps, such as typical Ruby On Rails web applications.

SignOutSimple clears the current user and shows a flash message.

For docs go to

Want to help? We're happy to get pull requests.

## Install

### Gem

To install this gem in your shell or terminal:

gem install sixarm_ruby_sign_out_simple

### Gemfile

To add this gem to your Gemfile:

gem 'sixarm_ruby_sign_out_simple'

### Require

To require the gem in your code:

require 'sixarm_ruby_sign_out_simple'

## Details

The controller must define this method to clear the user:

current_user=(nil)

Routes must be able to redirect_to:

:sign_out_success
:sign_out_failure