username 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30a2016ad31e9aabae42451d8f93f7f090ac25659a77bc35b4a1933ea60e4159
-  data.tar.gz: aafae93ad37efc1eb2ef0e7c887c47c1f37fcf29802676a772f4cff3e81b1cbf
+  metadata.gz: a76b0ea615f4def3a94b66ca1a024202c36bf106c9261ff20cfee0a95e051cfa
+  data.tar.gz: 809f5283ee7f6b15a56e99802afa6767c1513c378072afa032dc21d171706882
 SHA512:
-  metadata.gz: c1ba518f119955a8eb4982f73824f667babb33b5df160ef88178104e2fb833c617b6ec74e89091fc805056cbb0bad7e3bc0ce67732c25a45c3e113910f929edc
-  data.tar.gz: 83c2e53ab7d4f52d66f04f84f3b854b325131466be304ba70f5accd4b831a246710d30d88288d2aaec9d9ea77e3d5fdccce7e2652ee1147d75583dc61f886b99
+  metadata.gz: 8bebd2607b4a0b2bf24dfb973524799ca074bce7424113a1d98b1bb78667da6c149f440968801b7fd0fd273242b30330883f87bd483b140cc6669049df63220f
+  data.tar.gz: 15456eb519fbe2062ebb7cab85f063774f9f9e4e6e3535a5fd01cf45744a621aea1048e4c6fa2926e0bb49e5cbd4a0deba17ee949e6ab052c9a4e56c1e4e8348

data/CHANGELOG.md

@@ -4,6 +4,11 @@
 
 * nothing yet
 
+### 1.1.0 - 2018/01/24
+
+* features
+    * add Devise login implementation
+
 ### 1.0.1 - 2018/01/20
 
 * bugfixes

data/README.md

@@ -11,6 +11,7 @@ Usernames for ActiveRecord model.
 * [Installation](#installation)
 * [Usage](#usage)
     * [Methods](#methods)
+    * [Devise](#devise)
 * [Configuration](#configuration)
 * [To Do](#to-do)
 * [Contributing](#contributing)
@@ -72,6 +73,42 @@ User.username_valid? 'test'
 User.first.username_available? 'test'
 ```
 
+### Devise
+
+If you are using Devise and you want to allow your users to sign in using either their username or email address, here is how you'd do that:
+
+1) Pass the `devise` option to the `has_username` method:
+
+```ruby
+class User < ApplicationRecord
+    has_username devise: true
+end
+```
+
+2) Configure permitted Devise parameters in your `ApplicationController`:
+
+```ruby
+class ApplicationController < ActionController::Base
+
+    before_action :configure_permitted_parameters, if: :devise_controller?
+
+    def configure_permitted_parameters
+        attributes = [:username, :email, :password, :remember_me]
+        devise_parameter_sanitizer.permit :sign_up, keys: attributes
+        devise_parameter_sanitizer.permit :account_update, keys: attributes
+    end
+
+end
+```
+
+3) Replace `:email` in your sign in form with `:login`:
+
+```haml
+= simple_form_for resource, as: resource_name, url: session_url(resource_name) do |f|
+    = f.input :login, required: true, autofocus: true
+    = f.input :password, required: true
+```
+
 ---
 
 ## Configuration

data/app/models/concerns/username/model.rb

@@ -4,9 +4,19 @@ module Username
         extend ActiveSupport::Concern
 
         module ClassMethods
-            def has_username
+            def has_username options = {}
+                defaults = {
+                    devise: false
+                }
+                options = defaults.merge options
+
                 Username.configuration&.models << self.name
                 validate :username_validation
+
+                if options[:devise]
+                    attr_accessor :login
+                    extend Username::Model::DeviseMethods
+                end
             end
 
             def username_valid? username
@@ -27,6 +37,17 @@ module Username
             end
         end
 
+        module DeviseMethods
+            def find_for_database_authentication warden_conditions
+                conditions = warden_conditions.dup
+                if login = conditions.delete(:login)
+                    where(conditions.to_h).where(['lower(username) = :value OR lower(email) = :value', { value: login.downcase }]).first
+                elsif conditions.has_key?(:username) || conditions.has_key?(:email)
+                    where(conditions.to_h).first
+                end
+            end
+        end
+
         def username_available? username
             unless username.nil?
                 valid = true

data/lib/username/version.rb

@@ -1,5 +1,5 @@
 module Username
 
-    VERSION = '1.0.1'
+    VERSION = '1.1.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: username
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-20 00:00:00.000000000 Z
+date: 2018-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties