Merge pull request #28 from osmlab/dev

Merging dev to master

Author: mgcuthbert

README.md

@@ -19,30 +19,27 @@ For information on the API Library see the [documentation](docs/using.md).
 
 Here is examples of adding the library into a project.
 
-- <img src="https://search.maven.org/assets/images/gradle.png" width="30" height="30"/> Gradle Groovy DSL:
+<img src="https://search.maven.org/assets/images/gradle.png" width="30" height="30"/> Gradle Groovy DSL:
+
 ```
+repositories 
+{
+    maven {
+        name = "GitHubPackages"
+        url = uri("https://maven.pkg.github.com/osmlab/maproulette-java-client")
+        credentials {
+            username = project.findProperty("gpr.user") ?: System.getProperty("USERNAME")
+            password = project.findProperty("gpr.key") ?: System.getProperty("PASSWORD")
+        }
+    }
+}
+
 dependencies
 {
     implementation "org.maproulette:maproulette-java-client:0.3.0"
 }
 ```
 
-- <img src="https://search.maven.org/assets/images/mvn.png" width="30" height="30"/> Maven:
-```
-<dependency>
-    <groupId>org.maproulette</groupId>
-    <artifactId>maproulette-java-client</artifactId>
-    <version>0.3.0</version>
-</dependency>
-```
-
-- <img src="https://search.maven.org/assets/images/sbt.svg" width="30" height="30"/> Scala SBT:
-```
-libraryDependencies += "org.maproulette" % "maproulette-java-client" % "0.3.0"
-```
-
-- <img src="https://search.maven.org/assets/images/ivy.png" width="30" height="30"/> Apache Ivy:
-```
-<dependency org="org.maproulette" name="maproulette-java-client" rev="0.3.0"/>
-```
+This project is published using Github Package Registry. Unfortunately one of the drawbacks of using Github Package Registry is that to download a package you have to be authenticated and have permissions to read packages. Hopefully this will change in the future, however for now you will have to supply a username and token to access the package. 
 
+The "credentials" section above shows that it will look for any properties found in gradle with `gpr.user` for your Github username and if not found it will look at any passed in system environment variables called `USERNAME`. Likewise it will do the same for password, except obviously looking for `gpr.key` and `PASSWORD` respectively.

gradle.properties

@@ -1,5 +1,5 @@
 group=org.maproulette.client
-version=0.3.0
+version=0.3.1
 
 project_name="MapRoulette Java Client"
 project_description="Java Client to connect and use MapRoulette API."

src/main/java/org/maproulette/client/model/Challenge.java

@@ -2,6 +2,9 @@
 
 import java.io.Serializable;
 
+import org.maproulette.client.exception.MapRouletteException;
+import org.maproulette.client.utilities.Utilities;
+
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
@@ -63,4 +66,9 @@ public class Challenge implements IMapRouletteObject, Serializable
     private Integer defaultBasemap;
     private String defaultBasemapId;
     private String customBasemap;
+
+    public static Challenge fromJson(final String json) throws MapRouletteException
+    {
+        return Utilities.fromJson(json, Challenge.class);
+    }
 }

src/main/java/org/maproulette/client/model/Project.java

@@ -2,6 +2,9 @@
 
 import java.io.Serializable;
 
+import org.maproulette.client.exception.MapRouletteException;
+import org.maproulette.client.utilities.Utilities;
+
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
@@ -39,6 +42,11 @@ public class Project implements IMapRouletteObject, Serializable
     @Builder.Default
     private boolean enabled = false;
 
+    public static Project fromJson(final String json) throws MapRouletteException
+    {
+        return Utilities.fromJson(json, Project.class);
+    }
+
     /**
      * Projects have no parents, so will automatically return -1
      *

src/main/java/org/maproulette/client/model/Task.java

@@ -9,6 +9,7 @@
 import org.apache.commons.lang.StringUtils;
 import org.maproulette.client.exception.MapRouletteException;
 import org.maproulette.client.exception.MapRouletteRuntimeException;
+import org.maproulette.client.utilities.Utilities;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonInclude;
@@ -205,6 +206,11 @@ public static TaskBuilder builder(final long parentIdentifier, final String name
         return taskBuilder().parent(parentIdentifier).name(name);
     }
 
+    public static Task fromJson(final String json) throws MapRouletteException
+    {
+        return Utilities.fromJson(json, Task.class);
+    }
+
     public TaskBuilder toBuilder(final boolean resetGeometry)
     {
         if (resetGeometry)

src/main/java/org/maproulette/client/utilities/Utilities.java

@@ -0,0 +1,34 @@
+package org.maproulette.client.utilities;
+
+import java.io.IOException;
+
+import org.maproulette.client.exception.MapRouletteException;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+/**
+ * A generic helper class
+ *
+ * @author mcuthbert
+ */
+public final class Utilities
+{
+    public static <T> T fromJson(final String json, final Class<T> clazz)
+            throws MapRouletteException
+    {
+        try
+        {
+            final var mapper = new ObjectMapper();
+            return mapper.readValue(json, clazz);
+        }
+        catch (final IOException e)
+        {
+            throw new MapRouletteException(e);
+        }
+    }
+
+    private Utilities()
+    {
+        // Don't need to the constructor as this a utilities class
+    }
+}

src/test/java/org/maproulette/client/serializer/ChallengeSerializationTest.java

@@ -5,6 +5,7 @@
 
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
+import org.maproulette.client.exception.MapRouletteException;
 import org.maproulette.client.model.Challenge;
 import org.maproulette.client.model.ChallengeDifficulty;
 import org.maproulette.client.model.ChallengePriority;
@@ -89,11 +90,11 @@ public void defaultSerializationTest() throws IOException
     /**
      * Tests that a challenge with no defaultPriority specified gets loaded as defaultPriority=LOW.
      *
-     * @throws IOException
+     * @throws Exception
      *             any failure when reading the challenge resource file
      */
     @Test
-    public void serializationNoDefaultPrioritySpecifiedTest() throws IOException
+    public void serializationNoDefaultPrioritySpecifiedTest() throws Exception
     {
         final var deserializedChallenge = this.getChallenge("challenges/testChallenge4.json");
 
@@ -112,11 +113,11 @@ public void serializationNoDefaultPrioritySpecifiedTest() throws IOException
      * Test if a challange can be deserialized from a test JSON file. The challenge resource json
      * contains no MapRoulette priority information.
      *
-     * @throws IOException
+     * @throws Exception
      *             any failure when reading the challenge resource file
      */
     @Test
-    public void serializationNoPriorityTest() throws IOException
+    public void serializationNoPriorityTest() throws Exception
     {
         // This line will deserialize the challenge, and if it fails we know it didn't work.
         final var deserializedChallenge = this.getChallenge("challenges/testChallenge2.json");
@@ -135,11 +136,11 @@ public void serializationNoPriorityTest() throws IOException
      * Test if a challenge can be deserialized from a test JSON file. The challenge contains
      * MapRoulette priority information for high and medium priority but not for low priority.
      *
-     * @throws IOException
+     * @throws Exception
      *             any failure when reading the challenge resource file
      */
     @Test
-    public void serializationTest() throws IOException
+    public void serializationTest() throws Exception
     {
         // This line will deserialize the challenge, and if it fails we know it didn't work.
         final var deserializedChallenge = this.getChallenge("challenges/testChallenge.json");
@@ -171,12 +172,11 @@ public void serializationTest() throws IOException
      * @param resource
      *            The path to the resource file
      * @return A {@link Challenge} object representing the provided resource.
-     * @throws IOException
+     * @throws MapRouletteException
      *             any failure when reading the challenge resource file
      */
-    private Challenge getChallenge(final String resource) throws IOException
+    private Challenge getChallenge(final String resource) throws MapRouletteException
     {
-        final var value = SerializerUtilities.getResourceAsString(resource);
-        return new ObjectMapper().readValue(value, Challenge.class);
+        return Challenge.fromJson(SerializerUtilities.getResourceAsString(resource));
     }
 }

src/test/java/org/maproulette/client/serializer/ProjectSerializationTest.java

@@ -24,10 +24,27 @@ public void projectSerializationTest() throws IOException
         final var projectJson = mapper.writeValueAsString(project);
         final var deserializedProject = mapper.readValue(projectJson, Project.class);
 
-        Assertions.assertEquals(project.getName(), deserializedProject.getName());
-        Assertions.assertEquals(project.getId(), deserializedProject.getId());
-        Assertions.assertEquals(project.getDescription(), deserializedProject.getDescription());
-        Assertions.assertEquals(project.getDisplayName(), deserializedProject.getDisplayName());
-        Assertions.assertEquals(project.isEnabled(), deserializedProject.isEnabled());
+        this.verifyProjects(project, deserializedProject);
+    }
+
+    @Test
+    public void fromJsonTest() throws Exception
+    {
+        final var mapper = new ObjectMapper();
+        final var project = Project.builder().name("TestProject").description("TestDescription")
+                .displayName("TestDisplayName").enabled(true).id(6875L).build();
+        final var projectJson = mapper.writeValueAsString(project);
+        final var deserializedProject = Project.fromJson(projectJson);
+
+        this.verifyProjects(project, deserializedProject);
+    }
+
+    private void verifyProjects(final Project project1, final Project project2)
+    {
+        Assertions.assertEquals(project1.getName(), project2.getName());
+        Assertions.assertEquals(project1.getId(), project2.getId());
+        Assertions.assertEquals(project1.getDescription(), project2.getDescription());
+        Assertions.assertEquals(project1.getDisplayName(), project2.getDisplayName());
+        Assertions.assertEquals(project1.isEnabled(), project2.isEnabled());
     }
 }

src/test/java/org/maproulette/client/serializer/TaskSerializerTest.java

@@ -51,6 +51,25 @@ public void geometriesSerializationTest() throws IOException
         this.verifyTask(task, deserializedTask);
     }
 
+    @Test
+    public void fromJsonTest() throws Exception
+    {
+        final var testFeatureString = "{\"type\":\"Feature\",\"geometry\":{\"type\":\"Point\",\"coordinates\":[%s, %s]},\"properties\": {\"name\":\"%s\"}}";
+        final var mapper = new ObjectMapper();
+        final var pointList = Arrays.asList(new PointInformation(1.0, 2.0),
+                new PointInformation(5.4, 8.7));
+
+        final var task = Task.builder(343444454, "TestTask").id(12355655)
+                .instruction("TestInstruction").priority(ChallengePriority.HIGH)
+                .status(TaskStatus.DELETED).addPoints(pointList)
+                .addGeojson(String.format(testFeatureString, 1.0, 2.0, "Feature1"))
+                .addGeojson(String.format(testFeatureString, 5.0, 6.0, "Feature2")).build();
+        final var taskJson = mapper.writeValueAsString(task);
+
+        final var deserializedTask = Task.fromJson(taskJson);
+        this.verifyTask(task, deserializedTask);
+    }
+
     private void verifyTask(final Task task1, final Task task2)
     {
         Assertions.assertEquals(task1.getId(), task2.getId());