sonarqube 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 801fefe171e320dd14316a7c77780e29fcd1d48a42d0a72d95c82963dad8c295
-  data.tar.gz: 225697afc310666c0be1f710ed4be1f84d6e8fb16c2eddb66a19b170f279a74c
+  metadata.gz: 0f97d9312e91b553eececceee3faa5749c597a9410bd897e82d8790b967b6a43
+  data.tar.gz: 7e96a1dd2c6611cf1af13963e622137a84e377ed537230f5a818c98cb26fe737
 SHA512:
-  metadata.gz: f925f8ec8136457b91748054cf76a03a315187f0d7145163573821f8c5d2ab1d13c13f30e2afe0280f83e6fe4232c5fccd40e10803a03f86bcb44f66a4d061fb
-  data.tar.gz: 432d2e44abb168f23bc425c5e673edbea93bc06f55addd0a05863c734e5d2d4a5f1db812ea3c66595d2c46c5079d126c9b532099eca4892bd1789393af02dc8d
+  metadata.gz: 7c5b2bac929779842c7aee2c666faf33332d259a70ed749a4d7ee4edbaf523979c7f5bed6444586123ff9f09fe12f90a2bb6ca37250d7988318abd98883ed504
+  data.tar.gz: d4001184c48629d9c5c886868f70d42da634d4f279d630745899e20e6be51fae28f350514bc61447f019c236e20ed881588364fa761ae7fdf7287b09bbfc8050

data/lib/sonarqube/client/quality_gates.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+class Sonarqube::Client
+  # Defines methods related to tokens.
+  # @see https://SONAR_URL/web_api/api/qualitygates
+  module QualityGates
+    ALLOWED_OPERATORS = %w[LT GT].freeze
+    ALLOWED_METRICS = %w[
+      coverage new_coverage duplicated_lines_density
+      new_duplicated_lines_density reliability_rating new_reliability_rating
+      maintainability_rating new_maintainability_rating
+    ].freeze
+    # Create new quality gate.
+    #
+    # @example
+    #   Sonarqube.create_quality_gate('name_quality_gate')
+    #
+    #   # Gracefully continue if gate already exists
+    #   begin
+    #     Sonarqube.create_quality_gate('name_quality_gate')
+    #   rescue Sonarqube::Error::BadRequest => error
+    #     raise unless error.message =~ /Name has already been taken/
+    #   end
+    #
+    # @param  [String] name (required) Quality Gate name.
+    # @return [Sonarqube::ObjectifiedHash]
+    def create_quality_gate(name)
+      raise ArgumentError, 'Missing required parameters' if name.nil?
+
+      body = { name: name }
+      post('/api/qualitygates/create', body: body)
+    end
+    alias quality_gate_create create_quality_gate
+
+    # Create condition for a quality gate.
+    #
+    # @example
+    #   # Create a condition that errors when coverage is below 90%
+    #   Sonarqube.create_quality_gate_condition('name_quality_gate', 'coverage', '90')
+    #
+    #   # Create a condition that errors when code duplication is > 3%
+    #   Sonarqube.create_quality_gate_condition('name_quality_gate', 'duplicated_lines_density',
+    #                                           '3', 'GT')
+    #
+    # @param  [String] name (required) Quality Gate name.
+    # @param  [String] metric (required) SonarQube metric name.
+    # @param  [String] error_threshold (required) Error threshold value
+    # @param  [String] operator (required) Operator - LT for <; GT for >
+    # @return [Sonarqube::ObjectifiedHash]
+    def create_quality_gate_condition(name, metric, error_threshold, operator = 'LT')
+      raise ArgumentError, 'Missing required parameters' if name.nil? || metric.nil? || error_threshold.nil?
+      unless ALLOWED_OPERATORS.include?(operator)
+        raise ArgumentError, "Operator must be in #{ALLOWED_OPERATORS.join(', ')}"
+      end
+      raise ArgumentError, "Metric must be in #{ALLOWED_METRICS.join(', ')}" unless ALLOWED_METRICS.include?(metric)
+
+      body = {
+        gateName: name,
+        metric: metric,
+        error: error_threshold,
+        op: operator
+      }
+      post('/api/qualitygates/create_condition', body: body)
+    end
+    alias quality_gate_condition_create create_quality_gate_condition
+
+    # Set the default quality gate.
+    #
+    # @example
+    #   Sonarqube.set_default_quality_gate('name_quality_gate')
+    #
+    # @param  [String] name (required) Quality Gate name.
+    # @return [Sonarqube::ObjectifiedHash]
+    # rubocop:disable Naming/AccessorMethodName
+    def set_default_quality_gate(name)
+      raise ArgumentError, 'Missing required parameters' if name.nil?
+
+      body = { name: name }
+      post('/api/qualitygates/set_as_default', body: body)
+    end
+    # rubocop:enable Naming/AccessorMethodName
+    alias default_quality_gate_set set_default_quality_gate
+
+    # List quality gates.
+    #
+    # @example
+    #   Sonarqube.list_quality_gates
+    #
+    # @return [Sonarqube::ObjectifiedHash].
+    def list_quality_gates
+      get('/api/qualitygates/list')
+    end
+    alias quality_gates_list list_quality_gates
+  end
+end

data/lib/sonarqube/client.rb

@@ -9,6 +9,7 @@ module Sonarqube
     include Groups
     include Permissions
     include Projects
+    include QualityGates
     include Tokens
     include Users
 

data/lib/sonarqube/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sonarqube
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sonarqube
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Mariani Lucas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-08 00:00:00.000000000 Z
+date: 2021-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -108,6 +108,7 @@ files:
 - lib/sonarqube/client/groups.rb
 - lib/sonarqube/client/permissions.rb
 - lib/sonarqube/client/projects.rb
+- lib/sonarqube/client/quality_gates.rb
 - lib/sonarqube/client/tokens.rb
 - lib/sonarqube/client/users.rb
 - lib/sonarqube/configuration.rb
@@ -134,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper for the Sonarqube API