SONAR-4083 add java web service API for metrics

6 files changed, 302 insertions, 0 deletions

diff --git a/sonar-ws-client/src/main/java/org/sonar/wsclient/services/MetricCreateQuery.java b/sonar-ws-client/src/main/java/org/sonar/wsclient/services/MetricCreateQuery.java
new file mode 100644
index 00000000000..b40d0ed87fd
--- /dev/null
+++ b/sonar-ws-client/src/main/java/org/sonar/wsclient/services/MetricCreateQuery.java
@@ -0,0 +1,78 @@
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2008-2012 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * Sonar 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+package org.sonar.wsclient.services;
+
+/**
+ * @since 3.6
+ */
+public class MetricCreateQuery extends CreateQuery<Metric>  {
+
+  private String key;
+  private String name;
+  private String description;
+  private String domain;
+  private String type;
+
+  public static MetricCreateQuery create(String metricKey) {
+    return new MetricCreateQuery(metricKey);
+  }
+
+  private MetricCreateQuery(String key) {
+    this.key = key;
+  }
+
+  public MetricCreateQuery setName(String name) {
+    this.name = name;
+    return this;
+  }
+
+  public MetricCreateQuery setDescription(String description) {
+    this.description = description;
+    return this;
+  }
+
+  public MetricCreateQuery setDomain(String domain) {
+    this.domain = domain;
+    return this;
+  }
+
+  public MetricCreateQuery setType(String type) {
+    this.type = type;
+    return this;
+  }
+
+  @Override
+  public String getUrl() {
+    StringBuilder url = new StringBuilder();
+    url.append(MetricQuery.BASE_URL);
+    url.append("/").append(encode(key));
+    url.append('?');
+    appendUrlParameter(url, "name", name);
+    appendUrlParameter(url, "description", description);
+    appendUrlParameter(url, "domain", domain);
+    appendUrlParameter(url, "val_type", type);
+    return url.toString();
+  }
+
+  @Override
+  public Class<Metric> getModelClass() {
+    return Metric.class;
+  }
+}
diff --git a/sonar-ws-client/src/main/java/org/sonar/wsclient/services/MetricDeleteQuery.java b/sonar-ws-client/src/main/java/org/sonar/wsclient/services/MetricDeleteQuery.java
new file mode 100644
index 00000000000..c736629950f
--- /dev/null
+++ b/sonar-ws-client/src/main/java/org/sonar/wsclient/services/MetricDeleteQuery.java
@@ -0,0 +1,53 @@
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2008-2012 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * Sonar 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+package org.sonar.wsclient.services;
+
+/**
+ * @since 3.6
+ */
+public class MetricDeleteQuery extends DeleteQuery {
+
+  private String key;
+
+  public static MetricDeleteQuery delete(String key){
+    return new MetricDeleteQuery(key);
+  }
+
+  private MetricDeleteQuery(String key) {
+    this.key = key;
+  }
+
+  public String getKey() {
+    return key;
+  }
+
+  public MetricDeleteQuery setKey(String key) {
+    this.key = key;
+    return this;
+  }
+
+  @Override
+  public String getUrl() {
+    StringBuilder url = new StringBuilder();
+    url.append(MetricQuery.BASE_URL);
+    url.append("/").append(encode(key));
+    return url.toString();
+  }
+}
diff --git a/sonar-ws-client/src/main/java/org/sonar/wsclient/services/MetricUpdateQuery.java b/sonar-ws-client/src/main/java/org/sonar/wsclient/services/MetricUpdateQuery.java
new file mode 100644
index 00000000000..b0596d9bdd4
--- /dev/null
+++ b/sonar-ws-client/src/main/java/org/sonar/wsclient/services/MetricUpdateQuery.java
@@ -0,0 +1,86 @@
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2008-2012 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * Sonar 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+package org.sonar.wsclient.services;
+
+/**
+ * @since 2.6
+ */
+public class MetricUpdateQuery extends UpdateQuery<Metric> {
+
+  private String key;
+  private String name;
+  private String description;
+  private String domain;
+  private String type;
+
+  public static MetricUpdateQuery update(String key){
+    return new MetricUpdateQuery(key);
+  }
+
+  private MetricUpdateQuery(String key) {
+    this.key = key;
+  }
+
+  public MetricUpdateQuery setName(String name) {
+    this.name = name;
+    return this;
+  }
+
+  public MetricUpdateQuery setDescription(String description) {
+    this.description = description;
+    return this;
+  }
+
+  public MetricUpdateQuery setDomain(String domain) {
+    this.domain = domain;
+    return this;
+  }
+
+  public MetricUpdateQuery setType(String type) {
+    this.type = type;
+    return this;
+  }
+
+  @Override
+  public String getUrl() {
+    StringBuilder url = new StringBuilder();
+    url.append(MetricQuery.BASE_URL);
+    url.append("/").append(encode(key));
+    url.append('?');
+    appendUrlParameter(url, "name", name);
+    appendUrlParameter(url, "description", description);
+    appendUrlParameter(url, "domain", domain);
+    appendUrlParameter(url, "val_type", type);
+    return url.toString();
+  }
+
+  /**
+   * Property {@link #description} transmitted through request body as content may exceed URL size allowed by the server.
+   */
+  @Override
+  public String getBody() {
+    return description;
+  }
+
+  @Override
+  public Class<Metric> getModelClass() {
+    return Metric.class;
+  }
+}
diff --git a/sonar-ws-client/src/test/java/org/sonar/wsclient/services/MetricCreateQueryTest.java b/sonar-ws-client/src/test/java/org/sonar/wsclient/services/MetricCreateQueryTest.java
new file mode 100644
index 00000000000..a43051cf00d
--- /dev/null
+++ b/sonar-ws-client/src/test/java/org/sonar/wsclient/services/MetricCreateQueryTest.java
@@ -0,0 +1,35 @@
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2008-2012 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * Sonar 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+package org.sonar.wsclient.services;
+
+import org.junit.Test;
+
+import static org.fest.assertions.Assertions.assertThat;
+
+public class MetricCreateQueryTest extends QueryTestCase {
+
+  @Test
+  public void should_create() {
+    MetricCreateQuery query = MetricCreateQuery.create("key").setName("name").setDescription("description").setDomain("domain").setType("type");
+    assertThat(query.getUrl()).isEqualTo("/api/metrics/key?name=name&description=description&domain=domain&val_type=type&");
+    assertThat(query.getModelClass().getName()).isEqualTo(Metric.class.getName());
+  }
+
+}
diff --git a/sonar-ws-client/src/test/java/org/sonar/wsclient/services/MetricDeleteQueryTest.java b/sonar-ws-client/src/test/java/org/sonar/wsclient/services/MetricDeleteQueryTest.java
new file mode 100644
index 00000000000..8509e786d34
--- /dev/null
+++ b/sonar-ws-client/src/test/java/org/sonar/wsclient/services/MetricDeleteQueryTest.java
@@ -0,0 +1,33 @@
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2008-2012 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * Sonar 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+package org.sonar.wsclient.services;
+
+import org.junit.Test;
+
+import static org.fest.assertions.Assertions.assertThat;
+
+public class MetricDeleteQueryTest extends QueryTestCase {
+
+  @Test
+  public void should_delete() {
+    MetricDeleteQuery query = MetricDeleteQuery.delete("key");
+    assertThat(query.getUrl()).isEqualTo("/api/metrics/key");
+  }
+}
diff --git a/sonar-ws-client/src/test/java/org/sonar/wsclient/services/MetricUpdateQueryTest.java b/sonar-ws-client/src/test/java/org/sonar/wsclient/services/MetricUpdateQueryTest.java
new file mode 100644
index 00000000000..fe35a04052f
--- /dev/null
+++ b/sonar-ws-client/src/test/java/org/sonar/wsclient/services/MetricUpdateQueryTest.java
@@ -0,0 +1,17 @@
+package org.sonar.wsclient.services;
+
+import org.junit.Test;
+
+import static org.fest.assertions.Assertions.assertThat;
+
+public class MetricUpdateQueryTest extends QueryTestCase {
+
+  @Test
+  public void should_update() {
+    MetricUpdateQuery query = MetricUpdateQuery.update("key").setName("name").setDescription("description").setDomain("domain").setType("type");
+    assertThat(query.getUrl()).isEqualTo("/api/metrics/key?name=name&description=description&domain=domain&val_type=type&");
+    assertThat(query.getBody()).isEqualTo("description");
+    assertThat(query.getModelClass().getName()).isEqualTo(Metric.class.getName());
+  }
+
+}