api_guard_grape 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e667ff860411d0279873e75ec9a26d91021d77cc39b8fd4ff71b80064a9381c
-  data.tar.gz: bf6ce23224222985aff4c0ccfd1457b3983c26860611a4ffdc1dee67e300f6b4
+  metadata.gz: 4381e38e78427908ffe9ee0597a0ce30393d2495fc21054d8457fc51726cbc96
+  data.tar.gz: dc228c65bcdc551b54074d0bd09afafe261009a878a201da48dd783a14c3dc44
 SHA512:
-  metadata.gz: 78be63e439d78752712a6aa7f1473c7af2baeed3e85a855caaed6d3816b3ac29afe51bcf7da3a0e0ab16aeffe59863abc9880aed0fb4496a79a2fe6c9cea7746
-  data.tar.gz: 07b3f3e2d4b4752b00892baab81720075e6b409dfbd7894e87b202c57b9fdb1dc303033d599885948fb2df36b232bf6b7953c535c36c575f234fd461e90c71d2
+  metadata.gz: c507254d38f3d3f71fa02ab3c973e1b7eaa06f2adc75214be6bacc97f2a4bcf34b1e66e22b28e1139808ea3a2c70db8e86553f8bd98d7470a88c659a5b8508ca
+  data.tar.gz: 8f602a2ac573fabe7bed9ff8a6206ad147e6d683bbb825942f767e4c7acb112c80a96b32d2fa108b91811739a5d2514f217a7ed99c06c2c0b7486f6735eaa271

data/README.md

@@ -1,8 +1,8 @@
 # API Guard
 
-[![Version](https://img.shields.io/gem/v/api_guard.svg?color=green)](https://rubygems.org/gems/api_guard_grape)
-[![Build Status](https://github.com/prateeksinghbundela/api_guard_grape/workflows/build/badge.svg?branch=master)](https://github.com/prateeksinghbundela/api_guard_grape/actions?query=workflow%3Abuild)
-[![Maintainability](https://api.codeclimate.com/v1/badges/ced3e74a26a66ed915cb/maintainability)](https://codeclimate.com/github/prateeksinghbundela/api_guard_grape/maintainability)
+[![Version](https://img.shields.io/gem/v/api_guard_grape.svg?color=green)](https://rubygems.org/gems/api_guard_grape_grape)
+[![Build Status](https://github.com/prateeksinghbundela/api_guard_grape_grape/workflows/build/badge.svg?branch=master)](https://github.com/prateeksinghbundela/api_guard_grape_grape/actions?query=workflow%3Abuild)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ced3e74a26a66ed915cb/maintainability)](https://codeclimate.com/github/prateeksinghbundela/api_guard_grape_grape/maintainability)
 
 
 [JSON Web Token (JWT)](https://jwt.io/) based authentication solution with token refreshing & blacklisting for APIs 
@@ -38,8 +38,8 @@ for cryptographic signing.
     * [Override finding resource](#override-finding-resource)
     * [Customizing / translating response messages using I18n](#customizing--translating-response-messages-using-i18n)
 * [Testing](#testing)
-* [Wiki](https://github.com/prateeksinghbundela/api_guard_grape/wiki)
-    * [Using API Guard with Devise](https://github.com/prateeksinghbundela/api_guard_grape/wiki/Using-API-Guard-with-Devise)
+* [Wiki](https://github.com/prateeksinghbundela/api_guard_grape_grape/wiki)
+    * [Using API Guard with Devise](https://github.com/prateeksinghbundela/api_guard_grape_grape/wiki/Using-API-Guard-with-Devise)
 * [Contributing](#contributing)
 * [License](#license)
 
@@ -82,7 +82,7 @@ $ rails db:migrate
 Add [has_secure_password](https://api.rubyonrails.org/classes/ActiveModel/SecurePassword/ClassMethods.html#method-i-has_secure_password) 
 in `User` model for password authentication. 
 
-> Refer [this Wiki](https://github.com/prateeksinghbundela/api_guard_grape/wiki/Using-API-Guard-with-Devise#authentication) for configuring API Guard authentication to work with Devise instead of using `has_secure_password`.
+> Refer [this Wiki](https://github.com/prateeksinghbundela/api_guard_grape_grape/wiki/Using-API-Guard-with-Devise#authentication) for configuring API Guard authentication to work with Devise instead of using `has_secure_password`.
 
 ```ruby
 class User < ApplicationRecord
@@ -109,12 +109,12 @@ $ bundle install
 Add this line to the application routes (`config/routes.rb`) file:
 
 ```ruby
-api_guard_routes for: 'users'
+api_guard_grape_routes for: 'users'
 ``` 
 
 This will generate default routes such as sign up, sign in, sign out, token refresh, password change for User.
 
-> Refer [this Wiki](https://github.com/prateeksinghbundela/api_guard_grape/wiki/Using-API-Guard-with-Devise#routes) for configuring API Guard routes to work with Devise.
+> Refer [this Wiki](https://github.com/prateeksinghbundela/api_guard_grape_grape/wiki/Using-API-Guard-with-Devise#routes) for configuring API Guard routes to work with Devise.
 
 ### Registration
 
@@ -128,7 +128,7 @@ POST "/users/sign_up"
 
 # Request body
 {
-    "email": "user@apiguard.com",
+    "email": "user@ApiGuardGrape.com",
     "password": "api_password",
     "password_confirmation": "api_password"
 }
@@ -174,7 +174,7 @@ POST "/users/sign_in"
 
 # Request body
 {
-    "email": "user@apiguard.com",
+    "email": "user@ApiGuardGrape.com",
     "password": "api_password"
 }
 ```
@@ -347,18 +347,18 @@ Example response:
 To configure the API Guard you need to first create an initializer using
 
 ```bash
-$ rails generate api_guard:initializer
+$ rails generate api_guard_grape:initializer
 ```
 
-This will generate an initializer named **api_guard.rb** in your app **config/initializers** directory with default 
+This will generate an initializer named **api_guard_grape.rb** in your app **config/initializers** directory with default 
 configurations.
 
 ### Default configuration
 
-**config/initializers/api_guard.rb**
+**config/initializers/api_guard_grape.rb**
 
 ```ruby
-ApiGuard.setup do |config|
+ApiGuardGrape.setup do |config|
   # Validity of the JWT access token
   # Default: 1 day
   # config.token_validity = 1.day
@@ -434,11 +434,11 @@ $ rails db:migrate
 >**Note:** Replace `user` in the above command with your model name if your model is not User.
 
 After creating model and table for refresh token configure the association in the resource model using
-`api_guard_associations` method
+`api_guard_grape_associations` method
 
 ```ruby
 class User < ApplicationRecord
-  api_guard_associations refresh_token: 'refresh_tokens'
+  api_guard_grape_associations refresh_token: 'refresh_tokens'
   has_many :refresh_tokens, dependent: :delete_all
 end
 ```
@@ -446,7 +446,7 @@ end
 If you also have token blacklisting enabled you need to specify both associations as below
 
 ```ruby
-api_guard_associations refresh_token: 'refresh_tokens', blacklisted_token: 'blacklisted_tokens'
+api_guard_grape_associations refresh_token: 'refresh_tokens', blacklisted_token: 'blacklisted_tokens'
 ```
 
 ### Token blacklisting
@@ -470,11 +470,11 @@ $ rails db:migrate
 >**Note:** Replace `user` in the above command with your model name if your model is not User.
 
 After creating model and table for blacklisted token configure the association in the resource model using 
-`api_guard_associations` method
+`api_guard_grape_associations` method
 
 ```ruby
 class User < ApplicationRecord
-  api_guard_associations blacklisted_token: 'blacklisted_tokens'
+  api_guard_grape_associations blacklisted_token: 'blacklisted_tokens'
   has_many :blacklisted_tokens, dependent: :delete_all
 end
 ```
@@ -482,7 +482,7 @@ end
 If you also have token refreshing enabled you need to specify both associations as below
 
 ```ruby
-api_guard_associations refresh_token: 'refresh_tokens', blacklisted_token: 'blacklisted_tokens'
+api_guard_grape_associations refresh_token: 'refresh_tokens', blacklisted_token: 'blacklisted_tokens'
 ```
 
 And, as this creates rows in `blacklisted_tokens` table you need to have a mechanism to delete the expired blacklisted 
@@ -506,7 +506,7 @@ You can override the default API Guard controllers and customize the code as you
 your app
 
 ```bash
-$ rails generate api_guard:controllers users
+$ rails generate api_guard_grape:controllers users
 ```
 
 In above command `users` is the scope of the controllers. If needed, you can replace `users` with your own scope.
@@ -516,7 +516,7 @@ This will generate all default controllers for `users` in the directory **app/co
 Then, configure this controller in the routes
 
 ```ruby
-api_guard_routes for: 'users', controller: {
+api_guard_grape_routes for: 'users', controller: {
   registration: 'users/registration',
   authentication: 'users/authentication',
   passwords: 'users/passwords',
@@ -527,7 +527,7 @@ api_guard_routes for: 'users', controller: {
 You can also specify the controllers that you need to generate using `-c` or `--controllers` option.
 
 ```bash
-$ rails generate api_guard:controllers users -c registration authentication
+$ rails generate api_guard_grape:controllers users -c registration authentication
 ```
 
 >**Available controllers:** registration, authentication, tokens, passwords
@@ -537,7 +537,7 @@ $ rails generate api_guard:controllers users -c registration authentication
 You can skip specific controller routes generated by API Guard
 
 ```ruby
-api_guard_routes for: 'users', except: [:registration]
+api_guard_grape_routes for: 'users', except: [:registration]
 ```
 
 Above config will skip registration related API Guard controller routes for the resource user.
@@ -546,21 +546,21 @@ Above config will skip registration related API Guard controller routes for the
 You can also specify only the controller routes you need,
 
 ```ruby
-api_guard_routes for: 'users', only: [:authentication]
+api_guard_grape_routes for: 'users', only: [:authentication]
 ```
 
 >**Available controllers:** registration, authentication, tokens, passwords
 
 **Customizing the route path:**
 
-You can customize the path of the default routes of the API Guard using the `api_guard_scope` as below,
+You can customize the path of the default routes of the API Guard using the `api_guard_grape_scope` as below,
 
 ```ruby
-api_guard_routes for: 'users', except: [:registration]
+api_guard_grape_routes for: 'users', except: [:registration]
 
-api_guard_scope 'users' do
-  post 'account/create' => 'api_guard/registration#create'
-  delete 'account/delete' => 'api_guard/registration#destroy'
+api_guard_grape_scope 'users' do
+  post 'account/create' => 'api_guard_grape/registration#create'
+  delete 'account/delete' => 'api_guard_grape/registration#destroy'
 end
 ```
 
@@ -626,14 +626,14 @@ locale file and customize the messages for any language.
 
 ```yaml
 en:
-  api_guard:
+  api_guard_grape:
     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/prateeksinghbundela/api_guard_grape/blob/master/config/locales/en.yml
+https://github.com/prateeksinghbundela/api_guard_grape_grape/blob/master/config/locales/en.yml
 
 ## Testing
 
@@ -648,7 +648,7 @@ If you're using RSpec as your test framework then include the helper in **spec/r
 
 ```ruby
 RSpec.configure do |config|
-  config.include ApiGuard::Test::ControllerHelper
+  config.include ApiGuardGrape::Test::ControllerHelper
 end
 ```
 
@@ -657,7 +657,7 @@ end
 If you're using Minitest as your test framework then include the helper in your test file
 
 ```ruby
-include ApiGuard::Test::ControllerHelper
+include ApiGuardGrape::Test::ControllerHelper
 ```
 
 After including the helper, you can use this method to create the JWT access token and refresh token for the resource
@@ -680,7 +680,7 @@ Then, you can set the access token and refresh token in appropriate request head
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/prateeksinghbundela/api_guard_grape. 
+Bug reports and pull requests are welcome on GitHub at https://github.com/prateeksinghbundela/api_guard_grape_grape. 
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to 
 the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 

data/Rakefile

@@ -10,7 +10,7 @@ require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ApiGuard'
+  rdoc.title    = 'ApiGuardGrape'
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')

data/app/controllers/{api_guard → api_guard_grape}/application_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module ApiGuard
+module ApiGuardGrape
   class ApplicationController < ActionController::Base
     skip_before_action :verify_authenticity_token, raise: false
 

data/app/controllers/{api_guard → api_guard_grape}/authentication_controller.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_dependency 'api_guard/application_controller'
+require_dependency 'api_guard_grape/application_controller'
 
-module ApiGuard
+module ApiGuardGrape
   class AuthenticationController < ApplicationController
     before_action :find_resource, only: [:create]
     before_action :authenticate_resource, only: [:destroy]
@@ -10,22 +10,22 @@ module ApiGuard
     def create
       if resource.authenticate(params[:password])
         create_token_and_set_header(resource, resource_name)
-        render_success(message: I18n.t('api_guard.authentication.signed_in'))
+        render_success(message: I18n.t('api_guard_grape.authentication.signed_in'))
       else
-        render_error(422, message: I18n.t('api_guard.authentication.invalid_login_credentials'))
+        render_error(422, message: I18n.t('api_guard_grape.authentication.invalid_login_credentials'))
       end
     end
 
     def destroy
       blacklist_token
-      render_success(message: I18n.t('api_guard.authentication.signed_out'))
+      render_success(message: I18n.t('api_guard_grape.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.authentication.invalid_login_credentials')) unless resource
+      render_error(422, message: I18n.t('api_guard_grape.authentication.invalid_login_credentials')) unless resource
     end
   end
 end

data/app/controllers/{api_guard → api_guard_grape}/passwords_controller.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_dependency 'api_guard/application_controller'
+require_dependency 'api_guard_grape/application_controller'
 
-module ApiGuard
+module ApiGuardGrape
   class PasswordsController < ApplicationController
     before_action :authenticate_resource, only: [:update]
 
@@ -10,11 +10,11 @@ module ApiGuard
       invalidate_old_jwt_tokens(current_resource)
 
       if current_resource.update(password_params)
-        blacklist_token unless ApiGuard.invalidate_old_tokens_on_password_change
+        blacklist_token unless ApiGuardGrape.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.password.changed'))
+        render_success(message: I18n.t('api_guard_grape.password.changed'))
       else
         render_error(422, object: current_resource)
       end

data/app/controllers/{api_guard → api_guard_grape}/registration_controller.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_dependency 'api_guard/application_controller'
+require_dependency 'api_guard_grape/application_controller'
 
-module ApiGuard
+module ApiGuardGrape
   class RegistrationController < ApplicationController
     before_action :authenticate_resource, only: [:destroy]
 
@@ -10,7 +10,7 @@ module ApiGuard
       init_resource(sign_up_params)
       if resource.save
         create_token_and_set_header(resource, resource_name)
-        render_success(message: I18n.t('api_guard.registration.signed_up'))
+        render_success(message: I18n.t('api_guard_grape.registration.signed_up'))
       else
         render_error(422, object: resource)
       end
@@ -18,7 +18,7 @@ module ApiGuard
 
     def destroy
       current_resource.destroy
-      render_success(message: I18n.t('api_guard.registration.account_deleted'))
+      render_success(message: I18n.t('api_guard_grape.registration.account_deleted'))
     end
 
     private

data/app/controllers/{api_guard → api_guard_grape}/tokens_controller.rb

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

data/config/locales/en.yml

@@ -1,5 +1,5 @@
 en:
-  api_guard:
+  api_guard_grape:
     authentication:
       signed_in: 'Signed in successfully'
       signed_out: 'Signed out successfully'

data/config/routes.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-ApiGuard::Engine.routes.draw do
+ApiGuardGrape::Engine.routes.draw do
   # Can't see anything here?
-  # Goto 'lib/api_guard/route_mapper.rb'
+  # Goto 'lib/api_guard_grape/route_mapper.rb'
 end

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

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require 'api_guard/engine'
-require 'api_guard/route_mapper'
-require 'api_guard/modules'
+require 'api_guard_grape/engine'
+require 'api_guard_grape/route_mapper'
+require 'api_guard_grape/modules'
 
-module ApiGuard
-  autoload :AppSecretKey, 'api_guard/app_secret_key'
+module ApiGuardGrape
+  autoload :AppSecretKey, 'api_guard_grape/app_secret_key'
 
   module Test
-    autoload :ControllerHelper, 'api_guard/test/controller_helper'
+    autoload :ControllerHelper, 'api_guard_grape/test/controller_helper'
   end
 
   mattr_accessor :token_validity
@@ -23,8 +23,8 @@ module ApiGuard
   mattr_accessor :blacklist_token_after_refreshing
   self.blacklist_token_after_refreshing = false
 
-  mattr_accessor :api_guard_associations
-  self.api_guard_associations = {}
+  mattr_accessor :api_guard_grape_associations
+  self.api_guard_grape_associations = {}
 
   mattr_reader :mapped_resource do
     {}
@@ -35,6 +35,6 @@ module ApiGuard
   end
 
   def self.map_resource(routes_for, class_name)
-    mapped_resource[routes_for.to_sym] = ApiGuard::ResourceMapper.new(routes_for, class_name)
+    mapped_resource[routes_for.to_sym] = ApiGuardGrape::ResourceMapper.new(routes_for, class_name)
   end
 end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module ApiGuard
+module ApiGuardGrape
   class AppSecretKey
     def initialize(application)
       @application = application

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-module ApiGuard
+module ApiGuardGrape
   class Engine < ::Rails::Engine
-    isolate_namespace ApiGuard
+    isolate_namespace ApiGuardGrape
 
     config.generators do |g|
       g.test_framework :rspec
@@ -10,8 +10,8 @@ module ApiGuard
     end
 
     # Use 'secret_key_base' from Rails secrets if 'token_signing_secret' is not configured
-    initializer 'ApiGuard.token_signing_secret' do |app|
-      ApiGuard.token_signing_secret ||= ApiGuard::AppSecretKey.new(app).detect
+    initializer 'ApiGuardGrape.token_signing_secret' do |app|
+      ApiGuardGrape.token_signing_secret ||= ApiGuardGrape::AppSecretKey.new(app).detect
     end
   end
 end

data/lib/{api_guard → api_guard_grape}/jwt_auth/authentication.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module ApiGuard
+module ApiGuardGrape
   module JwtAuth
     # Common module for API authentication
     module Authentication
@@ -25,17 +25,17 @@ module ApiGuard
         @resource_name = resource_name
 
         @token = request.headers['Authorization']&.split('Bearer ')&.last
-        return render_error(401, message: I18n.t('api_guard.access_token.missing')) unless @token
+        return render_error(401, message: I18n.t('api_guard_grape.access_token.missing')) unless @token
 
         authenticate_token
 
         # Render error response only if no resource found and no previous render happened
-        render_error(401, message: I18n.t('api_guard.access_token.invalid')) if !current_resource && !performed?
+        render_error(401, message: I18n.t('api_guard_grape.access_token.invalid')) if !current_resource && !performed?
       rescue JWT::DecodeError => e
         if e.message == 'Signature has expired'
-          render_error(401, message: I18n.t('api_guard.access_token.expired'))
+          render_error(401, message: I18n.t('api_guard_grape.access_token.expired'))
         else
-          render_error(401, message: I18n.t('api_guard.access_token.invalid'))
+          render_error(401, message: I18n.t('api_guard_grape.access_token.invalid'))
         end
       end
 
@@ -50,7 +50,7 @@ module ApiGuard
       # Returns whether the JWT token is issued after the last password change
       # Returns true if password hasn't changed by the user
       def self.valid_issued_at?(resource)
-        return true unless ApiGuard.invalidate_old_tokens_on_password_change
+        return true unless ApiGuardGrape.invalidate_old_tokens_on_password_change
 
         !resource.token_issued_at || @decoded_token[:iat] >= resource.token_issued_at.to_i
       end
@@ -77,7 +77,7 @@ module ApiGuard
         if resource && valid_issued_at?(resource) && !blacklisted?(resource)
           define_current_resource_accessors(resource)
         else
-          render_error(401, message: I18n.t('api_guard.access_token.invalid'))
+          render_error(401, message: I18n.t('api_guard_grape.access_token.invalid'))
         end
       end
 

data/lib/{api_guard → api_guard_grape}/jwt_auth/blacklist_token.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module ApiGuard
+module ApiGuardGrape
   module JwtAuth
     # Common module for token blacklisting functionality
     module BlacklistToken

data/lib/{api_guard → api_guard_grape}/jwt_auth/json_web_token.rb

@@ -2,7 +2,7 @@
 
 require 'jwt'
 
-module ApiGuard
+module ApiGuardGrape
   module JwtAuth
     # Common module for JWT operations
     module JsonWebToken
@@ -11,7 +11,7 @@ module ApiGuard
       end
 
       def self.token_expire_at
-        @token_expire_at ||= (current_time + ApiGuard.token_validity).to_i
+        @token_expire_at ||= (current_time + ApiGuardGrape.token_validity).to_i
       end
 
       def self.token_issued_at
@@ -20,13 +20,13 @@ module ApiGuard
 
       # Encode the payload with the secret key and return the JWT token
       def self.encode(payload)
-        JWT.encode(payload, ApiGuard.token_signing_secret)
+        JWT.encode(payload, ApiGuardGrape.token_signing_secret)
       end
 
       # Decode the JWT token and return the payload
       def self.decode(token, verify = true)
         HashWithIndifferentAccess.new(
-          JWT.decode(token, ApiGuard.token_signing_secret, verify, verify_iat: true)[0]
+          JWT.decode(token, ApiGuardGrape.token_signing_secret, verify, verify_iat: true)[0]
         )
       end
 
@@ -63,7 +63,7 @@ module ApiGuard
       # Set token issued at to current timestamp
       # to restrict access to old access(JWT) tokens
       def self.invalidate_old_jwt_tokens(resource)
-        return unless ApiGuard.invalidate_old_tokens_on_password_change
+        return unless ApiGuardGrape.invalidate_old_tokens_on_password_change
 
         resource.token_issued_at = Time.at(token_issued_at).utc
       end
@@ -160,17 +160,17 @@ module ApiGuard
         @resource_name = resource_name
 
         @token = request.headers['Authorization']&.split('Bearer ')&.last
-        return render_error(401, message: I18n.t('api_guard.access_token.missing')) unless @token
+        return render_error(401, message: I18n.t('api_guard_grape.access_token.missing')) unless @token
 
         authenticate_token
 
         # Render error response only if no resource found and no previous render happened
-        render_error(401, message: I18n.t('api_guard.access_token.invalid')) if !current_resource && !performed?
+        render_error(401, message: I18n.t('api_guard_grape.access_token.invalid')) if !current_resource && !performed?
       rescue JWT::DecodeError => e
         if e.message == 'Signature has expired'
-          render_error(401, message: I18n.t('api_guard.access_token.expired'))
+          render_error(401, message: I18n.t('api_guard_grape.access_token.expired'))
         else
-          render_error(401, message: I18n.t('api_guard.access_token.invalid'))
+          render_error(401, message: I18n.t('api_guard_grape.access_token.invalid'))
         end
       end
 
@@ -185,7 +185,7 @@ module ApiGuard
       # Returns whether the JWT token is issued after the last password change
       # Returns true if password hasn't changed by the user
       def self.valid_issued_at?(resource)
-        return true unless ApiGuard.invalidate_old_tokens_on_password_change
+        return true unless ApiGuardGrape.invalidate_old_tokens_on_password_change
 
         !resource.token_issued_at || @decoded_token[:iat] >= resource.token_issued_at.to_i
       end
@@ -212,7 +212,7 @@ module ApiGuard
         if resource && valid_issued_at?(resource) && !blacklisted?(resource)
           define_current_resource_accessors(resource)
         else
-          render_error(401, message: I18n.t('api_guard.access_token.invalid'))
+          render_error(401, message: I18n.t('api_guard_grape.access_token.invalid'))
         end
       end
 

data/lib/{api_guard → api_guard_grape}/jwt_auth/refresh_jwt_token.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module ApiGuard
+module ApiGuardGrape
   module JwtAuth
     # Common module for refresh token functionality
     module RefreshJwtToken

data/lib/api_guard_grape/models/concerns.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ApiGuardGrape
+  module Models
+    module Concerns
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def api_guard_grape_associations(refresh_token: nil, blacklisted_token: nil)
+          return if ApiGuardGrape.api_guard_grape_associations[name]
+
+          ApiGuardGrape.api_guard_grape_associations[name] = {}
+          ApiGuardGrape.api_guard_grape_associations[name][:refresh_token] = refresh_token
+          ApiGuardGrape.api_guard_grape_associations[name][:blacklisted_token] = blacklisted_token
+        end
+
+        def refresh_token_association
+          ApiGuardGrape.api_guard_grape_associations.dig(name, :refresh_token)
+        end
+
+        def blacklisted_token_association
+          ApiGuardGrape.api_guard_grape_associations.dig(name, :blacklisted_token)
+        end
+      end
+    end
+  end
+end

data/lib/api_guard_grape/modules.rb

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

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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-module ApiGuard
+module ApiGuardGrape
   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_#{routes_for}"
+      @resource_instance_name = "@api_guard_grape_#{routes_for}"
     end
   end
 
@@ -21,7 +21,7 @@ module ApiGuard
     end
 
     def current_resource_mapping
-      request.env['api_guard.mapping']
+      request.env['api_guard_grape.mapping']
     end
 
     def resource_name

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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-module ApiGuard
+module ApiGuardGrape
   module ResponseFormatters
     module Renderer
       def render_success(data: nil, message: nil)
-        resp_data = { status: I18n.t('api_guard.response.success') }
+        resp_data = { status: I18n.t('api_guard_grape.response.success') }
         resp_data[:message] = message if message
         resp_data[:data] = data if data
 
@@ -12,7 +12,7 @@ module ApiGuard
       end
 
       def render_error(status, options = {})
-        data = { status: I18n.t('api_guard.response.error') }
+        data = { status: I18n.t('api_guard_grape.response.error') }
         data[:error] = options[:object] ? options[:object].errors.full_messages[0] : options[:message]
 
         render json: data, status: status

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

@@ -7,7 +7,7 @@
 module ActionDispatch
   module Routing
     class Mapper
-      def api_guard_routes(options = {})
+      def api_guard_grape_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_scope(routes_for) do |mapped_resource|
+        api_guard_grape_scope(routes_for) do |mapped_resource|
           scope options do
             generate_routes(mapped_resource, controller_options, controllers)
           end
         end
       end
 
-      def api_guard_scope(routes_for)
-        mapped_resource = ApiGuard.mapped_resource[routes_for.to_sym].presence ||
-                          ApiGuard.map_resource(routes_for, routes_for.classify)
+      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)
 
         constraint = lambda do |request|
-          request.env['api_guard.mapping'] = mapped_resource
+          request.env['api_guard_grape.mapping'] = mapped_resource
           true
         end
 
@@ -56,27 +56,27 @@ module ActionDispatch
       end
 
       def authentication_routes(controller_name = nil)
-        controller_name ||= 'api_guard/authentication'
+        controller_name ||= 'api_guard_grape/authentication'
 
         post 'sign_in' => "#{controller_name}#create"
         delete 'sign_out' => "#{controller_name}#destroy"
       end
 
       def registration_routes(controller_name = nil)
-        controller_name ||= 'api_guard/registration'
+        controller_name ||= 'api_guard_grape/registration'
 
         post 'sign_up' => "#{controller_name}#create"
         delete 'delete' => "#{controller_name}#destroy"
       end
 
       def passwords_routes(controller_name = nil)
-        controller_name ||= 'api_guard/passwords'
+        controller_name ||= 'api_guard_grape/passwords'
 
         patch 'passwords' => "#{controller_name}#update"
       end
 
       def tokens_routes(controller_name = nil)
-        controller_name ||= 'api_guard/tokens'
+        controller_name ||= 'api_guard_grape/tokens'
 
         post 'tokens' => "#{controller_name}#create"
       end

data/lib/api_guard_grape/test/controller_helper.rb

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

data/lib/api_guard_grape/version.rb

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

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

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

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

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

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

@@ -1,27 +1,27 @@
 module <%= @controller_scope %>
-  class AuthenticationController < ApiGuard::AuthenticationController
+  class AuthenticationController < ApiGuardGrape::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.authentication.signed_in'))
+    #     render_success(message: I18n.t('api_guard_grape.authentication.signed_in'))
     #   else
-    #     render_error(422, message: I18n.t('api_guard.authentication.invalid_login_credentials'))
+    #     render_error(422, message: I18n.t('api_guard_grape.authentication.invalid_login_credentials'))
     #   end
     # end
 
     # def destroy
     #   blacklist_token
-    #   render_success(message: I18n.t('api_guard.authentication.signed_out'))
+    #   render_success(message: I18n.t('api_guard_grape.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.authentication.invalid_login_credentials')) unless resource
+    #   render_error(422, message: I18n.t('api_guard_grape.authentication.invalid_login_credentials')) unless resource
     # end
   end
 end

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

@@ -1,16 +1,16 @@
 module <%= @controller_scope %>
-  class PasswordsController < ApiGuard::PasswordsController
+  class PasswordsController < ApiGuardGrape::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 ApiGuard.invalidate_old_tokens_on_password_change
+    #     blacklist_token unless ApiGuardGrape.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.password.changed'))
+    #     render_success(message: I18n.t('api_guard_grape.password.changed'))
     #   else
     #     render_error(422, object: current_resource)
     #   end

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

@@ -1,12 +1,12 @@
 module <%= @controller_scope %>
-  class RegistrationController < ApiGuard::RegistrationController
+  class RegistrationController < ApiGuardGrape::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.registration.signed_up'))
+    #     render_success(message: I18n.t('api_guard_grape.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.registration.account_deleted'))
+    #   render_success(message: I18n.t('api_guard_grape.registration.account_deleted'))
     # end
 
     # private

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

@@ -1,5 +1,5 @@
 module <%= @controller_scope %>
-  class TokensController < ApiGuard::TokensController
+  class TokensController < ApiGuardGrape::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 ApiGuard.blacklist_token_after_refreshing
+    #   blacklist_token if ApiGuardGrape.blacklist_token_after_refreshing
     #
-    #   render_success(message: I18n.t('api_guard.access_token.refreshed'))
+    #   render_success(message: I18n.t('api_guard_grape.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.refresh_token.invalid')) unless @refresh_token
+    #     return render_error(401, message: I18n.t('api_guard_grape.refresh_token.invalid')) unless @refresh_token
     #   else
-    #     render_error(401, message: I18n.t('api_guard.refresh_token.missing'))
+    #     render_error(401, message: I18n.t('api_guard_grape.refresh_token.missing'))
     #   end
     # end
   end

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

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

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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-module ApiGuard
+module ApiGuardGrape
   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.rb'
+      copy_file 'initializer.rb', 'config/initializers/api_guard_grape.rb'
     end
   end
 end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-ApiGuard.setup do |config|
+ApiGuardGrape.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.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Prateek Singh
@@ -146,37 +146,37 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- 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
+- 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
 - config/locales/en.yml
 - config/routes.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
+- 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
+homepage: https://github.com/prateeksinghbundela/api_guard_grape
 licenses:
 - MIT
 metadata: {}

data/lib/api_guard/models/concerns.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module ApiGuard
-  module Models
-    module Concerns
-      extend ActiveSupport::Concern
-
-      class_methods do
-        def api_guard_associations(refresh_token: nil, blacklisted_token: nil)
-          return if ApiGuard.api_guard_associations[name]
-
-          ApiGuard.api_guard_associations[name] = {}
-          ApiGuard.api_guard_associations[name][:refresh_token] = refresh_token
-          ApiGuard.api_guard_associations[name][:blacklisted_token] = blacklisted_token
-        end
-
-        def refresh_token_association
-          ApiGuard.api_guard_associations.dig(name, :refresh_token)
-        end
-
-        def blacklisted_token_association
-          ApiGuard.api_guard_associations.dig(name, :blacklisted_token)
-        end
-      end
-    end
-  end
-end

data/lib/api_guard/modules.rb

@@ -1,26 +0,0 @@
-# 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/test/controller_helper.rb

@@ -1,13 +0,0 @@
-# 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

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