doorkeeper-jwt 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e221c6342513368dcb299a24749a66fe45936fd1eef1ab3e93d1b34b7d0a89ca
-  data.tar.gz: 976256cc0a811b02e0ae9738842f99a8ccc57a054f8adea6fce9072db40cc390
+  metadata.gz: a2d8dbcaba58c45f27f3e2b7ca2c7800e4dc34826e90b537b67850beeca32796
+  data.tar.gz: 191472dd355643ddf4143cccc2e42e8962d4482d51dfc6729be3f83c5dcba915
 SHA512:
-  metadata.gz: ca803cc8cff761b4c2e7eddeeb2bf673ff3c4b32bdad377149904504c4d4dcc411dbe7bdfac7ac87f7deebe6e61a309ca983eb42c348e904265b3086311eccb3
-  data.tar.gz: e4c2690b4ddc8d0ace06d44659a7a91480f452394e8a6f7781c4dc4cd057101d38968559751ee15abcacf1ccdb49da05ad80a4ff0efd4c4c90527b013c35bffd
+  metadata.gz: 013ecc163c7cbbb640165971572f37bb11a9903289a643dfbaf0cee41166cb24bb45a7903e111cc7ef21a5f7856fc8d267dbd797d5108d36fc85b5e8158fda09
+  data.tar.gz: 35b106bd511644278a27df3b2c7c396f95d5b8786a642d63e1600ef00929e05795f135caf8832838c5b35b66563e2b7677e3fbea9f8b8b86ec2f39350acd57be

data/.github/workflows/changelog.yml

@@ -0,0 +1,36 @@
+name: "Changelog verifier"
+on:
+  pull_request:
+    # The specific activity types are listed here to include "labeled" and "unlabeled"
+    # (which are not included by default for the "pull_request" trigger).
+    # This is needed to allow skipping enforcement of the changelog in PRs with specific labels,
+    # as defined in the (optional) "skipLabels" property.
+    types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
+
+jobs:
+  # Enforces the update of a changelog file on every pull request
+  changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - name: Check changed paths
+        id: changes
+        uses: dorny/paths-filter@v4
+        with:
+          filters: |
+            gem_changes:
+              - 'lib/**'
+              - 'app/**'
+              - 'config/**'
+              - '*.gemspec'
+              - 'Gemfile'
+              - 'Gemfile.lock'
+              - 'ext/**'
+
+      - name: Enforce changelog
+        if: |
+          steps.changes.outputs.gem_changes == 'true'
+        uses: dangoslen/changelog-enforcer@v3
+        with:
+          changeLogPath: CHANGELOG.md
+          skipLabels: "dependencies"

data/.github/workflows/ci.yml

@@ -19,8 +19,6 @@ jobs:
         experimental: [false]
         os: [ ubuntu-latest ]
         ruby:
-          - 2.6
-          - 2.7
           - '3.0'
           - '3.1'
     steps:

data/CHANGELOG.md

@@ -6,7 +6,21 @@ project adheres to [Semantic Versioning](http://semver.org/).
 
 ## master
 
-### Changed
+- Add your entry here
+
+## [0.4.2] - 2024-08-12
+
+- Reuse Doorkeeper core config options DSL [#58](https://github.com/doorkeeper-gem/doorkeeper-jwt/pull/58)
+- Include bin directory in gemspec correctly [#59](https://github.com/doorkeeper-gem/doorkeeper-jwt/pull/59)
+
+## [0.4.2] - 2024-08-12
+
+-  Rename encryption_method to signing_method [#53](https://github.com/doorkeeper-gem/doorkeeper-jwt/pull/53)
+-  Fix default token generation [#56](https://github.com/doorkeeper-gem/doorkeeper-jwt/pull/56)
+
+### Fixed
+
+- Fixed default token generation to return a random hex value [#56](https://github.com/doorkeeper-gem/doorkeeper-jwt/pull/56)
 
 ## [0.4.1] - 2022-02-23
 

data/Gemfile

@@ -5,6 +5,6 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in doorkeeper-jwt.gemspec
 gemspec
 
-gem "coveralls", require: false
+gem "coveralls_reborn", require: false
 gem "rubocop", "~> 1.8", require: false
-gem "rubocop-rspec", "~> 2.1", require: false
+gem "rubocop-rspec", "~> 3.0", require: false

data/README.md

@@ -46,43 +46,50 @@ Doorkeeper::JWT.configure do
   token_payload do |opts|
     user = User.find(opts[:resource_owner_id])
 
-    {
+    payload = {
       iss: 'My App',
-      iat: Time.current.utc.to_i,
+      iat: opts[:created_at].utc.to_i,
+      aud: opts[:application][:uid],
 
       # @see JWT reserved claims - https://tools.ietf.org/html/draft-jones-json-web-token-07#page-7
       jti: SecureRandom.uuid,
+      sub: user.id,
 
       user: {
         id: user.id,
         email: user.email
       }
     }
+
+    payload[:exp] = (opts[:created_at] + opts[:expires_in]).utc.to_i if opts[:expires_in]
+    payload
   end
 
   # Optionally set additional headers for the JWT. See
   # https://tools.ietf.org/html/rfc7515#section-4.1
-  token_headers do |opts|
-    { kid: opts[:application][:uid] }
-  end
+  # JWK can be used to automatically verify RS* tokens client-side if token's kid matches a public kid in /oauth/discovery/keys
+  # token_headers do |_opts|
+  #   key = OpenSSL::PKey::RSA.new(File.read(File.join('path', 'to', 'file.pem')))
+  #   { kid: JWT::JWK.new(key)[:kid] }
+  # end
 
   # Use the application secret specified in the access grant token. Defaults to
   # `false`. If you specify `use_application_secret true`, both `secret_key` and
   # `secret_key_path` will be ignored.
   use_application_secret false
 
-  # Set the encryption secret. This would be shared with any other applications
-  # that should be able to read the payload of the token. Defaults to "secret".
+  # Set the signing secret. This would be shared with any other applications
+  # that should be able to verify the authenticity of the token. Defaults to "secret".
   secret_key ENV['JWT_SECRET']
 
-  # If you want to use RS* encoding specify the path to the RSA key to use for
+  # If you want to use RS* algorithms specify the path to the RSA key to use for
   # signing. If you specify a `secret_key_path` it will be used instead of
   # `secret_key`.
   secret_key_path File.join('path', 'to', 'file.pem')
 
-  # Specify encryption type (https://github.com/progrium/ruby-jwt). Defaults to
+  # Specify cryptographic signing algorithm type (https://github.com/progrium/ruby-jwt). Defaults to
   # `nil`.
-  encryption_method :hs512
+  signing_method :hs512
 end
 ```
 

data/doorkeeper-jwt.gemspec

@@ -17,14 +17,23 @@ Gem::Specification.new do |spec|
   spec.license = "MIT"
 
   spec.bindir = "exe"
-  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|bin)/}) }
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.metadata = {
+    "homepage_uri" => "https://github.com/doorkeeper-gem/doorkeeper-jwt",
+    "changelog_uri" => "https://github.com/doorkeeper-gem/doorkeeper-jwt/blob/main/CHANGELOG.md",
+    "source_code_uri" => "https://github.com/doorkeeper-gem/doorkeeper-jwt",
+    "bug_tracker_uri" => "https://github.com/doorkeeper-gem/doorkeeper-jwt/issues",
+    "funding_uri" => "https://opencollective.com/doorkeeper-gem",
+  }
+
   spec.add_dependency "jwt", ">= 2.1"
 
-  spec.add_development_dependency "bundler", ">= 1.16", "< 3"
+  spec.add_development_dependency "bundler", ">= 1.16"
+  spec.add_development_dependency "doorkeeper"
   spec.add_development_dependency "pry", "~> 0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.8"

data/lib/doorkeeper/jwt/config.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "doorkeeper/config/option"
+
 module Doorkeeper
   module JWT
     class MissingConfiguration < StandardError
@@ -39,86 +41,30 @@ module Doorkeeper
           @config.instance_variable_set("@secret_key_path", value)
         end
 
+        # For backward compatibility. This library does not support encryption.
         def encryption_method(value)
-          @config.instance_variable_set("@encryption_method", value)
-        end
-      end
-
-      module Option
-        # Defines configuration options.
-        #
-        # When you call option, it defines two methods. One method will take
-        # place in the +Config+ class and the other method will take place in
-        # the +Builder+ class.
-        #
-        # The +name+ parameter will set both builder method and config
-        # attribute. If the +:as+ option is defined, the builder method will be
-        # the specified option while the config attribute will be the +name+
-        # parameter.
-        #
-        # If you want to introduce another level of config DSL you can define
-        # +builder_class+ parameter. Builder should take a block as the
-        # initializer parameter and respond to function +build+ that returns the
-        # value of the config attribute.
-        #
-        # ==== Options
-        #
-        # * [+:as+] Set the builder method that goes inside +configure+ block.
-        # * [+:default+] The default value in case no option was set.
-        #
-        # ==== Examples
-        #
-        #     option :name
-        #     option :name, as: :set_name
-        #     option :name, default: 'My Name'
-        #     option :scopes, builder_class: ScopesBuilder
-        def option(name, options = {})
-          attribute = options[:as] || name
-          attribute_builder = options[:builder_class]
-          attribute_symbol = :"@#{attribute}"
-
-          Builder.instance_eval do
-            define_method name do |*args, &block|
-              # TODO: is builder_class option being used?
-              value =
-                if attribute_builder
-                  attribute_builder.new(&block).build
-                else
-                  block || args.first
-                end
-
-              @config.instance_variable_set(attribute_symbol, value)
-            end
-          end
-
-          define_method attribute do |*|
-            if instance_variable_defined?(attribute_symbol)
-              instance_variable_get(attribute_symbol)
-            else
-              options[:default]
-            end
-          end
-
-          public attribute
+          @config.instance_variable_set("@signing_method", value)
+          Kernel.warn("[DOORKEEPER-JWT]: Please use signing_method instead, this option is deprecated and will be removed soon")
         end
 
-        def extended(base)
-          base.send(:private, :option)
+        def signing_method(value)
+          @config.instance_variable_set("@signing_method", value)
         end
       end
 
-      extend Option
+      mattr_reader(:builder_class) { Config::Builder }
+      extend ::Doorkeeper::Config::Option
 
       option(
         :token_payload,
-        default: proc { { token: SecureRandom.method(:hex) } }
+        default: proc { { token: SecureRandom.hex } },
       )
 
       option :token_headers, default: proc { {} }
       option :use_application_secret, default: false
       option :secret_key, default: nil
       option :secret_key_path, default: nil
-      option :encryption_method, default: nil
+      option :signing_method, default: nil
 
       def use_application_secret
         @use_application_secret ||= false
@@ -132,8 +78,8 @@ module Doorkeeper
         @secret_key_path ||= nil
       end
 
-      def encryption_method
-        @encryption_method ||= nil
+      def signing_method
+        @signing_method ||= nil
       end
     end
   end

data/lib/doorkeeper/jwt/version.rb

@@ -10,7 +10,7 @@ module Doorkeeper
       # Semantic versioning
       MAJOR = 0
       MINOR = 4
-      TINY = 1
+      TINY = 3
       PRE = nil
 
       # Full version number

data/lib/doorkeeper/jwt.rb

@@ -11,7 +11,7 @@ module Doorkeeper
         ::JWT.encode(
           token_payload(opts),
           secret_key(opts),
-          encryption_method,
+          signing_method,
           token_headers(opts)
         )
       end
@@ -31,22 +31,22 @@ module Doorkeeper
 
         return application_secret(opts) if use_application_secret?
         return secret_key_file unless secret_key_file.nil?
-        return rsa_key if rsa_encryption?
-        return ecdsa_key if ecdsa_encryption?
+        return rsa_key if rsa_signing?
+        return ecdsa_key if ecdsa_signing?
 
         Doorkeeper::JWT.configuration.secret_key
       end
 
       def secret_key_file
         return nil if Doorkeeper::JWT.configuration.secret_key_path.nil?
-        return rsa_key_file if rsa_encryption?
-        return ecdsa_key_file if ecdsa_encryption?
+        return rsa_key_file if rsa_signing?
+        return ecdsa_key_file if ecdsa_signing?
       end
 
-      def encryption_method
-        return "none" unless Doorkeeper::JWT.configuration.encryption_method
+      def signing_method
+        return "none" unless Doorkeeper::JWT.configuration.signing_method
 
-        Doorkeeper::JWT.configuration.encryption_method.to_s.upcase
+        Doorkeeper::JWT.configuration.signing_method.to_s.upcase
       end
 
       def use_application_secret?
@@ -83,12 +83,12 @@ module Doorkeeper
         secret
       end
 
-      def rsa_encryption?
-        /RS\d{3}/ =~ encryption_method
+      def rsa_signing?
+        /RS\d{3}/ =~ signing_method
       end
 
-      def ecdsa_encryption?
-        /ES\d{3}/ =~ encryption_method
+      def ecdsa_signing?
+        /ES\d{3}/ =~ signing_method
       end
 
       def rsa_key

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doorkeeper-jwt
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Chris Warren
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-23 00:00:00.000000000 Z
+date: 2026-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -32,9 +32,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,9 +39,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
-    - - "<"
+- !ruby/object:Gem::Dependency
+  name: doorkeeper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +103,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/changelog.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".hound.yml"
@@ -105,8 +114,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - doorkeeper-jwt.gemspec
 - lib/doorkeeper/jwt.rb
 - lib/doorkeeper/jwt/config.rb
@@ -114,7 +121,12 @@ files:
 homepage: https://github.com/chriswarren/doorkeeper-jwt
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/doorkeeper-gem/doorkeeper-jwt
+  changelog_uri: https://github.com/doorkeeper-gem/doorkeeper-jwt/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/doorkeeper-gem/doorkeeper-jwt
+  bug_tracker_uri: https://github.com/doorkeeper-gem/doorkeeper-jwt/issues
+  funding_uri: https://opencollective.com/doorkeeper-gem
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -130,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: JWT token generator for Doorkeeper

data/bin/console

@@ -1,17 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "doorkeeper-jwt"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require 'pry'
-#
-# Pry.start
-
-require "irb"
-
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here.