Merge pull request #8 from imsweb/retrofit-2.0

Retrofit 2.0

Author: ctmay4

README.md

@@ -29,7 +29,7 @@ Download [the latest JAR][1] or grab via Maven:
 <dependency>
     <groupId>com.imsweb</groupId>
     <artifactId>seerapi-client-java</artifactId>
-    <version>2.0</version>
+    <version>3.0</version>
 </dependency>
 ```
 
@@ -73,15 +73,15 @@ Each set of APIs are broken into their own service.  Here are the services:
 A glossary of cancer-related terms.
 
 ```java
-api.glossary().getById("latest", "4ffd7623a3dd635c99d38e2d");
+api.glossary().getById("latest", "4ffd7623a3dd635c99d38e2d").execute().body()
 ```
 
 ### Disease (rest/disease)
 
 A searchable database of hematopoietic and lymphoid neoplasms and solid tumor diseases.
 
 ```java
-api.disease().samePrimaries("9870/3", "9872/3", "2010")
+api.disease().samePrimaries("9870/3", "9872/3", "2010").execute().body()
 ```
 
 ### NAACCR (rest/naaccr)
@@ -90,15 +90,15 @@ The NAACCR API provides programmatic access to documentation for the NAACCR Stan
 field level documentation as well as information about file layout.
 
 ```java
-api.naaccr().field("14", 12)
+api.naaccr().field("14", 12).execute().body()
 ```
 
 ### RX (rest/rx)
 
 A searchable database for coding oncology drug and regimen treatment categories in cancer registries.
 
 ```java
-api.rx().getById("latest", "53c44b01102c1290262dc8b2");
+api.rx().getById("latest", "53c44b01102c1290262dc8b2").execute().body()
 ```
 
 ### SEER Incidence Site Recode (rest/recode)
@@ -109,15 +109,15 @@ cancer incidence data. For example, there is a section of the SEER Cancer Statis
 groupings in a site recode variable. The site recode variables are added to SEER databases as a convenience for researchers.
 
 ```java
-api.siteRecode().siteGroup("C619", "8000");
+api.siteRecode().siteGroup("C619", "8000").execute().body()
 ```
 
 ### Site-specific Surgery Codes (rest/surgery)
 
 The site-specific surgery tables available on the SEER website.
 
 ```java
-api.surgery().tables();
+api.surgery().tables().execute().body()
 ```
 
 ### Staging
@@ -128,7 +128,7 @@ improve data quality by standardizing rules for timing, clinical and pathologic
 systems for all cancer sites.
 
 ```
-api.staging().schemaById("cs", "02.05.50", "brain");
+api.staging().schemaById("cs", "02.05.50", "brain").execute().body()
 ```
 
 For a complete description of all available API inputs and outputs, see the SEER*API

build.gradle

@@ -8,7 +8,7 @@ plugins {
 }
 
 group = 'com.imsweb'
-version = '2.0'
+version = '3.0'
 description = 'Java client library for SEER*API'
 
 println "Starting build using ${Jvm.current()}"
@@ -21,12 +21,8 @@ repositories {
 }
 
 dependencies {
-    compile 'com.squareup.okhttp:okhttp:2.4.0'
-    compile('com.squareup.retrofit:retrofit:1.9.0') {
-        exclude module: 'gson'  // since Jackson is used, this is not needed
-    }
-
-    compile 'com.fasterxml.jackson.core:jackson-databind:2.5.3'
+    compile 'com.squareup.retrofit:retrofit:2.0.0-beta2'
+    compile 'com.squareup.retrofit:converter-jackson:2.0.0-beta2'
 
     testCompile 'junit:junit:4.11'
 }

src/main/java/com/imsweb/seerapi/client/ErrorInterceptor.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright (C) 2015 Information Management Services, Inc.
+ */
+package com.imsweb.seerapi.client;
+
+import java.io.IOException;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.squareup.okhttp.Interceptor;
+import com.squareup.okhttp.Response;
+
+/**
+ * Interceptor to catch all non-200 responses and convert them to exceptions.
+ */
+public class ErrorInterceptor implements Interceptor {
+
+    @Override
+    public Response intercept(Chain chain) throws IOException {
+        Response response = chain.proceed(chain.request());
+
+        if (response.code() != 200) {
+            // convert body to error response
+            ErrorResponse error = null;
+            if (response.body() != null) {
+                try {
+                    error = new ObjectMapper().readValue(response.body().byteStream(), ErrorResponse.class);
+                }
+                catch (IOException e) {
+                    // sometimes the error message is not right format (like for 404 errors)
+                }
+            }
+
+            String message = error == null ? "Error code " + response.code() : error.getMessage();
+
+            switch (response.code()) {
+                case 401:  // unauthorized
+                    throw new NotAuthorizedException(message);
+                case 400:  // bad request
+                    throw new BadRequestException(message);
+                case 404:
+                    throw new NotFoundException(message);
+                default:
+                    throw new SeerApiException(message);
+            }
+        }
+
+        return response;
+    }
+}

src/main/java/com/imsweb/seerapi/client/NotFoundException.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright (C) 2015 Information Management Services, Inc.
+ */
+package com.imsweb.seerapi.client;
+
+public class NotFoundException extends SeerApiException {
+
+    public NotFoundException() {
+        super();
+    }
+
+    public NotFoundException(String message) {
+        super(message);
+    }
+
+    public NotFoundException(String message, Throwable cause) {
+        super(message, cause);
+    }
+
+    public NotFoundException(Throwable cause) {
+        super(cause);
+    }
+
+}

src/main/java/com/imsweb/seerapi/client/SeerApi.java

@@ -6,9 +6,21 @@
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
+import java.text.DateFormat;
+import java.text.SimpleDateFormat;
 import java.util.Properties;
 
-import retrofit.RestAdapter;
+import com.fasterxml.jackson.annotation.JsonAutoDetect;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import com.squareup.okhttp.Interceptor;
+import com.squareup.okhttp.OkHttpClient;
+import com.squareup.okhttp.Request;
+import com.squareup.okhttp.Response;
+
+import retrofit.JacksonConverterFactory;
+import retrofit.Retrofit;
 
 import com.imsweb.seerapi.client.disease.DiseaseService;
 import com.imsweb.seerapi.client.glossary.GlossaryService;
@@ -23,79 +35,122 @@
  */
 public final class SeerApi {
 
-    RestAdapter _restAdapter;
+    private Retrofit _retroFit;
 
     /**
      * Creates a client API root object
      * @param baseUrl base URL for API
      * @param apiKey API key
      */
-    private SeerApi(String baseUrl, String apiKey) {
-        if (baseUrl.endsWith("/"))
-            baseUrl = baseUrl.substring(0, baseUrl.length() - 1);
-
-        _restAdapter = new RestAdapter.Builder()
-                .setEndpoint(baseUrl)
-                .setConverter(new SeerApiJacksonConverter())
-                .setRequestInterceptor(new SeerApiRequestInterceptor(apiKey))
-                .setErrorHandler(new SeerApiErrorHandler())
+    private SeerApi(String baseUrl, final String apiKey) {
+        if (!baseUrl.endsWith("/"))
+            baseUrl += "/";
+
+        OkHttpClient client = new OkHttpClient();
+        client.interceptors().add(new Interceptor() {
+            @Override
+            public Response intercept(Chain chain) throws IOException {
+                Request original = chain.request();
+
+                // add the api key to all requests
+                Request request = original.newBuilder()
+                        .header("Accept", "application/json")
+                        .header("X-SEERAPI-Key", apiKey)
+                        .method(original.method(), original.body())
+                        .build();
+
+                return chain.proceed(request);
+            }
+        });
+        client.interceptors().add(new ErrorInterceptor());
+
+        _retroFit = new Retrofit.Builder()
+                .baseUrl(baseUrl)
+                .addConverterFactory(JacksonConverterFactory.create(getMapper()))
+                .client(client)
                 .build();
     }
 
+    /**
+     * Return the internal ObjectMapper
+     * @return
+     */
+    protected static ObjectMapper getMapper() {
+        ObjectMapper mapper = new ObjectMapper();
+
+        // do not write null values
+        mapper.configure(SerializationFeature.WRITE_NULL_MAP_VALUES, false);
+        mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
+
+        mapper.setVisibilityChecker(mapper.getSerializationConfig().getDefaultVisibilityChecker()
+                .withFieldVisibility(JsonAutoDetect.Visibility.ANY)
+                .withGetterVisibility(JsonAutoDetect.Visibility.NONE)
+                .withSetterVisibility(JsonAutoDetect.Visibility.NONE)
+                .withCreatorVisibility(JsonAutoDetect.Visibility.NONE));
+
+        // set Date objects to output in readable customized format
+        mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
+
+        DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'");
+        mapper.setDateFormat(dateFormat);
+
+        return mapper;
+    }
+
     /**
      * Return the disease service
      * @return an interface to all the disease APIs
      */
     public DiseaseService disease() {
-        return _restAdapter.create(DiseaseService.class);
+        return _retroFit.create(DiseaseService.class);
     }
 
     /**
      * Return the glossary service
      * @return an interface to all the glossary APIs
      */
     public GlossaryService glossary() {
-        return _restAdapter.create(GlossaryService.class);
+        return _retroFit.create(GlossaryService.class);
     }
 
     /**
      * Return the NAACCR service
      * @return an inteface to all the NAACCR APIs
      */
     public NaaccrService naaccr() {
-        return _restAdapter.create(NaaccrService.class);
+        return _retroFit.create(NaaccrService.class);
     }
 
     /**
      * Return the Rx service
      * @return an inteface to all the Rx APIs
      */
     public RxService rx() {
-        return _restAdapter.create(RxService.class);
+        return _retroFit.create(RxService.class);
     }
 
     /**
      * Return the site recode service
      * @return an interface to all the site recode APIs
      */
     public SiteRecodeService siteRecode() {
-        return _restAdapter.create(SiteRecodeService.class);
+        return _retroFit.create(SiteRecodeService.class);
     }
 
     /**
      * Return the staging service
      * @return an interface to all the staging APIs
      */
     public StagingService staging() {
-        return _restAdapter.create(StagingService.class);
+        return _retroFit.create(StagingService.class);
     }
 
     /**
      * Return the surgery service
      * @return an interface to all the surgery APIs
      */
     public SurgeryService surgery() {
-        return _restAdapter.create(SurgeryService.class);
+        return _retroFit.create(SurgeryService.class);
     }
 
     /**
@@ -104,7 +159,7 @@ public SurgeryService surgery() {
     public static class Builder {
 
         // default base URL
-        private static final String _SEERAPI_URL = "https://api.seer.cancer.gov/rest";
+        private static final String _SEERAPI_URL = "https://api.seer.cancer.gov/rest/";
 
         // environment variable for URL and API key
         private static final String _ENV_URL = "SEER_API_URL";