grape-jwt-authentication 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e3f66e76b4c2b311f69dd18a6a5ad9288ec5ece3fc34a3cc7d11a685adf991c
-  data.tar.gz: da5277432b5e8eedad129c1fbf1236b1eca71bb01d32b9c2748dc5525e7e83d4
+  metadata.gz: a76b78814c21de200efd81a5b97a2032909f0dc67cb702562a814abb250986ab
+  data.tar.gz: dc5c5536b5d5d445ae8391d7787e41858c178e200fc6cdf41fe8cb1349b7fa77
 SHA512:
-  metadata.gz: 002fcd02712c1b23edc746d7b396cf53fe1cc1586b91bf8c1b4d72eaa44daaf4ff1a6e39064f211543f46bdf0bf473baaacaf66134d2f17e75ada1f3f58f6a10
-  data.tar.gz: 9c9ca3eab5b1e6031bf0eca71655931c1ee742010cb02cb324e2be91f20e4cbb967be8153205d86b44e48288ad2f614a4b50c1a43b915054df9e46e5f47ea509
+  metadata.gz: 4cb2b1ff597b9bfee4947d57a5c1ad0f0b1123b298a5675d78d761786ea2eb33cdb4b199d23e72e1fa41b72dc708b2d6149d3150bc5e10d9544313943e34203e
+  data.tar.gz: 4fc142b1b6519a2a4fa0f1ba5895fd929bfca37ff26a1ad3de2096b23241f1d846710a0f3abfdb3f0a6e020300c6728f9db3686f0d0887f20e5c2ae3f480e973

data/.github/workflows/documentation.yml

@@ -0,0 +1,39 @@
+name: Build Documentation
+on:
+  repository_dispatch:
+    types: [documentation]
+
+concurrency:
+  group: 'docs'
+
+jobs:
+  docs:
+    name: Build gem documentation
+    runs-on: ubuntu-22.04
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install the correct Ruby version
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+          bundler-cache: true
+          rubygems: '3.3.26'
+
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/gem-test
+
+      - name: Build gem documentation
+        run: make docs
+
+      - name: Upload the code coverage report
+        run: coverage
+
+      - name: Add this job to the commit status
+        run: commit-status '${{ job.status }}'
+        if: always()

data/.github/workflows/test.yml

@@ -0,0 +1,63 @@
+name: Test
+on:
+  push:
+    branches:
+      - '**'
+  schedule:
+    - cron: '0 0 * * MON'
+
+concurrency:
+  group: '${{ github.ref }}'
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: 'Test the gem (Ruby ${{ matrix.ruby }}, Rails ${{ matrix.rails }})'
+    runs-on: ubuntu-22.04
+    timeout-minutes: 5
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.5', '2.7']
+        rails: ['5.2']
+    env:
+      BUNDLE_GEMFILE: 'gemfiles/rails_${{ matrix.rails }}.gemfile'
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install the correct Ruby version
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          rubygems: '3.3.26'
+
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/gem-test
+
+      - name: Run the gem tests
+        run: make test
+
+      - name: Upload the code coverage report
+        run: coverage
+
+  trigger-docs:
+    name: Trigger the documentation upload
+    runs-on: ubuntu-22.04
+    timeout-minutes: 2
+    needs: test
+    if: github.ref == 'refs/heads/master'
+    steps:
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/noop
+
+      - name: Trigger the documentation upload
+        run: workflow documentation

data/.gitignore

@@ -6,7 +6,10 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/
+/gemfiles/vendor/
 /Gemfile.lock
+*.gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/.rspec

@@ -1,3 +1,3 @@
+--backtrace
+--force-color
 --format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,30 +1,40 @@
-require: rubocop-rspec
+require:
+  - rubocop-rspec
+  - rubocop-rails
 
 Rails:
   Enabled: true
 
-Documentation:
+Style/Documentation:
   Enabled: true
 
 AllCops:
+  NewCops: enable
+  SuggestExtensions: false
   DisplayCopNames: true
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
+  TargetRailsVersion: 5.2
   Exclude:
-    - db/schema.rb
     - bin/**/*
-    - db/migrate/**/*
-    - vendor/cache/**/*
-    - vendor/bundle/**/*
+    - vendor/**/*
     - build/**/*
+    - gemfiles/**/*
 
 Metrics/BlockLength:
   Exclude:
-    # Because of the Grape DSL
-    - lib/**/*.rb
     - Rakefile
-    - grape-jwt-authentication.gemspec
+    - '*.gemspec'
     - spec/**/*.rb
     - '**/*.rake'
+    - doc/**/*.rb
+
+# MFA is not yet enabled for our gems yet.
+Gemspec/RequireMFA:
+  Enabled: false
+
+# We stay with the original Ruby Style Guide recommendation.
+Layout/LineLength:
+  Max: 80
 
 # Document all the things.
 Style/DocumentationMethod:
@@ -41,3 +51,20 @@ Lint/AmbiguousBlockAssociation:
 # supported with the +with(hash_including)+ matchers
 RSpec/MessageSpies:
   EnforcedStyle: receive
+
+# Because nesting makes sense here to group the feature tests
+# more effective. This increases maintainability.
+RSpec/NestedGroups:
+  Max: 4
+
+# Disable regular Rails spec paths.
+RSpec/FilePath:
+  Enabled: false
+
+# Because we just implemented the ActiveRecord API.
+Rails/SkipsModelValidations:
+  Enabled: false
+
+# We highly depend on memoized helpers across the specs.
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false

data/.simplecov

@@ -1,3 +1,15 @@
+# frozen_string_literal: true
+
+require 'simplecov-html'
+require 'simplecov_json_formatter'
+
+SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new(
+  [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::JSONFormatter
+  ]
+)
+
 SimpleCov.start 'test_frameworks' do
   add_filter '/vendor/bundle/'
 end

data/.yardopts

@@ -0,0 +1,6 @@
+--output-dir=doc/api
+--plugin activesupport-concern
+--markup=rdoc
+-
+README.md
+lib/**/*.rb

data/Appraisals

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+appraise 'rails-5.2' do
+  gem 'activejob', '~> 5.2.0'
+  gem 'activerecord', '~> 5.2.0'
+  gem 'activesupport', '~> 5.2.0'
+end

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+### 2.1.0
+
+* Bundler >= 2.3 is from now on required as minimal version (#9)
+* Dropped support for Ruby < 2.5 (#9)
+* Dropped support for Rails < 5.2 (#9)
+* Updated all development/runtime gems to their latest
+  Ruby 2.5 compatible version (#9)
+
+### 2.0.4
+
+* Migrated to Github Actions
+* Migrated to our own coverage reporting
+* Added the code statistics to the test process
+
 ### 2.0.3
 
 * Pinned rspec-expectations to <= 3.9.2

data/Dockerfile

@@ -0,0 +1,28 @@
+FROM hausgold/ruby:2.5
+MAINTAINER Hermann Mayer <hermann.mayer@hausgold.de>
+
+# Update system gem
+RUN gem update --system '3.3.26'
+
+# Install system packages and the latest bundler
+RUN apt-get update -yqqq && \
+  apt-get install -y \
+    build-essential locales sudo vim \
+    ca-certificates \
+    bash-completion inotify-tools && \
+  echo 'en_US.UTF-8 UTF-8' >> /etc/locale.gen && /usr/sbin/locale-gen && \
+  gem install bundler -v '~> 2.3.0' --no-document --no-prerelease
+
+# Add new web user
+RUN mkdir /app && \
+  adduser web --home /home/web --shell /bin/bash \
+    --disabled-password --gecos ""
+COPY config/docker/* /home/web/
+RUN chown web:web -R /app /home/web /usr/local/bundle && \
+  mkdir -p /home/web/.ssh
+
+# Set the root password and grant root access to web
+RUN echo 'root:root' | chpasswd
+RUN echo 'web ALL=(ALL) NOPASSWD: ALL' >> /etc/sudoers
+
+WORKDIR /app

data/Envfile

@@ -0,0 +1,3 @@
+LANG=en_US.UTF-8
+LANGUAGE=en_US.UTF-8
+LC_ALL=en_US.UTF-8

data/Guardfile

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+(directories %w[lib spec]).select do |d|
+  if Dir.exist?(d)
+    d
+  else
+    UI.warning("Directory #{d} does not exist")
+  end
+end
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# NOTE: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch('spec/spec_helper.rb') { 'spec' }
+  watch(%r{^lib/grape/jwt/authentication.rb}) { 'spec' }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/grape/jwt/authentication/([^\\]+)\.rb$}) do |m|
+    "spec/grape/jwt/authentication/#{m[1]}_spec.rb"
+  end
+  watch(%r{^lib/grape/jwt/authentication/([^\\]+)/(.*)\.rb$}) do |m|
+    "spec/grape/jwt/authentication/#{m[1]}/#{m[2]}_spec.rb"
+  end
+end

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 HAUSGOLD | talocasa GmbH
+Copyright (c) 2023 HAUSGOLD | talocasa GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Makefile

@@ -0,0 +1,158 @@
+MAKEFLAGS += --warn-undefined-variables -j1
+SHELL := bash
+.SHELLFLAGS := -eu -o pipefail -c
+.DEFAULT_GOAL := all
+.DELETE_ON_ERROR:
+.SUFFIXES:
+.PHONY:
+
+# Environment switches
+MAKE_ENV ?= docker
+COMPOSE_RUN_SHELL_FLAGS ?= --rm
+BASH_RUN_SHELL_FLAGS ?=
+
+# Directories
+VENDOR_DIR ?= vendor/bundle
+
+# Host binaries
+AWK ?= awk
+BASH ?= bash
+COMPOSE ?= docker-compose
+DOCKER ?= docker
+GREP ?= grep
+ID ?= id
+MKDIR ?= mkdir
+RM ?= rm
+XARGS ?= xargs
+
+# Container binaries
+APPRAISAL ?= appraisal
+BUNDLE ?= bundle
+GEM ?= gem
+GUARD ?= guard
+RAKE ?= rake
+RSPEC ?= rspec
+RUBOCOP ?= rubocop
+YARD ?= yard
+
+# Define a generic shell run wrapper
+# $1 - The command to run
+ifeq ($(MAKE_ENV),docker)
+define run-shell
+	$(COMPOSE) run $(COMPOSE_RUN_SHELL_FLAGS) \
+		-e LANG=en_US.UTF-8 -e LANGUAGE=en_US.UTF-8 -e LC_ALL=en_US.UTF-8 \
+		-e HOME=/home/web -e BUNDLE_APP_CONFIG=/app/.bundle \
+		-u `$(ID) -u` test \
+		bash $(BASH_RUN_SHELL_FLAGS) -c 'sleep 0.1; echo; $(1)'
+endef
+else ifeq ($(MAKE_ENV),baremetal)
+define run-shell
+	$(1)
+endef
+endif
+
+all:
+	# grape-jwt-authentication
+	#
+	# install            Install the dependencies
+	# update             Update the local Gemset dependencies
+	# clean              Clean the dependencies
+	#
+	# test               Run the whole test suite
+	# test-style         Test the code styles
+	# watch              Watch for code changes and rerun the test suite
+	#
+	# docs               Generate the Ruby documentation of the library
+	# stats              Print the code statistics (library and test suite)
+	# notes              Print all the notes from the code
+	# release            Release a new Gem version (maintainers only)
+	#
+	# shell              Run an interactive shell on the container
+	# shell-irb          Run an interactive IRB shell on the container
+
+.interactive:
+	@$(eval BASH_RUN_SHELL_FLAGS = --login)
+
+install:
+	# Install the dependencies
+	@$(MKDIR) -p $(VENDOR_DIR)
+	@$(call run-shell,$(BUNDLE) check || $(BUNDLE) install --path $(VENDOR_DIR))
+	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) install)
+
+update:
+	# Install the dependencies
+	@$(MKDIR) -p $(VENDOR_DIR)
+	@$(call run-shell,$(BUNDLE) update)
+	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) update)
+
+watch: install .interactive
+	# Watch for code changes and rerun the test suite
+	@$(call run-shell,$(BUNDLE) exec $(GUARD))
+
+test: \
+	test-specs \
+	test-style
+
+test-specs:
+	# Run the whole test suite
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats spec)
+
+$(TEST_GEMFILES): GEMFILE=$(@:test-%=%)
+$(TEST_GEMFILES):
+	# Run the whole test suite ($(GEMFILE))
+	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) $(GEMFILE) $(RSPEC))
+
+test-style: \
+	test-style-ruby
+
+test-style-ruby:
+	# Run the static code analyzer (rubocop)
+	@$(call run-shell,$(BUNDLE) exec $(RUBOCOP) -a)
+
+clean:
+	# Clean the dependencies
+	@$(RM) -rf $(VENDOR_DIR)
+	@$(RM) -rf $(VENDOR_DIR)/Gemfile.lock
+	@$(RM) -rf .bundle .yardoc coverage pkg Gemfile.lock doc/api \
+		.rspec_status
+
+clean-containers:
+	# Clean running containers
+ifeq ($(MAKE_ENV),docker)
+	@$(COMPOSE) down
+endif
+
+clean-images:
+	# Clean build images
+ifeq ($(MAKE_ENV),docker)
+	@-$(DOCKER) images | $(GREP) $(shell basename "`pwd`") \
+		| $(AWK) '{ print $$3 }' \
+		| $(XARGS) -rn1 $(DOCKER) rmi -f
+endif
+
+distclean: clean clean-containers clean-images
+
+shell:
+	# Run an interactive shell on the container
+	@$(call run-shell,$(BASH) -i)
+
+shell-irb:
+	# Run an interactive IRB shell on the container
+	@$(call run-shell,bin/console)
+
+docs:
+	# Build the API documentation
+	@$(call run-shell,$(BUNDLE) exec $(YARD) -q && \
+		$(BUNDLE) exec $(YARD) stats --list-undoc --compact)
+
+notes:
+	# Print the code statistics (library and test suite)
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) notes)
+
+stats:
+	# Print all the notes from the code
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats)
+
+release:
+	# Release a new gem version
+	@$(BUNDLE) exec $(RAKE) release

data/README.md

@@ -1,14 +1,14 @@
 ![grape-jwt-authentication](doc/assets/project.svg)
 
-[![Build Status](https://travis-ci.com/hausgold/grape-jwt-authentication.svg?branch=master)](https://travis-ci.com/hausgold/grape-jwt-authentication)
+[![Continuous Integration](https://github.com/hausgold/grape-jwt-authentication/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/hausgold/grape-jwt-authentication/actions/workflows/test.yml)
 [![Gem Version](https://badge.fury.io/rb/grape-jwt-authentication.svg)](https://badge.fury.io/rb/grape-jwt-authentication)
-[![Maintainability](https://api.codeclimate.com/v1/badges/ab14a3bab572edfbf305/maintainability)](https://codeclimate.com/repos/5cac8bc06c282f791c009a66/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/ab14a3bab572edfbf305/test_coverage)](https://codeclimate.com/repos/5cac8bc06c282f791c009a66/test_coverage)
-[![API docs](https://img.shields.io/badge/docs-API-blue.svg)](https://www.rubydoc.info/gems/grape-jwt-authentication)
+[![Test Coverage](https://automate-api.hausgold.de/v1/coverage_reports/grape-jwt-authentication/coverage.svg)](https://knowledge.hausgold.de/coverage)
+[![Test Ratio](https://automate-api.hausgold.de/v1/coverage_reports/grape-jwt-authentication/ratio.svg)](https://knowledge.hausgold.de/coverage)
+[![API docs](https://automate-api.hausgold.de/v1/coverage_reports/grape-jwt-authentication/documentation.svg)](https://www.rubydoc.info/gems/grape-jwt-authentication)
 
 This gem is dedicated to easily integrate a JWT authentication to your
 [Grape](https://github.com/ruby-grape/grape) API. The real authentication
-functionality must be provided by the user and this makes this gem highy
+functionality must be provided by the user and this makes this gem highly
 flexible on the JWT verification level.
 
 - [Installation](#installation)
@@ -154,7 +154,7 @@ end
 
 #### Failed authentication handling
 
-When the client sends a corrected formatted JSON Web Token with the Bearer
+When the client sends a correctly formatted JSON Web Token with the Bearer
 authentication scheme within the `Authorization` header and your authenticator
 fails for some reason (token claims, wrong audience, bad subject, expired
 token, wrong cryptographic signing etc), this function is called to handle the
@@ -175,8 +175,8 @@ end
 #### RSA public key helper
 
 We provide a straightforward solution to deal with the provision of RSA public
-keys.  Somethimes you want to distribute them by file to each machine and have
-a local access, and somethimes you provide an endpoint on your identity
+keys.  Sometimes you want to distribute them by file to each machine and have
+a local access, and sometimes you provide an endpoint on your identity
 provider to fetch the RSA public key via HTTP/HTTPS.  The `RsaPublicKey` class
 helps you to fulfill this task easily.
 

data/Rakefile

@@ -2,7 +2,18 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'countless/rake_tasks'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+# Configure all code statistics directories
+Countless.configure do |config|
+  config.stats_base_directories = [
+    { name: 'Top-levels',
+      pattern: 'lib/**/*.rb' },
+    { name: 'Top-levels specs', test: true,
+      pattern: 'spec/grape/**/*.rb' }
+  ]
+end

data/config/docker/.bash_profile

@@ -0,0 +1,3 @@
+if [ -f ~/.bashrc ]; then
+  . ~/.bashrc
+fi

data/config/docker/.bashrc

@@ -0,0 +1,48 @@
+# ~/.bashrc: executed by bash(1) for non-login shells.
+# see /usr/share/doc/bash/examples/startup-files (in the package bash-doc)
+# for examples
+
+_GEM_PATHS=$(ls -d1 ${HOME}/.gem/ruby/*/bin 2>/dev/null | paste -sd ':')
+_APP_PATHS=$(ls -d1 /app/vendor/bundle/ruby/*/bin 2>/dev/null | paste -sd ':')
+
+export PATH="${_GEM_PATHS}:${_APP_PATHS}:${PATH}"
+export PATH="/app/node_modules/.bin:${HOME}/.bin:/app/bin:${PATH}"
+export MAKE_ENV=baremetal
+
+# Disable the autostart of all supervisord units
+sudo sed -i 's/autostart=.*/autostart=false/g' /etc/supervisor/conf.d/*
+
+# Start the supervisord (empty, no units)
+sudo supervisord >/dev/null 2>&1 &
+
+# Wait for supervisord
+while ! supervisorctl status >/dev/null 2>&1; do sleep 1; done
+
+# Boot the mDNS stack
+echo '# Start the mDNS stack'
+sudo supervisorctl start dbus avahi
+echo
+
+function watch-make-test()
+{
+  while [ 1 ]; do
+    inotifywait --quiet -r `pwd` -e close_write --format '%e -> %w%f'
+    make test
+  done
+}
+
+function watch-make()
+{
+  while [ 1 ]; do
+    inotifywait --quiet -r `pwd` -e close_write --format '%e -> %w%f'
+    make $@
+  done
+}
+
+function watch-run()
+{
+  while [ 1 ]; do
+    inotifywait --quiet -r `pwd` -e close_write --format '%e -> %w%f'
+    bash -c "$@"
+  done
+}

data/config/docker/.inputrc

@@ -0,0 +1,17 @@
+# mappings for Ctrl-left-arrow and Ctrl-right-arrow for word moving
+"\e[1;5C": forward-word
+"\e[1;5D": backward-word
+"\e[5C": forward-word
+"\e[5D": backward-word
+"\e\e[C": forward-word
+"\e\e[D": backward-word
+
+# handle common Home/End escape codes
+"\e[1~": beginning-of-line
+"\e[4~": end-of-line
+"\e[7~": beginning-of-line
+"\e[8~": end-of-line
+"\eOH": beginning-of-line
+"\eOF": end-of-line
+"\e[H": beginning-of-line
+"\e[F": end-of-line

data/docker-compose.yml

@@ -0,0 +1,9 @@
+version: "3"
+services:
+  test:
+    build: .
+    env_file: Envfile
+    network_mode: bridge
+    working_dir: /app
+    volumes:
+      - .:/app

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activejob", "~> 5.2.0"
+gem "activerecord", "~> 5.2.0"
+gem "activesupport", "~> 5.2.0"
+
+gemspec path: "../"

data/grape-jwt-authentication.gemspec

@@ -5,36 +5,57 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'grape/jwt/authentication/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'grape-jwt-authentication'
-  spec.version       = Grape::Jwt::Authentication::VERSION
-  spec.authors       = ['Hermann Mayer']
-  spec.email         = ['hermann.mayer92@gmail.com']
+  spec.name = 'grape-jwt-authentication'
+  spec.version = Grape::Jwt::Authentication::VERSION
+  spec.authors = ['Hermann Mayer']
+  spec.email = ['hermann.mayer92@gmail.com']
 
-  spec.summary       = 'A reusable Grape JWT authentication concern'
-  spec.description   = 'A reusable Grape JWT authentication concern'
-  spec.homepage      = 'https://github.com/hausgold/grape-jwt-authentication'
+  spec.license = 'MIT'
+  spec.summary = 'A reusable Grape JWT authentication concern'
+  spec.description = 'A reusable Grape JWT authentication concern'
+
+  base_uri = "https://github.com/hausgold/#{spec.name}"
+  spec.metadata = {
+    'homepage_uri' => base_uri,
+    'source_code_uri' => base_uri,
+    'changelog_uri' => "#{base_uri}/blob/master/CHANGELOG.md",
+    'bug_tracker_uri' => "#{base_uri}/issues",
+    'documentation_uri' => "https://www.rubydoc.info/gems/#{spec.name}"
+  }
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '>= 1.16', '< 3'
-  spec.add_development_dependency 'rack', '~> 2.0'
-  spec.add_development_dependency 'rack-test', '~> 0.8.2'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.9'
-  spec.add_development_dependency 'simplecov', '~> 0.15'
-  spec.add_development_dependency 'timecop', '~> 0.9.1'
-  spec.add_development_dependency 'vcr', '~> 3.0'
-  spec.add_development_dependency 'webmock', '~> 3.1'
-
-  spec.add_runtime_dependency 'activesupport', '>= 3.2.0'
+  spec.required_ruby_version = '>= 2.5'
+
+  spec.add_runtime_dependency 'activesupport', '>= 5.2'
   spec.add_runtime_dependency 'grape', '~> 1.0'
-  spec.add_runtime_dependency 'httparty'
-  spec.add_runtime_dependency 'jwt', '~> 2.1'
-  spec.add_runtime_dependency 'recursive-open-struct', '~> 1.0'
-  spec.add_runtime_dependency 'keyless', '~> 1.0'
+  spec.add_runtime_dependency 'httparty', '>= 0.21'
+  spec.add_runtime_dependency 'jwt', '~> 2.6'
+  spec.add_runtime_dependency 'keyless', '~> 1.1'
+  spec.add_runtime_dependency 'recursive-open-struct', '~> 1.1'
+
+  spec.add_development_dependency 'appraisal', '~> 2.4'
+  spec.add_development_dependency 'bundler', '~> 2.3'
+  spec.add_development_dependency 'countless', '~> 1.1'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'rack', '~> 2.2'
+  spec.add_development_dependency 'rack-test', '~> 2.0'
+  spec.add_development_dependency 'railties', '>= 5.2'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+  spec.add_development_dependency 'rubocop', '~> 1.28'
+  spec.add_development_dependency 'rubocop-rails', '~> 2.14'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.10'
+  spec.add_development_dependency 'simplecov', '>= 0.22'
+  spec.add_development_dependency 'timecop', '>= 0.9.6'
+  spec.add_development_dependency 'vcr', '~> 6.0'
+  spec.add_development_dependency 'webmock', '~> 3.18'
+  spec.add_development_dependency 'yard', '>= 0.9.28'
+  spec.add_development_dependency 'yard-activesupport-concern', '>= 0.0.1'
 end

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

@@ -2,6 +2,7 @@
 
 module Grape
   module Jwt
+    # The Grape JWT authentication concern.
     module Authentication
       # Specifies which configuration keys are shared between keyless
       # and grape-jwt-authentication, so that we can easily pass through
@@ -10,7 +11,7 @@ module Grape
         authenticator rsa_public_key_url rsa_public_key_caching
         rsa_public_key_expiration jwt_issuer jwt_beholder jwt_options
         jwt_verification_key
-      ]
+      ].freeze
 
       # (Re)configure our gem dependencies. We take care of setting up
       # +Keyless+, which has been extracted from this gem.

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

@@ -102,10 +102,8 @@ module Grape
         # interface.
         #
         # @param env [Hash{String => Mixed}] the Rack environment
-        #
-        # rubocop:disable Metrics/AbcSize because thats the auth handling core
+        # because thats the auth handling core
         # :reek:TooManyStatements because reek counts exception
-        #                         handling as statements
         def call(env)
           # Unfortunately Grape's middleware stack orders the error
           # handling higher than the formatter. So when a error is
@@ -139,7 +137,6 @@ module Grape
           # Call the user defined failed authentication handler.
           failed_handler.call(token, @app)
         end
-        # rubocop:enable Metrics/AbcSize
       end
     end
   end

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

@@ -2,8 +2,26 @@
 
 module Grape
   module Jwt
+    # The gem version details.
     module Authentication
-      VERSION = '2.0.3'.freeze
+      # The version of the +grape-jwt-authentication+ gem
+      VERSION = '2.1.0'
+
+      class << self
+        # Returns the version of gem as a string.
+        #
+        # @return [String] the gem version as string
+        def version
+          VERSION
+        end
+
+        # Returns the version of the gem as a +Gem::Version+.
+        #
+        # @return [Gem::Version] the gem version as object
+        def gem_version
+          Gem::Version.new VERSION
+        end
+      end
     end
   end
 end

metadata

@@ -1,231 +1,351 @@
 --- !ruby/object:Gem::Specification
 name: grape-jwt-authentication
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Hermann Mayer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
-    - - "<"
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
-    - - "<"
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
+        version: '2.6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: keyless
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.2
-  type: :development
+        version: '1.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: recursive-open-struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: countless
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '4.7'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
-  type: :runtime
+        version: '5.2'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: grape
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
+        version: '13.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '3.12'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: jwt
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :runtime
+        version: '1.28'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '1.28'
 - !ruby/object:Gem::Dependency
-  name: recursive-open-struct
+  name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
+        version: '2.14'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: keyless
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
+        version: '2.10'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+- !ruby/object:Gem::Dependency
+  name: yard-activesupport-concern
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.1
 description: A reusable Grape JWT authentication concern
 email:
 - hermann.mayer92@gmail.com
@@ -234,28 +354,46 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/documentation.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".simplecov"
-- ".travis.yml"
+- ".yardopts"
+- Appraisals
 - CHANGELOG.md
+- Dockerfile
+- Envfile
 - Gemfile
+- Guardfile
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- config/docker/.bash_profile
+- config/docker/.bashrc
+- config/docker/.inputrc
 - doc/assets/project.svg
+- docker-compose.yml
+- gemfiles/rails_5.2.gemfile
 - grape-jwt-authentication.gemspec
 - lib/grape/jwt/authentication.rb
 - lib/grape/jwt/authentication/configuration.rb
 - lib/grape/jwt/authentication/dependencies.rb
 - lib/grape/jwt/authentication/jwt_handler.rb
 - lib/grape/jwt/authentication/version.rb
-homepage: https://github.com/hausgold/grape-jwt-authentication
-licenses: []
-metadata: {}
+homepage:
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hausgold/grape-jwt-authentication
+  source_code_uri: https://github.com/hausgold/grape-jwt-authentication
+  changelog_uri: https://github.com/hausgold/grape-jwt-authentication/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/hausgold/grape-jwt-authentication/issues
+  documentation_uri: https://www.rubydoc.info/gems/grape-jwt-authentication
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -264,14 +402,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.3.8
 signing_key:
 specification_version: 4
 summary: A reusable Grape JWT authentication concern

data/.travis.yml

@@ -1,20 +0,0 @@
-env:
-  global:
-    - CC_TEST_REPORTER_ID=ecb753423174dbd8e4aaf04fb62bf4ef9c2a54904ac49a33fdf2b908b3c5e5f3
-
-sudo: false
-language: ruby
-rvm:
-  - 2.6
-  - 2.5
-  - 2.4
-
-before_install: gem install bundler
-
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-script: bundle exec rake
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT