Merge pull request #17 from spry-group/master

Release Candidate, 0.1.2

Author: dopry

.travis.yml

@@ -1,6 +1,5 @@
 language: python
 python:
-  - "2.6"
   - "2.7"
   - "3.2"
   - "3.3"

CONTRIBUTING.md

@@ -2,17 +2,17 @@
 
 Vultr is a client library for the Vultr API.
 
-## Bug Reports 
+## Bug Reports
 
 Please report bugs through the github issue queue. When reporting a bug please include a code sample, describe the behavior you expect, and the behavior you're observing.
 
 ## Contributing Code
 
-Vultr is maintained on Github. Changes should be submitted as pull requests rebased on the latest master. 
+Vultr is maintained on Github. Changes should be submitted as pull requests rebased on the latest master.
 
 ## Becoming a Maintainer
 
-Please send an email to darrel.opry@spry-group.com if you are interested in becoming a maintainer. Like all open source projects, the more hands the merrier. 
+Please send an email to darrel.opry@spry-group.com if you are interested in becoming a maintainer. Like all open source projects, the more hands the merrier.
 
 ## Development
 
@@ -21,4 +21,28 @@ Please send an email to darrel.opry@spry-group.com if you are interested in beco
 
 ```
 
-## Testing
+## Testing
+
+Tests spawn and destroy instances labelled 'python-vultr: test'
+
+I highly recommend you setup a Vultr account specifically for integration testing with
+this library to avoid unintentionally destroying servers you need.
+
+Be sure to clean up your Vultr account when done.
+
+```
+python setup.py test
+```
+
+## Release Process
+
+Releases are tracked by creating a pull request from master to release. Ensure the version has been properly upticked before creating the release candidate pull request. The merged commit should be tagged with the proper version and built and uploaded to pypi. Currently the release process is manual. Once a more mature testing suite in place, it should be automated with TravisCI.
+
+```
+python setup.py sdist
+python setup.py bdist_wheel
+python setup.py sdist upload -r pypi
+python setup.py bdist_wheel upload -r pypi
+```
+
+based on: [Sharing Your Labor of Love: PyPI Quick and Dirty](https://hynek.me/articles/sharing-your-labor-of-love-pypi-quick-and-dirty/)

README.rst

@@ -15,6 +15,17 @@ Vultr provides a client library to the Vultr.com API.
     plans_json = vultr.plans_list()
 
 
+**Support**
+
+
+Python Vultr is supported on a volunteer basis. 
+
+* `Open an Issue <https://github.com/spry-group/python-vultr/issues/new>`_
+
+* .. image:: https://badges.gitter.im/Join%20Chat.svg
+      :target: https://gitter.im/spry-group/python-vultr
+
+
 **API**
 
 

setup.py

@@ -12,7 +12,7 @@ def read(filename):
 
 setup(
     name='vultr',
-    version='0.1.1',
+    version='0.1.2',
     install_requires=[
       "requests"
     ],

tests/test_vultr.py

@@ -22,26 +22,18 @@ def test_app_list(self):
         response = self.vultr.app_list()
 
 
+@unittest.skipIf(not os.environ.get('VULTR_KEY'), 'Skipping AuthenticatedTests')
 class AuthenticatedTests(unittest.TestCase):
-
-    def setUp(self):
-        self.VULTR_KEY = os.environ.get('VULTR_KEY')
-
-        if self.VULTR_KEY is None:
-            warnings.warn('The VULTR_KEY environment variable is not ' +
-                          'set. AuthenticatedTests will be bypassed.',
-                          UserWarning)
-        else:
-            self.vultr = Vultr(self.VULTR_KEY)
+    @classmethod
+    def setUpClass(cls):
+        cls.VULTR_KEY = os.environ.get('VULTR_KEY')
+        cls.vultr = Vultr(cls.VULTR_KEY)
+        cls.server_list = {}
 
     def test_get_api_key(self):
-        if self.VULTR_KEY is None:
-            return
         response = self.vultr.iso_list()
 
     def test_post_api_key(self):
-        if self.VULTR_KEY is None:
-            return
         try:
             response = self.vultr.server_label_set('', '')
         except VultrError as e:
@@ -52,5 +44,47 @@ def test_post_api_key(self):
                                   " ensure your API key matches the server's" +
                                   " account")
 
+    def test_account_info(self):
+        response = self.vultr.account_info()
+
+    def test_server_create(self):
+        response = self.vultr.server_create(vpsplanid=29, dcid=1, osid=191,
+                                            label="python-vultr: test")
+        warnings.warn("Creating VM: " + str(response) +
+                      "\n This will cost money.")
+
+    def test_server_list(self):
+        AuthenticatedTests.server_list = self.vultr.server_list()
+        warnings.warn(str(AuthenticatedTests.server_list))
+
+    def test_server_list_by_subid(self):
+        for subid in AuthenticatedTests.server_list:
+            response = self.vultr.server_list(subid=subid)
+
+    def test_server_destroy(self):
+        servers = self.vultr.server_list()
+        for subid in servers:
+            # skip machines not made by tests.
+
+            if servers[subid]['label'] != 'python-vultr: test':
+                warnings.warn("skipping [" + subid + "]:\n" +
+                              str(servers[subid]))
+                continue
+
+            try:
+                response = self.vultr.server_destroy(subid=subid)
+            except VultrError as e:
+                # This should be it's own
+                # except VultrServerDestroyWithinFiveMinutesError as e:
+                msg = str(e)
+                self.assertEqual(msg, "Request failed. Check the response" +
+                                      " body for a more detailed" +
+                                      " description. Body: \nUnable to" +
+                                      " destroy server: Servers cannot be" +
+                                      " destroyed within 5 minutes of being" +
+                                      " created")
+
+                warnings.warn(msg)
+
 if __name__ == '__main__':
     unittest.main()

vultr/__init__.py

@@ -1,4 +1,3 @@
-__version__ = '0.1.1'
-__license__ = 'MIT'
-
 from .vultr import Vultr, VultrError
+__version__ = '0.1.2'
+__license__ = 'MIT'

vultr/vultr.py

@@ -1,7 +1,8 @@
 import sys
 import requests
+import time
 import json as json_module
-
+from os import environ
 API_ENDPOINT = 'https://api.vultr.com'
 
 
@@ -14,6 +15,8 @@ class Vultr(object):
     def __init__(self, api_key):
         self.api_endpoint = API_ENDPOINT
         self.api_key = api_key
+        self.requestsPerSecond = 1
+        self.requestDuration = 1 / self.requestsPerSecond
 
     def snapshot_list(self):
         """
@@ -563,7 +566,7 @@ def backup_list(self):
         """
         return self.request('/v1/backup/list')
 
-    def server_list(self, subid):
+    def server_list(self, subid=None):
         """
         /v1/server/list
         GET - account
@@ -615,7 +618,7 @@ def server_list(self, subid):
         params = {'SUBID': subid}
         return self.request('/v1/server/list', params)
 
-    def server_bandwidth(self):
+    def server_bandwidth(self, subid):
         """
         /v1/server/bandwidth
         GET - account
@@ -670,7 +673,7 @@ def server_bandwidth(self):
         params = {'SUBID': subid}
         return self.request('/v1/server/bandwidth', params)
 
-    def server_reboot(self):
+    def server_reboot(self, subid):
         """
         /v1/server/reboot
         POST - account
@@ -688,7 +691,7 @@ def server_reboot(self):
         params = {'SUBID': subid}
         return self.request('/v1/server/reboot', params, 'POST')
 
-    def server_halt(self):
+    def server_halt(self, subid):
         """
         /v1/server/halt
         POST - account
@@ -708,7 +711,7 @@ def server_halt(self):
         params = {'SUBID': subid}
         return self.request('/v1/server/halt', params, 'POST')
 
-    def server_start(self):
+    def server_start(self, subid):
         """
         /v1/server/start
         POST - account
@@ -726,7 +729,7 @@ def server_start(self):
         params = {'SUBID': subid}
         return self.request('/v1/server/start', params, 'POST')
 
-    def server_destroy(self):
+    def server_destroy(self, subid):
         """
         /v1/server/destroy
         POST - account
@@ -745,7 +748,7 @@ def server_destroy(self):
         params = {'SUBID': subid}
         return self.request('/v1/server/destroy', params, 'POST')
 
-    def server_reinstall(self):
+    def server_reinstall(self, subid):
         """
         /v1/server/reinstall
         POST - account
@@ -924,7 +927,7 @@ def server_list_ipv4(self, subid):
         params = {'SUBID': subid}
         return self.request('/v1/server/list_ipv4', params)
 
-    def server_reverse_set_ipv4(self):
+    def server_reverse_set_ipv4(self, subid, ip, entry):
         """
         /v1/server/reverse_set_ipv4
         POST - account
@@ -967,7 +970,7 @@ def server_reverse_default_ipv4(self, subid, ip):
         params = {'SUBID': subid, 'ip': ip}
         return self.request('/v1/server/reverse_default_ipv4', params, 'POST')
 
-    def server_list_ipv6(self):
+    def server_list_ipv6(self, subid):
         """
         /v1/server/list_ipv6
         GET - account
@@ -995,7 +998,7 @@ def server_list_ipv6(self):
         params = {'SUBID': subid}
         return self.request('/v1/server/list_ipv6', params)
 
-    def server_reverse_list_ipv6(self):
+    def server_reverse_list_ipv6(self, subid):
         """
         /v1/server/reverse_list_ipv6
         GET - account
@@ -1130,7 +1133,7 @@ def server_destroy_ipv4(self, subid, ip):
         params = {'SUBID': subid, 'ip': ip}
         return self.request('/v1/server/destroy_ipv4', params, 'POST')
 
-    def server_os_change_list(self):
+    def server_os_change_list(self, subid):
         """
         /v1/server/os_change_list
         GET - account
@@ -1185,7 +1188,7 @@ def server_os_change(self, subid, osid):
         params = {'SUBID': subid, 'OSID': osid}
         return self.request('/v1/server/os_change', params)
 
-    def server_upgrade_plan_list(self):
+    def server_upgrade_plan_list(self, subid):
         """
         /v1/server/upgrade_plan_list
         GET - account
@@ -1309,17 +1312,21 @@ def os_list(self):
         return self.request('/v1/os/list')
 
     def request(self, path, params={}, method='GET'):
+        _start = time.time()
+
         if not path.startswith('/'):
             path = '/' + path
         url = self.api_endpoint + path
 
         try:
             if method == 'POST':
-                query = {'api_key': self.api_key}
+                if (self.api_key):
+                    query = {'api_key': self.api_key}
                 resp = requests.post(url, params=query, data=params,
                                      timeout=60)
             elif method == 'GET':
-                params['api_key'] = self.api_key
+                if (self.api_key):
+                    params['api_key'] = self.api_key
                 resp = requests.get(url, params=params, timeout=60)
             else:
                 raise VultrError('Unsupported method %s' % method)
@@ -1351,14 +1358,24 @@ def request(self, path, params={}, method='GET'):
                                  ' to an average of 1/s. Try your request' +
                                  ' again later.')
 
-        return resp.json()
+        # very simplistic synchronous rate limiting;
+        _elapsed = time.time() - _start
+        if (_elapsed < self.requestDuration):
+            time.sleep(self.requestDuration - _elapsed)
+
+        # return an empty json object if the API
+        # doesn't respond with a value.
+        if not resp.text:
+            return json_module.loads('{}')
+        else:
+            return resp.json()
 
 
 if __name__ == '__main__':
     print("Vultr API Python Libary")
     print("http://vultr.com")
 
-    api_key = ''
+    api_key = environ.get('VULTR_KEY')
     if len(sys.argv) > 1:
         api_key = sys.argv[1]