api_guard 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b7ce3ac5306ae3a652084d29da83f37ec9b41c5
-  data.tar.gz: 7fb6b919ed4044e459a3840e442505326bfda971
+  metadata.gz: 5e4c4d5d2ef0490d9c1cfbb9bf408d09c5152fc3
+  data.tar.gz: 21f401a251b77bf72dfffccf92965f3ecd501f81
 SHA512:
-  metadata.gz: e02605d2b473c9931a1c494203562ae9e87ef90d5b3adfa4e043aba6b96e3da7aa3fc306189139a4d546b7b88eb4ecbdb876783dab28b9e6879b37dcca2f1c97
-  data.tar.gz: 293b709e2ae69d3b07912c319d5fd37c8ae3156797cf09b19aa55ab8bc317e90822747a3b3d0a856c368d0e16d8a89cdb7b6ca208d047e9dc5142db81db385d8
+  metadata.gz: 19a27ce1e5ae8f87482e891895de91ce3e08fae8912392ef09f24b4e3763b3e9a1db2315578acb784b6097548fb2ec02e3a9ab8d1776f71c5b0eafaf466e42fa
+  data.tar.gz: c76a2d4620091808a89f903abbf65672b25cddcd8c7974c6e8fdccdb195da88d96258bab30f3f0221954bb371705c619828f3167878dd45b0bfc06cf25d55f30

data/README.md

@@ -35,6 +35,7 @@ for cryptographic signing.
 * [Overriding defaults](#overriding-defaults)
     * [Controllers](#controllers)
     * [Routes](#routes)
+    * [Customizing / translating response messages using I18n](#customizing--translating-response-messages-using-i18n)
 * [Testing](#testing)
 * [Contributing](#contributing)
 * [License](#license)
@@ -353,19 +354,19 @@ configurations.
 ApiGuard.setup do |config|
   # Validity of the JWT access token
   # Default: 1 day
-  config.token_validity = 1.day
+  # config.token_validity = 1.day
 
   # Secret key for signing (encoding & decoding) the JWT access token
   # Default: 'secret_key_base' from Rails secrets 
-  config.token_signing_secret = Rails.application.secrets.secret_key_base
+  # config.token_signing_secret = 'my_signing_secret'
 
   # Invalidate old tokens on changing the password
   # Default: false
-  config.invalidate_old_tokens_on_password_change = false
+  # config.invalidate_old_tokens_on_password_change = false
 
   # Blacklist JWT access token after refreshing
   # Default: false
-  config.blacklist_token_after_refreshing = false
+  # config.blacklist_token_after_refreshing = false
 end
 ```
 
@@ -555,6 +556,22 @@ end
 Above configuration will replace default registration routes `users/sign_up` & `users/delete` with `account/create` & 
 `account/delete`
 
+### Customizing / translating response messages using I18n
+
+API Guard uses [I18n](https://guides.rubyonrails.org/i18n.html) for success and error messages. You can create your own 
+locale file and customize the messages for any language.
+
+```yaml
+en:
+  api_guard:
+    authentication:
+      signed_in: 'Signed in successfully'
+      signed_out: 'Signed out successfully'
+```
+
+You can find the complete list of available keys in this file:
+https://github.com/Gokul595/api_guard/blob/master/config/locales/en.yml
+
 ## Testing
 
 API Guard comes with helper for creating JWT access token and refresh token for the resource which you can use it for 

data/app/controllers/api_guard/authentication_controller.rb

@@ -8,22 +8,22 @@ module ApiGuard
     def create
       if resource.authenticate(params[:password])
         create_token_and_set_header(resource, resource_name)
-        render_success(message: 'Signed in successfully')
+        render_success(message: I18n.t('api_guard.authentication.signed_in'))
       else
-        render_error(422, message: 'Invalid login credentials')
+        render_error(422, message: I18n.t('api_guard.authentication.invalid_login_credentials'))
       end
     end
 
     def destroy
       blacklist_token
-      render_success(message: 'Signed out successfully')
+      render_success(message: I18n.t('api_guard.authentication.signed_out'))
     end
 
     private
 
     def find_resource
       self.resource = resource_class.find_by(email: params[:email].downcase.strip) if params[:email].present?
-      render_error(422, message: 'Invalid login credentials') unless resource
+      render_error(422, message: I18n.t('api_guard.authentication.invalid_login_credentials')) unless resource
     end
   end
 end

data/app/controllers/api_guard/passwords_controller.rb

@@ -12,7 +12,7 @@ module ApiGuard
         destroy_all_refresh_tokens(current_resource)
 
         create_token_and_set_header(current_resource, resource_name)
-        render_success(message: 'Password changed successfully')
+        render_success(message: I18n.t('api_guard.password.changed'))
       else
         render_error(422, object: current_resource)
       end

data/app/controllers/api_guard/registration_controller.rb

@@ -8,7 +8,7 @@ module ApiGuard
       init_resource(sign_up_params)
       if resource.save
         create_token_and_set_header(resource, resource_name)
-        render_success(message: 'Signed up successfully')
+        render_success(message: I18n.t('api_guard.registration.signed_up'))
       else
         render_error(422, object: resource)
       end
@@ -16,7 +16,7 @@ module ApiGuard
 
     def destroy
       current_resource.destroy
-      render_success(message: "Account deleted successfully")
+      render_success(message: I18n.t('api_guard.registration.account_deleted'))
     end
 
     private

data/app/controllers/api_guard/tokens_controller.rb

@@ -11,7 +11,7 @@ module ApiGuard
       @refresh_token.destroy
       blacklist_token if ApiGuard.blacklist_token_after_refreshing
 
-      render_success(message: 'Token refreshed successfully')
+      render_success(message: I18n.t('api_guard.access_token.refreshed'))
     end
 
     private
@@ -21,9 +21,9 @@ module ApiGuard
 
       if refresh_token_from_header
         @refresh_token = find_refresh_token_of(current_resource, refresh_token_from_header)
-        return render_error(401, message: 'Invalid refresh token') unless @refresh_token
+        return render_error(401, message: I18n.t('api_guard.refresh_token.invalid')) unless @refresh_token
       else
-        render_error(401, message: 'Refresh token is missing in the request')
+        render_error(401, message: I18n.t('api_guard.refresh_token.missing'))
       end
     end
   end

data/config/locales/en.yml

@@ -0,0 +1,22 @@
+en:
+  api_guard:
+    authentication:
+      signed_in: 'Signed in successfully'
+      signed_out: 'Signed out successfully'
+      invalid_login_credentials: 'Invalid login credentials'
+    password:
+      changed: 'Password changed successfully'
+    registration:
+      signed_up: 'Signed up successfully'
+      account_deleted: 'Account deleted successfully'
+    access_token:
+      refreshed: 'Token refreshed successfully'
+      missing: 'Access token is missing in the request'
+      invalid: 'Invalid access token'
+      expired: 'Access token expired'
+    refresh_token:
+      invalid: 'Invalid refresh token'
+      missing: 'Refresh token is missing in the request'
+    response:
+      success: 'success'
+      error: 'error'

data/lib/api_guard/jwt_auth/authentication.rb

@@ -19,17 +19,17 @@ module ApiGuard
         @resource_name = resource_name
 
         @token = request.headers['Authorization']&.split('Bearer ')&.last
-        return render_error(401, message: 'Access token is missing in the request') unless @token
+        return render_error(401, message: I18n.t('api_guard.access_token.missing')) unless @token
 
         authenticate_token
 
         # Render error response only if no resource found and no previous render happened
-        render_error(401, message: 'Invalid access token') if !current_resource && !performed?
+        render_error(401, message: I18n.t('api_guard.access_token.invalid')) if !current_resource && !performed?
       rescue JWT::DecodeError => e
         if e.message == 'Signature has expired'
-          render_error(401, message: 'Access token expired')
+          render_error(401, message: I18n.t('api_guard.access_token.expired'))
         else
-          render_error(401, message: 'Invalid access token')
+          render_error(401, message: I18n.t('api_guard.access_token.invalid'))
         end
       end
 
@@ -64,11 +64,12 @@ module ApiGuard
 
         return if current_resource && valid_issued_at? && !blacklisted?
 
-        render_error(401, message: 'Invalid access token')
+        render_error(401, message: I18n.t('api_guard.access_token.invalid'))
       end
 
       def current_resource
         return unless respond_to?("current_#{@resource_name}")
+
         public_send("current_#{@resource_name}")
       end
     end

data/lib/api_guard/jwt_auth/blacklist_token.rb

@@ -18,12 +18,14 @@ module ApiGuard
       # Returns whether the JWT token is blacklisted or not
       def blacklisted?
         return false unless token_blacklisting_enabled?(current_resource)
+
         blacklisted_tokens_for(current_resource).exists?(token: @token)
       end
 
       # Blacklist the current JWT token from future access
       def blacklist_token
         return unless token_blacklisting_enabled?(current_resource)
+
         blacklisted_tokens_for(current_resource).create(token: @token, expire_at: Time.at(@decoded_token[:exp]).utc)
       end
     end

data/lib/api_guard/jwt_auth/json_web_token.rb

@@ -59,6 +59,7 @@ module ApiGuard
       # to restrict access to old access(JWT) tokens
       def invalidate_old_jwt_tokens(resource)
         return unless ApiGuard.invalidate_old_tokens_on_password_change
+
         resource.token_issued_at = Time.at(token_issued_at).utc
       end
     end

data/lib/api_guard/jwt_auth/refresh_jwt_token.rb

@@ -30,11 +30,13 @@ module ApiGuard
       # Create a new refresh_token for the current resource
       def new_refresh_token(resource)
         return unless refresh_token_enabled?(resource)
+
         refresh_tokens_for(resource).create(token: uniq_refresh_token(resource)).token
       end
 
       def destroy_all_refresh_tokens(resource)
         return unless refresh_token_enabled?(resource)
+
         refresh_tokens_for(resource).destroy_all
       end
     end

data/lib/api_guard/response_formatters/renderer.rb

@@ -2,14 +2,14 @@ module ApiGuard
   module ResponseFormatters
     module Renderer
       def render_success(data: nil, message: nil)
-        resp_data = { status: 'success' }
+        resp_data = { status: I18n.t('api_guard.response.success') }
         resp_data[:message] = message if message
 
         render json: resp_data, status: 200
       end
 
       def render_error(status, options = {})
-        data = { status: 'error' }
+        data = { status: I18n.t('api_guard.response.error') }
         data[:error] = options[:object] ? options[:object].errors.full_messages[0] : options[:message]
 
         render json: data, status: status

data/lib/api_guard/version.rb

@@ -1,3 +1,3 @@
 module ApiGuard
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'.freeze
 end

data/lib/generators/api_guard/controllers/controllers_generator.rb

@@ -1,22 +1,22 @@
 module ApiGuard
   class ControllersGenerator < Rails::Generators::Base
-    CONTROLLERS = %i[registration authentication tokens passwords]
+    CONTROLLERS = %i[registration authentication tokens passwords].freeze
 
     desc 'Generates API Guard controllers in app/controllers/'
     source_root File.expand_path('../templates', __FILE__)
 
-    argument :scope, required: true,
-             desc: "The scope to create controllers in, e.g. users, admins"
+    argument :scope, required: true, desc: 'The scope to create controllers in, e.g. users, admins'
 
     class_option :controllers, aliases: "-c", type: :array,
-                 desc: "Specify the controllers to generate (#{CONTROLLERS.join(', ')})"
+                               desc: "Specify the controllers to generate (#{CONTROLLERS.join(', ')})"
 
     def create_controllers
       @controller_scope = scope.camelize
       controllers = options[:controllers] || CONTROLLERS
 
       controllers.each do |controller_name|
-        template "#{controller_name}_controller.rb", "app/controllers/#{scope}/#{controller_name}_controller.rb"
+        template "#{controller_name}_controller.rb",
+                 "app/controllers/#{scope}/#{controller_name}_controller.rb"
       end
     end
   end

data/lib/generators/api_guard/controllers/templates/authentication_controller.rb

@@ -6,22 +6,22 @@ module <%= @controller_scope %>
     # def create
     #   if resource.authenticate(params[:password])
     #     create_token_and_set_header(resource, resource_name)
-    #     render_success(data: resource)
+    #     render_success(message: I18n.t('api_guard.authentication.signed_in'))
     #   else
-    #     render_error(422, message: 'Invalid login credentials')
+    #     render_error(422, message: I18n.t('api_guard.authentication.invalid_login_credentials'))
     #   end
     # end
 
     # def destroy
     #   blacklist_token
-    #   render_success(message: 'Signed out successfully')
+    #   render_success(message: I18n.t('api_guard.authentication.signed_out'))
     # end
 
     # private
 
     # def find_resource
     #   self.resource = resource_class.find_by(email: params[:email].downcase.strip) if params[:email].present?
-    #   render_error(422, message: 'Invalid login credentials') unless resource
+    #   render_error(422, message: I18n.t('api_guard.authentication.invalid_login_credentials')) unless resource
     # end
   end
 end

data/lib/generators/api_guard/controllers/templates/passwords_controller.rb

@@ -6,11 +6,11 @@ module <%= @controller_scope %>
     #   invalidate_old_jwt_tokens(current_resource)
     #
     #   if current_resource.update_attributes(password_params)
-    #     blacklist_token
+    #     blacklist_token unless ApiGuard.invalidate_old_tokens_on_password_change
     #     destroy_all_refresh_tokens(current_resource)
     #
     #     create_token_and_set_header(current_resource, resource_name)
-    #     render_success(data: current_resource)
+    #     render_success(message: I18n.t('api_guard.password.changed'))
     #   else
     #     render_error(422, object: current_resource)
     #   end
@@ -19,7 +19,7 @@ module <%= @controller_scope %>
     # private
 
     # def password_params
-    #   params.require(resource_name.to_sym).permit(:password, :password_confirmation)
+    #   params.permit(:password, :password_confirmation)
     # end
   end
 end

data/lib/generators/api_guard/controllers/templates/registration_controller.rb

@@ -6,7 +6,7 @@ module <%= @controller_scope %>
     #   init_resource(sign_up_params)
     #   if resource.save
     #     create_token_and_set_header(resource, resource_name)
-    #     render_success(data: resource, message: "#{resource_name.capitalize} created successfully")
+    #     render_success(message: I18n.t('api_guard.registration.signed_up'))
     #   else
     #     render_error(422, object: resource)
     #   end
@@ -14,13 +14,13 @@ module <%= @controller_scope %>
 
     # def destroy
     #   current_resource.destroy
-    #   render_success(message: "#{resource_name.capitalize} destroyed successfully")
+    #   render_success(message: I18n.t('api_guard.registration.account_deleted'))
     # end
 
     # private
 
     # def sign_up_params
-    #   params.require(resource_name.to_sym).permit(:email, :password, :password_confirmation)
+    #   params.permit(:email, :password, :password_confirmation)
     # end
   end
 end

data/lib/generators/api_guard/controllers/templates/tokens_controller.rb

@@ -4,9 +4,12 @@ module <%= @controller_scope %>
     # before_action :find_refresh_token, only: [:create]
 
     # def create
-    #   @refresh_token.destroy
     #   create_token_and_set_header(current_resource, resource_name)
-    #   render_success(data: current_resource)
+    #
+    #   @refresh_token.destroy
+    #   blacklist_token if ApiGuard.blacklist_token_after_refreshing
+    #
+    #   render_success(message: I18n.t('api_guard.access_token.refreshed'))
     # end
 
     # private
@@ -16,9 +19,9 @@ module <%= @controller_scope %>
     #
     #   if refresh_token_from_header
     #     @refresh_token = find_refresh_token_of(current_resource, refresh_token_from_header)
-    #     return render_error(401, message: 'Invalid refresh token') unless @refresh_token
+    #     return render_error(401, message: I18n.t('api_guard.refresh_token.invalid')) unless @refresh_token
     #   else
-    #     render_error(401, message: 'Refresh token is missing in the request')
+    #     render_error(401, message: I18n.t('api_guard.refresh_token.missing'))
     #   end
     # end
   end

data/lib/generators/api_guard/initializer/templates/initializer.rb

@@ -1,17 +1,17 @@
 ApiGuard.setup do |config|
   # Validity of the JWT access token
   # Default: 1 day
-  config.token_validity = 1.day
+  # config.token_validity = 1.day
 
   # Secret key for signing (encoding & decoding) the JWT access token
   # Default: 'secret_key_base' from Rails secrets
-  config.token_signing_secret = Rails.application.secrets.secret_key_base
+  # config.token_signing_secret = 'my_signing_secret'
 
   # Invalidate old tokens on changing the password
   # Default: false
-  config.invalidate_old_tokens_on_password_change = false
+  # config.invalidate_old_tokens_on_password_change = false
 
   # Blacklist JWT access token after refreshing
   # Default: false
-  config.blacklist_token_after_refreshing = false
+  # config.blacklist_token_after_refreshing = false
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_guard
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Gokul Murali
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-08 00:00:00.000000000 Z
+date: 2019-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -167,6 +167,7 @@ files:
 - app/controllers/api_guard/tokens_controller.rb
 - app/models/api_guard/application_record.rb
 - app/views/layouts/api_guard/application.html.erb
+- config/locales/en.yml
 - config/routes.rb
 - lib/api_guard.rb
 - lib/api_guard/app_secret_key.rb