feat(controller): Deprecate X prefixed headers

Author: Joshua-Anderson

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'

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

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.
         """

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
 
 

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

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 = {