Allow client_from_file to load optional Client parameters

client_from_file now loads optional Client parameters. This allows
setting almost all parameters in an external file.

Author: tnydwrds

ox3apiclient/__init__.py

@@ -279,18 +279,40 @@ def client_from_file(file_path='.ox3rc', env=None):
 
     # Load required parameters.
     try:
-        for key in required_params:
-            client_params[key] = cp.get(env, key)
+        for param in required_params:
+            client_params[param] = cp.get(env, param)
     except ConfigParser.NoOptionError:
-        err_msg = "Missing required option: '%s'" % key
+        err_msg = "Missing required option: '%s'" % param
         raise Exception(err_msg)
 
-    # TODO: Add support for optional parameters.
-
     client = Client(
         domain=client_params['domain'],
         realm=client_params['realm'],
         consumer_key=client_params['consumer_key'],
         consumer_secret=client_params['consumer_secret'])
 
+    # Load optional parameters.
+    optional_params = [
+        'callback_url',
+        'scheme',
+        'request_token_url',
+        'access_token_url',
+        'authorization_url',
+        'api_path',
+        'email',
+        'password']
+
+    for param in optional_params:
+        try:
+            prop = param
+
+            # Prefix private properties with '_'.
+            if prop in ['email', 'password']:
+                prop = '_%s' % prop
+
+            client.__dict__[prop] = cp.get(env, param)
+
+        except ConfigParser.NoOptionError:
+            pass
+
     return client

tests/clientfromfile.py

@@ -59,3 +59,42 @@ def test_missing_required_option_raises_error(self):
             ox3apiclient.client_from_file,
             file_path,
             'missing-required-option')
+
+    def test_loads_optional_options(self):
+        file_path = os.path.join(os.path.dirname(__file__), 'ox3rctest')
+        ox = ox3apiclient.client_from_file(
+                file_path=file_path,
+                env='optional-options')
+
+        test_values = [
+            'domain',
+            'realm',
+            'consumer_secret',
+            'consumer_key',
+            'callback_url',
+            'scheme',
+            'request_token_url',
+            'access_token_url',
+            'authorization_url',
+            'api_path',
+            'email',
+            'password']
+
+        loaded_values = [
+            ox.domain,
+            ox.realm,
+            ox.consumer_key,
+            ox.consumer_secret,
+            ox.callback_url,
+            ox.scheme,
+            ox.request_token_url,
+            ox.access_token_url,
+            ox.authorization_url,
+            ox.api_path,
+            ox._email,
+            ox._password]
+
+        test_values.sort()
+        loaded_values.sort()
+
+        self.assertEqual(loaded_values, test_values)

tests/ox3rctest

@@ -3,6 +3,7 @@ envs=
     prod
     dev
     missing-required-option
+    optional-options
 
 [prod]
 email: email
@@ -26,3 +27,17 @@ password: password
 domain: domain
 realm: realm
 consumer_key: consumer_key
+
+[optional-options]
+email: email
+password: password
+domain: domain
+realm: realm
+consumer_key: consumer_key
+consumer_secret: consumer_secret
+scheme: scheme
+request_token_url: request_token_url
+access_token_url: access_token_url
+authorization_url: authorization_url
+api_path: api_path
+callback_url = callback_url