sonarqube 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 226a939373b149524665b8094209ab3cf99df41f2e0392fdb8bc2c4741696e01
+  data.tar.gz: '08dd9fbb620105b33bba11f5847d25e4ea5c1f9be67ffcfab9dd2384ad58e4cb'
+SHA512:
+  metadata.gz: 4f98a82d09ff64eb1c241bf48985fb14152b943347fa30d5067dd3482f8e94099cc118b12b7f617f0430cbcd0c49a64cef49e910de4998b1d42b91316ebc4c81
+  data.tar.gz: 80f4924d4c7b9c921102e1f37bc267f7c1736603b7d62f2c4faba0444009caba931d95f65c74b11c2683ccc2ecbe1e1c8f33efa76ba26528e17dc7ef3761303d

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## CHANGELOG
+
+### Newer releases
+
+Please see: https://github.com/psyreactor/sonarqube-ruby/releases
+
+
+### 1.0.0 (19/08/2020)
+- 

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2020 Lucas Mariani <marianilucas@gmail.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,250 @@
+# Sonarqube
+
+[![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)
+[![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)
+
+[website](https://psyreactor.github.io/sonarqube) |
+[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.
+
+## Installation
+
+Install it from rubygems:
+
+```sh
+gem install sonarqube
+```
+
+Or add to a Gemfile:
+
+```ruby
+gem 'sonarqube'
+# gem 'sonarqube', github: 'psyreactor/sonarqube'
+```
+
+Mac OS users can install using Homebrew (may not be the latest version):
+
+```sh
+brew install sonarqube-gem
+```
+
+## Usage
+
+### Configuration example
+
+```ruby
+Sonarqube.configure do |config|
+  config.endpoint       = 'https://example.net:9000' # API endpoint URL, default: ENV['SONARQUBE_API_ENDPOINT']
+  config.private_token  = 'Dfrt938dSgAOWd4'       # user's private token, default: ENV['SONARQUBE_API_PRIVATE_TOKEN']
+  # Optional
+  # config.user_agent   = 'Custom User Agent'          # user agent, default: 'Sonarqube Ruby Gem [version]'
+end
+```
+
+### Usage examples
+
+```ruby
+# set an API endpoint
+Sonarqube.endpoint = 'https://example.net:9000'
+# => "https://example.net:9000"
+
+# set a user private token
+Sonarqube.private_token = 'Dfrt938dSgAOWd4'
+# => "Dfrt938dSgAOWd4"
+
+# configure a proxy server
+Sonarqube.http_proxy('proxyhost', 8888)
+# proxy server with basic auth
+Sonarqube.http_proxy('proxyhost', 8888, 'proxyuser', 'strongpasswordhere')
+# set timeout for responses
+ENV['SONARQUBE_API_HTTPARTY_OPTIONS'] = '{read_timeout: 60}'
+```
+
+### initialize a new client with custom headers
+```ruby
+g = Sonarqube.client(
+  endpoint: 'https://example.com:9000',
+  private_token: 'Dfrt938dSgAOWd4',
+  httparty: {
+    headers: { 'Cookie' => 'sonarqube_canary=true' }
+  }
+)
+# => #<Sonarqube::Client:0x00000001e62408 @endpoint="https://api.example.com", @private_token="qEsq1pt6HJPaNciie3MG", @user_agent="Sonarqube Ruby Gem 2.0.0">
+```
+
+### Projects
+
+#### Create Project
+```ruby
+project = Sonarqube.project_create('new_project')
+# => <Sonarqube::ObjectifiedHash:46200 {hash: {"project"=>{"key"=>"new_project", "name"=>"new_project", "qualifier"=>"TRK", "visibility"=>"public"}}}
+project.project.key
+# => "new_project"
+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
+```ruby
+user = Sonarqube.user_create('new_user', 'key_new_user' ,'secretpassword')
+# => #<Sonarqube::ObjectifiedHash:46320 {hash: {"user"=>{"login"=>"login_name", "name"=>"name_user", "scmAccounts"=>[], "active"=>true, "local"=>true}}}
+user.user.login
+# login_name
+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' })
+# => #<Sonarqube::ObjectifiedHash:46520 {hash: {"paging"=>{"pageIndex"=>1, "pageSize"=>100, "total"=>1}, "groups"=>[{"uuid"=>"AXOt93S3gMZPhbn-E_O7", "name"=>"sonar-users", "description"=>"Any new users created will automatically join this group", "membersCount"=>5, "default"=>true}]}}
+groups.groups.each do | group |
+  puts "name: #{group.name}"
+  puts "login: #{group.description}"
+  puts "membersCount: #{group.membersCount}"
+end
+# name: sonar-users
+# description: Any new users created will automatically join this group
+# MembersCount: 5
+```
+
+For more information, refer to [documentation](https://www.rubydoc.info/gems/sonarqube/frames).
+
+## Development
+
+### With a dockerized Sonarqube instance
+
+```shell
+docker-compose up -d sonarqube # Will start the Sonarqube instance in the background (approx. 3 minutes)
+```
+
+After a while, your Sonarqube instance will be accessible on http://localhost:9000.
+
+You can login with the admin/admin user/password.
+
+You can now setup a personal access token here: http://localhost:9000
+
+Once you have your token, set the variables to the correct values in the `docker.env` file.
+
+Then, launch the tool:
+
+```shell
+docker-compose run app
+```
+
+```ruby
+Sonarqube.users
+=> [#<Sonarqube::ObjectifiedHash:47231290771040 {hash: {"id"=>1, "name"=>"Administrator", "username"=>"root", ...]
+```
+
+To launch the specs:
+
+```shell
+docker-compose run app rake spec
+```
+
+
+### With an external Sonarqube instance
+
+First, set the variables to the correct values in the `docker.env` file.
+
+Then, launch the tool:
+
+```shell
+docker-compose run app
+```
+
+```ruby
+Sonarqube.users
+=> [#<Sonarqube::ObjectifiedHash:47231290771040 {hash: {"id"=>1, "name"=>"Administrator", "username"=>"root", ...]
+```
+
+To launch the specs,
+
+```shell
+docker-compose run app rake spec
+```
+
+For more information see [CONTRIBUTING.md](https://github.com/psyreactor/sonarqube/blob/master/CONTRIBUTING.md).
+
+## License
+
+Released under the BSD 2-clause license. See LICENSE.txt for details.

data/lib/sonarqube.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'sonarqube/version'
+require 'sonarqube/objectified_hash'
+require 'sonarqube/configuration'
+require 'sonarqube/error'
+require 'sonarqube/request'
+require 'sonarqube/api'
+require 'sonarqube/client'
+
+module Sonarqube
+  extend Configuration
+
+  # Alias for Sonarqube::Client.new
+  #
+  # @return [Sonarqube::Client]
+  def self.client(options = {})
+    Sonarqube::Client.new(options)
+  end
+
+  # Delegate to Sonarqube::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to Sonarqube::Client
+  def self.respond_to_missing?(method_name, include_private = false)
+    client.respond_to?(method_name) || super
+  end
+
+  # Delegate to HTTParty.http_proxy
+  def self.http_proxy(address = nil, port = nil, username = nil, password = nil)
+    Sonarqube::Request.http_proxy(address, port, username, password)
+  end
+
+  # Returns an unsorted array of available client methods.
+  #
+  # @return [Array<Symbol>]
+  def self.actions
+    hidden =
+      /endpoint|private_token|auth_token|user_agent|get|post|put|\Adelete\z|validate\z|request_defaults|httparty/
+    (Sonarqube::Client.instance_methods - Object.methods).reject { |e| e[hidden] }
+  end
+end

data/lib/sonarqube/api.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Sonarqube
+  # @private
+  class API < Request
+    # @private
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+    # @private
+    alias auth_token= private_token=
+
+    # Creates a new API.
+    # @raise [Error:MissingCredentials]
+    def initialize(options = {})
+      options = Sonarqube.options.merge(options)
+      (Configuration::VALID_OPTIONS_KEYS + [:auth_token]).each do |key|
+        send("#{key}=", options[key]) if options[key]
+      end
+      request_defaults
+      self.class.headers 'User-Agent' => user_agent
+    end
+  end
+end

data/lib/sonarqube/client.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Sonarqube
+  # Wrapper for the Sonarqube REST API.
+  class Client < API
+    Dir[File.expand_path('client/*.rb', __dir__)].each { |f| require f }
+
+    # Please keep in alphabetical order
+    include Groups
+    include Projects
+    include Users
+
+    # Text representation of the client, masking private token.
+    #
+    # @return [String]
+    def inspect
+      inspected = super
+      inspected.sub! @private_token, only_show_last_four_chars(@private_token) if @private_token
+      inspected
+    end
+
+    # Utility method for URL encoding of a string.
+    # Copied from https://ruby-doc.org/stdlib-2.7.0/libdoc/erb/rdoc/ERB/Util.html
+    #
+    # @return [String]
+    def url_encode(url)
+      url.to_s.b.gsub(/[^a-zA-Z0-9_\-.~]/n) { |m| sprintf('%%%02X', m.unpack1('C')) } # rubocop:disable Style/FormatString, Style/FormatStringToken
+    end
+
+    private
+
+    def only_show_last_four_chars(token)
+      "#{'*' * (token.size - 4)}#{token[-4..-1]}"
+    end
+  end
+end

data/lib/sonarqube/client/groups.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+class Sonarqube::Client
+  # Defines methods related to groups.
+  # @see https://SONAR_URL/web_api/api/user_groups
+  module Groups
+    # Search for user groups.
+    #
+    # @example
+    #   Sonarqube.groups_search
+    #   Sonarqube.groups_search({ ps: 3, p: 2 })
+    #   Sonarqube.groups_search({ ps: 3, p: 2 , q: sonar-users})
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :f Comma-separated list of the fields to be returned in response. All the fields are returned by default.
+    # @option options [Integer] :ps Page size number of projects to return per page
+    # @option options [Integer] :p The page to retrieve
+    # @option options [String] :q Limit search to names that contain the supplied string.
+    # (Any provided options will be passed to Sonarqube. See {https://SONAR_URL/web_api/api/user_groups/search}
+    # @return [Array<Sonarqube::ObjectifiedHash>]
+    def search_groups(options = {})
+      get('/api/user_groups/search', query: options)
+    end
+    alias groups_search search_groups
+
+    # Creates a new group.
+    #
+    # @example
+    #   Sonarqube.create_group('new-group')
+    #   Sonarqube.create_group('sonarqube', { description: 'New Sonarqube project' })
+    #
+    # @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.
+    def create_group(name, options = {})
+      body = { name: name }.merge(options)
+      post('/api/user_groups/create', body: body)
+    end
+    alias group_create create_group
+
+    # Delete's a group.
+    #
+    # @example
+    #   Sonarqube.delete_group('projecto')
+    #
+    # @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 })
+    end
+    alias group_delete delete_group
+
+    # Update group.
+    #
+    # @example
+    #   Sonarqube.group_members('AXQRcKrW9pRiZzanEJ2E')
+    #   Sonarqube.group_members('AXQRcKrW9pRiZzanEJ2E, { description: 'update group description })
+    #
+    # @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.
+    # @return [Array<Sonarqube::ObjectifiedHash>]
+    def update_group(id, options = {})
+      post('/api/user_groups/update', body: { id: id }.merge!(options))
+    end
+    alias group_update update_group
+
+    # Add a user to a group.
+    #
+    # @example
+    #   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  [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?
+
+      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.
+    #
+    # @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  [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?
+
+      post('/api/user_groups/remove_user', body: { id: id, login: login }.merge!(options))
+    end
+    alias member_remove remove_member
+
+    # List members of group.
+    #
+    # @example
+    #   Sonarqube.list_members({id: 'AXQRcKrW9pRiZzanEJ2E'})
+    #   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.
+    # @return [Sonarqube::ObjectifiedHash] Information about added team member.
+    def list_members(options = {})
+      raise ArgumentError, 'Missing required parameters' if options[:id].nil? && options[:name].nil?
+
+      get('/api/user_groups/users', query: options)
+    end
+
+    alias members_list list_members
+  end
+end

data/lib/sonarqube/client/projects.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+class Sonarqube::Client
+  # Defines methods related to projects.
+  # @see https://SONAR_URL/web_api/api/projects
+  module Projects
+    # Search for projects by name.
+    #
+    # @example
+    #   Sonarqube.project_search()
+    #   Sonarqube.project_search({ p: 2 })
+    #   Sonarqube.search_projects({ ps: 42, p: 5 })
+    #
+    # @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 [Boolean] :onProvisionedOnly Filter the projects that are provisioned
+    # @option options [Integer] :ps Page size number of projects to return per page
+    # @option options [Integer] :p The page to retrieve
+    # @option options [String] :qualifiers  Filter the results with the specified qualifiers (TRK,VW,APP)
+    # @option options [String] :q Limit search to component names that contain the supplied string or component keys that contain the supplied string
+    # @option options [String] :projects Comma-separated list of project keys
+    # (Any provided options will be passed to Sonarqube. See {https://SONAR_URL/web_api/api/projects/search}
+    # @return [Array<Sonarqube::ObjectifiedHash>]
+    def projects_search(options = {})
+      get('/api/projects/search', query: options)
+    end
+    alias search_projects projects_search
+
+    # Creates a new project.
+    #
+    # @example
+    #   Sonarqube.create_project('sonarqube','sonarqube)
+    #   Sonarqube.create_project('viking', 'ragnar' { visibility: 'private' })
+    #
+    # @param  [String] name The name of a project.
+    # @param  [String] key The key of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :visibility Visibility of a project (public or private).
+    # @return [Sonarqube::ObjectifiedHash] Information about created project.
+    def create_project(name, key = nil, options = {})
+      key = name if key.nil?
+      post('/api/projects/create', body: { name: name, project: key }.merge(options))
+    end
+
+    alias project_create create_project
+    # Deletes a project.
+    #
+    # @example
+    #   Sonarqube.delete_project(4)
+    #
+    # @param  [String] key The key of project.
+    # @return [Sonarqube::ObjectifiedHash] Information about deleted project.
+    def delete_project(key)
+      post('/api/projects/delete', body: { project: key })
+    end
+
+    alias project_delete delete_project
+    # Gets a list of project hooks.
+    #
+    # @example
+    #   Sonarqube.project_update_key(42)
+    #   Sonarqube.project_update_key('sonarqube')
+    #
+    # @param  [String] key_ori The original key of a project.
+    # @param  [String] key_new The New key of a project.
+    # @return [Array<Sonarqube::ObjectifiedHash>]
+    def project_update_key(key_ori, key_new)
+      post('/api/projects/update_key', body: { from: key_ori, to: key_new })
+    end
+
+    alias update_key_project project_update_key
+    # Gets a project hook.
+    #
+    # @example
+    #   Sonarqube.project_hook(42, 5)
+    #   Sonarqube.project_hook('sonarqube', 5)
+    #
+    # @param  [String] project The name fo project.
+    # @param  [String] visibility The visibility of a project.
+    # @return [Sonarqube::ObjectifiedHash]
+    def project_update_visibility(project, visibility)
+      post('/api/projects/update_visibility', body: { project: project, visibility: visibility })
+    end
+
+    alias update_visibility_project project_update_visibility
+    # Bulk delete projects.
+    #
+    # @example
+    #   Sonarqube.project_bulk_delete()
+    #   Sonarqube.project_bulk_delete({ p: 2 })
+    #   Sonarqube.project_bulk_delete({ ps: 42, p: 5 })
+    #
+    # @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 [Boolean] :onProvisionedOnly Filter the projects that are provisioned
+    # @option options [String] :qualifiers  Filter the results with the specified qualifiers (TRK,VW,APP)
+    # @option options [String] :q Limit search to component names that contain the supplied string or component keys that contain the supplied string
+    # @option options [String] :projects Comma-separated list of project keys
+    # (Any provided options will be passed to Sonarqube. See {https://SONAR_URL/web_api/api/projects/bulk_delete}
+    # @return [Array<Sonarqube::ObjectifiedHash>]
+    def projects_bulk_delete(options = {})
+      if options[:analyzedBefore].nil? && options[:projects].nil? && options[:q].nil?
+        raise ArgumentError, 'Missing required parameters'
+      end
+
+      post('/api/projects/bulk_delete', body: options)
+    end
+
+    alias delete_bulk_projects projects_bulk_delete
+  end
+end

data/lib/sonarqube/client/users.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+class Sonarqube::Client
+  # Defines methods related to users.
+  # @see https://SONAR_URL/web_api/api/users
+  module Users
+    # Gets a list of users.
+    #
+    # @example
+    #   Sonarqube.users_search()
+    #   Sonarqube.users_search(query: { p: 1, ps: 10 })
+    #   Sonarqube.users_search(query: { p: 1, ps: 10, q: 'sonarqube' })
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :ps Page size number of users to return per page
+    # @option options [Integer] :p The page to retrieve
+    # @option options [String] :q Filter on login, name and email
+    # @return [Array<Sonarqube::ObjectifiedHash>]
+    def users_search(options = {})
+      get('/api/users/search', query: options)
+    end
+
+    alias search_users users_search
+    # Creates a new user.
+    # Requires authentication from an admin account.
+    #
+    # @example
+    #   Sonarqube.create_user('joe', 'joe', 'secret', , { mail: 'joe@foo.org' })
+    #   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  [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.
+    # @option options [String] :scmAccount List of SCM accounts. To set several values, the parameter must be called once for each value.
+    # @param  [Hash] options A customizable set of options.
+    # @return [Sonarqube::ObjectifiedHash] Information about created user.
+    def create_user(login, name, password = nil, options = {})
+      body = { login: login, password: password, name: name }
+      body.merge!(options)
+      post('/api/users/create', body: body)
+    end
+
+    alias user_create create_user
+    # Updates a user.
+    #
+    # @example
+    #   Sonarqube.update_user('joe', { email: 'joe.smith@foo.org', name: 'Joe' })
+    #
+    # @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.
+    # @option options [String] :scmAccount SCM accounts. To set several values, the parameter must be called once for each value.
+    # @param  [Hash] options A customizable set of options.
+    # @return [Sonarqube::ObjectifiedHash] Information about update user.
+    def update_user(login, options = {})
+      post('/api/users/update', body: { login: login }.merge!(options))
+    end
+
+    alias user_update update_user
+    # Blocks the specified user. Available only for admin.
+    #
+    # @example
+    #   Sonarqube.block_user(15)
+    #
+    # @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))
+    end
+
+    alias user_deactivate deactivate_user
+    # Change password the specified user. Available only for admin.
+    #
+    # @example
+    #   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  [Hash] options A customizable set of options.
+    def change_password_user(login, password, old_password = nil, options = {})
+      body = { login: login, password: password }
+      body = { old_password: old_password }.merge!(body) unless old_password.nil?
+      post('/api/users/change_password', body: body.merge!(options))
+    end
+
+    alias user_change_password change_password_user
+    # Creates a new user session.
+    #
+    # @example
+    #   Sonarqube.session('jack@example.com', 'secret12345')
+    #
+    # @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 = {})
+      post('/api/users/update_login', body: { login: login, newLogin: new_login }.merge!(options))
+    end
+
+    alias user_update_login update_login_user
+    # Lists the groups a user belongs to.
+    #
+    # @example
+    #   Sonarqube.group_user
+    #
+    # @param  [String] login A customizable set of options.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @option options [String] :from The start date for paginated results.
+    # @return [Array<Sonarqube::ObjectifiedHash>]
+    def groups_user(login, options = {})
+      get('/api/users/groups', query: { login: login }.merge!(options))
+    end
+
+    alias user_groups groups_user
+  end
+end

data/lib/sonarqube/configuration.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Sonarqube
+  # Defines constants and methods related to configuration.
+  module Configuration
+    # An array of valid keys in the options hash when configuring a Sonarqube::API.
+    VALID_OPTIONS_KEYS = %i[endpoint private_token user_agent httparty].freeze
+
+    # The user agent that will be sent to the API endpoint if none is set.
+    DEFAULT_USER_AGENT = "Sonarqube Ruby Gem #{Sonarqube::VERSION}"
+
+    # @private
+    attr_accessor(*VALID_OPTIONS_KEYS)
+    # @private
+    alias auth_token= private_token=
+
+    # Sets all configuration options to their default values
+    # when this module is extended.
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block.
+    def configure
+      yield self
+    end
+
+    # Creates a hash of options and their values.
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Resets all configuration options to the defaults.
+    def reset
+      self.endpoint       = ENV['SONARQUBE_API_ENDPOINT']
+      self.private_token  = ENV['SONARQUBE_API_PRIVATE_TOKEN']
+      self.httparty       = get_httparty_config(ENV['SONARQUBE_API_HTTPARTY_OPTIONS'])
+      self.user_agent     = DEFAULT_USER_AGENT
+    end
+
+    private
+
+    # Allows HTTParty config to be specified in ENV using YAML hash.
+    def get_httparty_config(options)
+      return if options.nil?
+
+      httparty = Sonarqube::CLI::Helpers.yaml_load(options)
+      raise ArgumentError, 'HTTParty config should be a Hash.' unless httparty.is_a? Hash
+
+      Sonarqube::CLI::Helpers.symbolize_keys httparty
+    end
+  end
+end

data/lib/sonarqube/error.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Sonarqube
+  module Error
+    # Custom error class for rescuing from all Sonarqube errors.
+    class Error < StandardError; end
+
+    # Raised when API endpoint credentials not configured.
+    class MissingCredentials < Error; end
+
+    # Raised when impossible to parse response body.
+    class Parsing < Error; end
+
+    # Custom error class for rescuing from HTTP response errors.
+    class ResponseError < Error
+      POSSIBLE_MESSAGE_KEYS = %i[message error_description error].freeze
+
+      def initialize(response)
+        @response = response
+        super(build_error_message)
+      end
+
+      # Status code returned in the HTTP response.
+      #
+      # @return [Integer]
+      def response_status
+        @response.code
+      end
+
+      # Body content returned in the HTTP response
+      #
+      # @return [String]
+      def response_message
+        @response.parsed_response.message
+      end
+
+      # Additional error context returned by some API endpoints
+      #
+      # @return [String]
+      def error_code
+        if @response.respond_to?(:error_code)
+          @response.error_code
+        else
+          ''
+        end
+      end
+
+      private
+
+      # Human friendly message.
+      #
+      # @return [String]
+      def build_error_message
+        parsed_response = classified_response
+        message = check_error_keys(parsed_response)
+        "Server responded with code #{@response.code}, message: " \
+        "#{handle_message(message)}. " \
+        "Request URI: #{@response.request.base_uri}#{@response.request.path}"
+      end
+
+      # Error keys vary across the API, find the first key that the parsed_response
+      # object responds to and return that, otherwise return the original.
+      def check_error_keys(resp)
+        key = POSSIBLE_MESSAGE_KEYS.find { |k| resp.respond_to?(k) }
+        key ? resp.send(key) : resp
+      end
+
+      # Parse the body based on the classification of the body content type
+      #
+      # @return parsed response
+      def classified_response
+        if @response.respond_to?('headers')
+          @response.headers['content-type'] == 'text/plain' ? { message: @response.to_s } : @response.parsed_response
+        else
+          @response.parsed_response
+        end
+      rescue Sonarqube::Error::Parsing
+        # Return stringified response when receiving a
+        # parsing error to avoid obfuscation of the
+        # api error.
+        #
+        # note: The Sonarqube API does not always return valid
+        # JSON when there are errors.
+        @response.to_s
+      end
+
+      # Handle error response message in case of nested hashes
+      def handle_message(message)
+        case message
+        when Sonarqube::ObjectifiedHash
+          message.to_h.sort.map do |key, val|
+            "'#{key}' #{(val.is_a?(Hash) ? val.sort.map { |k, v| "(#{k}: #{v.join(' ')})" } : [val].flatten).join(' ')}"
+          end.join(', ')
+        when Array
+          message.join(' ')
+        else
+          message
+        end
+      end
+    end
+
+    # Raised when API endpoint returns the HTTP status code 400.
+    class BadRequest < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 401.
+    class Unauthorized < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 403.
+    class Forbidden < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 404.
+    class NotFound < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 405.
+    class MethodNotAllowed < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 406.
+    class NotAcceptable < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 409.
+    class Conflict < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 422.
+    class Unprocessable < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 429.
+    class TooManyRequests < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 500.
+    class InternalServerError < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 502.
+    class BadGateway < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 503.
+    class ServiceUnavailable < ResponseError; end
+
+    # HTTP status codes mapped to error classes.
+    STATUS_MAPPINGS = {
+      400 => BadRequest,
+      401 => Unauthorized,
+      403 => Forbidden,
+      404 => NotFound,
+      405 => MethodNotAllowed,
+      406 => NotAcceptable,
+      409 => Conflict,
+      422 => Unprocessable,
+      429 => TooManyRequests,
+      500 => InternalServerError,
+      502 => BadGateway,
+      503 => ServiceUnavailable
+    }.freeze
+  end
+end

data/lib/sonarqube/objectified_hash.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Sonarqube
+  # Converts hashes to the objects.
+  class ObjectifiedHash
+    # Creates a new ObjectifiedHash object.
+    def initialize(hash)
+      @hash = hash
+      @data = hash.each_with_object({}) do |(key, value), data|
+        value = self.class.new(value) if value.is_a? Hash
+        value = value.map { |v| v.is_a?(Hash) ? self.class.new(v) : v } if value.is_a? Array
+        data[key.to_s] = value
+      end
+    end
+
+    # @return [Hash] The original hash.
+    def to_hash
+      hash
+    end
+    alias to_h to_hash
+
+    # @return [String] Formatted string with the class name, object id and original hash.
+    def inspect
+      "#<#{self.class}:#{object_id} {hash: #{hash.inspect}}"
+    end
+
+    def [](key)
+      data[key]
+    end
+
+    private
+
+    attr_reader :hash, :data
+
+    # Respond to messages for which `self.data` has a key
+    def method_missing(method_name, *args, &block)
+      if data.key?(method_name.to_s)
+        data[method_name.to_s]
+      elsif data.respond_to?(method_name)
+        warn 'WARNING: Please convert ObjectifiedHash object to hash before calling Hash methods on it.'
+        data.send(method_name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      hash.keys.map(&:to_sym).include?(method_name.to_sym) || super
+    end
+  end
+end

data/lib/sonarqube/request.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'json'
+
+module Sonarqube
+  # @private
+  class Request
+    include HTTParty
+    format :json
+    headers 'Accept' => 'application/json', 'Content-Type' => 'application/x-www-form-urlencoded'
+    parser(proc { |body, _| parse(body) })
+
+    attr_accessor :private_token, :endpoint
+
+    # Converts the response body to an ObjectifiedHash.
+    def self.parse(body)
+      body = decode(body)
+
+      if body.is_a? Hash
+        ObjectifiedHash.new body
+      elsif body
+        true
+      elsif !body
+        false
+      elsif body.nil?
+        false
+      else
+        raise Error::Parsing, "Couldn't parse a response body"
+      end
+    end
+
+    # Decodes a JSON response into Ruby object.
+    def self.decode(response)
+      response ? JSON.load(response) : {}
+    rescue JSON::ParserError
+      raise Error::Parsing, 'The response is not a valid JSON'
+    end
+
+    %w[get post put delete].each do |method|
+      define_method method do |path, options = {}|
+        params = options.dup
+
+        httparty_config(params)
+
+        unless params[:unauthenticated]
+          params[:headers] ||= {}
+          params[:headers].merge!(authorization_header)
+        end
+
+        validate self.class.send(method, @endpoint + path, params)
+      end
+    end
+
+    # Checks the response code for common errors.
+    # Returns parsed response for successful requests.
+    def validate(response)
+      error_klass = Error::STATUS_MAPPINGS[response.code]
+      raise error_klass, response if error_klass
+
+      parsed = response.parsed_response
+      parsed.client = self if parsed.respond_to?(:client=)
+      parsed.parse_headers!(response.headers) if parsed.respond_to?(:parse_headers!)
+      parsed
+    end
+
+    # Sets a base_uri and default_params for requests.
+    # @raise [Error::MissingCredentials] if endpoint not set.
+    def request_defaults
+      raise Error::MissingCredentials, 'Please set an endpoint to API' unless @endpoint
+
+      self.class.default_params
+    end
+
+    private
+
+    # Returns an Authorization header hash
+    #
+    # @raise [Error::MissingCredentials] if private_token and auth_token are not set.
+    def authorization_header
+      raise Error::MissingCredentials, 'Please provide a private_token for user' unless @private_token
+
+      { 'Authorization' => "Basic #{Base64.encode64("#{private_token}:")}" }
+    end
+
+    # Set HTTParty configuration
+    # @see https://github.com/jnunemaker/httparty
+    def httparty_config(options)
+      options.merge!(httparty) if httparty
+    end
+  end
+end

data/lib/sonarqube/version.rb

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

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: sonarqube
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mariani Lucas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client for Sonarqube API
+email:
+- marianilucas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/sonarqube.rb
+- lib/sonarqube/api.rb
+- lib/sonarqube/client.rb
+- lib/sonarqube/client/groups.rb
+- lib/sonarqube/client/projects.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
+licenses:
+- BSD-2-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Sonarqube API
+test_files: []