global-open-sdk-python 1.5.8__tar.gz → 1.6.0__tar.gz

{global_open_sdk_python-1.5.8 → global_open_sdk_python-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: global-open-sdk-python
-Version: 1.5.8
+Version: 1.6.0
 Summary: The global alipay gateway SDK for Python.
 Home-page: https://github.com/alipay/global-open-sdk-python
 Author: guodong.wzj

{global_open_sdk_python-1.5.8 → global_open_sdk_python-1.6.0}/README.md

@@ -1,10 +1,32 @@
 ```
 Language：Python  
 Python version：2.7+  
-Release ^1.5.8
+Release ^1.6.0
 Copyright：Ant financial services group  
 ```
 
+
+Planned release: **1.6.0**. This version is not published yet; package/tag references
+below describe the target release. Build this branch to try it before publication.
+
+## API Key client (planned for 1.6.0)
+
+Use `ApiKeyAlipayClient` with a regional HTTPS gateway and API Key. Existing request
+models are shared with the RSA client; ClientId and RSA keys are not required.
+
+```python
+import os
+from com.alipay.ams.api.api_key_alipay_client import ApiKeyAlipayClient
+
+client = ApiKeyAlipayClient(
+    os.environ["ANTOM_GATEWAY_URL"], os.environ["ANTOM_API_KEY"])
+```
+
+Start with the [sandbox createPaymentSession example](example/api_key_payment_session.py) and its
+[configuration and run instructions](docs/api-key-client.md). Existing RSA usage below remains supported.
+
+
+
 #### Meter event upload
 
 Install the optional HTTP/2 dependencies. This API requires Python 3.9 or later;

{global_open_sdk_python-1.5.8 → global_open_sdk_python-1.6.0}/com/alipay/ams/api/_version.py

@@ -1,2 +1,2 @@
-VERSION = "1.5.8"
+VERSION = "1.6.0"
 USER_AGENT = "global-open-sdk-python/" + VERSION

global_open_sdk_python-1.6.0/com/alipay/ams/api/api_key_alipay_client.py

@@ -0,0 +1,54 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+from com.alipay.ams.api._version import USER_AGENT
+from com.alipay.ams.api.api_key_auth import ApiKeyAuth, add_extra_headers
+from com.alipay.ams.api.exception.exception import AlipayApiException
+from com.alipay.ams.api.net.api_key_http_rpc import do_post
+from com.alipay.ams.api.request_transport_resolver import requires_session_http2
+
+
+class ApiKeyAlipayClient(object):
+    """Independent API Key client; execute returns the response body, like RSA."""
+
+    def __init__(self, gateway_url, api_key, timeout=30):
+        self.__auth = ApiKeyAuth(gateway_url, api_key)
+        if not isinstance(timeout, (int, float)) or timeout <= 0:
+            raise ValueError("timeout must be positive")
+        self.__timeout = timeout
+
+    def execute(self, request):
+        return self.execute_with_headers(request)
+
+    def execute_with_headers(self, request, extra_headers=None):
+        if not hasattr(request, "path") or not request.path:
+            raise AlipayApiException("invalid path")
+        method = request.http_method.value
+        if requires_session_http2(method, request.path):
+            from com.alipay.ams.api.session_http2_executor import execute_session_http2
+
+            return execute_session_http2(
+                self.__auth.gateway_url, request, extra_headers
+            )
+        error = None
+        try:
+            if method.upper() != "POST":
+                raise AlipayApiException(
+                    "Only POST is supported for ordinary API requests"
+                )
+            path = self.__auth.path(request.path)
+            headers = {
+                "Authorization": self.__auth.authorization(),
+                "Content-Type": "application/json; charset=UTF-8",
+                "User-Agent": USER_AGENT,
+            }
+            add_extra_headers(headers, extra_headers)
+            return do_post(
+                self.__auth.gateway_url + path,
+                headers,
+                request.to_ams_json(),
+                self.__timeout,
+            )
+        except Exception as exc:
+            error = self.__auth.redact(exc)
+        # Raise outside the handler to avoid retaining a sensitive exception context.
+        raise AlipayApiException(error)

global_open_sdk_python-1.6.0/com/alipay/ams/api/api_key_auth.py

@@ -0,0 +1,94 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""Internal API Key authentication without decoding the identity fragment."""
+
+import re
+
+try:
+    from urllib.parse import urlsplit
+except ImportError:
+    from urlparse import urlsplit
+
+_RESERVED_HEADERS = frozenset(
+    (
+        "authorization",
+        "signature",
+        "client-id",
+        "request-time",
+        "key-version",
+        "keyversion",
+        "agent-token",
+        "content-type",
+        "user-agent",
+        "x-sdkversion",
+        "sdk-version",
+        "host",
+        "content-length",
+        "transfer-encoding",
+        "connection",
+        "proxy-authorization",
+    )
+)
+
+
+class ApiKeyAuth(object):
+    def __init__(self, gateway_url, api_key):
+        if not isinstance(api_key, str) or not re.match(
+            r"\A(?:isak|irak)_(?:TEST|PROD)_[^_\s\x00-\x1f\x7f]+_[^\s\x00-\x1f\x7f]+\Z",
+            api_key,
+        ):
+            raise ValueError("api_key must be a Standard or Restricted TEST/PROD key")
+        try:
+            uri = urlsplit(gateway_url)
+            valid = (
+                uri.scheme == "https"
+                and uri.hostname
+                and uri.username is None
+                and uri.password is None
+                and uri.path in ("", "/")
+                and not uri.query
+                and not uri.fragment
+                and not re.search(r"\s", gateway_url)
+            )
+            uri.port  # Validate the configured port before any request.
+        except (TypeError, ValueError):
+            valid = False
+        if not valid:
+            raise ValueError("gateway_url must be an HTTPS base URL")
+        self.gateway_url = gateway_url.rstrip("/")
+        self.__api_key = api_key
+        self.__sandbox = api_key.split("_", 2)[1] == "TEST"
+
+    def authorization(self):
+        return "Bearer " + self.__api_key
+
+    def path(self, path):
+        if (
+            not isinstance(path, str)
+            or not re.match(r"\A/ams/(?:sandbox/)?api/[A-Za-z0-9_/-]+\Z", path)
+            or "//" in path
+        ):
+            raise ValueError("request path must be an ordinary /ams/api/ path")
+        normal = path.replace("/ams/sandbox/api/", "/ams/api/", 1)
+        return (
+            normal.replace("/ams/api/", "/ams/sandbox/api/", 1)
+            if self.__sandbox
+            else normal
+        )
+
+    def redact(self, message):
+        return str(message).replace(self.__api_key, "[REDACTED]")
+
+
+def add_extra_headers(headers, extra_headers):
+    for name, value in (extra_headers or {}).items():
+        if (
+            not isinstance(name, str)
+            or not re.match(r"\A[!#$%&'*+.^_`|~0-9A-Za-z-]+\Z", name)
+            or not isinstance(value, str)
+            or "\r" in value
+            or "\n" in value
+        ):
+            raise ValueError("Invalid custom header")
+        if name.lower() not in _RESERVED_HEADERS:
+            headers[name] = value

global_open_sdk_python-1.6.0/com/alipay/ams/api/net/api_key_http_rpc.py

@@ -0,0 +1,36 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""HTTPS transport with certificate validation, no redirects and no retries."""
+
+import ssl
+
+try:
+    import http.client as http_client
+    from urllib.parse import urlsplit
+except ImportError:
+    import httplib as http_client
+    from urlparse import urlsplit
+from com.alipay.ams.api.exception.exception import AlipayApiException
+
+
+def do_post(url, headers, req_body, timeout):
+    uri = urlsplit(url)
+    connection = http_client.HTTPSConnection(
+        uri.hostname,
+        port=uri.port or 443,
+        timeout=timeout,
+        context=ssl.create_default_context(),
+    )
+    try:
+        connection.request(
+            "POST", uri.path, body=req_body.encode("utf-8"), headers=headers
+        )
+        response = connection.getresponse()
+        try:
+            if response.status != 200:
+                raise AlipayApiException("invalid http status " + str(response.status))
+            return response.read().decode("utf-8")
+        finally:
+            response.close()
+    finally:
+        connection.close()

{global_open_sdk_python-1.5.8 → global_open_sdk_python-1.6.0}/global_open_sdk_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: global-open-sdk-python
-Version: 1.5.8
+Version: 1.6.0
 Summary: The global alipay gateway SDK for Python.
 Home-page: https://github.com/alipay/global-open-sdk-python
 Author: guodong.wzj

{global_open_sdk_python-1.5.8 → global_open_sdk_python-1.6.0}/global_open_sdk_python.egg-info/SOURCES.txt

@@ -7,6 +7,8 @@ com/alipay/__init__.py
 com/alipay/ams/__init__.py
 com/alipay/ams/api/__init__.py
 com/alipay/ams/api/_version.py
+com/alipay/ams/api/api_key_alipay_client.py
+com/alipay/ams/api/api_key_auth.py
 com/alipay/ams/api/default_alipay_client.py
 com/alipay/ams/api/file_upload_executor.py
 com/alipay/ams/api/request_transport_resolver.py
@@ -331,6 +333,7 @@ com/alipay/ams/api/model/wallet.py
 com/alipay/ams/api/model/wallet_payment_method_type.py
 com/alipay/ams/api/model/web_site.py
 com/alipay/ams/api/net/__init__.py
+com/alipay/ams/api/net/api_key_http_rpc.py
 com/alipay/ams/api/net/default_http_rpc.py
 com/alipay/ams/api/net/http2_json_transport.py
 com/alipay/ams/api/net/multipart_http_rpc.py