Get response fields by defining the excluded fields. (#32)

* Get the required response fields by define the excluded fields.

* Get the required response fields by define the excluded fields.

Co-authored-by: tmoskovitch <[email protected]>

Author: zacmos

README.md

@@ -26,6 +26,7 @@ Twitter API v2 available endpoints
 - [Authentication](#authentication)
   - [Auto Refresh Token](#auto-refresh-token)
 - [Rate limits retry mechanism](#rate-limits-retry-mechanism)
+- [Get all fields](#get-all-fields)
 - [Documentation for API Endpoints](#documentation-for-api-endpoints)
 - [Documentation for Models](#documentation-for-models)
 
@@ -239,6 +240,32 @@ In order to use the retry mechanism call the APIs with an additional parameter `
 Read more about Filtered stream and [rate limits](https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/integrate/handling-disconnections)
 
 
+## Get all fields
+
+
+The Twitter API v2 endpoints are equipped with a set of parameters called [fields](https://developer.twitter.com/en/docs/twitter-api/fields), which allows you to select just the data that you want from each of the objects in your endpoint response.
+
+When you need to get many fields in the response object it can be a bit gruelling to define all the needed fields.
+In order to make it easier, you can use the `excludeInputFields` approach. Instead of selecting the data that you want to get, you define which fields should be excluded from the response object.
+Using `excludeInputFields()` will change the behaviour of the execution, in this case all response fields will be returned besides the ones that were sent as input parameters.
+
+
+```java
+    Set<String> tweetFields = new HashSet<>();
+    tweetFields.add("non_public_metrics");
+    tweetFields.add("promoted_metrics");
+    tweetFields.add("organic_metrics");
+
+    // Get all available fields excluding Tweet Fields `non_public_metrics`, `promoted_metrics` & `organic_metrics`
+    Get2TweetsIdResponse result = apiInstance.tweets().findTweetById("20")
+        .tweetFields(tweetFields).excludeInputFields().execute();
+
+    // Get all the response fields
+    Get2TweetsIdResponse result2 = apiInstance.tweets().findTweetById("20").excludeInputFields().execute();
+
+```
+
+
 ## Documentation for API Endpoints
 
 All URIs are relative to *https://api.twitter.com*

sdk.properties

@@ -0,0 +1 @@
+sdk.exclude.fields=tweetFields, userFields, expansions, mediaFields, placeFields, pollFields, searchCountFields, spaceFields, complianceJobFields

src/main/java/com/twitter/clientlib/SDKConfig.java

@@ -0,0 +1,50 @@
+/*
+Copyright 2020 Twitter, Inc.
+SPDX-License-Identifier: Apache-2.0
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+https://openapi-generator.tech
+Do not edit the class manually.
+*/
+
+
+package com.twitter.clientlib;
+
+import java.io.FileInputStream;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.Properties;
+
+
+public class SDKConfig {
+  private static final Properties sdkProperties = new Properties();
+  private static final List<String> allowlistedExcludeInputFields;
+
+  static {
+    try {
+      sdkProperties.load(new FileInputStream("sdk.properties"));
+    } catch (Exception e) {
+      e.printStackTrace();
+    }
+    String sdkExcludeInputFields = sdkProperties.getProperty("sdk.exclude.fields");
+    sdkExcludeInputFields = sdkExcludeInputFields == null ? "" : sdkExcludeInputFields;
+    allowlistedExcludeInputFields = Collections.unmodifiableList(Arrays.asList(sdkExcludeInputFields.split("[, ]+")));
+  }
+
+  public static boolean isFieldAllowlisted(String field ) {
+    return allowlistedExcludeInputFields.contains(field);
+  }
+}

src/main/java/com/twitter/clientlib/api/ApiCommon.java

@@ -22,13 +22,14 @@
 
 package com.twitter.clientlib.api;
 
-import com.github.scribejava.core.model.OAuth2AccessToken;
-
 import java.util.Calendar;
 import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
 
 import com.twitter.clientlib.ApiClient;
 import com.twitter.clientlib.ApiException;
+import com.twitter.clientlib.SDKConfig;
 
 public class ApiCommon {
   protected ApiClient localVarApiClient;
@@ -73,5 +74,13 @@ boolean isRateLimitRemaining(ApiException e) {
     return xRateLimitRemaining != null && xRateLimitRemaining.get(0) != null
         && Long.parseLong(xRateLimitRemaining.get(0)) == 0;
   }
+
+  Set<String> getFields(String fieldName, boolean isExclude, Set<String> fieldValues, Set<String> allFieldsValues) {
+    Set<String> result = fieldValues;
+    if(isExclude && SDKConfig.isFieldAllowlisted(fieldName) && allFieldsValues != null) {
+      result = allFieldsValues.stream().filter(e -> !(fieldValues != null && fieldValues.contains(e))).collect(Collectors.toSet());
+    }
+    return result;
+  }
 }
 

src/main/java/com/twitter/clientlib/api/BookmarksApi.java

@@ -36,6 +36,7 @@
 import com.google.gson.reflect.TypeToken;
 
 import java.io.IOException;
+import java.util.HashSet;
 
 
 import com.twitter.clientlib.model.BookmarkAddRequest;
@@ -167,6 +168,19 @@ public class APIgetUsersIdBookmarksRequest {
         private Set<String> pollFields;
         private Set<String> userFields;
         private Set<String> placeFields;
+        private final Set<String> tweetFieldsAll = new HashSet<>(Arrays.asList("attachments", "author_id", "context_annotations", "conversation_id", "created_at", "entities", "geo", "id", "in_reply_to_user_id", "lang", "non_public_metrics", "organic_metrics", "possibly_sensitive", "promoted_metrics", "public_metrics", "referenced_tweets", "reply_settings", "source", "text", "withheld"));
+        private final Set<String> expansionsAll = new HashSet<>(Arrays.asList("attachments.media_keys", "attachments.poll_ids", "author_id", "entities.mentions.username", "geo.place_id", "in_reply_to_user_id", "referenced_tweets.id", "referenced_tweets.id.author_id"));
+        private final Set<String> mediaFieldsAll = new HashSet<>(Arrays.asList("alt_text", "duration_ms", "height", "media_key", "non_public_metrics", "organic_metrics", "preview_image_url", "promoted_metrics", "public_metrics", "type", "url", "variants", "width"));
+        private final Set<String> pollFieldsAll = new HashSet<>(Arrays.asList("duration_minutes", "end_datetime", "id", "options", "voting_status"));
+        private final Set<String> userFieldsAll = new HashSet<>(Arrays.asList("created_at", "description", "entities", "id", "location", "name", "pinned_tweet_id", "profile_image_url", "protected", "public_metrics", "url", "username", "verified", "withheld"));
+        private final Set<String> placeFieldsAll = new HashSet<>(Arrays.asList("contained_within", "country", "country_code", "full_name", "geo", "id", "name", "place_type"));
+        
+        private boolean isExclude = false;
+
+        public APIgetUsersIdBookmarksRequest excludeInputFields() {
+          isExclude = true;
+          return this;
+        }
 
         private APIgetUsersIdBookmarksRequest(String id) {
             this.id = id;
@@ -280,6 +294,13 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException {
          </table>
          */
         public Get2UsersIdBookmarksResponse execute() throws ApiException {
+            tweetFields = getFields("tweetFields", isExclude, tweetFields, tweetFieldsAll);
+            expansions = getFields("expansions", isExclude, expansions, expansionsAll);
+            mediaFields = getFields("mediaFields", isExclude, mediaFields, mediaFieldsAll);
+            pollFields = getFields("pollFields", isExclude, pollFields, pollFieldsAll);
+            userFields = getFields("userFields", isExclude, userFields, userFieldsAll);
+            placeFields = getFields("placeFields", isExclude, placeFields, placeFieldsAll);
+            
             ApiResponse<Get2UsersIdBookmarksResponse> localVarResp = getUsersIdBookmarksWithHttpInfo(id, maxResults, paginationToken, tweetFields, expansions, mediaFields, pollFields, userFields, placeFields);
             return localVarResp.getData();
         }
@@ -422,6 +443,8 @@ private okhttp3.Call postUsersIdBookmarksAsync(BookmarkAddRequest bookmarkAddReq
     public class APIpostUsersIdBookmarksRequest {
         private final BookmarkAddRequest bookmarkAddRequest;
         private final String id;
+        
+        
 
         private APIpostUsersIdBookmarksRequest(BookmarkAddRequest bookmarkAddRequest, String id) {
             this.bookmarkAddRequest = bookmarkAddRequest;
@@ -456,6 +479,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException {
          </table>
          */
         public BookmarkMutationResponse execute() throws ApiException {
+            
             ApiResponse<BookmarkMutationResponse> localVarResp = postUsersIdBookmarksWithHttpInfo(bookmarkAddRequest, id);
             return localVarResp.getData();
         }
@@ -600,6 +624,8 @@ private okhttp3.Call usersIdBookmarksDeleteAsync(String id, String tweetId, fina
     public class APIusersIdBookmarksDeleteRequest {
         private final String id;
         private final String tweetId;
+        
+        
 
         private APIusersIdBookmarksDeleteRequest(String id, String tweetId) {
             this.id = id;
@@ -634,6 +660,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException {
          </table>
          */
         public BookmarkMutationResponse execute() throws ApiException {
+            
             ApiResponse<BookmarkMutationResponse> localVarResp = usersIdBookmarksDeleteWithHttpInfo(id, tweetId);
             return localVarResp.getData();
         }

src/main/java/com/twitter/clientlib/api/ComplianceApi.java

@@ -36,6 +36,7 @@
 import com.google.gson.reflect.TypeToken;
 
 import java.io.IOException;
+import java.util.HashSet;
 
 
 import com.twitter.clientlib.model.CreateComplianceJobRequest;
@@ -127,6 +128,8 @@ private okhttp3.Call createBatchComplianceJobAsync(CreateComplianceJobRequest cr
 
     public class APIcreateBatchComplianceJobRequest {
         private final CreateComplianceJobRequest createComplianceJobRequest;
+        
+        
 
         private APIcreateBatchComplianceJobRequest(CreateComplianceJobRequest createComplianceJobRequest) {
             this.createComplianceJobRequest = createComplianceJobRequest;
@@ -160,6 +163,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException {
          </table>
          */
         public CreateComplianceJobResponse execute() throws ApiException {
+            
             ApiResponse<CreateComplianceJobResponse> localVarResp = createBatchComplianceJobWithHttpInfo(createComplianceJobRequest);
             return localVarResp.getData();
         }
@@ -301,6 +305,14 @@ private okhttp3.Call getBatchComplianceJobAsync(String id, Set<String> complianc
     public class APIgetBatchComplianceJobRequest {
         private final String id;
         private Set<String> complianceJobFields;
+        private final Set<String> complianceJobFieldsAll = new HashSet<>(Arrays.asList("created_at", "download_expires_at", "download_url", "id", "name", "resumable", "status", "type", "upload_expires_at", "upload_url"));
+        
+        private boolean isExclude = false;
+
+        public APIgetBatchComplianceJobRequest excludeInputFields() {
+          isExclude = true;
+          return this;
+        }
 
         private APIgetBatchComplianceJobRequest(String id) {
             this.id = id;
@@ -344,6 +356,8 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException {
          </table>
          */
         public Get2ComplianceJobsIdResponse execute() throws ApiException {
+            complianceJobFields = getFields("complianceJobFields", isExclude, complianceJobFields, complianceJobFieldsAll);
+            
             ApiResponse<Get2ComplianceJobsIdResponse> localVarResp = getBatchComplianceJobWithHttpInfo(id, complianceJobFields);
             return localVarResp.getData();
         }
@@ -493,6 +507,14 @@ public class APIlistBatchComplianceJobsRequest {
         private final String type;
         private String status;
         private Set<String> complianceJobFields;
+        private final Set<String> complianceJobFieldsAll = new HashSet<>(Arrays.asList("created_at", "download_expires_at", "download_url", "id", "name", "resumable", "status", "type", "upload_expires_at", "upload_url"));
+        
+        private boolean isExclude = false;
+
+        public APIlistBatchComplianceJobsRequest excludeInputFields() {
+          isExclude = true;
+          return this;
+        }
 
         private APIlistBatchComplianceJobsRequest(String type) {
             this.type = type;
@@ -546,6 +568,8 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException {
          </table>
          */
         public Get2ComplianceJobsResponse execute() throws ApiException {
+            complianceJobFields = getFields("complianceJobFields", isExclude, complianceJobFields, complianceJobFieldsAll);
+            
             ApiResponse<Get2ComplianceJobsResponse> localVarResp = listBatchComplianceJobsWithHttpInfo(type, status, complianceJobFields);
             return localVarResp.getData();
         }

src/main/java/com/twitter/clientlib/api/GeneralApi.java

@@ -36,6 +36,7 @@
 import com.google.gson.reflect.TypeToken;
 
 import java.io.IOException;
+import java.util.HashSet;
 
 
 
@@ -114,6 +115,8 @@ private okhttp3.Call getOpenApiSpecAsync(final ApiCallback<Object> _callback) th
     }
 
     public class APIgetOpenApiSpecRequest {
+        
+        
 
         private APIgetOpenApiSpecRequest() {
         }
@@ -144,6 +147,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException {
          </table>
          */
         public Object execute() throws ApiException {
+            
             ApiResponse<Object> localVarResp = getOpenApiSpecWithHttpInfo();
             return localVarResp.getData();
         }