v2kit 0.3__tar.gz → 0.4__tar.gz

{v2kit-0.3 → v2kit-0.4}/CHANGELOG.md

@@ -5,6 +5,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [0.4] - 2026-07-02
+### Added
+- `HttpConfig` class
+### Changed
+- `parse` function modified
+- `README.md` updated
+- Test system modified
 ## [0.3] - 2026-06-16
 ### Added
 - Logo
@@ -43,7 +50,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `encode_subscription` function
 - `decode_subscription` function
 
-[Unreleased]: https://github.com/sepandhaghighi/v2kit/compare/v0.3...dev
+[Unreleased]: https://github.com/sepandhaghighi/v2kit/compare/v0.4...dev
+[0.4]: https://github.com/sepandhaghighi/v2kit/compare/v0.3...v0.4
 [0.3]: https://github.com/sepandhaghighi/v2kit/compare/v0.2...v0.3
 [0.2]: https://github.com/sepandhaghighi/v2kit/compare/v0.1...v0.2
 [0.1]: https://github.com/sepandhaghighi/v2kit/compare/bb5a2cb...v0.1

{v2kit-0.3 → v2kit-0.4}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: v2kit
-Version: 0.3
+Version: 0.4
 Summary: V2Kit: A Lightweight Toolkit for V2Ray Config Manipulation
 Home-page: https://github.com/sepandhaghighi/v2kit
-Download-URL: https://github.com/sepandhaghighi/v2kit/tarball/v0.3
+Download-URL: https://github.com/sepandhaghighi/v2kit/tarball/v0.4
 Author: Sepand Haghighi
 Author-email: me@sepand.tech
 License: MIT
@@ -96,13 +96,13 @@ V2Kit is a lightweight and extensible Python toolkit for working with V2Ray prox
 ## Installation		
 
 ### Source Code
-- Download [Version 0.3](https://github.com/sepandhaghighi/v2kit/archive/v0.3.zip) or [Latest Source](https://github.com/sepandhaghighi/v2kit/archive/dev.zip)
+- Download [Version 0.4](https://github.com/sepandhaghighi/v2kit/archive/v0.4.zip) or [Latest Source](https://github.com/sepandhaghighi/v2kit/archive/dev.zip)
 - `pip install .`				
 
 ### PyPI
 
 - Check [Python Packaging User Guide](https://packaging.python.org/installing/)     
-- `pip install v2kit==0.3`						
+- `pip install v2kit==0.4`						
 
 ## Supported Protocols
 
@@ -115,6 +115,7 @@ V2Kit currently supports the following protocols:
 | Trojan      | ✅         | ✅       | ✅          | ✅           |
 | Shadowsocks | ✅         | ✅       | ✅          | ✅           |
 | SOCKS       | ✅         | ✅       | ✅          | ✅           |
+| HTTP        | ✅         | ✅       | ✅          | ✅           |
 
 
 ## Usage
@@ -210,6 +211,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [0.4] - 2026-07-02
+### Added
+- `HttpConfig` class
+### Changed
+- `parse` function modified
+- `README.md` updated
+- Test system modified
 ## [0.3] - 2026-06-16
 ### Added
 - Logo
@@ -248,7 +256,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `encode_subscription` function
 - `decode_subscription` function
 
-[Unreleased]: https://github.com/sepandhaghighi/v2kit/compare/v0.3...dev
+[Unreleased]: https://github.com/sepandhaghighi/v2kit/compare/v0.4...dev
+[0.4]: https://github.com/sepandhaghighi/v2kit/compare/v0.3...v0.4
 [0.3]: https://github.com/sepandhaghighi/v2kit/compare/v0.2...v0.3
 [0.2]: https://github.com/sepandhaghighi/v2kit/compare/v0.1...v0.2
 [0.1]: https://github.com/sepandhaghighi/v2kit/compare/bb5a2cb...v0.1

{v2kit-0.3 → v2kit-0.4}/README.md

@@ -51,13 +51,13 @@ V2Kit is a lightweight and extensible Python toolkit for working with V2Ray prox
 ## Installation		
 
 ### Source Code
-- Download [Version 0.3](https://github.com/sepandhaghighi/v2kit/archive/v0.3.zip) or [Latest Source](https://github.com/sepandhaghighi/v2kit/archive/dev.zip)
+- Download [Version 0.4](https://github.com/sepandhaghighi/v2kit/archive/v0.4.zip) or [Latest Source](https://github.com/sepandhaghighi/v2kit/archive/dev.zip)
 - `pip install .`				
 
 ### PyPI
 
 - Check [Python Packaging User Guide](https://packaging.python.org/installing/)     
-- `pip install v2kit==0.3`						
+- `pip install v2kit==0.4`						
 
 ## Supported Protocols
 
@@ -70,6 +70,7 @@ V2Kit currently supports the following protocols:
 | Trojan      | ✅         | ✅       | ✅          | ✅           |
 | Shadowsocks | ✅         | ✅       | ✅          | ✅           |
 | SOCKS       | ✅         | ✅       | ✅          | ✅           |
+| HTTP        | ✅         | ✅       | ✅          | ✅           |
 
 
 ## Usage

{v2kit-0.3 → v2kit-0.4}/SECURITY.md

@@ -4,8 +4,8 @@
 
 | Version       | Supported          |
 | ------------- | ------------------ |
-| 0.3           | :white_check_mark: |
-| < 0.3         | :x:                |
+| 0.4           | :white_check_mark: |
+| < 0.4         | :x:                |
 
 ## Reporting a Vulnerability
 

{v2kit-0.3 → v2kit-0.4}/setup.py

@@ -2,6 +2,7 @@
 """Setup module."""
 from setuptools import setup
 
+
 def read_description() -> str:
     """Read README.md and CHANGELOG.md."""
     try:
@@ -22,7 +23,7 @@ def read_description() -> str:
 setup(
     name='v2kit',
     packages=['v2kit', 'v2kit.models'],
-    version='0.3',
+    version='0.4',
     description='V2Kit: A Lightweight Toolkit for V2Ray Config Manipulation',
     long_description=read_description(),
     long_description_content_type='text/markdown',
@@ -30,7 +31,7 @@ setup(
     author='Sepand Haghighi',
     author_email='me@sepand.tech',
     url='https://github.com/sepandhaghighi/v2kit',
-    download_url='https://github.com/sepandhaghighi/v2kit/tarball/v0.3',
+    download_url='https://github.com/sepandhaghighi/v2kit/tarball/v0.4',
     keywords='v2ray v2ray-config v2ray-tools vmess vless trojan shadowsocks proxy subscription network',
     project_urls={
         'Source': 'https://github.com/sepandhaghighi/v2kit'},

{v2kit-0.3 → v2kit-0.4}/tests/test_errors.py

@@ -7,10 +7,12 @@ from v2kit import V2kitError, V2kitValidationError, V2kitParseError
 from v2kit.validators import _validate_uri
 
 
-INVALID_PROTOCOL = "http://example.com"
+INVALID_PROTOCOL = "ftp://example.com"
 
 INVALID_VMESS = "vmess://invalid-base64"
 
+INVALID_SHADOWSOCKS = "ss://invalid-base64@example.com:8388#ss-test"
+
 VALID_VLESS = (
     "vless://1c4b4bca-e3ff-4ca8-a062-6f399ad3cf45@example.com:443"
     "?security=tls#test"
@@ -61,7 +63,7 @@ def test_relabel_non_string_label():
         relabel(VALID_VLESS, 123)
 
 
-def test_encode_subscription_invalid_config():
+def test_encode_subscription_invalid_config1():
     configs = [
         VALID_VLESS,
         "invalid-config",
@@ -71,6 +73,16 @@ def test_encode_subscription_invalid_config():
         encode_subscription(configs)
 
 
+def test_encode_subscription_invalid_config2():
+    configs = [
+        VALID_VLESS,
+        1,
+    ]
+
+    with pytest.raises(V2kitValidationError):
+        encode_subscription(configs)
+
+
 def test_decode_subscription_non_string():
     with pytest.raises(V2kitValidationError):
         decode_subscription(123)
@@ -109,7 +121,17 @@ def test_parse_invalid_uri():
 
 def test_parse_unsupported_protocol():
     with pytest.raises(V2kitParseError):
-        parse("http://example.com")
+        parse(INVALID_PROTOCOL)
+
+
+def test_parse_invalid_vmess():
+    with pytest.raises(V2kitParseError):
+        parse(INVALID_VMESS)
+
+
+def test_parse_invalid_shadowsocks():
+    with pytest.raises(V2kitParseError):
+        parse(INVALID_SHADOWSOCKS)
 
 
 def test_vless_invalid_uuid():

{v2kit-0.3 → v2kit-0.4}/tests/test_functions.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 import json
-from v2kit import is_vmess, is_vless, is_trojan, is_shadowsocks, is_socks, parse
+from v2kit import is_vmess, is_vless, is_trojan, is_shadowsocks, is_socks, is_http, parse
 from v2kit import relabel, encode_subscription, decode_subscription
 from v2kit import VMESSConfig, VLESSConfig, TrojanConfig, ShadowsocksConfig, SocksConfig
 from v2kit.utils import _encode_base64
@@ -37,6 +37,8 @@ SHADOWSOCKS_CONFIG = "ss://YWVzLTI1Ni1nY206cGFzc3dvcmQ=@example.com:8388#ss-test
 
 SOCKS_CONFIG = "socks://user:password@example.com:1080#socks-test"
 
+HTTP_CONFIG = "http://user@example.com:1080#test"
+
 
 def test_is_vmess():
     assert is_vmess(VMESS_CONFIG) is True
@@ -54,6 +56,10 @@ def test_is_shadowsocks():
     assert is_shadowsocks(SHADOWSOCKS_CONFIG) is True
 
 
+def test_is_http():
+    assert is_http(HTTP_CONFIG) is True
+
+
 def test_is_vmess_negative():
     assert is_vmess(VLESS_CONFIG) is False
 
@@ -74,6 +80,10 @@ def test_is_shadowsocks_invalid():
     assert is_shadowsocks("invalid") is False
 
 
+def test_is_http_invalid():
+    assert is_http("invalid") is False
+
+
 def test_is_socks():
     assert is_socks(SOCKS_CONFIG) is True
 

v2kit-0.4/tests/test_http.py

@@ -0,0 +1,194 @@
+# -*- coding: utf-8 -*-
+import pytest
+from v2kit import parse
+from v2kit import HttpConfig
+
+
+def test_defaults():
+    config = HttpConfig(
+        address="example.com",
+        port=1080,
+    )
+
+    assert config.label is None
+    assert config.extra == {}
+    assert config.username is None
+    assert config.password is None
+
+
+def test_to_dict():
+    config = HttpConfig(
+        address="example.com",
+        port=1080,
+        username="user",
+        password="password",
+        label="test",
+        extra={"foo": "bar"},
+    )
+
+    assert config.to_dict() == {
+        "protocol": "http",
+        "address": "example.com",
+        "port": 1080,
+        "username": "user",
+        "password": "password",
+        "extra": {"foo": "bar"},
+        "label": "test",
+    }
+
+
+def test_extra():
+    config = HttpConfig(
+        address="example.com",
+        port=1080,
+        extra={"foo": "bar"},
+    )
+
+    data = config.to_dict()
+
+    assert data["extra"]["foo"] == "bar"
+
+
+def test_update_methods():
+    config = HttpConfig(
+        address="example.com",
+        port=1080,
+    )
+
+    config.update_address("example.org")
+    config.update_port(8080)
+    config.update_username("user")
+    config.update_password("password")
+
+    assert config.address == "example.org"
+    assert config.port == 8080
+    assert config.username == "user"
+    assert config.password == "password"
+
+
+def test_update_extra():
+    config = HttpConfig(
+        address="example.com",
+        port=1080,
+    )
+
+    config.update_extra(
+        {"foo": "bar"}
+    )
+
+    assert config.extra["foo"] == "bar"
+
+
+def test_method_chaining():
+    config = HttpConfig(
+        address="example.com",
+        port=1080,
+    )
+
+    config.update_address(
+        "example.org"
+    ).update_port(
+        8080
+    ).update_username(
+        "user"
+    ).update_password(
+        "password"
+    )
+
+    assert config.address == "example.org"
+    assert config.port == 8080
+    assert config.username == "user"
+    assert config.password == "password"
+
+
+@pytest.mark.parametrize(
+    "kwargs",
+    [
+        {"address": ""},
+        {"port": 0},
+        {"port": 1.2},
+        {"username": ""},
+        {"password": ""},
+        {"extra": 1},
+    ],
+)
+def test_invalid_values(kwargs):
+    params = {
+        "address": "example.com",
+        "port": 1080,
+    }
+    params.update(kwargs)
+
+    with pytest.raises(ValueError):
+        HttpConfig(**params)
+
+
+def test_to_uri_roundtrip():
+    config = HttpConfig(
+        address="example.com",
+        port=1080,
+        username="user",
+        password="password",
+        label="test",
+    )
+
+    parsed = parse(config.to_uri())
+
+    assert parsed == config
+
+
+def test_equality():
+    config1 = HttpConfig(
+        address="example.com",
+        port=1080,
+        username="user",
+        password="password",
+    )
+
+    config2 = HttpConfig(
+        address="example.com",
+        port=1080,
+        username="user",
+        password="password",
+    )
+
+    config3 = HttpConfig(
+        address="example.org",
+        port=1080,
+        username="user",
+        password="password",
+    )
+
+    assert config1 == config2
+    assert config1 != config3
+    assert config1 != "config1"
+
+
+def test_to_uri_without_auth():
+    config = HttpConfig(
+        address="example.com",
+        port=1080,
+        label="test",
+    )
+
+    assert config.to_uri() == "http://example.com:1080#test"
+
+
+def test_to_uri_username_only():
+    config = HttpConfig(
+        address="example.com",
+        port=1080,
+        username="user",
+        label="test",
+    )
+
+    assert config.to_uri() == "http://user@example.com:1080#test"
+
+
+def test_repr():
+    config = HttpConfig(
+        address="example.com",
+        port=1080,
+    )
+
+    assert repr(config) == "HttpConfig(protocol=<Protocol.HTTP: 'http'>, label=None)"

v2kit-0.4/tests/test_shadowsocks.py

@@ -0,0 +1,196 @@
+# -*- coding: utf-8 -*-
+import pytest
+from v2kit import parse
+from v2kit import ShadowsocksConfig
+
+
+def test_defaults():
+    config = ShadowsocksConfig(
+        encryption="aes-256-gcm",
+        password="password",
+        address="example.com",
+        port=8388,
+    )
+
+    assert config.label is None
+    assert config.extra == {}
+
+
+def test_to_dict():
+    config = ShadowsocksConfig(
+        encryption="aes-256-gcm",
+        password="password",
+        address="example.com",
+        port=8388,
+        label="test",
+        extra={"plugin": "v2ray-plugin"},
+    )
+
+    assert config.to_dict() == {
+        "protocol": "shadowsocks",
+        "encryption": "aes-256-gcm",
+        "password": "password",
+        "address": "example.com",
+        "port": 8388,
+        "label": "test",
+        "extra": {"plugin": "v2ray-plugin"},
+    }
+
+
+def test_extra():
+    config = ShadowsocksConfig(
+        encryption="aes-256-gcm",
+        password="password",
+        address="example.com",
+        port=8388,
+        extra={"plugin": "v2ray-plugin"},
+    )
+
+    data = config.to_dict()
+
+    assert data["extra"]["plugin"] == "v2ray-plugin"
+
+
+def test_method_chaining():
+    config = ShadowsocksConfig(
+        encryption="aes-256-gcm",
+        password="password",
+        address="example.com",
+        port=8388,
+    )
+
+    config.update_encryption(
+        "chacha20-ietf-poly1305"
+    ).update_password(
+        "secret"
+    ).update_address(
+        "example.org"
+    ).update_port(
+        443
+    )
+
+    assert config.encryption == "chacha20-ietf-poly1305"
+    assert config.password == "secret"
+    assert config.address == "example.org"
+    assert config.port == 443
+
+
+@pytest.mark.parametrize(
+    "kwargs",
+    [
+        {"encryption": ""},
+        {"password": ""},
+        {"address": ""},
+        {"port": 0},
+        {"port": 1.2},
+        {"extra": 1},
+    ],
+)
+def test_invalid_values(kwargs):
+    params = {
+        "encryption": "aes-256-gcm",
+        "password": "password",
+        "address": "example.com",
+        "port": 8388,
+    }
+    params.update(kwargs)
+
+    with pytest.raises(ValueError):
+        ShadowsocksConfig(**params)
+
+
+def test_to_uri_roundtrip():
+    config = ShadowsocksConfig(
+        encryption="aes-256-gcm",
+        password="password",
+        address="example.com",
+        port=8388,
+        label="test",
+    )
+
+    parsed = parse(config.to_uri())
+
+    assert parsed == config
+
+
+def test_equality():
+    config1 = ShadowsocksConfig(
+        encryption="aes-256-gcm",
+        password="password",
+        address="example.com",
+        port=8388,
+    )
+
+    config2 = ShadowsocksConfig(
+        encryption="aes-256-gcm",
+        password="password",
+        address="example.com",
+        port=8388,
+    )
+
+    config3 = ShadowsocksConfig(
+        encryption="aes-256-gcm",
+        password="password",
+        address="example.org",
+        port=8388,
+    )
+
+    assert config1 == config2
+    assert config1 != config3
+    assert config1 != "config1"
+
+
+def test_repr():
+    config = ShadowsocksConfig(
+        encryption="aes-256-gcm",
+        password="password",
+        address="example.com",
+        port=8388,
+    )
+
+    assert repr(config) == (
+        "ShadowsocksConfig(protocol=<Protocol.SHADOWSOCKS: "
+        "'ss'>, label=None)"
+    )
+
+
+def test_update_extra():
+    config = ShadowsocksConfig(
+        encryption="aes-256-gcm",
+        password="password",
+        address="example.com",
+        port=8388,
+    )
+
+    config.update_extra(
+        {"plugin": "v2ray-plugin"}
+    )
+
+    assert config.extra["plugin"] == "v2ray-plugin"
+
+
+def test_update_methods():
+    config = ShadowsocksConfig(
+        encryption="aes-256-gcm",
+        password="password",
+        address="example.com",
+        port=8388,
+    )
+
+    config.update_encryption(
+        "chacha20-ietf-poly1305"
+    )
+    config.update_password(
+        "secret"
+    )
+    config.update_address(
+        "example.org"
+    )
+    config.update_port(
+        443
+    )
+
+    assert config.encryption == "chacha20-ietf-poly1305"
+    assert config.password == "secret"
+    assert config.address == "example.org"
+    assert config.port == 443