sonarqube-client 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e5c848304338dee76e0a4b1b08c46efdc7c3061
+  data.tar.gz: ce4957d40b5a6eaaf651d3c9edf0deefc2d4df71
+SHA512:
+  metadata.gz: 66ae5d99b34c55cdb05c6e70bf74601268de8cdd570ad9adb8c933bbddc72b53cf9f890ca2080b681b40abfcaf73f88f91b16091c62489d5caf676dc6c2dc545
+  data.tar.gz: 8662428d509991e30ca8bb1c7a262866674c4caa26cf67146f7323e93b5f8c4fc0fe185a7875f9ec390ed8f68be36a8cbc00dbcd4197b544228eb4ca7eccc04e

data/lib/sonarqube-client.rb

@@ -0,0 +1,84 @@
+# Copyright (C) 2016 Dimitrios Dimas <dimitrios.work@outlook.com>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+
+require 'rest-client'
+require 'nokogiri'
+require 'json'
+require 'logger'
+
+require File.dirname(__FILE__) + '/sonarqube/client.rb'
+require File.dirname(__FILE__) + '/sonarqube/issues.rb'
+require File.dirname(__FILE__) + '/sonarqube/logger.rb'
+require File.dirname(__FILE__) + '/sonarqube/projects.rb'
+require File.dirname(__FILE__) + '/sonarqube/timemachine.rb'
+require File.dirname(__FILE__) + '/sonarqube/version.rb'
+
+
+
+
+
+module SonarQube
+
+  #@@logger=SonarQube::Logger::Logger.new
+
+
+  class SonarQube
+    def initialize server_url, username='', password=''
+      if [username, password].reduce(:+) == ''
+        @connector=RestClient::Resource.new(server_url)      
+      else
+        @connector=RestClient::Resource.new(server_url, username, password)      
+      end
+    end
+    
+    #Returns a timemachine object, can also be used to invoke timemachine methods without having to explicitly initialize/store an object
+    # @example my_tm = SonarQube.timemachine
+    #   or if we don't want a persistent object: 
+    # @example puts \"coverage for my project is: \#\\{SonarQube.timemachine.get(my_awesome_project, coverage)\}\"
+    # @return [TimeMachine::TimeMachine]
+    def timemachine
+      TimeMachine::TimeMachine.new(@connector)
+    end
+    
+    #Returns a projects object, can also be used to invoke projects methods without having to explicitly initialize/store an object
+    # @example my_proj = SonarQube.projects
+    #   or if we don't want a persistent object: 
+    # @example puts \"available projects are: \#\\{SonarQube.projects.list\}\"
+    # @return [TimeMachine::TimeMachine]
+    def projects
+      Projects::Projects.new(@connector)
+    end
+    
+    #Returns an issues object, can also be used to invoke issues methods without having to explicitly initialize/store an object
+    # @example issues = SonarQube.issues
+    #   or if we don't want a persistent object: 
+    # @example puts \"the list with all the issues is: \#\\{SonarQube.issues.get\}\"
+    # @return [TimeMachine::TimeMachine]
+    def issues
+      Issues::Issues.new(@connector)
+    end
+  end
+  
+  def sonarqube(server_url, username='', password='')
+    if [username, password].reduce(:+) == ''
+      proc {|endpoint| RestClient::Resource.new server_url + endpoint}.curry
+    else
+      proc {|endpoint| RestClient::Resource.new server_url + endpoint, a, b}.curry
+    end
+  end
+
+end

data/lib/sonarqube/client.rb

@@ -0,0 +1,32 @@
+# Copyright (C) 2016 Dimitrios Dimas <dimitrios.work@outlook.com>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+module SonarQube
+  module Client
+    
+    def connect(server_url, username='', password='')
+      RestClient::Resource.new(server_url, username, password)
+    end
+    
+    def initialize(server_url, username='', password='')
+      if username + password == ''
+        proc {|endpoint| RestClient::Resource.new server_url+endpoint}.curry
+      else
+        proc {|endpoint| RestClient::Resource.new server_url+endpoint, a, b}.curry
+      end
+    end
+  end
+end

data/lib/sonarqube/issues.rb

@@ -0,0 +1,113 @@
+# Copyright (C) 2016 Dimitrios Dimas <dimitrios.work@outlook.com>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+module SonarQube
+  module Issues
+
+    class Issues 
+      @@endpoint='api/issues/'
+      
+      #Constructor
+      #
+      # @param [RestClient::Resource] connector The rest-client resource object
+      #
+      def initialize connector
+        @connector=connector
+      end
+      
+      #Search for issues by name
+      #
+      # @param names The key or keys (comma-separated list) to be used in the search
+      # @return A JSON object, containing all the issues found.
+      #
+      def search_by_name names
+        JSON.parse(@connector[@@endpoint + "search?componentKeys=#{names}"].get)
+      end
+      
+      #Search for issues older than a date/datetime
+      #
+      # @param [String] date A string representation of a date or datetime in ISO
+      #   format (example: 2015-01-01 or 2015-01-01T11:01:01+0100)
+      # @return A JSON object, containing all the issues created after the given date.
+      #
+      def older_than date
+        JSON.parse(@connector[@@endpoint + "search?createdBefore=#{date}"].get)
+      end
+      
+      #Returns all issues created between the current date/time and the amount of days/time provided
+      #
+      # @param [String] date A string representation of a date or datetime in ISO 
+      #   format, that specifies how far back from the current date/time we want 
+      #   to look for new issues (example: 2015-01-01 or 2015-01-01T11:01:01+0100)
+      # @return [JSON] A JSON object, containing all the issues created in the previous time/days specified.
+      #
+      def in_past date
+        JSON.parse(@connector[@@endpoint + "search?createdInLast=#{date}"].get)
+      end
+      
+      #Add a comment to an issue
+      #
+      # @param [String] key The issue key
+      # @param [String] comment (optional, the default value is an empty string) The comment we want to add.
+      # @return [JSON] A JSON object, containing all the issues.
+      #
+      def add_comment key, comment=''
+        JSON.parse(@connector[@@endpoint + "add_comment?format=json,issue=#{key},text=#{comment}"].get)
+      end
+      
+      #Assigns an issue to a user
+      #
+      # @param [String] issue The issue key
+      # @param [String] username The username (login) of the assignee
+      # @return [A JSON object, containing all the issues.
+      #
+      def assign issue, username=''
+        JSON.parse(@connector[@@endpoint + "assign?issue=#{issue},assignee=#{username}"].get)
+      end
+      
+      #Returns scm users (usernames or emails) that have authored code with issues
+      #
+      # @param [String] search_string A string that will be used to search (regex match equivalent to /.\*search_string.\*/) for 
+      #   authors usernames or emails (e.g. for git it'll be used to search for what's configured in user.name or user.email).
+      # @return [JSON] A JSON object, containing all the authors.
+      #
+      def get_committers search_string
+        JSON.parse(@connector[@@endpoint + "authors?ps=2147483647&q=#{search_string}"].get)
+      end
+      
+      #Returns the changelog of an issue
+      #
+      # @param [String] key The issue key.
+      # @return [JSON] A JSON object, containing all the changelog.
+      #
+      def changelog key
+        JSON.parse(@connector[@@endpoint + "changelog?format=json,issue=#{key}"].get)
+      end
+
+      #Returns all issues
+      #
+      # @return [JSON] A JSON object, containing all the issues.
+      #
+      def get
+        JSON.parse(@connector[@@endpoint + 'search'].get)
+      end
+      
+      def search_by_name names
+        
+      end
+    end
+  end
+end

data/lib/sonarqube/logger.rb

@@ -0,0 +1,41 @@
+# Copyright (C) 2016 Dimitrios Dimas <dimitrios.work@outlook.com>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+module SonarQube
+  class Logger
+    
+    def self.log(*args, level)
+      @@logger=Logger.new *args
+      @@logger.level loglevel level
+    end
+    
+    def loglevel(level)
+      case level
+      when 'debug'
+        return 0
+      when 'info'
+        return 1
+      when 'warn'
+        return 2
+      when 'error'
+        return 3
+      when 'fatal'
+        return 4
+      else
+      end
+    end
+  end
+end

data/lib/sonarqube/projects.rb

@@ -0,0 +1,121 @@
+# Copyright (C) 2016 Dimitrios Dimas <dimitrios.work@outlook.com>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+module SonarQube
+  module Projects
+    class Projects
+      @@endpoint='/api/projects/'
+      
+      #Constructor
+      #
+      # @param [RestClient::Resource] connector The rest-client resource object
+      #
+      def initialize connector
+        @connector=connector
+      end
+      
+      #Returns all projects
+      #
+      # @return [JSON] A JSON object, containing all the projects.
+      #
+      def get
+        JSON.parse(@connector["#{@@endpoint}index?format=json"].get)
+      end
+    
+      #Search for a project using the project index number (id)
+      #
+      # @param [String] index project index number to use in the search
+      # @example puts \"this will return all the projects that their id is 47: #\\{search_by_key 47\}\"
+      # @return [JSON] A JSON object containing the project details (what details?).
+      def search_by_index index
+        JSON.parse(@connector["#{@@endpoint}index?key=#{index}"].get)
+      end
+   
+      #Search for a project using the project key
+      #
+      # @param [String] key project key to use in the search
+      # @example puts \"this will return all the projects that their key is \'my:awesome:project\': #\\{search_by_key 'my:awesome:project'\}\"
+      # @return [JSON] A JSON object containing the project details (what details?).
+      def search_by_key key
+        JSON.parse(@connector["#{@@endpoint}index?key=#{key}"].get)
+      end
+      
+      #Return all projects that their name contains the provided string
+      #
+      # @param [String] search_string search string to search with
+      # @return [JSON] A JSON object, containing all the project details (what details?).
+      # @example puts \"this will return all the projects that their name contains the string \'java\': #\\{name_contains 'java'\}\"
+      def name_contains search_string
+        JSON.parse(@connector["#{@@endpoint}index?search=#{search_string}"].get)
+      end
+      
+      #Delete a project with the specified id
+      #
+      # @param [String] id id of the project to be deleted
+      # @return [JSON] A JSON object, containing all the project details (what details?).
+      # @example puts \"this will delete the project with id 47: #\\{delete_id 47\}\"
+      def delete_id id
+        JSON.parse(@connector["#{@@endpoint}delete?id=#{id}"].get)
+      end
+      
+      #Delete a project with the specified key
+      #
+      # @param [String] key key of the project to be deleted
+      # @return [JSON] A JSON object, containing all the project details (what details?).
+      # @example puts \"this will delete the project with the key \'my:awesome:project\': #\\{delete_key 'my:awesome:project'\}\"
+      def delete_key key
+        JSON.parse(@connector["#{@@endpoint}delete?key=#{key}"].get)
+      end
+    end
+    
+    #Returns all projects (functional interface)
+    #
+    # @return A JSON object, containing all the projects.
+    #
+    def get
+      JSON.parse(@connector["#{@@endpoint}api/projects/index"].get)
+    end
+  
+    #Search for a project by key (functional interface)
+    #
+    # == Parameters:
+    # Project key
+    #
+    # == Returns:
+    # A JSON object containing the project details (what details?).
+    # 
+    # == Example endpoints:
+    #http://localhost:9000/api/projects/index?key=35
+    #http://localhost:9000/api/projects/index?key=java-sonar-runner-simple
+    def search_by_key key
+      'api/projects/index?key=' + key
+    end
+
+    #Search for a project by name
+    #
+    # == Parameters:
+    # Project name
+    #
+    # == Returns:
+    # A JSON object, containing all the project details (what details?).
+    # 
+    # == Example endpoints:
+    #http://localhost:9000/api/projects/index?search=java
+    def search_by_name name
+      'api/projects/index?search=' + name
+    end
+  end
+end

data/lib/sonarqube/timemachine.rb

@@ -0,0 +1,45 @@
+# Copyright (C) 2016 Dimitrios Dimas <dimitrios.work@outlook.com>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+module SonarQube
+  module TimeMachine
+    
+
+    
+    class TimeMachine
+      @@endpoint='api/timemachine/'
+      
+      def initialize connector
+        @connector=connector
+      end
+      
+      #Returns the specified metrics of a project
+      #@param [String] project_name The name of the project
+      #@param [String] metrics A string that contains comma separated project metric keys/id's (can be found in: http://docs.sonarqube.org/display/SONAR/Metric+definitions)
+      #@return [JSON] A JSON object with the project metrics
+      def get project_name, metrics
+        JSON.parse(@connector["#{@@endpoint}index?format=json&resource=#{project_name}&metrics=#{metrics}&toDateTime=&fromDateTime="].get)
+      end
+    end
+    
+    #example url:
+    #http://localhost:9000/api/timemachine/index?resource=java-sonar-runner-simple&metrics=lines,toDateTime=,fromDateTime=
+    def get(project, metrics)
+      'api/timemachine/index?resource=' + project +'&metrics=' + metrics
+    end
+    
+  end
+end

data/lib/sonarqube/version.rb

@@ -0,0 +1,24 @@
+# Copyright (C) 2016 Dimitrios Dimas <dimitrios.work@outlook.com>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+module SonarQube
+    VERSION_INFO = [0, 0, 0, 'develop'] unless defined?(self::VERSION_INFO)
+    VERSION = VERSION_INFO.map(&:to_s).join('.') unless defined?(self::VERSION)
+
+    def self.version
+      VERSION
+    end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: sonarqube-client
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Dimitrios Dimas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+description: This gem can be used to interact with a SonarQube server using the REST
+  API. This is an initial version and likely to be buggy and badly written. Testing/development
+  is done against a sonarqube 5.2 server.
+email: dimitrios.work@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sonarqube-client.rb
+- lib/sonarqube/client.rb
+- lib/sonarqube/issues.rb
+- lib/sonarqube/logger.rb
+- lib/sonarqube/projects.rb
+- lib/sonarqube/timemachine.rb
+- lib/sonarqube/version.rb
+homepage: http://rubygems.org/gems/sonarqube-client
+licenses:
+- GPL-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: SonarQube client
+test_files: []
+has_rdoc: