openproject-token 1.0.2 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d055c8358ab2666105256d7a71247b3f0235e32ceaa6fb5588fe3af7846213ce
-  data.tar.gz: 2a9ca23046c2d5dd0d48ecaa232393b7598fe149bfacbb76eef5fdf6a435e741
+  metadata.gz: 1ed575580b33d7177820ffda871a4fd406f8fd43140703c1aad12ebcdbddde8c
+  data.tar.gz: e12c8de3670fd3088cfdca2d269dfd421ce64fc0a915d55ee0963519c62f81c0
 SHA512:
-  metadata.gz: 1d051dd136b1ab29adcc0604098fd365c2039152a6f299a548dc95bfc53021a74c4a61ff81a914f723d6620c2fd646993942450ba466f07ad6d5e0266aa441e5
-  data.tar.gz: fd21a30af2d6ee77bf8ce114ca0c95eeb3d8a656bcb3816bfdaa35b2a78d154843b13db896115f6dbd2f4d30e939b3aa900697b6a748e8e8f4b6c3fc1784ea86
+  metadata.gz: 1d7598d1e1190514985bcfc5c61377aac11fa6fff26a9d7acb3464436a1a7ac1cf3efc4d01eea6fcb8756025189458a6cf00c7e2d07721f245a1ce2378651037
+  data.tar.gz: 57d526430d85dda036614a71352e7bf677569f679e5c8314a42ff82411c033acbc7d17abd5d1500c4aaedbb9b9c622557152ae01eef503b2df1c8abe4e59fbb7

data/lib/open_project/token.rb

@@ -49,13 +49,15 @@ module OpenProject
     include ActiveModel::Validations
 
     attr_reader :version
-    attr_accessor :subscriber, :mail
+    attr_accessor :subscriber, :mail, :company, :domain
     attr_accessor :starts_at, :issued_at, :expires_at
     attr_accessor :notify_admins_at, :notify_users_at, :block_changes_at
     attr_accessor :restrictions
 
     validates_presence_of :subscriber
     validates_presence_of :mail
+    validates_presence_of :company, allow_blank: true
+    validates_presence_of :domain, if: :validate_domain?
 
     validates_each(
       :starts_at, :issued_at, :expires_at, :notify_admins_at, :notify_users_at, :block_changes_at,
@@ -104,6 +106,11 @@ module OpenProject
       will_block_changes? && Date.today >= self.block_changes_at
     end
 
+    # tokens with no version or a version lower than 2.0 don't have the attributes company or domain
+    def validate_domain?
+      version && Gem::Version.new(version) >= domain_required_from_version
+    end
+
     def restricted?(key = nil)
       if key
         restricted? && restrictions.has_key?(key)
@@ -118,6 +125,8 @@ module OpenProject
       hash["version"]          = self.version
       hash["subscriber"]       = self.subscriber
       hash["mail"]             = self.mail
+      hash["company"]          = self.company
+      hash["domain"]           = self.domain
 
       hash["issued_at"]        = self.issued_at
       hash["starts_at"]        = self.starts_at
@@ -147,17 +156,13 @@ module OpenProject
     def load_attributes(attributes)
       attributes = Hash[attributes.map { |k, v| [k.to_s, v] }]
 
-      version = attributes["version"] || 1
-      unless version && version == 1
-        raise ArgumentError, "Version is too new"
-      end
-
-      @version = version
+      @version = read_version attributes
       @subscriber = attributes["subscriber"]
       @mail = attributes["mail"]
+      @company = attributes["company"]
+      @domain = attributes["domain"]
 
-      %w(starts_at issued_at expires_at
-         notify_admins_at notify_users_at block_changes_at).each do |attr|
+      date_attribute_keys.each do |attr|
         value = attributes[attr]
         value = Date.parse(value) rescue nil if value.is_a?(String)
 
@@ -167,10 +172,54 @@ module OpenProject
       end
 
       restrictions = attributes["restrictions"]
+
       if restrictions && restrictions.is_a?(Hash)
         restrictions = Hash[restrictions.map { |k, v| [k.to_sym, v] }]
         @restrictions = restrictions
       end
     end
+
+    ##
+    # Reads the version from the given attributes hash.
+    # Besides the usual values it allows for a special value `-1`.
+    # This is then results in the version being `nil` specifically rather than
+    # the current gem version by default.
+    #
+    # This way the generated token will get what ever version the importing party
+    # has. This is important due to a bug in openproject-token 1.x where any version
+    # other than `nil` (or the integer literal 1) results in a "Version is too new" error.
+    # This affects all OpenProject installations with a version older than 10.6
+    # which will run into internal server errors trying to activate their Enterprise
+    # tokens due to this.
+    #
+    # Generating tokens with version `-1` prevents that.
+    #
+    # @param attr [Hash] Parsed token attributes.
+    def read_version(attr)
+      value = attr["version"]
+      version = nil
+
+      if value.present? && value.to_s != "-1"
+        version = Gem::Version.new value
+
+        if version > current_gem_version
+          raise ArgumentError, "Version is too new"
+        end
+      end
+
+      version
+    end
+
+    def date_attribute_keys
+      %w(starts_at issued_at expires_at notify_admins_at notify_users_at block_changes_at)
+    end
+
+    def current_gem_version
+      @current_gem_version ||= Gem::Version.new(OpenProject::Token::VERSION.to_s)
+    end
+
+    def domain_required_from_version
+      @domain_required_from_version ||= Gem::Version.new('2.0')
+    end
   end
 end

data/lib/open_project/token/version.rb

@@ -1,5 +1,5 @@
 module OpenProject
   class Token
-    VERSION = "1.0.2"
+    VERSION = "2.1.2"
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: openproject-token
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.1.2
 platform: ruby
 authors:
 - OpenProject GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-05 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +67,7 @@ files:
 - lib/openproject-token.rb
 homepage: https://www.openproject.org
 licenses:
-- GPLv3
+- GPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -70,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: OpenProject EE token reader