Merge pull request #21 from arrowhead-f/Development

Development

Author: ajoino

.gitignore

@@ -0,0 +1,20 @@
+*.vim
+start_insecure_coresystems.sh
+stop_coresystems.sh
+*.crt
+*.key
+*.p12
+docs/build/
+__pycache__/
+.mypy_cache/
+logs/
+build/
+dist/
+tags
+arrowhead_client.egg-info/
+.tox/
+.idea/
+venv*
+*/__pycache__/*
+.coverage
+htmlcov/*

_version.py

@@ -1,4 +1,4 @@
 __lib_name__ = 'arrowhead-client'
-__version__ = '0.2.0a2'
+__version__ = '0.3.0a'
 __author__ = 'Jacob Nilsson'
 __email__ = 'jacob.nilsson@ltu.se'

arrowhead_client/abc.py

@@ -1,40 +1,61 @@
-from abc import abstractmethod
-from typing import Any, Callable
-try:
-    from typing import Protocol
-except ImportError:
-    from typing_extensions import Protocol  # type: ignore
+from abc import abstractmethod, ABC
 
+from arrowhead_client.response import Response
+from arrowhead_client.rules import OrchestrationRule, RegistrationRule
 
-class BaseConsumer(Protocol):
+
+class ProtocolMixin(ABC):
+    def __init_subclass__(cls, protocol='', **kwargs):
+        if protocol == '':
+            raise ValueError('No protocol specified.')
+        elif not isinstance(protocol, str):
+            raise TypeError('Protocol must be of type str.')
+        cls._protocol = protocol.upper()
+
+
+class BaseConsumer(ProtocolMixin, ABC, protocol='<PROTOCOL>'):
+    """Abstract base class for consumers"""
     @abstractmethod
     def consume_service(
             self,
-            service_uri: str,
-            method: str,
-            **kwargs) -> Any:  # type: ignore
-        raise NotImplementedError
+            rule: OrchestrationRule,
+            **kwargs) -> Response:
+        """
+        Consume service according to the consumation rule and return the response.
+
+        Args:
+           rule: Orchestration rule.
+        Returns:
+            A Response object.
+        """
 
+
+class BaseProvider(ProtocolMixin, ABC, protocol='<PROTOCOL>'):
+    """Abstract base class for providers"""
     @abstractmethod
-    def extract_payload(
-            self,
-            service_response: Any,
-            payload_type: str):
-        raise NotImplementedError
+    def add_provided_service(self, rule: RegistrationRule, ) -> None:
+        """
+        Adds the provided service to the provider according the provision rule.
 
+        Args:
+            rule: Provision rule.
+        """
 
-class BaseProvider(Protocol):
     @abstractmethod
-    def add_provided_service(
+    def run_forever(
             self,
-            service_definition: str,
-            service_uri: str,
-            method: str,
-            func: Callable,
-            *func_args,
-            **func_kwargs, ) -> None:
-        pass
+            address: str,
+            port: int,
+            keyfile: str,
+            certfile: str,
+    ) -> None:
+        """
+        Starts the provider and runs until interrupted.
 
-    @abstractmethod
-    def run_forever(self) -> None:
-        pass
+        Args:
+            address: system ip address.
+            port: system port.
+            keyfile: client keyfile.
+            certfile: client certfile.
+            cafile: certificate authority file
+        """

arrowhead_client/api.py

@@ -2,24 +2,22 @@
 Arrowhead Client API module
 ===========================
 
-This module contains the api of the :code:`arrowhead_client` module.
+This module contains the public api of the :code:`arrowhead_client` module.
 """
-from arrowhead_client.configuration import config
-from arrowhead_client.client import ArrowheadClient
+from typing import Dict
+from arrowhead_client.client import ArrowheadClient, provided_service
 from arrowhead_client.system import ArrowheadSystem
-from arrowhead_client.httpconsumer import HttpConsumer
-from arrowhead_client.httpprovider import HttpProvider
+from arrowhead_client.implementations.httpconsumer import HttpConsumer
+from arrowhead_client.implementations.httpprovider import HttpProvider
 from arrowhead_client.service import Service  # noqa: F401
 from arrowhead_client.logs import get_logger
 
-from gevent import pywsgi  # type: ignore
-
 
 class ArrowheadHttpClient(ArrowheadClient):
     """
     Arrowhead client using HTTP.
 
-    Args:
+    Attributes:
         system_name: A string to assign the system name
         address: A string to assign the system address
         port: An int to assign the system port
@@ -32,25 +30,24 @@ def __init__(self,
                  system_name: str,
                  address: str,
                  port: int,
-                 authentication_info: str = '',
+                 config: Dict = None,
                  keyfile: str = '',
-                 certfile: str = ''):
+                 certfile: str = '',
+                 cafile: str = ''):
         logger = get_logger(system_name, 'debug')
-        wsgi_server = pywsgi.WSGIServer(
-                (address, port),
-                None,
-                keyfile=keyfile,
-                certfile=certfile,
-                log=logger,
+        system = ArrowheadSystem.with_certfile(
+                system_name,
+                address,
+                port,
+                certfile,
         )
         super().__init__(
-                ArrowheadSystem(system_name, address, port, authentication_info),
-                HttpConsumer(),
-                HttpProvider(wsgi_server),
+                system,
+                HttpConsumer(keyfile, certfile, cafile),
+                HttpProvider(cafile),
                 logger,
-                config,
+                config=config,
                 keyfile=keyfile,
                 certfile=certfile
         )
         self._logger.info(f'{self.__class__.__name__} initialized at {self.system.address}:{self.system.port}')
-        # TODO: This line is a hack and needs to be fixed

arrowhead_client/client/__init__.py

@@ -1,3 +1,3 @@
-from .client_core import ArrowheadClient
+from .client_core import ArrowheadClient, provided_service
 
-__all__ = ['ArrowheadClient']
+__all__ = ['ArrowheadClient', 'provided_service']