improved assertions and docs

Author: stritti

src/main/java/com/sybit/airtable/Airtable.java

@@ -136,6 +136,9 @@ public Airtable configure(Configuration config) throws AirtableException {
      */
     @SuppressWarnings("WeakerAccess")
     public Airtable configure(Configuration config, ObjectMapper objectMapper) throws AirtableException {
+        assert config != null : "config was null";
+        assert objectMapper != null : "objectMapper was null";
+
         if(config.getApiKey() == null) {
             throw new AirtableException("Missing Airtable API-Key");
         }
@@ -157,17 +160,16 @@ public Airtable configure(Configuration config, ObjectMapper objectMapper) throw
 
         // Add specific Converter for Date
         DateTimeConverter dtConverter = new DateConverter();
-        ListConverter lConverter = new ListConverter();
-        MapConverter thConverter = new MapConverter();
-
-        lConverter.setListClass(Attachment.class);
-        thConverter.setMapClass(Thumbnail.class);
         dtConverter.setPattern("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'");
-
         ConvertUtils.register(dtConverter, Date.class);
+
+        ListConverter lConverter = new ListConverter();
+        lConverter.setListClass(Attachment.class);
         ConvertUtils.register(lConverter, List.class);
-        ConvertUtils.register(thConverter, Map.class);
 
+        MapConverter thConverter = new MapConverter();
+        thConverter.setMapClass(Thumbnail.class);
+        ConvertUtils.register(thConverter, Map.class);
 
         return this;
     }
@@ -235,6 +237,8 @@ public Configuration getConfig() {
     }
 
     public void setConfig(Configuration config) {
+        assert config != null : "config was null";
+
         this.config = config;
         setProxy(config.getEndpointUrl());
     }

src/main/java/com/sybit/airtable/Base.java

@@ -24,19 +24,22 @@ public class Base {
 
     private final Map<String, Table> tableMap = new HashMap<>();
 
-    private final String base;
+    private final String baseName;
 
     private final Airtable parent;
 
 
     /**
-     * Create Airtable Base with given base ID.
+     * Create Airtable Base with given baseName ID.
      *
-     * @param base base ID could be found at https://airtable.com if you select your current base.
+     * @param name base ID could be found at https://airtable.com if you select your current baseName.
      * @param airtable parent airtable object
      */
-    public Base(String base, Airtable airtable) {
-        this.base = base;
+    public Base(String name, Airtable airtable) {
+        assert name != null : "baseName was null";
+        assert airtable != null : "airtable was null";
+
+        this.baseName = name;
         this.parent = airtable;
     }
 
@@ -54,7 +57,6 @@ public Airtable airtable() {
      * @return Object to access table.
      */
     public Table table(String name) {
-
         return table(name, Records.class);
     }
 
@@ -65,6 +67,8 @@ public Table table(String name) {
      * @return Object to access table.
      */
     public Table table(String name, Class clazz) {
+        assert name != null : "name was null";
+        assert clazz != null : "clazz was null";
 
         if(!tableMap.containsKey(name)) {
             LOG.debug("Create new instance for table [" + name + "]");
@@ -77,10 +81,10 @@ public Table table(String name, Class clazz) {
     }
 
     /**
-     * Get base id of base.
-     * @return base id
+     * Get baseName id of baseName.
+     * @return baseName id
      */
     public String name() {
-        return base;
+        return baseName;
     }
 }

src/main/java/com/sybit/airtable/Configuration.java

@@ -9,6 +9,8 @@
 /**
  * Configuration settings for Airtable.
  * Used by class <code>Airtable</code> to configure basic settings.
+ *
+ * @since 0.1
  */
 public class Configuration {
 

src/main/java/com/sybit/airtable/GsonObjectMapper.java

@@ -12,7 +12,9 @@
 import java.util.logging.Logger;
 
 /**
+ * Default mapper based on GSON.
  *
+ * @since 0.1
  * @author fzr
  */
 class GsonObjectMapper implements ObjectMapper {

src/main/java/com/sybit/airtable/IOUtils.java

@@ -9,6 +9,8 @@
 
 /**
  * Interface for specific queries.
+ *
+ * @since 0.1
  */
 @SuppressWarnings("WeakerAccess")
 public interface Query {

src/main/java/com/sybit/airtable/Query.java

@@ -7,7 +7,9 @@
 package com.sybit.airtable;
 
 /**
- * Sortation helper.
+ * Sorting of query results.
+ *
+ * @since 0.1
  */
 public class Sort {
 

src/main/java/com/sybit/airtable/Sort.java

@@ -13,12 +13,9 @@
 import com.mashape.unirest.request.GetRequest;
 import com.sybit.airtable.exception.AirtableException;
 import com.sybit.airtable.exception.HttpResponseExceptionHandler;
-import com.sybit.airtable.vo.Attachment;
-import com.sybit.airtable.vo.Delete;
-import com.sybit.airtable.vo.PostRecord;
-import com.sybit.airtable.vo.RecordItem;
-import com.sybit.airtable.vo.Records;
+import com.sybit.airtable.vo.*;
 import org.apache.commons.beanutils.BeanUtils;
+import org.apache.commons.beanutils.BeanUtilsBean;
 import org.apache.commons.beanutils.PropertyUtils;
 import org.apache.http.client.HttpResponseException;
 import org.slf4j.Logger;
@@ -27,12 +24,9 @@
 import java.lang.reflect.Field;
 import java.lang.reflect.InvocationTargetException;
 import java.util.ArrayList;
-
 import java.util.List;
 import java.util.Map;
 
-import org.apache.commons.beanutils.BeanUtilsBean;
-
 /**
  * Representation Class of Airtable Tables.
  *
@@ -49,12 +43,15 @@ public class Table<T> {
 
     /**
      *
-     * @param name
-     * @param type
+     * @param name name of table.
+     * @param type class to represent table row
      */
     public Table(String name, Class<T> type) {
-        this.type = type;
+        assert name != null : "name was null";
+        assert type != null : "type was null";
+
         this.name = name;
+        this.type = type;
     }
 
     /**
@@ -78,10 +75,9 @@ public void setParent(Base parent) {
     }
 
     /**
-     * 
-     * If no Parameter ser all querys to null.
+     * Select all rows of table.
      *
-     * @return
+     * @return List of all items.
      * @throws AirtableException
      */
     public List<T> select() throws AirtableException, HttpResponseException {
@@ -122,8 +118,8 @@ public Integer getPageSize() {
     /**
      * Select List of data of table with defined Query Parameters.
      *
-     * @param query
-     * @return
+     * @param query defined query
+     * @return list of table items
      * @throws AirtableException
      */
     @SuppressWarnings("WeakerAccess")
@@ -311,10 +307,10 @@ public Integer getPageSize() {
     }
 
     /**
-     * select only Table data with defined Fields
-     * 
-     * @param fields
-     * @return
+     * Select only Table data with defined fields.
+     *
+     * @param fields array of requested fields.
+     * @return list of item using only requested fields.
      * @throws AirtableException
      * @throws HttpResponseException 
      */
@@ -385,7 +381,7 @@ private List<T> getList(HttpResponse<Records> response) {
      */
     public T find(String id) throws AirtableException {
 
-        RecordItem body = null;
+        RecordItem body;
 
         HttpResponse<RecordItem> response;
         try {
@@ -402,15 +398,14 @@ public T find(String id) throws AirtableException {
             body = response.getBody();
         } else {
             HttpResponseExceptionHandler.onResponse(response);
+            body = null;
         }
 
         try {
             return transform(body, this.type.newInstance() );
         } catch (InvocationTargetException | IllegalAccessException | InstantiationException e) {
-            LOG.error(e.getMessage(), e);
+            throw new AirtableException(e);
         }
-
-        return null;
     }
 
     /**

src/main/java/com/sybit/airtable/Table.java

@@ -7,17 +7,21 @@
 
 import com.google.gson.Gson;
 import com.mashape.unirest.http.HttpResponse;
-import com.sybit.airtable.IOUtils;
 import com.sybit.airtable.vo.Error;
 
+/**
+ * Handle HTTP responses and create exceptions.
+ *
+ * @since 0.1
+ */
 public class HttpResponseExceptionHandler {
 
     public static void onResponse(HttpResponse response) throws AirtableException {
 
-        Integer statusCode = response.getStatus();
-        String message = IOUtils.convertStreamToString(response.getRawBody());
+        final Integer statusCode = response.getStatus();
+        String message = convertStreamToString(response.getRawBody());
 
-        Gson gson = new Gson();
+        final Gson gson = new Gson();
         Error err = gson.fromJson(message, Error.class);
         switch (statusCode) {
             case 401:
@@ -48,4 +52,9 @@ public static void onResponse(HttpResponse response) throws AirtableException {
                 throw new AirtableException("UNDEFINED_ERROR", message, statusCode);
         }
     }
+
+    public static String convertStreamToString(java.io.InputStream is) {
+        java.util.Scanner s = new java.util.Scanner(is).useDelimiter("\\A");
+        return s.hasNext() ? s.next() : "";
+    }
 }

src/main/java/com/sybit/airtable/exception/HttpResponseExceptionHandler.java

@@ -6,11 +6,12 @@
 package com.sybit.airtable;
 
 import com.sybit.airtable.exception.AirtableException;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
 import org.junit.Before;
 import org.junit.Test;
 
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
 /**
  *
  * @author fzr
@@ -48,7 +49,10 @@ public void baseNameTest(){
         Base base = new Base("base", this.airtable);
         assertEquals(base.name(),"base");
     }
-    
-    
+
+    @Test(expected = java.lang.AssertionError.class )
+    public void baseAssertationTest() {
+        Base base = new Base(null,null);
+    }
 
 }