Replaced build_services with init_services.

Author: rohe

src/oidcservice/__init__.py

@@ -9,7 +9,7 @@
 
 
 __author__ = 'Roland Hedberg'
-__version__ = '0.6.3'
+__version__ = '0.6.4'
 
 
 OIDCONF_PATTERN = "{}/.well-known/openid-configuration"

src/oidcservice/oidc/__init__.py

@@ -1,22 +1,25 @@
 #
-import inspect
-import sys
-from glob import glob
-from os.path import basename
-from os.path import dirname
-from os.path import join
-
-from oidcservice.service import Service
-# from oidcservice.oauth2 import factory as oauth2_factory
-
 
 DEFAULT_SERVICES = {
-    'ProviderInfoDiscovery': {},
-    'Registration': {},
-    'Authorization': {},
-    'AccessToken': {},
-    'RefreshAccessToken': {},
-    'UserInfo': {}
+    "discovery": {
+        'class': 'oidcservice.oidc.provider_info_discovery'
+                 '.ProviderInfoDiscovery'
+    },
+    'registration': {
+        'class': 'oidcservice.oidc.registration.Registration'
+    },
+    'authorization': {
+        'class': 'oidcservice.oidc.authorization.Authorization'
+    },
+    'access_token': {
+        'class': 'oidcservice.oidc.access_token.AccessToken'
+    },
+    'refresh_access_token': {
+        'class': 'oidcservice.oidc.refresh_access_token.RefreshAccessToken'
+    },
+    'userinfo': {
+        'class': 'oidcservice.oidc.userinfo.UserInfo'
+    }
 }
 
 WF_URL = "https://{}/.well-known/webfinger"
@@ -35,25 +38,3 @@
     'registration': ['registration'],
     'end_sesssion': ['end_session']
 }
-
-
-# def factory(req_name, **kwargs):
-#     pwd = dirname(__file__)
-#     if pwd not in sys.path:
-#         sys.path.insert(0, pwd)
-#     for x in glob(join(pwd, '*.py')):
-#         _mod = basename(x)[:-3]
-#         if not _mod.startswith('__'):
-#             # _mod = basename(x)[:-3]
-#             if _mod not in sys.modules:
-#                 __import__(_mod, globals(), locals())
-#
-#             for name, obj in inspect.getmembers(sys.modules[_mod]):
-#                 if inspect.isclass(obj) and issubclass(obj, Service):
-#                     try:
-#                         if obj.__name__ == req_name:
-#                             return obj(**kwargs)
-#                     except AttributeError:
-#                         pass
-#
-#     return oauth2_factory(req_name, **kwargs)

src/oidcservice/service.py

@@ -2,20 +2,20 @@
 from urllib.parse import urlparse
 
 from cryptojwt.jwt import JWT
+from oidcmsg.message import Message
+from oidcmsg.oauth2 import ResponseMessage
+from oidcmsg.oauth2 import is_error_message
 
+from oidcservice import util
 from oidcservice.client_auth import factory as ca_factory
 from oidcservice.exception import ResponseError
 from oidcservice.state_interface import StateInterface
-from oidcservice.util import get_http_body
-from oidcservice.util import get_http_url
 from oidcservice.util import JOSE_ENCODED
 from oidcservice.util import JSON_ENCODED
 from oidcservice.util import URL_ENCODED
-
-from oidcmsg.oauth2 import is_error_message
-from oidcmsg.oauth2 import ResponseMessage
-from oidcmsg.message import Message
-
+from oidcservice.util import get_http_body
+from oidcservice.util import get_http_url
+from oidcservice.util import importer
 
 __author__ = 'Roland Hedberg'
 
@@ -46,9 +46,9 @@ def __init__(self, service_context, state_db, conf=None,
         StateInterface.__init__(self, state_db)
 
         if client_authn_factory is None:
-            self.client_authn_factory=ca_factory
+            self.client_authn_factory = ca_factory
         else:
-            self.client_authn_factory=client_authn_factory
+            self.client_authn_factory = client_authn_factory
 
         self.service_context = service_context
         self.default_request_args = {}
@@ -94,7 +94,8 @@ def gather_request_args(self, **kwargs):
                         ar_args[prop] = self.conf['request_args'][prop]
                     except KeyError:
                         try:
-                            ar_args[prop] = self.service_context.register_args[prop]
+                            ar_args[prop] = self.service_context.register_args[
+                                prop]
                         except KeyError:
                             try:
                                 ar_args[prop] = self.default_request_args[prop]
@@ -337,11 +338,11 @@ def get_request_parameters(self, request_body_type="", method="",
         _info['url'] = get_http_url(endpoint_url, request, method=method)
 
         # If there is to be a body part
-        if method  == 'POST':
+        if method == 'POST':
             # How should it be serialized
             if request_body_type == 'urlencoded':
                 content_type = URL_ENCODED
-            elif request_body_type in ['jws','jwe', 'jose']:
+            elif request_body_type in ['jws', 'jwe', 'jose']:
                 content_type = JOSE_ENCODED
             else:  # request_body_type == 'json'
                 content_type = JSON_ENCODED
@@ -424,7 +425,7 @@ def parse_response(self, info, sformat="", state="", **kwargs):
 
         logger.debug('response format: {}'.format(sformat))
 
-        if sformat in ['jose','jws','jwe']:
+        if sformat in ['jose', 'jws', 'jwe']:
             resp = self.post_parse_response(info, state=state)
 
             if not resp:
@@ -511,19 +512,50 @@ def get_conf_attr(self, attr, default=None):
             return default
 
 
-def build_services(service_definitions, service_factory, module_dirs,
-                   service_context, state_db, client_authn_factory=None):
+# def build_services(service_definitions, service_factory, module_dirs,
+#                    service_context, state_db, client_authn_factory=None):
+#     """
+#     This function will build a number of :py:class:`oidcservice.service.Service`
+#     instances based on the service definitions provided.
+#
+#     :param service_definitions: A dictionary of service definitions. The keys
+#         are the names of the subclasses. The values are configurations.
+#     :param service_factory: A factory that can initiate a service class
+#     :param module_dirs: The directories in which to search for service modules.
+#         Directory names are expected to be relative to the oidcservice package.
+#         e.g. ['oidc', 'oauth2]. The directories will be search in order until
+#         a matching module is found.
+#     :param service_context: A reference to the service context, this is the same
+#         for all service instances.
+#     :param state_db: A reference to the state database. Shared by all the
+#         services.
+#     :param client_authn_factory: A list of methods the services can use to
+#         authenticate the client to a service.
+#     :return: A dictionary, with service name as key and the service instance as
+#         value.
+#     """
+#     service = {}
+#     for service_name, service_configuration in service_definitions.items():
+#         _srv = service_factory(service_name,
+#                                module_dirs,
+#                                service_context=service_context,
+#                                state_db=state_db,
+#                                client_authn_factory=client_authn_factory,
+#                                conf=service_configuration)
+#         try:
+#             service[_srv.service_name] = _srv
+#         except AttributeError:
+#             raise ValueError("Could not load '{}'".format(service_name))
+#
+#     return service
+
+
+def init_services(service_definitions, service_context, state_db,
+                  client_authn_factory=None):
     """
-    This function will build a number of :py:class:`oidcservice.service.Service`
-    instances based on the service definitions provided.
-
-    :param service_definitions: A dictionary of service definitions. The keys
-        are the names of the subclasses. The values are configurations.
-    :param service_factory: A factory that can initiate a service class
-    :param module_dirs: The directories in which to search for service modules.
-        Directory names are expected to be relative to the oidcservice package.
-        e.g. ['oidc', 'oauth2]. The directories will be search in order until
-        a matching module is found.
+    Initiates a set of services
+
+    :param service_definitions: A dictionary cotaining service definitions
     :param service_context: A reference to the service context, this is the same
         for all service instances.
     :param state_db: A reference to the state database. Shared by all the
@@ -535,12 +567,20 @@ def build_services(service_definitions, service_factory, module_dirs,
     """
     service = {}
     for service_name, service_configuration in service_definitions.items():
-        _srv = service_factory(service_name,
-                               module_dirs,
-                               service_context=service_context,
-                               state_db=state_db,
-                               client_authn_factory=client_authn_factory,
-                               conf=service_configuration)
+        try:
+            kwargs = service_configuration['kwargs']
+        except KeyError:
+            kwargs = {}
+
+        kwargs.update({'service_context': service_context,
+                       'state_db': state_db,
+                       'client_authn_factory': client_authn_factory})
+
+        if isinstance(service_configuration['class'], str):
+            _srv = util.importer(service_configuration['class'])(**kwargs)
+        else:
+            _srv = service_configuration['class'](**kwargs)
+
         try:
             service[_srv.service_name] = _srv
         except AttributeError:

src/oidcservice/util.py

@@ -1,3 +1,4 @@
+import importlib
 import logging
 from urllib.parse import parse_qs
 from urllib.parse import urlsplit
@@ -62,5 +63,28 @@ def get_http_body(req, content_type=URL_ENCODED):
             "Unsupported content type: '%s'" % content_type)
 
 
-def load_yaml_config(file):
-    return yaml.load(file)
+def load_yaml_config(filename):
+    with open(filename, "rt", encoding='utf-8') as file:
+        config_dict = yaml.load(file)
+    return config_dict
+
+
+def modsplit(s):
+    """Split importable"""
+    if ':' in s:
+        c = s.split(':')
+        if len(c) != 2:
+            raise ValueError("Syntax error: {s}")
+        return c[0], c[1]
+    else:
+        c = s.split('.')
+        if len(c) < 2:
+            raise ValueError("Syntax error: {s}")
+        return '.'.join(c[:-1]), c[-1]
+
+
+def importer(name):
+    """Import by name"""
+    c1, c2 = modsplit(name)
+    module = importlib.import_module(c1)
+    return getattr(module, c2)

tests/test_09_client_auth.py

@@ -21,7 +21,7 @@
 from oidcservice.client_auth import valid_service_context
 from oidcservice.oidc import DEFAULT_SERVICES
 from oidcservice.service_factory import service_factory
-from oidcservice.service import build_services
+from oidcservice.service import init_services
 from oidcservice.service_context import ServiceContext
 from oidcservice.state_interface import InMemoryStateDataBase
 from oidcservice.state_interface import State
@@ -70,8 +70,7 @@ def services():
                                         state='ABCDE').to_json()
     db.set('ABCDE', State(iss='Issuer', auth_request=auth_request,
                           auth_response=auth_response).to_json())
-    return build_services(DEFAULT_SERVICES, service_factory, ['oidc'],
-                          get_service_context(), db)
+    return init_services(DEFAULT_SERVICES, get_service_context(), db)
 
 
 def test_quote():

tests/test_20_conversation.py

@@ -14,11 +14,11 @@
 from oidcmsg.oidc import OpenIDSchema
 from oidcmsg.oidc import ProviderConfigurationResponse
 from oidcmsg.oidc import RegistrationResponse
+from oidcservice.oidc.webfinger import WebFinger
 
+from oidcservice.service import init_services
 from oidcservice.service_context import ServiceContext
 from oidcservice.oidc import DEFAULT_SERVICES
-from oidcservice.service_factory import service_factory
-from oidcservice.service import build_services
 from oidcservice.state_interface import InMemoryStateDataBase
 
 # ================== SETUP ===========================
@@ -116,9 +116,9 @@ def test_conversation():
         )
 
     service_spec = DEFAULT_SERVICES.copy()
-    service_spec['WebFinger'] = {}
+    service_spec['WebFinger'] = {'class': WebFinger}
 
-    service = build_services(service_spec, service_factory, ['oidc'],
+    service = init_services(service_spec,
                              state_db=InMemoryStateDataBase(),
                              service_context=service_context)