Merge pull request #2 from BlockScore/java-4.0

Java 4.0

Author: alainmeier

CHANGELOG

@@ -0,0 +1,11 @@
+=== 4.0.0 2015-06-04
+
+- Added support for version 4 of the API
+
+=== 3.0.2 2014-10-03
+
+- Fixed a bug in listing verifications.
+
+=== 3.0.1 2014-10-01
+
+- Initial release

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013-2015 BlockScore
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,33 +1,57 @@
-blockscore-java
-===============
+# blockscore-java [![Circle CI](https://circleci.com/gh/BlockScore/blockscore-java/tree/java-4.0.svg?style=shield)](https://circleci.com/gh/BlockScore/blockscore-java/tree/java-4.0)
 
-An API wrapper for the BlockScore API using Java.
+This is the official library for Java clients of the BlockScore API. [Click here to read the full documentation including code examples](http://docs.blockscore.com/v4.0/java/).
 
-Latest Revision: <b>3.0.2</b> <br />
-API Compatibility: <b>3.0</b>
+## Requirements
 
-##Release Notes
-Version: 3.0.2
+- Java 1.7 and later
 
-1. Fixed a bug in listing verifications.
+## Installation
 
-##System Requirements (For building and usage)
-1. Java 1.7+
+### Maven users
+
+### Gradle users
 
-##How to build
 1. Clone this repository
 2. `./gradlew build`
 3. `./gradlew jar` (Builds the standard JAR) or `./gradlew fatJar` (Builds the plug and play jar)
 
-##How to run code quality tools
-1. Checkstyle (Ensures code style) `./gradlew checkstyleMain`
-2. PMD (Checks for bugs) `./gradlew pmdMain`
-3. Findbugs (Checks for bugs) `./gradlew findbugsMain`
-4. JUnit (Tests) `./gradlew build`
-
-##Dependencies Required (If using standard JAR)
-1. Retrofit 1.6.1+
-2. Retrofit Converter-Jackson 1.6.1+
-3. RxJava 1.0+
-4. OkHTTP 2.0+
-5. OkHTTP UrlConnection 2.0+
+### Others
+
+You can download our JAR files from here: https://github.com/BlockScore/blockscore-java/releases
+
+## Usage
+
+```java
+BlockscoreApiClient client = new BlockscoreApiClient("your api key here");
+
+Address address = new Address();
+address.setStreet1("1 Infinite Loop")
+       .setStreet2("Apt 6")
+       .setCity("Cupertino")
+       .setSubdivision("CA")
+       .setPostalCode("95014")
+       .setCountryCode("US");
+
+SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd");
+Date dateOfBirth = dateOfBirth = formatter.parse("1980-08-23");
+
+Person.Builder personBuilder = new Person.Builder(client);
+personBuilder.setFirstName("John")
+             .setMiddleName("Pearce")
+             .setLastName("Doe")
+             .setDocumentType("ssn")
+             .setDocumentValue("0000")
+             .setAddress(address)
+             .setDateOfBirth(dateOfBirth);
+
+Person person = personBuilder.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,11 +1,11 @@
 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'
@@ -15,47 +15,69 @@ apply plugin: 'checkstyle'
 apply plugin: 'eu.appsatori.fatjar'
 
 sourceCompatibility = 1.7
-version = '3.0.2'
+targetCompatibility = 1.7
+version = '4.0.0'
 
 repositories {
-    mavenCentral()
+  mavenCentral()
+}
+
+checkstyle {
+  toolVersion = "6.7"
 }
 
 dependencies {
-    compile 'com.squareup.retrofit:retrofit:+'
-    compile 'com.squareup.retrofit:converter-jackson:+'
-    compile 'io.reactivex:rxjava:+'
-    compile 'com.squareup.okhttp:okhttp:+'
-    compile 'com.squareup.okhttp:okhttp-urlconnection:+'
+  compile 'com.squareup.retrofit:retrofit:+'
+  compile 'com.squareup.retrofit:converter-jackson:+'
+  compile 'com.squareup.okhttp:okhttp:+'
+  compile 'com.squareup.okhttp:okhttp-urlconnection:+'
 
-    //Used for static analysis
-    compile 'com.intellij:annotations:+'
-    compile 'com.google.code.findbugs:annotations:+'
+  //Used for static analysis
+  compile 'com.intellij:annotations:+'
+  compile 'com.google.code.findbugs:annotations:+'
+
+  //Used for testing only.
+  testCompile 'junit:junit:+'
+}
 
-    //Used for testing only.
-    testCompile 'junit:junit:+'
+task docs(type: Javadoc) {
+  source = sourceSets.main.allJava
+  options {
+    links("http://docs.oracle.com/javase/7/docs/api/");
+  }
 }
 
 jar {
-    manifest {
-        attributes("Implementation-Title": "Blockscore Java API"
-                , "Implementation-Version": version
-                , "Implementation-Vendor": "Blockscore Inc.")
-    }
+  manifest {
+    attributes("Implementation-Title": "Blockscore Java API",
+                "Implementation-Version": version,
+                "Implementation-Vendor": "Blockscore Inc.")
+  }
 }
 
 test {
-    testLogging {
-        // Show that tests are run in the command-line output
-        events 'started', 'passed'
-    }
+  testLogging {
+    // Show that tests are run in the command-line output
+    events 'started', 'passed'
+    showStandardStreams true
+  }
 }
 
 tasks.withType(FindBugs) {
-    reports {
-        xml.enabled = false;
-        html.enabled = true;
-    }
+  reports {
+    xml.enabled = false;
+    html.enabled = true;
+  }
 }
 
-checkstyleTest.exclude '**/src/test/**'
+pmd {
+  sourceSets = [sourceSets.main]
+}
+
+checkstyleTest.exclude '**/src/test/**'
+
+
+// Use java's linting facilities
+tasks.withType(JavaCompile) {
+  options.compilerArgs << "-Xlint"
+}