Added client_from_file

Added client_from_file function to create a Client instance from an ini
style config file as well as tests.

Author: tnydwrds

.gitignore

@@ -1,2 +1,2 @@
-ox_*.py
+.ox3rc
 *.pyc

ox3apiclient/__init__.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 
+import ConfigParser
 import cookielib
 import json
 import oauth2 as oauth
@@ -209,3 +210,37 @@ def delete(self, url):
         """"""
         res = self.request(self._resolve_url(url), method='DELETE')
         return json.loads(res.read())
+
+
+def client_from_file(file_path='.ox3rc', env=None):
+    """"""
+    cp = ConfigParser.RawConfigParser()
+    cp.read(file_path)
+
+    # Load default env if no env is specified. The default env is just the first
+    # env listed.
+    env_ids = [e for e in cp.get('ox3apiclient', 'envs').split('\n') if e]
+    env = env if env else env_ids[0]
+
+    # Required parameters for a ox3apiclient.Client instance.
+    required_params = [
+        'domain',
+        'realm',
+        'consumer_key',
+        'consumer_secret']
+
+    client_params = {}
+
+    # TODO: Catch NoOptionErrors.
+    for key in required_params:
+        client_params[key] = cp.get(env, key)
+
+    # 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'])
+
+    return client

tests/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+
+from clientfromfile import *

tests/clientfromfile.py

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+
+import os.path
+import unittest
+
+import ox3apiclient
+
+class ClientFromFileTestCase(unittest.TestCase):
+
+    def test_returns_client(self):
+        file_path = os.path.join(os.path.dirname(__file__), 'ox3rctest')
+        ox = ox3apiclient.client_from_file(file_path=file_path)
+        self.assertTrue(isinstance(ox, ox3apiclient.Client))
+
+    def test_loads_default_env(self):
+        file_path = os.path.join(os.path.dirname(__file__), 'ox3rctest')
+        ox = ox3apiclient.client_from_file(file_path=file_path)
+
+        test_values = [
+            'domain',
+            'realm',
+            'consumer_secret',
+            'consumer_key']
+
+        loaded_values = [
+            ox.domain,
+            ox.realm,
+            ox.consumer_key,
+            ox.consumer_secret]
+
+        test_values.sort()
+        loaded_values.sort()
+        self.assertEqual(loaded_values, test_values)
+
+    def test_loads_alternate_env(self):
+        file_path = os.path.join(os.path.dirname(__file__), 'ox3rctest')
+        ox = ox3apiclient.client_from_file(file_path=file_path, env='dev')
+
+        test_values = [
+            'domain_dev',
+            'realm_dev',
+            'consumer_secret_dev',
+            'consumer_key_dev']
+
+        loaded_values = [
+            ox.domain,
+            ox.realm,
+            ox.consumer_key,
+            ox.consumer_secret]
+
+        test_values.sort()
+        loaded_values.sort()
+        self.assertEqual(loaded_values, test_values)

tests/ox3rctest

@@ -0,0 +1,20 @@
+[ox3apiclient]
+envs=
+    prod
+    dev
+
+[prod]
+email: email
+password: password
+domain: domain
+realm: realm
+consumer_key: consumer_key
+consumer_secret: consumer_secret
+
+[dev]
+email: email_dev
+password: password_dev
+domain: domain_dev
+realm: realm_dev
+consumer_key: consumer_key_dev
+consumer_secret: consumer_secret_dev