openproject-token 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d218d4572439ee41238271a09ad784c6a94be598e8028664d2d9ad3ac0a26115
-  data.tar.gz: 02adcfc7070c95e4d972a59b6df4dc812631855fcc008e6ba2fcbf9fcb6f3a9f
+  metadata.gz: 674fb4bda421c9bc39debd39abf5ef0103070da6c27967334c2d237480aeb893
+  data.tar.gz: 0e9d87592b6479b00163c2ada64649b959924b8c845468419814599733fe6ab0
 SHA512:
-  metadata.gz: 4698826acfa3110b50d0d8989148ed44025722a968f2f13d257573fe05550685480b7dacc5786ec6ee450b6704eba6b60ea70cce97e2e631bc19c0a4968c3908
-  data.tar.gz: 29a1fdb2b2c20ec9f0af23769e31c2ac990f490932bda21314faa26387a9d617309da6a0d2591b02bb7f411a4784f7829d10007d77e30baff0e2183575558e7c
+  metadata.gz: 415fd95a605f1b34205253b24873a359cf4fb9546f6bc6a3ae7442746f46075f1521cd9195009ff9e045de9139908c42124b59c68294abeeedc7c96f18e223ea
+  data.tar.gz: a658f645da29350cb45f1ec144690a474ed316249eb0ef2f3364f97a1e1ee4bdcdd4c5472dd4f5dea85128aa4a4ccd63a84fbc2b5873ed3c4fb1bc37f415c0d8

data/lib/open_project/token/version.rb

@@ -1,5 +1,5 @@
 module OpenProject
   class Token
-    VERSION = "2.1.0"
+    VERSION = "2.2.0"
   end
 end

data/lib/open_project/token.rb

@@ -51,6 +51,7 @@ module OpenProject
     attr_reader :version
     attr_accessor :subscriber, :mail, :company, :domain
     attr_accessor :starts_at, :issued_at, :expires_at
+    attr_accessor :reprieve_days
     attr_accessor :notify_admins_at, :notify_users_at, :block_changes_at
     attr_accessor :restrictions
 
@@ -90,8 +91,29 @@ module OpenProject
       self.block_changes_at
     end
 
-    def expired?
-      will_expire? && Date.today >= self.expires_at
+    ##
+    # Indicates whether or not the token has expired.
+    #
+    # This does include a reprieve (grace period) if configured.
+    # I.e. this will return false even if `expires_at` has passed
+    # if `reprieve_days` is configured, as long as the current date
+    # is still within those days after the actual expiration.
+    #
+    # @param reprieve [Boolean] Allow for reprieve (default true)
+    def expired?(reprieve: true)
+      offset = reprieve ? reprieve_days.to_i : 0
+
+      will_expire? && Date.today >= self.expires_at.next_day(offset)
+    end
+
+    ##
+    # Returns the number of days of reprieve left after the token has expired.
+    #
+    # @return Returns `nil` if the token hasn't expired yet or if no reprieve was given.
+    def reprieve_days_left
+      return nil unless reprieve_days.to_i > 0 && expired?(reprieve: false)
+
+      (self.expires_at.next_day(reprieve_days.to_i) - Date.today).to_i
     end
 
     def notify_admins?
@@ -131,6 +153,7 @@ module OpenProject
       hash["issued_at"]        = self.issued_at
       hash["starts_at"]        = self.starts_at
       hash["expires_at"]       = self.expires_at       if self.will_expire?
+      hash["reprieve_days"]    = self.reprieve_days    if self.will_expire?
 
       hash["notify_admins_at"] = self.notify_admins_at if self.will_notify_admins?
       hash["notify_users_at"]  = self.notify_users_at  if self.will_notify_users?
@@ -171,6 +194,16 @@ module OpenProject
         send("#{attr}=", value)
       end
 
+      reprieve_days = attributes["reprieve_days"]
+
+      if will_expire?
+        if reprieve_days.nil? && apply_default_reprieve?(version)
+          @reprieve_days = 7
+        else
+          @reprieve_days = reprieve_days.to_i
+        end
+      end
+
       restrictions = attributes["restrictions"]
 
       if restrictions && restrictions.is_a?(Hash)
@@ -196,11 +229,13 @@ module OpenProject
     #
     # @param attr [Hash] Parsed token attributes.
     def read_version(attr)
-      value = attr["version"]
+      value = attr.include?("version") ? attr["version"] : current_gem_version.to_s
       version = nil
 
-      if value.to_s != "-1"
-        version = value.then { |v| v && Gem::Version.new(v) } || current_gem_version
+      if value.to_s == "1"
+        version = 1
+      elsif value.present? && value.to_s != "-1"
+        version = Gem::Version.new value
 
         if version > current_gem_version
           raise ArgumentError, "Version is too new"
@@ -221,5 +256,13 @@ module OpenProject
     def domain_required_from_version
       @domain_required_from_version ||= Gem::Version.new('2.0')
     end
+
+    ##
+    # Reprieve was introduced in version 2.2.0 so could only be set
+    # during generation from then onwards. All tokens before that
+    # shall apply a default reprieve to be safe.
+    def apply_default_reprieve?(version)
+      Gem::Version.new(version) < Gem::Version.new("2.2.0")
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openproject-token
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - OpenProject GmbH
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-29 00:00:00.000000000 Z
+date: 2021-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
-description: 
+description:
 email: info@openproject.com
 executables: []
 extensions: []
@@ -69,7 +69,7 @@ homepage: https://www.openproject.org
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -84,8 +84,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: OpenProject EE token reader
 test_files: []