Merge pull request #2 from Sybit-Education/feauture/AttachementConverter

Feauture/attachement converter

Author: stritti

README.md

@@ -17,6 +17,15 @@ For adding dependency, you could use bintray-repository:
 
 The files are stored at: [https://dl.bintray.com/sybit-education/maven/](https://dl.bintray.com/sybit-education/maven/)
 
+## Gradle
+For Gradle add compile `com.sybit:airtable.java:[version]` to compile dependencies.
+Also add `jcenter` repository to dependencies:
+```
+repositories {
+    jcenter()
+    ...
+}
+```
 
 ## Initializing
 
@@ -71,6 +80,19 @@ Table<Actor> actorTable = base.table("Actors", Actor.class);
 Actor actor = actorTable.find("rec514228ed76ced1");
 ```
 
+## Annotations
+
+Use the Gson Annotation @SerializedName to annotate Names which contain - or an emtpy Charakter.
+
+### Example
+```Java
+
+    import com.google.gson.annotations.SerializedName;
+
+    @SerializedName("First- & Lastname")
+    private String name;
+```
+
 # Roadmap
 
 + [x] Select

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

@@ -6,11 +6,13 @@
  */
 package com.sybit.airtable;
 
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
-import com.mashape.unirest.http.ObjectMapper;
+
 import com.mashape.unirest.http.Unirest;
 import com.sybit.airtable.exception.AirtableException;
+import com.sybit.airtable.vo.Attachment;
+import com.sybit.airtable.vo.Thumbnail;
+
+import org.apache.http.HttpHost;
 import org.apache.commons.beanutils.ConvertUtils;
 import org.apache.commons.beanutils.converters.DateConverter;
 import org.apache.commons.beanutils.converters.DateTimeConverter;
@@ -20,8 +22,11 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.Date;
+import java.util.List;
+import java.util.Map;
 import java.util.Properties;
 
+
 /**
  * Representation Class of Airtable.
  * It is the entry class to access Airtable data.
@@ -49,6 +54,7 @@ public class Airtable {
      * or within credentials.properties.
      *
      * @return configured Airtable object.
+     * @throws com.sybit.airtable.exception.AirtableException Missing API-Key
      */
     @SuppressWarnings("UnusedReturnValue")
     public Airtable configure() throws AirtableException {
@@ -74,6 +80,7 @@ public Airtable configure() throws AirtableException {
      *
      * @param apiKey API-Key of Airtable.
      * @return
+     * @throws com.sybit.airtable.exception.AirtableException Missing API-Key
      */
     @SuppressWarnings("WeakerAccess")
     public Airtable configure(String apiKey) throws AirtableException {
@@ -85,6 +92,7 @@ public Airtable configure(String apiKey) throws AirtableException {
      * @param apiKey
      * @param endpointUrl
      * @return
+     * @throws com.sybit.airtable.exception.AirtableException Missing API-Key or Endpoint
      */
     @SuppressWarnings("WeakerAccess")
     public Airtable configure(String apiKey, String endpointUrl) throws AirtableException {
@@ -98,40 +106,55 @@ public Airtable configure(String apiKey, String endpointUrl) throws AirtableExce
         this.apiKey = apiKey;
         this.endpointUrl = endpointUrl;
 
-
-        final String httpProxy = System.getenv("http_proxy");
-        if(httpProxy != null) {
-            LOG.info("Use Proxy: Environment variable 'http_proxy' found and used: " + httpProxy);
-            //Unirest.setProxy(HttpHost.create(httpProxy));
-        }
-
+        setProxy(endpointUrl);
 
         // Only one time
-        Unirest.setObjectMapper(new ObjectMapper() {
-            final Gson gson = new GsonBuilder().create();
-
-            public <T> T readValue(String value, Class<T> valueType) {
-                LOG.debug("readValue: \n" + value);
-                return gson.fromJson(value, valueType);
-            }
-
-            public String writeValue(Object value) {
-                return gson.toJson(value);
-            }
-        });
+        Unirest.setObjectMapper(new GsonObjectMapper());
 
+                
         // 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);
+        ConvertUtils.register(lConverter, List.class);
+        ConvertUtils.register(thConverter, Map.class);
+        
 
         return this;
     }
 
+    /**
+     * Set Proxy environment for Unirest.
+     *
+     * Proxy will be ignored for endpointUrls containing <code>localhost</code> or <code>127.0.0.1,/code>
+     * @param endpointUrl
+     */
+    private void setProxy(String endpointUrl) {
+        final String httpProxy = System.getenv("http_proxy");
+        if(httpProxy != null
+                && (endpointUrl.contains("127.0.0.1")
+                || endpointUrl.contains("localhost"))) {
+            LOG.info("Use Proxy: ignored for 'localhost' ann '127.0.0.1'");
+            Unirest.setProxy(null);
+        } else if(httpProxy != null) {
+            LOG.info("Use Proxy: Environment variable 'http_proxy' found and used: " + httpProxy);
+            Unirest.setProxy(HttpHost.create(httpProxy));
+        } else {
+            Unirest.setProxy(null);
+        }
+    }
+
     /**
      * Getting the base by given property <code>AIRTABLE_BASE</code>.
      *
      * @return the base object.
+     * @throws com.sybit.airtable.exception.AirtableException Missing Airtable_BASE
      */
     public Base base() throws AirtableException {
 
@@ -153,6 +176,7 @@ public Base base() throws AirtableException {
      * Builder method to create base of given base id.
      * @param base the base id.
      * @return
+     * @throws com.sybit.airtable.exception.AirtableException AIRTABLE_BASE was Null
      */
     public Base base(String base) throws AirtableException {
         if(base == null) {
@@ -210,5 +234,6 @@ private String getCredentialProperty(String key) {
 
     public void setEndpointUrl(String endpointUrl) {
         this.endpointUrl = endpointUrl;
+        setProxy(endpointUrl);
     }
 }

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

@@ -0,0 +1,36 @@
+/*
+ * To change this license header, choose License Headers in Project Properties.
+ * To change this template file, choose Tools | Templates
+ * and open the template in the editor.
+ */
+package com.sybit.airtable;
+
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.mashape.unirest.http.ObjectMapper;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+/**
+ *
+ * @author fzr
+ */
+class GsonObjectMapper implements ObjectMapper{
+    private static final Logger LOG = Logger.getLogger( GsonObjectMapper.class.getName() );
+    private final Gson gson;
+                
+    public GsonObjectMapper() {
+        gson = new GsonBuilder().setDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'").create();
+     
+    }
+
+    public <T> T readValue(String value, Class<T> valueType) {
+        LOG.log(Level.INFO, "readValue: \n" + value);
+        return gson.fromJson(value, valueType);
+    }
+
+    public String writeValue(Object value) {
+        return gson.toJson(value);
+    }
+
+}

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

@@ -0,0 +1,155 @@
+/*
+ * To change this license header, choose License Headers in Project Properties.
+ * To change this template file, choose Tools | Templates
+ * and open the template in the editor.
+ */
+package com.sybit.airtable;
+
+import com.google.gson.internal.LinkedTreeMap;
+import java.lang.reflect.InvocationTargetException;
+import java.util.ArrayList;
+import java.util.List;
+import org.apache.commons.beanutils.BeanUtils;
+import org.apache.commons.beanutils.converters.AbstractConverter;
+
+/**
+ * 
+ * org.apache.commons.beanutils.Converter implementaion
+ * that handles conversion to and from List<T> objects.
+ *
+ * <p>This implementation converts List&lt;T&gt; to List&lt;innerClass&gt;.
+ * The innerClass can be set to the Class that is needed.</p>
+ *
+ * @author fzr
+ */
+public class ListConverter extends AbstractConverter {
+    
+    private Class listClass;
+    
+    /**
+     * 
+     * Method overwritten so it doesent return only the first Element of the Array. 
+     * 
+     * @param value The Input Value
+     * @return value The value to be returned
+     */
+    @Override
+    protected Object convertArray(final Object value) {
+        return value;
+    }
+
+    /**
+     * 
+     * Convert the Input Object into a List of Attachements
+     * 
+     * This Method handles the conversion from a List of LinkedHashMaps to a List of Attachement Objects.
+     * 
+     * <p>If the Input Object is no List or the List Item is no LinkedHashMap everything will be converted into a (List?) String.</p>
+     * 
+     * @param type The type of the Input Object
+     * @param value The value of the Input Object
+     * @return A List
+     * @throws java.lang.InstantiationException If no Instance of the listClass can be instantiated
+     * @throws java.lang.IllegalAccessException If the Object can't be accest
+     * @throws java.lang.reflect.InvocationTargetException If th Target can't be accessed
+     */
+    @Override
+    protected <T> T convertToType(final Class<T> type, Object value) throws InstantiationException, IllegalAccessException, InvocationTargetException  {
+        
+        List<T> returnList = new ArrayList<>();
+          
+        if(value instanceof List){
+            for (T item: ((List<T>) value)){
+                if(item instanceof LinkedTreeMap){
+                    Object instanz = this.listClass.newInstance();
+                    for (String key : ((LinkedTreeMap<String, Object>) item).keySet()) {
+                        Object val = ((LinkedTreeMap) item).get(key);            
+                        BeanUtils.setProperty(instanz,key,val);     
+                    }         
+                    returnList = toClassList(item.getClass(),instanz,returnList);        
+                }
+                if(item instanceof String){
+                    returnList = toStringList(item.getClass(),item.toString(),returnList);
+                }
+                
+            }       
+            return (T) returnList;  
+        }
+        
+        
+        //TODO überarbeiten
+        if(value instanceof String){
+            return (T) toStringList(value.getClass(),value.toString(),returnList);
+        }
+        
+        final String stringValue = value.toString().trim();
+        if (stringValue.length() == 0) {
+            return handleMissing(type);
+        }
+            
+        return (T) toStringList(value.getClass(),stringValue,returnList);
+    }
+    
+    /**
+     * Default toString conversion
+     * 
+     * @param type The type of the Class
+     * @param value The String value
+     * @param returnList A List of all currently converted Objects
+     * @return A List
+     */
+    private List toStringList(final Class type, final String value,List returnList) {
+         
+        if (type.equals(String.class)) {      
+            returnList.add(String.valueOf(value));
+            return returnList;
+        }
+        
+        returnList.add(String.valueOf(value));    
+        return returnList;
+    }
+    
+    /**
+     * Default conversion to specified Class.
+     * 
+     * <p>If conversion is not possible default toString.</p>
+     * 
+     * @param type The type of the Class
+     * @param value The value of the Input Object
+     * @param returnList A List of all currently converted Objects
+     * @return A List
+     */
+    private List toClassList(final Class type, final Object value, List returnList) {
+        
+        if (type.equals(LinkedTreeMap.class)) {
+            returnList.add(value);
+            return returnList;
+        }
+        
+        return toStringList(type,value.toString(),returnList);
+    }
+
+    /**
+     * @param listClass the listClass to set
+     */
+    public void setListClass(Class listClass) {
+        this.listClass = listClass;
+    }
+   
+    //TODO Default überlegen
+    @Override
+    protected Class<?> getDefaultType() {
+        throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
+    }
+
+
+
+
+
+
+
+    
+
+    
+    
+}