sonarqube 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36f0b9e09a5bfb9b12982dcd90c1d948b9b8f1f9208b7013df3f3e01abff6dd5
-  data.tar.gz: f40d3080cfe16333e36848d29085d1c2fd6931abc23c481eda5eaf9bda95235b
+  metadata.gz: 2243cd4ce1e3bccfd8852b3e288aa93e1a0d161457c3902265e2b3539384997a
+  data.tar.gz: 2059652b00336b55c9c4af3ea0d9d5eab29208f1944b5ae59b4f32c6fa5a9dd3
 SHA512:
-  metadata.gz: d4386f5ea8015775811541b8eb725ae60b8489a8d1127ffa1445e95a4e01d0360001569897ab88f4691ad0b3c1cfe3973654c324f5bf011f36bc07f201e6216c
-  data.tar.gz: 4fe56aee93ffb543a2de3bbedac9560558265ab59f547225e23d8bfa4f7f9654150cb82927d026b9bad9c5e8b60a27100dceaf7b041ecea643b61aeb06fdf5c4
+  metadata.gz: b55245ca6385f98e50e861fb7fd5fba42e06c70c7d488cae559bb1e69d66cd57784944c274b6d432ca9ddc57de8a638327fa71a44c127eae4b07f3238936444c
+  data.tar.gz: '0832fc8d69d1030b9e120e3463a3b59ddffd85dff8992331b8ad3ce7e49894b35dca566fa87cd0fc4d796553b3e8ea31fd0a856315484bac7934925c7d18dc89'

data/CHANGELOG.md

@@ -4,6 +4,17 @@
 
 Please see: https://github.com/psyreactor/sonarqube-ruby/releases
 
+### 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

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.0` this gem only supports Sonarqube 7.9.
 
 ## Installation
 

data/lib/sonarqube/client.rb

@@ -7,6 +7,7 @@ module Sonarqube
 
     # Please keep in alphabetical order
     include Groups
+    include Permissions
     include Projects
     include Tokens
     include Users

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sonarqube
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Mariani Lucas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-25 00:00:00.000000000 Z
+date: 2020-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -106,6 +106,7 @@ 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