sonarqube 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 226a939373b149524665b8094209ab3cf99df41f2e0392fdb8bc2c4741696e01
-  data.tar.gz: '08dd9fbb620105b33bba11f5847d25e4ea5c1f9be67ffcfab9dd2384ad58e4cb'
+  metadata.gz: ba2aa4fbcd9ee7798aa7b97b73469c91f8090dfe2de3157f167e2311c6e8a56e
+  data.tar.gz: 6bd2accd7888f5aa574e63a77ec7ea188db2936c6cfd36cbf12bdb6095a25429
 SHA512:
-  metadata.gz: 4f98a82d09ff64eb1c241bf48985fb14152b943347fa30d5067dd3482f8e94099cc118b12b7f617f0430cbcd0c49a64cef49e910de4998b1d42b91316ebc4c81
-  data.tar.gz: 80f4924d4c7b9c921102e1f37bc267f7c1736603b7d62f2c4faba0444009caba931d95f65c74b11c2683ccc2ecbe1e1c8f33efa76ba26528e17dc7ef3761303d
+  metadata.gz: e1a0fb6328cee65b598e7d633dc1dd3cfd11e313755e7b03fdce5946297d65bb09c498c7f3796b43fbad53cb8511c2d4284ff9b1d3a02e500524e3261b91c780
+  data.tar.gz: 2e6890ae9d74965df7dedc6978c5b7d736614b6a683fcc92bd5c109777a945c7d3682a8d4ca4be7c8c4cefd15a5cd98dc8087d31c489a8b7c633948c629b883b

data/CHANGELOG.md

@@ -4,6 +4,16 @@
 
 Please see: https://github.com/psyreactor/sonarqube-ruby/releases
 
+### 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/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,8 +73,8 @@ 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]
@@ -85,14 +85,14 @@ class Sonarqube::Client
     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]
@@ -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/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/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.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sonarqube
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Mariani Lucas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-23 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty