rails_jwt_auth 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 590d1c824e7a0171f9e8c084046dc0351181487d
-  data.tar.gz: ef843896d84008e223cefa7fa805ef646bdd4926
+  metadata.gz: 6b162526193bd334a5f559b06df71fa65af2596e
+  data.tar.gz: 39edbb7292698a62f424a94807295d0cb3941dc8
 SHA512:
-  metadata.gz: 80f81e20135779d4d172fce4d06d0f92cb21aee8a5b45a81a93e1d6d2fdba20dd6c37de4747315d8df5b6b13e08b44b78d7bc6d2f75c869af6708e0186d9da79
-  data.tar.gz: 69a6d187020c8acb0984adbedbaed96aa45d622bea1ad63d9b657cd04dc769c6a8770fd2b0eb0b7509331e536cda01de58fa1072a05e270d49c2f1cf963e1968
+  metadata.gz: 56056babd43f0f71ef9b33990b4ba847986ae5d81dc49222f60f615709e6e64ebb4b2ff34551ae636008fe49171812e1d52bcb1bb84c60cb9a80495855886a1c
+  data.tar.gz: 2c715028b96c35fc280030471a61ea13e646c9bf3b2a87476ad0f57926e19ec46cd34c3fa345c7838436d7e952c086243c3e742e038c984d7b733240e8b4ddd3

data/README.md

@@ -324,7 +324,7 @@ Password api is defined by RailsJwtAuth::PasswordsController.
 
 ## Custom controllers
 
-You can overwrite RailsJwtAuth controller to edit actions, responses,
+You can overwrite RailsJwtAuth controllers to edit actions, responses,
 permitted parameters...
 
 For example, if we want to change registration strong parameters we
@@ -348,6 +348,10 @@ And edit route resource to use it:
 resource :registration, controller: 'registrations', only: [:create, :update, :destroy]
 ```
 
+## Custom responses
+
+You can overwrite `RailsJwtAuth::RenderHelper` to customize controllers responses.
+
 ## Testing (rspec)
 
 Require the RailsJwtAuth::Spec::Helpers helper module in `rails_helper.rb`.

data/app/controllers/rails_jwt_auth/confirmations_controller.rb

@@ -1,38 +1,25 @@
-class RailsJwtAuth::ConfirmationsController < ApplicationController
-  def create
-    user = RailsJwtAuth.model.where(email: confirmation_params[:email]).first
-    return render json: create_error_response, status: 422 unless user
+module RailsJwtAuth
+  class ConfirmationsController < ApplicationController
+    include RenderHelper
 
-    user.send_confirmation_instructions
-    render json: {}, status: 204
-  end
-
-  def update
-    user = RailsJwtAuth.model.where(confirmation_token: params[:confirmation_token]).first
-    return render json: update_error_response(nil), status: 422 unless user
+    def create
+      user = RailsJwtAuth.model.where(email: confirmation_params[:email]).first
+      return render_422(email: [I18n.t('rails_jwt_auth.errors.not_found')]) unless user
 
-    if user.confirm!
-      render json: {}, status: 204
-    else
-      render json: update_error_response(user), status: 422
+      user.send_confirmation_instructions ? render_204 : render_422(user.errors)
     end
-  end
 
-  private
+    def update
+      user = RailsJwtAuth.model.where(confirmation_token: params[:confirmation_token]).first
+      return render_422(confirmation_token: [I18n.t('rails_jwt_auth.errors.not_found')]) unless user
 
-  def confirmation_params
-    params.require(:confirmation).permit(:email)
-  end
+      user.confirm! ? render_204 : render_422(user.errors)
+    end
 
-  def create_error_response
-    {errors: {email: [I18n.t('rails_jwt_auth.errors.not_found')]}}
-  end
+    private
 
-  def update_error_response(user)
-    if user
-      {errors: user.errors}
-    else
-      {errors: {confirmation_token: [I18n.t('rails_jwt_auth.errors.not_found')]}}
+    def confirmation_params
+      params.require(:confirmation).permit(:email)
     end
   end
 end

data/app/controllers/rails_jwt_auth/passwords_controller.rb

@@ -1,42 +1,29 @@
-class RailsJwtAuth::PasswordsController < ApplicationController
-  def create
-    user = RailsJwtAuth.model.where(email: create_password_params[:email]).first
-    return render json: create_error_response, status: 422 unless user
+module RailsJwtAuth
+  class PasswordsController < ApplicationController
+    include RenderHelper
 
-    user.send_reset_password_instructions
-    render json: {}, status: 204
-  end
-
-  def update
-    user = RailsJwtAuth.model.where(reset_password_token: params[:reset_password_token]).first
-    return render json: update_error_response(nil), status: 422 unless user
+    def create
+      user = RailsJwtAuth.model.where(email: create_password_params[:email]).first
+      return render_422(email: [I18n.t('rails_jwt_auth.errors.not_found')]) unless user
 
-    if user.update_attributes(update_password_params)
-      render json: {}, status: 204
-    else
-      render json: update_error_response(user), status: 422
+      user.send_reset_password_instructions ? render_204 : render_422(user.errors)
     end
-  end
 
-  private
+    def update
+      user = RailsJwtAuth.model.where(reset_password_token: params[:reset_password_token]).first
+      return render_422(reset_password_token: [I18n.t('rails_jwt_auth.errors.not_found')]) unless user
 
-  def create_password_params
-    params.require(:password).permit(:email)
-  end
+      user.update_attributes(update_password_params) ? render_204 : render_422(user.errors)
+    end
 
-  def create_error_response
-    {errors: {email: [I18n.t('rails_jwt_auth.errors.not_found')]}}
-  end
+    private
 
-  def update_password_params
-    params.require(:password).permit(:password, :password_confirmation)
-  end
+    def create_password_params
+      params.require(:password).permit(:email)
+    end
 
-  def update_error_response(user)
-    if user
-      {errors: user.errors}
-    else
-      {errors: {reset_password_token: [I18n.t('rails_jwt_auth.errors.not_found')]}}
+    def update_password_params
+      params.require(:password).permit(:password, :password_confirmation)
     end
   end
 end

data/app/controllers/rails_jwt_auth/registrations_controller.rb

@@ -1,35 +1,19 @@
-class RailsJwtAuth::RegistrationsController < ApplicationController
-  def create
-    user = RailsJwtAuth.model.new(create_params)
+module RailsJwtAuth
+  class RegistrationsController < ApplicationController
+    include RenderHelper
 
-    if user.save
-      render json: create_success_response(user), status: 201
-    else
-      render json: create_error_response(user), status: 422
-    end
-  end
-
-  private
-
-  def root
-    RailsJwtAuth.model_name.underscore
-  end
+    def create
+      user = RailsJwtAuth.model.new(create_params)
 
-  def create_success_response(user)
-    {
-      root => {
-        id: user.id.to_s,
-        RailsJwtAuth.auth_field_name => user.send(RailsJwtAuth.auth_field_name)
-      }
-    }
-  end
+      user.save ? render_201(user) : render_422(user.errors)
+    end
 
-  def create_error_response(user)
-    {errors: user.errors}
-  end
+    private
 
-  def create_params
-    params.require(root).permit(
-      RailsJwtAuth.auth_field_name, :password, :password_confirmation)
+    def create_params
+      params.require(RailsJwtAuth.model_name.underscore).permit(
+        RailsJwtAuth.auth_field_name, :password, :password_confirmation
+      )
+    end
   end
 end

data/app/controllers/rails_jwt_auth/sessions_controller.rb

@@ -3,19 +3,21 @@ require 'rails_jwt_auth/jwt/request'
 
 module RailsJwtAuth
   class SessionsController < ApplicationController
+    include RenderHelper
+
     def create
       user = RailsJwtAuth.model.where(
         RailsJwtAuth.auth_field_name => create_params[RailsJwtAuth.auth_field_name].to_s.downcase
       ).first
 
       if !user
-        render json: create_error_response(user), status: 422
+        render_422 session: [create_session_error]
       elsif user.respond_to?('confirmed?') && !user.confirmed?
-        render json: unconfirmed_error_response, status: 422
+        render_422 session: [I18n.t('rails_jwt_auth.errors.unconfirmed')]
       elsif user.authenticate(create_params[:password])
-        render json: create_success_response(user, get_jwt(user)), status: 201
+        render_201 session: {jwt: get_jwt(user)}
       else
-        render json: create_error_response(user), status: 422
+        render_422 session: [create_session_error]
       end
     end
 
@@ -35,16 +37,8 @@ module RailsJwtAuth
       params.require(:session).permit(RailsJwtAuth.auth_field_name, :password)
     end
 
-    def create_error_response(_user)
-      {errors: {session: "Invalid #{RailsJwtAuth.auth_field_name} / password"}}
-    end
-
-    def unconfirmed_error_response
-      {errors: {session: 'Unconfirmed email'}}
-    end
-
-    def create_success_response(_user, jwt)
-      {session: {jwt: jwt}}
+    def create_session_error
+      I18n.t('rails_jwt_auth.errors.create_session', field: RailsJwtAuth.auth_field_name)
     end
   end
 end

data/app/helpers/rails_jwt_auth/render_helper.rb

@@ -0,0 +1,15 @@
+module RailsJwtAuth
+  module RenderHelper
+    def render_201(resource)
+      render json: resource, root: true, status: 201
+    end
+
+    def render_204
+      render json: {}, status: 204
+    end
+
+    def render_422(errors)
+      render json: {errors: errors}, status: 422
+    end
+  end
+end

data/app/models/concerns/rails_jwt_auth/confirmable.rb

@@ -1,7 +1,10 @@
 module RailsJwtAuth
   module Confirmable
     def send_confirmation_instructions
-      return false if confirmed?
+      if confirmed?
+        errors.add(:email, I18n.t('rails_jwt_auth.errors.already_confirmed'))
+        return false
+      end
 
       self.confirmation_token = SecureRandom.base58(24)
       self.confirmation_sent_at = Time.now

data/config/locales/en.yml

@@ -6,7 +6,9 @@ en:
       reset_password_instructions.subject:
         subject: "Reset password instructions"
     errors:
+      unconfirmed: "unconfirmed email"
       already_confirmed: "was already confirmed, please try signing in"
+      create_session: "invalid %{field} / password"
       expired: "has expired, please request a new one"
       invalid: "invalid"
       not_found: "not found"

data/lib/generators/templates/initializer.rb

@@ -27,8 +27,8 @@ RailsJwtAuth.setup do |config|
   #config.confirmation_expiration_time = 1.day
 
   # url used to create email link with reset password token
-  #config.reset_password_url
+  #config.reset_password_url = 'http://frontend.com/reset_password'
 
   # expiration time for reset password tokens
-  #config.reset_password_expiration_time
+  #config.reset_password_expiration_time = 1.day
 end

data/lib/rails_jwt_auth/version.rb

@@ -1,3 +1,3 @@
 module RailsJwtAuth
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_jwt_auth
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - rjurado
@@ -82,6 +82,7 @@ files:
 - app/controllers/rails_jwt_auth/registrations_controller.rb
 - app/controllers/rails_jwt_auth/sessions_controller.rb
 - app/controllers/unauthorized_controller.rb
+- app/helpers/rails_jwt_auth/render_helper.rb
 - app/helpers/rails_jwt_auth/warden_helper.rb
 - app/mailers/rails_jwt_auth/mailer.rb
 - app/models/concerns/rails_jwt_auth/authenticatable.rb