grape-jwt-authentication 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d39f954c1709be8bcf40890427ce3c5903cbf1a3e354efe46ade4ef2d9e8d086
-  data.tar.gz: ccbf4143b8fc1258bb3235e1b910aa8b3bca2c0d118b00ef03251447d447cce7
+  metadata.gz: 2dc344933b04d2166715f0580af0d4e6904bfc36430e85d8258776d0eae5ba4b
+  data.tar.gz: 6969bbc278b237497418be8b35362a5be11c0b0013647760bd44da33cfdf8d0e
 SHA512:
-  metadata.gz: 89c29d5a661bc6d865d19193ae60c8310072281cc92b4e2501038d6a7038e9b7a1c20baa0b38c0e414c855a1800f49f1a986df9571e1e179387c5ccb3e3283fb
-  data.tar.gz: 1f7bd448ee6e7cd6323c1e24b05ab2ac928359bc906b81d3d6e4d3ab58847c833790d81d4e785efae7d4fe89941d26fafd632627fadf7966cef11d19f7fed0a4
+  metadata.gz: 815ed44f92461b67e059b35b746549fd0139acd3641b13b691561848ce8d80833b672bcced0699cde2bdcd429732e6974cf2619fe2f9ae1c6e6509bba3fc14df
+  data.tar.gz: bb06cd6e6640293be1930caaae50cbd762bd989dc2d8974acc7656241d7af256bd877557991e242d83590675fb04a66179d22ec59d5e255ac7ef4218087743c2

data/.github/workflows/release.yml

@@ -16,7 +16,7 @@ jobs:
   docs:
     name: Release the gem
     runs-on: ubuntu-22.04
-    timeout-minutes: 5
+    timeout-minutes: 10
     steps:
       - uses: actions/checkout@v4
 

data/.github/workflows/test.yml

@@ -11,7 +11,7 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  test:
+  test-rails:
     name: 'Test the gem (Ruby ${{ matrix.ruby }}, Rails ${{ matrix.rails }})'
     runs-on: ubuntu-22.04
     timeout-minutes: 5
@@ -19,7 +19,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby: ['3.2', '3.3', '3.4']
-        rails: ['7.1', '7.2', '8.0']
+        rails: ['7.1', '7.2', '8.0', '8.1']
     env:
       BUNDLE_GEMFILE: 'gemfiles/rails_${{ matrix.rails }}.gemfile'
     steps:
@@ -45,3 +45,38 @@ jobs:
 
       - name: Upload the code coverage report
         run: coverage
+
+  test-grape:
+    name: 'Test the gem (Ruby ${{ matrix.ruby }}, Grape ${{ matrix.grape }})'
+    runs-on: ubuntu-22.04
+    timeout-minutes: 5
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.2', '3.3', '3.4']
+        grape: ['1', '2', '3']
+    env:
+      BUNDLE_GEMFILE: 'gemfiles/grape_${{ matrix.grape }}.gemfile'
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install the correct Ruby version
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          rubygems: '3.6.9'
+
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings_secret_key: '${{ secrets.SETTINGS_SECRET_KEY }}'
+          settings: '${{ github.repository }}'
+          target: ci/gem-test
+
+      - name: Run the gem tests
+        run: make test
+
+      - name: Upload the code coverage report
+        run: coverage

data/.rubocop.yml

@@ -13,7 +13,7 @@ AllCops:
   SuggestExtensions: false
   DisplayCopNames: true
   TargetRubyVersion: 3.2
-  TargetRailsVersion: 6.1
+  TargetRailsVersion: 7.1
   Exclude:
     - bin/**/*
     - vendor/**/*

data/Appraisals

@@ -17,3 +17,21 @@ appraise 'rails-8.0' do
   gem 'activerecord', '~> 8.0.0'
   gem 'activesupport', '~> 8.0.0'
 end
+
+appraise 'rails-8.1' do
+  gem 'activejob', '~> 8.1.0'
+  gem 'activerecord', '~> 8.1.0'
+  gem 'activesupport', '~> 8.1.0'
+end
+
+appraise 'grape-1' do
+  gem 'grape', '~> 1.8.0'
+end
+
+appraise 'grape-2' do
+  gem 'grape', '~> 2.4.0'
+end
+
+appraise 'grape-3' do
+  gem 'grape', '~> 3.0.0'
+end

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 * TODO: Replace this bullet point with an actual description of a change.
 
+### 3.2.0 (2 December 2025)
+
+* Added appraisals for Grape 1, 2 and 3 and loosed up the version requirement
+  to `>= 1, < 4.0` ([#28](https://github.com/hausgold/grape-jwt-authentication/pull/28))
+* Loosed up the version requirement for the `jwt` gem to `>= 2.6`, so people
+  can [migrate to
+  3.0+](https://github.com/jwt/ruby-jwt/blob/v3.1.2/UPGRADING.md) ([#28](https://github.com/hausgold/grape-jwt-authentication/pull/28))
+
+### 3.1.0 (23 October 2025)
+
+* Dropped Reek ([#24](https://github.com/hausgold/grape-jwt-authentication/pull/24))
+* Added support for Rails 8.1 ([#25](https://github.com/hausgold/grape-jwt-authentication/pull/25))
+* Switched from `ActiveSupport::Configurable` to a custom implementation based
+  on `ActiveSupport::OrderedOptions` ([#26](https://github.com/hausgold/grape-jwt-authentication/pull/26))
+
 ### 3.0.0 (28 June 2025)
 
 * Corrected some RuboCop glitches ([#21](https://github.com/hausgold/grape-jwt-authentication/pull/21))

data/Gemfile

@@ -10,7 +10,7 @@ gemspec
 # Development dependencies
 gem 'appraisal', '~> 2.4'
 gem 'bundler', '~> 2.6'
-gem 'countless', '~> 2.0'
+gem 'countless', '~> 2.2'
 gem 'guard-rspec', '~> 4.7'
 gem 'rack', '~> 2.2'
 gem 'rack-test', '~> 2.0'

data/gemfiles/grape_1.gemfile

@@ -0,0 +1,25 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.4"
+gem "bundler", "~> 2.6"
+gem "countless", "~> 2.2"
+gem "guard-rspec", "~> 4.7"
+gem "rack", "~> 2.2"
+gem "rack-test", "~> 2.0"
+gem "railties", ">= 7.1"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.12"
+gem "rubocop"
+gem "rubocop-rails"
+gem "rubocop-rspec"
+gem "simplecov", ">= 0.22"
+gem "timecop", ">= 0.9.6"
+gem "vcr", "~> 6.0"
+gem "webmock", "~> 3.18"
+gem "yard", ">= 0.9.28"
+gem "yard-activesupport-concern", ">= 0.0.1"
+gem "grape", "~> 1.8.0"
+
+gemspec path: "../"

data/gemfiles/grape_2.gemfile

@@ -0,0 +1,25 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.4"
+gem "bundler", "~> 2.6"
+gem "countless", "~> 2.2"
+gem "guard-rspec", "~> 4.7"
+gem "rack", "~> 2.2"
+gem "rack-test", "~> 2.0"
+gem "railties", ">= 7.1"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.12"
+gem "rubocop"
+gem "rubocop-rails"
+gem "rubocop-rspec"
+gem "simplecov", ">= 0.22"
+gem "timecop", ">= 0.9.6"
+gem "vcr", "~> 6.0"
+gem "webmock", "~> 3.18"
+gem "yard", ">= 0.9.28"
+gem "yard-activesupport-concern", ">= 0.0.1"
+gem "grape", "~> 2.4.0"
+
+gemspec path: "../"

data/gemfiles/grape_3.gemfile

@@ -0,0 +1,25 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.4"
+gem "bundler", "~> 2.6"
+gem "countless", "~> 2.2"
+gem "guard-rspec", "~> 4.7"
+gem "rack", "~> 2.2"
+gem "rack-test", "~> 2.0"
+gem "railties", ">= 7.1"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.12"
+gem "rubocop"
+gem "rubocop-rails"
+gem "rubocop-rspec"
+gem "simplecov", ">= 0.22"
+gem "timecop", ">= 0.9.6"
+gem "vcr", "~> 6.0"
+gem "webmock", "~> 3.18"
+gem "yard", ">= 0.9.28"
+gem "yard-activesupport-concern", ">= 0.0.1"
+gem "grape", "~> 3.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.1.gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 
 gem "appraisal", "~> 2.4"
 gem "bundler", "~> 2.6"
-gem "countless", "~> 2.0"
+gem "countless", "~> 2.2"
 gem "guard-rspec", "~> 4.7"
 gem "rack", "~> 2.2"
 gem "rack-test", "~> 2.0"

data/gemfiles/rails_7.2.gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 
 gem "appraisal", "~> 2.4"
 gem "bundler", "~> 2.6"
-gem "countless", "~> 2.0"
+gem "countless", "~> 2.2"
 gem "guard-rspec", "~> 4.7"
 gem "rack", "~> 2.2"
 gem "rack-test", "~> 2.0"

data/gemfiles/rails_8.0.gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 
 gem "appraisal", "~> 2.4"
 gem "bundler", "~> 2.6"
-gem "countless", "~> 2.0"
+gem "countless", "~> 2.2"
 gem "guard-rspec", "~> 4.7"
 gem "rack", "~> 2.2"
 gem "rack-test", "~> 2.0"

data/gemfiles/rails_8.1.gemfile

@@ -0,0 +1,27 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.4"
+gem "bundler", "~> 2.6"
+gem "countless", "~> 2.2"
+gem "guard-rspec", "~> 4.7"
+gem "rack", "~> 2.2"
+gem "rack-test", "~> 2.0"
+gem "railties", ">= 7.1"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.12"
+gem "rubocop"
+gem "rubocop-rails"
+gem "rubocop-rspec"
+gem "simplecov", ">= 0.22"
+gem "timecop", ">= 0.9.6"
+gem "vcr", "~> 6.0"
+gem "webmock", "~> 3.18"
+gem "yard", ">= 0.9.28"
+gem "yard-activesupport-concern", ">= 0.0.1"
+gem "activejob", "~> 8.1.0"
+gem "activerecord", "~> 8.1.0"
+gem "activesupport", "~> 8.1.0"
+
+gemspec path: "../"

data/grape-jwt-authentication.gemspec

@@ -34,11 +34,11 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 3.2'
 
   spec.add_dependency 'activesupport', '>= 7.1'
-  spec.add_dependency 'grape', '>= 1.0', '< 3.0'
+  spec.add_dependency 'grape', '>= 1.0', '< 4.0'
   spec.add_dependency 'httparty', '>= 0.21'
-  spec.add_dependency 'jwt', '~> 2.6'
-  spec.add_dependency 'keyless', '~> 2.0'
-  spec.add_dependency 'mutex_m', '~> 0.3.0'
+  spec.add_dependency 'jwt', '>= 2.6'
+  spec.add_dependency 'keyless', '~> 2.1'
+  spec.add_dependency 'mutex_m', '>= 0.3'
   spec.add_dependency 'recursive-open-struct', '~> 2.0'
   spec.add_dependency 'zeitwerk', '~> 2.6'
 end

data/lib/grape/jwt/authentication/configuration.rb

@@ -4,8 +4,46 @@ module Grape
   module Jwt
     module Authentication
       # The configuration for the Grape JWT authentication concern.
-      class Configuration
-        include ActiveSupport::Configurable
+      class Configuration < ActiveSupport::OrderedOptions
+        # Track our configurations settings (+Symbol+ keys) and their defaults
+        # as lazy-loaded +Proc+'s values
+        class_attribute :defaults,
+                        instance_reader: true,
+                        instance_writer: false,
+                        instance_predicate: false,
+                        default: {}
+
+        # Create a new +Configuration+ instance with all settings populated
+        # with their respective defaults.
+        #
+        # @param args [Hash{Symbol => Mixed}] additional settings which
+        #   overwrite the defaults
+        # @return [Configuration] the new configuration instance
+        def initialize(**args)
+          super()
+          defaults.each { |key, default| self[key] = instance_exec(&default) }
+          merge!(**args)
+        end
+
+        # A simple DSL method to define new configuration accessors/settings
+        # with their defaults. The defaults can be retrieved with
+        # +Configuration.defaults+ or +Configuration.new.defaults+.
+        #
+        # @param name [Symbol, String] the name of the configuration
+        #   accessor/setting
+        # @param default [Mixed, nil] a non-lazy-loaded static value, serving
+        #   as a default value for the setting
+        # @param block [Proc] when given, the default value will be lazy-loaded
+        #   (result of the Proc)
+        def self.config_accessor(name, default = nil, &block)
+          # Save the given configuration accessor default value
+          defaults[name.to_sym] = block || -> { default }
+
+          # Compile reader/writer methods so we don't have to go through
+          # +ActiveSupport::OrderedOptions#method_missing+.
+          define_method(name) { self[name] }
+          define_method("#{name}=") { |value| self[name] = value }
+        end
 
         # The authenticator function which must be defined by the user to
         # verify the given JSON Web Token. Here comes all your logic to lookup

data/lib/grape/jwt/authentication/jwt_handler.rb

@@ -102,8 +102,6 @@ module Grape
         # interface.
         #
         # @param env [Hash{String => Mixed}] the Rack environment
-        # because thats the auth handling core
-        # :reek:TooManyStatements because reek counts exception
         def call(env)
           # Unfortunately Grape's middleware stack orders the error
           # handling higher than the formatter. So when a error is

data/lib/grape/jwt/authentication/version.rb

@@ -5,7 +5,7 @@ module Grape
     # The gem version details.
     module Authentication
       # The version of the +grape-jwt-authentication+ gem
-      VERSION = '3.0.0'
+      VERSION = '3.2.0'
 
       class << self
         # Returns the version of gem as a string.

data/lib/grape/jwt/authentication.rb

@@ -4,8 +4,9 @@ require 'zeitwerk'
 require 'logger'
 require 'active_support'
 require 'active_support/concern'
-require 'active_support/configurable'
 require 'active_support/cache'
+require 'active_support/ordered_options'
+require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/hash'
 require 'active_support/time'
 require 'active_support/time_with_zone'
@@ -18,7 +19,6 @@ module Grape
     # The Grape JWT authentication concern.
     module Authentication
       extend ActiveSupport::Concern
-      include Grape::DSL::API
 
       # Setup a Zeitwerk autoloader instance and configure it
       loader = Zeitwerk::Loader.for_gem_extension(Grape::Jwt)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-jwt-authentication
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Hermann Mayer
@@ -32,7 +32,7 @@ dependencies:
         version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
         version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -61,14 +61,14 @@ dependencies:
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.6'
 - !ruby/object:Gem::Dependency
@@ -77,28 +77,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: mutex_m
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: recursive-open-struct
   requirement: !ruby/object:Gem::Requirement
@@ -160,10 +160,14 @@ files:
 - config/docker/.inputrc
 - doc/assets/project.svg
 - docker-compose.yml
+- gemfiles/grape_1.gemfile
+- gemfiles/grape_2.gemfile
+- gemfiles/grape_3.gemfile
 - gemfiles/rails_6.1.gemfile
 - gemfiles/rails_7.1.gemfile
 - gemfiles/rails_7.2.gemfile
 - gemfiles/rails_8.0.gemfile
+- gemfiles/rails_8.1.gemfile
 - grape-jwt-authentication.gemspec
 - lib/grape/jwt/authentication.rb
 - lib/grape/jwt/authentication/configuration.rb