Updated exceptions.py by formatting the comments (some dealt with Issue #3). Fixed a bug in URL formatting where the logic allowed appending the '&format=<name>' multiple times. Updated test_core.py to test the content-type returned in the header of the request. This will make sure that we are getting the correct response type for XML, JSON, and VDF requests (Issue #4).

Author: Michael Barr

steamwebapi/core.py

@@ -126,7 +126,9 @@ def __init__(self, interface, method, method_version=1, httpmethod='GET',
         self._version = 'v{0:04d}'.format(method_version)
         self._parameters = parameters
         self._httpmethod = str(httpmethod).upper()
-        self._url = self._encode_url()
+
+        # Set self._url
+        self._encode_url()
 
     def _encode_url(self):
         """.. method:: _encode_url()
@@ -135,12 +137,12 @@ def _encode_url(self):
 
         :returns:  url
         """
-        return 'http://api.steampowered.com/{0}/{1}/{2}/?{3}'.format(
+        self._url = 'http://api.steampowered.com/{0}/{1}/{2}/?{3}'.format(
             self._interface,
             self._method,
             self._version,
             # urllib.urlencode(self._parameters)
-            urlencode(self._parameters)
+            urlencode(self._parameters),
         )
 
     @property
@@ -215,9 +217,9 @@ def xml(self):
         return self.as_xml()
 
     @property
-    def json(self, load=False):
+    def json(self):
         """.. attribute:: json"""
-        return self.as_json(load)
+        return self.as_json()
 
     @property
     def vdf(self):
@@ -232,7 +234,7 @@ def as_xml(self):
         self._url += '&format=xml'
         return self._execute_query()
 
-    def as_json(self, load=False):
+    def as_json(self):
         """.. method:: as_json()"""
         # We need to encode the URL again to prevent appending the format
         # multiple times.

steamwebapi/util/exceptions.py

@@ -1,4 +1,16 @@
+"""
+.. module:: exceptions
+   :platform: Unix, Windows
+   :synopsis: Contains the API's "core" classes for constructing queries.
+
+.. moduleauthor:: Michael Barr <[email protected]>
+
+"""
+# =============================================================================
+# >> EXCEPTIONS
+# =============================================================================
 class SteamWebAPIError(Exception):
+    """The base Exception for the steamwebapi package."""
     pass
 
 

tests/test_core.py

@@ -188,6 +188,58 @@ def test_default_language_initialized_from__init__no_keyword_arg(self):
         )
 
 
+class TestAPIQuery(TestCase):
+    """Tests the core.APIQuery() class to ensure the correct content-type is
+    returned. We utilize ISteamWebAPIUtil().GetSupportedAPIList() as it
+    does not require a key or arguments, and should always be available.
+
+    """
+
+    def setUp(self):
+        """Initializes an APIQuery instance."""
+        from steamwebapi.core import APIQuery
+        self.apiquery = APIQuery(
+            interface='ISteamWebAPIUtil',
+            method='GetSupportedAPIList',
+            method_version=1,
+            httpmethod='GET',
+            parameters={},
+        )
+
+    def test_api_query_return_xml(self):
+        """Tests that calling the XML format returns the correct
+        content-type.
+
+        """
+        self.assertEqual(
+            self.apiquery.xml.headers['content-type'],
+            'text/xml; charset=UTF-8',
+            'The content-type headers returned do not match the XML type.',
+        )
+
+    def test_api_query_return_json(self):
+        """Tests that calling the JSON format returns the correct
+        content-type.
+
+        """
+        self.assertEqual(
+            self.apiquery.json.headers['content-type'],
+            'application/json; charset=UTF-8',
+            'The content-type headers returned do not match the JSON type.',
+        )
+
+    def test_api_query_return_vdf(self):
+        """Tests that calling the VDF format returns the correct
+        content-type.
+
+        """
+        self.assertEqual(
+            self.apiquery.vdf.headers['content-type'],
+            'text/vdf; charset=UTF-8',
+            'The content-type headers returned do not match the VDF type.',
+        )
+
+
 # =============================================================================
 # >> TEST FUNCTIONS
 # =============================================================================