SixArm.com » Ruby » SignIn abstract interface for apps
Ruby
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.yardoc
doc
lib
test
.codeclimate.yml
.document
.gemtest
.gitattributes
.gitignore
.rspec
.travis.yml
CHANGES.md
CONTRIBUTING.md
Gemfile
LICENSE.md
README.md
Rakefile
VERSION
sixarm_ruby_sign_in-1.2.0-sha512.txt
sixarm_ruby_sign_in-1.2.0.gem
sixarm_ruby_sign_in.gemspec

README.md

SixArm.com → Ruby →
SignIn abstract interface for apps

Gem Version Build Status Code Climate Coverage Status

Introduction

SignIn is a simple abstract framework for apps.

You can include this module in a Rails application controller, then your controller can define any of these concrete methods.

For docs go to http://sixarm.com/sixarm_ruby_sign_in/doc

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

Install

Gem

Run this command in your shell or terminal:

gem install sixarm_ruby_sign_in

Or add this to your Gemfile:

gem 'sixarm_ruby_sign_in'

Require

To require the gem in your code:

require 'sixarm_ruby_sign_in'

Details

This provides one top-level method:

sign_in(options=nil) => true for success, false for failure

The top level method will call mid-level methods that you will define in your own controller.

sign_in calls:

sign_in_attempt(options=nil), e.g. authenticate and set current user
sign_in_success(options=nil), e.g. redirect to a welcome page
sign_in_failure(options=nil), e.g. flash notice help messesage

AuthLogic Example

AuthLogic provides this example:

def create
  # sign in attempt
  @user_session = UserSession.new(params[:user_session])
  if @user_session.save
    # sign in success
    redirect_to account_url
  else
    # sign in failure
    render :action => :new
  end
end

AuthLogic example refactored for improved security and structure:

def sign_in_attempt
  @user_session = UserSession.new(params[:user_session])
  @user_session.save
end

def sign_in_success
  redirect_to account_url
end

def sign_in_failure
 render :action => :new
end