openproject-token 2.1.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d622e466da4e5bf9dab90d1ee1fcfac8757ce2a24fdc19a9c4b4be954081eaa1
-  data.tar.gz: 7ddbec23cf11fb83e1177abf33a942418e009f45567c0015c56fb20b9cea1225
+  metadata.gz: c70ad73f805a38cc1846b8c5b1db6492efda10e039c0d417f41577ba4aa0c50d
+  data.tar.gz: ddc82e67199f997413a1493eef6518f238821eb5f995cf07d945b7fec95cb8b6
 SHA512:
-  metadata.gz: 87d2219c37f2574e9c7651241e2c49af4f4928b7b84278bc1f92f97c8651142e414a68bdc3e2ce79e57b78df58b82d0c1b6fe6c2719b8889ae1374a5eadd29d3
-  data.tar.gz: 4505d7dca7305c46cd76a7afa3435615f78413d89f60ed28f566c65acb0376fec0bc2adc95c43af09d4f3a73f42656fc6bd6ebbdbd3d08ae728ca31d3932c0d2
+  metadata.gz: abd224aeb838bac009ab74e4aa9d31c60891c4d860351c21e18d2bc52aaca39be0bbf008e304b58e842194234cf3e6070b9de2a59f6086fde577abdaaa84a773
+  data.tar.gz: eb3bb63292374c49f3d6cf39bebeb7584c64b91835107f520d995cebb4047e3e285f83481948b209e40e3364f85be909346f362540548fbe017665c47d932b47

data/lib/open_project/token/version.rb

@@ -1,5 +1,5 @@
 module OpenProject
   class Token
-    VERSION = "2.1.3"
+    VERSION = "3.0.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?
@@ -111,6 +133,14 @@ module OpenProject
       version && Gem::Version.new(version) >= domain_required_from_version
     end
 
+    def valid_domain?(input)
+      if domain.is_a?(Regexp)
+        domain.match?(input)
+      else
+        domain == input
+      end
+    end
+
     def restricted?(key = nil)
       if key
         restricted? && restrictions.has_key?(key)
@@ -131,6 +161,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?
@@ -160,7 +191,7 @@ module OpenProject
       @subscriber = attributes["subscriber"]
       @mail = attributes["mail"]
       @company = attributes["company"]
-      @domain = attributes["domain"]
+      @domain = read_domain attributes["domain"]
 
       date_attribute_keys.each do |attr|
         value = attributes[attr]
@@ -171,6 +202,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)
@@ -199,7 +240,9 @@ module OpenProject
       value = attr.include?("version") ? attr["version"] : current_gem_version.to_s
       version = nil
 
-      if value.present? && value.to_s != "-1"
+      if value.to_s == "1"
+        version = 1
+      elsif value.present? && value.to_s != "-1"
         version = Gem::Version.new value
 
         if version > current_gem_version
@@ -210,6 +253,13 @@ module OpenProject
       version
     end
 
+    def read_domain(input)
+      return input if input.nil? || !(input.start_with?('/') && input.end_with?('/'))
+
+      # Omit the slashes of the input
+      Regexp.new input[1..-2]
+    end
+
     def date_attribute_keys
       %w(starts_at issued_at expires_at notify_admins_at notify_users_at block_changes_at)
     end
@@ -221,5 +271,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.3
+  version: 3.0.0
 platform: ruby
 authors:
 - OpenProject GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2023-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: OpenProject EE token reader