fix: requirements.txt to reduce vulnerabilities

The following vulnerabilities are fixed by pinning transitive dependencies:
- https://snyk.io/vuln/SNYK-PYTHON-WEBSOCKETS-1582792

.drone.yml

@@ -1,14 +0,0 @@
----
-kind: pipeline
-type: docker
-name: delugeClient
-
-platform:
-  os: linux
-  arch: amd64
-
-steps:
-  - name: Build package
-    image: python:3.8
-    commands:
-      - make build

Makefile

@@ -1,17 +0,0 @@
-.PHONY: clean
-binaries=dist build
-
-install:
-	python3 setup.py install
-
-build:
-	python3 setup.py build
-
-dist:
-	python3 setup.py sdist
-
-upload: clean dist
-	twine upload dist/*
-
-clean:
-	rm -rf $(binaries)

README.md

@@ -4,15 +4,18 @@
 
 <h4 align="center"> A easy to use Deluge CLI that can connect to Deluge RPC (even over ssh) written entirely in python.</h4>
 
-| Tested version | PyPi package | Drone CI |
-|:--------|:------|:------|
-| [![PyVersion](https://img.shields.io/badge/python-3.8-blue.svg)](https://www.python.org/downloads/release/python-380/) | [![PyPI](https://img.shields.io/pypi/v/delugeClient_kevin)](https://pypi.org/project/delugeClient_kevin/) | [![Build Status](https://drone.schleppe.cloud/api/badges/KevinMidboe/delugeClient/status.svg)](https://drone.schleppe.cloud/KevinMidboe/delugeClient)
-
-
-| Known vulnerabilities | License |
-|:--------|:------|
-| [![Known Vulnerabilities](https://snyk.io/test/github/kevinmidboe/delugeClient/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/kevinmidboe/delugeClient?targetFile=requirements.txt) |[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
-
+<p align="center">
+  <a href="https://pypi.org/project/delugeClient-kevin/">
+    <img src="https://img.shields.io/pypi/v/delugeClient-kevin" />
+  </a>
+  <a href="https://snyk.io/test/github/kevinmidboe/delugeclient?targetFile=requirements.txt">
+  	<img src="https://snyk.io/test/github/kevinmidboe/delugeclient/badge.svg?targetFile=requirements.txt" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/kevinmidboe/delugeclient?targetFile=requirements.txt" style="max-width:100%;">
+  </a>
+  
+  <a href="https://opensource.org/licenses/MIT">
+    <img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="">
+  </a>
+</p>
 
 <p align="center">
   <a href="#abstract">Abstract</a> •

delugeClient/__init__.py

@@ -1,22 +1,22 @@
-#!/usr/bin/env python3.6
-# -*- encoding: utf-8 -*-
-
+import os
 from sys import path
-from os.path import dirname, join
 
-path.append(dirname(__file__))
+path.append(os.path.dirname(__file__))
+
+__version__=0.1
 
 import logging
-from utils import BASE_DIR, ColorizeFilter
+from delugeUtils import BASE_DIR
 
 logger = logging.getLogger('deluge_cli')
 logger.setLevel(logging.DEBUG)
 
-fh = logging.FileHandler(join(BASE_DIR, 'deluge_cli.log'))
+fh = logging.FileHandler(os.path.join(BASE_DIR, 'deluge_cli.log'))
 fh.setLevel(logging.DEBUG)
+ch = logging.StreamHandler()
+ch.setLevel(logging.ERROR)
 
 formatter = logging.Formatter('%(asctime)s %(levelname)8s %(name)s | %(message)s')
 fh.setFormatter(formatter)
-
 logger.addHandler(fh)
-logger.addFilter(ColorizeFilter())
+logger.addHandler(ch)

delugeClient/__main__.py

@@ -1,137 +1,148 @@
 #!/usr/bin/env python3.6
 
+
+"""Custom delugeRPC client
+Usage:
+   deluge_cli add MAGNET [DIR] [--json | --debug | --warning | --error]
+   deluge_cli search NAME [--json]
+   deluge_cli get  TORRENT [--json | --debug | --warning | --error]
+   deluge_cli ls [--downloading | --seeding | --paused | --json]
+   deluge_cli toggle TORRENT
+   deluge_cli progress [--json]
+   deluge_cli rm NAME [--destroy] [--debug | --warning | --error]
+   deluge_cli (-h | --help)
+   deluge_cli --version
+
+Arguments:
+   MAGNET        Magnet link to add
+   DIR           Directory to save to
+   TORRENT       A selected torrent
+
+Options:
+   -h --help     Show this screen
+   --version     Show version
+   --print       Print response from commands
+   --json        Print response as JSON
+   --debug       Print all debug log
+   --warning     Print only logged warnings
+   --error       Print error messages (Error/Warning)
+"""
 import os
 import sys
 import signal
 import logging
 
-import typer
+from docopt import docopt
 from pprint import pprint
 
 from deluge import Deluge
 from utils import ColorizeFilter, BASE_DIR
-from __version__ import __version__
+from __init__ import __version__
 
 logger = logging.getLogger('deluge_cli')
+logger.setLevel(logging.DEBUG)
+
+fh = logging.FileHandler(os.path.join(BASE_DIR, 'deluge_cli.log'))
+fh.setLevel(logging.DEBUG)
 ch = logging.StreamHandler()
 ch.setLevel(logging.ERROR)
+
+formatter = logging.Formatter('%(asctime)s %(levelname)8s %(name)s | %(message)s')
+fh.setFormatter(formatter)
+logger.addHandler(fh)
 logger.addHandler(ch)
 
-logger.addFilter(ColorizeFilter())
-
-app = typer.Typer()
-deluge = Deluge()
+logger.addFilter(ColorizeFilter())   
 
 def signal_handler(signal, frame):
   """
   Handle exit by Keyboardinterrupt
   """
-  del deluge
-
   logger.info('\nGood bye!')
   sys.exit(0)
 
-def handleKeyboardInterrupt():
+def main():
+  """
+  Main function, parse the input
+  """
   signal.signal(signal.SIGINT, signal_handler)
 
-def printResponse(response, json=False):
+  arguments = docopt(__doc__, version=__version__)
+
+  # Set logging level for streamHandler
+  if arguments['--debug']:
+    ch.setLevel(logging.DEBUG)
+  elif arguments['--warning']:
+    ch.setLevel(logging.WARNING)
+  elif arguments['--error']:
+    ch.setLevel(logging.ERROR)
+
+  logger.info('Deluge client')
+  logger.debug(arguments)
+
+  # Get config settings
+  deluge = Deluge()
+
+  _id = arguments['TORRENT']
+  query = arguments['NAME']
+  magnet = arguments['MAGNET']
+  name = arguments['NAME']
+  _filter = [ a[2:] for a in ['--downloading', '--seeding', '--paused'] if arguments[a] ]
+
+  response = None
+
+  if arguments['add']:
+    logger.info('Add cmd selected with link {}'.format(magnet))
+    response = deluge.add(magnet)
+
+    if response is not None:
+      logger.info('Successfully added torrent.\nResponse from deluge: {}'.format(response))
+    else:
+      logger.warning('Add response returned empty: {}'.format(response))
+
+  elif arguments['search']:
+    logger.info('Search cmd selected for query: {}'.format(query))
+    response = deluge.search(query)
+    if response is not None or response != '[]':
+      logger.info('Search found {} torrents'.format(len(response)))
+    else:
+      logger.info('Empty response for search query.')
+
+  elif arguments['progress']:
+    logger.info('Progress cmd selected.')
+    response = deluge.progress()
+
+  elif arguments['get']:
+    logger.info('Get cmd selected for id: {}'.format(_id))
+    response = deluge.get(_id)
+
+  elif arguments['ls']:
+    logger.info('List cmd selected')
+    response = deluge.get_all(_filter=_filter)
+
+  elif arguments['toggle']:
+    logger.info('Toggling id: {}'.format(_id))
+    deluge.togglePaused(_id)
+
+  elif arguments['rm']:
+    destroy = arguments['--destroy']
+    logger.info('Remove by name: {}.'.format(name))
+
+    if destroy:
+      logger.info('Destroy set, removing files')
+      deluge.remove(name, destroy)
+
   try:
-    if json:
-      if isinstance(response, list):
+    if arguments['--json']:
+      if len(response) > 1:
         print('[{}]'.format(','.join([t.toJSON() for t in response])))
       else:
-        print(response.toJSON())
-
-    elif isinstance(response, list):
-      for el in response:
-        print(el)
-
-    elif response:
-      print(response)
-
+        print(response[0].toJSON())
   except KeyError as error:
     logger.error('Unexpected error while trying to print')
     raise error
 
-@app.command()
-def add(magnet: str):
-  '''
-  Add magnet torrent
-  '''
-  logger.debug('Add command selected')
-  logger.debug(magnet)
-  response = deluge.add(magnet)
-  printResponse(response)
-
-@app.command()
-def ls(json: bool = typer.Option(False, help="Print as json")):
-  '''
-  List all torrents
-  '''
-  logger.debug('List command selected')
-  response = deluge.get_all()
-  printResponse(response, json)
-
-@app.command()
-def get(id: str, json: bool = typer.Option(False, help="Print as json")):
-  '''
-  Get torrent by id or hash
-  '''
-  logger.debug('Get command selected for id {}'.format(id))
-  response = deluge.get(id)
-  printResponse(response, json)
-
-@app.command()
-def toggle(id: str):
-  '''
-  Toggle torrent download state
-  '''
-  logger.debug('Toggle command selected for id {}'.format(id))
-  response = deluge.toggle(id)
-  printResponse(response)
-
-@app.command()
-def search(query: str, json: bool = typer.Option(False, help="Print as json")):
-  '''
-  Search for string segment in torrent name
-  '''
-  logger.debug('Search command selected with query: {}'.format(query))
-  response = deluge.search(query)
-  printResponse(response, json)
-
-@app.command()
-def remove(id: str, destroy: bool = typer.Option(False, help="Remove torrent data")):
-  '''
-  Remove torrent by id or hash
-  '''
-  logger.debug('Remove command selected for id: {} with destroy: {}'.format(id, destroy))
-  response = deluge.remove(id, destroy)
-  printResponse(response)
-
-@app.command()
-def version():
-  '''
-  Print package version
-  '''
-  print(__version__)
-
-@app.callback()
-def defaultOptions(debug: bool = typer.Option(False, '--debug', help='Set log level to debug'), info: bool = typer.Option(False, '--info', help='Set log level to info'), warning: bool = typer.Option(False, '--warning', help='Set log level to warning'), error: bool = typer.Option(False, '--error', help='Set log level to error')):
-  ch.setLevel(logging.WARNING)
-
-  if error == True:
-    ch.setLevel(logging.ERROR)
-  elif warning == True:
-    ch.setLevel(logging.WARNING)
-  elif info == True:
-    ch.setLevel(logging.INFO)
-  elif debug == True:
-    ch.setLevel(logging.DEBUG)
-
-def main():
-  app()
-  del deluge
+  return response
 
 if __name__ == '__main__':
-  handleKeyboardInterrupt()
-  main()
+  main()

delugeClient/__version__.py

@@ -1 +0,0 @@
-__version__ = '0.3.0'

delugeClient/deluge.py

@@ -9,7 +9,7 @@ import logging.config
 
 from deluge_client import DelugeRPCClient
 from sshtunnel import SSHTunnelForwarder
-from utils import getConfig, BASE_DIR
+from delugeUtils import getConfig, BASE_DIR
 
 from torrent import Torrent
 
@@ -19,14 +19,6 @@ def split_words(string):
    logger.debug('Splitting input: {} (type: {}) with split_words'.format(string, type(string)))
    return re.findall(r"[\w\d']+", string.lower())
 
-def responseToString(response=None):
-   try:
-      response = response.decode('utf-8')
-   except (UnicodeDecodeError, AttributeError):
-      pass
-
-   return response
-
 class Deluge(object):
    """docstring for ClassName"""
    def __init__(self):
@@ -54,7 +46,7 @@ class Deluge(object):
       return torrents
 
    def _connect(self):
-      logger.debug('Checking if script on same server as deluge RPC')
+      logger.info('Checking if script on same server as deluge RPC')
       if self.host != 'localhost' and self.host is not None:
          try:
             if self.password:
@@ -74,14 +66,11 @@ class Deluge(object):
 
    def add(self, url):
       logger.info('Adding magnet with url: {}.'.format(url))
-      response = None
       if (url.startswith('magnet')):
-         response = self.client.call('core.add_torrent_magnet', url, {})
+         return self.client.call('core.add_torrent_magnet', url, {})
       elif url.startswith('http'):
          magnet = self.getMagnetFromFile(url)
-         response = self.client.call('core.add_torrent_magnet', magnet, {})
-
-      return responseToString(response)
+         return self.client.call('core.add_torrent_magnet', magnet, {})
 
    def get_all(self, _filter=None):
       if (type(_filter) is list and len(_filter)):
@@ -101,7 +90,7 @@ class Deluge(object):
       torrentNamesMatchingQuery = []
       if len(allTorrents):
          for torrent in allTorrents:
-            if query in torrent.name.lower():
+            if query in torrent.name:
                torrentNamesMatchingQuery.append(torrent)
 
          allTorrents = torrentNamesMatchingQuery
@@ -113,47 +102,33 @@ class Deluge(object):
 
    def get(self, id):
       response = self.client.call('core.get_torrent_status', id, {})
-      if response == {}:
-         logger.warning('No torrent with id: {}'.format(id))
-         return None
-
       return Torrent.fromDeluge(response)
 
-   def toggle(self, id):
+   def togglePaused(self, id):
       torrent = self.get(id)
       if (torrent.paused):
          response = self.client.call('core.resume_torrent', [id])
       else:
          response = self.client.call('core.pause_torrent', [id])
+      return response
 
-      return responseToString(response)
-
-   def removeByName(self, name, destroy=False):
+   def remove(self, name, destroy=False):
       matches = list(filter(lambda t: t.name == name, self.get_all()))
       logger.info('Matches for {}: {}'.format(name, matches))
       
-      if len(matches) > 1:
+      if (len(matches) > 1):
          raise ValueError('Multiple files found matching key. Unable to remove.')
-      elif len(matches) == 1:
+      elif (len(matches) == 1):
          torrent = matches[0]
-         response = self.remove(torrent.key, destroy)
+         response = self.client.call('core.remove_torrent', torrent.key, destroy)
          logger.info('Response: {}'.format(str(response)))
 
-         if response == False:
+         if (response == False):
             raise AttributeError('Unable to remove torrent.')
-         return responseToString(response)
+         return response
       else:
          logger.error('ERROR. No torrent found with that name.')
 
-   def remove(self, id, destroy=False):
-      response = self.client.call('core.remove_torrent', id, destroy)
-      logger.info('Response: {}'.format(str(response)))
-
-      if response == False:
-         raise AttributeError('Unable to remove torrent.')
-
-      return responseToString(response)
-
    def filterOnValue(self, torrents, value):
       filteredTorrents = []
       for t in torrents:
@@ -165,12 +140,23 @@ class Deluge(object):
          filteredTorrents.append(value_template)
       return filteredTorrents
 
-   def __del__(self):
-      self.client.disconnect()
+   def progress(self):
+      attributes = ['progress', 'eta', 'state', 'finished']
+      all_torrents = self.get_all()
 
-      if hasattr(self, 'tunnel') and self.tunnel.is_active:
-         logger.debug('Closing ssh tunnel')
-         self.tunnel.stop(True)
+      torrents = []
+      for i, attribute in enumerate(attributes):
+         if i < 1:
+            torrents = self.filterOnValue(all_torrents, attribute)
+            continue
+         torrents = [dict(e, **v) for e,v in zip(torrents, self.filterOnValue(all_torrents, attribute))]
+
+      return torrents
+
+   def __del__(self):
+      if hasattr(self, 'tunnel'):
+         logger.info('Closing ssh tunnel')
+         self.tunnel.stop()
 
    def getMagnetFromFile(self, url):
       logger.info('File url found, fetching magnet.')

delugeClient/delugeUtils.py

@@ -50,7 +50,7 @@ def getConfig():
   for key, value in requiredParameters:
     if value == '':
       logger.error('Missing value for variable: "{}" in config: \
-"{}.'.format(key, user_config_dir))
+"$HOME/.config/delugeClient/config.ini".'.format(key))
       exit(1)
 
   return config

delugeClient/torrent.py

@@ -44,5 +44,5 @@ class Torrent(object):
     return json.dumps(torrentDict)
 
   def __str__(self):
-    return "{} Progress: {}% ETA: {} State: {} Paused: {}".format(
-      self.name[:59].ljust(60), self.progress.rjust(5), self.eta.rjust(11), self.state.ljust(12), self.paused)
+    return "Name: {}, Progress: {}%, ETA: {}, State: {}, Paused: {}".format(
+      self.name, self.progress, self.eta, self.state, self.paused)

requirements.txt

@@ -3,4 +3,4 @@ deluge-client==1.9.0
 docopt==0.6.2
 requests==2.25.1
 sshtunnel==0.4.0
-websockets==9.1
+websockets==10.0

setup.py

@@ -1,34 +1,25 @@
-#!/usr/bin/env python3
-# -*- encoding: utf-8 -*-
 from setuptools import setup, find_packages
-from sys import path
-from os.path import dirname
+
+import delugeClient
 
 with open("README.md", "r", encoding="utf-8") as fh:
   long_description = fh.read()
 
-exec(open('delugeClient/__version__.py').read())
-
 setup(
   name="delugeClient-kevin",
-  version=__version__,
-  packages=find_packages(),
-  package_data={
-    'delugeClient': ['default_config.ini'],
-  },
-  python_requires=">=3.6",
+  version=delugeClient.__version__,
   author="KevinMidboe",
   description="Deluge client with custom functions written in python",
   long_description=long_description,
   long_description_content_type="text/markdown",
   url="https://github.com/kevinmidboe/delugeClient",
   install_requires=[
-    'colored',
-    'deluge-client',
-    'requests',
-    'sshtunnel',
-    'typer',
-    'websockets'
+    'colored==1.4.2',
+    'deluge-client==1.9.0',
+    'docopt==0.6.2',
+    'requests==2.25.1',
+    'sshtunnel==0.4.0',
+    'websockets==9.1'
   ],
   classifiers=[
     'Programming Language :: Python',
@@ -39,5 +30,10 @@ setup(
     'console_scripts': [
       'delugeclient = delugeClient.__main__:main',
    ],
-  }
+  },
+  packages=find_packages(),
+  package_data={
+    'delugeClient': ['default_config.ini'],
+  },
+  python_requires=">=3.6",
 )