Add addSlackConnectedListener and removeSlackConnectedListener to all…

…ow clients to intercept connection status information
ja-ko · Oct 4, 2015 · ff274d2 · ff274d2
1 parent 25a8fff
commit ff274d2
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 2 deletions.
diff --git a/src/main/java/com/ullink/slack/simpleslackapi/SlackSession.java b/src/main/java/com/ullink/slack/simpleslackapi/SlackSession.java
@@ -15,6 +15,7 @@
 import com.ullink.slack.simpleslackapi.listeners.SlackMessageDeletedListener;
 import com.ullink.slack.simpleslackapi.listeners.SlackMessagePostedListener;
 import com.ullink.slack.simpleslackapi.listeners.SlackMessageUpdatedListener;
+import com.ullink.slack.simpleslackapi.listeners.SlackConnectedListener;
 
 public interface SlackSession
 {
@@ -99,4 +100,15 @@ public interface SlackSession
 
     void removeGroupJoinedListener(SlackGroupJoinedListener listener);
 
+    /*
+     * Subscribe to events related to the connection to the slack
+     * server. At this time a set of status information is exchanged that
+     * is useful to implementing bots.
+     * 
+     * For example, the current user that is connecting.
+     * knowing your own user id will help you stop answering your own
+     * questions.
+     */
+    void addSlackConnectedListener(SlackConnectedListener listner);
+    void removeSlackConnectedListener(SlackConnectedListener listener);
 }
diff --git a/src/main/java/com/ullink/slack/simpleslackapi/impl/AbstractSlackSessionImpl.java b/src/main/java/com/ullink/slack/simpleslackapi/impl/AbstractSlackSessionImpl.java
@@ -34,7 +34,7 @@ abstract class AbstractSlackSessionImpl implements SlackSession
     protected List<SlackMessagePostedListener>     messagePostedListener    = new ArrayList<SlackMessagePostedListener>();
     protected List<SlackMessageUpdatedListener>    messageUpdatedListener   = new ArrayList<SlackMessageUpdatedListener>();
     protected List<SlackReplyListener>             slackReplyListener       = new ArrayList<SlackReplyListener>();
-    protected List<SlackConnectedListener>         slackConnectedLinster    = new ArrayList<SlackConnectedListener>();
+    protected List<SlackConnectedListener>         slackConnectedListener    = new ArrayList<SlackConnectedListener>();
 
     static final SlackChatConfiguration            DEFAULT_CONFIGURATION    = SlackChatConfiguration.getConfiguration().asUser();
 
@@ -260,4 +260,13 @@ void removeSlackReplyListener(SlackReplyListener listener)
         slackReplyListener.remove(listener);
     }
 
+    @Override
+    public void addSlackConnectedListener(SlackConnectedListener listener) {
+      slackConnectedListener.add(listener);
+    }
+
+    @Override
+    public void removeSlackConnectedListener(SlackConnectedListener listener) {
+      slackConnectedListener.remove(listener);
+    }
 }
diff --git a/src/main/java/com/ullink/slack/simpleslackapi/impl/SlackWebSocketSessionImpl.java b/src/main/java/com/ullink/slack/simpleslackapi/impl/SlackWebSocketSessionImpl.java
@@ -95,7 +95,7 @@ void dispatch(SlackEvent event)
                     dispatchImpl((SlackReplyEvent) event, slackReplyListener);
                     break;
                 case SLACK_CONNECTED:
-                    dispatchImpl((SlackConnected) event, slackConnectedLinster);
+                    dispatchImpl((SlackConnected) event, slackConnectedListener);
                     break;
                 case UNKNOWN:
                     throw new IllegalArgumentException("event not handled " + event);

diff --git a/src/test/java/com/ullink/slack/simpleslackapi/impl/TestAbstractSlackSessionImpl.java b/src/test/java/com/ullink/slack/simpleslackapi/impl/TestAbstractSlackSessionImpl.java
@@ -7,6 +7,9 @@
 import com.ullink.slack.simpleslackapi.SlackChannel;
 import com.ullink.slack.simpleslackapi.SlackMessageHandle;
 
+import com.ullink.slack.simpleslackapi.listeners.SlackConnectedListener;
+import com.ullink.slack.simpleslackapi.events.SlackConnected;
+import com.ullink.slack.simpleslackapi.SlackSession;
 
 public class TestAbstractSlackSessionImpl
 {
@@ -92,6 +95,12 @@ public SlackMessageHandle inviteUser(String email, String firstName, boolean set
         {
             return null;
         }
+
+        // Helper method with access to abstract class properties.
+        public boolean isListening(SlackConnectedListener expectedListener) 
+        {
+          return slackConnectedListener.contains(expectedListener);
+        }
     }
 
     @Test
@@ -199,5 +208,30 @@ public void testFindUserByUserName_MissingBot()
         assertThat(slackSession.findUserByUserName("unknownuser")).isNull();
     }
 
+    @Test
+    public void testAddConnectedListener() {
+        SlackConnectedListener listener = new SlackConnectedListener() {
+          public void onEvent(SlackConnected event, SlackSession session) {
+          }
+        };
 
+        TestSlackSessionImpl slackSession = new TestSlackSessionImpl();
+        slackSession.addSlackConnectedListener(listener);
+
+        assertThat(!slackSession.isListening(listener));
+    }
+
+    @Test
+    public void testRemoveConnectedListener() {
+        SlackConnectedListener listener = new SlackConnectedListener() {
+          public void onEvent(SlackConnected event, SlackSession session) {
+          }
+        };
+
+        TestSlackSessionImpl slackSession = new TestSlackSessionImpl();
+        slackSession.addSlackConnectedListener(listener);
+        slackSession.removeSlackConnectedListener(listener);
+
+        assertThat(!slackSession.isListening(listener));
+    }
 }