Documentation for modules and classes

Author: anakinj

.rubocop.yml

@@ -6,9 +6,6 @@ AllCops:
     - 'gemfiles/*.gemfile'
     - 'vendor/**/*'
 
-Style/Documentation:
-  Enabled: false
-
 Metrics/AbcSize:
   Max: 25
 

lib/jwt/deprecations.rb

@@ -2,6 +2,7 @@
 
 module JWT
   # Deprecations module to handle deprecation warnings in the gem
+  # @api private
   module Deprecations
     class << self
       def context

lib/jwt/encoded_token.rb

@@ -111,15 +111,15 @@ def valid_signature?(algorithm:, key:)
     def decode_payload
       raise JWT::DecodeError, 'Encoded payload is empty' if encoded_payload == ''
 
-      if unecoded_payload?
+      if unencoded_payload?
         verify_claims!(crit: ['b64'])
         return parse_unencoded(encoded_payload)
       end
 
       parse_and_decode(encoded_payload)
     end
 
-    def unecoded_payload?
+    def unencoded_payload?
       header['b64'] == false
     end
 

lib/jwt/json.rb

@@ -3,7 +3,7 @@
 require 'json'
 
 module JWT
-  # JSON wrapper
+  # @api private
   class JSON
     class << self
       def generate(data)

lib/jwt/jwa/ecdsa.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWA
+    # ECDSA signing algorithm
     class Ecdsa
       include JWT::JWA::SigningAlgorithm
 

lib/jwt/jwa/eddsa.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWA
+    # Implementation of the EdDSA family of algorithms
     class Eddsa
       include JWT::JWA::SigningAlgorithm
 

lib/jwt/jwa/hmac.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWA
+    # Implementation of the HMAC family of algorithms
     class Hmac
       include JWT::JWA::SigningAlgorithm
 

lib/jwt/jwa/hmac_rbnacl.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWA
+    # Implementation of the HMAC family of algorithms (using RbNaCl)
     class HmacRbNaCl
       include JWT::JWA::SigningAlgorithm
 

lib/jwt/jwa/hmac_rbnacl_fixed.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWA
+    # Implementation of the HMAC family of algorithms (using RbNaCl prior to a certain version)
     class HmacRbNaClFixed
       include JWT::JWA::SigningAlgorithm
 

lib/jwt/jwa/none.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWA
+    # Implementation of the none algorithm
     class None
       include JWT::JWA::SigningAlgorithm
 

lib/jwt/jwa/ps.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWA
+    # Implementation of the RSASSA-PSS family of algorithms
     class Ps
       include JWT::JWA::SigningAlgorithm
 

lib/jwt/jwa/rsa.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWA
+    # Implementation of the RSA family of algorithms
     class Rsa
       include JWT::JWA::SigningAlgorithm
 

lib/jwt/jwa/signing_algorithm.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 module JWT
+  # JSON Web Algorithms
   module JWA
+    # Base functionality for signing algorithms
     module SigningAlgorithm
+      # Class methods for the SigningAlgorithm module
       module ClassMethods
         def register_algorithm(algo)
           ::JWT::JWA.register_algorithm(algo)

lib/jwt/jwa/unsupported.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWA
+    # Represents an unsupported algorithm
     module Unsupported
       class << self
         include JWT::JWA::SigningAlgorithm

lib/jwt/jwa/wrapper.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWA
+    # @api private
     class Wrapper
       include SigningAlgorithm
 

lib/jwt/jwk.rb

@@ -4,6 +4,7 @@
 require_relative 'jwk/set'
 
 module JWT
+  # JSON Web Key (JWK)
   module JWK
     class << self
       def create_from(key, params = nil, options = {})

lib/jwt/jwk/ec.rb

@@ -4,6 +4,7 @@
 
 module JWT
   module JWK
+    # JWK representation for Elliptic Curve (EC) keys
     class EC < KeyBase # rubocop:disable Metrics/ClassLength
       KTY    = 'EC'
       KTYS   = [KTY, OpenSSL::PKey::EC, JWT::JWK::EC].freeze

lib/jwt/jwk/hmac.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWK
+    # JWK for HMAC keys
     class HMAC < KeyBase
       KTY  = 'oct'
       KTYS = [KTY, String, JWT::JWK::HMAC].freeze

lib/jwt/jwk/key_base.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWK
+    # Base for JWK implementations
     class KeyBase
       def self.inherited(klass)
         super

lib/jwt/jwk/key_finder.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWK
+    # @api private
     class KeyFinder
       def initialize(options)
         @allow_nil_kid = options[:allow_nil_kid]

lib/jwt/jwk/kid_as_key_digest.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWK
+    # @api private
     class KidAsKeyDigest
       def initialize(jwk)
         @jwk = jwk

lib/jwt/jwk/okp_rbnacl.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWK
+    # JSON Web Key (JWK) representation for Ed25519 keys
     class OKPRbNaCl < KeyBase
       KTY  = 'OKP'
       KTYS = [KTY, JWT::JWK::OKPRbNaCl, RbNaCl::Signatures::Ed25519::SigningKey, RbNaCl::Signatures::Ed25519::VerifyKey].freeze

lib/jwt/jwk/rsa.rb

@@ -2,6 +2,7 @@
 
 module JWT
   module JWK
+    # JSON Web Key (JWK) representation of a RSA key
     class RSA < KeyBase # rubocop:disable Metrics/ClassLength
       BINARY = 2
       KTY    = 'RSA'

lib/jwt/jwk/set.rb

@@ -4,6 +4,8 @@
 
 module JWT
   module JWK
+    # JSON Web Key Set (JWKS) representation
+    # https://tools.ietf.org/html/rfc7517
     class Set
       include Enumerable
       extend Forwardable

lib/jwt/version.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# JSON Web Token implementation
+#
+# Should be up to date with the latest spec:
+# https://tools.ietf.org/html/rfc7519
 module JWT
   # Returns the gem version of the JWT library.
   #