update lib + tests

Author: delabiejochen

README.md

@@ -1,4 +1,5 @@
 [![Build Status](https://travis-ci.org/testingbot/testingbotclient.svg?branch=master)](https://travis-ci.org/testingbot/testingbotclient)
+[![PyPI version](https://badge.fury.io/py/testingbotclient.svg)](https://badge.fury.io/py/testingbotclient)
 
 # testingbotclient
 
@@ -11,91 +12,190 @@ pip install testingbotclient
 ```
 
 ## TestingBot
-[TestingBot](https://testingbot.com/) allows you to run your Selenium tests in the cloud.
-With access to over 400 different browser combinations, you can run your tests in parallel on their Selenium grid.
+[TestingBot](https://testingbot.com/) allows you to run Selenium tests in the cloud.
+With access to over +1500 different browser/device combinations, you can run your browser and mobile tests in parallel on the TestingBot Selenium grid.
 
-## Using the client
+## Getting Started
 
 ```python
 import testingbotclient
 
-tb = testingbotclient.TestingBotClient(
-            'key',
-            'secret'
-        )
-print tb.tests.update_test("webdriverSessionId", 'my test name', False, 'test failure error')
+tb = testingbotclient.TestingBotClient('key', 'secret')
 ```
 
 It is also possible to use `TESTINGBOT_KEY` and `TESTINGBOT_SECRET` environment variables instead of specifying these in the TestingBotClient constructor. Or use a `~/.testingbot` file with `key:secret`.
 
-## Running tests
 
-This library is only intended to query the TestingBot API.
-Below is a simple example which runs a Selenium Webdriver test on TestingBot and reports its name/success state back to TestingBot via this library:
+*All API methods can throw these exceptions:*
 
 ```python
-import unittest
-import sys
+TestingBotException(errorMessage)
+```
 
-from selenium import webdriver
-from selenium.webdriver.common.keys import Keys
-from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
-from testingbotclient import TestingBotClient
+### getBrowsers
+Retrieves collection of available browsers
+<https://testingbot.com/support/api>
 
-class TestTestingBotClient(unittest.TestCase):
 
-    def setUp(self):
-		desired_cap = {'platform': 'Windows', 'browserName': 'firefox', 'version': 'latest' }
+```python
+testingbotclient.information.get_browsers()
+```
 
-		self.driver = webdriver.Remote(
-		    command_executor='http://key:[email protected]/wd/hub',
-		    desired_capabilities=desired_cap)
+### updateTest
+Update meta-data for a test
+<https://testingbot.com/support/api#updatetest>
 
-    def test_google_example(self):
-		self.driver.get("http://www.google.com")
-		if not "Google" in self.driver.title:
-		    raise Exception("Unable to load google page!")
-		elem = self.driver.find_element_by_name("q")
-		elem.send_keys("TestingBot")
-		elem.submit()
+- `String` status_message
+- `boolean` success
+- `String` build
+- `String` name
 
-    def tearDown(self):
-		self.driver.quit()
-		status = sys.exc_info() == (None, None, None)
-		tb_client = TestingBotClient('key', 'secret')
-		tb_client.tests.update_test(self.driver.session_id, self._testMethodName, status)
 
-if __name__ == '__main__':
-    unittest.main()
+```python
+testingbotclient.tests.update_test(sessionId, status_message=.., passed=1|0, build=.., name=..)
 ```
 
-For more information on running Selenium RC/WebDriver tests with Python, please see [Python WebDriver Examples](https://testingbot.com/support/getting-started/python.html)
+### stopTest
+Stops a running test
+<https://testingbot.com/support/api#stoptest>
 
 
-## More documentation
+```python
+testingbotclient.tests.stop_test(sessionId)
+```
+
+### deleteTest
+Deletes a test from TestingBot
+<https://testingbot.com/support/api#deletetest>
+
+
+```python
+testingbotclient.tests.delete_test(sessionId)
+```
+
+### getTest
+Retrieves information regarding a test
+<https://testingbot.com/support/api#singletest>
+
+
+```python
+testingbotclient.tests.get_test(sessionId)
+```
+
+### getTests
+Retrieves a collection of tests
+<https://testingbot.com/support/api#tests>
 
-Check out the [TestingBot REST API](https://testingbot.com/support/api) for more information.
 
-## License
+```python
+testingbotclient.tests.get_tests(offset=0, limit=30)
+```
 
-The MIT License (MIT)
+### getBuilds
+Retrieves a collection of builds
+<https://testingbot.com/support/api#builds>
+
+
+```python
+testingbotclient.build.get_builds(offset=0, limit=30)
+```
+
+### getTestsForBuild
+Retrieves a collection of tests for a specific build
+<https://testingbot.com/support/api#singlebuild>
+
+
+```python
+testingbotclient.build.get_tests_for_build(buildId)
+```
+
+### getUserConfig
+Retrieves information about the current user
+<https://testingbot.com/support/api#user>
+
+
+```python
+testingbotclient.user.get_user_information()
+```
+
+### getTunnels
+Retrieves tunnels for the current user
+<https://testingbot.com/support/api#apitunnellist>
+
+
+```python
+testingbotclient.tunnel.get_tunnels()
+```
 
-Copyright (c) TestingBot.com
+### deleteTunnel
+Deletes/stops a specific tunnel for the current user
+<https://testingbot.com/support/api#apitunneldelete>
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+```python
+testingbotclient.tunnel.delete_tunnel(sessionId)
+```
+
+### uploadToStorage - Local File
+Uploads a local file to TestingBot Storage
+<https://testingbot.com/support/api#upload>
+
+
+```python
+testingbotclient.storage.upload_local_file(localFilePath)
+```
+
+### uploadToStorage - Remote File
+Uploads a remote file to TestingBot Storage
+<https://testingbot.com/support/api#upload>
+
+
+```python
+testingbotclient.storage.upload_remote_file(localFilePath)
+```
+
+### getStorageFile
+Retrieves meta-data from a previously stored file
+<https://testingbot.com/support/api#uploadfile>
+
+
+```python
+testingbotclient.storage.get_stored_file(appUrl)
+```
+
+### getStorageFiles
+Retrieves meta-data from previously stored files
+<https://testingbot.com/support/api#filelist>
+
+
+```python
+testingbotclient.storage.get_stored_files(appUrl)
+```
+
+### deleteStorageFile
+Deletes a file previously stored in TestingBot Storage
+<https://testingbot.com/support/api#filedelete>
+
+
+```python
+testingbotclient.storage.remove_file(appUrl)
+```
+
+### get_share_link
+Calculates the authenticationHash necessary to share tests
+<https://testingbot.com/support/other/sharing>
+
+
+```python
+testingbotclient.get_share_link(sessionId)
+```
+
+## Test
+
+```python
+python test_travis.py
+```
+
+## More documentation
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+Check out the [TestingBot REST API](https://testingbot.com/support/api) for more information.

setup.py

@@ -20,6 +20,9 @@
     download_url='http://pypi.python.org/pypi/testingbotclient',
     keywords='testingbot selenium testing'.split(),
     license='Apache v2.0',
+    install_requires=[
+        'requests',
+    ],
     classifiers=[
         'Development Status :: 4 - Beta',
         'Intended Audience :: Developers',

test_travis.py

@@ -1,6 +1,6 @@
 import os
 import unittest
-
+import uuid
 import testingbotclient
 
 class TestTestingBotClient(unittest.TestCase):
@@ -9,7 +9,52 @@ def setUp(self):
         self.tb = testingbotclient.TestingBotClient()
 
     def test_get_user_information(self):
-        self.assertEqual(self.tb.user.get_user_information()['first_name'], "travisbot")
+        self.assertTrue(self.tb.user.get_user_information()['first_name'])
+
+    def test_upload_file(self):
+    	response = self.tb.storage.upload_local_file("./tests/resources/sample.apk")
+    	self.assertTrue(response.get("app_url") != None)
+
+    def test_upload_remote_file(self):
+        response = self.tb.storage.upload_remote_file("https://testingbot.com/appium/sample.apk")
+        self.assertTrue(response.get("app_url") != None)
+
+    def test_upload_and_delete_file(self):
+    	files = self.tb.storage.get_stored_files()
+    	current_count = files.get("meta").get("total")
+    	response = self.tb.storage.upload_local_file("./tests/resources/sample.apk")
+    	app_url = response.get("app_url")
+    	meta_data = self.tb.storage.get_stored_file(app_url)
+    	self.assertEqual(meta_data.get("app_url"), app_url)
+
+    	files = self.tb.storage.get_stored_files()
+    	self.assertEqual(files.get("meta").get("total"), current_count + 1)
+
+    	self.tb.storage.remove_file(app_url)
+
+        try:
+            self.tb.storage.get_stored_file(app_url)
+        except testingbotclient.TestingBotException:
+            pass
+        except Exception as e:
+           self.fail('Unexpected exception raised:', e)
+        else:
+           self.fail('ExpectedException not raised')
+
+    def test_get_test(self):
+        sessionId = "6344353dcee24694bf39d5ee5e6e5b11"
+        test_meta = self.tb.tests.get_test(sessionId)
+        self.assertEqual(test_meta.get("session_id"), sessionId)
+
+    def test_update_test(self):
+        sessionId = "6344353dcee24694bf39d5ee5e6e5b11"
+        new_status_message = uuid.uuid4().hex.upper()[0:6]
+        self.tb.tests.update_test(sessionId, status_message=new_status_message)
+        test_meta = self.tb.tests.get_test(sessionId)
+        self.assertEqual(test_meta.get("status_message"), new_status_message)
+
+    def test_share_link(self):
+        self.assertEqual(self.tb.get_share_link("test"), "344ebf07233168c4882adf953a8a8c9b")
 
 if __name__ == '__main__':
     unittest.main()