Updating documentation & gradle file

Author: dgollahon

README.md

@@ -25,16 +25,28 @@ Add this dependency to your project's POM:
 Add this dependency to your project's build file:
 
 ```groovy
-compile "com.blockscore:blockscore-java:4.0.0"
+compile 'com.blockscore:blockscore-java:4.0.0'
 ```
 
 ### Others
 
 You can download our JAR files from here: https://github.com/BlockScore/blockscore-java/releases
 
+Or, alternatively, build from source by
+1. Cloning this repo
+2. `./gradlew :build`
+3. `./gradlew :jar` (Builds the standard JAR) or `./gradlew :fatJar` (Builds the plug and play jar)
+
 ## Usage
 
 ```java
+import com.blockscore.models.Address;
+import com.blockscore.models.Person;
+import com.blockscore.net.BlockscoreApiClient;
+
+import java.text.SimpleDateFormat;
+import java.util.Date;
+
 BlockscoreApiClient client = new BlockscoreApiClient("your api key here");
 
 Address address = new Address();
@@ -59,11 +71,3 @@ builder.setFirstName("John")
 
 Person person = builder.create();
 ```
-
-## Generating Javadocs
-
-Enter `./gradlew docs` and a new copy of the Javadocs can be found in `build/docs/javadoc`.
-
-## Testing
-
-You must have gradle installed. Tests can be run by typing `./gradlew :test`.

build.gradle

@@ -1,50 +1,46 @@
 buildscript {
-  repositories {
-    jcenter()
-  }
+    repositories {
+        jcenter()
+    }
 
-  dependencies {
-    classpath 'eu.appsatori:gradle-fatjar-plugin:0.3'
-  }
+    dependencies {
+        classpath 'eu.appsatori:gradle-fatjar-plugin:0.3'
+    }
 }
 
 apply plugin: 'java'
 apply plugin: 'findbugs'
 apply plugin: 'pmd'
 apply plugin: 'checkstyle'
 apply plugin: 'eu.appsatori.fatjar'
+apply plugin: 'maven'
+apply plugin: 'signing'
 
 sourceCompatibility = 1.7
 targetCompatibility = 1.7
-version = '4.0.0'
 
-repositories {
-  mavenCentral()
-}
+group = "com.blockscore"
+archivesBaseName = "blockscore-java"
+version = "4.0.0"
 
-checkstyle {
-  toolVersion = "6.7"
+repositories {
+  jcenter()
 }
 
 dependencies {
-  compile 'com.squareup.retrofit:retrofit:+'
-  compile 'com.squareup.retrofit:converter-jackson:+'
-  compile 'com.squareup.okhttp:okhttp:+'
-  compile 'com.squareup.okhttp:okhttp-urlconnection:+'
+  compile 'com.squareup.retrofit:retrofit:1.9.0'
+  compile 'com.squareup.retrofit:converter-jackson:1.9.0'
+  compile 'com.squareup.okhttp:okhttp:2.4.0'
+  compile 'com.squareup.okhttp:okhttp-urlconnection:2.4.0'
 
-  //Used for static analysis
-  compile 'com.intellij:annotations:+'
-  compile 'com.google.code.findbugs:annotations:+'
+  compile 'com.intellij:annotations:12.0'
+  compile 'com.google.code.findbugs:annotations:2.0.2'
 
-  //Used for testing only.
-  testCompile 'junit:junit:+'
+  testCompile 'junit:junit:4.12'
 }
 
-task docs(type: Javadoc) {
-  source = sourceSets.main.allJava
-  options {
-    links("http://docs.oracle.com/javase/7/docs/api/");
-  }
+tasks.withType(JavaCompile) {
+  options.compilerArgs << "-Xlint"
 }
 
 jar {
@@ -57,7 +53,6 @@ jar {
 
 test {
   testLogging {
-    // Show that tests are run in the command-line output
     events 'started', 'passed'
     showStandardStreams true
   }
@@ -74,10 +69,76 @@ pmd {
   sourceSets = [sourceSets.main]
 }
 
-checkstyleTest.exclude '**/src/test/**'
+checkstyle {
+  toolVersion = "6.7"
+  sourceSets = [ sourceSets.main ]
+}
+
+task javadocJar(type: Jar) {
+    classifier = 'javadoc'
+    from javadoc
+}
 
+task sourcesJar(type: Jar) {
+    classifier = 'sources'
+    from sourceSets.main.allSource
+}
 
-// Use java's linting facilities
-tasks.withType(JavaCompile) {
-  options.compilerArgs << "-Xlint"
-}
+artifacts {
+    archives javadocJar, sourcesJar
+}
+
+uploadArchives {
+  repositories {
+    mavenDeployer {
+      beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }
+
+      repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") {
+        authentication(userName: '', password: '')
+      }
+
+      snapshotRepository(url: "https://oss.sonatype.org/content/repositories/snapshots/") {
+        authentication(userName: '', password: '')
+      }
+
+      pom.project {
+        name 'Blockscore API'
+        packaging 'jar'
+        description 'The Blockscore API wrapper for java.'
+        url 'http://docs.blockscore.com/v4.0/java/#introduction'
+
+        scm {
+          connection 'scm:git:[email protected]:BlockScore/blockscore-java.git'
+          developerConnection 'scm:git:[email protected]:BlockScore/blockscore-java.git'
+          url '[email protected]:BlockScore/blockscore-java.git'
+        }
+
+        licenses {
+          license {
+            name 'MIT License'
+            url 'http://opensource.org/licenses/MIT'
+          }
+        }
+
+        developers {
+          developer {
+            id 'dgollahon'
+            name 'Daniel Gollahon'
+            email '[email protected]'
+          }
+
+          developer {
+            id 'ameier'
+            name 'Alain Meier'
+            email '[email protected]'
+          }
+        }
+      }
+    }
+  }
+}
+
+signing {
+  required { gradle.taskGraph.hasTask("uploadArchives") }
+  sign configurations.archives
+}

src/main/java/com/blockscore/models/Candidate.java

@@ -33,7 +33,7 @@ public class Candidate extends BasicResponse {
   @NotNull
   @JsonProperty("name_last")
   private String lastName;
-  
+
   @Nullable
   @JsonProperty("note")
   private String note;
@@ -53,11 +53,11 @@ public class Candidate extends BasicResponse {
   @NotNull
   @JsonProperty("address_street1")
   private String addressStreet1;
-  
+
   @Nullable
   @JsonProperty("address_street2")
   private String addressStreet2;
-  
+
   @NotNull
   @JsonProperty("address_city")
   private String addressCity;
@@ -69,7 +69,7 @@ public class Candidate extends BasicResponse {
   @NotNull
   @JsonProperty("address_postal_code")
   private String addressPostalCode;
-  
+
   @NotNull
   @JsonProperty("address_country_code")
   private String addressCountryCode;
@@ -97,7 +97,7 @@ public void delete() {
 
   /**
    * Returns a complete revision history of a candidate's edits. This allows you to maintain a full
-   * audit trail of when and how you update a client's profile over time. The latest revision is 
+   * audit trail of when and how you update a client's profile over time. The latest revision is
    * presented at the top of the list, and the original is at the end of the list.
    * @return the list of candidates
    */
@@ -217,7 +217,7 @@ public Candidate setNote(@Nullable final String note) {
     this.note = note;
     return this;
   }
-  
+
   /**
    * Can be either the last 4 digits of the US Social Security Number or the whole SSN.
    *
@@ -357,7 +357,7 @@ public Date getDateOfBirth() {
   public Address getAddress() {
     Address addressObject = new Address(addressStreet1,
                       addressStreet2,
-                      addressCity, 
+                      addressCity,
                       addressSubdivision,
                       addressPostalCode,
                       addressCountryCode);
@@ -366,6 +366,8 @@ public Address getAddress() {
 
   /**
    * Sets the internal REST api adapter needed to complete Blockscore API requests.
+   *
+   * @param restAdapter  the REST adapter
    */
   public void setAdapter(BlockscoreRestAdapter restAdapter) {
     this.restAdapter = restAdapter;
@@ -431,7 +433,7 @@ public Builder setNote(@Nullable final String note) {
       candidate.setNote(note);
       return this;
     }
-    
+
     /**
      * Can be either the last 4 digits of the US Social Security Number or the whole SSN.
      *

src/main/java/com/blockscore/models/Person.java

@@ -60,11 +60,11 @@ public class Person extends BasicResponse {
   @NotNull
   @JsonProperty("address_street1")
   private String addressStreet1;
-  
+
   @Nullable
   @JsonProperty("address_street2")
   private String addressStreet2;
-  
+
   @NotNull
   @JsonProperty("address_city")
   private String addressCity;
@@ -76,7 +76,7 @@ public class Person extends BasicResponse {
   @NotNull
   @JsonProperty("address_postal_code")
   private String addressPostalCode;
-  
+
   @NotNull
   @JsonProperty("address_country_code")
   private String addressCountryCode;
@@ -112,6 +112,8 @@ private Person() {
 
   /**
    * Sets the internal REST api adapter needed to complete Blockscore API requests.
+   * 
+   * @param restAdapter  the REST adapter
    */
   public void setAdapter(BlockscoreRestAdapter restAdapter) {
     this.restAdapter = restAdapter;
@@ -225,7 +227,7 @@ public Date getDateOfBirth() {
   public Address getAddress() {
     Address addressObject = new Address(addressStreet1,
                       addressStreet2,
-                      addressCity, 
+                      addressCity,
                       addressSubdivision,
                       addressPostalCode,
                       addressCountryCode);
@@ -273,7 +275,7 @@ public boolean isValid() {
   }
 
   /**
-   * Contains a breakdown of how the status (validity) was determined. It will let you diagnose 
+   * Contains a breakdown of how the status (validity) was determined. It will let you diagnose
    * problems like address inconsistencies.
    *
    * @return the details breakdown
@@ -405,7 +407,7 @@ public Builder setAddress(@NotNull final Address address) {
      *
      * <p>
      * If you set the phone number, we will use it as an additional
-     * 'positive' data point for the consumer. That is, if it is provided, it will help us identify 
+     * 'positive' data point for the consumer. That is, if it is provided, it will help us identify
      * them, but if we cannot, they will not be penalized.
      *
      * @param phoneNumber  the phone number for this individual.
@@ -423,7 +425,7 @@ public Builder setPhoneNumber(@Nullable final String phoneNumber) {
      * <p>
      * Your customers' IP address can be passed to us for storage
      * purposes. Soon we will be using this information for anti-fraud and verification purposes.
-     * With this information we will be able to back-test your verifications when this feature is 
+     * With this information we will be able to back-test your verifications when this feature is
      * released.
      *
      * @param ipAddress  the IP address

src/main/java/com/blockscore/net/UserAgentInterceptor.java

@@ -1,9 +1,9 @@
 package com.blockscore.net;
 
-import com.squareup.okhttp.Interceptor;
 import com.squareup.okhttp.Interceptor.Chain;
-import com.squareup.okhttp.Response;
+import com.squareup.okhttp.Interceptor;
 import com.squareup.okhttp.Request;
+import com.squareup.okhttp.Response;
 
 import java.io.IOException;