Some minor layout and doc fixes

Author: aliok

.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 2

.gitignore

@@ -1,4 +1,5 @@
 target/
+
 pom.xml.tag
 pom.xml.releaseBackup
 pom.xml.versionsBackup
@@ -7,7 +8,11 @@ release.properties
 dependency-reduced-pom.xml
 buildNumber.properties
 .mvn/timing.properties
-.idea
-jenkins-client.iml
+
 # Exclude maven wrapper
 !/.mvn/wrapper/maven-wrapper.jar
+
+# Intellij Idea files
+.idea
+*.iml
+

src/main/java/com/redhat/digkins/DiggerClient.java

@@ -9,9 +9,7 @@
 import java.net.URISyntaxException;
 
 /**
- * Digger Java Client
- * <p>
- * Interact with digger jenkins api!
+ * Digger Java Client interact with Digger Jenkins api.
  */
 public class DiggerClient {
 
@@ -21,29 +19,14 @@ public DiggerClient(JenkinsAuth auth) throws URISyntaxException {
     this.jenkins = new JenkinsServer(new URI(auth.getUrl()), auth.getUser(), auth.getPassword());
   }
 
-  /**
-   * Create new digger job on jenkins platform
-   *
-   * @param name      - job name that can be used later to reference job
-   * @param gitRepo   - git repository url (full git repository url. e.g [email protected]:wtrocki/helloworld-android-gradle.git
-   * @param gitBranch - git repository branch (default branch used to checkout source code)
-   */
-  public void createJob(String name, String gitRepo, String gitBranch) throws DiggerClientException {
-    CreateJobService service = new CreateJobService(this.jenkins);
-    try {
-      service.create(name, gitRepo, gitBranch);
-    } catch (Throwable e) {
-      throw new DiggerClientException(e);
-    }
-  }
-
   /**
    * Create client using provided url and credentials
    *
-   * @param url      - jenkins url
-   * @param user     - jenkins user
-   * @param password - jenkins password
+   * @param url      Jenkins url
+   * @param user     Jenkins user
+   * @param password Jenkins password
    * @return client instance
+   * @throws DiggerClientException if something goes wrong
    */
   public static DiggerClient from(String url, String user, String password) throws DiggerClientException {
     try {
@@ -53,4 +36,22 @@ public static DiggerClient from(String url, String user, String password) throws
       throw new DiggerClientException("Invalid jenkins url format.");
     }
   }
+
+  /**
+   * Create new Digger job on Jenkins platform
+   *
+   * @param name      job name that can be used later to reference job
+   * @param gitRepo   git repository url (full git repository url. e.g [email protected]:wtrocki/helloworld-android-gradle.git
+   * @param gitBranch git repository branch (default branch used to checkout source code)
+   * @throws DiggerClientException if something goes wrong
+   */
+  public void createJob(String name, String gitRepo, String gitBranch) throws DiggerClientException {
+    CreateJobService service = new CreateJobService(this.jenkins);
+    try {
+      service.create(name, gitRepo, gitBranch);
+    } catch (Throwable e) {
+      throw new DiggerClientException(e);
+    }
+  }
+
 }

src/main/java/com/redhat/digkins/services/CreateJobService.java

@@ -1,24 +1,23 @@
 package com.redhat.digkins.services;
 
 import com.offbytwo.jenkins.JenkinsServer;
-import org.apache.commons.io.FileUtils;
 import org.jtwig.JtwigModel;
 import org.jtwig.JtwigTemplate;
 
-import java.io.File;
 import java.io.IOException;
 
 /**
  * Create digger job on jenkins platform
  */
 public class CreateJobService {
 
-  private JenkinsServer jenkins;
+  private final static String GIT_REPO_URL = "GIT_REPO_URL";
+  private final static String GIT_REPO_BRANCH = "GIT_REPO_BRANCH";
 
-  private final static String GIT_REPO_URL = "GIT_REPO_URL", GIT_REPO_BRANCH = "GIT_REPO_BRANCH";
+  private JenkinsServer jenkins;
 
   /**
-   * @param jenkins - jenkins api instance
+   * @param jenkins jenkins api instance
    */
   public CreateJobService(JenkinsServer jenkins) {
     this.jenkins = jenkins;
@@ -27,9 +26,9 @@ public CreateJobService(JenkinsServer jenkins) {
   /**
    * Create new digger job on jenkins platform
    *
-   * @param name      - job name that can be used later to reference job
-   * @param gitRepo   - git repository url (full git repository url. e.g [email protected]:digger/helloworld.git
-   * @param gitBranch - git repository branch (default branch used to checkout source code)
+   * @param name      job name that can be used later to reference job
+   * @param gitRepo   git repository url (full git repository url. e.g [email protected]:digger/helloworld.git
+   * @param gitBranch git repository branch (default branch used to checkout source code)
    */
   public void create(String name, String gitRepo, String gitBranch) throws IOException {
     JtwigTemplate template = JtwigTemplate.classpathTemplate("templates/job.xml");

src/main/java/com/redhat/digkins/util/DiggerClientException.java

@@ -1,7 +1,5 @@
 package com.redhat.digkins.util;
 
-import java.util.TreeMap;
-
 /**
  * Represents internal client exception
  */

src/main/java/com/redhat/digkins/util/JenkinsAuth.java

@@ -2,6 +2,8 @@
 
 /**
  * Jenkins authentication object.
+ * <p>
+ * Holds credentials in it.
  */
 public class JenkinsAuth {