Merge pull request #869 from abeyuya/feature/customable-authorized_users_only_error-response

Feature/customable authorized users only error response

Author: zachfeldman

lib/devise_token_auth/controllers/helpers.rb

@@ -15,10 +15,11 @@ module ClassMethods
         #     devise_group :blogger, contains: [:user, :admin]
         #
         #   Generated methods:
-        #     authenticate_blogger!  # Redirects unless user or admin are signed in
-        #     blogger_signed_in?     # Checks whether there is either a user or an admin signed in
-        #     current_blogger        # Currently signed in user or admin
-        #     current_bloggers       # Currently signed in user and admin
+        #     authenticate_blogger!             # Redirects unless user or admin are signed in
+        #     blogger_signed_in?                # Checks whether there is either a user or an admin signed in
+        #     current_blogger                   # Currently signed in user or admin
+        #     current_bloggers                  # Currently signed in user and admin
+        #     render_authenticate_error         # Render error unless user or admin are signed in
         #
         #   Use:
         #     before_action :authenticate_blogger!              # Redirects unless either a user or an admin are authenticated
@@ -38,9 +39,7 @@ def authenticate_#{group_name}!(favourite=nil, opts={})
                 end
 
                 unless current_#{group_name}
-                  return render json: {
-                    errors: [I18n.t('devise.failure.unauthenticated')]
-                  }, status: 401
+                  render_authenticate_error
                 end
               end
             end
@@ -67,8 +66,14 @@ def current_#{group_name.to_s.pluralize}
               end.compact
             end
 
+            def render_authenticate_error
+              return render json: {
+                errors: [I18n.t('devise.failure.unauthenticated')]
+              }, status: 401
+            end
+
             if respond_to?(:helper_method)
-              helper_method "current_#{group_name}", "current_#{group_name.to_s.pluralize}", "#{group_name}_signed_in?"
+              helper_method "current_#{group_name}", "current_#{group_name.to_s.pluralize}", "#{group_name}_signed_in?", "render_authenticate_error"
             end
           METHODS
         end
@@ -90,14 +95,15 @@ def log_process_action(payload)
       #     Admin
       #
       #   Generated methods:
-      #     authenticate_user!  # Signs user in or 401
-      #     authenticate_admin! # Signs admin in or 401
-      #     user_signed_in?     # Checks whether there is a user signed in or not
-      #     admin_signed_in?    # Checks whether there is an admin signed in or not
-      #     current_user        # Current signed in user
-      #     current_admin       # Current signed in admin
-      #     user_session        # Session data available only to the user scope
-      #     admin_session       # Session data available only to the admin scope
+      #     authenticate_user!                   # Signs user in or 401
+      #     authenticate_admin!                  # Signs admin in or 401
+      #     user_signed_in?                      # Checks whether there is a user signed in or not
+      #     admin_signed_in?                     # Checks whether there is an admin signed in or not
+      #     current_user                         # Current signed in user
+      #     current_admin                        # Current signed in admin
+      #     user_session                         # Session data available only to the user scope
+      #     admin_session                        # Session data available only to the admin scope
+      #     render_authenticate_error            # Render error unless user or admin is signed in
       #
       #   Use:
       #     before_action :authenticate_user!  # Tell devise to use :user map
@@ -109,9 +115,7 @@ def self.define_helpers(mapping) #:nodoc:
         class_eval <<-METHODS, __FILE__, __LINE__ + 1
           def authenticate_#{mapping}!
             unless current_#{mapping}
-              return render json: {
-                errors: [I18n.t('devise.failure.unauthenticated')]
-              }, status: 401
+              render_authenticate_error
             end
           end
 
@@ -126,11 +130,17 @@ def current_#{mapping}
           def #{mapping}_session
             current_#{mapping} && warden.session(:#{mapping})
           end
+
+          def render_authenticate_error
+            return render json: {
+              errors: [I18n.t('devise.failure.unauthenticated')]
+            }, status: 401
+          end
         METHODS
 
         ActiveSupport.on_load(:action_controller) do
           if respond_to?(:helper_method)
-            helper_method "current_#{mapping}", "#{mapping}_signed_in?", "#{mapping}_session"
+            helper_method "current_#{mapping}", "#{mapping}_signed_in?", "#{mapping}_session", "render_authenticate_error"
           end
         end
       end

test/controllers/demo_group_controller_test.rb

@@ -74,6 +74,10 @@ class DemoGroupControllerTest < ActionDispatch::IntegrationTest
           it 'should define member_signed_in?' do
             assert @controller.current_members.include? @resource
           end
+
+          it 'should define render_authenticate_error' do
+            assert @controller.methods.include?(:render_authenticate_error)
+          end
         end
       end
 
@@ -118,6 +122,10 @@ class DemoGroupControllerTest < ActionDispatch::IntegrationTest
           it 'should define member_signed_in?' do
             assert @controller.current_members.include? @mang
           end
+
+          it 'should define render_authenticate_error' do
+            assert @controller.methods.include?(:render_authenticate_error)
+          end
         end
       end
 
@@ -132,7 +140,7 @@ class DemoGroupControllerTest < ActionDispatch::IntegrationTest
 
         it 'should return error: unauthorized status' do
           assert_equal 401, response.status
-        end      
+        end
       end
     end
   end

test/controllers/demo_mang_controller_test.rb

@@ -46,6 +46,10 @@ class DemoMangControllerTest < ActionDispatch::IntegrationTest
           it 'should not define current_user' do
             refute_equal @resource, @controller.current_user
           end
+
+          it 'should define render_authenticate_error' do
+            assert @controller.methods.include?(:render_authenticate_error)
+          end
         end
 
         it 'should return success status' do
@@ -260,4 +264,3 @@ class DemoMangControllerTest < ActionDispatch::IntegrationTest
     end
   end
 end
-

test/controllers/demo_user_controller_test.rb

@@ -47,6 +47,10 @@ class DemoUserControllerTest < ActionDispatch::IntegrationTest
           it 'should not define current_mang' do
             refute_equal @resource, @controller.current_mang
           end
+
+          it 'should define render_authenticate_error' do
+            assert @controller.methods.include?(:render_authenticate_error)
+          end
         end
 
         it 'should return success status' do