api_guard_grape 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0f059f11ee3c6b9387bc7492027ee5a521110cd13ffff5367e99c19210546c6
-  data.tar.gz: 6fcd6cf23fe46e68400ab26ca485ac16439a1f1ec2d0357379249842ba8c628b
+  metadata.gz: 03fd89353f83f1dff916ed717aeb63ab7a957c867f82849e7b9db0c59f8b495e
+  data.tar.gz: 3934bf4a9824a8d81d28e4ec1eed7d4a4a4fa0fc526154375ad35316fdc10c84
 SHA512:
-  metadata.gz: e5a6532eb9cbb2c26d878822158ee04e17146f8896109620beb573ef7f6bb29e122dd5d1bac8e63a263de4dabd3fe0563df0bfb1db58d0cf3d5c1a26fb00081a
-  data.tar.gz: 335d7d8ae4baecf1df445ba7d597142ffb7344658340cb8bde36f36bc82a9a8795ac611f2846159e648e3a357c3ed4e856f59ac7264a278a9ff0b7983bffd5b6
+  metadata.gz: 16190fb470832b3f483d8879dd41dc4eff235fe84a3274ad4ca31ced70f503a165270b9745ed83c4ae894ac614097adde6fb35434a8659fe9e1b154a93c9bfb3
+  data.tar.gz: 6345f644b9a59ffd6da22f9f5284baf2a8ac4ef572a95263d15e73c4f5448bb181f7a891f081edfc27422e5b4ca35293b8eb68c8d16dfa63570b2a6eba61c6b3

data/README.md

@@ -1,8 +1,8 @@
 # API Guard
 
-[![Version](https://img.shields.io/gem/v/api_guard_grape.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.svg?color=green)](https://rubygems.org/gems/api_guard)
+[![Build Status](https://github.com/Gokul595/api_guard/workflows/build/badge.svg?branch=master)](https://github.com/Gokul595/api_guard/actions?query=workflow%3Abuild)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ced3e74a26a66ed915cb/maintainability)](https://codeclimate.com/github/Gokul595/api_guard/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/Gokul595/api_guard/wiki)
+    * [Using API Guard with Devise](https://github.com/Gokul595/api_guard/wiki/Using-API-Guard-with-Devise)
 * [Contributing](#contributing)
 * [License](#license)
 
@@ -48,7 +48,7 @@ for cryptographic signing.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'api_guard_grape'
+gem 'api_guard'
 ```
 
 And then execute in your terminal:
@@ -58,7 +58,7 @@ $ bundle install
 
 Or install it yourself as:
 ```bash
-$ gem install api_guard_grape
+$ gem install api_guard
 ```
 
 ## Getting Started
@@ -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/Gokul595/api_guard/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_grape_routes for: 'users'
+api_guard_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/Gokul595/api_guard/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@ApiGuardGrape.com",
+    "email": "user@apiguard.com",
     "password": "api_password",
     "password_confirmation": "api_password"
 }
@@ -174,7 +174,7 @@ POST "/users/sign_in"
 
 # Request body
 {
-    "email": "user@ApiGuardGrape.com",
+    "email": "user@apiguard.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_grape:initializer
+$ rails generate api_guard:initializer
 ```
 
-This will generate an initializer named **api_guard_grape.rb** in your app **config/initializers** directory with default 
+This will generate an initializer named **api_guard.rb** in your app **config/initializers** directory with default 
 configurations.
 
 ### Default configuration
 
-**config/initializers/api_guard_grape.rb**
+**config/initializers/api_guard.rb**
 
 ```ruby
-ApiGuardGrape.setup do |config|
+ApiGuard.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_grape_associations` method
+`api_guard_associations` method
 
 ```ruby
 class User < ApplicationRecord
-  api_guard_grape_associations refresh_token: 'refresh_tokens'
+  api_guard_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_grape_associations refresh_token: 'refresh_tokens', blacklisted_token: 'blacklisted_tokens'
+api_guard_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_grape_associations` method
+`api_guard_associations` method
 
 ```ruby
 class User < ApplicationRecord
-  api_guard_grape_associations blacklisted_token: 'blacklisted_tokens'
+  api_guard_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_grape_associations refresh_token: 'refresh_tokens', blacklisted_token: 'blacklisted_tokens'
+api_guard_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_grape:controllers users
+$ rails generate api_guard: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_grape_routes for: 'users', controller: {
+api_guard_routes for: 'users', controller: {
   registration: 'users/registration',
   authentication: 'users/authentication',
   passwords: 'users/passwords',
@@ -527,7 +527,7 @@ api_guard_grape_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_grape:controllers users -c registration authentication
+$ rails generate api_guard:controllers users -c registration authentication
 ```
 
 >**Available controllers:** registration, authentication, tokens, passwords
@@ -537,7 +537,7 @@ $ rails generate api_guard_grape:controllers users -c registration authenticatio
 You can skip specific controller routes generated by API Guard
 
 ```ruby
-api_guard_grape_routes for: 'users', except: [:registration]
+api_guard_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_grape_routes for: 'users', only: [:authentication]
+api_guard_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_grape_scope` as below,
+You can customize the path of the default routes of the API Guard using the `api_guard_scope` as below,
 
 ```ruby
-api_guard_grape_routes for: 'users', except: [:registration]
+api_guard_routes for: 'users', except: [:registration]
 
-api_guard_grape_scope 'users' do
-  post 'account/create' => 'api_guard_grape/registration#create'
-  delete 'account/delete' => 'api_guard_grape/registration#destroy'
+api_guard_scope 'users' do
+  post 'account/create' => 'api_guard/registration#create'
+  delete 'account/delete' => 'api_guard/registration#destroy'
 end
 ```
 
@@ -626,14 +626,14 @@ locale file and customize the messages for any language.
 
 ```yaml
 en:
-  api_guard_grape:
+  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/prateeksinghbundela/api_guard_grape/blob/master/config/locales/en.yml
+https://github.com/Gokul595/api_guard/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 ApiGuardGrape::Test::ControllerHelper
+  config.include ApiGuard::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 ApiGuardGrape::Test::ControllerHelper
+include ApiGuard::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. 
+Bug reports and pull requests are welcome on GitHub at https://github.com/Gokul595/api_guard. 
 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    = 'ApiGuardGrape'
+  rdoc.title    = 'ApiGuard'
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')

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

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

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_dependency 'api_guard_grape/application_controller'
+require_dependency 'api_guard/application_controller'
 
-module ApiGuardGrape
+module ApiGuard
   class AuthenticationController < ApplicationController
     before_action :find_resource, only: [:create]
     before_action :authenticate_resource, only: [:destroy]
@@ -10,22 +10,22 @@ module ApiGuardGrape
     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/app/controllers/{api_guard_grape → api_guard}/passwords_controller.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_dependency 'api_guard_grape/application_controller'
+require_dependency 'api_guard/application_controller'
 
-module ApiGuardGrape
+module ApiGuard
   class PasswordsController < ApplicationController
     before_action :authenticate_resource, only: [:update]
 
@@ -10,11 +10,11 @@ module ApiGuardGrape
       invalidate_old_jwt_tokens(current_resource)
 
       if current_resource.update(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/app/controllers/{api_guard_grape → api_guard}/registration_controller.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_dependency 'api_guard_grape/application_controller'
+require_dependency 'api_guard/application_controller'
 
-module ApiGuardGrape
+module ApiGuard
   class RegistrationController < ApplicationController
     before_action :authenticate_resource, only: [:destroy]
 
@@ -10,7 +10,7 @@ module ApiGuardGrape
       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
@@ -18,7 +18,7 @@ module ApiGuardGrape
 
     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/app/controllers/{api_guard_grape → api_guard}/tokens_controller.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_dependency 'api_guard_grape/application_controller'
+require_dependency 'api_guard/application_controller'
 
-module ApiGuardGrape
+module ApiGuard
   class TokensController < ApplicationController
     before_action :authenticate_resource, only: [:create]
     before_action :find_refresh_token, only: [:create]
@@ -11,9 +11,9 @@ module ApiGuardGrape
       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
@@ -23,9 +23,9 @@ module ApiGuardGrape
 
       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/config/locales/en.yml

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

data/config/routes.rb

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

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

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