update: pytest for unit tests, bug fixes.

Author: Two Dev

.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit = tests/*

.editorconfig

@@ -0,0 +1,23 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{py,rst,ini}]
+indent_style = space
+indent_size = 4
+
+[*.{html,css,scss,json,yml,xml}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab

.github/workflows/ci.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: ['3.9', '3.10', '3.11']
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
@@ -24,11 +24,15 @@ jobs:
     - name: Install Dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements.txt
+        pip install -r requirements-dev.txt
 
     - name: Run pre-commit
       uses: pre-commit/[email protected]
 
+    - name: Run tests
+      run: |
+        python -m pytest tests
+
   deploy:
     needs: build
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -1,6 +1,35 @@
 Release History
 ===============
 
+1.0.3 (2024-12-11)
+-------------------
+**Improvements:**
+
+- Add unit tests.
+- Improve document.
+
+**Bugfixes:**
+
+- Fix timeout.
+- Fix missing port redirection.
+
+
+1.0.3 (2024-12-05)
+-------------------
+**Improvements**
+
+- improve document.
+
+**Bugfixes**
+
+- Fix multipart encoders, cross share auth.
+
+1.0.2 (2024-12-05)
+-------------------
+**Improvements**
+- Download specific TLS library versions.
+- Add a document.
+
 1.0.1 (2024-12-04)
 -------------------
-* First release
+- First release

Makefile

@@ -1,6 +1,10 @@
 .PHONY: docs
 init:
-	python -m pip install -r requirements.txt
+	python -m pip install -r requirements-dev.txt
+
+test:
+	tox -p
+	rm -rf *.egg-info
 
 test-readme:
 	python setup.py check --restructuredtext --strict && ([ $$? -eq 0 ] && echo "README.rst and CHANGELOG.md ok") || echo "Invalid markup in README.md or CHANGELOG.md!"
@@ -10,11 +14,22 @@ lint:
 	python -m isort tls_requests
 	python -m flake8 tls_requests
 
+coverage:
+	python -m pytest --cov-config .coveragerc --verbose --cov-report term --cov-report xml --cov=tls_requests tests
+
+docs:
+	mkdocs serve
+
+publish-test-pypi:
+	python -m pip install -r requirements-dev.txt
+	python -m pip install 'twine>=6.0.1'
+	python setup.py sdist bdist_wheel
+	twine upload --repository testpypi dist/*
+	rm -rf build dist .egg *.egg-info
+
 publish-pypi:
+	python -m pip install -r requirements-dev.txt
 	python -m pip install 'twine>=6.0.1'
 	python setup.py sdist bdist_wheel
 	twine upload dist/*
-	rm -rf build dist .egg wrapper_tls_requests.egg-info
-
-docs:
-	mkdocs serve
+	rm -rf build dist .egg *.egg-info

docs/advanced/hooks.md

@@ -100,7 +100,7 @@ client.hooks = {
 Best Practices
 --------------
 
-1.  **Access Content**: Use `.read()` or `await read()` in asynchronous contexts to access `response.content` before returning it.
+1.  **Access Content**: Use `.read()` or `await .aread()` in asynchronous contexts to access `response.content` before returning it.
 2.  **Always Use Lists:** Hooks must be registered as **lists of callables**, even if you are adding only one function.
 3.  **Combine Hooks:** You can register multiple hooks for the same event type to handle various concerns, such as logging and error handling.
 4.  **Order Matters:** Hooks are executed in the order they are registered.

pyproject.toml

@@ -1,3 +1,6 @@
 [build-system]
 requires = ['setuptools>=40.8.0']
 build-backend = 'setuptools.build_meta'
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"

requirements-dev.txt

@@ -0,0 +1,24 @@
+-r requirements.txt
+
+# Documentation
+mkdocs==1.6.1
+mkautodoc==0.2.0
+mkdocs-material==9.5.39
+
+# Packaging
+setuptools~=75.3.0
+twine~=6.0.1
+
+# Tests & Linting
+pre-commit==3.7.0
+black==24.3.0
+coverage[toml]==7.6.1
+pre-commit==3.7.0
+isort==5.13.2
+mypy==1.11.2
+pytest==8.3.3
+pytest-asyncio==0.24.0
+pytest-cov==6.0.0
+pytest_httpserver==1.1.0
+Werkzeug==3.1.3
+tox==4.23.2

requirements.txt

@@ -1,23 +1,5 @@
 # Base
 chardet~=5.2.0
-requests~=2.32.3
+requests>=2.28.0
 tqdm~=4.67.1
-
-# Documentation
-mkdocs==1.6.1
-mkautodoc==0.2.0
-mkdocs-material==9.5.39
-
-# Packaging
-setuptools~=75.3.0
-twine~=6.0.1
-
-# Tests & Linting
-pre-commit==3.7.0
-black==24.3.0
-flake8==7.0.0
-coverage[toml]==7.6.1
-pre-commit==3.7.0
-isort==5.13.2
-mypy==1.11.2
-pytest==8.3.3
+idna~=3.10

setup.cfg

@@ -21,6 +21,7 @@ classifiers =
     Programming Language :: Python :: 3.10
     Programming Language :: Python :: 3.11
     Programming Language :: Python :: 3.12
+    Programming Language :: Python :: 3.13
     Programming Language :: Python :: 3 :: Only
     Programming Language :: Python :: Implementation :: CPython
     Programming Language :: Python :: Implementation :: PyPy
@@ -29,7 +30,7 @@ classifiers =
 
 project_urls =
     Changelog = https://github.com/thewebscraping/tls-requests/blob/main/CHANGELOG.md
-    Documentation = https://github.com/thewebscraping/tls-requests
+    Documentation = https://thewebscraping.github.io/tls-requests/
     Source = https://github.com/thewebscraping/tls-requests
     Homepage = https://github.com/thewebscraping/tls-requests
 

tests/conftest.py

@@ -0,0 +1 @@
+pytest_plugins = ['pytest_httpserver', 'pytest_asyncio']

tests/files/__init__.py

@@ -0,0 +1,52 @@
+import tls_requests
+
+RESPONSE_BYTE = b"Hello World!"
+RESPONSE_TEXT = "Hello World!"
+
+
+def assert_response(response):
+    assert response.status_code, 200
+    assert response.reason, "OK"
+    assert response.text, RESPONSE_TEXT
+    assert response.content, RESPONSE_BYTE
+
+
+def make_request(request_fn, httpserver, is_assert_response: bool = True):
+    httpserver.expect_request("/api").respond_with_data(RESPONSE_BYTE)
+    response = request_fn(httpserver.url_for('/api'))
+    if is_assert_response:
+        assert_response(response)
+
+    return response
+
+
+def test_get(httpserver):
+    make_request(tls_requests.get, httpserver)
+
+
+def test_post(httpserver):
+    make_request(tls_requests.post, httpserver)
+
+
+def test_put(httpserver):
+    make_request(tls_requests.put, httpserver)
+
+
+def test_patch(httpserver):
+    make_request(tls_requests.patch, httpserver)
+
+
+def test_delete(httpserver):
+    make_request(tls_requests.delete, httpserver)
+
+
+def test_options(httpserver):
+    make_request(tls_requests.options, httpserver)
+
+
+def test_head(httpserver):
+    response = make_request(tls_requests.head, httpserver, False)
+    assert response.status_code == 200
+    assert response.reason == "OK"
+    assert response.text == ""
+    assert response.content == b""

tests/files/coingecko.png

@@ -0,0 +1,102 @@
+from base64 import b64encode
+
+import pytest
+
+import tls_requests
+
+auth = ("user", "pass")
+AUTH_TOKEN = "Basic %s" % b64encode(b":".join([s.encode() for s in auth])).decode()
+AUTH_HEADERS = {"authorization": AUTH_TOKEN}
+AUTH_FUNCTION_KEY = "x-authorization"
+AUTH_FUNCTION_VALUE = "123456"
+AUTH_FUNCTION_HEADERS = {AUTH_FUNCTION_KEY: AUTH_FUNCTION_VALUE}
+
+
+def auth_function(request):
+    request.headers.update(AUTH_FUNCTION_HEADERS)
+
+
+@pytest.fixture
+def auth_url(httpserver):
+    return httpserver.url_for('/auth')
+
+
+@pytest.fixture
+def http_auth_function(httpserver):
+    httpserver.expect_request("/auth", headers=AUTH_FUNCTION_HEADERS).respond_with_data()
+    return httpserver
+
+
+@pytest.fixture
+def http_auth(httpserver):
+    httpserver.expect_request("/auth", headers=AUTH_HEADERS).respond_with_data()
+    return httpserver
+
+
+def test_auth(http_auth, auth_url):
+    response = tls_requests.get(auth_url, auth=auth)
+    assert response.status_code == 200
+    assert response.request.headers["Authorization"] == AUTH_TOKEN
+
+
+def test_auth_function(http_auth_function, auth_url):
+    response = tls_requests.get(auth_url, auth=auth_function)
+    assert response.status_code == 200
+    assert response.request.headers[AUTH_FUNCTION_KEY] == AUTH_FUNCTION_VALUE
+
+
+def test_client_auth(http_auth, auth_url):
+    with tls_requests.Client(auth=auth) as client:
+        response = client.get(auth_url)
+
+    assert response.status_code == 200
+    assert bool(response.closed == client.closed) is True
+    assert response.request.headers["Authorization"] == AUTH_TOKEN
+
+
+def test_client_auth_cross_sharing(http_auth, auth_url):
+    with tls_requests.Client(auth=('1', '2')) as client:
+        response = client.get(auth_url, auth=auth)
+
+    assert response.status_code == 200
+    assert bool(response.closed == client.closed) is True
+    assert response.request.headers["Authorization"] == AUTH_TOKEN
+
+
+def test_client_auth_function_cross_sharing(http_auth_function, auth_url):
+    with tls_requests.Client(auth=auth) as client:
+        response = client.get(auth_url, auth=auth_function)
+
+    assert response.status_code == 200
+    assert bool(response.closed == client.closed) is True
+    assert response.request.headers[AUTH_FUNCTION_KEY] == AUTH_FUNCTION_VALUE
+
+
+@pytest.mark.asyncio
+async def test_async_auth(http_auth, auth_url):
+    async with tls_requests.AsyncClient(auth=auth) as client:
+        response = await client.get(auth_url)
+
+    assert response.status_code == 200
+    assert bool(response.closed == client.closed) is True
+    assert response.request.headers["Authorization"] == AUTH_TOKEN
+
+
+@pytest.mark.asyncio
+async def test_async_auth_function(http_auth_function, auth_url):
+    async with tls_requests.AsyncClient(auth=auth_function) as client:
+        response = await client.get(auth_url)
+
+    assert response.status_code == 200
+    assert bool(response.closed == client.closed) is True
+    assert response.request.headers[AUTH_FUNCTION_KEY] == AUTH_FUNCTION_VALUE
+
+
+@pytest.mark.asyncio
+async def test_async_auth_function_cross_sharing(http_auth_function, auth_url):
+    async with tls_requests.AsyncClient(auth=auth) as client:
+        response = await client.get(auth_url, auth=auth_function)
+
+    assert response.status_code == 200
+    assert bool(response.closed == client.closed) is True
+    assert response.request.headers[AUTH_FUNCTION_KEY] == AUTH_FUNCTION_VALUE