Added an optional username field to User model. Mongo makes this easy without an…

…y need for migrations, and I made my implementation as unintrusive as possible. Some organizations (such as ours) will find the "username" field useful when implementing an alternative authentication strategy. (Default is off, and this is fully backwards compatible.)

Added an optional username field to User model. Mongo makes this easy without an…
…y need for migrations, and I made my implementation as unintrusive as possible. Some organizations (such as ours) will find the "username" field useful when implementing an alternative authentication strategy. (Default is off, and this is fully backwards compatible.)
Nathan Broadbent
1 parent 9c3b6ba9
Showing 11 changed files with 62 additions and 10 deletions Show diff stats
README.md
app/models/user.rb
app/views/users/_fields.html.haml
app/views/users/index.html.haml
app/views/users/show.html.haml
config/config.example.yml
config/initializers/devise.rb
config/initializers/overrides.rb
config/locales/devise.en.yml
db/seeds.rb
lib/overrides/devise/failure_app.rb
@@ -100,11 +100,13 @@ for you. Checkout [Hoptoad](http://hoptoadapp.com) from the guys over at
 **Configuring LDAP authentication:**
-Follow the instructions at https://github.com/cschiewek/devise_ldap_authenticatable
+  1. In `config/config.yml`, set `user_has_username` to `true`
+  2. Follow the instructions at https://github.com/cschiewek/devise_ldap_authenticatable
+  to set up the devise_ldap_authenticatable gem.
-If you want to authenticate via `username`, add the following lines to `app/models/user.rb`:
+  3. If you are authenticating by `username`, you will need to set the user's email
+  after authentication. You can do this by adding the following lines to `app/models/user.rb`:
-          field :username
           before_save :set_ldap_email
           def set_ldap_email
             self.email = Devise::LdapAdapter.get_ldap_param(self.username, "mail")
@@ -19,6 +19,11 @@ class User
   attr_protected :admin
+  if Errbit::Config.user_has_username
+    field :username
+    validates_presence_of :username
+  end
+
   # Mongoid doesn't seem to currently support
   # referencing embedded documents
   def watchers
@@ -3,7 +3,12 @@
 .required
   = f.label :name
   = f.text_field :name
-  
+
+- if Errbit::Config.user_has_username
+  .required
+    = f.label :username
+    = f.text_field :username
+
 .required
   = f.label :email
   = f.text_field :email
@@ -11,11 +16,11 @@
 .required
   = f.label 'Entries per page'
   = f.select :per_page, [10, 20, 30, 50, 75, 100]
-  
+
 .required
   = f.label :password
   = f.password_field :password
-  
+
 .required
   = f.label :password_confirmation
   = f.password_field :password_confirmation
@@ -23,4 +28,5 @@
 - if current_user.admin?
   .checkbox
     = f.check_box :admin
-    = f.label :admin, 'Admin?'
 \ No newline at end of file
+    = f.label :admin, 'Admin?'
+
@@ -6,13 +6,17 @@
   %thead
     %tr
       %th Name
+      - if Errbit::Config.user_has_username
+        %th Username
       %th.main Email
       %th Admin?
   %tbody
     - @users.each do |user|
       %tr
         %td.nowrap= link_to user.name, user_path(user)
+        - if Errbit::Config.user_has_username
+          %td= user.username
         %td= user.email
         %td= user.admin? ? 'Y' : 'N'
 = will_paginate @users, :previous_label => '&laquo; Previous', :next_label => 'Next &raquo;'
-      
 \ No newline at end of file
+
@@ -8,6 +8,10 @@
   %tr
     %th Email
     %td.main= @user.email
+  - if Errbit::Config.user_has_username
+    %tr
+      %th Username
+      %td.main= @user.username
   %tr
     %th Admin?
     %td= @user.admin? ? 'Y' : 'N'
@@ -6,6 +6,7 @@
 # be copied to shared/config on the server when
 # `cap deploy:setup` is ran the first time. Be sure
 # to place production specific settings there
+# You will need to restart the server after changing any settings.
 # The host of your errbit server
 host: errbit.example.com
@@ -26,3 +27,7 @@ email_at_notices: [1, 10, 100]
 # Configure whether or not the user should be prompted before resolving an error.
 confirm_resolve_err: true
+# Add an optional 'username' field to Users.
+# Helpful if you want to plug in your own authentication strategy.
+user_has_username: false
+
@@ -20,7 +20,7 @@ Devise.setup do |config|
   # authenticating an user, both parameters are required. Remember that those
   # parameters are used only when authenticating and not when retrieving from
   # session. If you need permissions, you should implement that in a before filter.
-  # config.authentication_keys = [ :email ]
+  config.authentication_keys = [ Errbit::Config.user_has_username ? :username : :email ]
   # Tell if authentication through request.params is enabled. True by default.
   # config.params_authenticatable = true
@@ -140,3 +140,4 @@ Devise.setup do |config|
   #   manager.default_strategies(:scope => :user).unshift :twitter_oauth
   # end
 end
+
 require Rails.root.join('lib/overrides/mongoid/relations/builder.rb')
+require Rails.root.join('lib/overrides/devise/failure_app.rb')
+
@@ -10,7 +10,10 @@ en:
       unauthenticated: 'You need to sign in before continuing.'
       unconfirmed: 'You have to confirm your account before continuing.'
       locked: 'Your account is locked.'
-      invalid: 'Invalid email or password.'
+      invalid: 'Invalid login details.'
+      user:
+        email_invalid: 'Invalid email or password.'
+        username_invalid: 'Invalid username or password.'
       invalid_token: 'Invalid authentication token.'
       timeout: 'Your session expired, please sign in again to continue.'
       inactive: 'Your account was not activated yet.'
@@ -37,3 +40,4 @@ en:
         subject: 'Reset password instructions'
       unlock_instructions:
         subject: 'Unlock Instructions'
+
@@ -2,10 +2,12 @@ puts &quot;Seeding database&quot;
 puts "-------------------------------"
 # Create an initial Admin User
+admin_username = "errbit"
 admin_email = "errbit@#{Errbit::Config.host}"
 admin_pass  = 'password'
 puts "Creating an initial admin user:"
+puts "-- username: #{admin_username}" if Errbit::Config.user_has_username
 puts "-- email:    #{admin_email}"
 puts "-- password: #{admin_pass}"
 puts ""
@@ -16,6 +18,8 @@ user = User.where(:email =&gt; admin_email).first || User.new({
   :password               => admin_pass,
   :password_confirmation  => admin_pass
 })
+user.username = admin_username if Errbit::Config.user_has_username
 user.admin = true
 user.save!
+
@@ -0,0 +1,15 @@
+Devise::FailureApp.class_eval do
+  protected
+    # Handles both 'email_invalid' and 'username_invalid' messages.
+    def i18n_message(default = nil)
+      message = warden.message || warden_options[:message] || default || :unauthenticated
+
+      if message.is_a?(Symbol)
+        I18n.t(:"#{scope}.#{Devise.authentication_keys.first}_#{message}", :resource_name => scope,
+               :scope => "devise.failure", :default => [message, message.to_s])
+      else
+        message.to_s
+      end
+    end
+end
+
1	require Rails.root.join('lib/overrides/mongoid/relations/builder.rb')	1	require Rails.root.join('lib/overrides/mongoid/relations/builder.rb')
		2	+require Rails.root.join('lib/overrides/devise/failure_app.rb')
		3	+
	@@ -10,7 +10,10 @@ en:		@@ -10,7 +10,10 @@ en:
10	unauthenticated: 'You need to sign in before continuing.'	10	unauthenticated: 'You need to sign in before continuing.'
11	unconfirmed: 'You have to confirm your account before continuing.'	11	unconfirmed: 'You have to confirm your account before continuing.'
12	locked: 'Your account is locked.'	12	locked: 'Your account is locked.'
13	- invalid: 'Invalid email or password.'	13	+ invalid: 'Invalid login details.'
		14	+ user:
		15	+ email_invalid: 'Invalid email or password.'
		16	+ username_invalid: 'Invalid username or password.'
14	invalid_token: 'Invalid authentication token.'	17	invalid_token: 'Invalid authentication token.'
15	timeout: 'Your session expired, please sign in again to continue.'	18	timeout: 'Your session expired, please sign in again to continue.'
16	inactive: 'Your account was not activated yet.'	19	inactive: 'Your account was not activated yet.'
	@@ -37,3 +40,4 @@ en:		@@ -37,3 +40,4 @@ en:
37	subject: 'Reset password instructions'	40	subject: 'Reset password instructions'
38	unlock_instructions:	41	unlock_instructions:
39	subject: 'Unlock Instructions'	42	subject: 'Unlock Instructions'
		43	+
@@ -0,0 +1,15 @@		@@ -0,0 +1,15 @@
	1	+Devise::FailureApp.class_eval do
	2	+ protected
	3	+ # Handles both 'email_invalid' and 'username_invalid' messages.
	4	+ def i18n_message(default = nil)
	5	+ message = warden.message \|\| warden_options[:message] \|\| default \|\| :unauthenticated
	6	+
	7	+ if message.is_a?(Symbol)
	8	+ I18n.t(:"#{scope}.#{Devise.authentication_keys.first}_#{message}", :resource_name => scope,
	9	+ :scope => "devise.failure", :default => [message, message.to_s])
	10	+ else
	11	+ message.to_s
	12	+ end
	13	+ end
	14	+end
	15	+