Change MentionEntity.id to be not mandatory. (#29)

zacmos · web-flow · commit b7d34902e31c · 2022-07-04T14:58:05.000+12:00
* Change MentionEntity.id to be not mandatory.
* Add integration tests.
diff --git a/README.md b/README.md
@@ -60,7 +60,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>com.twitter</groupId>
   <artifactId>twitter-api-java-sdk</artifactId>
-  <version>2.0.0</version>
+  <version>2.0.1</version>
 </dependency>
 ```
 
@@ -75,7 +75,7 @@ mavenLocal()       // Needed if the 'twitter-api-java-sdk' jar has been publishe
 }
 
 dependencies {
-implementation "com.twitter:twitter-api-java-sdk:2.0.0"
+implementation "com.twitter:twitter-api-java-sdk:2.0.1"
 }
 ```
 
@@ -89,7 +89,7 @@ mvn clean package
 
 Then manually install the following JARs:
 
-* `target/twitter-api-java-sdk-2.0.0.jar`
+* `target/twitter-api-java-sdk-2.0.1.jar`
 * `target/lib/*.jar`
 
 ## Twitter Credentials
@@ -120,7 +120,8 @@ You can use the following objects in order to set the credentials:
 
 ```java
 
-TwitterApi apiInstance = new TwitterApi(new TwitterCredentialsOAuth2(System.getenv("TWITTER_OAUTH2_CLIENT_ID"),
+TwitterApi apiInstance = new TwitterApi(new TwitterCredentialsOAuth2(
+      System.getenv("TWITTER_OAUTH2_CLIENT_ID"),
       System.getenv("TWITTER_OAUTH2_CLIENT_SECRET"),
       System.getenv("TWITTER_OAUTH2_ACCESS_TOKEN"),
       System.getenv("TWITTER_OAUTH2_REFRESH_TOKEN")));
@@ -152,7 +153,8 @@ public class TwitterApiExample {
      * Check the 'security' tag of the required APIs in https://api.twitter.com/2/openapi.json in order
      * to use the right credential object.
      */
-    TwitterApi apiInstance = new TwitterApi(new TwitterCredentialsOAuth2(System.getenv("TWITTER_OAUTH2_CLIENT_ID"),
+    TwitterApi apiInstance = new TwitterApi(new TwitterCredentialsOAuth2(
+          System.getenv("TWITTER_OAUTH2_CLIENT_ID"),
           System.getenv("TWITTER_OAUTH2_CLIENT_SECRET"),
           System.getenv("TWITTER_OAUTH2_ACCESS_TOKEN"),
           System.getenv("TWITTER_OAUTH2_REFRESH_TOKEN")));
diff --git a/docs/MentionEntity.md b/docs/MentionEntity.md
@@ -9,7 +9,7 @@
 |------------ | ------------- | ------------- | -------------|
 |**end** | **Integer** | Index (zero-based) at which position this entity ends.  The index is exclusive. |  |
 |**start** | **Integer** | Index (zero-based) at which position this entity starts.  The index is inclusive. |  |
-|**id** | **String** | Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers. |  |
+|**id** | **String** | Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers. |  [optional] |
 |**username** | **String** | The Twitter handle (screen name) of this user. |  |
 
 
diff --git a/docs/MentionFields.md b/docs/MentionFields.md
@@ -8,7 +8,7 @@ Represent the portion of text recognized as a User mention, and its start and en
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**id** | **String** | Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers. |  |
+|**id** | **String** | Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers. |  [optional] |
 |**username** | **String** | The Twitter handle (screen name) of this user. |  |
 
 
diff --git a/examples/pom.xml b/examples/pom.xml
@@ -16,7 +16,7 @@
         <dependency>
             <groupId>com.twitter</groupId>
             <artifactId>twitter-api-java-sdk</artifactId>
-            <version>2.0.0</version>
+            <version>2.0.1</version>
             <scope>compile</scope>
         </dependency>
     </dependencies>
diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
     <artifactId>twitter-api-java-sdk</artifactId>
     <packaging>jar</packaging>
     <name>twitter-api-java-sdk</name>
-    <version>2.0.0</version>
+    <version>2.0.1</version>
     <url>https://github.com/twitterdev/twitter-api-java-sdk</url>
     <description>Twitter API v2 available endpoints</description>
     <scm>
diff --git a/src/main/java/com/twitter/clientlib/ApiClient.java b/src/main/java/com/twitter/clientlib/ApiClient.java
@@ -225,7 +225,7 @@ private void init() {
         json = new JSON();
 
         // Set default User-Agent.
-        setUserAgent("twitter-api-java-sdk/2.0.0");
+        setUserAgent("twitter-api-java-sdk/2.0.1");
 
         authentications = new HashMap<String, Authentication>();
     }
diff --git a/src/main/java/com/twitter/clientlib/JSON.java b/src/main/java/com/twitter/clientlib/JSON.java
diff --git a/src/main/java/com/twitter/clientlib/model/MentionEntity.java b/src/main/java/com/twitter/clientlib/model/MentionEntity.java
@@ -137,8 +137,8 @@ public MentionEntity id(String id) {
    * Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
    * @return id
   **/
-  @javax.annotation.Nonnull
-  @ApiModelProperty(example = "2244994945", required = true, value = "Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.")
+  @javax.annotation.Nullable
+  @ApiModelProperty(example = "2244994945", value = "Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.")
 
   public String getId() {
     return id;
@@ -233,7 +233,6 @@ private String toIndentedString(Object o) {
     openapiRequiredFields = new HashSet<String>();
     openapiRequiredFields.add("end");
     openapiRequiredFields.add("start");
-    openapiRequiredFields.add("id");
     openapiRequiredFields.add("username");
   }
 
diff --git a/src/main/java/com/twitter/clientlib/model/MentionFields.java b/src/main/java/com/twitter/clientlib/model/MentionFields.java
@@ -80,8 +80,8 @@ public MentionFields id(String id) {
    * Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
    * @return id
   **/
-  @javax.annotation.Nonnull
-  @ApiModelProperty(example = "2244994945", required = true, value = "Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.")
+  @javax.annotation.Nullable
+  @ApiModelProperty(example = "2244994945", value = "Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.")
 
   public String getId() {
     return id;
@@ -168,7 +168,6 @@ private String toIndentedString(Object o) {
 
     // a set of required properties/fields (JSON key names)
     openapiRequiredFields = new HashSet<String>();
-    openapiRequiredFields.add("id");
     openapiRequiredFields.add("username");
   }
 
diff --git a/src/test/java/com/twitter/clientlib/integration/ApiBookmarksTester.java b/src/test/java/com/twitter/clientlib/integration/ApiBookmarksTester.java
@@ -141,7 +141,7 @@ public void createDeleteTweetErrorTest() throws ApiException {
       apiInstance.bookmarks().postUsersIdBookmarks(req, userId).execute();
     });
     checkGenericProblem(exception.getErrorObject().getProblem(),
-        "You are not permitted to bookmark this Tweet.", "Forbidden",
-        403);
+        "You cannot bookmark a Tweet that does not exist.", "Bad Request",
+        400);
   }
 }
diff --git a/src/test/java/com/twitter/clientlib/integration/ApiComplianceTester.java b/src/test/java/com/twitter/clientlib/integration/ApiComplianceTester.java
@@ -0,0 +1,103 @@
+/*
+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.integration;
+
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestInstance;
+
+import com.twitter.clientlib.ApiException;
+import com.twitter.clientlib.model.*;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+
+
+@TestInstance(TestInstance.Lifecycle.PER_CLASS)
+public class ApiComplianceTester extends ApiTester {
+
+  String complianceJobByID = "1537616980307456001"; //1382081613278814209
+  String complianceJobByIDNotFound = "998837616980307456099"; //1382081613278814209
+
+  @BeforeAll
+  public void init() {
+    initApiInstanceBearer();
+  }
+
+  public CreateComplianceJobResponse createCompliance() throws ApiException {
+    CreateComplianceJobRequest req = new CreateComplianceJobRequest();
+    req.setType(CreateComplianceJobRequest.TypeEnum.TWEETS);
+    return apiInstance.compliance().createBatchComplianceJob(req)
+        .execute();
+  }
+
+  @Test
+  public void getBatchComplianceJobJobTest() throws ApiException {
+    String id = createCompliance().getData().getId();
+    Get2ComplianceJobsIdResponse result = apiInstance.compliance().getBatchComplianceJob(id).execute();
+    checkErrors(false, result.getErrors());
+    checkComplianceJobData(result.getData());
+  }
+
+  @Test
+  public void getBatchComplianceJobErrorTest() throws ApiException {
+    ApiException exception = assertThrows(ApiException.class, () -> {
+      Get2ComplianceJobsIdResponse result = apiInstance.compliance().getBatchComplianceJob(complianceJobByIDNotFound).execute();
+    });
+    checkApiExceptionProblem(exception, InvalidRequestProblem.class,
+        "The `id` query parameter value [" + complianceJobByIDNotFound + "] does not match ^[0-9]{1,19}$",
+        "Invalid Request", "One or more parameters to your request was invalid.");
+  }
+
+// ComplianceJobStatus should have "expired value
+//  @Test
+//  public void listBatchComplianceJobsTest() throws ApiException {
+//    Get2ComplianceJobsResponse result = apiInstance.compliance().listBatchComplianceJobs(
+//        CreateComplianceJobRequest.TypeEnum.TWEETS.getValue()).execute();
+//    checkErrors(false, result.getErrors());
+//    assertNotNull(result.getData());
+//    checkComplianceJobData(result.getData().get(0));
+//  }
+
+  @Test
+  public void listBatchComplianceJobsErrorTest() throws ApiException {
+    ApiException exception = assertThrows(ApiException.class, () -> {
+      apiInstance.compliance().listBatchComplianceJobs("DUMMY").execute();
+    });
+    checkApiExceptionProblem(exception, InvalidRequestProblem.class,
+        "The `type` query parameter value [" + "DUMMY" + "] is not one of [tweets,users]",
+        "Invalid Request", "One or more parameters to your request was invalid.");
+  }
+
+  @Test
+  public void createBatchComplianceJobTest() throws ApiException {
+    CreateComplianceJobResponse result = createCompliance();
+    checkErrors(false, result.getErrors());
+    assertNotNull(result.getData());
+    assertNotNull(result.getData().getId());
+    assertNotNull(result.getData().getType());
+  }
+}
diff --git a/src/test/java/com/twitter/clientlib/integration/ApiListsTester.java b/src/test/java/com/twitter/clientlib/integration/ApiListsTester.java
@@ -36,6 +36,7 @@
 
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
 import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
@@ -577,12 +578,14 @@ public void listUserFollowUserNotExistsTest() throws ApiException {
 
   @Test
   public void listUserPinTest() throws ApiException {
+    listUserFollowTest();
     ListPinnedRequest request = new ListPinnedRequest();
     request.setListId(listId);
     ListPinnedResponse result = apiInstance.lists().listUserPin(request, userId).execute();
     checkErrors(false, result.getErrors());
     assertNotNull(result.getData());
     assertTrue(result.getData().getPinned());
+    listUserUnfollowTest();
   }
 
   @Test
@@ -634,4 +637,58 @@ public void listUserUnpinUserNotFoundTest() throws ApiException {
         "The `id` query parameter value [" + userNotExists + "] must be the same as the authenticating user",
         "Invalid Request", "One or more parameters to your request was invalid.");
   }
+
+  @Test
+  public void listUserPinnedListsTest() throws ApiException {
+    Get2UsersIdPinnedListsResponse result = apiInstance.lists().listUserPinnedLists(userId)
+        .userFields(userFields)
+        .listFields(listFields)
+        .execute();
+    checkErrors(false, result.getErrors());
+    assertNotNull(result.getData());
+    checkModelListData(result.getData().get(0));
+    assertNull(result.getIncludes());
+  }
+
+  @Test
+  public void listUserPinnedListsErrorTest() throws ApiException {
+    ApiException exception = assertThrows(ApiException.class, () -> {
+      apiInstance.lists().listUserPinnedLists(userNotExists)
+          .userFields(userFields)
+          .listFields(listFields)
+          .execute();
+    });
+    checkApiExceptionProblem(exception, InvalidRequestProblem.class,
+        "The `id` query parameter value [" + userNotExists + "] must be the same as the authenticating user",
+        "Invalid Request", "One or more parameters to your request was invalid.");
+  }
+
+  @Test
+  public void listUserUnfollowTest() throws ApiException {
+    ListFollowedResponse result = apiInstance.lists().listUserUnfollow(userId, listId)
+        .execute();
+    checkErrors(false, result.getErrors());
+    assertNotNull(result.getData());
+    assertNotEquals(Boolean.TRUE, result.getData().getFollowing());
+  }
+
+  @Test
+  public void listUserUnfollowUserNotFoundTest() throws ApiException {
+    ApiException exception = assertThrows(ApiException.class, () -> {
+      apiInstance.lists().listUserUnfollow(userNotExists, listId)
+          .execute();
+    });
+    checkApiExceptionProblem(exception, InvalidRequestProblem.class,
+        "The `id` query parameter value [" + userNotExists + "] must be the same as the authenticating user",
+        "Invalid Request", "One or more parameters to your request was invalid.");
+  }
+
+  @Test
+  public void listUserUnfollowListNotFoundTest() throws ApiException {
+    ListFollowedResponse result = apiInstance.lists().listUserUnfollow(userId, listIdNotFound)
+        .execute();
+    checkErrors(false, result.getErrors());
+    assertNotNull(result.getData());
+    assertFalse(result.getData().getFollowing());
+  }
 }
diff --git a/src/test/java/com/twitter/clientlib/integration/ApiTester.java b/src/test/java/com/twitter/clientlib/integration/ApiTester.java
@@ -34,16 +34,7 @@
 import com.twitter.clientlib.TwitterCredentialsBearer;
 import com.twitter.clientlib.TwitterCredentialsOAuth2;
 import com.twitter.clientlib.api.TwitterApi;
-import com.twitter.clientlib.model.DuplicateRuleProblem;
-import com.twitter.clientlib.model.Expansions;
-import com.twitter.clientlib.model.GenericProblem;
-import com.twitter.clientlib.model.InvalidRequestProblem;
-import com.twitter.clientlib.model.ModelList;
-import com.twitter.clientlib.model.Problem;
-import com.twitter.clientlib.model.ResourceNotFoundProblem;
-import com.twitter.clientlib.model.Space;
-import com.twitter.clientlib.model.Tweet;
-import com.twitter.clientlib.model.User;
+import com.twitter.clientlib.model.*;
 
 
 @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
@@ -138,6 +129,20 @@ protected void checkListData(ModelList list) {
     Assertions.assertNotNull(list.getFollowerCount());
   }
 
+  protected void checkComplianceJobData(ComplianceJob complianceJob) {
+    Assertions.assertNotNull(complianceJob);
+    Assertions.assertNotNull(complianceJob.getType());
+    Assertions.assertNotNull(complianceJob.getId());
+    Assertions.assertNotNull(complianceJob.getCreatedAt());
+  }
+
+  protected void checkModelListData(ModelList modelList) {
+    Assertions.assertNotNull(modelList);
+    Assertions.assertNotNull(modelList.getName());
+    Assertions.assertNotNull(modelList.getId());
+    Assertions.assertNotNull(modelList.getCreatedAt());
+  }
+
   protected void checkResourceNotFoundProblem(
       Problem problem, String value, String title, String parameter
   ) {
diff --git a/src/test/java/com/twitter/clientlib/integration/ApiTweetTester.java b/src/test/java/com/twitter/clientlib/integration/ApiTweetTester.java
@@ -402,6 +402,31 @@ public void usersIdLikeUserNotFoundTest() throws ApiException {
         "Invalid Request", "One or more parameters to your request was invalid.");
   }
 
+  @Test
+  public void usersIdTimelineTest() throws ApiException {
+    Get2UsersIdTimelinesReverseChronologicalResponse result = apiInstance.tweets().usersIdTimeline(userId)
+        .userFields(userFields)
+        .tweetFields(tweetFields)
+        .execute();
+    checkErrors(false, result.getErrors());
+    assertNotNull(result.getData());
+    checkTweetData(result.getData().get(0));
+    assertNull(result.getIncludes());
+  }
+
+  @Test
+  public void usersIdTimelineErrorTest() throws ApiException {
+    ApiException exception = assertThrows(ApiException.class, () -> {
+      apiInstance.tweets().usersIdTimeline(userNotExists)
+          .userFields(userFields)
+          .tweetFields(tweetFields)
+          .execute();
+    });
+    checkApiExceptionProblem(exception, InvalidRequestProblem.class,
+        "The `id` query parameter value [" + userNotExists + "] must be the same as the authenticating user [" + userId + "]",
+        "Invalid Request", "One or more parameters to your request was invalid.");
+  }
+
   /* Does not work for now
     Streaming
 */
diff --git a/src/test/java/com/twitter/clientlib/integration/ApiUserTester.java b/src/test/java/com/twitter/clientlib/integration/ApiUserTester.java

Original file line number	Diff line number	Diff line change
`@@ -225,7 +225,7 @@ private void init() {`
`225`	`225`	`json = new JSON();`
`226`	`226`
`227`	`227`	`// Set default User-Agent.`
`228`		`- setUserAgent("twitter-api-java-sdk/2.0.0");`
	`228`	`+ setUserAgent("twitter-api-java-sdk/2.0.1");`
`229`	`229`
`230`	`230`	`authentications = new HashMap<String, Authentication>();`
`231`	`231`	`}`
Original file line number	Diff line number	Diff line change
`@@ -141,7 +141,7 @@ public void createDeleteTweetErrorTest() throws ApiException {`
`141`	`141`	`apiInstance.bookmarks().postUsersIdBookmarks(req, userId).execute();`
`142`	`142`	`});`
`143`	`143`	`checkGenericProblem(exception.getErrorObject().getProblem(),`
`144`		`- "You are not permitted to bookmark this Tweet.", "Forbidden",`
`145`		`- 403);`
	`144`	`+ "You cannot bookmark a Tweet that does not exist.", "Bad Request",`
	`145`	`+ 400);`
`146`	`146`	`}`
`147`	`147`	`}`