Merge pull request ej2#74 from humrochagf/master

ej2 · web-flow · commit 861d2fde8b39 · 2017-08-17T09:33:45.000-07:00
QuickBooks command line tool
diff --git a/README.rst b/README.rst
@@ -14,6 +14,17 @@ You can find additional examples of usage in `Integration tests folder`_.
 Connecting your application to Quickbooks Online
 ------------------------------------------------
 
+Theres two ways to connect your application to Quickbooks Online:
+
+With quickbooks-cli
+-------------------
+
+   ::
+       quickbooks-cli [-h] [-s] [-p PORT] consumer_key consumer_secret
+
+Manually
+--------
+
 1. Create the Authorization URL for your application:
 
    ::
diff --git a/quickbooks/tools/__init__.py b/quickbooks/tools/__init__.py
diff --git a/quickbooks/tools/auth.py b/quickbooks/tools/auth.py
@@ -0,0 +1,91 @@
+try:  # Python 3
+    from urllib.parse import parse_qs, urlparse
+    from http.server import BaseHTTPRequestHandler, HTTPServer
+except ImportError:  # Python 2
+    from urlparse import parse_qs, urlparse
+    from BaseHTTPServer import BaseHTTPRequestHandler, HTTPServer
+
+    def bytes(value, encoding):
+        return str(value)
+
+from quickbooks import QuickBooks
+
+
+class QuickBooksAuthHandler(BaseHTTPRequestHandler):
+
+    def _set_headers(self):
+        self.send_response(200)
+        self.send_header('Content-Type', 'text/html')
+        self.end_headers()
+
+    def do_GET(self):
+        self._set_headers()
+        qb_data = self.server.qb_data
+
+        GET = parse_qs(urlparse(self.path).query)
+
+        oauth_verifier = GET.get('oauth_verifier')
+        realm_id = GET.get('realmId')
+
+        if type(realm_id) is list and len(realm_id) == 1:
+            realm_id = realm_id[0]
+
+        if oauth_verifier and realm_id:
+            client = self.server.qb_client_class(
+                sandbox=qb_data['sandbox'],
+                consumer_key=qb_data['consumer_key'],
+                consumer_secret=qb_data['consumer_secret']
+            )
+
+            client.authorize_url = qb_data['authorize_url']
+            client.request_token = qb_data['request_token']
+            client.request_token_secret = qb_data['request_token_secret']
+            client.set_up_service()
+
+            client.get_access_tokens(oauth_verifier)
+
+            self.wfile.write(
+                bytes('<h1>QuickBooks auth handled with success!</h1>',
+                      'UTF-8'))
+            self.wfile.write(
+                bytes('<p><b>Sandbox:</b> {0}</p>'.format(qb_data['sandbox']),
+                      'UTF-8'))
+            self.wfile.write(
+                bytes('<p><b>Realm Id:</b> {0}</p>'.format(realm_id), 'UTF-8'))
+            self.wfile.write(
+                bytes('<p><b>Access Token:</b> {0}</p>'.format(
+                    client.access_token), 'UTF-8'))
+            self.wfile.write(
+                bytes('<p><b>Access Token Secret:</b> {0}</p>'.format(
+                    client.access_token_secret), 'UTF-8'))
+        else:
+            self.wfile.write(
+                bytes('<h1>QuickBooks auth failed, try again.</h1>', 'UTF-8'))
+
+
+class QuickBooksAuthServer(HTTPServer):
+
+    qb_client_class = QuickBooks
+
+    @classmethod
+    def build_server(cls, consumer_key, consumer_secret, sandbox, port):
+        client = cls.qb_client_class(
+            sandbox=sandbox,
+            consumer_key=consumer_key,
+            consumer_secret=consumer_secret,
+            callback_url='http://localhost:{0}'.format(port)
+        )
+
+        qb_data = {
+            'authorize_url': client.get_authorize_url(),
+            'request_token': client.request_token,
+            'request_token_secret': client.request_token_secret,
+            'consumer_key': consumer_key,
+            'consumer_secret': consumer_secret,
+            'sandbox': sandbox,
+        }
+
+        instance = cls(('', port), QuickBooksAuthHandler)
+        instance.qb_data = qb_data
+
+        return instance
diff --git a/quickbooks/tools/cli.py b/quickbooks/tools/cli.py
@@ -0,0 +1,42 @@
+import argparse
+
+from quickbooks.tools.auth import QuickBooksAuthServer
+
+
+class CLI(argparse.ArgumentParser):
+    info = ({
+        'prog': 'quickbooks-cli',
+        'description': 'Starts a local server to handle quickbooks auth',
+    })
+
+    def __init__(self):
+        super(CLI, self).__init__(**self.info)
+
+        self.add_argument('consumer_key', type=str,
+                          help='quickbooks consumer key')
+        self.add_argument('consumer_secret', type=str,
+                          help='quickbooks consumer secret')
+        self.add_argument('-s', '-sandbox', action='store_true',
+                          dest='sandbox', help='sandbox flag')
+        self.add_argument('-p', '--port', type=int, default=8080,
+                          dest='port', help='auth calback port')
+
+    def run(self, args=None):
+        print('Starting the authentication process...')
+
+        server = QuickBooksAuthServer.build_server(
+            args.consumer_key, args.consumer_secret, args.sandbox, args.port)
+
+        print('Copy and paste the authorization url on your browser:')
+        print(server.qb_data['authorize_url'])
+
+        server.serve_forever()
+
+
+def cli_execute():
+    cli = CLI()
+    cli.run(cli.parse_args())
+
+
+if __name__ == '__main__':
+    cli_execute()
diff --git a/setup.py b/setup.py
@@ -24,6 +24,10 @@ def read(*parts):
     keywords=['quickbooks', 'qbo', 'accounting'],
     long_description=read('README.rst'),
 
+    entry_points={
+        'console_scripts': ['quickbooks-cli=quickbooks.tools.cli:cli_execute']
+    },
+
     install_requires=[
         'setuptools',
         'rauth>=0.7.1',
diff --git a/tests/unit/tools/__init__.py b/tests/unit/tools/__init__.py
diff --git a/tests/unit/tools/test_auth.py b/tests/unit/tools/test_auth.py
@@ -0,0 +1,31 @@
+import unittest
+
+try:
+    from mock import patch
+except ImportError:
+    from unittest.mock import patch
+
+from quickbooks.tools.auth import QuickBooksAuthServer
+
+
+class ClientTest(unittest.TestCase):
+
+    def setUp(self):
+        self.consumer_key = 'update_consumer_key'
+        self.consumer_secret = 'update_consumer_secret'
+        self.sandbox = True
+        self.port = 8080
+        self.authorize_url = '{0}?oauth_token=testToken'.format(
+            QuickBooksAuthServer.qb_client_class.authorize_url)
+
+    def test_build_server(self):
+        with patch.object(QuickBooksAuthServer.qb_client_class,
+                          'get_authorize_url',
+                          return_value=self.authorize_url):
+            server = QuickBooksAuthServer.build_server(
+                self.consumer_key, self.consumer_secret,
+                self.sandbox, self.port)
+
+            self.assertTrue(isinstance(server, QuickBooksAuthServer))
+            self.assertTrue(isinstance(server.qb_data, dict))
+            self.assertTrue('oauth_token' in server.qb_data['authorize_url'])
