Add client (#2)

Author: jeffbuswell

README.md

@@ -21,17 +21,24 @@ pip install wayscript
 2. Run your WayScript programs from your Python code:
 
 ```python
-import wayscript
+from wayscript import WayScript
 
 api_key = 'YOUR_API_KEY'
 
-wayscript = wayscript.authorize( api_key )
+wayscript = WayScript( api_key )
 
 # Run a program by id
 program_id = 1234
-wayscript.run( program_id )
+wayscript.run_program( program_id )
 
 # Pass variables to a program
 variables = [ 'one', 'two', 'three' ]
-wayscript.run( program_id, variables )
+wayscript.run_program( program_id, variables = variables )
+
+# Run a program asynchronously
+wayscript.run_program( program_id, run_async = True )
+wayscript.run_program( program_id, variables = variables, run_async = True )
+
+# Get the response from the server
+response = wayscript.run_program( program_id )
 ```

setup.py

@@ -1,3 +1,8 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2019 WayScript, Inc. All rights reserved.
+# Licensed under the MIT License.
+
 import setuptools
 
 with open("README.md", "r") as fh:
@@ -11,8 +16,9 @@
     description="WayScript gives you flexible building blocks to seamlessly integrate, automate and host tools in the cloud.",
     long_description=long_description,
     long_description_content_type="text/markdown",
+    install_requires=['requests>=2.21.0'],
     url="https://github.com/wayscript/wayscript-python",
-    packages=setuptools.find_packages(),
+    packages=['wayscript'],
     license='MIT',
     classifiers=[
         "Development Status :: 4 - Beta",

tests/__init__.py

@@ -0,0 +1,72 @@
+# Copyright (c) 2019 WayScript, Inc. All rights reserved.
+# Licensed under the MIT License.
+
+from unittest import TestCase
+from unittest.mock import patch
+
+from wayscript import WayScript
+from wayscript.exceptions import InvalidApiKeyException
+
+
+class TestWayScript( TestCase ):
+    dummy_api_key = "_DUMMY_API_KEY_DUMMY_API_KEY_DUMMY_API_KEY_"
+    program_id = 1234
+    variables = [ 'one', 'two', 'three' ]
+    api_url = 'https://wayscript.com/api'
+
+    def test_api_key( self ):
+        with self.assertRaises( InvalidApiKeyException ):
+            WayScript( '' )
+
+        with self.assertRaises( InvalidApiKeyException ):
+            WayScript( 'foobar' )
+
+        self.assertIsNotNone( WayScript( self.dummy_api_key ) )
+
+    def test_run_program( self ):
+        wayscript = WayScript( self.dummy_api_key )
+
+        with patch( 'requests.post' ) as post_request:
+            wayscript.run_program( self.program_id )
+            post_request.assert_called_once_with( self.api_url, params = { 'api_key': self.dummy_api_key,
+                                                                  'program_id': self.program_id,
+                                                                  'run_async': False } )
+
+    def test_run_program_with_variables( self ):
+        wayscript = WayScript( self.dummy_api_key )
+
+        with patch( 'requests.post' ) as post_request:
+            wayscript.run_program( self.program_id, variables = self.variables )
+            post_request.assert_called_once_with( self.api_url, params = { 'api_key': self.dummy_api_key,
+                                                                           'program_id': self.program_id,
+                                                                           'run_async': False,
+                                                                           'variables': self.variables } )
+
+    def test_run_program_async( self ):
+        wayscript = WayScript( self.dummy_api_key )
+
+        with patch( 'requests.post' ) as post_request:
+            wayscript.run_program( self.program_id, variables = self.variables, run_async = True )
+            post_request.assert_called_once_with( self.api_url, params = { 'api_key': self.dummy_api_key,
+                                                                           'program_id': self.program_id,
+                                                                           'run_async': True,
+                                                                           'variables': self.variables } )
+
+    def test_empty_variables( self ):
+        wayscript = WayScript( self.dummy_api_key )
+
+        with patch( 'requests.post' ) as post_request:
+            wayscript.run_program( self.program_id, variables = [ ], run_async = True )
+            post_request.assert_called_once_with( self.api_url, params = { 'api_key': self.dummy_api_key,
+                                                                           'program_id': self.program_id,
+                                                                           'run_async': True } )
+
+    def test_returns_response( self ):
+        wayscript = WayScript( self.dummy_api_key )
+
+        with patch( 'requests.post', return_value = 'ok' ) as post_request:
+            response = wayscript.run_program( self.program_id, run_async = True )
+            post_request.assert_called_once_with( self.api_url, params = { 'api_key': self.dummy_api_key,
+                                                                           'program_id': self.program_id,
+                                                                           'run_async': True } )
+            self.assertEqual( response, 'ok' )

tests/test.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+"""
+WayScript Python SDK
+~~~~~~~~~~~~
+This module implements the WayScript Client.
+:copyright: (c) 2019 WayScript, Inc
+:license: MIT, see LICENSE.txt for more details.
+"""
+
+from wayscript.client import Client
+
+class WayScript( Client ):
+    """A user-created :class:`WayScript <WayScript>` client object.
+        Used to send requests to the WayScript server.
+        :param api_key: The API Key for a WayScript account.
+        Usage::
+          >>> from wayscript import WayScript
+          >>> api_key = 'YOUR_API_KEY'
+          >>> wayscript = WayScript( api_key )
+        """
+    pass
+

wayscript/__init__.py

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+
+"""
+wayscript.client
+~~~~~~~~~~~~
+This module handles WayScript API calls.
+:copyright: (c) 2019 WayScript, Inc
+:license: MIT, see LICENSE.txt for more details.
+"""
+
+import requests
+from wayscript.exceptions import InvalidApiKeyException
+
+
+class Client:
+    def __init__( self, api_key):
+        if not api_key or len( api_key ) != 43:
+            raise InvalidApiKeyException()
+
+        self._api_key = api_key
+        self._api_url = 'https://wayscript.com/api'
+
+    def run_program( self, program_id, variables = None, run_async = False ):
+        """Runs a WayScript program.
+            :param program_id: The id of the program you want to run.
+            :param variables: (optional) An array of arguments to pass to your program.
+            :param run_async: (optional) Run this program asyncronously.
+                    If False, this command will block until your program has finished running.
+            :return: Response object
+            :rtype: requests.Response
+            Usage::
+                >>> from wayscript import WayScript
+                >>> api_key = 'YOUR_API_KEY'
+                >>> wayscript = WayScript( api_key )
+                >>> program_id = 1234
+                >>> response = wayscript.run_program( program_id, variables = variables, run_async = True )
+              <Response [200]>
+            """
+
+        params = { 'api_key': self._api_key,
+                   'program_id': program_id,
+                   'run_async': run_async }
+
+        if variables and len( variables ):
+            params[ 'variables' ] = variables
+
+        return self._post( params )
+
+    def _post( self, params ):
+        return requests.post( self._api_url, params = params )

wayscript/client.py

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+
+"""
+wayscript.exceptions
+~~~~~~~~~~~~
+This module contains the WayScript exception classes.
+:copyright: (c) 2019 WayScript, Inc
+:license: MIT, see LICENSE.txt for more details.
+"""
+
+
+class InvalidApiKeyException( Exception ):
+    def __init__( self ):
+        super().__init__( 'The API Key provided is not valid.' )