api_guard 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db273f8953347d07ed9d5acb5923480e463461517e2e1396d37a9db704ffc218
-  data.tar.gz: 92b5aeffc41c1d97d3d1ade1389b4acd902ff66166ecb3895fd858b0f8f51a01
+  metadata.gz: bc003426a48f2bf1a83d3b1653438efa43522f465a4cf98b4ac0b030f691cbfd
+  data.tar.gz: 771a016a40a938684ea61accde401e7eed3dc8c201688f51bb0444cd241901d7
 SHA512:
-  metadata.gz: d99aa923a6b41bdc4b1c5524cc9159342fee8e1c31931d0387c21651d7b338ccef6be7773cdd48d8773f1b50000e228310bf7a18d9c3cefaeb52f63f2b82c824
-  data.tar.gz: 3651814062e401e8c8be16d9c103a23de042232140bccb10a79977dc3ffdb7370b658ddfeed26cc3e995705e3d7e60c90d97f5b65469025eed717260e6097a31
+  metadata.gz: 16a0a967961773fcfdab3744fcfd228198484eb550b7b6abeb19e4daa1d2a42d7ecf2730709c4ab7f518bdb0fe1781973255b24da60c67a88b71198cb76913d1
+  data.tar.gz: e609d92695acc9d424739450b87c6a7cd4725d200e3b3bdf745e465e2c090fe9af7bb15820bb02d9964cc0af420f7faa34fede752484b41dcfe9aaf7bc53114c

data/README.md

@@ -1,7 +1,7 @@
 # API Guard
 
 [![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)
+[![Build Status](https://github.com/Gokul595/api_guard/workflows/build-master/badge.svg?branch=master)](https://github.com/Gokul595/api_guard/actions?query=workflow%3Abuild-master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/ced3e74a26a66ed915cb/maintainability)](https://codeclimate.com/github/Gokul595/api_guard/maintainability)
 
 
@@ -202,6 +202,8 @@ To authenticate the API request just add this before_action in the controller:
 before_action :authenticate_and_set_user
 ```
 
+>**Note:** It is possible to authenticate with more than one resource, e.g. `authenticate_and_set_user_or_admin` will permit tokens issued for users or admins.
+
 Send the access token got in sign in API in the Authorization header in the API request as below. 
 Also, make sure you add "Bearer" before the access token in the header value.
 
@@ -451,11 +453,11 @@ api_guard_associations refresh_token: 'refresh_tokens', blacklisted_token: 'blac
 
 ### Token blacklisting
 
-To include token blacklisting in your application you need to create a table to store the refresh tokens. This will be 
+To include token blacklisting in your application you need to create a table to store the blacklisted tokens. This will be 
 used to blacklist a JWT access token from future use. The access token will be blacklisted on successful sign out of the 
 resource.
 
-Use below command to create a model `RefeshToken` with columns to store the token and the user reference
+Use below command to create a model `BlacklistedToken` with columns to store the token and the user reference
 
 ```bash
 $ rails generate model blacklisted_token token:string user:references expire_at:datetime

data/lib/api_guard/jwt_auth/authentication.rb

@@ -9,8 +9,8 @@ module ApiGuard
         method_name = name.to_s
 
         if method_name.start_with?('authenticate_and_set_')
-          resource_name = method_name.split('authenticate_and_set_')[1]
-          authenticate_and_set_resource(resource_name)
+          resource_names = method_name.split('authenticate_and_set_')[1].split('_or_')
+          authenticate_and_set_resources(resource_names)
         else
           super
         end
@@ -20,9 +20,9 @@ module ApiGuard
         method_name.to_s.start_with?('authenticate_and_set_') || super
       end
 
-      # Authenticate the JWT token and set resource
-      def authenticate_and_set_resource(resource_name)
-        @resource_name = resource_name
+      # Authenticate the JWT token and set resources
+      def authenticate_and_set_resources(resource_names)
+        @resource_names = resource_names
 
         @token = request.headers['Authorization']&.split('Bearer ')&.last
         return render_error(401, message: I18n.t('api_guard.access_token.missing')) unless @token
@@ -72,15 +72,25 @@ module ApiGuard
       def authenticate_token
         return unless decode_token
 
+        @resource_name = set_resource_name_from_token(@resource_names)
+        return if @resource_name.nil?
+
         resource = find_resource_from_token(@resource_name.classify.constantize)
 
         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'))
         end
       end
 
+      def set_resource_name_from_token(resource_names)
+        resource_names.each do |name|
+          resource_id = @decoded_token[:"#{name}_id"]
+          return name if resource_id.present?
+        end
+
+        return nil
+      end
+
       def find_resource_from_token(resource_class)
         resource_id = @decoded_token[:"#{@resource_name}_id"]
         return if resource_id.blank?

data/lib/api_guard/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_guard
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Gokul Murali
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-08 00:00:00.000000000 Z
+date: 2021-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt