api_guard 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc003426a48f2bf1a83d3b1653438efa43522f465a4cf98b4ac0b030f691cbfd
-  data.tar.gz: 771a016a40a938684ea61accde401e7eed3dc8c201688f51bb0444cd241901d7
+  metadata.gz: 664b5fd08385f8cb690e350127d83bdeb8228264ccf179bc2a4242841e27e114
+  data.tar.gz: 6c94a5a7867c4ce5aa186f4f18fbfd4706b654818de791e23b8d83827e58fcf1
 SHA512:
-  metadata.gz: 16a0a967961773fcfdab3744fcfd228198484eb550b7b6abeb19e4daa1d2a42d7ecf2730709c4ab7f518bdb0fe1781973255b24da60c67a88b71198cb76913d1
-  data.tar.gz: e609d92695acc9d424739450b87c6a7cd4725d200e3b3bdf745e465e2c090fe9af7bb15820bb02d9964cc0af420f7faa34fede752484b41dcfe9aaf7bc53114c
+  metadata.gz: 4d5b0b0145c8c2c82a4a679c2ece7249e397ec3ad497dc9336388fff6d6830e76f70078336a50b790ace86f374967840c99535b86989bb2bec570d30fbe5b912
+  data.tar.gz: e90af09ed86e505eb7a38f489f3347fbfc9f906f7d141748c4c4bc28365cf165cbfa668832eceef29e744dcb9ea929e4b568181730cd6337023183b64cd5cd40

data/README.md

@@ -424,7 +424,7 @@ To include token refreshing in your application you need to create a table to st
 Use below command to create a model `RefeshToken` with columns to store the token and the user reference
 
 ```bash
-$ rails generate model refresh_token token:string:uniq user:references
+$ rails generate model refresh_token token:string:uniq user:references expire_at:datetime
 ```
 
 Then, run migration to create the `refresh_tokens` table

data/lib/api_guard/jwt_auth/json_web_token.rb

@@ -34,7 +34,8 @@ module ApiGuard
       # Also, create refresh token if enabled for the resource.
       #
       # This creates expired JWT token if the argument 'expired_token' is true which can be used for testing.
-      def jwt_and_refresh_token(resource, resource_name, expired_token = false)
+      # This creates expired refresh token if the argument 'expired_refresh_token' is true which can be used for testing.
+      def jwt_and_refresh_token(resource, resource_name, expired_token = false, expired_refresh_token = false)
         payload = {
           "#{resource_name}_id": resource.id,
           exp: expired_token ? token_issued_at : token_expire_at,
@@ -44,7 +45,7 @@ module ApiGuard
         # Add custom data in the JWT token payload
         payload.merge!(resource.jwt_token_payload) if resource.respond_to?(:jwt_token_payload)
 
-        [encode(payload), new_refresh_token(resource)]
+        [encode(payload), new_refresh_token(resource, expired_refresh_token)]
       end
 
       # Create tokens and set response headers

data/lib/api_guard/jwt_auth/refresh_jwt_token.rb

@@ -4,6 +4,11 @@ module ApiGuard
   module JwtAuth
     # Common module for refresh token functionality
     module RefreshJwtToken
+
+      def refresh_token_expire_at
+        @refresh_token_expire_at ||= (Time.now.utc + ApiGuard.refresh_token_validity)
+      end
+
       def refresh_token_association(resource)
         resource.class.refresh_token_association
       end
@@ -18,7 +23,7 @@ module ApiGuard
       end
 
       def find_refresh_token_of(resource, refresh_token)
-        refresh_tokens_for(resource).find_by_token(refresh_token)
+        refresh_tokens_for(resource).where(token: refresh_token).where('expire_at IS NULL OR expire_at > ?', Time.now.utc).first
       end
 
       # Generate and return unique refresh token for the resource
@@ -30,10 +35,11 @@ module ApiGuard
       end
 
       # Create a new refresh_token for the current resource
-      def new_refresh_token(resource)
+      # This creates expired refresh_token if the argument 'expired_refresh_token' is true which can be used for testing.
+      def new_refresh_token(resource, expired_refresh_token = false)
         return unless refresh_token_enabled?(resource)
 
-        refresh_tokens_for(resource).create(token: uniq_refresh_token(resource)).token
+        refresh_tokens_for(resource).create(token: uniq_refresh_token(resource), expire_at: expired_refresh_token ? Time.now.utc : refresh_token_expire_at).token
       end
 
       def destroy_all_refresh_tokens(resource)

data/lib/api_guard/version.rb

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

data/lib/api_guard.rb

@@ -14,6 +14,9 @@ module ApiGuard
   mattr_accessor :token_validity
   self.token_validity = 1.day
 
+  mattr_accessor :refresh_token_validity
+  self.refresh_token_validity = 2.weeks
+
   mattr_accessor :token_signing_secret
   self.token_signing_secret = nil
 

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

@@ -4,6 +4,10 @@ ApiGuard.setup do |config|
   # Validity of the JWT access token
   # Default: 1 day
   # config.token_validity = 1.day
+    
+  # Validity of the refresh token
+  # Default: 2 weeks
+  # config.refresh_token_validity = 2.weeks
 
   # Secret key for signing (encoding & decoding) the JWT access token
   # Default: 'secret_key_base' from Rails secrets

metadata

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