nebtrx / hello

Enjoyable Rails User Registration

Hello

Enjoyable Rails Authentication.

We are very excited and looking forwards to our release of version 0.1.0

Please take a look at our issues, all help is appreciated.

Status

Tested With

Ruby Versions	Rails Versions
Ruby 2.2.2	Rails 4.2.*
JRuby (submit a PR)	Rails 5 beta
RBX (submit a PR)

Running Tests

Please read Running Tests

Install

Add this line to your application's Gemfile:

gem 'hello', github: 'hello-gem/hello' # latest from github while this gem is in rapid development
gem 'bcrypt', '~> 3.1' # bcrypt is highly recommended

And then execute:

bundle install
bundle exec rails generate hello:install
bundle exec rake db:migrate

Customizing - behavior and views

These files are generated when you install this gem.

They are simple to customize, just open them.

├── app/
│   ├── controllers/
│   │   ├── hello/
│   │   │   └── concerns/
│   │   │       └── [...optional...]
│   │   ├── onboarding_controller.rb
│   │   └── users_controller.rb
│   │
│   ├── models/
│   │   ├── credential.rb
│   │   ├── active_session.rb
│   │   └── user.rb
│   │
│   ├── views/
│   │   ├── hello/
│   │   │   └── [...optional...]
│   │   ├── layouts/
│   │   │   └── application.html.erb
│   │   ├── onboarding/
│   │   │   └── index.html.erb
│   │   └── users/
│   │       ├── index.html.erb
│   │       └── show.html.erb
│   │
├── config/
│   └── initializers
│       └── hello.rb
│
└── db/
    └── migrate/
        ├── 1_create_credentials.hello.rb
        ├── 2_create_accesses.hello.rb
        └── 3_create_users.hello.rb

Customizing

class User < ActiveRecord::Base
  def user?
    %w(user webmaster).include?(role)
  end
end

module Hello
  module Concerns
    module EmailSignUpOnSuccess

      def on_success
        deliver_welcome_email
        deliver_confirmation_email
        redirect_to root_path
      end

    end
  end
end

Demo

Want to see it in action?

• Visit https://bit.ly/hellogem
• Sources at https://github.com/hello-gem/hello_demo

References

• Home page: https://github.com/hello-gem/hello
• API Doc: https://github.com/hello-gem/hello
• Version: https://github.com/hello-gem/hello
• Trello Board: https://trello.com/b/WwNptyVM/hello-gem

Support

• Bugs/Issues: https://github.com/hello-gem/hello/issues
• Support: http://stackoverflow.com/questions/tagged/hello
• Support/Chat:

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.

Brian Landau and Ryan Foster for NavLynx as well as everybody on the Bootstrap Team as we use these open source projects on our generated view code.

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

Contributing With Translations

Link to Translation files

Link to Our Locale Contributors

1. change the initializer config.locales = %w(en es pt-BR <NL>)
2. dummy initializer spec/dummy/config/initializers/hello.rb
3. initializer template lib/generators/hello/install/templates/initializer.rb
4. update locale test in spec/controllers/localization_spec.rb
5. create and modify the locale file config/locales/hello.<NEW_LANGUAGE>.yml
6. ensure consistency with this test bundle exec rspec spec/others/localization_consistency_spec.rb spec/controllers/localization_spec.rb
7. Thank You! Submit your Pull Request :)

Versioning

Hello uses Semantic Versioning 2.0.0

Copyright

Copyright 2013-2014 James Pinto – Released under MIT License

Additional

Look for these terms in the source code

"TODO", "KNOWNBUG"

Known bugs

1. (Rails 4.0 only) Top Feature Set: Current User Feature Set: Settings Feature: Cancel Account Invalid Scenarios Validation: has_many restrict_with_error Scenario 2: User has dependent grandchildren

To Do

1. One translation missing: config/locales/*.yml

2. Test this method: Hello::Railsy::Controller::AccessRestrictionConcern::ClassMethods#restrict_if_role_is

3. Generate Access Token Feature