/hello

Rails Gem to authenticate you and your users

Primary LanguageRubyMIT LicenseMIT

Hello

We want enjoyable Rails authentication

This gem is in rapid development, can be used in production by Rails experts

Status

Build Status

Code Climate

Code Climate

Dependency Status

Inline docs

References

Support

Requirements and Compatibility

  • Ruby 1.9+
  • Rails 4.0+

Demo

Want to see it in action?

Installation

Add this line to your application's Gemfile:

gem 'hello', github: 'hello-gem/hello' # latest from github while this gem is in rapid development

And then execute:

bundle
rails g hello:install
rake db:migrate
rails g hello:views # optional

Customizing - behavior and views

These files are generated when you install this gem. They are simple to customize, just open them

+ app/
| + lib/
| | + hello/
| |   - sign_up.rb
| |   - sign_in.rb
| |   - sign_out.rb
| |   - forgot.rb
| |   - reset.rb
| + view/
|   + hello/
|       ...

Usage

TODO: review usage instructions

You only need to include our module in your User class

class User < ActiveRecord::Base
  include Hello::UserModel

  # uncomment the line below if you want username
  # validates_presence_of :username

end

We let you customize everything

class Credential < ActiveRecord::Base
  include Hello::CredentialModel

  def encrypt_password(plain_text_password)
    BCrypt::Password.create(plain_text_password)
  end

end

Thank You

Tim Lucas, John Nunemaker, Dan Everton and Johan Andersson or their open source gem user_agent_parser. As well as Tobie Langel and everybody involved in BrowserScope (full list), as our device and browser detection derives from their open-source work.

Iain Hecker for his open source gem http_accept_language that helps us understand browser's favorite locales.

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

Versioning

Hello uses Semantic Versioning 2.0.0

Copyright

Copyright 2013-2014 James Pinto – Released under MIT License