gitlab-license 0.0.4 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 458edee6f3e0f3ef81ae4734cc63af70a667f383
-  data.tar.gz: 4adc60bab3dac96bee869135a3896731bf71a5d0
+SHA256:
+  metadata.gz: dc45d84ba41ec6f999cd4569cdf27b7acaf2476cf87c35e4121369633e1d3251
+  data.tar.gz: 5076ad7c092c002fbf727b8c16fefc41aeb836e1a150f82d311dd3e5b43cac25
 SHA512:
-  metadata.gz: 369ed3f123ac2cc4ea140234597f89d05c65f178f7c8e3312a2de17e3554c8838e473b1e6e76af54ee56963465283451a732c8bec4d44b04138ecad1ed72d86f
-  data.tar.gz: aec729297882d8ca53352a78fefec5748e83a18b40aea8734ac83a492d70fd6e0cccb2f841206505b4d38eb234500dd577ed116b8ff19794df3fd0f54f439a62
+  metadata.gz: ab4289143609c6f7d9a225d626b8a8c939e734b8eb39105a1994898b63854416ce2ab5b74ee1cc0dcbaee75c6eec28d5fe2a09a3f638ce08fa4b45b29b9af642
+  data.tar.gz: 9b1e46528d6d2309d40dfba3408fbff1e1edc93b5437ea7b354b08573eb0331a3dcb039b0bf996103a713e3e1470abfadf265c0435b2d33e567af07aa52fc71d

data/.rubocop.yml

@@ -0,0 +1,22 @@
+inherit_from: .rubocop_todo.yml
+
+require: rubocop-rspec
+
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+RSpec/MultipleExpectations:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,84 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-03-02 14:37:54 -0500 using RuboCop version 0.80.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 6
+Metrics/AbcSize:
+  Max: 36
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 129
+
+# Offense count: 3
+Metrics/CyclomaticComplexity:
+  Max: 16
+
+# Offense count: 5
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 38
+
+# Offense count: 3
+Metrics/PerceivedComplexity:
+  Max: 16
+
+# Offense count: 3
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/gitlab/license.rb'
+    - 'lib/gitlab/license/boundary.rb'
+    - 'lib/gitlab/license/encryptor.rb'
+
+# Offense count: 12
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'bin/console'
+    - 'gitlab-license.gemspec'
+    - 'lib/gitlab/license.rb'
+    - 'lib/gitlab/license/boundary.rb'
+    - 'lib/gitlab/license/encryptor.rb'
+    - 'lib/gitlab/license/version.rb'
+    - 'spec/gitlab/license/boundary_spec.rb'
+    - 'spec/gitlab/license/encryptor_spec.rb'
+    - 'spec/gitlab/license_spec.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/gitlab/license.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: short, verbose
+Style/PreferredHashMethods:
+  Exclude:
+    - 'lib/gitlab/license.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RescueModifier:
+  Exclude:
+    - 'lib/gitlab/license.rb'
+
+# Offense count: 14
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 104

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "gitlab/license"
+require 'bundler/setup'
+require 'gitlab/license'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "gitlab/license"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/gitlab-license.gemspec

@@ -1,24 +1,28 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gitlab/license/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "gitlab-license"
+  spec.name          = 'gitlab-license'
   spec.version       = Gitlab::License::VERSION
-  spec.authors       = ["Douwe Maan"]
-  spec.email         = ["douwe@gitlab.com"]
+  spec.authors       = ['Douwe Maan', 'Stan Hu', 'Tyler Amos']
+  spec.email         = ['douwe@gitlab.com', 'stanhu@gitlab.com', 'tamos@gitlab.com']
 
-  spec.summary       = %q{gitlab-license helps you generate, verify and enforce software licenses.}
-  spec.homepage      = "https://gitlab.com/gitlab-org/gitlab-license"
-  spec.license       = "MIT"
+  spec.summary       = 'gitlab-license helps you generate, verify and enforce software licenses.'
+  spec.homepage      = 'https://dev.gitlab.org/gitlab/gitlab-license'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "byebug"
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'rubocop', '~> 0.80.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.38.1'
 end

data/lib/gitlab/license.rb

@@ -1,11 +1,11 @@
-require "openssl"
-require "date"
-require "json"
-require "base64"
+require 'openssl'
+require 'date'
+require 'json'
+require 'base64'
 
-require "gitlab/license/version"
-require "gitlab/license/encryptor"
-require "gitlab/license/boundary"
+require 'gitlab/license/version'
+require 'gitlab/license/encryptor'
+require 'gitlab/license/boundary'
 
 module Gitlab
   class License
@@ -18,34 +18,31 @@ module Gitlab
       @encryption_key = nil
 
       def encryption_key=(key)
-        if key && !key.is_a?(OpenSSL::PKey::RSA)
-          raise ArgumentError, "No RSA encryption key provided."
-        end
+        raise ArgumentError, 'No RSA encryption key provided.' if key && !key.is_a?(OpenSSL::PKey::RSA)
 
         @encryption_key = key
+        @encryptor = nil
       end
 
       def encryptor
-        @encryptor ||= Encryptor.new(self.encryption_key)
+        @encryptor ||= Encryptor.new(encryption_key)
       end
 
       def import(data)
-        if data.nil?
-          raise ImportError, "No license data."
-        end
+        raise ImportError, 'No license data.' if data.nil?
 
         data = Boundary.remove_boundary(data)
 
         begin
           license_json = encryptor.decrypt(data)
         rescue Encryptor::Error
-          raise ImportError, "License data could not be decrypted."
+          raise ImportError, 'License data could not be decrypted.'
         end
 
         begin
           attributes = JSON.parse(license_json)
         rescue JSON::ParseError
-          raise ImportError, "License data is invalid JSON."
+          raise ImportError, 'License data is invalid JSON.'
         end
 
         new(attributes)
@@ -53,9 +50,9 @@ module Gitlab
     end
 
     attr_reader :version
-    attr_accessor :licensee, :starts_at, :expires_at
-    attr_accessor :notify_admins_at, :notify_users_at, :block_changes_at
-    attr_accessor :restrictions
+    attr_accessor :licensee, :starts_at, :expires_at, :notify_admins_at,
+                  :notify_users_at, :block_changes_at, :type, :last_synced_at,
+                  :next_sync_at, :restrictions
 
     alias_method :issued_at, :starts_at
     alias_method :issued_at=, :starts_at=
@@ -65,51 +62,69 @@ module Gitlab
     end
 
     def valid?
-      return false if !licensee         || !licensee.is_a?(Hash) || licensee.length == 0
-      return false if !starts_at        || !starts_at.is_a?(Date)
-      return false if expires_at        && !expires_at.is_a?(Date)
-      return false if notify_admins_at  && !notify_admins_at.is_a?(Date)
-      return false if notify_users_at   && !notify_users_at.is_a?(Date)
-      return false if block_changes_at  && !block_changes_at.is_a?(Date)
-      return false if restrictions      && !restrictions.is_a?(Hash)
-
-      true
+      if !licensee || !licensee.is_a?(Hash) || licensee.empty?
+        false
+      elsif !starts_at || !starts_at.is_a?(Date)
+        false
+      elsif expires_at && !expires_at.is_a?(Date)
+        false
+      elsif notify_admins_at && !notify_admins_at.is_a?(Date)
+        false
+      elsif notify_users_at && !notify_users_at.is_a?(Date)
+        false
+      elsif block_changes_at && !block_changes_at.is_a?(Date)
+        false
+      elsif last_synced_at && !last_synced_at.is_a?(DateTime)
+        false
+      elsif next_sync_at && !next_sync_at.is_a?(DateTime)
+        false
+      elsif type && type != 'cloud'
+        false
+      elsif restrictions && !restrictions.is_a?(Hash)
+        false
+      else
+        true
+      end
     end
 
     def validate!
-      raise ValidationError, "License is invalid" unless valid?
+      raise ValidationError, 'License is invalid' unless valid?
     end
 
     def will_expire?
-      self.expires_at
+      expires_at
     end
 
     def will_notify_admins?
-      self.notify_admins_at
+      notify_admins_at
     end
 
     def will_notify_users?
-      self.notify_users_at
+      notify_users_at
     end
 
     def will_block_changes?
-      self.block_changes_at
+      block_changes_at
+    end
+
+    def will_sync?
+      next_sync_at
     end
 
     def expired?
-      will_expire? && Date.today >= self.expires_at
+      will_expire? && Date.today >= expires_at
     end
 
     def notify_admins?
-      will_notify_admins? && Date.today >= self.notify_admins_at
+      will_notify_admins? && Date.today >= notify_admins_at
     end
 
     def notify_users?
-      will_notify_users? && Date.today >= self.notify_users_at
+      will_notify_users? && Date.today >= notify_users_at
     end
 
     def block_changes?
-      will_block_changes? && Date.today >= self.block_changes_at
+      will_block_changes? && Date.today >= block_changes_at
     end
 
     def restricted?(key = nil)
@@ -123,35 +138,37 @@ module Gitlab
     def attributes
       hash = {}
 
-      hash["version"]          = self.version
-      hash["licensee"]         = self.licensee
+      hash['version'] = version
+      hash['licensee'] = licensee
 
       # `issued_at` is the legacy name for starts_at.
       # TODO: Move to starts_at in a next version.
-      hash["issued_at"]        = self.starts_at
-      hash["expires_at"]       = self.expires_at       if self.will_expire?
+      hash['issued_at'] = starts_at
+      hash['expires_at'] = expires_at if 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?
-      hash["block_changes_at"] = self.block_changes_at if self.will_block_changes?
+      hash['notify_admins_at'] = notify_admins_at if will_notify_admins?
+      hash['notify_users_at'] = notify_users_at if will_notify_users?
+      hash['block_changes_at'] = block_changes_at if will_block_changes?
 
-      hash["restrictions"]     = self.restrictions     if self.restricted?
+      hash['next_sync_at'] = next_sync_at if will_sync?
+      hash['last_synced_at'] = last_synced_at if will_sync?
+      hash['type'] = type
+
+      hash['restrictions'] = restrictions if restricted?
 
       hash
     end
 
-    def to_json
-      JSON.dump(self.attributes)
+    def to_json(*_args)
+      JSON.dump(attributes)
     end
 
     def export(boundary: nil)
       validate!
 
-      data = self.class.encryptor.encrypt(self.to_json)
+      data = self.class.encryptor.encrypt(to_json)
 
-      if boundary
-        data = Boundary.add_boundary(data, boundary)
-      end
+      data = Boundary.add_boundary(data, boundary) if boundary
 
       data
     end
@@ -161,31 +178,41 @@ module Gitlab
     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 = attributes['version'] || 1
+      raise ArgumentError, 'Version is too new' unless version && version == 1
 
       @version = version
 
-      @licensee = attributes["licensee"]
+      @licensee = attributes['licensee']
+      @type = attributes['type']
 
       # `issued_at` is the legacy name for starts_at.
       # TODO: Move to starts_at in a next version.
-      %w(issued_at expires_at notify_admins_at notify_users_at block_changes_at).each do |attr|
-        value = attributes[attr]
-        value = Date.parse(value) rescue nil if value.is_a?(String)
-
-        next unless value
+      %w[issued_at expires_at notify_admins_at notify_users_at block_changes_at].each do |attr_name|
+        set_date_attribute(attr_name, attributes[attr_name])
+      end
 
-        send("#{attr}=", value)
+      %w[last_synced_at next_sync_at].each do |attr_name|
+        set_datetime_attribute(attr_name, attributes[attr_name])
       end
 
-      restrictions = attributes["restrictions"]
-      if restrictions && restrictions.is_a?(Hash)
+      restrictions = attributes['restrictions']
+      if restrictions&.is_a?(Hash)
         restrictions = Hash[restrictions.map { |k, v| [k.to_sym, v] }]
         @restrictions = restrictions
       end
     end
+
+    def set_date_attribute(attr_name, value, date_class = Date)
+      value = date_class.parse(value) rescue nil if value.is_a?(String)
+
+      return unless value
+
+      send("#{attr_name}=", value)
+    end
+
+    def set_datetime_attribute(attr_name, value)
+      set_date_attribute(attr_name, value, DateTime)
+    end
   end
 end

data/lib/gitlab/license/boundary.rb

@@ -15,9 +15,9 @@ module Gitlab
 
             padding = total_padding / 2.0
             [
-              "-" * padding.ceil,
+              '-' * padding.ceil,
               message,
-              "-" * padding.floor
+              '-' * padding.floor
             ].join
           end
 

data/lib/gitlab/license/encryptor.rb

@@ -8,17 +8,13 @@ module Gitlab
       attr_accessor :key
 
       def initialize(key)
-        if key && !key.is_a?(OpenSSL::PKey::RSA)
-          raise KeyError, "No RSA encryption key provided."
-        end
+        raise KeyError, 'No RSA encryption key provided.' if key && !key.is_a?(OpenSSL::PKey::RSA)
 
         @key = key
       end
 
       def encrypt(data)
-        unless key.private?
-          raise KeyError, "Provided key is not a private key."
-        end
+        raise KeyError, 'Provided key is not a private key.' unless key.private?
 
         # Encrypt the data using symmetric AES encryption.
         cipher = OpenSSL::Cipher::AES128.new(:CBC)
@@ -29,12 +25,12 @@ module Gitlab
         encrypted_data = cipher.update(data) + cipher.final
 
         # Encrypt the AES key using asymmetric RSA encryption.
-        encrypted_key = self.key.private_encrypt(aes_key)
+        encrypted_key = key.private_encrypt(aes_key)
 
         encryption_data = {
-          "data" => Base64.encode64(encrypted_data),
-          "key"  => Base64.encode64(encrypted_key),
-          "iv"   => Base64.encode64(aes_iv)
+          'data' => Base64.encode64(encrypted_data),
+          'key' => Base64.encode64(encrypted_key),
+          'iv' => Base64.encode64(aes_iv)
         }
 
         json_data = JSON.dump(encryption_data)
@@ -42,31 +38,29 @@ module Gitlab
       end
 
       def decrypt(data)
-        unless key.public?
-          raise KeyError, "Provided key is not a public key."
-        end
+        raise KeyError, 'Provided key is not a public key.' unless key.public?
 
         json_data = Base64.decode64(data.chomp)
 
         begin
           encryption_data = JSON.parse(json_data)
         rescue JSON::ParserError
-          raise DecryptionError, "Encryption data is invalid JSON."
+          raise DecryptionError, 'Encryption data is invalid JSON.'
         end
 
-        unless %w(data key iv).all? { |key| encryption_data[key] }
-          raise DecryptionError, "Required field missing from encryption data."
+        unless %w[data key iv].all? { |key| encryption_data[key] }
+          raise DecryptionError, 'Required field missing from encryption data.'
         end
 
-        encrypted_data  = Base64.decode64(encryption_data["data"])
-        encrypted_key   = Base64.decode64(encryption_data["key"])
-        aes_iv          = Base64.decode64(encryption_data["iv"])
+        encrypted_data  = Base64.decode64(encryption_data['data'])
+        encrypted_key   = Base64.decode64(encryption_data['key'])
+        aes_iv          = Base64.decode64(encryption_data['iv'])
 
         begin
           # Decrypt the AES key using asymmetric RSA encryption.
           aes_key = self.key.public_decrypt(encrypted_key)
         rescue OpenSSL::PKey::RSAError
-          raise DecryptionError, "AES encryption key could not be decrypted."
+          raise DecryptionError, 'AES encryption key could not be decrypted.'
         end
 
         # Decrypt the data using symmetric AES encryption.
@@ -74,21 +68,21 @@ module Gitlab
         cipher.decrypt
 
         begin
-          cipher.key  = aes_key
+          cipher.key = aes_key
         rescue OpenSSL::Cipher::CipherError
-          raise DecryptionError, "AES encryption key is invalid."
+          raise DecryptionError, 'AES encryption key is invalid.'
         end
 
         begin
-          cipher.iv   = aes_iv
+          cipher.iv = aes_iv
         rescue OpenSSL::Cipher::CipherError
-          raise DecryptionError, "AES IV is invalid."
+          raise DecryptionError, 'AES IV is invalid.'
         end
 
         begin
           data = cipher.update(encrypted_data) + cipher.final
         rescue OpenSSL::Cipher::CipherError
-          raise DecryptionError, "Data could not be decrypted."
+          raise DecryptionError, 'Data could not be decrypted.'
         end
 
         data

data/lib/gitlab/license/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   class License
-    VERSION = "0.0.4"
+    VERSION = '1.3.1'.freeze
   end
 end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-license
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.3.1
 platform: ruby
 authors:
 - Douwe Maan
+- Stan Hu
+- Tyler Amos
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-24 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +26,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,28 +55,60 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.38.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.38.1
 description: 
 email:
 - douwe@gitlab.com
+- stanhu@gitlab.com
+- tamos@gitlab.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -73,7 +121,7 @@ files:
 - lib/gitlab/license/boundary.rb
 - lib/gitlab/license/encryptor.rb
 - lib/gitlab/license/version.rb
-homepage: https://gitlab.com/gitlab-org/gitlab-license
+homepage: https://dev.gitlab.org/gitlab/gitlab-license
 licenses:
 - MIT
 metadata: {}
@@ -85,15 +133,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: gitlab-license helps you generate, verify and enforce software licenses.