Merge pull request #31 from fterh/release-v0.8.0-beta

Release v0.8.0 beta

Author: fterh

.travis.yml

@@ -0,0 +1,9 @@
+dist: xenial
+language: python
+python:
+  - "3.7"
+install:
+  - pip install pipenv
+script:
+  - pipenv install
+  - pipenv run invoke test

README.md

@@ -1,4 +1,7 @@
 # sneakpeek
+
+[![Build Status](https://travis-ci.com/fterh/sneakpeek.svg?branch=master)](https://travis-ci.com/fterh/sneakpeek)
+
 A Reddit bot that previews hyperlinks and posts their contents as a comment.
 It should **never spam or double-post**, and will skip a comment if it is
 too long.
@@ -49,6 +52,9 @@ If the final comment in Markdown does not exceed a pre-configured comment length
 (`config.COMMENT_LENGTH_LIMIT`), the comment is posted, and the action written 
 to the database (through `DatabaseManager`) to prevent double-posting.
 
+Logging is written to standard output, and logging level can be configured in
+`config.py`.
+
 ### Handlers
 `handler.py` contains a HandlerManager that checks if a website has a Handler. 
 
@@ -78,6 +84,12 @@ the commands.
 `ENV=prod python main.py` or `ENV=prod nohup python main.py &`
 
 ## Changelog
+### v0.8.0-beta
+* Fix program stops running after a while (issue #30)
+* Implement proper logging
+* Clean up and refactor codebase
+* Travis CI
+
 ### v0.7.0-beta
 * Fix random crashes (issue #25)
 * Fix README formatting issues

config.py

@@ -1,4 +1,6 @@
+import logging
 import os
+import sys
 from dotenv import load_dotenv
 
 
@@ -7,8 +9,14 @@
 # Set to "prod" in production, but default to "dev"
 ENV = os.getenv("ENV", "dev")
 
+# Logging configuration
+LOGGING = {
+    "LEVEL": logging.DEBUG,
+    "HANDLER": logging.StreamHandler(sys.stdout)  # Log to stdout (see: https://12factor.net/logs)
+}
+
 BOT = {
-    "VERSION": "0.7.0-beta",
+    "VERSION": "0.8.0-beta",
     "REPO_LINK": "https://github.com/fterh/sneakpeek",
     "CONTRIBUTE_LINK": "https://github.com/fterh/sneakpeek"
 }

main.py

@@ -1,12 +1,25 @@
-import traceback
+import logging
 import praw
 import config
 from scan import scan
 
 
-def start():
-    print("Starting main")
+def setup_logging():
+    root = logging.getLogger()
+    root.setLevel(config.LOGGING["LEVEL"])
+
+    handler = config.LOGGING["HANDLER"]
+    handler.setLevel(logging.DEBUG)
+
+    formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
 
+    handler.setFormatter(formatter)
+    root.addHandler(handler)
+
+
+def start():
+    logging.info("Starting application")
+    logging.info("Instantiating Reddit instance")
     reddit = praw.Reddit(
         client_id=config.CLIENT["ID"],
         client_secret=config.CLIENT["SECRET"],
@@ -20,9 +33,10 @@ def start():
         # This should never happen,
         # because it breaks the infinite subreddit monitoring
         # provided by subreddit.stream.submissions()
-        print("Exception occurred while scanning. This should never happen!")
-        traceback.print_exc()
+        logging.critical("Exception occurred while scanning. This should never happen.")
+        logging.critical(e)
 
 
 if __name__ == "__main__":
+    setup_logging()
     start()

qualify.py

@@ -1,3 +1,4 @@
+import logging
 from handler import HandlerManager
 
 
@@ -8,10 +9,14 @@ def qualify(submission):
     (1) Submission is a link
     (2) Submission has a Handler
     """
+    logging.info("Qualifying submission id: {}".format(submission.id))
+
     # Check (1) Submission is a link
     is_link = not submission.is_self
 
     # Check (2) Submission has a Handler
     has_handler = HandlerManager.has_handler(submission.url)
 
+    logging.debug("is_link = {}, has_handler = {}".format(is_link, has_handler))
+
     return is_link and has_handler

scan.py

@@ -1,6 +1,5 @@
-import traceback
-
 import config
+import logging
 import sys
 from handler import HandlerManager
 from comment import format_comment
@@ -9,46 +8,64 @@
 
 def scan(subreddit):
     """Scan a Subreddit for new submissions."""
-    print("Starting scan")
+    logging.info("Starting scan")
 
     for submission in subreddit.stream.submissions(skip_existing=True):
-        print("Operating on submission ID: " + submission.id)
+        logging.info("Operating on submission")
+        logging.debug("Submission ID = {}, title = {}".format(
+            submission.id,
+            submission.title
+        ))
 
         does_qualify = qualify(submission)
 
-        if does_qualify:
-            print("Submission qualifies")
+        if not does_qualify:
+            logging.info("Comment does not qualify; skipping comment")
+            continue
+
+        logging.info("Submission qualifies")
 
+        handler = None
+        try:
+            logging.info("Attempting to get article handler")
             handler = HandlerManager.get_handler(submission.url)
+            logging.info("Article handler = {}".format(handler))
+        except Exception as e:
+            logging.error("""
+                            An error occurred while getting article handler. This should never happen.
+                            """)
+            logging.error("Exception = {}".format(e))
+            logging.info("Skipping current submission")
+            continue
+
+        comment_raw = None
+        try:
+            logging.info("Attempting to generate raw comment using handler")
+            comment_raw = handler.handle(submission.url)
+            logging.info("Raw comment generated")
+        except Exception as e:
+            logging.error("An error occurred while handling URL = {}".format(
+                submission.url
+            ))
+            logging.error("Exception = {}".format(e))
+            logging.info("Skipping current submission")
+            continue
+
+        if comment_raw is None:
+            logging.error("comment_raw is None; skipping current submission")
+            continue
 
-            comment_raw = None
+        logging.info("Generating formatted comment")
+        comment_markdown = format_comment(comment_raw)
+        logging.info("Formatted comment generated")
+
+        if len(comment_markdown) < config.COMMENT_LENGTH_LIMIT:
             try:
-                comment_raw = handler.handle(submission.url)
+                logging.info("Attempting to post comment")
+                submission.reply(comment_markdown)
+                logging.info("Comment posting succeeded")
             except Exception as e:
-                print(f"Exception occurred while handling {submission.url}")
-                traceback.print_exc()
-
-            if comment_raw is None:
-                skip(submission)
-                return
-            comment_markdown = format_comment(comment_raw)
-
-            if len(comment_markdown) < config.COMMENT_LENGTH_LIMIT:
-                try:
-                    print("Attempting to post a comment")
-                    submission.reply(comment_markdown)
-                    print("Comment posting succeeded")
-                except Exception as e:
-                    print("An error occurred:")
-                    print(e)
-            else:
-                print("Submission is too long to be posted.")
+                logging.error("An error occurred while posting comment")
+                logging.error("Exception = {}".format(e))
         else:
-            skip(submission)
-
-        # Flush stdout buffer
-        sys.stdout.flush()
-
-def skip(submission):
-    # If submission does not qualify, write SKIP to database only if it is new.
-    print("Submission does not qualify")
+            logging.warning("Submission is too long to be posted")

test_scan.py

@@ -1,4 +1,3 @@
-import sqlite3
 import unittest
 from unittest import mock, TestCase