Added configure method
Added support for disabling HTTPS SSL verification
This commit is contained in:
parent
d7b74dc1da
commit
5ad540e177
3 changed files with 69 additions and 12 deletions
11
README.rst
11
README.rst
|
@ -77,11 +77,16 @@ API Versioning
|
||||||
==============
|
==============
|
||||||
It may be useful to lock your application to a particular version of the Trovebox API.
|
It may be useful to lock your application to a particular version of the Trovebox API.
|
||||||
This ensures that future API updates won't cause unexpected breakages.
|
This ensures that future API updates won't cause unexpected breakages.
|
||||||
|
To do this, configure your Trovebox client as follows:
|
||||||
|
|
||||||
To do this, add the optional ``api_version`` parameter when creating the client object::
|
client.configure(api_version=2)
|
||||||
|
|
||||||
from trovebox import Trovebox
|
SSL Verification
|
||||||
client = Trovebox(api_version=2)
|
================
|
||||||
|
If you connect to your Trovebox server over HTTPS, its SSL certificate is automatically verified.
|
||||||
|
You can configure your Trovebox client to bypass this verification step:
|
||||||
|
|
||||||
|
client.configure(ssl_verify=False)
|
||||||
|
|
||||||
Commandline Tool
|
Commandline Tool
|
||||||
================
|
================
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
from __future__ import unicode_literals
|
from __future__ import unicode_literals
|
||||||
import os
|
import os
|
||||||
import json
|
import json
|
||||||
|
import mock
|
||||||
import httpretty
|
import httpretty
|
||||||
try:
|
try:
|
||||||
import unittest2 as unittest # Python2.6
|
import unittest2 as unittest # Python2.6
|
||||||
|
@ -219,7 +220,8 @@ class TestHttp(unittest.TestCase):
|
||||||
@httpretty.activate
|
@httpretty.activate
|
||||||
def test_get_with_api_version(self):
|
def test_get_with_api_version(self):
|
||||||
"""Check that an API version can be specified for the get method"""
|
"""Check that an API version can be specified for the get method"""
|
||||||
self.client = trovebox.Trovebox(host=self.test_host, api_version=1)
|
self.client = trovebox.Trovebox(host=self.test_host)
|
||||||
|
self.client.configure(api_version=1)
|
||||||
self._register_uri(httpretty.GET,
|
self._register_uri(httpretty.GET,
|
||||||
uri="http://%s/v1/%s" % (self.test_host,
|
uri="http://%s/v1/%s" % (self.test_host,
|
||||||
self.test_endpoint))
|
self.test_endpoint))
|
||||||
|
@ -228,13 +230,39 @@ class TestHttp(unittest.TestCase):
|
||||||
@httpretty.activate
|
@httpretty.activate
|
||||||
def test_post_with_api_version(self):
|
def test_post_with_api_version(self):
|
||||||
"""Check that an API version can be specified for the post method"""
|
"""Check that an API version can be specified for the post method"""
|
||||||
self.client = trovebox.Trovebox(host=self.test_host, api_version=1,
|
self.client = trovebox.Trovebox(host=self.test_host, **self.test_oauth)
|
||||||
**self.test_oauth)
|
self.client.configure(api_version=1)
|
||||||
self._register_uri(httpretty.POST,
|
self._register_uri(httpretty.POST,
|
||||||
uri="http://%s/v1/%s" % (self.test_host,
|
uri="http://%s/v1/%s" % (self.test_host,
|
||||||
self.test_endpoint))
|
self.test_endpoint))
|
||||||
self.client.post(self.test_endpoint)
|
self.client.post(self.test_endpoint)
|
||||||
|
|
||||||
|
@mock.patch.object(trovebox.http.requests, 'Session')
|
||||||
|
def test_get_with_ssl_verify_disabled(self, mock_session):
|
||||||
|
"""Check that SSL verification can be disabled for the get method"""
|
||||||
|
session = mock_session.return_value.__enter__.return_value
|
||||||
|
session.get.return_value.text = "response text"
|
||||||
|
session.get.return_value.status_code = 200
|
||||||
|
session.get.return_value.json.return_value = self.test_data
|
||||||
|
|
||||||
|
self.client = trovebox.Trovebox(host=self.test_host, **self.test_oauth)
|
||||||
|
self.client.configure(ssl_verify=False)
|
||||||
|
self.client.get(self.test_endpoint)
|
||||||
|
self.assertEqual(session.verify, False)
|
||||||
|
|
||||||
|
@mock.patch.object(trovebox.http.requests, 'Session')
|
||||||
|
def test_post_with_ssl_verify_disabled(self, mock_session):
|
||||||
|
"""Check that SSL verification can be disabled for the post method"""
|
||||||
|
session = mock_session.return_value.__enter__.return_value
|
||||||
|
session.post.return_value.text = "response text"
|
||||||
|
session.post.return_value.status_code = 200
|
||||||
|
session.post.return_value.json.return_value = self.test_data
|
||||||
|
|
||||||
|
self.client = trovebox.Trovebox(host=self.test_host, **self.test_oauth)
|
||||||
|
self.client.configure(ssl_verify=False)
|
||||||
|
self.client.post(self.test_endpoint)
|
||||||
|
self.assertEqual(session.verify, False)
|
||||||
|
|
||||||
@httpretty.activate
|
@httpretty.activate
|
||||||
def test_post_file(self):
|
def test_post_file(self):
|
||||||
"""Check that a file can be posted"""
|
"""Check that a file can be posted"""
|
||||||
|
|
|
@ -31,14 +31,22 @@ class Http(object):
|
||||||
The config_file parameter is used to specify an alternate config file.
|
The config_file parameter is used to specify an alternate config file.
|
||||||
If the host parameter is specified, no config file is loaded and
|
If the host parameter is specified, no config file is loaded and
|
||||||
OAuth tokens (consumer*, token*) can optionally be specified.
|
OAuth tokens (consumer*, token*) can optionally be specified.
|
||||||
All requests will include the api_version path, if specified.
|
|
||||||
This should be used to ensure that your application will continue to work
|
|
||||||
even if the Trovebox API is updated to a new revision.
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
_CONFIG_DEFAULTS = {"api_version" : None,
|
||||||
|
"ssl_verify" : True,
|
||||||
|
}
|
||||||
|
|
||||||
def __init__(self, config_file=None, host=None,
|
def __init__(self, config_file=None, host=None,
|
||||||
consumer_key='', consumer_secret='',
|
consumer_key='', consumer_secret='',
|
||||||
token='', token_secret='', api_version=None):
|
token='', token_secret='', api_version=None):
|
||||||
self._api_version = api_version
|
|
||||||
|
self.config = dict(self._CONFIG_DEFAULTS)
|
||||||
|
|
||||||
|
if api_version is not None:
|
||||||
|
print("Deprecation Warning: api_version should be set by "
|
||||||
|
"calling the configure function")
|
||||||
|
self.config["api_version"] = api_version
|
||||||
|
|
||||||
self._logger = logging.getLogger("trovebox")
|
self._logger = logging.getLogger("trovebox")
|
||||||
|
|
||||||
|
@ -53,6 +61,20 @@ class Http(object):
|
||||||
self.last_params = None
|
self.last_params = None
|
||||||
self.last_response = None
|
self.last_response = None
|
||||||
|
|
||||||
|
def configure(self, **kwds):
|
||||||
|
"""
|
||||||
|
Update Trovebox HTTP client configuration.
|
||||||
|
|
||||||
|
:param api_version: Include a Trovebox API version in all requests.
|
||||||
|
This can be used to ensure that your application will continue
|
||||||
|
to work even if the Trovebox API is updated to a new revision.
|
||||||
|
[default: None]
|
||||||
|
:param ssl_verify: If true, HTTPS SSL certificates will always be
|
||||||
|
verified [default: True]
|
||||||
|
"""
|
||||||
|
for item in kwds:
|
||||||
|
self.config[item] = kwds[item]
|
||||||
|
|
||||||
def get(self, endpoint, process_response=True, **params):
|
def get(self, endpoint, process_response=True, **params):
|
||||||
"""
|
"""
|
||||||
Performs an HTTP GET from the specified endpoint (API path),
|
Performs an HTTP GET from the specified endpoint (API path),
|
||||||
|
@ -76,6 +98,7 @@ class Http(object):
|
||||||
auth = None
|
auth = None
|
||||||
|
|
||||||
with requests.Session() as session:
|
with requests.Session() as session:
|
||||||
|
session.verify = self.config["ssl_verify"]
|
||||||
response = session.get(url, params=params, auth=auth)
|
response = session.get(url, params=params, auth=auth)
|
||||||
|
|
||||||
self._logger.info("============================")
|
self._logger.info("============================")
|
||||||
|
@ -114,6 +137,7 @@ class Http(object):
|
||||||
self.auth.token,
|
self.auth.token,
|
||||||
self.auth.token_secret)
|
self.auth.token_secret)
|
||||||
with requests.Session() as session:
|
with requests.Session() as session:
|
||||||
|
session.verify = self.config["ssl_verify"]
|
||||||
if files:
|
if files:
|
||||||
# Need to pass parameters as URL query, so they get OAuth signed
|
# Need to pass parameters as URL query, so they get OAuth signed
|
||||||
response = session.post(url, params=params,
|
response = session.post(url, params=params,
|
||||||
|
@ -153,8 +177,8 @@ class Http(object):
|
||||||
|
|
||||||
if not endpoint.startswith("/"):
|
if not endpoint.startswith("/"):
|
||||||
endpoint = "/" + endpoint
|
endpoint = "/" + endpoint
|
||||||
if self._api_version is not None:
|
if self.config["api_version"] is not None:
|
||||||
endpoint = "/v%d%s" % (self._api_version, endpoint)
|
endpoint = "/v%d%s" % (self.config["api_version"], endpoint)
|
||||||
return urlunparse((scheme, host, endpoint, '', '', ''))
|
return urlunparse((scheme, host, endpoint, '', '', ''))
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue