api_guard_grape 0.5.4 → 0.5.5

data/lib/api_guard/modules.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'api_guard/resource_mapper'
+require 'api_guard/jwt_auth/json_web_token'
+require 'api_guard/jwt_auth/authentication'
+require 'api_guard/jwt_auth/refresh_jwt_token'
+require 'api_guard/jwt_auth/blacklist_token'
+require 'api_guard/response_formatters/renderer'
+require 'api_guard/models/concerns'
+
+module ApiGuard
+  module Modules
+    ActiveSupport.on_load(:action_controller) do
+      include ApiGuard::Resource
+      include ApiGuard::JwtAuth::JsonWebToken
+      include ApiGuard::JwtAuth::Authentication
+      include ApiGuard::JwtAuth::RefreshJwtToken
+      include ApiGuard::JwtAuth::BlacklistToken
+      include ApiGuard::ResponseFormatters::Renderer
+    end
+
+    ActiveSupport.on_load(:active_record) do
+      include ApiGuard::Models::Concerns
+    end
+  end
+end

data/lib/{api_guard_grape → api_guard}/resource_mapper.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-module ApiGuardGrape
+module ApiGuard
   class ResourceMapper
     attr_reader :resource_name, :resource_class, :resource_instance_name
 
     def initialize(routes_for, class_name)
       @resource_name = routes_for.singularize
       @resource_class = class_name.constantize
-      @resource_instance_name = "@api_guard_grape_#{routes_for}"
+      @resource_instance_name = "@api_guard_#{routes_for}"
     end
   end
 
@@ -21,7 +21,7 @@ module ApiGuardGrape
     end
 
     def current_resource_mapping
-      request.env['api_guard_grape.mapping']
+      request.env['api_guard.mapping']
     end
 
     def resource_name

data/lib/{api_guard_grape → api_guard}/response_formatters/renderer.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-module ApiGuardGrape
+module ApiGuard
   module ResponseFormatters
     module Renderer
       def render_success(data: nil, message: nil)
-        resp_data = { status: I18n.t('api_guard_grape.response.success') }
+        resp_data = { status: I18n.t('api_guard.response.success') }
         resp_data[:message] = message if message
         resp_data[:data] = data if data
 
@@ -12,7 +12,7 @@ module ApiGuardGrape
       end
 
       def render_error(status, options = {})
-        data = { status: I18n.t('api_guard_grape.response.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_grape → api_guard}/route_mapper.rb

@@ -7,7 +7,7 @@
 module ActionDispatch
   module Routing
     class Mapper
-      def api_guard_grape_routes(options = {})
+      def api_guard_routes(options = {})
         routes_for = options.delete(:for).to_s || 'users'
 
         controllers = default_controllers(options[:only], options[:except])
@@ -16,19 +16,19 @@ module ActionDispatch
         options[:as] = options[:as] || routes_for.singularize
         options[:path] = options[:path] || routes_for
 
-        api_guard_grape_scope(routes_for) do |mapped_resource|
+        api_guard_scope(routes_for) do |mapped_resource|
           scope options do
             generate_routes(mapped_resource, controller_options, controllers)
           end
         end
       end
 
-      def api_guard_grape_scope(routes_for)
-        mapped_resource = ApiGuardGrape.mapped_resource[routes_for.to_sym].presence ||
-                          ApiGuardGrape.map_resource(routes_for, routes_for.classify)
+      def api_guard_scope(routes_for)
+        mapped_resource = ApiGuard.mapped_resource[routes_for.to_sym].presence ||
+                          ApiGuard.map_resource(routes_for, routes_for.classify)
 
         constraint = lambda do |request|
-          request.env['api_guard_grape.mapping'] = mapped_resource
+          request.env['api_guard.mapping'] = mapped_resource
           true
         end
 
@@ -56,27 +56,27 @@ module ActionDispatch
       end
 
       def authentication_routes(controller_name = nil)
-        controller_name ||= 'api_guard_grape/authentication'
+        controller_name ||= 'api_guard/authentication'
 
         post 'sign_in' => "#{controller_name}#create"
         delete 'sign_out' => "#{controller_name}#destroy"
       end
 
       def registration_routes(controller_name = nil)
-        controller_name ||= 'api_guard_grape/registration'
+        controller_name ||= 'api_guard/registration'
 
         post 'sign_up' => "#{controller_name}#create"
         delete 'delete' => "#{controller_name}#destroy"
       end
 
       def passwords_routes(controller_name = nil)
-        controller_name ||= 'api_guard_grape/passwords'
+        controller_name ||= 'api_guard/passwords'
 
         patch 'passwords' => "#{controller_name}#update"
       end
 
       def tokens_routes(controller_name = nil)
-        controller_name ||= 'api_guard_grape/tokens'
+        controller_name ||= 'api_guard/tokens'
 
         post 'tokens' => "#{controller_name}#create"
       end

data/lib/api_guard/test/controller_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'api_guard/jwt_auth/json_web_token'
+require 'api_guard/jwt_auth/refresh_jwt_token'
+
+module ApiGuard
+  module Test
+    module ControllerHelper
+      include ApiGuard::JwtAuth::JsonWebToken
+      include ApiGuard::JwtAuth::RefreshJwtToken
+    end
+  end
+end

data/lib/api_guard/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ApiGuard
+  VERSION = '0.5.5'
+end

data/lib/generators/{api_guard_grape → api_guard}/controllers/USAGE

@@ -2,7 +2,7 @@ Description:
     Generates all API Guard controllers in app/controllers/
 
 Example:
-    rails generate api_guard_grape:controllers users
+    rails generate api_guard:controllers users
 
     This will create:
         app/controllers/users/registration_controller.rb

data/lib/generators/{api_guard_grape → api_guard}/controllers/controllers_generator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module ApiGuardGrape
+module ApiGuard
   class ControllersGenerator < Rails::Generators::Base
     CONTROLLERS = %i[registration authentication tokens passwords].freeze
 

data/lib/generators/{api_guard_grape → api_guard}/controllers/templates/authentication_controller.rb

@@ -1,27 +1,27 @@
 module <%= @controller_scope %>
-  class AuthenticationController < ApiGuardGrape::AuthenticationController
+  class AuthenticationController < ApiGuard::AuthenticationController
     # before_action :find_resource, only: [:create]
     # before_action :authenticate_resource, only: [:destroy]
 
     # def create
     #   if resource.authenticate(params[:password])
     #     create_token_and_set_header(resource, resource_name)
-    #     render_success(message: I18n.t('api_guard_grape.authentication.signed_in'))
+    #     render_success(message: I18n.t('api_guard.authentication.signed_in'))
     #   else
-    #     render_error(422, message: I18n.t('api_guard_grape.authentication.invalid_login_credentials'))
+    #     render_error(422, message: I18n.t('api_guard.authentication.invalid_login_credentials'))
     #   end
     # end
 
     # def destroy
     #   blacklist_token
-    #   render_success(message: I18n.t('api_guard_grape.authentication.signed_out'))
+    #   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: I18n.t('api_guard_grape.authentication.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_grape → api_guard}/controllers/templates/passwords_controller.rb

@@ -1,16 +1,16 @@
 module <%= @controller_scope %>
-  class PasswordsController < ApiGuardGrape::PasswordsController
+  class PasswordsController < ApiGuard::PasswordsController
     # before_action :authenticate_resource, only: [:update]
 
     # def update
     #   invalidate_old_jwt_tokens(current_resource)
     #
     #   if current_resource.update_attributes(password_params)
-    #     blacklist_token unless ApiGuardGrape.invalidate_old_tokens_on_password_change
+    #     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(message: I18n.t('api_guard_grape.password.changed'))
+    #     render_success(message: I18n.t('api_guard.password.changed'))
     #   else
     #     render_error(422, object: current_resource)
     #   end

data/lib/generators/{api_guard_grape → api_guard}/controllers/templates/registration_controller.rb

@@ -1,12 +1,12 @@
 module <%= @controller_scope %>
-  class RegistrationController < ApiGuardGrape::RegistrationController
+  class RegistrationController < ApiGuard::RegistrationController
     # before_action :authenticate_resource, only: [:destroy]
 
     # def create
     #   init_resource(sign_up_params)
     #   if resource.save
     #     create_token_and_set_header(resource, resource_name)
-    #     render_success(message: I18n.t('api_guard_grape.registration.signed_up'))
+    #     render_success(message: I18n.t('api_guard.registration.signed_up'))
     #   else
     #     render_error(422, object: resource)
     #   end
@@ -14,7 +14,7 @@ module <%= @controller_scope %>
 
     # def destroy
     #   current_resource.destroy
-    #   render_success(message: I18n.t('api_guard_grape.registration.account_deleted'))
+    #   render_success(message: I18n.t('api_guard.registration.account_deleted'))
     # end
 
     # private

data/lib/generators/{api_guard_grape → api_guard}/controllers/templates/tokens_controller.rb

@@ -1,5 +1,5 @@
 module <%= @controller_scope %>
-  class TokensController < ApiGuardGrape::TokensController
+  class TokensController < ApiGuard::TokensController
     # before_action :authenticate_resource, only: [:create]
     # before_action :find_refresh_token, only: [:create]
 
@@ -7,9 +7,9 @@ module <%= @controller_scope %>
     #   create_token_and_set_header(current_resource, resource_name)
     #
     #   @refresh_token.destroy
-    #   blacklist_token if ApiGuardGrape.blacklist_token_after_refreshing
+    #   blacklist_token if ApiGuard.blacklist_token_after_refreshing
     #
-    #   render_success(message: I18n.t('api_guard_grape.access_token.refreshed'))
+    #   render_success(message: I18n.t('api_guard.access_token.refreshed'))
     # end
 
     # private
@@ -19,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: I18n.t('api_guard_grape.refresh_token.invalid')) unless @refresh_token
+    #     return render_error(401, message: I18n.t('api_guard.refresh_token.invalid')) unless @refresh_token
     #   else
-    #     render_error(401, message: I18n.t('api_guard_grape.refresh_token.missing'))
+    #     render_error(401, message: I18n.t('api_guard.refresh_token.missing'))
     #   end
     # end
   end

data/lib/generators/{api_guard_grape → api_guard}/initializer/USAGE

@@ -2,7 +2,7 @@ Description:
     Creates initializer for configuring API Guard
 
 Example:
-    rails generate api_guard_grape:initializer
+    rails generate api_guard:initializer
 
     This will create:
-        config/initializers/api_guard_grape.rb
+        config/initializers/api_guard.rb

data/lib/generators/{api_guard_grape → api_guard}/initializer/initializer_generator.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-module ApiGuardGrape
+module ApiGuard
   class InitializerGenerator < Rails::Generators::Base
     source_root File.expand_path('templates', __dir__)
 
     desc 'Creates initializer for configuring API Guard'
 
     def create_initializer
-      copy_file 'initializer.rb', 'config/initializers/api_guard_grape.rb'
+      copy_file 'initializer.rb', 'config/initializers/api_guard.rb'
     end
   end
 end

data/lib/generators/{api_guard_grape → api_guard}/initializer/templates/initializer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-ApiGuardGrape.setup do |config|
+ApiGuard.setup do |config|
   # Validity of the JWT access token
   # Default: 1 day
   # config.token_validity = 1.day

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_guard_grape
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Prateek Singh
@@ -146,36 +146,36 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/controllers/api_guard_grape/application_controller.rb
-- app/controllers/api_guard_grape/authentication_controller.rb
-- app/controllers/api_guard_grape/passwords_controller.rb
-- app/controllers/api_guard_grape/registration_controller.rb
-- app/controllers/api_guard_grape/tokens_controller.rb
+- app/controllers/api_guard/application_controller.rb
+- app/controllers/api_guard/authentication_controller.rb
+- app/controllers/api_guard/passwords_controller.rb
+- app/controllers/api_guard/registration_controller.rb
+- app/controllers/api_guard/tokens_controller.rb
 - config/locales/en.yml
 - config/routes.rb
-- lib/api_guard_grape.rb
-- lib/api_guard_grape/app_secret_key.rb
-- lib/api_guard_grape/engine.rb
-- lib/api_guard_grape/jwt_auth/authentication.rb
-- lib/api_guard_grape/jwt_auth/blacklist_token.rb
-- lib/api_guard_grape/jwt_auth/json_web_token.rb
-- lib/api_guard_grape/jwt_auth/refresh_jwt_token.rb
-- lib/api_guard_grape/models/concerns.rb
-- lib/api_guard_grape/modules.rb
-- lib/api_guard_grape/resource_mapper.rb
-- lib/api_guard_grape/response_formatters/renderer.rb
-- lib/api_guard_grape/route_mapper.rb
-- lib/api_guard_grape/test/controller_helper.rb
-- lib/api_guard_grape/version.rb
-- lib/generators/api_guard_grape/controllers/USAGE
-- lib/generators/api_guard_grape/controllers/controllers_generator.rb
-- lib/generators/api_guard_grape/controllers/templates/authentication_controller.rb
-- lib/generators/api_guard_grape/controllers/templates/passwords_controller.rb
-- lib/generators/api_guard_grape/controllers/templates/registration_controller.rb
-- lib/generators/api_guard_grape/controllers/templates/tokens_controller.rb
-- lib/generators/api_guard_grape/initializer/USAGE
-- lib/generators/api_guard_grape/initializer/initializer_generator.rb
-- lib/generators/api_guard_grape/initializer/templates/initializer.rb
+- lib/api_guard.rb
+- lib/api_guard/app_secret_key.rb
+- lib/api_guard/engine.rb
+- lib/api_guard/jwt_auth/authentication.rb
+- lib/api_guard/jwt_auth/blacklist_token.rb
+- lib/api_guard/jwt_auth/json_web_token.rb
+- lib/api_guard/jwt_auth/refresh_jwt_token.rb
+- lib/api_guard/models/concerns.rb
+- lib/api_guard/modules.rb
+- lib/api_guard/resource_mapper.rb
+- lib/api_guard/response_formatters/renderer.rb
+- lib/api_guard/route_mapper.rb
+- lib/api_guard/test/controller_helper.rb
+- lib/api_guard/version.rb
+- lib/generators/api_guard/controllers/USAGE
+- lib/generators/api_guard/controllers/controllers_generator.rb
+- lib/generators/api_guard/controllers/templates/authentication_controller.rb
+- lib/generators/api_guard/controllers/templates/passwords_controller.rb
+- lib/generators/api_guard/controllers/templates/registration_controller.rb
+- lib/generators/api_guard/controllers/templates/tokens_controller.rb
+- lib/generators/api_guard/initializer/USAGE
+- lib/generators/api_guard/initializer/initializer_generator.rb
+- lib/generators/api_guard/initializer/templates/initializer.rb
 homepage: https://github.com/prateeksinghbundela/api_guard_grape
 licenses:
 - MIT
@@ -195,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Rails API authentication made easy

data/lib/api_guard_grape/jwt_auth/refresh_jwt_token.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module ApiGuardGrape
-  module JwtAuth
-    # Common module for refresh token functionality
-    module RefreshJwtToken
-      def self.refresh_token_association(resource)
-        resource.class.refresh_token_association
-      end
-
-      def self.refresh_token_enabled?(resource)
-        refresh_token_association(resource).present?
-      end
-
-      def self.refresh_tokens_for(resource)
-        refresh_token_association = refresh_token_association(resource)
-        resource.send(refresh_token_association)
-      end
-
-      def self.find_refresh_token_of(resource, refresh_token)
-        refresh_tokens_for(resource).find_by_token(refresh_token)
-      end
-
-      # Generate and return unique refresh token for the resource
-      def self.uniq_refresh_token(resource)
-        loop do
-          random_token = SecureRandom.urlsafe_base64
-          return random_token unless refresh_tokens_for(resource).exists?(token: random_token)
-        end
-      end
-
-      # Create a new refresh_token for the current resource
-      def self.new_refresh_token(resource)
-        return unless refresh_token_enabled?(resource)
-
-        refresh_tokens_for(resource).create(token: uniq_refresh_token(resource)).token
-      end
-
-      def self.destroy_all_refresh_tokens(resource)
-        return unless refresh_token_enabled?(resource)
-
-        refresh_tokens_for(resource).destroy_all
-      end
-    end
-  end
-end