sonarqube 1.0.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e680fc94b776928413282ec95fba32c8fd7e51c4b5bc87a4bcf55c1d52278243
-  data.tar.gz: f50d05b8fdcae29c3012ece050e5a150b9ca34ccced8ae4d284a6a8cd7673695
+  metadata.gz: 0f97d9312e91b553eececceee3faa5749c597a9410bd897e82d8790b967b6a43
+  data.tar.gz: 7e96a1dd2c6611cf1af13963e622137a84e377ed537230f5a818c98cb26fe737
 SHA512:
-  metadata.gz: 55b07744ea669d652069d03647ccb2e8474b27c68d259590a777ab2738163188f0ce1f8010f4c46c671a38964fa2221498c18e690c49c8b1dddda403699da3cb
-  data.tar.gz: 379617da7805974463649b0d1379f08f9a6cc075ee840eb26b1466835e9e232e1b873420ec7d26352b8852c5ae5552ed30a0a18effdfb999af2658ab6cbf74ee
+  metadata.gz: 7c5b2bac929779842c7aee2c666faf33332d259a70ed749a4d7ee4edbaf523979c7f5bed6444586123ff9f09fe12f90a2bb6ca37250d7988318abd98883ed504
+  data.tar.gz: d4001184c48629d9c5c886868f70d42da634d4f279d630745899e20e6be51fae28f350514bc61447f019c236e20ed881588364fa761ae7fdf7287b09bbfc8050

data/CHANGELOG.md

@@ -4,6 +4,30 @@
 
 Please see: https://github.com/psyreactor/sonarqube-ruby/releases
 
+### 1.2.1 (08/09/2020)
+
+- Fix
+  * Fix groups parameter validation
+
+### 1.2.0 (03/09/2020)
+
+- New features
+  * Added support for permissions API
+  * Added support for premissions internal API
+- Fix
+  * Fix Coverage
+  * Fix Documentation file name
+- New
+  * Guard config
+
+### 1.1.0 (24/08/2020)
+
+- New features
+  * Added support for users_token API
+- Fix
+  * Fix Readme
+  * Add site documentation
+
 ### 1.0.2 (24/08/2020)
 
 - Fix

data/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://img.shields.io/github/workflow/status/psyreactor/sonarqube/CI/master)](https://github.com/psyreactor/sonarqube/actions?query=workflow%3ARuby)
 [![Inline docs](https://inch-ci.org/github/psyreactor/sonarqube.svg)](https://inch-ci.org/github/psyreactor/sonarqube)
+[![Coverage Status](https://coveralls.io/repos/github/psyreactor/sonarqube/badge.svg)](https://coveralls.io/github/psyreactor/sonarqube)
 [![Gem version](https://img.shields.io/gem/v/sonarqube.svg)](https://rubygems.org/gems/sonarqube)
 [![License](https://img.shields.io/badge/license-BSD-red.svg)](https://github.com/psyreactor/sonarqube/blob/master/LICENSE.txt)
 
@@ -9,7 +10,7 @@
 [documentation](https://www.rubydoc.info/gems/sonarqube/frames)
 
 Sonarqube is a Ruby wrapper and CLI for the Sonarqube API
-As of version `1.0.0` this gem only supports Sonarqube 7.9.
+As of version `1.2.1` this gem only supports Sonarqube 7.9.
 
 ## Installation
 
@@ -88,28 +89,6 @@ project.to_hash
 # => {"project"=>{"key"=>"new_project", "name"=>"new_project", "qualifier"=>"TRK", "visibility"=>"public"}}
 ```
 
-#### Delete Project
-```ruby
-project = Sonarqube.project_delete('test')
-# => #<Sonarqube::ObjectifiedHash:46220 {hash: {}}
-project.to_hash.empty?
-# => true
-```
-
-#### Search Project
-```ruby
-projects = Sonarqube.project_search()
-# => #<Sonarqube::ObjectifiedHash:46240 {hash: {"paging"=>{"pageIndex"=>1, "pageSize"=>100, "total"=>2}, "components"=>[{"organization"=>"default-organization", "key"=>"old_key", "name"=>"new_proyect", "qualifier"=>"TRK", "visibility"=>"private"}, {"organization"=>"default-organization", "key"=>"test", "name"=>"test", "qualifier"=>"TRK", "visibility"=>"public"}]}}
-projects.components.each do | project |
-  puts "name: #{project.name}"
-  puts "key: #{project.key}"
-end
-# name: new_proyect
-# key: old_key
-# name: test
-# key: test
-```
-
 ### Users
 
 #### Create User
@@ -122,56 +101,9 @@ user.user.name
 # name_user
 ```
 
-#### Delete User
-```ruby
-user = Sonarqube.user_delete('test')
-# => #<Sonarqube::ObjectifiedHash:46220 {hash: {}}
-user.to_hash.empty?
-# => true
-```
-
-#### Search User
-```ruby
-users = Sonarqube.users_search()
-# => #<Sonarqube::ObjectifiedHash:46340 {hash: {"paging"=>{"pageIndex"=>1, "pageSize"=>50, "total"=>5}, "users"=>[{"login"=>"admin", "name"=>"Administrator", "active"=>true, "groups"=>["sonar-administrators", "sonar-users"], "tokensCount"=>1, "local"=>true, "externalIdentity"=>"admin", "externalProvider"=>"sonarqube", "lastConnectionDate"=>"2020-08-22T23:09:14+0000"}, {"login"=>"new_user", "name"=>"key_new_user", "active"=>true, "groups"=>["sonar-users"], "tokensCount"=>0, "local"=>true, "externalIdentity"=>"new_user", "externalProvider"=>"sonarqube"}, {"login"=>"login_name", "name"=>"name_user", "active"=>true, "groups"=>["sonar-users"], "tokensCount"=>0, "local"=>true, "externalIdentity"=>"login_name", "externalProvider"=>"sonarqube"}, {"login"=>"test3", "name"=>"test QA", "active"=>true, "groups"=>["sonar-users"], "tokensCount"=>0, "local"=>true, "externalIdentity"=>"test3", "externalProvider"=>"sonarqube"}, {"login"=>"newlogin", "name"=>"test QA", "active"=>true, "groups"=>["sonar-users"], "tokensCount"=>0, "local"=>true, "externalIdentity"=>"newlogin", "externalProvider"=>"sonarqube"}]}}
-users.users.each do | user |
-  puts "name: #{user.name}"
-  puts "login: #{user.login}"
-  puts "lastConection: #{user.lastConnectionDate}" if defined? user.lastConnectionDate
-end
-# name: Administrator
-# login: admin
-# lastConection: 2020-08-22T23:09:14+0000
-# name: key_new_user
-# login: new_user
-# name: name_user
-# login: login_name
-# name: test QA
-# login: test3
-# name: test QA
-# login: newlogin
-```
 
 ### Groups
 
-#### Create Group
-```ruby
-group = Sonarqube.create_group('New-Group', {description: 'Sonarqube group users'})
-# => #<Sonarqube::ObjectifiedHash:46500 {hash: {"group"=>{"uuid"=>"AXQYrrgCsrvdoo0YodNM", "organization"=>"default-organization", "name"=>"New-Group", "description"=>"Sonarqube group users", "membersCount"=>0, "default"=>false}}}
-group.group.uuid
-# AXQYrrgCsrvdoo0YodNM
-group.group.description
-# Sonarqube group users
-```
-
-#### Delete Group
-```ruby
-group = Sonarqube.group_delete('New-Group')
-# => #<Sonarqube::ObjectifiedHash:46220 {hash: {}}
-group.to_hash.empty?
-# => true
-```
-
 #### Search Group
 ```ruby
 groups = Sonarqube.search_groups({ q: 'sonar-users' })

data/lib/sonarqube/client/groups.rb

@@ -79,7 +79,7 @@ class Sonarqube::Client
     # @option options [String] :name Optional name of group.
     # @return [Sonarqube::ObjectifiedHash]
     def add_member(id = nil, login = nil, options = {})
-      raise ArgumentError, 'Missing required parameters' if id.nil? || login.nil?
+      raise ArgumentError, 'Missing required parameters' if id.nil? && login.nil?
 
       post('/api/user_groups/add_user', body: { id: id, login: login }.merge!(options))
     end
@@ -97,7 +97,7 @@ class Sonarqube::Client
     # @option options [String] :name Optional name of group.
     # @return [Sonarqube::ObjectifiedHash]
     def remove_member(id = nil, login = nil, options = {})
-      raise ArgumentError, 'Missing required parameters' if id.nil? || login.nil?
+      raise ArgumentError, 'Missing required parameters' if id.nil? && login.nil?
 
       post('/api/user_groups/remove_user', body: { id: id, login: login }.merge!(options))
     end

data/lib/sonarqube/client/permissions.rb

@@ -0,0 +1,237 @@
+# frozen_string_literal: true
+
+class Sonarqube::Client
+  # Defines methods related to permissions.
+  # @see https://SONAR_URL/web_api/api/permissions
+  module Permissions
+    # Add permission to a group.
+    #
+    # @example
+    # Sonarqube.permissions_add_group({ groupName: 'New-Group', permission: 'user', projectKey: 'test' })
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :groupId Id of group.
+    # @option options [String] :groupName Name of group.
+    # @option options [String] :permission Permission to asing to group. global permissions: admin, profileadmin, gateadmin, scan, provisioning |  project permissions: admin, codeviewer, issueadmin, securityhotspotadmin, scan, user
+    # @option options [String] :projectId Id of project, only apply for project permissions.
+    # @option options [String] :projectKey Key of project, only apply for project permissions.
+    # (Any provided options will be passed to Sonarqube. See {https://SONAR_URL/web_api/api/permissions/add_group}
+    # @return [<Sonarqube::ObjectifiedHash>]
+    def permission_add_group(options = {})
+      options.transform_keys(&:to_sym)
+      raise ArgumentError, 'Missing required parameters' if options[:groupId].nil? && options[:groupName].nil?
+
+      post('/api/permissions/add_group', body: options)
+    end
+    alias add_group_permission permission_add_group
+
+    # Add group to template.
+    #
+    # @example
+    # Sonarqube.add_group_to_template({ groupName: 'New-Group', permission: 'user', templateName: 'test' })
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :groupId Id of group.
+    # @option options [String] :groupName Name of group.
+    # @option options [String] :permission Permission to asing to group. global permissions: admin, profileadmin, gateadmin, scan, provisioning |  project permissions: admin, codeviewer, issueadmin, securityhotspotadmin, scan, user
+    # @option options [String] :templateId Id of template.
+    # @option options [String] :templateName Name of template.
+    # (Any provided options will be passed to Sonarqube. See {https://SONAR_URL/web_api/api/permissions/add_group_to_template}
+    # @return [<Sonarqube::ObjectifiedHash>]
+    def add_group_to_template(options = {})
+      options.transform_keys(&:to_sym)
+      raise ArgumentError, 'Missing required parameters' if options[:groupId].nil? && options[:groupName].nil?
+
+      post('/api/permissions/add_group_to_template', body: options)
+    end
+
+    # Add project creator to template.
+    #
+    # @example
+    # Sonarqube.add_project_creator_to_template('issueadmin', { templateName: 'test' })
+    #
+    # @param [String] :permission Permission to asing to group. global permissions: admin, profileadmin, gateadmin, scan, provisioning |  project permissions: admin, codeviewer, issueadmin, securityhotspotadmin, scan, user
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :templateId Id of template.
+    # @option options [String] :templateName Name of template.
+    # (Any provided options will be passed to Sonarqube. See {https://SONAR_URL/web_api/api/permissions/add_project_creator_to_template}
+    # @return [<Sonarqube::ObjectifiedHash>]
+    def add_project_creator_to_template(permission, options = {})
+      raise ArgumentError, 'Missing required parameters' if permission.nil?
+
+      post('/api/permissions/add_project_creator_to_template', body: { permission: permission }.merge!(options))
+    end
+
+    # Add permissions to user.
+    #
+    # @example
+    # Sonarqube.permission_add_user('new_user', 'issueadmin', { projectKey: 'test' })
+    #
+    # @param  [String] :login Name of login user.
+    # @param  [String] :permission Permission to asing to group. global permissions: admin, profileadmin, gateadmin, scan, provisioning |  project permissions: admin, codeviewer, issueadmin, securityhotspotadmin, scan, user
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :projectId Id of project, only apply for project permissions.
+    # @option options [String] :projectKey Key of project, only apply for project permissions.
+    # (Any provided options will be passed to Sonarqube. See {https://SONAR_URL/web_api/api/permissions/add_user}
+    # @return [<Sonarqube::ObjectifiedHash>]
+    def permission_add_user(login, permission, options = {})
+      options.transform_keys(&:to_sym)
+      raise ArgumentError, 'Missing required parameters' if login.nil? && permission.nil?
+
+      body = { login: login, permission: permission }.merge!(options)
+      post('/api/permissions/add_user', body: body)
+    end
+    alias add_user_permission permission_add_user
+
+    # Add user to template.
+    #
+    # @example
+    # Sonarqube.add_user_to_template({ 'new_user', 'issueadmin', { templateName: 'test' })
+    #
+    # @param  [String] :login Name of login user.
+    # @param  [String] :permission Permission to asing to group. global permissions: admin, profileadmin, gateadmin, scan, provisioning |  project permissions: admin, codeviewer, issueadmin, securityhotspotadmin, scan, user.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :templateId Id of template.
+    # @option options [String] :templateName Name of template.
+    # (Any provided options will be passed to Sonarqube. See {https://SONAR_URL/web_api/api/permissions/add_user_to_template}
+    # @return [<Sonarqube::ObjectifiedHash>]
+    def add_user_to_template(login, permission, options = {})
+      options.transform_keys(&:to_sym)
+      raise ArgumentError, 'Missing required parameters' if login.nil? && permission.nil?
+
+      body = { login: login, permission: permission }.merge!(options)
+      post('/api/permissions/add_user_to_template', body: body)
+    end
+
+    # Apply template.
+    #
+    # @example
+    # Sonarqube.apply_template({ projectName: 'New-Group', templateName: 'test' })
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :projectId Id of group.
+    # @option options [String] :projectName Name of group.
+    # @option options [String] :templateId Id of template.
+    # @option options [String] :templateName Name of template.
+    # (Any provided options will be passed to Sonarqube. See {https://SONAR_URL/web_api/api/permissions/apply_template}
+    # @return [<Sonarqube::ObjectifiedHash>]
+    def apply_template(options = {})
+      options.transform_keys(&:to_sym)
+
+      post('/api/permissions/apply_template', body: options)
+    end
+
+    # Bulk apply template.
+    #
+    # @example
+    # Sonarqube.bulk_apply_template({ templateName: 'test', projects: 'my_project,another_project' })
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :analyzedBefore Filter the projects for which last analysis is older than the given date .
+    # @option options [String] :onProvisionedOnly Filter the projects that are provisioned.
+    # @option options [String] :projects Comma-separated list of project keys maximum 1000
+    # @option options [String] :q serach project names that contain the supplied string and project keys that are exactly the same as the supplied string
+    # @option options [String] :qualifiers Comma-separated list of component qualifiers. Filter the results with the specified qualifiers.
+    # @option options [String] :templateId Id of template.
+    # @option options [String] :templateName Name of template.
+    # (Any provided options will be passed to Sonarqube. See {https://SONAR_URL/web_api/api/permissions/bulk_apply_template}
+    # @return [<Sonarqube::ObjectifiedHash>]
+    def bulk_apply_template(options = {})
+      options.transform_keys(&:to_sym)
+
+      post('/api/permissions/bulk_apply_template', body: options)
+    end
+
+    # Create template.
+    #
+    # @example
+    # Sonarqube.create_template('template_name', 'description', '.*\.finance\..*')
+    #
+    # @param [String] :name Name of template.
+    # @param [String] :project_key_pattern Project key pattern. Must be a valid Java regular expression.
+    # @param [String] :description Description of template.
+    # (Any provided options will be passed to Sonarqube. See {https://SONAR_URL/web_api/api/permissions/create_template}
+    # @return [<Sonarqube::ObjectifiedHash>]
+    def create_template(name, description, project_key_pattern)
+      body = { name: name, description: description, projectKeyPattern: project_key_pattern }
+      post('/api/permissions/create_template', body: body)
+    end
+
+    # Delete template.
+    #
+    # @example
+    # Sonarqube.create_template({ templateName: 'template_name' })
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :templateId Id of template.
+    # @option options [String] :templateName Name of template.
+    # (Any provided options will be passed to Sonarqube. See {https://SONAR_URL/web_api/api/permissions/delete_template}
+    # @return [<Sonarqube::ObjectifiedHash>]
+    def delete_template(options = {})
+      options.transform_keys(&:to_sym)
+      raise ArgumentError, 'Missing required parameters' if options[:templateName].nil? && options[:templateId].nil?
+
+      post('/api/permissions/delete_template', body: options)
+    end
+
+    # Remove permission to a group.
+    #
+    # @example
+    # Sonarqube.permissions_add_group({ groupName: 'New-Group', permission: permission, projectKey: 'test' })
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :groupId Id of group.
+    # @option options [String] :groupName Name of group.
+    # @option options [String] :permission Permission to asing to group. global permissions: admin, profileadmin, gateadmin, scan, provisioning |  project permissions: admin, codeviewer, issueadmin, securityhotspotadmin, scan, user
+    # @option options [String] :projectId Id of project, only apply for project permissions.
+    # @option options [String] :projectKey Key of project, only apply for project permissions.
+    # (Any provided options will be passed to Sonarqube. See {https://SONAR_URL/web_api/api/permissions/remove_group}
+    # @return [<Sonarqube::ObjectifiedHash>]
+    def permission_remove_group(options = {})
+      options.transform_keys(&:to_sym)
+      raise ArgumentError, 'Missing required parameters' if options[:groupId].nil? && options[:groupName].nil?
+
+      post('/api/permissions/remove_group', body: options)
+    end
+    alias remove_group_permission permission_remove_group
+
+    # Remove group from template.
+    #
+    # @example
+    # Sonarqube.remove_group_from_template({ groupName: 'New-Group', permission: 'permission', templateId: 'test' })
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :groupId Id of group.
+    # @option options [String] :groupName Name of group.
+    # @option options [String] :permission Permission to asing to group. global permissions: admin, profileadmin, gateadmin, scan, provisioning |  project permissions: admin, codeviewer, issueadmin, securityhotspotadmin, scan, user
+    # @option options [String] :TemplateId Id of template.
+    # @option options [String] :TemplateName Name of template.
+    # (Any provided options will be passed to Sonarqube. See {https://SONAR_URL/web_api/api/permissions/remove_group_from_template}
+    # @return [<Sonarqube::ObjectifiedHash>]
+    def remove_group_from_template(options = {})
+      post('/api/permissions/remove_group_from_template', body: options)
+    end
+
+    # Lists the groups with their permissions
+    #
+    # @example
+    # Sonarqube.permission_list_group({ q: 'test', projectsKey: 'project' })
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :organization Key of organization, used when group name is set
+    # @option options [String] :p 1-based page number.
+    # @option options [String] :permission Possible values for global permissions or values for project permissions.
+    # @option options [String] :q Limit search to group names that contain the supplied string.
+    # @option options [String] :ps Page size. Must be greater than 0 and less or equal than 100
+    # @option options [String] :projectId Id of project.
+    # @option options [String] :projectKey Key of project.
+    # (Any provided options will be passed to Sonarqube. See {https://SONAR_URL/web_api/api/permissions/groups?internal=true}
+    # @return [<Sonarqube::ObjectifiedHash>]
+    def permission_list_group(options = {})
+      options.transform_keys(&:to_sym)
+
+      get('/api/permissions/groups', quey: options)
+    end
+    alias list_group_permission permission_list_group
+  end
+end

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/tokens.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class Sonarqube::Client
+  # Defines methods related to tokens.
+  # @see https://SONAR_URL/web_api/api/user_tokens
+  module Tokens
+    # Create token for user.
+    #
+    # @example
+    #   Sonarqube.create_token('name_token')
+    #   Sonarqube.create_token('name_token', 'login_name')
+    #
+    # @param  [String] name (required) Token name.
+    # @param  [String] login (optional) Login user name.
+    # @return [Sonarqube::ObjectifiedHash]
+    def create_token(name, login = nil)
+      raise ArgumentError, 'Missing required parameters' if name.nil?
+
+      body = { name: name }
+      body = { login: login }.merge!(body) unless login.nil?
+      post('/api/user_tokens/generate', body: body)
+    end
+    alias token_create create_token
+
+    # Revoke a token.
+    #
+    # @example
+    #   Sonarqube.revoke_token('new-group')
+    #   Sonarqube.revoke_token('sonarqube', { description: 'New Sonarqube project' })
+    #
+    # @param  [String] name (required) Token name.
+    # @param  [String] login (optional) Login user name.
+    # @return [Sonarqube::ObjectifiedHash] Empty hash response.
+    def revoke_token(name, login = nil)
+      raise ArgumentError, 'Missing required parameters' if name.nil?
+
+      body = { name: name }
+      body = { login: login }.merge!(body) unless login.nil?
+      post('/api/user_tokens/revoke', body: body)
+    end
+    alias token_revoke revoke_token
+
+    # List token for user.
+    #
+    # @example
+    #   Sonarqube.list_token('login')
+    #
+    # @param  [String] login (required) The login name of user
+    # @return [Sonarqube::ObjectifiedHash].
+    def list_tokens(login)
+      raise ArgumentError, 'Missing required parameters' if login.nil?
+
+      get('/api/user_tokens/search', query: { login: login })
+    end
+    alias tokens_list list_tokens
+  end
+end

data/lib/sonarqube/client.rb

@@ -7,7 +7,10 @@ module Sonarqube
 
     # Please keep in alphabetical order
     include Groups
+    include Permissions
     include Projects
+    include QualityGates
+    include Tokens
     include Users
 
     # Text representation of the client, masking private token.

data/lib/sonarqube/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sonarqube
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Mariani Lucas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-24 00:00:00.000000000 Z
+date: 2021-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -106,7 +106,10 @@ files:
 - lib/sonarqube/api.rb
 - lib/sonarqube/client.rb
 - 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
 - lib/sonarqube/error.rb
@@ -132,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