Merge pull request #13 from Sybit-Education/develop

Develop

Author: Zelle97

README.md

@@ -67,9 +67,14 @@ logging framework at deployment time.
 The API of Airtable itself is limited to 5 requests per second. If you exceed this rate, you will receive a 429 status code and will 
 need to wait 30 seconds before subsequent requests will succeed.
 
-*TODO:*
-* How to create an Airtable Object
-* How to create an Airtable Base
+### Connecting to Airtable
+To use this Libraray you will need a Airtable Object. Simply create one! `Airtable airtable = new Airtable();`.
+This Object needs an API-Key or it won't work properly so `airtable.configure(AIRTABLE_API_KEY);`.
+Now the Airtable Object needs to know on which base you want access. This Method will return a Base Object which will be used in the Future.
+`Base base = airtable.base(AIRTABLE_BASE);`
+
+With the Base object you can perform all kind of Operations see more [here](#crud-operations-on-table-records).
+
 
 ## Object Mapping
 The Java implementation of the Airtable API provides automatic Object mapping. You can map any Table to your own Java Classes.
@@ -146,7 +151,7 @@ Now our Java Class should look like this:
       }
   }
 ```
-For each column we give the Java class an attribute with the column name (Be careful! See more about naming in the [Section 'Annotations'](#annotations)) 
+For each column we give the Java class an attribute with the column name (Be careful! See more about naming in the Section [Annotations](#annotations)) 
 and add Getters and Setters for each attribute. The attribute types can be either primitive Java types like `String` and `Float` for Text and Numbers,
 `String Array` for references on other Tables or `Attachment` for attached photos and files.
 
@@ -209,6 +214,21 @@ The airtable.java API will respect these mappings automatically.
     @SerializedName("First- & Lastname")
     private String name;
 ```
+### Sort
+With the integrated Sort element you can retrieve a list of sort objects that specifies how the records will be ordered. 
+Each sort object must have a field key specifying the name of the field to sort on, and an optional direction key that is either "asc" or "desc".
+The default direction is "asc".
+
+For example, to sort records by Name, pass in:
+
+```Java
+Sort sort = new Sort("Name", Sort.Direction.desc);
+List<Movie> listMovies = movieTable.select(sort);
+```
+If you set the view parameter, the returned records in that view will be sorted by these fields.
+
+Detailed Example see [TableParameterTest](https://github.com/Sybit-Education/airtable.java/blob/develop/src/test/java/com/sybit/airtable/TableParameterTest.java)
+
 
 ## CRUD-Operations on Table Records
 
@@ -217,9 +237,11 @@ Select list of items from table:
 
 + `table(name).select()`: get all records of table `name`
 + `table(name).select(Integer maxRecords)`: get max `maxRecords` records of table `name`
++ `table(name).select(String[] fields)`: get records of table `name` with only the specified `fields`
++ `table(name).select(String view)`: get records of table `name` with the specified `view` (more about [views](https://support.airtable.com/hc/en-us/sections/200644955-Views))
++ `table(name).select(Sort sortation)`: get records of table `name` using `sort` to sort records (More about Sort [here](#sort))
 + `table(name).select(Query query)`: get records of table `name` using `query` to filter
 
-+ `...`
 
 ### Example
 ```Java
@@ -276,6 +298,8 @@ newActor.setName("Neuer Actor");
 Actor test = actorTable.create(newActor);
 ```
 
+Detailed example see [TableDestroyTest.java](https://github.com/Sybit-Education/airtable.java/blob/develop/src/test/java/com/sybit/airtable/TableCreateRecordTest.java)
+
 ## Update
 Use `update` to update a record of table:
 
@@ -292,6 +316,8 @@ marlonBrando.setName("Marlon Brando");
 Actor updated = actorTable.update(marlonBrando);
 ```
 
+Detailed example see [TableUpdateTest](https://github.com/Sybit-Education/airtable.java/blob/develop/src/test/java/com/sybit/airtable/TableUpdateTest.java)
+
 # Roadmap
 
 Short overview of features, which are supported:
@@ -304,8 +330,8 @@ Short overview of features, which are supported:
 + [x] Select Records
   + [x] SelectAll
   + [x] Queries (`maxRecords`, `sort` & `view` )
-  + [ ] Support of `filterByFormula`
-  + [ ] Support of Paging
+  + [x] Support of `filterByFormula`
+  + [x] Support of Paging
 
 + [x] Find Record
 

build.gradle

@@ -1,4 +1,9 @@
-import com.smokejumperit.gradle.report.DependencyLicensePlugin
+/*
+ * The MIT License (MIT)
+ * Copyright (c) 2017 Sybit GmbH
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ */
 
 /*
  * Gets the version name from the latest Git tag
@@ -16,12 +21,6 @@ def getVersionName = { ->
         return version;
     }
 }
-/*
- * The MIT License (MIT)
- * Copyright (c) 2017 Sybit GmbH
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- */
 
 buildscript {
     repositories {
@@ -40,7 +39,6 @@ apply plugin: 'maven'
 apply plugin: 'com.palantir.jacoco-coverage'
 apply plugin: 'maven-publish'
 apply plugin: 'com.jfrog.bintray'
-apply plugin: DependencyLicensePlugin
 
 group = 'com.sybit'
 version = getVersionName()
@@ -82,18 +80,22 @@ dependencies {
     codacy group: 'com.codacy', name: 'codacy-coverage-reporter', version: '1.0.13'
 }
 
-
-// custom tasks for creating source/javadoc jars
+// custom tasks for creating source jar
 task sourcesJar(type: Jar, dependsOn: classes) {
     classifier = 'sources'
     from sourceSets.main.allSource
 }
-
+// custom tasks for creating javadoc jar
 task javadocJar(type: Jar, dependsOn: javadoc) {
     classifier = 'javadoc'
     from javadoc.destinationDir
 }
 
+// add javadoc/source jar tasks as artifacts
+artifacts {
+    archives sourcesJar, javadocJar
+}
+
 task sendCoverageToCodacy(type: JavaExec, dependsOn: jacocoTestReport) {
     main = "com.codacy.CodacyCoverageReporter"
     classpath = configurations.codacy
@@ -105,10 +107,6 @@ task sendCoverageToCodacy(type: JavaExec, dependsOn: jacocoTestReport) {
     ]
 }
 
-// add javadoc/source jar tasks as artifacts
-artifacts {
-    archives sourcesJar, javadocJar
-}
 
 publishing {
     publications {
@@ -146,4 +144,4 @@ bintray {
             released = new Date()
         }
     }
-}
+}

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

@@ -12,6 +12,16 @@
  */
 @SuppressWarnings("WeakerAccess")
 public interface Query {
+    
+    /**
+     * @return Fields to be loaded 
+     */
+    String [] getFields();
+    
+    /**
+     * @return the number of records per page
+     */
+    Integer getPageSize();
 
     /**
      * @return number of max rows to load.

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

@@ -38,7 +38,7 @@
  *
  * @since 0.1
  */
-class Table<T> {
+public class Table<T> {
 
     private static final Logger LOG = LoggerFactory.getLogger( Table.class );
 
@@ -78,6 +78,8 @@ public void setParent(Base parent) {
     }
 
     /**
+     * 
+     * If no Parameter ser all querys to null.
      *
      * @return
      * @throws AirtableException
@@ -103,17 +105,26 @@ public List<Sort> getSort() {
             public String filterByFormula() {
                 return null;
             }
+
+            @Override
+            public String[] getFields() {
+                return null;
+            }
+
+            @Override
+            public Integer getPageSize() {
+                return null;
+            }
         });
 
     }
 
     /**
-     * Select List of data of table.
+     * Select List of data of table with defined Query Parameters.
      *
      * @param query
      * @return
      * @throws AirtableException
-     * @throws HttpResponseException
      */
     @SuppressWarnings("WeakerAccess")
     public List<T> select(Query query) throws AirtableException {
@@ -122,6 +133,12 @@ public List<T> select(Query query) throws AirtableException {
             GetRequest request = Unirest.get(getTableEndpointUrl())
                     .header("accept", "application/json")
                     .header("Authorization", getBearerToken());
+            if(query.getFields() != null && query.getFields().length > 0){ 
+                String[] fields = query.getFields();
+                for (int i = 0; i < fields.length; i++) {
+                    request.queryString("fields[]",fields[i]);     
+                }      
+            }
             if(query.getMaxRecords() != null) {
                 request.queryString("maxRecords", query.getMaxRecords());
             }
@@ -131,6 +148,13 @@ public List<T> select(Query query) throws AirtableException {
             if(query.filterByFormula() != null) {
                 request.queryString("filterByFormula", query.filterByFormula());
             }
+            if(query.getPageSize() != null){
+                if (query.getPageSize() > 100) {
+                    request.queryString("pageSize",100);
+                } else {
+                    request.queryString("pageSize",query.getPageSize());
+                }      
+            }
             if(query.getSort() != null) {
                 int i = 0;
                 for (Sort sort : query.getSort()) {
@@ -158,7 +182,14 @@ public List<T> select(Query query) throws AirtableException {
         return list;
     }
 
-
+    /**
+     * select with Parameter maxRecords
+     * 
+     * @param maxRecords
+     * @return
+     * @throws AirtableException
+     * @throws HttpResponseException 
+     */
     public List<T> select(Integer maxRecords) throws AirtableException, HttpResponseException {
         return select(new Query() {
             @Override
@@ -180,6 +211,16 @@ public List<Sort> getSort() {
             public String filterByFormula() {
                 return null;
             }
+
+            @Override
+            public String[] getFields() {
+                return null;
+            }
+
+            @Override
+            public Integer getPageSize() {
+                return null;
+            }
         });
     }
 
@@ -211,11 +252,22 @@ public List<Sort> getSort() {
             public String filterByFormula() {
                 return null;
             }
+
+            @Override
+            public String[] getFields() {
+                return null;
+            }
+
+            @Override
+            public Integer getPageSize() {
+                return null;
+            }
         });
     }
 
     /**
-     *
+     *select Table data with defined sortation
+     * 
      * @param sortation
      * @return
      * @throws AirtableException
@@ -245,6 +297,59 @@ public List<Sort> getSort() {
             public String filterByFormula() {
                 return null;
             }
+
+            @Override
+            public String[] getFields() {
+                return null;
+            }
+
+            @Override
+            public Integer getPageSize() {
+                return null;
+            }
+        });
+    }
+    
+    /**
+     * select only Table data with defined Fields
+     * 
+     * @param fields
+     * @return
+     * @throws AirtableException
+     * @throws HttpResponseException 
+     */
+    public List<T> select(String[] fields) throws AirtableException, HttpResponseException {
+
+        return select(new Query() {
+            @Override
+            public Integer getMaxRecords() {
+                return null;
+            }
+
+            @Override
+            public String getView() {
+                return null;
+            }
+
+            @Override
+            public List<Sort> getSort() {
+                return null;
+            }
+
+            @Override
+            public String filterByFormula() {
+                return null;
+            }
+
+            @Override
+            public String[] getFields() {
+                return fields;
+            }
+
+            @Override
+            public Integer getPageSize() {
+                return null;
+            }
         });
     }