sonarqube 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e680fc94b776928413282ec95fba32c8fd7e51c4b5bc87a4bcf55c1d52278243
-  data.tar.gz: f50d05b8fdcae29c3012ece050e5a150b9ca34ccced8ae4d284a6a8cd7673695
+  metadata.gz: 36f0b9e09a5bfb9b12982dcd90c1d948b9b8f1f9208b7013df3f3e01abff6dd5
+  data.tar.gz: f40d3080cfe16333e36848d29085d1c2fd6931abc23c481eda5eaf9bda95235b
 SHA512:
-  metadata.gz: 55b07744ea669d652069d03647ccb2e8474b27c68d259590a777ab2738163188f0ce1f8010f4c46c671a38964fa2221498c18e690c49c8b1dddda403699da3cb
-  data.tar.gz: 379617da7805974463649b0d1379f08f9a6cc075ee840eb26b1466835e9e232e1b873420ec7d26352b8852c5ae5552ed30a0a18effdfb999af2658ab6cbf74ee
+  metadata.gz: d4386f5ea8015775811541b8eb725ae60b8489a8d1127ffa1445e95a4e01d0360001569897ab88f4691ad0b3c1cfe3973654c324f5bf011f36bc07f201e6216c
+  data.tar.gz: 4fe56aee93ffb543a2de3bbedac9560558265ab59f547225e23d8bfa4f7f9654150cb82927d026b9bad9c5e8b60a27100dceaf7b041ecea643b61aeb06fdf5c4

data/CHANGELOG.md

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

@@ -88,28 +88,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 +100,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

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

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sonarqube
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Mariani Lucas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-24 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -107,6 +107,7 @@ files:
 - lib/sonarqube/client.rb
 - lib/sonarqube/client/groups.rb
 - lib/sonarqube/client/projects.rb
+- lib/sonarqube/client/tokens.rb
 - lib/sonarqube/client/users.rb
 - lib/sonarqube/configuration.rb
 - lib/sonarqube/error.rb