jot-helpers 1.0.0.beta4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbbe16be31ced7f4112c725850272c26bd91fbba4ba060aefc16d6b7292cc85e
-  data.tar.gz: c4094b3f477538683ac34be6f428ade5c4c138c290654b8ab9fe3d0814bb8c16
+  metadata.gz: a587295210595b3561634de5170dc2dc7ce37a47ea1ce61db7ebcede1a7dbad9
+  data.tar.gz: fc9c02f97af24c90ae7150d5f7f1ad945f79a85416220e30d8ec0bb86577529f
 SHA512:
-  metadata.gz: 343bb0e4f8a9fa376900f5a684191ff3c8582ca9c7e89edfb1732b16931e147f9fe5df9d105059abaca86c6233d32b14cdec430327610194540291fdd67da9eb
-  data.tar.gz: c6214640f8e904216dccb1052d14cc558181ddd0cbb7d1515bd5a5e577bb03b1a2cc09f3870574e10491b5bc42102237be65a1daaa660cabf1f88d4b1ff486b7
+  metadata.gz: ca5d28c55edc69017aafddb218b5ccea2287b17a37a7739c07db15f60c98e70fa101a58e71df34168baebaf222d81228a4df8f6a6f79617441b2fd0c4e68c719
+  data.tar.gz: 2acc4fd85f00662e3cf14c6198ec968d1cfd877d4a16b395edd0d75c6c16e6bbc3f3c66866b7f664ce0ff90d753d4b244a20acec06b13f0ea189d4d4d9b416f9

data/README.md

@@ -13,6 +13,12 @@ Jot.configure do |config|
 end
 ```
 
+You may wish to also specify the expiration time for tokens as well. The default is 1 hour, but it can be overridden:
+
+```ruby
+  config.expiration_time_in_seconds = 1500 # 25 minutes
+```
+
 ## Usage
 
 Encode a payload:
@@ -27,4 +33,11 @@ Decode a payload:
 Jot.decode("eyJhbGciOiJIUz...") # => { "user_id" => 1 }
 ```
 
+Decode a payload and get the header information too:
+
+```ruby
+Jot.original_decode("eyJhbGciOiJIUz") # => [{ "user_id" => 1 }, { "alg" => "HS256" }]
+
+```
+
 Exceptions raised for invalid / expired tokens will be the same as those raised by the JWT gem.

data/Rakefile

@@ -1,4 +1,8 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-task default: %i[]
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/jot/configuration.rb

@@ -1,7 +1,10 @@
 class Jot
   class Configuration
-    attr_accessor :algorithm, :secret
-
+    attr_accessor :algorithm, :secret, :expiration_time_in_seconds
 
+    # Defaults to 1 hour
+    def expiration_time_in_seconds
+      @expiration_time_in_seconds || 3600
+    end
   end
 end

data/lib/jot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Jot
-  VERSION = "1.0.0.beta4"
+  VERSION = "1.1.0"
 end

data/lib/jot.rb

@@ -16,10 +16,16 @@ class Jot
   end
 
   def self.encode(payload)
-    JWT.encode(payload, config.secret, config.algorithm)
+    exp = payload[:exp] || Time.now + config.expiration_time_in_seconds
+    JWT.encode(payload.merge(exp: exp.to_i), config.secret, config.algorithm)
   end
 
   def self.decode(payload, verify: true)
+    data, _algorithm = original_decode(payload, verify: verify)
+    data
+  end
+
+  def self.original_decode(payload, verify: true)
     JWT.decode(payload, config.secret, verify, { algorithm: config.algorithm })
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jot-helpers
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta4
+  version: 1.1.0
 platform: ruby
 authors:
 - Ryan Bigg
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-04 00:00:00.000000000 Z
+date: 2023-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides helper methods for working with JSON Web Tokens (JWTs)
 email:
 - me@ryanbigg.com
@@ -70,9 +84,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.16
 signing_key: