masstack-python-client 0.0.1__tar.gz → 0.0.3__tar.gz

{masstack_python_client-0.0.1/src/masstack_python_client.egg-info → masstack_python_client-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: masstack-python-client
-Version: 0.0.1
+Version: 0.0.3
 Summary: This Python API client provides access to masmovil core API domains
 Author-email: Borja Gimeno <borja.gimeno@somconnexio.coop>
 License: GPL-3.0-only
@@ -38,6 +38,13 @@ This Python API client provides access to masmovil core API domains.
             - get: returns a unit by id with a list of coverages
             - get_coverage: returns coverage info for a unit id and territory_owner
 
+* Customers
+    - Signups - access to signups new clients
+        - post new client
+    - Users
+        - returns customer tree data associated to a given document identification, email or number of the client. 
+        - returns user data by userId
+
 ## Installation
 
 ```commandline

{masstack_python_client-0.0.1 → masstack_python_client-0.0.3}/README.md

@@ -21,6 +21,13 @@ This Python API client provides access to masmovil core API domains.
             - get: returns a unit by id with a list of coverages
             - get_coverage: returns coverage info for a unit id and territory_owner
 
+* Customers
+    - Signups - access to signups new clients
+        - post new client
+    - Users
+        - returns customer tree data associated to a given document identification, email or number of the client. 
+        - returns user data by userId
+
 ## Installation
 
 ```commandline

{masstack_python_client-0.0.1 → masstack_python_client-0.0.3}/pyproject.toml

@@ -74,7 +74,6 @@ requires = ["tox>=4.20"]
 env_list = [
     "style",
     "py3119",
-    "coverage",
     "pep8"
 ]
 
@@ -90,9 +89,9 @@ commands = [
     ["pre-commit", "run", "--all-files", "--show-diff-on-failure"],
 ]
 
-[tool.tox.env.coverage]
+[tool.tox.env.py3119]
 commands = [
-    ["pytest", "--cov", "--cov-report", "term:skip-covered", "--cov-report", "html"],
+    ["pytest", "--cov=masstack_python_client", "--cov-report=term:skip-covered", "--cov-report=html", "--cov-report=term-missing"],
 ]
 
 [tool.tox.env.pep8]
@@ -100,3 +99,8 @@ deps = ["flake8"]
 commands = [
     ["flake8"],
 ]
+
+[tool.tox.env.coverage]
+commands = [
+    ["pytest", "--cov=masstack_python_client", "--cov-report=term-missing", "--cov-fail-under=95"],
+]

{masstack_python_client-0.0.1 → masstack_python_client-0.0.3}/src/masstack_python_client/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.0.1"
+__version__ = "0.0.3"
 __homepage__ = "https://somconnexio.coop/"
 __author__ = "Borja Gimeno <borja.gimeno@somconnexio.coop>"
 __license__ = "GPL-3.0-only"

{masstack_python_client-0.0.1 → masstack_python_client-0.0.3}/src/masstack_python_client/auth/token_manager.py

@@ -56,17 +56,18 @@ class TokenManager:
         try:
             key = RSAKey.import_key(self._private_key)
             assertion = jwt.encode(jwt_header, claims, key)
+            data = {
+                "assertion": assertion,
+                "grant_type": "urn:ietf:params:oauth:grant-type:jwt-bearer",
+            }
             response = requests.post(
                 self._token_uri,
-                data={
-                    "assertion": assertion,
-                    "grant_type": "urn:ietf:params:oauth:grant-type:jwt-bearer",
-                },
+                data=data,
                 headers={"Content-Type": "application/x-www-form-urlencoded"},
             )
             response.raise_for_status()
         except HTTPError:
-            raise ErrorFetchingToKen(response.status_code, response.text)
+            raise ErrorFetchingToKen(response.status_code, response.text, data)
         except Exception as e:
             raise ErrorFetchingToKen(500, str(e))
         data = response.json()

{masstack_python_client-0.0.1 → masstack_python_client-0.0.3}/src/masstack_python_client/exceptions.py

@@ -8,19 +8,19 @@ class MasstackClientException(Exception):
     _message: Optional[str] = None
 
     def __init__(self, status_code: int, message: str):
-        super(Exception, self).__init__(message)
+        super(MasstackClientException, self).__init__(message)
         self._message = message
         self._status_code = status_code
 
     @property
     def status_code(self) -> int:
         """The status_code property."""
-        return self._status_code or 0
+        return 0 if self._status_code is None else self._status_code
 
     @property
     def message(self) -> str:
         """The error message property."""
-        return self._message or ""
+        return "" if self._message is None else self._message
 
     def _params_to_string(self, params):
         if not params or len(params) == 0:
@@ -32,9 +32,11 @@ class MasstackClientException(Exception):
 
 
 class ErrorFetchingToKen(MasstackClientException):
-    def __init__(self, status_code: int, error_msg: str):
-        message = "Error fetching token with the next error message: {}".format(
-            error_msg
+    def __init__(self, status_code: int, error_msg: str, body: Optional[dict] = None):
+        message = (
+            "Error fetching token with the next error message: {}\nBody:\n{}".format(
+                error_msg, self._params_to_string(body)
+            )
         )
         super(ErrorFetchingToKen, self).__init__(status_code, message)
 

masstack_python_client-0.0.3/src/masstack_python_client/resources/customers.py

@@ -0,0 +1,106 @@
+from typing import Optional
+from dataclasses import asdict
+
+from masstack_python_client.client import MasstackClient
+from masstack_python_client.resources.enums.document_type_search import (
+    DocumentTypeSearch,
+)
+from masstack_python_client.resources.models.signup import (
+    SignupRequestData,
+    SignupsResponseData,
+)
+from masstack_python_client.resources.models.user import UserData
+from masstack_python_client.resources.utils.serialize import remove_none
+
+
+class CustomersResource:
+    """Provide the necessary functionality to be able to give
+    E2E coverage to the entire life-cycle of a client
+    https://developers.masstack.com/en/docs/apis_customers_doc_swagger/2/apioverview
+    """
+
+    _api_domain = "customers"
+
+    @classmethod
+    def _request(
+        cls,
+        method: str,
+        endpoint: str,
+        params: Optional[dict] = None,
+        data: Optional[dict] = None,
+    ) -> dict:
+        client = MasstackClient()
+        func = getattr(client, method)
+
+        return func(
+            api=cls._api_domain,
+            version=cls._version,
+            endpoint=endpoint,
+            params=params,
+            data=data,
+        )
+
+
+class SignupsResource(CustomersResource):
+    _api_path = "signups"
+    _version = "v2"
+
+    @classmethod
+    def add_customer(cls, customer_data: SignupRequestData) -> SignupsResponseData:
+        """Add new customers including products purchased.
+
+        Args:
+            customer_data (SignupRequestData): The data of the customer to be added.
+
+        Returns:
+            SignupsResponseData
+        """
+        payload = remove_none(asdict(customer_data))
+        result = cls._request(
+            method="post",
+            endpoint=cls._api_path,
+            data=payload,
+        )
+
+        return SignupsResponseData(
+            sell_id=result["sell_id"],
+            customer_id=result["customer_id"],
+            work_order_id=[result["work_order_id"]],
+        )
+
+
+class Users(CustomersResource):
+    _api_path = "users"
+    _version = "v2"
+
+    @classmethod
+    def get_user_id_by_doc(cls, doc: str, doc_type: DocumentTypeSearch) -> str:
+        """
+        Get user ID associated to a given document identification
+
+        Args:
+            doc (str): The user's document number.
+            doc_type (DocumentTypeSearch): The type of document.
+
+        Returns:
+            user id.
+        """
+        data = {"document_type": doc_type.value, "document": doc}
+
+        return cls._request(method="post", endpoint=f"{cls._api_path}/tree", data=data)[
+            "id"
+        ]
+
+    @classmethod
+    def get_user_by_id(cls, user_id: str) -> dict:
+        """
+        Get user information by user ID
+
+        Args:
+            user_id (str): The user's ID.
+
+        Returns:
+            UserData
+        """
+        user = cls._request(method="get", endpoint=f"{cls._api_path}/{user_id}")
+        return UserData.from_dict(**user)

masstack_python_client-0.0.3/src/masstack_python_client/resources/enums/document_type_search.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class DocumentTypeSearch(Enum):
+    NIF = "NIF"
+    DNI = "DNI"
+    TR = "TR"
+    PASS = "PASS"
+    CIF = "CIF"

masstack_python_client-0.0.3/src/masstack_python_client/resources/models/client_address.py

@@ -0,0 +1,11 @@
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class ClientAddress:
+    street_name: str
+    state_id: int
+    locality: str
+    postal_code: str
+    number: int
+    country: str = "España"

masstack_python_client-0.0.3/src/masstack_python_client/resources/models/client_attribute.py

@@ -0,0 +1,27 @@
+from dataclasses import dataclass
+from typing import Dict, Any
+
+from masstack_python_client.resources.models.client_address import ClientAddress
+
+
+@dataclass(frozen=True)
+class ClientAttribute:
+    type: str
+    document_type_id: int
+    document_value: str
+    email: str
+    birthdate: str
+    nationality_id: int
+    contact_phone: str
+    gender: str
+    language_id: int
+    address: ClientAddress
+    name: str = None
+    company_name: str = None
+    middlename: str = "."
+    lastname: str = "."
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "ClientAttribute":
+        data_address = data.pop("address")
+        return cls(address=ClientAddress(**data_address), **data)

masstack_python_client-0.0.3/src/masstack_python_client/resources/models/client_payment.py

@@ -0,0 +1,14 @@
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class BankAccount:
+    bank_account: str
+
+
+@dataclass(frozen=True)
+class ScoringAccount:
+    id_value: float = 1.01
+    scoring_value: int = 71
+    up_front: float = 1.01
+    forced_value: float = 0.01

masstack_python_client-0.0.3/src/masstack_python_client/resources/models/products.py

@@ -0,0 +1,90 @@
+from dataclasses import dataclass, field
+from typing import List, Dict, Any
+
+
+@dataclass(frozen=True)
+class Contact:
+    name: str
+    phone: str
+    email: str
+    document_type_id: str
+    document_value: str
+    middlename: str = "."
+    lastname: str = "."
+
+
+@dataclass(frozen=True)
+class Address:
+    street_type_id: int
+    street_name: str
+    number: int
+    supplement: str
+    state_id: int
+    locality: str
+    postal_code: str
+    gescal: str
+    address_id: str
+    pair_vacancy: bool = True
+
+
+@dataclass(frozen=True)
+class Info:
+    contact: Contact
+    address: Address
+
+    @classmethod
+    def from_dict(
+        cls,
+        data: Dict[str, Any],
+    ) -> "Info":
+        return cls(
+            contact=Contact(**data["contact"]),
+            address=Address(**data["address"]),
+        )
+
+
+@dataclass(frozen=True)
+class Landline:
+    product_id: int
+    number: str
+    services: List = field(default_factory=list)
+    wants_communications: bool = False
+    # TODO portability_info
+
+
+@dataclass(frozen=True)
+class Ftth:
+    product_id: int
+    connection_type: str = ""
+    installer: str = "MM"
+    wants_communications: bool = False
+    # TODO access_reuse
+    # TODO access_reuse_choice
+    # TODO iua
+
+
+@dataclass(frozen=True)
+class Bundle:
+    bundle_id: int
+    territory_owner: str
+    installation_info: Info
+    delivery_info: Info
+    landline: Landline
+    ftth: Ftth
+
+    @classmethod
+    def from_dict(
+        cls,
+        bundle_id: int,
+        territory_owner: str,
+        **data,
+    ) -> "Bundle":
+        info = Info.from_dict(data["client_info"])
+        return cls(
+            bundle_id,
+            territory_owner,
+            installation_info=info,
+            delivery_info=info,
+            landline=Landline(**data["land_line"]),
+            ftth=Ftth(**data["ftth"]),
+        )

masstack_python_client-0.0.3/src/masstack_python_client/resources/models/signup.py

@@ -0,0 +1,78 @@
+from dataclasses import dataclass
+from typing import List, Dict, Any
+
+from masstack_python_client.resources.models.client_attribute import ClientAttribute
+from masstack_python_client.resources.models.client_payment import (
+    BankAccount,
+    ScoringAccount,
+)
+from masstack_python_client.resources.models.products import Bundle
+
+
+@dataclass(frozen=True)
+class SalesInfo:
+    dealer_id: str
+    shop_id: str
+    channel: str = "dealer"
+    logistic: bool = False
+
+
+@dataclass(frozen=True)
+class Clients:
+    attributes: List[ClientAttribute]
+    sector_id: int = 1
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "Clients":
+        client_types = ["client", "account"]
+        return cls(
+            attributes=[
+                ClientAttribute.from_dict({"type": client_type, **data})
+                for client_type in client_types
+            ]
+        )
+
+
+@dataclass(frozen=True)
+class ClientPayment:
+    info: BankAccount
+    scoring: ScoringAccount = ScoringAccount()
+    billing_type_id: int = 1
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "ClientPayment":
+        return cls(info=BankAccount(bank_account=data["bank_account"]))
+
+
+@dataclass(frozen=True)
+class Products:
+    bundle: Bundle
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "Products":
+        return cls(bundle=Bundle.from_dict(**data))
+
+
+@dataclass(frozen=True)
+class SignupRequestData:
+    sales_info: SalesInfo
+    clients: Clients
+    payment: ClientPayment
+    products: Products
+    sales_type: str = "telecomunications"
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "SignupRequestData":
+        return cls(
+            sales_info=SalesInfo(**data["sales"]),
+            clients=Clients.from_dict(data["client"]),
+            payment=ClientPayment.from_dict(data["payment"]),
+            products=Products.from_dict(data["products"]),
+        )
+
+
+@dataclass(frozen=True)
+class SignupsResponseData:
+    sell_id: int
+    customer_id: int
+    work_order_id: str

masstack_python_client-0.0.3/src/masstack_python_client/resources/models/user.py

@@ -0,0 +1,42 @@
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class UserData:
+    id: int
+    document_value: str
+    document_type_id: int
+    gender: str
+    first_name: str
+    middle_name: str
+    last_name: str
+    nationality: str
+    email: str
+    birthdate: str
+    phone: str
+
+    @classmethod
+    def from_dict(
+        cls,
+        id,
+        document_value: str,
+        document_type: dict,
+        nationality: dict,
+        personal: dict,
+        **kwargs,
+    ):
+        return cls(
+            **{
+                "id": id,
+                "document_value": document_value,
+                "document_type_id": document_type["id"],
+                "gender": personal["gender"],
+                "first_name": personal["first_name"],
+                "middle_name": personal["middle_name"],
+                "last_name": personal["last_name"],
+                "nationality": nationality["value"],
+                "email": personal["email"],
+                "birthdate": personal["birthdate"],
+                "phone": personal["other_phone"],
+            }
+        )

masstack_python_client-0.0.3/src/masstack_python_client/resources/utils/serialize.py

@@ -0,0 +1,7 @@
+def remove_none(obj):
+    if isinstance(obj, dict):
+        return {k: remove_none(v) for k, v in obj.items() if v is not None}
+    elif isinstance(obj, list):
+        return [remove_none(v) for v in obj if v is not None]
+    else:
+        return obj

{masstack_python_client-0.0.1 → masstack_python_client-0.0.3/src/masstack_python_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: masstack-python-client
-Version: 0.0.1
+Version: 0.0.3
 Summary: This Python API client provides access to masmovil core API domains
 Author-email: Borja Gimeno <borja.gimeno@somconnexio.coop>
 License: GPL-3.0-only
@@ -38,6 +38,13 @@ This Python API client provides access to masmovil core API domains.
             - get: returns a unit by id with a list of coverages
             - get_coverage: returns coverage info for a unit id and territory_owner
 
+* Customers
+    - Signups - access to signups new clients
+        - post new client
+    - Users
+        - returns customer tree data associated to a given document identification, email or number of the client. 
+        - returns user data by userId
+
 ## Installation
 
 ```commandline

{masstack_python_client-0.0.1 → masstack_python_client-0.0.3}/src/masstack_python_client.egg-info/SOURCES.txt

@@ -19,6 +19,16 @@ src/masstack_python_client/data/province_translation.csv
 src/masstack_python_client/data/street_type_translation.csv
 src/masstack_python_client/data/unit_translation.csv
 src/masstack_python_client/resources/__init__.py
+src/masstack_python_client/resources/customers.py
 src/masstack_python_client/resources/feasibility.py
+src/masstack_python_client/resources/enums/document_type_search.py
 src/masstack_python_client/resources/models/address.py
-tests/test_client.py
+src/masstack_python_client/resources/models/client_address.py
+src/masstack_python_client/resources/models/client_attribute.py
+src/masstack_python_client/resources/models/client_payment.py
+src/masstack_python_client/resources/models/products.py
+src/masstack_python_client/resources/models/signup.py
+src/masstack_python_client/resources/models/user.py
+src/masstack_python_client/resources/utils/serialize.py
+tests/test_client.py
+tests/test_exceptions.py

{masstack_python_client-0.0.1 → masstack_python_client-0.0.3}/tests/test_client.py

@@ -25,7 +25,6 @@ class ClientTestCase(unittest.TestCase):
         self.version = "v1"
         self.endpoint = "testapi"
         self.params = {"param1": "value1", "param2": "value2"}
-        self.header = {"Custom-Header": "HeaderValue"}
 
     """
         test get
@@ -36,9 +35,7 @@ class ClientTestCase(unittest.TestCase):
             status_code=200, json=lambda: {"data": "test_data"}
         )
         self.assertEqual(
-            MasstackClient().get(
-                self.api, self.version, self.endpoint, self.params, self.header
-            ),
+            MasstackClient().get(self.api, self.version, self.endpoint, self.params),
             {"data": "test_data"},
         )
         mock_token_manager.assert_called_once()
@@ -48,7 +45,6 @@ class ClientTestCase(unittest.TestCase):
             headers={
                 "Authorization": "Bearer test_token",
                 "Accept": "application/json",
-                **self.header,
             },
             json=None,
             params=self.params,
@@ -65,7 +61,6 @@ class ClientTestCase(unittest.TestCase):
             self.version,
             self.endpoint,
             self.params,
-            self.header,
         )
 
     """
@@ -73,16 +68,13 @@ class ClientTestCase(unittest.TestCase):
     """
 
     def test_post_ok(self, mock_request, mock_token_manager):
+        extra_header = {"Custom-Header": "HeaderValue"}
         mock_request.return_value = Mock(
             status_code=200, json=lambda: {"data": "test_data"}
         )
         self.assertEqual(
             MasstackClient().post(
-                self.api,
-                self.version,
-                self.endpoint,
-                self.params,
-                self.header,
+                self.api, self.version, self.endpoint, self.params, extra_header
             ),
             {"data": "test_data"},
         )
@@ -93,7 +85,7 @@ class ClientTestCase(unittest.TestCase):
             headers={
                 "Authorization": "Bearer test_token",
                 "Accept": "application/json",
-                **self.header,
+                **extra_header,
             },
             json=self.params,
             params=None,
@@ -110,5 +102,4 @@ class ClientTestCase(unittest.TestCase):
             self.version,
             self.endpoint,
             self.params,
-            self.header,
         )

masstack_python_client-0.0.3/tests/test_exceptions.py

@@ -0,0 +1,14 @@
+import unittest
+
+from masstack_python_client.exceptions import MasstackClientException
+
+
+class MasstackClientExceptionTestCase(unittest.TestCase):
+    def test_exception_fallback_properties(self):
+        exc = MasstackClientException(0, "")
+
+        exc._status_code = None
+        exc._message = None
+
+        self.assertEqual(exc.status_code, 0)
+        self.assertEqual(exc.message, "")