feat(controller): Deprecate X prefixed headers

Author: Joshua-Anderson

client/deis.py

@@ -77,7 +77,7 @@
 __version__ = '1.7.0-dev'
 
 # what version of the API is this client compatible with?
-__api_version__ = '1.3'
+__api_version__ = '1.4'
 
 
 locale.setlocale(locale.LC_ALL, '')
@@ -396,7 +396,7 @@ def check_connection(self, controller, ssl_verify):
 
         if response.status_code != 401:
             raise EnvironmentError(error_message)
-        self.check_api_version(response.headers.get('X_DEIS_API_VERSION'))
+        self.check_api_version(response.headers.get('DEIS_API_VERSION'))
 
     def check_api_version(self, server_api_version):
         """
@@ -997,7 +997,7 @@ def builds_create(self, args):
             progress.cancel()
             progress.join()
         if response.status_code == requests.codes.created:
-            version = response.headers['x-deis-release']
+            version = response.headers['Deis-Release']
             self._logger.info("done, v{}".format(version))
         else:
             raise ResponseError(response)
@@ -1242,7 +1242,7 @@ def _config_set(self, app, values):
             progress.cancel()
             progress.join()
         if response.status_code == requests.codes.created:
-            version = response.headers['x-deis-release']
+            version = response.headers['Deis-Release']
             self._logger.info("done, v{}\n".format(version))
             config = response.json()
             values = config['values']
@@ -1288,7 +1288,7 @@ def config_unset(self, args):
             progress.cancel()
             progress.join()
         if response.status_code == requests.codes.created:
-            version = response.headers['x-deis-release']
+            version = response.headers['Deis-Release']
             self._logger.info("done, v{}\n".format(version))
             config = response.json()
             values = config['values']
@@ -1636,7 +1636,7 @@ def limits_set(self, args):
             progress.cancel()
             progress.join()
         if response.status_code == requests.codes.created:
-            version = response.headers['x-deis-release']
+            version = response.headers['Deis-Release']
             self._logger.info("done, v{}\n".format(version))
 
             self._print_limits(app, response.json())
@@ -1682,7 +1682,7 @@ def limits_unset(self, args):
             progress.cancel()
             progress.join()
         if response.status_code == requests.codes.created:
-            version = response.headers['x-deis-release']
+            version = response.headers['Deis-Release']
             self._logger.info("done, v{}\n".format(version))
             self._print_limits(app, response.json())
         else:
@@ -1907,7 +1907,7 @@ def tags_set(self, args):
             progress.cancel()
             progress.join()
         if response.status_code == requests.codes.created:
-            version = response.headers['x-deis-release']
+            version = response.headers['Deis-Release']
             self._logger.info("done, v{}\n".format(version))
 
             self._print_tags(app, response.json())
@@ -1945,7 +1945,7 @@ def tags_unset(self, args):
             progress.cancel()
             progress.join()
         if response.status_code == requests.codes.created:
-            version = response.headers['x-deis-release']
+            version = response.headers['Deis-Release']
             self._logger.info("done, v{}\n".format(version))
             self._print_tags(app, response.json())
         else:

controller/api/__init__.py

@@ -2,4 +2,4 @@
 The **api** Django app presents a RESTful web API for interacting with the **deis** system.
 """
 
-__version__ = '1.3.0'
+__version__ = '1.4.0'

controller/api/middleware.py

@@ -24,7 +24,7 @@ def process_request(self, request):
         doesn't match this controller's REST API major version (currently "1").
         """
         try:
-            client_version = request.META['HTTP_X_DEIS_VERSION']
+            client_version = request.META['HTTP_DEIS_VERSION']
             server_version = __version__.rsplit('.', 2)[0]
             if client_version != server_version:
                 message = {
@@ -46,5 +46,6 @@ def process_response(self, request, response):
         a response header.
         """
         # clients shouldn't care about the patch release
-        response['X_DEIS_API_VERSION'] = __version__.rsplit('.', 1)[0]
+        response['DEIS_API_VERSION'] = __version__.rsplit('.', 1)[0]
+        response['X_DEIS_API_VERSION'] = response['DEIS_API_VERSION']  # DEPRECATED
         return response

controller/api/tests/test_api_middleware.py

@@ -22,31 +22,31 @@ def setUp(self):
         self.user = User.objects.get(username='autotest')
         self.token = Token.objects.get(user=self.user).key
 
-    def test_x_deis_version_header_good(self):
+    def test_deis_version_header_good(self):
         """
         Test that when the version header is sent, the request is accepted.
         """
         response = self.client.get(
             '/v1/apps',
-            HTTP_X_DEIS_VERSION=__version__.rsplit('.', 2)[0],
+            HTTP_DEIS_VERSION=__version__.rsplit('.', 2)[0],
             HTTP_AUTHORIZATION='token {}'.format(self.token),
         )
         self.assertEqual(response.status_code, 200)
-        self.assertEqual(response.has_header('X_DEIS_API_VERSION'), True)
-        self.assertEqual(response['X_DEIS_API_VERSION'], __version__.rsplit('.', 1)[0])
+        self.assertEqual(response.has_header('DEIS_API_VERSION'), True)
+        self.assertEqual(response['DEIS_API_VERSION'], __version__.rsplit('.', 1)[0])
 
-    def test_x_deis_version_header_bad(self):
+    def test_deis_version_header_bad(self):
         """
         Test that when an improper version header is sent, the request is declined.
         """
         response = self.client.get(
             '/v1/apps',
-            HTTP_X_DEIS_VERSION='1234.5678',
+            HTTP_DEIS_VERSION='1234.5678',
             HTTP_AUTHORIZATION='token {}'.format(self.token),
         )
         self.assertEqual(response.status_code, 405)
 
-    def test_x_deis_version_header_not_present(self):
+    def test_deis_version_header_not_present(self):
         """
         Test that when the version header is not present, the request is accepted.
         """

controller/api/views.py

@@ -99,7 +99,8 @@ def get_object(self):
 
     def get_success_headers(self, data, **kwargs):
         headers = super(ReleasableViewSet, self).get_success_headers(data)
-        headers.update({'X-Deis-Release': self.release.version})
+        headers.update({'Deis-Release': self.release.version})
+        headers.update({'X-Deis-Release': self.release.version})  # DEPRECATED
         return headers
 
 

controller/deis/middleware.py

@@ -4,5 +4,6 @@
 class PlatformVersionMiddleware:
 
     def process_response(self, request, response):
-        response['X_DEIS_PLATFORM_VERSION'] = __version__
+        response['DEIS_PLATFORM_VERSION'] = __version__
+        response['X_DEIS_PLATFORM_VERSION'] = __version__  # DEPRECATED
         return response

controller/deis/settings.py

@@ -178,8 +178,12 @@
 )
 
 CORS_EXPOSE_HEADERS = (
-    'X_DEIS_API_VERSION',
-    'X_DEIS_PLATFORM_VERSION',
+    'X_DEIS_API_VERSION',  # DEPRECATED
+    'X_DEIS_PLATFORM_VERSION',  # DEPRECATED
+    'X-Deis-Release',  # DEPRECATED
+    'DEIS_API_VERSION',
+    'DEIS_PLATFORM_VERSION',
+    'Deis-Release',
 )
 
 REST_FRAMEWORK = {

docs/reference/api-v1.3.rst

@@ -1,8 +1,6 @@
 :title: Controller API v1.3
 :description: The v1.3 REST API for Deis' Controller
 
-.. _controller_api_v1:
-
 Controller API v1.3
 ===================