Reviewed::Auth

A Central Authentication Service (CAS) for Reviewed (Next) applications. The service can be run as a stand alone application or mounted to a Rails or Sinatra application.

Installation

Add this line to your application's Gemfile:

gem 'reviewed-auth', github: "reviewed/reviewed-auth"

And then execute:

$ bundle

Usage

Rails 3.x

To mount the CAS to a Rails application add the following route to routes.rb:

mount Reviewed::Auth::LoginController => "/auth"

Configuration

  • api_host_path : REQUIRED. You must set this to the URL of The Guide. Reviewed::Auth.api_host_path = "https://api.reviewed.com/api/v1"
  • drop_cookie : Defaults to false. If set to true this will drop a cookie named _reviewed_token with the user's API token as it's value. This can be passed as a query parameter or set using Reviewed::Auth.drop_cookie = true.
  • return_url : Defaults to /. This can be passed as a query parameter or set using Reviewed::Auth.return_url = 'http://www.example.com'. If the drop_cookie setting is set to false the parameter of _reviewed_token will be appended to the return_url value when the redirect occurs.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request