py3 friendly

.github/workflows/pythonpackage.yml

@@ -0,0 +1,29 @@
+name: build
+
+on: [push]
+
+jobs:
+  tester:
+    name: Test them all
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      max-parallel: 4
+      matrix:
+        operating-system: [ubuntu-latest]
+        python-version: [3.8, 3.11]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest>=3.6 mock "pytest-cov<2.6.0" codecov win_inet_pton
+        pip install -r requirements.txt
+    - name: Test with pytest
+      run: |
+        pip install pytest
+        pytest

README.md

@@ -0,0 +1,16 @@
+Socks5man is a Socks5 management tool and Python library. It
+enables you to add socks5 servers, run a service that verifies if
+they are operational, and request these servers in a round-robin fashion
+by country, city, average connection time, and bandwidth, using the Python library.
+
+The library also allows for manual operationality, bandwidth, and connection time tests.
+A local database is used to lookup country and city information for a host ip.
+
+The documentation can be found at: [https://socks5man.readthedocs.io](https://socks5man.readthedocs.io).
+
+This product includes GeoLite2 data created by MaxMind, available from [maxmind.com](maxmind.com).
+
+![](https://github.com/RicoVZ/socks5man/workflows/build/badge.svg)
+
+* [maxmind.com](http://www.maxmind.com)
+* [https://socks5man.readthedocs.io](https://socks5man.readthedocs.io)

docs/source/conf.py

@@ -19,6 +19,7 @@
 
 # -- Project information -----------------------------------------------------
 
+from __future__ import absolute_import
 project = u'Socks5man'
 copyright = u'2016-2018'
 author = u'Ricardo van Zutphen'

requirements.txt

@@ -1,5 +1,5 @@
-PySocks==1.5.7
-geoip2==2.9.0
-SQLAlchemy>=1.3.3, <1.4
-click==6.6
-alembic>=1.0.7, <1.1
+PySocks>=1.7
+geoip2>=2.9.0
+SQLAlchemy
+click
+alembic

setup.py

@@ -1,17 +1,10 @@
-import sys
+from __future__ import absolute_import
 
 from setuptools import setup
 
-if sys.version[0] != "2":
-    sys.exit(
-        "Socks5man currently only supports Python 2.7. 3.5+ is on the roadmap"
-        ", but is not supported yet. For now, please install it in the"
-        " following way: `pip2 install -U socks5man`."
-    )
-
 setup(
     name="Socks5man",
-    version="0.2.0",
+    version="0.3.0",
     author="Ricardo van Zutphen",
     author_email="ricardo@hatching.io",
     packages=[
@@ -37,11 +30,11 @@
     ],
     license="GPLv3",
     description="SOCKS5 server management tool and library",
-    long_description=open("README.rst", "rb").read(),
+    long_description=open("README.md", "r").read(),
     include_package_data=True,
     url="https://github.com/RicoVZ/socks5man",
     install_requires=[r.strip() for r in open("requirements.txt", "r").readlines()],
-    python_requires=">=2.7, <3.0",
+    python_requires=">=3.6",
     extras_require={
         ":sys_platform == 'win32'": [
             "win-inet-pton==1.0.1",

socks5man/__init__.py

@@ -0,0 +1 @@
+

socks5man/config.py

@@ -1,5 +1,6 @@
-import ConfigParser
+from __future__ import absolute_import
 import os
+import configparser
 
 from socks5man.exceptions import Socks5ConfigError
 from socks5man.misc import cwd
@@ -43,7 +44,7 @@ def read(self):
         if Config._cache:
             Config._cache = {}
 
-        config = ConfigParser.ConfigParser()
+        config = configparser.ConfigParser()
 
         confpath = cwd("conf", "socks5man.conf")
         if not os.path.isfile(confpath):
@@ -53,7 +54,7 @@ def read(self):
             )
         try:
             config.read(confpath)
-        except ConfigParser.Error as e:
+        except configparser.Error as e:
             raise Socks5ConfigError(
                 "Cannot parse config file. Error: %s" % e
             )

socks5man/database.py

@@ -1,10 +1,11 @@
+from __future__ import absolute_import
 import logging
 import os
 from datetime import datetime
 
 from sqlalchemy import (
     Column, Integer, String, DateTime, Boolean, Text, create_engine,
-    Float, and_, func
+    Float, and_, func, inspect
 )
 from sqlalchemy.exc import SQLAlchemyError
 from sqlalchemy.ext.declarative import declarative_base
@@ -45,12 +46,14 @@ class Socks5(Base):
     connect_time = Column(Float(), nullable=True)
     description = Column(Text(), nullable=True)
     dnsport = Column(Integer(), nullable=True)
+    private = Column(Boolean, nullable=True)
 
-    def __init__(self, host, port, country, country_code):
+    def __init__(self, host, port, country, country_code, private):
         self.host = host
         self.port = port
         self.country = country
         self.country_code = country_code
+        self.private = private
 
     def to_dict(self):
         """Converts object to dict.
@@ -62,7 +65,7 @@ def to_dict(self):
             value = getattr(self, column.name)
             if isinstance(value, datetime):
                 socks_dict[column.name] = value.strftime("%Y-%m-%d %H:%M:%S")
-            elif isinstance(value, (str, basestring)):
+            elif isinstance(value, str):
                 socks_dict[column.name] = value.encode("utf-8")
             else:
                 socks_dict[column.name] = value
@@ -77,9 +80,7 @@ def __repr__(self):
         )
 
 
-class Database(object):
-
-    __metaclass__ = Singleton
+class Database(object, metaclass=Singleton):
 
     def __init__(self):
         self.connect(create=True)
@@ -90,9 +91,7 @@ def connect(self, create=False):
         if create:
             if not os.path.exists(cwd("socks5man.db")):
                 self._create()
-            elif not self.engine.dialect.has_table(
-                    self.engine, AlembicVersion.__tablename__
-            ):
+            elif not inspect(self.engine).has_table(AlembicVersion.__tablename__):
                 AlembicVersion.__table__.create(self.engine)
 
     def _create(self):
@@ -117,9 +116,9 @@ def db_migratable(self):
             ses.close()
 
     def add_socks5(self, host, port, country, country_code, operational=False,
-                   city=None, username=None, password=None, dnsport=None, description=None):
+                   city=None, username=None, password=None, dnsport=None, description=None, private=False):
         """Add new socks5 server to the database"""
-        socks5 = Socks5(host, port, country, country_code)
+        socks5 = Socks5(host, port, country, country_code, private)
         socks5.operational = operational
         socks5.city = city
         socks5.username = username
@@ -381,7 +380,7 @@ def bulk_delete_socks5(self, ids_list):
         @param ids_list: A list of socks5 ids to delete"""
         chunk = 100
         try:
-            for c in xrange(0, len(ids_list), chunk):
+            for c in range(0, len(ids_list), chunk):
                 self.engine.execute(
                     Socks5.__table__.delete().where(
                         Socks5.id.in_(ids_list[c:c+chunk])

socks5man/helpers.py

@@ -1,9 +1,11 @@
+from __future__ import absolute_import
 import logging
 import socket
 import socks
 import struct
 import time
-import urllib2
+import urllib.request
+import urllib.error
 
 from socks5man.config import cfg
 from socks5man.constants import IANA_RESERVERD_IPV4_RANGES
@@ -48,6 +50,8 @@ def is_ipv4(ip):
     """Try to parse string as Ipv4. Return True if success, False
     otherwise"""
     try:
+        if not isinstance(ip, type(str)):
+            ip = str(ip)
         socket.inet_aton(ip)
         return True
     except socket.error:
@@ -125,19 +129,18 @@ def validify_host_port(host, port):
 
 def get_over_socks5(url, host, port, username=None, password=None, timeout=3):
     """Make a HTTP GET request over socks5 of the given URL"""
-    socks.set_default_proxy(
-        socks.SOCKS5, host, port,
-        username=username, password=password
-    )
+
+    socks.set_default_proxy(socks.SOCKS5, host, port, username=username, password=password)
 
     response = None
+    clean_socket = socket.socket
     try:
         socket.socket = socks.socksocket
-        response = urllib2.urlopen(url, timeout=timeout).read()
-    except (socket.error, urllib2.URLError, socks.ProxyError) as e:
+        response = urllib.request.urlopen(url, timeout=timeout).read()
+    except urllib.error.URLError as e:
         log.error("Error making HTTP GET over socks5: %s", e)
     finally:
-        socket.socket = socket._socketobject
+        socket.socket = clean_socket
     return response
 
 def approximate_bandwidth(host, port, username=None, password=None,

socks5man/logs.py

@@ -1,3 +1,4 @@
+from __future__ import absolute_import
 import copy
 import logging
 import sys

socks5man/main.py

@@ -1,3 +1,5 @@
+from __future__ import absolute_import
+from __future__ import print_function
 import click
 import csv
 import logging
@@ -63,7 +65,8 @@ def verify(repeated, operational, non_operational, unverified):
 @click.option("-u", "--username", help="Username for this socks5 server")
 @click.option("-p", "--password", help="Password for this socks5 server")
 @click.option("-d", "--description", help="Description for this socks5 server")
-def add(host, port, username, password, description):
+@click.option("-pi", "--private", is_flag=True, help="Private server ip")
+def add(host, port, username, password, description, private):
     """Add socks5 server."""
     if username and not password or password and not username:
         log.warning(
@@ -75,7 +78,7 @@ def add(host, port, username, password, description):
     try:
         entry = m.add(
             host, port, username=username, password=password,
-            description=unicode(description)
+            description=description, private=private
         )
     except Socks5manError as e:
         log.error("Failed to add socks5 server: %s", e)
@@ -217,20 +220,22 @@ def list(country, code, city, host, operational, non_operational, count,
         sys.exit(0)
 
     if not export:
-        print(
+        print((
             "{:<4} {:<12} {:<20} {:<5} {:<16} {:<12} {:<16} {:<16} {:<16}{:<16}".format(
                 "ID", "Operational", "Host", "Port", "Country", "Country Code", "City",
                 "Username", "Password", "Description",
             )
-        )
+        ))
         for socks5 in socks5s:
             print(
                 "{:<4} {:<12} {:<20} {:<5} {:<16} {:<12} {:<16} {:<16} {:<16} {:<16}".format(
                     socks5.id, "Yes" if socks5.operational else "No", socks5.host, socks5.port,
                     socks5.country, socks5.country_code, socks5.city,
-                    socks5.username, socks5.password, socks5.description
+                    socks5.username if socks5.username else "", socks5.password if socks5.password else "",
+                    socks5.description if socks5.description else ""
                 )
             )
+
         sys.exit(0)
 
     if os.path.exists(export):
@@ -243,10 +248,10 @@ def list(country, code, city, host, operational, non_operational, count,
         for socks5 in socks5s:
             socks5_d = socks5.to_dict()
             if header:
-                csv_w.writerow(socks5_d.keys())
+                csv_w.writerow(list(socks5_d.keys()))
                 header = False
 
-            csv_w.writerow(socks5_d.values())
+            csv_w.writerow(list(socks5_d.values()))
 
 
 @main.command()