jwt_keeper 5.0.1 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ce4912150544b5d9944105ef36f43022c480578eb922d6a5f001c2044a53de6
-  data.tar.gz: 8f1ef7fa13008c88133aac5babbf8622070db55ac3ea49eb45ef515c23e1751b
+  metadata.gz: d6ad212dc01831b9bae31adab98ba2edbe1fd803923e32eb9817e2b96515c706
+  data.tar.gz: c6ef8deb150ffeed569d4da108ac745a907c8bfc065c5564cd49b6aff978f00e
 SHA512:
-  metadata.gz: df62c535a49f323772ee6b7fe995ada5a1906c1ac3d80916949a30c7030c058eea47105368edc97351c1853bdf11cf6f561452e21d71d2d79f32246964acf3b5
-  data.tar.gz: b03abb09f142d3d5b27706b9792be412ea8c5698b4c7c385a343f15cd147cf9b71202c32b24b7dbbd892a9ac054be6918b9562498f7f8a347d30d054d54ddc19
+  metadata.gz: 87f73d56ceb956a78337d4df685ac8fb86b6eda03046ba137f92f689eb10b5485103f9ea003ccdb7643149b4e74722d674571ec698e8eed40eb0a2d3b1b2feb2
+  data.tar.gz: 7695c3ce514f9e150d492766b90e7b76e04cb5c496e422aa265d6f255a311e72d986319f169fc0bb5919a42fbe4cb364da700bfeb42fb947bfdb9a6841c5c280

data/README.md

@@ -40,6 +40,7 @@ class ApplicationController < ActionController::Base
   include JWTKeeper::Controller
 
   before_action :require_authentication
+  rescue_from JWTKeeper::NotAuthenticatedError, with: :not_authenticated
 
   def not_authenticated
     # Overload to return status 401

data/jwt_keeper.gemspec

@@ -28,8 +28,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.8'
   spec.add_development_dependency 'fuubar'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'redis-client'
+  spec.add_development_dependency 'redis'
 
-  spec.add_dependency 'redis'
   spec.add_dependency 'rails'
   spec.add_dependency 'activesupport'
   spec.add_dependency 'jwt', '>= 1.5'

data/lib/generators/templates/jwt_keeper.rb

@@ -27,10 +27,8 @@ JWTKeeper.configure do |config|
   # config.audience         = 'example.com'
 
   # the location of redis config file
-  # config.redis_connection = Redis.new(connection_options)
-  # config.redis_connection = ConnectionPool.new(size: ENV.fetch('RAILS_MAX_THREADS', 5)) do
-  #   Redis.new(url: ENV['REDISCLOUD_URL'] || 'redis://localhost:6379/')
-  # end
+  # config.redis_connection = RedisClient.new(connection_options)
+  # config.redis_connection = RedisClient.config(connection_options).new_pool(size: ENV.fetch('RAILS_MAX_THREADS', 5))
 
   # A unique idenfitier for the token version.
   # config.version          = 1

data/lib/jwt_keeper/controller.rb

@@ -10,7 +10,7 @@ module JWTKeeper
 
       if token.nil?
         clear_authentication_token
-        return not_authenticated
+        raise JWTKeeper::NotAuthenticatedError
       end
 
       if token.version_mismatch? || token.pending?
@@ -51,13 +51,6 @@ module JWTKeeper
       @authentication_token = nil
     end
 
-    # The default action for denying non-authenticated connections.
-    # You can override this method in your controllers
-    # @return [void]
-    def not_authenticated
-      redirect_to root_path
-    end
-
     # The default action for accepting authenticated connections.
     # You can override this method in your controllers
     # @return [void]

data/lib/jwt_keeper/datastore.rb

@@ -27,27 +27,40 @@ module JWTKeeper
 
       # @!visibility private
       def set_with_expiry(jti, seconds, type)
-        redis = JWTKeeper.configuration.redis_connection
-
-        if redis.is_a?(Redis)
-          redis.setex(jti, seconds, type)
-        elsif defined?(ConnectionPool) && redis.is_a?(ConnectionPool)
-          redis.with { |conn| conn.setex(jti, seconds, type) }
-        else
-          throw 'Bad Redis Connection'
+        with_redis do |redis|
+          if redis.respond_to?(:call) # For RedisClient
+            redis.call('SETEX', jti, seconds, type)
+          elsif redis.respond_to?(:setex) # For Redis
+            redis.setex(jti, seconds, type)
+          else
+            throw 'Bad Redis Connection'
+          end
         end
       end
 
       # @!visibility private
       def get(jti)
+        with_redis do |redis|
+          if redis.respond_to?(:call) # For RedisClient
+            redis.call('GET', jti)
+          elsif redis.respond_to?(:get) # For Redis
+            redis.get(jti)
+          else
+            throw 'Bad Redis Connection'
+          end
+        end
+      end
+
+      # @!visibility private
+      def with_redis
         redis = JWTKeeper.configuration.redis_connection
 
-        if redis.is_a?(Redis)
-          redis.get(jti)
-        elsif defined?(ConnectionPool) && redis.is_a?(ConnectionPool)
-          redis.with { |conn| conn.get(jti) }
+        if redis.respond_to?(:with)
+          redis.with do |conn|
+            yield conn
+          end
         else
-          throw 'Bad Redis Connection'
+          yield(redis)
         end
       end
     end

data/lib/jwt_keeper/exceptions.rb

@@ -1,4 +1,7 @@
 module JWTKeeper
+  # the session is invalid
+  class NotAuthenticatedError < StandardError; end
+
   # The token is invalid
   class InvalidTokenError < StandardError; end
 

data/lib/jwt_keeper/version.rb

@@ -1,4 +1,4 @@
 # Gem Version
 module JWTKeeper
-  VERSION = '5.0.1'.freeze
+  VERSION = '6.1.0'.freeze
 end

data/spec/lib/jwt_keeper/controller_spec.rb

@@ -52,7 +52,6 @@ RSpec.describe JWTKeeper do
       it { is_expected.to respond_to(:read_authentication_token) }
       it { is_expected.to respond_to(:write_authentication_token) }
       it { is_expected.to respond_to(:clear_authentication_token) }
-      it { is_expected.to respond_to(:not_authenticated) }
       it { is_expected.to respond_to(:authenticated) }
       it { is_expected.to respond_to(:regenerate_claims) }
     end
@@ -77,13 +76,9 @@ RSpec.describe JWTKeeper do
 
       context 'with expired token' do
         let(:token) { JWTKeeper::Token.create(exp: 3.hours.ago) }
-        before do
-          allow(test_controller).to receive(:not_authenticated)
-        end
 
-        it 'calls not_authenticated' do
-          subject.require_authentication
-          expect(subject).to have_received(:not_authenticated).once
+        it 'raises NotAuthenticated' do
+          expect { subject.require_authentication }.to raise_error(JWTKeeper::NotAuthenticatedError)
         end
       end
 
@@ -162,16 +157,5 @@ RSpec.describe JWTKeeper do
         expect(subject.response.headers['Authorization']).to be_nil
       end
     end
-
-    describe '#not_authenticated' do
-      before do
-        allow(test_controller).to receive(:redirect_to)
-      end
-
-      it 'it calls redirect_to' do
-        subject.not_authenticated
-        expect(subject).to have_received(:redirect_to).with('/')
-      end
-    end
   end
 end

data/spec/lib/jwt_keeper/datastore_spec.rb

@@ -1,70 +1,107 @@
 RSpec.describe JWTKeeper::Datastore do
-  include_context 'initialize config'
   let(:jti) { SecureRandom.uuid }
 
-  describe '.rotate' do
-    before { described_class.rotate(jti, 30) }
+  shared_examples 'Datastore Specs' do
+    describe '.rotate' do
+      before { described_class.rotate(jti, 30) }
 
-    it 'stores a token_id with a soft expiry' do
-      expect(described_class.send(:get, jti)).to eq 'soft'
+      it 'stores a token_id with a soft expiry' do
+        expect(described_class.send(:get, jti)).to eq 'soft'
+      end
     end
-  end
 
-  describe '.pending?' do
-    context 'with a missing token' do
-      it 'returns false' do
-        expect(described_class.pending?(jti)).to be false
+    describe '.pending?' do
+      context 'with a missing token' do
+        it 'returns false' do
+          expect(described_class.pending?(jti)).to be false
+        end
       end
-    end
 
-    context 'with a revoked token' do
-      before { described_class.revoke(jti, 30) }
+      context 'with a revoked token' do
+        before { described_class.revoke(jti, 30) }
 
-      it 'returns false' do
-        expect(described_class.pending?(jti)).to be false
+        it 'returns false' do
+          expect(described_class.pending?(jti)).to be false
+        end
       end
-    end
 
-    context 'with a pending token' do
-      before { described_class.rotate(jti, 30) }
+      context 'with a pending token' do
+        before { described_class.rotate(jti, 30) }
 
-      it 'returns true' do
-        expect(described_class.pending?(jti)).to be true
+        it 'returns true' do
+          expect(described_class.pending?(jti)).to be true
+        end
       end
     end
-  end
 
-  describe '.revoke' do
-    before do
-      described_class.revoke(jti, 30)
-    end
+    describe '.revoke' do
+      before do
+        described_class.revoke(jti, 30)
+      end
 
-    it 'stores a token_id with a hard expiry' do
-      expect(described_class.send(:get, jti)).to eq 'hard'
+      it 'stores a token_id with a hard expiry' do
+        expect(described_class.send(:get, jti)).to eq 'hard'
+      end
     end
-  end
 
-  describe '.revoked?' do
-    context 'with a missing token' do
-      it 'returns false' do
-        expect(described_class.revoked?(jti)).to be false
+    describe '.revoked?' do
+      context 'with a missing token' do
+        it 'returns false' do
+          expect(described_class.revoked?(jti)).to be false
+        end
+      end
+
+      context 'with a revoked token' do
+        before { described_class.revoke(jti, 30) }
+
+        it 'returns true' do
+          expect(described_class.revoked?(jti)).to be true
+        end
       end
-    end
 
-    context 'with a revoked token' do
-      before { described_class.revoke(jti, 30) }
+      context 'with a pending token' do
+        before { described_class.rotate(jti, 30) }
 
-      it 'returns true' do
-        expect(described_class.revoked?(jti)).to be true
+        it 'returns false' do
+          expect(described_class.revoked?(jti)).to be false
+        end
       end
     end
+  end
 
-    context 'with a pending token' do
-      before { described_class.rotate(jti, 30) }
+  context 'with Redis' do
+    include_context 'initialize config'
+
+    let(:redis_connection) { Redis.new(url: ENV['REDIS_URL']) }
+
+    include_examples 'Datastore Specs'
+  end
+
+  context 'with Redis Connection Pool' do
+    include_context 'initialize config'
 
-      it 'returns false' do
-        expect(described_class.revoked?(jti)).to be false
+    let(:redis_connection) do
+      ConnectionPool.new(size: ENV.fetch('RAILS_MAX_THREADS', 5)) do
+        Redis.new(url: ENV['REDISCLOUD_URL'] || 'redis://localhost:6379/')
       end
     end
+
+    include_examples 'Datastore Specs'
+  end
+
+  context 'with RedisClient' do
+    include_context 'initialize config'
+
+    let(:redis_connection) { RedisClient.new(url: ENV['REDIS_URL']) }
+
+    include_examples 'Datastore Specs'
+  end
+
+  context 'with RedisClient Pool' do
+    include_context 'initialize config'
+
+    let(:redis_connection) { RedisClient.config(url: ENV['REDIS_URL']).new_pool(size: ENV.fetch('RAILS_MAX_THREADS', 5)) }
+
+    include_examples 'Datastore Specs'
   end
 end

data/spec/spec_helper.rb

@@ -39,6 +39,7 @@ RSpec.configure do |config|
 end
 
 RSpec.shared_context 'initialize config' do
+  let(:redis_connection) { RedisClient.new(url: ENV['REDIS_URL']) }
   let(:config) do
     {
       algorithm:        'HS256',
@@ -46,12 +47,13 @@ RSpec.shared_context 'initialize config' do
       expiry:           24.hours,
       issuer:           'api.example.com',
       audience:         'example.com',
-      redis_connection: Redis.new(url: ENV['REDIS_URL']),
+      redis_connection: redis_connection,
       version:          nil,
       cookie_lock:      false
     }
   end
 
+
   before(:each) do
     JWTKeeper.configure(JWTKeeper::Configuration.new(config))
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jwt_keeper
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 6.1.0
 platform: ruby
 authors:
 - David Rivera
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2023-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,6 +137,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -144,7 +158,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -249,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: JWT for Rails made easy