sonarqube-client 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e5c848304338dee76e0a4b1b08c46efdc7c3061
-  data.tar.gz: ce4957d40b5a6eaaf651d3c9edf0deefc2d4df71
+  metadata.gz: 64c7070d55e7746cbfe8ec2a8dd088f53a25a273
+  data.tar.gz: 369e824b95082c608fea15d9141313d0dacc1bab
 SHA512:
-  metadata.gz: 66ae5d99b34c55cdb05c6e70bf74601268de8cdd570ad9adb8c933bbddc72b53cf9f890ca2080b681b40abfcaf73f88f91b16091c62489d5caf676dc6c2dc545
-  data.tar.gz: 8662428d509991e30ca8bb1c7a262866674c4caa26cf67146f7323e93b5f8c4fc0fe185a7875f9ec390ed8f68be36a8cbc00dbcd4197b544228eb4ca7eccc04e
+  metadata.gz: bfbbb0d549ee281fc1de3f1cfd8082b17cf12ef18bf48597d484c529b8e7d0cc9ec7ba4106e3e9fbd69e8fe668f13e704ea67d951ba66d35144be306120b4ecb
+  data.tar.gz: f539a01d8c48bcaa8f24862bd236afbd232d675842e40cbd98e4c68341510cbcd7ec32c179f9fc1e2efae002f313a25c6f0185f557e38f37ef09b0685254388a

data/lib/sonarqube-client.rb

@@ -20,12 +20,12 @@ 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'
+require File.dirname(__FILE__) + '/sonarqube-client/client.rb'
+require File.dirname(__FILE__) + '/sonarqube-client/issues.rb'
+require File.dirname(__FILE__) + '/sonarqube-client/logger.rb'
+require File.dirname(__FILE__) + '/sonarqube-client/projects.rb'
+require File.dirname(__FILE__) + '/sonarqube-client/timemachine.rb'
+require File.dirname(__FILE__) + '/sonarqube-client/version.rb'
 
 
 
@@ -75,9 +75,9 @@ module SonarQube
   
   def sonarqube(server_url, username='', password='')
     if [username, password].reduce(:+) == ''
-      proc {|endpoint| RestClient::Resource.new server_url + endpoint}.curry
+      proc {|endpoint| JSON.parse((RestClient::Resource.new server_url + endpoint).get)}.curry
     else
-      proc {|endpoint| RestClient::Resource.new server_url + endpoint, a, b}.curry
+      proc {|endpoint| JSON.parse((RestClient::Resource.new server_url + endpoint, username, password).get)}.curry
     end
   end
 

data/lib/{sonarqube → sonarqube-client}/projects.rb

@@ -16,6 +16,8 @@
 
 module SonarQube
   module Projects
+    require 'ostruct'
+    
     class Projects
       @@endpoint='/api/projects/'
       
@@ -29,37 +31,38 @@ module SonarQube
       
       #Returns all projects
       #
-      # @return [JSON] A JSON object, containing all the projects.
-      #
+      # @return [Array<OpenStruct>] An Array of OpenStruct objects containing the project details (e.g. [#<OpenStruct id="1", k="bad:project", nm="My bad project", sc="PRJ", qu="TRK">]).
       def get
-        JSON.parse(@connector["#{@@endpoint}index?format=json"].get)
+        response = JSON.parse(@connector["#{@@endpoint}index?format=json"].get, object_class: OpenStruct)
+        return response.length > 0 ? response : nil
       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?).
+      # @example puts \"this will return the project with id 47: #\\{search_by_key 47\}\"
+      # @return [OpenStruct, nil] An OpenStruct object containing the project details (e.g. #<OpenStruct id="1", k="bad:project", nm="My bad project", sc="PRJ", qu="TRK">) or nil.
       def search_by_index index
-        JSON.parse(@connector["#{@@endpoint}index?key=#{index}"].get)
+        JSON.parse(@connector["#{@@endpoint}index?format=json&key=#{index}"].get, object_class: OpenStruct)[0]
       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?).
+      # @example puts \"this will return all the project with key \'my:awesome:project\': #\\{search_by_key 'my:awesome:project'\}\"
+      # @return [OpenStruct] An OpenStruct object containing the project details (e.g. #<OpenStruct id="1", k="bad:project", nm="My bad project", sc="PRJ", qu="TRK">) or nil.
       def search_by_key key
-        JSON.parse(@connector["#{@@endpoint}index?key=#{key}"].get)
+        JSON.parse(@connector["#{@@endpoint}index?format=json&key=#{key}"].get, object_class: OpenStruct)[0]
       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'\}\"
+      # @return [Array<OpenStruct>, nil] An Array of OpenStruct objects containing the project details (e.g. [#<OpenStruct id="1", k="bad:project", nm="My bad project", sc="PRJ", qu="TRK">]) or nil.
       def name_contains search_string
-        JSON.parse(@connector["#{@@endpoint}index?search=#{search_string}"].get)
+        response = JSON.parse(@connector["#{@@endpoint}index?format=json&search=#{search_string}"].get, object_class: OpenStruct)
+        return response.length > 0 ? response : nil
       end
       
       #Delete a project with the specified id
@@ -86,7 +89,7 @@ module SonarQube
     # @return A JSON object, containing all the projects.
     #
     def get
-      JSON.parse(@connector["#{@@endpoint}api/projects/index"].get)
+      'api/projects/index?format=json'
     end
   
     #Search for a project by key (functional interface)
@@ -101,7 +104,7 @@ module SonarQube
     #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
+      '/api/projects/index?key=' + key
     end
 
     #Search for a project by name

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sonarqube-client
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Dimitrios Dimas
@@ -75,12 +75,12 @@ 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
+- lib/sonarqube-client/client.rb
+- lib/sonarqube-client/issues.rb
+- lib/sonarqube-client/logger.rb
+- lib/sonarqube-client/projects.rb
+- lib/sonarqube-client/timemachine.rb
+- lib/sonarqube-client/version.rb
 homepage: http://rubygems.org/gems/sonarqube-client
 licenses:
 - GPL-2.0
@@ -104,6 +104,6 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: SonarQube client
+summary: A SonarQube client
 test_files: []
 has_rdoc: