Merge pull request #66 from oxctl/AB#78143

AB#78143: Adding restore API call

src/main/java/edu/ksu/canvas/impl/AccountImpl.java

@@ -112,4 +112,12 @@ public User deleteUser(String userId, String accountId) throws IOException {
         Optional<DeletedUserResponse> responseParsed = responseParser.parseToObject(DeletedUserResponse.class, response);
         return responseParsed.map(DeletedUserResponse::getUser).orElse(null);
     }
+
+    @Override
+    public Optional<User> restoreUser(String accountId, String userIdentifier) throws IOException {
+        LOG.debug("Restoring user {}", userIdentifier);
+        String url = buildCanvasUrl("accounts/" + accountId + "/users/" + userIdentifier + "/restore", Collections.emptyMap());
+        Response response = canvasMessenger.putToCanvas(oauthToken, url,  Collections.emptyMap());
+        return responseParser.parseToObject(User.class, response);
+    }
 }

src/main/java/edu/ksu/canvas/interfaces/AccountWriter.java

@@ -1,5 +1,6 @@
 package edu.ksu.canvas.interfaces;
 
+import edu.ksu.canvas.exception.InvalidOauthTokenException;
 import edu.ksu.canvas.model.Account;
 import edu.ksu.canvas.model.User;
 
@@ -39,4 +40,14 @@ public interface AccountWriter extends CanvasWriter<Account, AccountWriter> {
      * @throws IOException When there is an error communicating with Canvas
      */
      User deleteUser(String userId, String accountId) throws IOException;
+
+    /**
+     * Restore a deleted user in Canvas
+     * @param accountId account id for restoring user into an account
+     * @param userId user id for restoring user
+     * @return The newly restored user
+     * @throws InvalidOauthTokenException When the supplied OAuth token is not valid
+     * @throws IOException When there is an error communicating with Canvas
+     */
+    Optional<User> restoreUser (String accountId, String userId) throws InvalidOauthTokenException, IOException;
 }

src/test/java/edu/ksu/canvas/tests/account/AccountReaderUTest.java → src/test/java/edu/ksu/canvas/tests/account/AccountUTest.java

@@ -7,6 +7,8 @@
 import java.util.Map;
 import java.util.Optional;
 
+import edu.ksu.canvas.interfaces.AccountWriter;
+import edu.ksu.canvas.model.User;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
@@ -22,17 +24,20 @@
 import edu.ksu.canvas.requestOptions.ListAccountOptions.Include;
 import edu.ksu.canvas.util.CanvasURLBuilder;
 
-public class AccountReaderUTest extends CanvasTestBase {
+public class AccountUTest extends CanvasTestBase {
     @Autowired
     private FakeRestClient fakeRestClient;
     private AccountReader accountReader;
+    private AccountWriter accountWriter;
 
     private static final String ROOT_ACCOUNT_ID = "1";
 
     @Before
     public void setupReader() {
         accountReader = new AccountImpl(baseUrl, apiVersion, SOME_OAUTH_TOKEN, fakeRestClient, SOME_CONNECT_TIMEOUT,
                 SOME_READ_TIMEOUT, DEFAULT_PAGINATION_PAGE_SIZE, false);
+        accountWriter = new AccountImpl(baseUrl, apiVersion, SOME_OAUTH_TOKEN, fakeRestClient, SOME_CONNECT_TIMEOUT,
+                SOME_READ_TIMEOUT, DEFAULT_PAGINATION_PAGE_SIZE, false);
     }
 
     @Test
@@ -63,4 +68,16 @@ public void listAccountWithLtiGuidInclude() throws Exception {
         Assert.assertEquals("f22a4332-3d40-427b-846d-9bc1fa5ab9b4.canvas.example.edu", account.getLtiGuid());
     }
 
+    @Test
+    public void testRestoreUserByUserId() throws Exception {
+        String accountId = "1";
+        int userId = 20;
+        String url = baseUrl + "/api/v1/accounts/1/users/" + String.valueOf(userId) + "/restore";
+        fakeRestClient.addSuccessResponse(url, "SampleJson/user/UserById.json");
+        Optional<User> result = accountWriter.restoreUser(accountId, String.valueOf(userId));
+        User user = result.get();
+        Assert.assertEquals(userId, user.getId());
+        Assert.assertEquals("2011-05-30T16:45:25Z", user.getCreatedAt().toString());
+    }
+
 }