adding logging instead of system.out or .err

Author: kisaga

examples/pom.xml

@@ -19,5 +19,10 @@
             <version>1.2.4</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-simple</artifactId>
+            <version>1.7.5</version>
+        </dependency>
     </dependencies>
 </project>

examples/src/main/java/com/twitter/clientlib/HelloWorldStreaming.java

@@ -25,11 +25,7 @@
 
 import com.twitter.clientlib.model.*;
 import com.twitter.clientlib.query.StreamQueryParameters;
-import com.twitter.clientlib.query.model.MediaField;
-import com.twitter.clientlib.query.model.PlaceField;
-import com.twitter.clientlib.query.model.PollField;
 import com.twitter.clientlib.query.model.TweetField;
-import com.twitter.clientlib.query.model.UserField;
 import com.twitter.clientlib.stream.TweetsStreamListener;
 import com.twitter.clientlib.stream.TwitterStream;
 
@@ -48,17 +44,9 @@ public static void main(String[] args) {
     twitterStream.setTwitterCredentials(credentials);
     twitterStream.addListener(new Responder());
 
-//    twitterStream.sampleStream(new StreamQueryParameters.Builder()
-//            .withTweetFields(TweetField.AUTHOR_ID, TweetField.ID, TweetField.CREATED_AT)
-//            .build());
-
     twitterStream.sampleStream(new StreamQueryParameters.Builder()
-                    .withTweetFields(TweetField.all())
-                    .withMediaFields(MediaField.all())
-                    .withUserFields(UserField.all())
-                    .withPollFields(PollField.all())
-                    .withPlaceFields(PlaceField.all())
-                    .build());
+            .withTweetFields(TweetField.AUTHOR_ID, TweetField.ID, TweetField.CREATED_AT)
+            .build());
 
   }
 }

src/main/java/com/twitter/clientlib/exceptions/StreamException.java

@@ -0,0 +1,12 @@
+package com.twitter.clientlib.exceptions;
+
+public class StreamException extends RuntimeException{
+
+    public StreamException(String message) {
+        super(message);
+    }
+
+    public StreamException(String message, Throwable cause) {
+        super(message, cause);
+    }
+}

src/main/java/com/twitter/clientlib/stream/TweetsStreamExecutor.java

@@ -34,15 +34,18 @@
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.DeserializationFeature;
-import com.fasterxml.jackson.databind.JsonMappingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 import com.twitter.clientlib.exceptions.EmptyStreamTimeoutException;
 import com.twitter.clientlib.model.StreamingTweet;
 import okio.BufferedSource;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 public class TweetsStreamExecutor {
 
+  private static final Logger logger = LoggerFactory.getLogger(TweetsStreamExecutor.class);
+
   private static final long EMPTY_STREAM_TIMEOUT = 20000;
   private static final int POLL_WAIT = 5;
   private volatile BlockingQueue<String> rawTweets;
@@ -75,7 +78,7 @@ public void removeListener(TweetsStreamListener toRemove) {
 
   public void start() {
     if (stream == null) {
-      System.out.println("Error: stream is null.");
+      logger.error("Stream is null. Exiting...");
       return;
     }
     startTime = System.currentTimeMillis();
@@ -91,6 +94,7 @@ public void start() {
   }
 
   public synchronized void shutdown() {
+    logger.info("TweetsStreamListenersExecutor is shutting down.");
     isRunning = false;
     shutDownServices();
     try {
@@ -102,7 +106,6 @@ public synchronized void shutdown() {
     } catch (IOException e) {
 
     }
-    System.out.println("TweetsStreamListenersExecutor is shutting down.");
   }
 
   private void shutDownServices() {
@@ -120,12 +123,14 @@ private void terminateService(ExecutorService executorService) throws Interrupte
     if (!executorService.awaitTermination(1500, TimeUnit.MILLISECONDS)) {
       executorService.shutdownNow();
       if (!executorService.awaitTermination(1500, TimeUnit.MILLISECONDS))
-        System.err.println("Pool did not terminate");
+        logger.error("Thread pool did not terminate");
     }
   }
 
   private class RawTweetsQueuer implements Runnable {
 
+    private final Logger logger = LoggerFactory.getLogger(RawTweetsQueuer.class);
+
     @Override
     public void run() {
       queueTweets();
@@ -159,13 +164,15 @@ public void queueTweets() {
           }
         }
       } catch (Exception e) {
-        System.out.println("Something went wrong. Closing stream... " + e.getMessage());
+        logger.error("Something went wrong. Closing stream... {}", e.getMessage());
         shutdown();
       }
     }
   }
 
   private class DeserializeTweetsTask implements Runnable {
+
+    private final Logger logger = LoggerFactory.getLogger(DeserializeTweetsTask.class);
     private final ObjectMapper objectMapper;
 
     private DeserializeTweetsTask() {
@@ -181,16 +188,18 @@ public void run() {
           if (rawTweet == null) continue;
           StreamingTweet tweet = objectMapper.readValue(rawTweet, StreamingTweet.class);
           tweets.put(tweet);
-        } catch (InterruptedException e) {
+        } catch (InterruptedException ignore) {
 
         } catch (JsonProcessingException e) {
-          System.out.println("debug log here");
+          logger.debug("Json could not be parsed");
         }
       }
     }
   }
 
   private class TweetsListenersTask implements Runnable {
+
+    private final Logger logger = LoggerFactory.getLogger(TweetsListenersTask.class);
     @Override
     public void run() {
       processTweets();
@@ -211,7 +220,7 @@ private void processTweets() {
               long stopTime = System.currentTimeMillis();
               long durationInMillis = stopTime - startTime;
               double seconds = durationInMillis / 1000.0;
-              System.out.println("Total duration in seconds: " + seconds);
+              logger.info("Total duration in seconds: {}", seconds);
               shutdown();
             }
           } catch (InterruptedException e) {

src/main/java/com/twitter/clientlib/stream/TwitterStream.java

@@ -5,19 +5,27 @@
 import com.twitter.clientlib.TwitterCredentialsBearer;
 import com.twitter.clientlib.api.TweetsApi;
 import com.twitter.clientlib.exceptions.AuthenticationException;
+import com.twitter.clientlib.exceptions.StreamException;
 import com.twitter.clientlib.query.StreamQueryParameters;
+
 import okio.BufferedSource;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.util.LinkedList;
 import java.util.List;
 
 public class TwitterStream {
+
+    private static final Logger logger = LoggerFactory.getLogger(TwitterStream.class);
     private final TweetsApi tweets = new TweetsApi();
 
     private final ApiClient apiClient = new ApiClient();
 
     private final List<TweetsStreamListener> listeners = new LinkedList<>();
 
+    private TweetsStreamExecutor executor;
+
     public TwitterStream() {
         initBasePath();
         tweets.setClient(apiClient);
@@ -34,16 +42,22 @@ public void addListener(TweetsStreamListener listener) {
     public void sampleStream(StreamQueryParameters streamParameters) {
         try {
             BufferedSource streamResult = tweets.sampleStream(streamParameters);
-            TweetsStreamExecutor executor = new TweetsStreamExecutor(streamResult);
+            executor = new TweetsStreamExecutor(streamResult);
             listeners.forEach(executor::addListener);
             executor.start();
         } catch (ApiException e) {
             if(e.getCode() == 401) {
+                logger.error("Authentication didn't work");
                 throw new AuthenticationException("Not authenticated. Please check the credentials", e);
             }
+            throw new StreamException("An exception occurred during stream execution", e);
         }
     }
 
+    public void shutdown() {
+        executor.shutdown();
+    }
+
     private void initBasePath() {
         String basePath = System.getenv("TWITTER_API_BASE_PATH");
         apiClient.setBasePath(basePath != null ? basePath : "https://api.twitter.com");

src/test/java/com/twitter/clientlib/api/TweetsApiTest.java

@@ -54,6 +54,8 @@
 import com.twitter.clientlib.model.UsersRetweetsCreateRequest;
 import com.twitter.clientlib.model.UsersRetweetsCreateResponse;
 import com.twitter.clientlib.model.UsersRetweetsDeleteResponse;
+import com.twitter.clientlib.query.StreamQueryParameters;
+import okio.BufferedSource;
 import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
@@ -248,14 +250,7 @@ public void listsIdTweetsTest() throws ApiException {
      */
     @Test
     public void sampleStreamTest() throws ApiException {
-        Set<String> expansions = null;
-        Set<String> tweetFields = null;
-        Set<String> userFields = null;
-        Set<String> mediaFields = null;
-        Set<String> placeFields = null;
-        Set<String> pollFields = null;
-        Integer backfillMinutes = null;
-                InputStream response = apiInstance.tweets().sampleStream(expansions, tweetFields, userFields, mediaFields, placeFields, pollFields, backfillMinutes);
+        BufferedSource response = apiInstance.tweets().sampleStream(new StreamQueryParameters.Builder().build());
         // TODO: test validations
     }
 
@@ -269,14 +264,7 @@ public void sampleStreamTest() throws ApiException {
      */
     @Test
     public void searchStreamTest() throws ApiException {
-        Set<String> expansions = null;
-        Set<String> tweetFields = null;
-        Set<String> userFields = null;
-        Set<String> mediaFields = null;
-        Set<String> placeFields = null;
-        Set<String> pollFields = null;
-        Integer backfillMinutes = null;
-                InputStream response = apiInstance.tweets().searchStream(expansions, tweetFields, userFields, mediaFields, placeFields, pollFields, backfillMinutes);
+        BufferedSource response = apiInstance.tweets().searchStream(new StreamQueryParameters.Builder().build());
         // TODO: test validations
     }