Skip to content

Latest commit

 

History

History
163 lines (112 loc) · 6.45 KB

readme.textile

File metadata and controls

163 lines (112 loc) · 6.45 KB
Raw

Casino Logo

Casino! – user management for Play! framework

This project provides a simple method to integrate user registration and password recovery to your project.
The cool thing is that it is based on play’s security concept. So we don’t re-invent the wheel
but simply add some stuff.

Features

  • Signup / Registration of new users
  • Sending of signup email for email verification
  • Password recovery when user lost password
  • Views fully customizable
  • ReCaptcha protection against bots
  • Login via different url (eg. login / registration via https, rest of app handled via http)
  • Simple management of arbitrary roles
  • AfterUserCreationHook => do something when a user has been created in your db
  • Built-in Support for Siena ORM (dependency casinosiena) and JPA (module casinojpa)
  • Own user model with any ORM you like can be used
  • Integrated bcrypt support for password hashing

Getting started

Basic configuration (uses siena mapper by default)

  • Add – play → casino-xx to your dependencies.yml
    • For JPA support: Add – play → casinojpa-xx to your dependencies.yml
    • For Siena support: Add – play → casinosiena-xx to your dependencies.yml
  • Add the following properties to your application conf:

Please check out also the test configuration at https://github.com/reyez/casino-play/blob/master/casino-test/conf/application.conf

Basic routes

I would recommend checking out the source of casino-test. If you run the application using play test you can examine everything.

Basic routes provided:

  • /login
  • /logout
  • /registration
  • /registration/lostpassword

Advanced configuration

Custom views

Most likely you’ll find Casino!’s views nasty and not fitting your nicely crafted ui design. We know that :) And in
fact you can and should implement your own views and email message templates. Simply copy the directory
structure of app/views/casino and style them the way you want.

Two different urls for http / https – aka secure login

Transmitting passwords should ALWAYS go to https. Regular traffic to your website not necessarily. Casino!
supports sending your password to a secure url and redirecting to the regular http. Casino! signs both
urls with the play! cookie. So your app runs on both urls.

This is for instance needed on Google AppEngne. https is server off https://myapp.appspot.com, but regularily you
want the user being able to use http://www.myapp.com. Using Casino! you can simply specify

AfterUserCreationHook

If you use the standard User models distributed by Casino! you are getting all you need: Password management for a user, role management and more.
But sometimes you need more. Generate a Settings Entity right after a user is executed for instance.

The way to accomplish this in Casino! is simple:

  • Implement a class in your project that inherits casino.AfterUserCreationHook
  • Implement method execute(String email) – this method will be called right after a user is created in your database.
  • in your application.conf file specify a new parameter casino.afterUserCreationHook and specify the class you just created
    • casino.afterUserCreationHook=myapplication.MySpecialAfterUserCreationHook

Your own User model

You can use your own way of handling user management. You’ll still profit of all basic functions Casino! provides: password hashing, all views responsible for signup and password recovery.
The only thing you have to do is implementing your own CasinoUserManager.

  • Implement a class in your project that inherits casino.CasinoUserManager
  • Implement all methods.
  • in your application.conf file specify a new parameter casino.userManager and specify the class you just created

And that’s it.

More getting started

Implementation details

  • Uses siena for persistence of the user object
  • Uses bcrypt to hash password (should be safe in the next years)
  • Uses re-captcha to block bots from using your stuff
  • complete selenium usecase is at casino-test/test/!RegistrationLifecycle.html

Develop

Next possible todos

  • Time based invalidation for confirmation codes in User model
  • OAuth integration => facebook login / google login (module securesocial?)
  • Deadbolt integration?

Setup and develop

  • clone sources from github
  • generate a link to casino from your play/modules directory:
  • ln -s mycheckoutdirectory/casino-play/casino casino-0.x (x is the version you want to reference)
  • run “play deps —sync” and “play ec” in both casino and casino-test
  • run “play auto-test” in casino-test – the result should be “All tests passed”

~ 7 tests to run:
~
~ models/casino/UserTest… PASSED 0s
~ ApplicationTest… PASSED 1s
~ controllers/casino/AfterUserCreationHookTest… PASSED 0s
~ controllers/casino/BaseFunctionalTest… PASSED 0s
~ controllers/casino/Helper… PASSED 0s
~ controllers/casino/SecurityCasinoTest… PASSED 1s
~ RegistrationLifecycle… PASSED 11s
~
~ All tests passed

  • import projects into eclipse if you wish

… Happy coding :)

Test

  • Test project is under casino-test
  • Run tests via “play test” or “play auto-test”

Release

  • play build-module
  • Use /dist/casino-0.X.zip for distribution :)

Friends on the road

Supported by FinalFrontierLabs]