Changeset 11999 for main/waeup.ikoba/branches/uli-payments/src/waeup/ikoba/zcml.py

Timestamp:

20 Nov 2014, 03:06:02 (10 years ago)

Author:

uli

Message:

Require the paypal config file to exists when declared.

File:

• main/waeup.ikoba/branches/uli-payments/src/waeup/ikoba/zcml.py (modified) (2 diffs)

main/waeup.ikoba/branches/uli-payments/src/waeup/ikoba/zcml.py

@@ -16 +16 @@
 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 ##
+import os
 from zope.component.zcml import handler
+from zope.configuration.exceptions import ConfigurationError
 from waeup.ikoba.interfaces import IDataCenterConfig, IPayPalConfig
 
@@ -52 +54 @@
 
 
+def paypal_handler(path):
+    """ZCML handler that registers paypal configuration.
+
+    We expect paypal credentials written down in a config file. The
+    path to this config file can be set with the ZCML `paypalconf`
+    directive, which is handled here.
+
+    This handler requires the given path to exist and to be a file.
+
+    If the file exists and is readable, a dict with ``path`` set to
+    the given path is registered as a global unnamed utility for the
+    `IPayPalConfig` interface.
+
+    We do not check more (syntax, etc. of a found config) as this is
+    beyond the scope of ZCML configuration. ZCML is responsible for
+    finding _some_ paypal configuration file, not for the values found
+    (or not found) within this file.
+    """
+    if not os.path.exists(path):
+        raise ConfigurationError("No such file: %s" % path)
+    if not os.path.isfile(path):
+        raise ConfigurationError("Not a regular file: %s" % path)
+    return handler(
+        'registerUtility', {'path': path}, IPayPalConfig, '')
+
+
 def paypal_conf(context, path):
     """Handler for ZCML paypalconf directive.
+
+    This handler registers the `paypal_handler` above to perform the
+    real configuration action.
     """
     context.action(
         discriminator=('utility', IPayPalConfig, ''),
-        callable=handler,
-        args=(
-            'registerUtility',
-            {'path': path}, IPayPalConfig, '')
+        callable=paypal_handler,
+        args=(path, )
         )