Add rate limits

Author: seratch

slack-api-client/src/main/java/com/slack/api/methods/MethodsRateLimitTier.java

@@ -69,6 +69,11 @@ public enum MethodsRateLimitTier {
     }
 
     public static Integer getAllowedRequestsPerMinute(MethodsRateLimitTier tier) {
+        if (tier == null) {
+            // Just in case, this method returns Tier2 when the given Tier is null to avoid runtime errors
+            // Tier2 may not be optimal in the case but it works for most cases
+            return allowedRequestsPerMinute.get(MethodsRateLimitTier.Tier2);
+        }
         return allowedRequestsPerMinute.get(tier);
     }
 

slack-api-client/src/main/java/com/slack/api/methods/MethodsRateLimits.java

@@ -40,7 +40,8 @@ public static void setRateLimitTier(String methodName, MethodsRateLimitTier tier
 
         // Tier1
         final List<String> adminApiMethods_Tier1 = Arrays.asList(
-                ADMIN_TEAMS_CREATE
+                ADMIN_TEAMS_CREATE,
+                ADMIN_USERGROUPS_ADD_CHANNELS
         );
         for (String methods : adminApiMethods_Tier1) {
             setRateLimitTier(methods, Tier1);
@@ -81,7 +82,10 @@ public static void setRateLimitTier(String methodName, MethodsRateLimitTier tier
                 ADMIN_USERS_SET_OWNER,
                 ADMIN_USERS_SET_REGULAR,
 
-                ADMIN_USERS_SESSION_RESET
+                ADMIN_USERS_SESSION_RESET,
+
+                ADMIN_USERGROUPS_LIST_CHANNELS,
+                ADMIN_USERGROUPS_REMOVE_CHANNELS
         );
         for (String methods : adminApiMethods_Tier2) {
             setRateLimitTier(methods, Tier2);

slack-api-client/src/main/java/com/slack/api/methods/impl/AsyncMethodsRateLimiter.java

@@ -56,6 +56,9 @@ private WaitTime calculateWaitTime(String teamId, String methodName, String suff
         String key = methodName + suffix;
 
         MethodsRateLimitTier tier = MethodsRateLimits.lookupRateLimitTier(methodName);
+        if (tier == null) {
+            log.warn("Rate Limit Tier for method: {} is not found", methodName);
+        }
         int allowedRequests = getAllowedRequestsPerMinute(tier);
         if (log.isDebugEnabled()) {
             int currentRequests = getNumberOfLastMinuteRequests(teamId, key);

slack-api-client/src/test/java/test_locally/api/MethodsTest.java

@@ -1,6 +1,8 @@
 package test_locally.api;
 
 import com.slack.api.methods.Methods;
+import com.slack.api.methods.MethodsRateLimitTier;
+import com.slack.api.methods.MethodsRateLimits;
 import org.junit.Test;
 
 import java.lang.reflect.Field;
@@ -17,7 +19,7 @@ public void verifyTheCoverage() {
         // https://api.slack.com/methods
         // var methodNames = [].slice.call(document.getElementsByClassName('bold')).map(e => e.text);console.log(methodNames.toString());console.log(methodNames.length);
         // 188 endpoints as of Jan 30
-        String methods = "admin.apps.approve,admin.apps.restrict,admin.apps.approved.list,admin.apps.requests.list,admin.apps.restricted.list,admin.conversations.setTeams,admin.emoji.add,admin.emoji.addAlias,admin.emoji.list,admin.emoji.remove,admin.emoji.rename,admin.inviteRequests.approve,admin.inviteRequests.deny,admin.inviteRequests.list,admin.inviteRequests.approved.list,admin.inviteRequests.denied.list,admin.teams.admins.list,admin.teams.create,admin.teams.list,admin.teams.owners.list,admin.teams.settings.info,admin.teams.settings.setDefaultChannels,admin.teams.settings.setDescription,admin.teams.settings.setDiscoverability,admin.teams.settings.setIcon,admin.teams.settings.setName,admin.users.assign,admin.users.invite,admin.users.list,admin.users.remove,admin.users.setAdmin,admin.users.setExpiration,admin.users.setOwner,admin.users.setRegular,admin.users.session.reset,api.test,apps.permissions.info,apps.permissions.request,apps.permissions.resources.list,apps.permissions.scopes.list,apps.permissions.users.list,apps.permissions.users.request,apps.uninstall,auth.revoke,auth.test,bots.info,chat.delete,chat.deleteScheduledMessage,chat.getPermalink,chat.meMessage,chat.postEphemeral,chat.postMessage,chat.scheduleMessage,chat.unfurl,chat.update,chat.scheduledMessages.list,conversations.archive,conversations.close,conversations.create,conversations.history,conversations.info,conversations.invite,conversations.join,conversations.kick,conversations.leave,conversations.list,conversations.members,conversations.open,conversations.rename,conversations.replies,conversations.setPurpose,conversations.setTopic,conversations.unarchive,dialog.open,dnd.endDnd,dnd.endSnooze,dnd.info,dnd.setSnooze,dnd.teamInfo,emoji.list,files.comments.delete,files.delete,files.info,files.list,files.revokePublicURL,files.sharedPublicURL,files.upload,files.remote.add,files.remote.info,files.remote.list,files.remote.remove,files.remote.share,files.remote.update,migration.exchange,oauth.access,oauth.token,oauth.v2.access,pins.add,pins.list,pins.remove,reactions.add,reactions.get,reactions.list,reactions.remove,reminders.add,reminders.complete,reminders.delete,reminders.info,reminders.list,rtm.connect,rtm.start,search.all,search.files,search.messages,stars.add,stars.list,stars.remove,team.accessLogs,team.billableInfo,team.info,team.integrationLogs,team.profile.get,usergroups.create,usergroups.disable,usergroups.enable,usergroups.list,usergroups.update,usergroups.users.list,usergroups.users.update,users.conversations,users.deletePhoto,users.getPresence,users.identity,users.info,users.list,users.lookupByEmail,users.setActive,users.setPhoto,users.setPresence,users.profile.get,users.profile.set,views.open,views.publish,views.push,views.update,channels.archive,channels.create,channels.history,channels.info,channels.invite,channels.join,channels.kick,channels.leave,channels.list,channels.mark,channels.rename,channels.replies,channels.setPurpose,channels.setTopic,channels.unarchive,groups.archive,groups.create,groups.createChild,groups.history,groups.info,groups.invite,groups.kick,groups.leave,groups.list,groups.mark,groups.open,groups.rename,groups.replies,groups.setPurpose,groups.setTopic,groups.unarchive,im.close,im.history,im.list,im.mark,im.open,im.replies,mpim.close,mpim.history,mpim.list,mpim.mark,mpim.open,mpim.replies";
+        String methods = "admin.apps.approve,admin.apps.restrict,admin.apps.approved.list,admin.apps.requests.list,admin.apps.restricted.list,admin.conversations.setTeams,admin.emoji.add,admin.emoji.addAlias,admin.emoji.list,admin.emoji.remove,admin.emoji.rename,admin.inviteRequests.approve,admin.inviteRequests.deny,admin.inviteRequests.list,admin.inviteRequests.approved.list,admin.inviteRequests.denied.list,admin.teams.admins.list,admin.teams.create,admin.teams.list,admin.teams.owners.list,admin.teams.settings.info,admin.teams.settings.setDefaultChannels,admin.teams.settings.setDescription,admin.teams.settings.setDiscoverability,admin.teams.settings.setIcon,admin.teams.settings.setName,admin.usergroups.addChannels,admin.usergroups.listChannels,admin.usergroups.removeChannels,admin.users.assign,admin.users.invite,admin.users.list,admin.users.remove,admin.users.setAdmin,admin.users.setExpiration,admin.users.setOwner,admin.users.setRegular,admin.users.session.reset,api.test,apps.permissions.info,apps.permissions.request,apps.permissions.resources.list,apps.permissions.scopes.list,apps.permissions.users.list,apps.permissions.users.request,apps.uninstall,auth.revoke,auth.test,bots.info,chat.delete,chat.deleteScheduledMessage,chat.getPermalink,chat.meMessage,chat.postEphemeral,chat.postMessage,chat.scheduleMessage,chat.unfurl,chat.update,chat.scheduledMessages.list,conversations.archive,conversations.close,conversations.create,conversations.history,conversations.info,conversations.invite,conversations.join,conversations.kick,conversations.leave,conversations.list,conversations.members,conversations.open,conversations.rename,conversations.replies,conversations.setPurpose,conversations.setTopic,conversations.unarchive,dialog.open,dnd.endDnd,dnd.endSnooze,dnd.info,dnd.setSnooze,dnd.teamInfo,emoji.list,files.comments.delete,files.delete,files.info,files.list,files.revokePublicURL,files.sharedPublicURL,files.upload,files.remote.add,files.remote.info,files.remote.list,files.remote.remove,files.remote.share,files.remote.update,migration.exchange,oauth.access,oauth.token,oauth.v2.access,pins.add,pins.list,pins.remove,reactions.add,reactions.get,reactions.list,reactions.remove,reminders.add,reminders.complete,reminders.delete,reminders.info,reminders.list,rtm.connect,rtm.start,search.all,search.files,search.messages,stars.add,stars.list,stars.remove,team.accessLogs,team.billableInfo,team.info,team.integrationLogs,team.profile.get,usergroups.create,usergroups.disable,usergroups.enable,usergroups.list,usergroups.update,usergroups.users.list,usergroups.users.update,users.conversations,users.deletePhoto,users.getPresence,users.identity,users.info,users.list,users.lookupByEmail,users.setActive,users.setPhoto,users.setPresence,users.profile.get,users.profile.set,views.open,views.publish,views.push,views.update,channels.archive,channels.create,channels.history,channels.info,channels.invite,channels.join,channels.kick,channels.leave,channels.list,channels.mark,channels.rename,channels.replies,channels.setPurpose,channels.setTopic,channels.unarchive,groups.archive,groups.create,groups.createChild,groups.history,groups.info,groups.invite,groups.kick,groups.leave,groups.list,groups.mark,groups.open,groups.rename,groups.replies,groups.setPurpose,groups.setTopic,groups.unarchive,im.close,im.history,im.list,im.mark,im.open,im.replies,mpim.close,mpim.history,mpim.list,mpim.mark,mpim.open,mpim.replies";
         final List<String> existingMethods = new ArrayList<>();
         for (Field f : Methods.class.getDeclaredFields()) {
             int modifiers = f.getModifiers();
@@ -36,5 +38,11 @@ public void verifyTheCoverage() {
             }
         }
 
+        for (String method : methods.split(",")) {
+            MethodsRateLimitTier tier = MethodsRateLimits.lookupRateLimitTier(method);
+            if (tier == null) {
+                fail(method + " is not supported yet!");
+            }
+        }
     }
 }

slack-api-client/src/test/java/test_locally/api/methods_admin_api/AdminApiAsyncTest.java

@@ -3,6 +3,7 @@
 import com.slack.api.Slack;
 import com.slack.api.SlackConfig;
 import com.slack.api.methods.AsyncMethodsClient;
+import com.slack.api.methods.MethodsClient;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
@@ -141,4 +142,16 @@ public void adminUsers() throws Exception {
                 .get().isOk(), is(true));
     }
 
+    @Test
+    public void adminUsergroups() throws Exception {
+        AsyncMethodsClient methods = slack.methodsAsync(ValidToken);
+
+        assertThat(methods.adminUsergroupsAddChannels(r -> r.teamId("T123").usergroupId("S123").channelIds(Arrays.asList("C123", "C234")))
+                .get().isOk(), is(true));
+        assertThat(methods.adminUsergroupsListChannels(r -> r.teamId("T123").usergroupId("S123").includeNumMembers(true))
+                .get().isOk(), is(true));
+        assertThat(methods.adminUsergroupsRemoveChannels(r -> r.usergroupId("S123").channelIds(Arrays.asList("C123", "C234")))
+                .get().isOk(), is(true));
+    }
+
 }

slack-api-client/src/test/java/test_locally/api/methods_admin_api/AdminApiTest.java

@@ -141,4 +141,15 @@ public void adminUsers() throws Exception {
                 .isOk(), is(true));
     }
 
+    @Test
+    public void adminUsergroups() throws Exception {
+        MethodsClient methods = slack.methods(ValidToken);
+
+        assertThat(methods.adminUsergroupsAddChannels(r -> r.teamId("T123").usergroupId("S123").channelIds(Arrays.asList("C123", "C234")))
+                .isOk(), is(true));
+        assertThat(methods.adminUsergroupsListChannels(r -> r.teamId("T123").usergroupId("S123").includeNumMembers(true))
+                .isOk(), is(true));
+        assertThat(methods.adminUsergroupsRemoveChannels(r -> r.usergroupId("S123").channelIds(Arrays.asList("C123", "C234")))
+                .isOk(), is(true));
+    }
 }