keyless 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fd16c98d515436659a9719caeb4552f1426992f77b4a1b2bf2465ad90cbf115
-  data.tar.gz: ce0f9e63a8f37f73282be5692a22de88ce6cf8bcddfeb2fafc71015b54281989
+  metadata.gz: bf3b27e57dd5695ad190bc2940a7cdb7b08ea79b66d35bdf4c2d67acefa6cc42
+  data.tar.gz: aed02f107d55f5a77e50c724fa517a50864ec42f16d4c505ab84ed31d4443cf6
 SHA512:
-  metadata.gz: 92c80c2e5b22db4bd178441cc406d7379f64f870be51909d11139a56a64b0c5497415af384088601fd8cefb19b0cacbc97a50881959a56a775de0375bc8ebc9b
-  data.tar.gz: 2c212d36f0fd05ba0a5cf7a315f873b752f7549c532f3e39c3f5e4489db28e6eeb9213a0f76c728e41a55ae08db66ccb9bc8ebbe94fb5a084cd4a05d31729336
+  metadata.gz: 2669da4e5baf3e6bf8fc6f3b37e28b9e09278ba245f8057fd80e332b4bee8b4c34195bba07b22b549fca6213722fc1ac9ad1f58186cd30b835524009e79daf42
+  data.tar.gz: 6f5ff05b341d0991786a76aff5d6f3a042800fe6a9f5fdc8a3a92e037c9b76eaa6b7d6f6d690442e4f0d85dc831c40b5ccb4ff736fa5953170d0c21ff2f8604d

data/.github/workflows/documentation.yml

@@ -9,16 +9,17 @@ concurrency:
 jobs:
   docs:
     name: Build gem documentation
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v2
+      - 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

data/.github/workflows/release.yml

@@ -0,0 +1,47 @@
+name: Release
+run-name: Release ${{ github.event.inputs.VERSION }}
+
+on:
+  workflow_dispatch:
+    inputs:
+      VERSION:
+        description: The new version to release. (eg. `1.0.0`) Check the
+          changelog for the latest version.
+
+concurrency:
+  group: '${{ github.event.inputs.VERSION }}'
+  cancel-in-progress: true
+
+jobs:
+  docs:
+    name: Release the gem
+    runs-on: ubuntu-22.04
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install Ruby 2.5
+        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: Switch to SSH remotes for the Git repository
+        run: git-ssh-remotes
+
+      - name: Enforce version '${{ github.event.inputs.VERSION }}'
+        run: set-gem-version '${{ github.event.inputs.VERSION }}'
+
+      - name: Prepare the Git release commit
+        run: git-release-commit '${{ github.event.inputs.VERSION }}'
+
+      - name: Push the release Git commit/tag and package to the registry
+        run: make release

data/.github/workflows/test.yml

@@ -12,21 +12,25 @@ concurrency:
 
 jobs:
   test:
-    name: 'Test the gem (Ruby ${{ matrix.ruby }})'
-    runs-on: ubuntu-20.04
+    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.4, 2.5, 2.6]
+        ruby: ['2.5', '2.7']
+        rails: ['5.2']
+    env:
+      BUNDLE_GEMFILE: 'gemfiles/rails_${{ matrix.rails }}.gemfile'
     steps:
-      - uses: actions/checkout@v2
+      - 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
@@ -43,7 +47,7 @@ jobs:
 
   trigger-docs:
     name: Trigger the documentation upload
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     timeout-minutes: 2
     needs: test
     if: github.ref == 'refs/heads/master'

data/.rspec

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

data/.rubocop.yml

@@ -1,14 +1,19 @@
-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.5
+  TargetRailsVersion: 5.2
   Exclude:
     - bin/**/*
     - vendor/**/*
@@ -23,6 +28,14 @@ Metrics/BlockLength:
     - '**/*.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:
   Enabled: true
@@ -51,3 +64,8 @@ RSpec/FilePath:
 # Because we just implemented the ActiveRecord API.
 Rails/SkipsModelValidations:
   Enabled: false
+
+# We use memoized helpers all over the place to construct inputs and output
+# which can be customized at nested contexts easily.
+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/Appraisals

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

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+### next
+
+* TODO: Replace this bullet point with an actual description of a change.
+
+### 1.2.0
+
+* Added support for Gem release automation
+
+### 1.1.0
+
+* Bundler >= 2.3 is from now on required as minimal version (#1)
+* Dropped support for Ruby < 2.5 (#1)
+* Dropped support for Rails < 5.2 (#1)
+* Updated all development/runtime gems to their latest
+  Ruby 2.5 compatible version (#1)
+
 ### 1.0.2
 
 * Migrated to Github Actions
@@ -10,5 +26,6 @@
 
 ### 1.0.0
 
-* Initial release, extracted from former [grape-jwt-authentication](https://github.com/hausgold/grape-jwt-authentication)
-code at v1.3.0.
+* Initial release, extracted from former
+  [grape-jwt-authentication](https://github.com/hausgold/grape-jwt-authentication)
+  code at v1.3.0.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at development@hausgold.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -2,7 +2,7 @@ FROM hausgold/ruby:2.5
 MAINTAINER Hermann Mayer <hermann.mayer@hausgold.de>
 
 # Update system gem
-RUN gem update --system
+RUN gem update --system '3.3.26'
 
 # Install system packages and the latest bundler
 RUN apt-get update -yqqq && \
@@ -11,8 +11,7 @@ RUN apt-get update -yqqq && \
     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.0' --no-document --no-prerelease && \
-  gem install bundler -v '~> 1.0' --no-document --no-prerelease
+  gem install bundler -v '~> 2.3.0' --no-document --no-prerelease
 
 # Add new web user
 RUN mkdir /app && \

data/Envfile

@@ -1,6 +1,3 @@
 LANG=en_US.UTF-8
 LANGUAGE=en_US.UTF-8
 LC_ALL=en_US.UTF-8
-
-# Just fix this, so Appraisals with Rails 4 are working fine
-BUNDLER_VERSION=1.17.3

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/keyless.rb}) { 'spec' }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/keyless/([^\\]+)\.rb$}) do |m|
+    "spec/keyless/#{m[1]}_spec.rb"
+  end
+  watch(%r{^lib/keyless/([^\\]+)/(.*)\.rb$}) do |m|
+    "spec/keyless/#{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

@@ -9,6 +9,7 @@ SHELL := bash
 # Environment switches
 MAKE_ENV ?= docker
 COMPOSE_RUN_SHELL_FLAGS ?= --rm
+BASH_RUN_SHELL_FLAGS ?=
 
 # Directories
 VENDOR_DIR ?= vendor/bundle
@@ -25,12 +26,20 @@ RM ?= rm
 XARGS ?= xargs
 
 # Container binaries
+APPRAISAL ?= appraisal
 BUNDLE ?= bundle
 GEM ?= gem
+GUARD ?= guard
 RAKE ?= rake
+RSPEC ?= rspec
 RUBOCOP ?= rubocop
 YARD ?= yard
 
+# Files
+GEMFILES ?= $(subst _,-,$(patsubst $(GEMFILES_DIR)/%.gemfile,%,\
+	$(wildcard $(GEMFILES_DIR)/*.gemfile)))
+TEST_GEMFILES := $(GEMFILES:%=test-%)
+
 # Define a generic shell run wrapper
 # $1 - The command to run
 ifeq ($(MAKE_ENV),docker)
@@ -38,7 +47,8 @@ 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 -c 'sleep 0.1; echo; $(1)'
+		-u `$(ID) -u` test \
+		bash $(BASH_RUN_SHELL_FLAGS) -c 'sleep 0.1; echo; $(1)'
 endef
 else ifeq ($(MAKE_ENV),baremetal)
 define run-shell
@@ -55,6 +65,7 @@ all:
 	#
 	# 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)
@@ -64,12 +75,24 @@ all:
 	# 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,GEM_HOME=vendor/bundle/ruby/$${RUBY_MAJOR}.0 \
-		$(GEM) install bundler -v "~> 1.0")
+	@$(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 \
@@ -79,6 +102,11 @@ 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
 
@@ -90,8 +118,8 @@ clean:
 	# Clean the dependencies
 	@$(RM) -rf $(VENDOR_DIR)
 	@$(RM) -rf $(VENDOR_DIR)/Gemfile.lock
-	@$(RM) -rf pkg
-	@$(RM) -rf coverage
+	@$(RM) -rf .bundle .yardoc coverage pkg Gemfile.lock doc/api \
+		.rspec_status
 
 clean-containers:
 	# Clean running containers
@@ -102,7 +130,7 @@ endif
 clean-images:
 	# Clean build images
 ifeq ($(MAKE_ENV),docker)
-	@-$(DOCKER) images | $(GREP) rimless \
+	@-$(DOCKER) images | $(GREP) $(shell basename "`pwd`") \
 		| $(AWK) '{ print $$3 }' \
 		| $(XARGS) -rn1 $(DOCKER) rmi -f
 endif

data/README.md

@@ -25,7 +25,9 @@ flexible on the JWT verification level.
     - [Custom JWT verification key](#custom-jwt-verification-key)
   - [Full RSA256 example](#full-rsa256-example)
 - [Development](#development)
+- [Code of Conduct](#code-of-conduct)
 - [Contributing](#contributing)
+- [Releasing](#releasing)
 
 ## Installation
 
@@ -265,17 +267,28 @@ end
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run
-`bundle exec rake spec` to run the tests. You can also run `bin/console` for an
+After checking out the repo, run `make install` to install dependencies. Then,
+run `make test` to run the tests. You can also run `make shell-irb` for an
 interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release`, which will create a git tag for the version, push
-git commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
+## Code of Conduct
+
+Everyone interacting in the project codebase, issue tracker, chat
+rooms and mailing lists is expected to follow the [code of
+conduct](./CODE_OF_CONDUCT.md).
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at
-https://github.com/hausgold/keyless.
+https://github.com/hausgold/keyless. Make sure that every pull request adds
+a bullet point to the [changelog](./CHANGELOG.md) file with a reference to the
+actual pull request.
+
+## Releasing
+
+The release process of this Gem is fully automated. You just need to open the
+Github Actions [Release
+Workflow](https://github.com/hausgold/keyless/actions/workflows/release.yml)
+and trigger a new run via the **Run workflow** button. Insert the new version
+number (check the [changelog](./CHANGELOG.md) first for the latest release) and
+you're done.

data/Rakefile

@@ -2,71 +2,18 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-require 'rails/code_statistics'
-require 'pp'
+require 'countless/rake_tasks'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
 
-# Load some railties tasks
-load 'rails/tasks/statistics.rake'
-load 'rails/tasks/annotations.rake'
-
-# Clear the default statistics directory constant
-#
-# rubocop:disable Style/MutableConstant because we define it
-Object.send(:remove_const, :STATS_DIRECTORIES)
-::STATS_DIRECTORIES = []
-# rubocop:enable Style/MutableConstant
-
-# Monkey patch the Rails +CodeStatistics+ class to support configurable
-# patterns per path. This is reuqired to support top-level only file matches.
-class CodeStatistics
-  DEFAULT_PATTERN = /^(?!\.).*?\.(rb|js|coffee|rake)$/.freeze
-
-  # Pass the possible +pattern+ argument down to the
-  # +calculate_directory_statistics+ method call.
-  def calculate_statistics
-    Hash[@pairs.map do |pair|
-      [pair.first, calculate_directory_statistics(*pair[1..-1])]
-    end]
-  end
-
-  # Match the pattern against the individual file name and the relative file
-  # path. This allows top-level only matches.
-  def calculate_directory_statistics(directory, pattern = DEFAULT_PATTERN)
-    stats = CodeStatisticsCalculator.new
-
-    Dir.foreach(directory) do |file_name|
-      path = "#{directory}/#{file_name}"
-
-      if File.directory?(path) && (/^\./ !~ file_name)
-        stats.add(calculate_directory_statistics(path, pattern))
-      elsif file_name =~ pattern || path =~ pattern
-        stats.add_by_file_path(path)
-      end
-    end
-
-    stats
-  end
-end
-
 # Configure all code statistics directories
-vendors = [
-  [:unshift, 'Top-levels', 'lib', %r{lib(/keyless)?/[^/]+\.rb$}],
-  [:unshift, 'Top-levels specs', 'spec', %r{spec/.*_spec\.rb$}]
-].reverse
-
-vendors.each do |method, type, dir, pattern|
-  ::STATS_DIRECTORIES.send(method, [type, dir, pattern].compact)
-  ::CodeStatistics::TEST_TYPES << type if type.include? 'specs'
-end
-
-# Setup annotations
-ENV['SOURCE_ANNOTATION_DIRECTORIES'] = 'spec,doc'
-
-desc 'Enumerate all annotations'
-task :notes do
-  SourceAnnotationExtractor.enumerate '@?OPTIMIZE|@?FIXME|@?TODO', tag: true
+Countless.configure do |config|
+  config.stats_base_directories = [
+    { name: 'Top-levels',
+      pattern: 'lib/**/*.rb' },
+    { name: 'Top-levels specs', test: true,
+      pattern: 'spec/**/*_spec.rb' }
+  ]
 end

data/gemfiles/rails_5.2.gemfile

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

data/keyless.gemspec

@@ -5,39 +5,55 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'keyless/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'keyless'
-  spec.version       = Keyless::VERSION
-  spec.authors       = ['Hermann Mayer', 'Christopher Mühl', 'Marcus Geißler']
-  spec.email         = ['hermann.mayer92@gmail.com',
-                        'christopher@padarom.xyz',
-                        'mg@hausgold.de']
+  spec.name = 'keyless'
+  spec.version = Keyless::VERSION
+  spec.authors = ['Hermann Mayer', 'Christopher Mühl', 'Marcus Geißler']
+  spec.email = ['hermann.mayer92@gmail.com',
+                'christopher@padarom.xyz',
+                'marcus3006@gmail.com']
 
-  spec.summary       = 'A reusable JWT authentication helper'
-  spec.description   = 'A reusable JWT authentication helper'
-  spec.homepage      = 'https://github.com/hausgold/keyless'
+  spec.license = 'MIT'
+  spec.summary = 'A reusable JWT authentication helper'
+  spec.description = 'A reusable JWT authentication helper'
+
+  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_runtime_dependency 'activesupport', '>= 3.2.0'
-  spec.add_runtime_dependency 'httparty'
-  spec.add_runtime_dependency 'jwt', '~> 2.1'
-  spec.add_runtime_dependency 'recursive-open-struct', '~> 1.0'
-
-  spec.add_development_dependency 'bundler', '>= 1.16', '< 3'
-  spec.add_development_dependency 'railties', '>= 4.2.0', '< 6.1'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.63.1'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.31'
-  spec.add_development_dependency 'simplecov', '< 0.18'
-  spec.add_development_dependency 'timecop', '~> 0.9.1'
-  spec.add_development_dependency 'vcr', '~> 3.0'
-  spec.add_development_dependency 'webmock', '~> 3.1'
-  spec.add_development_dependency 'yard', '~> 0.9.18'
-  spec.add_development_dependency 'yard-activesupport-concern', '~> 0.0.1'
+  spec.required_ruby_version = '>= 2.5'
+
+  spec.add_runtime_dependency 'activesupport', '>= 5.2'
+  spec.add_runtime_dependency 'httparty', '>= 0.21'
+  spec.add_runtime_dependency 'jwt', '~> 2.6'
+  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 '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/keyless/version.rb

@@ -1,5 +1,23 @@
 # frozen_string_literal: true
 
+# The gem version details.
 module Keyless
-  VERSION = '1.0.2'
+  # The version of the +keyless+ gem
+  VERSION = '1.2.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

data/lib/keyless.rb

@@ -7,9 +7,7 @@ require 'active_support/cache'
 require 'active_support/core_ext/hash'
 require 'active_support/time'
 require 'active_support/time_with_zone'
-
 require 'jwt'
-
 require 'keyless/version'
 require 'keyless/configuration'
 require 'keyless/jwt'

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: keyless
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Hermann Mayer
 - Christopher Mühl
 - Marcus Geißler
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2023-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -18,257 +18,305 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '5.2'
   type: :runtime
   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: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: recursive-open-struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        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: '2.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
-    - - "<"
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: countless
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
-    - - "<"
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.63.1
+        version: '1.28'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.28'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.63.1
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.31'
+        version: '2.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.31'
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.6
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.18'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.18
+        version: 0.9.28
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.18
+        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 JWT authentication helper
 email:
 - hermann.mayer92@gmail.com
 - christopher@padarom.xyz
-- mg@hausgold.de
+- marcus3006@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".github/workflows/documentation.yml"
+- ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".simplecov"
 - ".yardopts"
+- Appraisals
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Dockerfile
 - Envfile
 - Gemfile
+- Guardfile
 - LICENSE
 - Makefile
 - README.md
@@ -280,16 +328,23 @@ files:
 - config/docker/.inputrc
 - doc/assets/project.svg
 - docker-compose.yml
+- gemfiles/rails_5.2.gemfile
 - keyless.gemspec
 - lib/keyless.rb
 - lib/keyless/configuration.rb
 - lib/keyless/jwt.rb
 - lib/keyless/rsa_public_key.rb
 - lib/keyless/version.rb
-homepage: https://github.com/hausgold/keyless
-licenses: []
-metadata: {}
-post_install_message:
+homepage: 
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hausgold/keyless
+  source_code_uri: https://github.com/hausgold/keyless
+  changelog_uri: https://github.com/hausgold/keyless/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/hausgold/keyless/issues
+  documentation_uri: https://www.rubydoc.info/gems/keyless
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -297,15 +352,15 @@ 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
-signing_key:
+rubygems_version: 3.3.26
+signing_key: 
 specification_version: 4
 summary: A reusable JWT authentication helper
 test_files: []