Contents

# frozen_string_literal: true

module SolidusJwt
  module Encodeable
    ##
    # Encode a specified payload
    # @see https://github.com/jwt/ruby-jwt
    #
    # @example encode data into token
    #   payload = {
    #     sub: 1,
    #     iat: DateTime.current.to_i,
    #     exp: 1.hour.from_now.to_i
    #   }
    #
    #   SolidusJwt.encode payload: payload
    #   #=> 'eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlhdCI6MTU4NDEzMjExOCwiZXhwIj
    #    oxNTg0MTM1NzE4LCJpc3MiOiJzb2xpZHVzIn0.OKZOGlawx435GdgKp2AGD8SKxW7sqn0h-Ef2qdVSxqQ'
    #
    # @param payload [Hash] Attributes to place within the jwt
    # @param expires_in [Integer] How long until token expires in Seconds (*Optional*).
    #   Note that if no expires at is set, then the token will last forever.
    # @return [String]
    #
    def encode(payload:, expires_in: nil)
      jwt_payload = payload.dup.with_indifferent_access

      current_time = Time.current.to_i

      # @see https://github.com/jwt/ruby-jwt#support-for-reserved-claim-names
      jwt_payload[:exp] ||= current_time + expires_in.to_i if expires_in.present?
      jwt_payload[:iat] ||= current_time
      jwt_payload[:iss] ||= 'solidus'

      JWT.encode(jwt_payload, SolidusJwt::Config.jwt_secret,
        SolidusJwt::Config.jwt_algorithm)
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
solidus_jwt-1.2.2	lib/solidus_jwt/concerns/encodeable.rb