sonarqube 1.0.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 226a939373b149524665b8094209ab3cf99df41f2e0392fdb8bc2c4741696e01
-  data.tar.gz: '08dd9fbb620105b33bba11f5847d25e4ea5c1f9be67ffcfab9dd2384ad58e4cb'
+  metadata.gz: 801fefe171e320dd14316a7c77780e29fcd1d48a42d0a72d95c82963dad8c295
+  data.tar.gz: 225697afc310666c0be1f710ed4be1f84d6e8fb16c2eddb66a19b170f279a74c
 SHA512:
-  metadata.gz: 4f98a82d09ff64eb1c241bf48985fb14152b943347fa30d5067dd3482f8e94099cc118b12b7f617f0430cbcd0c49a64cef49e910de4998b1d42b91316ebc4c81
-  data.tar.gz: 80f4924d4c7b9c921102e1f37bc267f7c1736603b7d62f2c4faba0444009caba931d95f65c74b11c2683ccc2ecbe1e1c8f33efa76ba26528e17dc7ef3761303d
+  metadata.gz: f925f8ec8136457b91748054cf76a03a315187f0d7145163573821f8c5d2ab1d13c13f30e2afe0280f83e6fe4232c5fccd40e10803a03f86bcb44f66a4d061fb
+  data.tar.gz: 432d2e44abb168f23bc425c5e673edbea93bc06f55addd0a05863c734e5d2d4a5f1db812ea3c66595d2c46c5079d126c9b532099eca4892bd1789393af02dc8d

data/CHANGELOG.md

@@ -4,6 +4,45 @@
 
 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
+  * Fix gemspec repo url
+
+### 1.0.1 (24/08/2020)
+
+- Fix
+  * Fix YARD comments
 
 ### 1.0.0 (19/08/2020)
-- 
+
+- New features
+  * Added support for users API
+  * Added support for user_groups API
+  * Added support for projects API
+
+ 

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

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

data/lib/sonarqube/client/groups.rb

@@ -29,7 +29,7 @@ class Sonarqube::Client
     #   Sonarqube.create_group('new-group')
     #   Sonarqube.create_group('sonarqube', { description: 'New Sonarqube project' })
     #
-    # @param  [String] name(required) The name of a group.
+    # @param  [String] name (required) The name of a group.
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :description Description for the new group. A group description cannot be larger than 200 characters.
     # @return [Sonarqube::ObjectifiedHash] Information about created group.
@@ -44,7 +44,7 @@ class Sonarqube::Client
     # @example
     #   Sonarqube.delete_group('projecto')
     #
-    # @param  [String] name(required) The name of a group
+    # @param  [String] name (required) The name of a group
     # @return [Sonarqube::ObjectifiedHash] Empty hash response.
     def delete_group(name)
       post('/api/user_groups/delete', body: { name: name })
@@ -57,7 +57,7 @@ class Sonarqube::Client
     #   Sonarqube.group_members('AXQRcKrW9pRiZzanEJ2E')
     #   Sonarqube.group_members('AXQRcKrW9pRiZzanEJ2E, { description: 'update group description })
     #
-    # @param  [String] id(required) The ID of a group.
+    # @param  [String] id (required) The ID of a group.
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :description New optional description for the group. A group description cannot be larger than 200 characters. If value is not defined, then description is not changed.
     # @option options [String] :name New optional name for the group. A group name cannot be larger than 255 characters and must be unique. Value 'anyone' (whatever the case) is reserved and cannot be used. If value is empty or not defined, then name is not changed.
@@ -73,31 +73,31 @@ class Sonarqube::Client
     #   Sonarqube.add_member('AXQRcKrW9pRiZzanEJ2E', 'test-user')
     #   Sonarqube.add_member('AXQRcKrW9pRiZzanEJ2E', 'test-user', {name: 'sonar-groups'})
     #
-    # @param  [String] id(required) The id of group.
-    # @param  [String] login(required) The login of user.
+    # @param  [String] id (required) The id of group.
+    # @param  [String] login (required) The login of user.
     # @param  [Hash] options A customizable set of options.
     # @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
     alias member_add add_member
 
-    # Reomve a user to a group.
+    # Remove a user to a group.
     #
     # @example
     #   Sonarqube.remove_member('AXQRcKrW9pRiZzanEJ2E', 'test-user')
     #   Sonarqube.remove_member('AXQRcKrW9pRiZzanEJ2E', 'test-user', {name: 'sonar-groups'})
     #
-    # @param  [String] id(required) The id of group.
-    # @param  [String] login(required) The login of user.
+    # @param  [String] id (required) The id of group.
+    # @param  [String] login (required) The login of user.
     # @param  [Hash] options A customizable set of options.
     # @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
@@ -110,8 +110,8 @@ class Sonarqube::Client
     #   Sonarqube.list_members({name: 'sonar-groups'})
     #
     # @param  [Hash] options A customizable set of options.
-    # @option options [String] :name(required) Name of group.
-    # @option options [String] :id(required) Id of group.
+    # @option options [String] :name (required) Name of group.
+    # @option options [String] :id (required) Id of group.
     # @return [Sonarqube::ObjectifiedHash] Information about added team member.
     def list_members(options = {})
       raise ArgumentError, 'Missing required parameters' if options[:id].nil? && options[:name].nil?

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

@@ -55,7 +55,7 @@ class Sonarqube::Client
     end
 
     alias project_delete delete_project
-    # Gets a list of project hooks.
+    # Update project key.
     #
     # @example
     #   Sonarqube.project_update_key(42)
@@ -69,11 +69,10 @@ class Sonarqube::Client
     end
 
     alias update_key_project project_update_key
-    # Gets a project hook.
+    # Update  project visibility.
     #
     # @example
-    #   Sonarqube.project_hook(42, 5)
-    #   Sonarqube.project_hook('sonarqube', 5)
+    #   project_update_visibility('sonarqube', 'public')
     #
     # @param  [String] project The name fo project.
     # @param  [String] visibility The visibility of a project.

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

@@ -29,9 +29,9 @@ class Sonarqube::Client
     #   or
     #   Sonarqube.create_user('joe', 'joe', 'secret')
     #
-    # @param  [String] name(required) The name of a user.
-    # @param  [String] login(required) The login of a user.
-    # @param  [String] password(required only is local user) The password of a user.
+    # @param  [String] name (required) The name of a user.
+    # @param  [String] login (required) The login of a user.
+    # @param  [String] password (required only is local user) The password of a user.
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :email The emails of a user.
     # @option options [String] :local Specify if the user should be authenticated from SonarQube server or from an external authentication system. Password should not be set when local is set to false.
@@ -50,7 +50,7 @@ class Sonarqube::Client
     # @example
     #   Sonarqube.update_user('joe', { email: 'joe.smith@foo.org', name: 'Joe' })
     #
-    # @param  [String] login(required) The login of a user
+    # @param  [String] login (required) The login of a user
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :email The email of a user.
     # @option options [String] :name The name of a user.
@@ -65,9 +65,9 @@ class Sonarqube::Client
     # Blocks the specified user. Available only for admin.
     #
     # @example
-    #   Sonarqube.block_user(15)
+    #   Sonarqube.deactivate_user('login')
     #
-    # @param [String] login(required) The login of a user
+    # @param [String] login (required) The login of a user
     # @param  [Hash] options A customizable set of options.
     def deactivate_user(login, options = {})
       post('/api/users/deactivate', body: { login: login }.merge!(options))
@@ -80,9 +80,9 @@ class Sonarqube::Client
     #   Sonarqube.change_password_user('joe', 'password')
     #   Sonarqube.change_password_user('admin', 'password', admin)
     #
-    # @param [String] login(required) The login of a user
-    # @param [String] password(required) New password for login
-    # @param [String] old_password(optional) Previous password. Required when changing one's own password.
+    # @param [String] login (required) The login of a user
+    # @param [String] password (required) New password for login
+    # @param [String] old_password (optional) Previous password. Required when changing one's own password.
     # @param  [Hash] options A customizable set of options.
     def change_password_user(login, password, old_password = nil, options = {})
       body = { login: login, password: password }
@@ -91,13 +91,13 @@ class Sonarqube::Client
     end
 
     alias user_change_password change_password_user
-    # Creates a new user session.
+    # Update login user.
     #
     # @example
-    #   Sonarqube.session('jack@example.com', 'secret12345')
+    #   Sonarqube.update_login_user('test', 'new_test')
     #
-    # @param  [String] login(required) The login of a user
-    # @param  [String] new_login(required) The new login of a user
+    # @param  [String] login (required) The login of a user
+    # @param  [String] new_login (required) The new login of a user
     # @param  [Hash] options A customizable set of options.
     # @return [Sonarqube::ObjectifiedHash]
     def update_login_user(login, new_login, options = {})
@@ -108,7 +108,7 @@ class Sonarqube::Client
     # Lists the groups a user belongs to.
     #
     # @example
-    #   Sonarqube.group_user
+    #   Sonarqube.group_user('login')
     #
     # @param  [String] login A customizable set of options.
     # @param  [Hash] options A customizable set of options.

data/lib/sonarqube/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sonarqube
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Mariani Lucas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-23 00:00:00.000000000 Z
+date: 2020-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -106,14 +106,16 @@ 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/tokens.rb
 - lib/sonarqube/client/users.rb
 - lib/sonarqube/configuration.rb
 - lib/sonarqube/error.rb
 - lib/sonarqube/objectified_hash.rb
 - lib/sonarqube/request.rb
 - lib/sonarqube/version.rb
-homepage: https://github.com/psyreactor/sonarqube-ruby
+homepage: https://github.com/psyreactor/sonarqube
 licenses:
 - BSD-2-Clause
 metadata: {}