Ember Simple Auth Tok

This is an extension to the Ember Simple Auth library that provides an authenticator and authorizer that are compatible with Ruby on Rails token-based authentication plugin Tok.

Installation

To install Ember Simple Auth Tok in an Ember.js application you have three options:

If you are using Ember CLI, just add the Ember CLI addon to your project (run the two installation commands and you're all set).
Ember Simple Auth Tok is also packaged as a bower component, offering an AMD build in addition to a browserified version. If you're using the AMD build from bower, be sure to require the autoloader as follows:
```
require('/simple-auth-tok/ember');
```
You can also download a pre-built version from the releases page.

Usage

This section explains how to use the extension along with Ember Simple Auth and Tok.

Server-side setup

Refer to Tok's repository for more information on how to get Tok working with a Rails::API app.

Client-side setup

Start with creating a new Ember CLI application if you haven't already.

ember new my_app

Adding Ember Simple Auth is actually fairly easy to do, just install its Ember CLI addon in your application directory:

npm install --save-dev ember-cli-simple-auth

and then run the generator:

ember generate ember-cli-simple-auth

Likewise, do the same for this extension using the installation section above. Done? Let's continue then. We will start by creating some routes, in your app/router.js file add the following routes:

Router.map(function() {
  // Routes for handling authentication and invalidation.
  this.route('login');
  this.route('logout');

  // And a protected route.
  this.route('protected');
});

The easiest way to use the session is by including the ApplicationRouteMixin in your application route, this will make the session available in all routes and controllers of the application. To do this, create a new route at app/routes/application.js

import ApplicationRouteMixin from 'simple-auth/mixins/application-route-mixin';

export default Ember.Route.extend(ApplicationRouteMixin);

Since we want the application to require the session to be authenticated when /protected is accessed, we will use the AuthenticatedRouteMixin provided by Ember Simple Auth in our app/routes/protected.js route:

import AuthenticatedRouteMixin from 'simple-auth/mixins/authenticated-route-mixin';

export default Ember.Route.extend(AuthenticatedRouteMixin);

This goes the same for any other route we want to protect. To avoid having to repeat that for each route you want to require authentication for, create an authenticatedRoute or something and ensure all protected routes will extend that one:

// app/routes/authenticated.js
import AuthenticatedRouteMixin from 'simple-auth/mixins/authenticated-route-mixin';

var AuthenticatedRoute = Ember.Route.extend(AuthenticatedRouteMixin);

export default AuthenticatedRoute; 

// app/routes/protected_one.js
import AuthenticatedRoute from './authenticated';

export default AuthenticatedRoute.extend();

// app/routes/protected_two.js
import AuthenticatedRoute from './authenticated';

export default AuthenticatedRoute.extend();

Next, you need to specify you're going to use a custom authenticator (in our case, authenticator:tok) in your login controller, to do so, create a controller at app/controllers/login.js:

Contributing

Contributions are welcome. Please follow the instructions below to get started:

Fork the repository.
Create a branch for your edits, e.g. git checkout -b fix-authentication.
Usually, you're expected to write tests for your changes. Please refer to the section below on how to get tests running.
Make any necessary changes to the documentation to reflect your changes.
Submit a pull request. Please be sure to include a descriptive title and some information about the changes you've made, why they should be included and so on.

Running tests

To run tests, you need to have node.js and bower installed. If you have those, simply run:

git clone https://github.com/ahazem/ember-simple-auth-tok

then cd into ember-simple-auth-tok:

cd ember-simple-auth-tok

and install npm dependencies:

npm install -D

and bower dependencies as well:

bower install

then you can run the following command:

grunt test

License

See LICENSE.

ahazem / ember-simple-auth-tok