c2client 0.22__tar.gz → 0.24__tar.gz

{c2client-0.22/c2client.egg-info → c2client-0.24}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: c2client
-Version: 0.22
+Version: 0.24
 Summary: CROC Cloud Platform - API Client
 Home-page: https://github.com/c2devel/c2-client
 Author: CROC Cloud Team
@@ -8,12 +8,20 @@ Author-email: devel@croc.ru
 Maintainer: Andrey Kulaev
 Maintainer-email: adkulaev@gmail.com
 License: GPL3
-Classifier: Development Status :: 4 - Beta
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 
 CROC Cloud API Client
 =====================
@@ -21,7 +29,7 @@ CROC Cloud API Client
 Simple command-line utility for sending custom requests to CROC Cloud platform.
 
 **Warning: this utility is not intended for automation cases.
-Use https://github.com/c2devel/boto.git and python scripts instead.**
+Use https://github.com/c2devel/boto3.git and python scripts instead.**
 
 Installation
 ------------
@@ -66,3 +74,5 @@ Send simple request:
 
    $ c2-ec2 RunInstances ImageId cmi-078880A0 Description "Test instance" \
    InstanceType m1.small MaxCount 1 MinCount 1 SecurityGroup.1 test
+
+

{c2client-0.22 → c2client-0.24}/README.rst

@@ -4,7 +4,7 @@ CROC Cloud API Client
 Simple command-line utility for sending custom requests to CROC Cloud platform.
 
 **Warning: this utility is not intended for automation cases.
-Use https://github.com/c2devel/boto.git and python scripts instead.**
+Use https://github.com/c2devel/boto3.git and python scripts instead.**
 
 Installation
 ------------

c2client-0.24/c2client/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.24"

{c2client-0.22 → c2client-0.24}/c2client/clients.py

@@ -1,29 +1,20 @@
 import argparse
 import json
-import os
 import re
 import ssl
 from abc import abstractmethod
 from functools import wraps
-from typing import Dict
-from urllib.parse import urlparse
+from typing import Any, Dict, Optional
 
-import boto
-import boto.cloudtrail.layer1
-import boto.ec2
-import boto.ec2.cloudwatch
 import boto3
 import inflection
-from boto.ec2.regioninfo import RegionInfo
 
-from c2client.utils import from_dot_notation, get_env_var, prettify_xml
+from c2client.errors import InvalidMethodName
+from c2client.utils import from_dot_notation, get_env_var, convert_args
 
 
 ssl._create_default_https_context = ssl._create_unverified_context
 
-if os.environ.get("DEBUG"):
-    boto.set_stream_logger("c2")
-
 
 def exitcode(func: callable):
     """Wrapper for logging any caught exception."""
@@ -32,9 +23,6 @@ def exitcode(func: callable):
     def wrapper(*args, **kwargs):
         try:
             func(*args, **kwargs)
-        except boto.exception.BotoServerError as error:
-            error_code = error.error_code or error.body.get("__type")
-            return f"{error_code}: {error.message}"
         except Exception as e:
             return e
     return wrapper
@@ -94,38 +82,6 @@ class BaseClient:
         print(response)
 
 
-class C2ClientLegacy(BaseClient):
-
-    connection_class: type
-
-    @classmethod
-    def get_client(cls, verify: bool):
-        """Return boto connection."""
-
-        if not boto.config.has_section("Boto"):
-            boto.config.add_section("Boto")
-        boto.config.set("Boto", "is_secure", "True")
-        boto.config.set("Boto", "num_retries", "0")
-        boto.config.set("Boto", "https_validate_certificates", str(verify))
-
-        parsed_endpoint = urlparse(get_env_var(cls.url_key))
-
-        return cls.connection_class(
-            port=parsed_endpoint.port,
-            path=parsed_endpoint.path,
-            region=RegionInfo(name=parsed_endpoint.hostname, endpoint=parsed_endpoint.hostname),
-            is_secure=False,
-        )
-
-    @classmethod
-    def make_request(cls, method: str, arguments: dict, verify: bool):
-
-        connection = cls.get_client(verify)
-        response = connection.make_request(method, arguments)
-
-        return prettify_xml(response.read())
-
-
 class C2Client(BaseClient):
 
     @classmethod
@@ -148,72 +104,82 @@ class C2Client(BaseClient):
         )
 
     @classmethod
-    def is_conversion_needed(cls, argument_name: str) -> bool:
-        """Check whether type conversion is needed for argument."""
-
-        return True
-
-    @classmethod
-    def make_request(cls, method: str, arguments: dict, verify: bool):
+    def make_request(cls, method: str, arguments: Optional[Dict], verify: bool) -> str:
 
         client = cls.get_client(verify)
 
-        for key, value in arguments.items():
-            if not cls.is_conversion_needed(key):
-                continue
-            if value.isdigit():
-                arguments[key] = int(value)
-            elif value.lower() == "true":
-                arguments[key] = True
-            elif value.lower() == "false":
-                arguments[key] = False
+        if not hasattr(client, inflection.underscore(method)):
+            raise InvalidMethodName(method)
+
+        if arguments:
+            arguments = cls.convert_fields_names(arguments)
+            shape = client.meta.service_model.operation_model(method).input_shape
+            arguments = convert_args(from_dot_notation(arguments), shape)
 
-        result = getattr(client, inflection.underscore(method))(**from_dot_notation(arguments))
+        result = getattr(client, inflection.underscore(method))(**arguments)
 
         result.pop("ResponseMetadata", None)
 
         # default=str is required for serializing Datetime objects
         return json.dumps(result, indent=4, default=str)
 
+    @staticmethod
+    def convert_fields_names(arguments: dict) -> Dict[str, Any]:
+        """Convert field names as in the documentation."""
+
+        return arguments
+
 
-class EC2Client(C2ClientLegacy):
+class EC2Client(C2Client):
 
     url_key = "EC2_URL"
     client_name = "ec2"
 
-    connection_class = boto.ec2.EC2Connection
+    @staticmethod
+    def convert_fields_names(arguments: dict) -> Dict[str, Any]:
+        """Convert field names as in the documentation."""
 
+        tag_pattern = r"Filter\.\d+\.Value"
 
-class CWClient(C2ClientLegacy):
+        new_arguments = {}
+        filters = {}
+        for key, value in arguments.items():
+            new_key = key
+            if re.fullmatch(tag_pattern, key):
+                key = ".".join(key.split(".")[:3])
 
-    url_key = "AWS_CLOUDWATCH_URL"
-    client_name = "cw"
+                if key in filters:
+                    filters[key] += 1
+                else:
+                    filters[key] = 1
 
-    connection_class = boto.ec2.cloudwatch.CloudWatchConnection
+                new_key = f"{key}.{filters[key]}"
 
+            new_arguments[new_key] = value
 
-class CTClient(C2ClientLegacy):
+        return new_arguments
 
-    url_key = "AWS_CLOUDTRAIL_URL"
-    client_name = "ct"
 
-    connection_class = boto.cloudtrail.layer1.CloudTrailConnection
+class CWClient(C2Client):
 
-    @classmethod
-    def make_request(cls, method: str, arguments: dict, verify: bool):
+    url_key = "AWS_CLOUDWATCH_URL"
+    client_name = "cloudwatch"
+
+    @staticmethod
+    def convert_fields_names(arguments: dict) -> Dict[str, Any]:
+        """Convert field names as in the documentation."""
 
-        connection = cls.get_client(verify)
+        new_arguments = {}
+        for key, value in arguments.items():
+            new_key = key.replace(".member.", ".")
+            new_arguments[new_key] = value
+        return new_arguments
 
-        if "MaxResults" in arguments:
-            arguments["MaxResults"] = int(arguments["MaxResults"])
-        if "StartTime" in arguments:
-            arguments["StartTime"] = int(arguments["StartTime"])
-        if "EndTime" in arguments:
-            arguments["EndTime"] = int(arguments["EndTime"])
 
-        response = connection.make_request(method, json.dumps(from_dot_notation(arguments)))
+class CTClient(C2Client):
 
-        return json.dumps(response, indent=4, sort_keys=True)
+    url_key = "AWS_CLOUDTRAIL_URL"
+    client_name = "cloudtrail"
 
 
 class ASClient(C2Client):
@@ -221,18 +187,6 @@ class ASClient(C2Client):
     url_key = "AUTO_SCALING_URL"
     client_name = "autoscaling"
 
-    @classmethod
-    def is_conversion_needed(cls, argument_name: str) -> bool:
-        """Check whether type conversion is needed for argument."""
-
-        patterns = (
-            r"Filters\.\d+\.Values\.\d+",
-        )
-        for pattern in patterns:
-            if re.fullmatch(pattern, argument_name):
-                return False
-        return True
-
 
 class BSClient(C2Client):
 

{c2client-0.22 → c2client-0.24}/c2client/errors.py

@@ -10,3 +10,13 @@ class EnvironmentVariableError(Exception):
 class MalformedParametersError(Exception):
     def __init__(self):
         super(MalformedParametersError, self).__init__("Malformed parameters.")
+
+
+class InvalidParameterName(Exception):
+    def __init__(self, parameter_name: str) -> None:
+        super().__init__(f"Parameter with name '{parameter_name}' was not found.")
+
+
+class InvalidMethodName(Exception):
+    def __init__(self, method_name: str) -> None:
+        super().__init__(f"Not found method by name: {method_name}.")

c2client-0.24/c2client/utils.py

@@ -0,0 +1,134 @@
+import dataclasses
+import os
+from typing import Any, Dict
+
+from botocore.model import ListShape, StructureShape, Shape
+
+from c2client.errors import EnvironmentVariableError, MalformedParametersError, InvalidParameterName
+
+
+@dataclasses.dataclass
+class Parameter:
+    """API parameter info."""
+
+    name: str
+    shape: Shape
+
+
+def from_dot_notation(source):
+    """Convert a incoming query to a request dictionary.
+    For example::
+        1. {"Action": ["Action"], "Param": ["Value"]}
+        2. {"Action": ["Action"], "Param.2": ["Value2"], "Param.1": ["Value1"]}
+        3. {"Action": ["Action"], "Param.SubParam": ["Value"]}
+    would  result in the params dict::
+        1. {"Action": "Action", "Param": "Value"}
+        2. {"Action": "Action", "Param": ["Value1", "Value2"]}
+        3. {"Action": "Action", "Param": { "SubParam": "Value"}}
+    :type query: dict
+    :param query: This is dictionary, returned by '_get_query()'.
+    """
+
+    result = {"result": {}}
+    for key, value in sorted(source.items()):
+        try:
+            _process_tokens(key.split("."), value, result, "result")
+        except Exception:
+            raise MalformedParametersError
+    return result["result"]
+
+
+def _process_tokens(tokens, value, parent, index):
+    key, rest = tokens[0], tokens[1:]
+    if key.isdigit():
+        key = int(key) - 1
+
+    if not isinstance(key, int):
+        parent[index].setdefault(key, {})
+    elif isinstance(parent[index], dict) and not parent[index]:
+        parent[index] = [{}]
+    elif isinstance(parent[index], list) and len(parent[index]) == key:
+        parent[index].append({})
+    elif not (isinstance(parent[index], list) and len(parent[index]) > key):
+        raise MalformedParametersError
+
+    if rest:
+        _process_tokens(rest, value, parent[index], key)
+    else:
+        parent[index][key] = value
+
+
+def get_env_var(name: str) -> Any:
+    """Return env_var by it's name or raises EnvironmentError."""
+
+    env_var = os.environ.get(name)
+    if env_var is None:
+        raise EnvironmentVariableError(name)
+    return env_var
+
+
+def collect_param_shapes(shape: Shape) -> Dict[str, Parameter]:
+    """Collect a dict of API schema parameters by their name or serialization name."""
+
+    param_shapes = {}
+    for member_name in shape.members:
+        param_shapes[member_name.lower()] = Parameter(
+            name=member_name, shape=shape.members[member_name])
+        if shape.members[member_name].serialization.get("name"):
+            param_shapes[shape.members[member_name].serialization.get("name").lower()] = Parameter(
+                name=member_name, shape=shape.members[member_name])
+
+    return param_shapes
+
+
+def convert_args(params: Any, shape: Shape):
+    """Convert values in the params dictionary to the types expected by shape."""
+
+    if not isinstance(shape, StructureShape):
+        return convert_arg(value=params, shape=shape)
+
+    converted_params = {}
+    param_shapes = collect_param_shapes(shape)
+
+    for param_name, param_value in params.items():
+        parameter = param_shapes.get(param_name.lower())
+
+        if not parameter:
+            raise InvalidParameterName(param_name)
+
+        if parameter.shape:
+            converted_params[parameter.name] = convert_arg(param_value, parameter.shape)
+        else:
+            converted_params[parameter.name] = param_value
+
+    return converted_params
+
+
+def convert_arg(value: Any, shape: Shape):
+    """Convert an individual value to the type expected by shape."""
+
+    if isinstance(shape, ListShape):
+        if not isinstance(value, list):
+            raise ValueError(f"Expected list for {shape.name}, got {type(value).__name__}")
+        return [convert_arg(v, shape.member) for v in value]
+
+    elif isinstance(shape, StructureShape):
+        if not isinstance(value, dict):
+            raise ValueError(f"Expected dict for {shape.name}, got {type(value).__name__}")
+        return convert_args(value, shape)
+
+    elif shape.type_name == "string":
+        return str(value)
+
+    elif shape.type_name == "integer" or shape.type_name == "long":
+        return int(value)
+
+    elif shape.type_name == "float" or shape.type_name == "double":
+        return float(value)
+
+    elif shape.type_name == "boolean":
+        if isinstance(value, str) and value.lower() == "false":
+            return False
+        return bool(value)
+    else:
+        return value

{c2client-0.22 → c2client-0.24/c2client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: c2client
-Version: 0.22
+Version: 0.24
 Summary: CROC Cloud Platform - API Client
 Home-page: https://github.com/c2devel/c2-client
 Author: CROC Cloud Team
@@ -8,12 +8,20 @@ Author-email: devel@croc.ru
 Maintainer: Andrey Kulaev
 Maintainer-email: adkulaev@gmail.com
 License: GPL3
-Classifier: Development Status :: 4 - Beta
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 
 CROC Cloud API Client
 =====================
@@ -21,7 +29,7 @@ CROC Cloud API Client
 Simple command-line utility for sending custom requests to CROC Cloud platform.
 
 **Warning: this utility is not intended for automation cases.
-Use https://github.com/c2devel/boto.git and python scripts instead.**
+Use https://github.com/c2devel/boto3.git and python scripts instead.**
 
 Installation
 ------------
@@ -66,3 +74,5 @@ Send simple request:
 
    $ c2-ec2 RunInstances ImageId cmi-078880A0 Description "Test instance" \
    InstanceType m1.small MaxCount 1 MinCount 1 SecurityGroup.1 test
+
+

{c2client-0.22 → c2client-0.24}/c2client.egg-info/entry_points.txt

@@ -13,3 +13,4 @@ c2-iam = c2client.clients:IAMClient.execute
 c2-paas = c2client.clients:PaasClient.execute
 c2-route53 = c2client.clients:Route53Client.execute
 c2rc-convert = c2client.c2rc_convert:main
+

{c2client-0.22 → c2client-0.24}/c2client.egg-info/requires.txt

@@ -1,5 +1,3 @@
-boto
 boto3
 botocore
 inflection==0.3.1
-lxml

{c2client-0.22 → c2client-0.24}/setup.py

@@ -14,11 +14,9 @@ def get_description():
 
 
 install_requires = [
-    "boto",
     "boto3",
     "botocore",
     "inflection==0.3.1",
-    "lxml",
 ]
 
 entrypoints = [
@@ -49,12 +47,19 @@ setup(
     maintainer="Andrey Kulaev",
     maintainer_email="adkulaev@gmail.com",
     classifiers=[
-        "Development Status :: 4 - Beta",
+        "Development Status :: 5 - Production/Stable",
         "Environment :: Console",
         "Intended Audience :: Developers",
         "Intended Audience :: System Administrators",
         "Operating System :: OS Independent",
         "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
     ],
     install_requires=install_requires,
     packages=find_packages(),

c2client-0.22/c2client/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.22"

c2client-0.22/c2client/utils.py

@@ -1,64 +0,0 @@
-import os
-
-from lxml import etree
-
-from c2client.errors import EnvironmentVariableError, MalformedParametersError
-
-
-def prettify_xml(string):
-    """Returns prettified XML string."""
-
-    parser = etree.XMLParser(remove_blank_text=True)
-    tree = etree.fromstring(string, parser)
-    return etree.tostring(tree, pretty_print=True, encoding="unicode")
-
-
-def from_dot_notation(source):
-    """Converts a incoming query to a request dictionary.
-    For example::
-        1. {"Action": ["Action"], "Param": ["Value"]}
-        2. {"Action": ["Action"], "Param.2": ["Value2"], "Param.1": ["Value1"]}
-        3. {"Action": ["Action"], "Param.SubParam": ["Value"]}
-    would  result in the params dict::
-        1. {"Action": "Action", "Param": "Value"}
-        2. {"Action": "Action", "Param": ["Value1", "Value2"]}
-        3. {"Action": "Action", "Param": { "SubParam": "Value"}}
-    :type query: dict
-    :param query: This is dictionary, returned by '_get_query()'.
-    """
-    result = {"result": {}}
-    for key, value in sorted(source.items()):
-        try:
-            _process_tokens(key.split("."), value, result, "result")
-        except Exception:
-            raise MalformedParametersError
-    return result["result"]
-
-
-def _process_tokens(tokens, value, parent, index):
-    key, rest = tokens[0], tokens[1:]
-    if key.isdigit():
-        key = int(key) - 1
-
-    if not isinstance(key, int):
-        parent[index].setdefault(key, {})
-    elif isinstance(parent[index], dict) and not parent[index]:
-        parent[index] = [{}]
-    elif isinstance(parent[index], list) and len(parent[index]) == key:
-        parent[index].append({})
-    elif not (isinstance(parent[index], list) and len(parent[index]) > key):
-        raise MalformedParametersError
-
-    if rest:
-        _process_tokens(rest, value, parent[index], key)
-    else:
-        parent[index][key] = value
-
-
-def get_env_var(name):
-    """Returns env_var by it's name or raises EnvironmentError."""
-
-    env_var = os.environ.get(name)
-    if env_var is None:
-        raise EnvironmentVariableError(name)
-    return env_var