Removing not needed fields and added README

Author: mechero

README.md

@@ -0,0 +1,36 @@
+# Quboo SonarQube Plugin
+
+# What is Quboo?
+
+[Quboo](https://quboo.io) is a platform that helps you improve your code by using gamification techniques to motivate you and your peers to fix your technical debt.
+
+Go to [quboo.io](https://quboo.io) for more details about how Quboo works and why you should give it a try.
+
+# The plugin
+
+## How does it work?
+
+Our platform uses your code analysis results from SonarQube to extract the game statistics, and also create players based on the existent users in this tool.
+
+This plugin runs after each analysis and collect partial information about your SonarQube users and your existing Issues and send them to Quboo. Then, it computes the new scorecards and badges that you will be able to see next time you access your account via login or public link.
+
+## Installing the Plugin
+
+1. Navigate to [Releases](https://github.com/thepracticaldeveloper/quboo-sonarqube-plugin/releases) and download the latest `.jar` file.
+2. Remove any previous version of the plugin and put the new jar in the folder `$SONARQUBE_HOME/extensions/plugins`.
+3. Restart your SonarQube server.
+
+## Configuration
+
+After you install the plugin you need Administrator rights to enter your Quboo Access and Secret Keys. The plugin needs these so it can link the data to your account. You can find these values under the section *Settings* when you log in as a user in Quboo.
+
+In SonarQube, you have to enter these keys in the section *Administration -> Configuration -> General Settings -> Quboo (tab)*. 
+
+## What information do we send?
+
+We do not need much information for you to play the game, so we collect only some details from Users and Issues. We keep this plugin in an open source repository for transparency so you can see at anytime what is the transferred data:
+
+- **Users**: login, name, active.
+- **Issues**: key, rule, severity, componentId, resolution, status, debt, author, creationDate, updateDate, closeDate.
+
+As you can see, **we DO NOT send anything related to code to the server**. Not even your component names, tags, comments, etc. 

src/main/java/io/tpd/quboo/sonarplugin/hooks/QubooConnector.java

@@ -10,16 +10,16 @@
 import io.tpd.quboo.sonarplugin.pojos.Users;
 import io.tpd.quboo.sonarplugin.settings.QubooProperties;
 import okhttp3.*;
+import org.apache.commons.lang3.StringUtils;
 import org.sonar.api.ce.posttask.PostProjectAnalysisTask;
 import org.sonar.api.platform.Server;
 import org.sonar.api.utils.log.Logger;
 import org.sonar.api.utils.log.Loggers;
 
+import static io.tpd.quboo.sonarplugin.settings.QubooProperties.DEFAULT_ACCESS_KEY;
+
 /**
- * Sends stats to the Quboo server after an analysis meeting these conditions:
- * 1. On a 'master' branch
- * 2. No more than 5 times a day
- * 3. Issues created before today
+ * Sends stats to the Quboo server after an analysis
  */
 public class QubooConnector implements PostProjectAnalysisTask {
 
@@ -38,14 +38,18 @@ public QubooConnector(final Server server) {
   public void finished(ProjectAnalysis analysis) {
     final String qubooKey = analysis.getScannerContext().getProperties().get(QubooProperties.ACCESS_KEY);
     final String qubooSecret = analysis.getScannerContext().getProperties().get(QubooProperties.SECRET_KEY);
-    log.info("Connecting to Quboo with quboo key: " + qubooKey);
-    try {
-      final UsersWrapper allUsers = getUsers();
-      sendUsersToQuboo(allUsers, qubooKey, qubooSecret);
-      final IssuesWrapper allIssues = getIssues();
-      sendIssuesToQuboo(allIssues, qubooKey, qubooSecret);
-    } catch (final Exception e) {
-      log.error("Error while trying to connect to Quboo", e);
+    if (!StringUtils.isEmpty(qubooKey) && !DEFAULT_ACCESS_KEY.equals(qubooKey)) {
+      log.info("Connecting to Quboo with quboo key: " + qubooKey);
+      try {
+        final UsersWrapper allUsers = getUsers();
+        sendUsersToQuboo(allUsers, qubooKey, qubooSecret);
+        final IssuesWrapper allIssues = getIssues();
+        sendIssuesToQuboo(allIssues, qubooKey, qubooSecret);
+      } catch (final Exception e) {
+        log.error("Error while trying to connect to Quboo", e);
+      }
+    } else {
+      log.info("Quboo plugin is disabled. Enter your access and secret keys to enable it.");
     }
   }
 
@@ -74,7 +78,7 @@ private IssuesWrapper getIssues() throws Exception {
       moreData = moreData(issues.getPaging(), issues.getIssues().size());
       pageNumber++;
     }
-    log.info("There are " + wrapper.getIssues().size() + " issues");
+    log.info("Sending " + wrapper.getIssues().size() + " issues to Quboo");
     return wrapper;
   }
 
@@ -108,7 +112,7 @@ private UsersWrapper getUsers() {
         break;
       }
     }
-    log.info("There are " + wrapper.getUsers().size() + " users");
+    log.info("Sending " + wrapper.getUsers().size() + " users to Quboo");
     return wrapper;
   }
 

src/main/java/io/tpd/quboo/sonarplugin/pojos/Component.java

@@ -1,24 +1,12 @@
 package io.tpd.quboo.sonarplugin.pojos;
 
-import com.fasterxml.jackson.annotation.*;
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
 import org.apache.commons.lang3.builder.ToStringBuilder;
 
-import java.util.HashMap;
-import java.util.Map;
-
 @JsonInclude(JsonInclude.Include.NON_NULL)
-@JsonPropertyOrder({
-  "id",
-  "key",
-  "uuid",
-  "enabled",
-  "qualifier",
-  "name",
-  "longName",
-  "path",
-  "projectId",
-  "subProjectId"
-})
+@JsonIgnoreProperties(ignoreUnknown = true)
 public class Component {
 
   @JsonProperty("id")
@@ -29,20 +17,10 @@ public class Component {
   private String uuid;
   @JsonProperty("enabled")
   private Boolean enabled;
-  @JsonProperty("qualifier")
-  private String qualifier;
-  @JsonProperty("name")
-  private String name;
-  @JsonProperty("longName")
-  private String longName;
-  @JsonProperty("path")
-  private String path;
   @JsonProperty("projectId")
   private Integer projectId;
   @JsonProperty("subProjectId")
   private Integer subProjectId;
-  @JsonIgnore
-  private Map<String, Object> additionalProperties = new HashMap<String, Object>();
 
   /**
    * @return The id
@@ -128,90 +106,6 @@ public Component withEnabled(Boolean enabled) {
     return this;
   }
 
-  /**
-   * @return The qualifier
-   */
-  @JsonProperty("qualifier")
-  public String getQualifier() {
-    return qualifier;
-  }
-
-  /**
-   * @param qualifier The qualifier
-   */
-  @JsonProperty("qualifier")
-  public void setQualifier(String qualifier) {
-    this.qualifier = qualifier;
-  }
-
-  public Component withQualifier(String qualifier) {
-    this.qualifier = qualifier;
-    return this;
-  }
-
-  /**
-   * @return The name
-   */
-  @JsonProperty("name")
-  public String getName() {
-    return name;
-  }
-
-  /**
-   * @param name The name
-   */
-  @JsonProperty("name")
-  public void setName(String name) {
-    this.name = name;
-  }
-
-  public Component withName(String name) {
-    this.name = name;
-    return this;
-  }
-
-  /**
-   * @return The longName
-   */
-  @JsonProperty("longName")
-  public String getLongName() {
-    return longName;
-  }
-
-  /**
-   * @param longName The longName
-   */
-  @JsonProperty("longName")
-  public void setLongName(String longName) {
-    this.longName = longName;
-  }
-
-  public Component withLongName(String longName) {
-    this.longName = longName;
-    return this;
-  }
-
-  /**
-   * @return The path
-   */
-  @JsonProperty("path")
-  public String getPath() {
-    return path;
-  }
-
-  /**
-   * @param path The path
-   */
-  @JsonProperty("path")
-  public void setPath(String path) {
-    this.path = path;
-  }
-
-  public Component withPath(String path) {
-    this.path = path;
-    return this;
-  }
-
   /**
    * @return The projectId
    */
@@ -259,19 +153,4 @@ public String toString() {
     return ToStringBuilder.reflectionToString(this);
   }
 
-  @JsonAnyGetter
-  public Map<String, Object> getAdditionalProperties() {
-    return this.additionalProperties;
-  }
-
-  @JsonAnySetter
-  public void setAdditionalProperty(String name, Object value) {
-    this.additionalProperties.put(name, value);
-  }
-
-  public Component withAdditionalProperty(String name, Object value) {
-    this.additionalProperties.put(name, value);
-    return this;
-  }
-
 }