jwt_sessions 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a485796c7aa19c00c79992111ed0135c0ec93af6e88aff80b233be779bb2301
-  data.tar.gz: d0b89a924589aa8450cfcaefb2061674db4d61cb32ed5ace92f1cab021db1fb1
+  metadata.gz: ad42d33af309b3295e9aa6402179df2a9a0ac5e17618d133427e27edafca9578
+  data.tar.gz: e67b97b9bf3a2aec4bba3f66cc517d4dad03bcb4ce73269147cce31bcd9d85d4
 SHA512:
-  metadata.gz: e0bef3934719502d51f1299b210fad2df87360ef91cc3471384c3840870f3d548f43c5c5c1ff89a33e9e8847b706f9b7e1d2c240f288a21a16533369d8b0fce5
-  data.tar.gz: cd8b450b1a09e13290e3ac6ec5bcd17cf52c7314f01044ca1c2888321816585ff27eb7ae7b3935f5aa388fec3c11d9b8ebb0fe2c5fdde5a99cbc390932c4a646
+  metadata.gz: fe6bc8a993388688a85d6b86ea139ab8d3123b628db77181fa4db6ba68d92c0080ca16fdfcaeb3567be9f2a07896df711cb9edb9c7845d6a226408e6fda00de9
+  data.tar.gz: 712ea681644f82710f5d561a96e78df86c1c3e4c225b8535a9d1cd2e03bcb363d93e4b42764847b786461e26f6f9440a3f85b026e02fa557c647a5866eef70dc

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.7.0 (October 05, 2021)
+
+Features:
+
+- added redis_client setting to JWTSessions::StoreAdapters::RedisStoreAdapter
+
 ## 2.6.0 (June 01, 2021)
 
 Features:

data/README.md

@@ -153,11 +153,11 @@ end
 ```
 
 Specify an encryption key for JSON Web Tokens in `config/initializers/jwt_session.rb` \
-It is advisable to store the key itself within the app secrets.
+It is advisable to store the key itself in a secure way, f.e. within app credentials.
 
 ```ruby
 JWTSessions.algorithm = "HS256"
-JWTSessions.encryption_key = Rails.application.secrets.secret_jwt_encryption_key
+JWTSessions.encryption_key = Rails.application.credentials.secret_jwt_encryption_key
 ```
 
 Most of the encryption algorithms require private and public keys to sign a token. However, HMAC requires only a single key and you can use the `encryption_key` shortcut to sign the token. For other algorithms you must specify private and public keys separately.
@@ -378,6 +378,12 @@ JWTSessions.token_store = :redis, {
 }
 ```
 
+If you already have a configured Redis client, you can pass it among the options to reduce opened connections to a Redis server:
+
+```ruby
+JWTSessions.token_store = :redis, {redis_client: Redis.current}
+```
+
 ##### JWT signature
 
 ```ruby

data/lib/jwt_sessions/store_adapters/redis_store_adapter.rb

@@ -7,16 +7,20 @@ module JWTSessions
 
       REFRESH_KEYS = %i[csrf access_uid access_expiration expiration].freeze
 
-      def initialize(token_prefix: JWTSessions.token_prefix, **options)
+      def initialize(token_prefix: JWTSessions.token_prefix, redis_client: nil, **options)
         @prefix = token_prefix
 
-        begin
-          require "redis"
-          @storage = configure_redis_client(**options)
-        rescue LoadError => e
-          msg = "Could not load the 'redis' gem, please add it to your gemfile or " \
-                "configure a different adapter (e.g. JWTSessions.store_adapter = :memory)"
-          raise e.class, msg, e.backtrace
+        if redis_client
+          @storage = redis_client
+        else
+          begin
+            require "redis"
+            @storage = configure_redis_client(**options)
+          rescue LoadError => e
+            msg = "Could not load the 'redis' gem, please add it to your gemfile or " \
+                  "configure a different adapter (e.g. JWTSessions.store_adapter = :memory)"
+            raise e.class, msg, e.backtrace
+          end
         end
       end
 

data/lib/jwt_sessions/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JWTSessions
-  VERSION = "2.6.0"
+  VERSION = "2.7.0"
 end

data/test/units/jwt_sessions/store_adapters/test_redis_store_adapter.rb

@@ -77,4 +77,10 @@ class TestRedisStoreAdapter < Minitest::Test
     adapter = JWTSessions::StoreAdapters::RedisStoreAdapter.new
     assert_equal "redis://127.0.0.2:6322/0", adapter.storage.connection[:id]
   end
+
+  def test_configuration_via_redis_client
+    client = Object.new
+    adapter = JWTSessions::StoreAdapters::RedisStoreAdapter.new(redis_client: client)
+    assert_equal client, adapter.storage
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jwt_sessions
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Yulia Oletskaya
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -98,7 +98,7 @@ metadata:
   changelog_uri: https://github.com/tuwukee/jwt_sessions/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/tuwukee/jwt_sessions
   bug_tracker_uri: https://github.com/tuwukee/jwt_sessions/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,8 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.5
+signing_key:
 specification_version: 4
 summary: JWT Sessions
 test_files: