Set an explicit user-agent for the Python API

Author: oschwald

geoip2/webservices.py

@@ -93,8 +93,11 @@
 check to see if the attribute is set.
 
 """
+
+import geoip2
 import geoip2.models
 import requests
+from requests.utils import default_user_agent
 from .errors import GeoIP2Error, GeoIP2HTTPError, GeoIP2WebServiceError
 
 
@@ -202,13 +205,18 @@ def omni(self, ip_address='me'):
     def _response_for(self, path, model_class, ip_address):
         uri = '/'.join([self._base_uri, path, ip_address])
         response = requests.get(uri, auth=(self.user_id, self.license_key),
-                                headers={'Accept': 'application/json'})
+                                headers={'Accept': 'application/json',
+                                         'User-Agent': self._user_agent() })
         if (response.status_code == 200):
             body = self._handle_success(response, uri)
             return model_class(body, languages=self.languages)
         else:
             self._handle_error(response, uri)
 
+    def _user_agent(self):
+        return 'GeoIP2 Python Client v%s (%s)' % (geoip2.__version__,
+                                                 default_user_agent())
+
     def _handle_success(self, response, uri):
         try:
             return response.json()

tests/webservices_test.py

@@ -22,6 +22,8 @@
 
 if sys.version_info[0] == 2:
     unittest.TestCase.assertRaisesRegex = unittest.TestCase.assertRaisesRegexp
+    unittest.TestCase.assertRegex = unittest.TestCase.assertRegexpMatches
+
 
 
 @patch.object(requests, 'get')
@@ -163,10 +165,17 @@ def test_300_error(self, get):
     def test_request(self, get):
         self._setup_get(get, 'country', 200, self.country)
         country = self.client.country('1.2.3.4')
-        get.assert_called_with('https://geoip.maxmind.com'
-                               '/geoip/v2.0/country/1.2.3.4',
-                               headers={'Accept': 'application/json'},
-                               auth=(42, 'abcdef123456'))
+        args, kwargs = get.call_args
+        self.assertEqual(args[0], 'https://geoip.maxmind.com'
+                         '/geoip/v2.0/country/1.2.3.4',
+                         'correct URI is used')
+        self.assertEqual(kwargs.get('headers').get('Accept'),
+                         'application/json',
+                         'correct Accept header')
+        self.assertRegex(kwargs.get('headers').get('User-Agent'),
+                                 '^GeoIP2 Python Client v',
+                                 'Correct User-Agent')
+        self.assertEqual(kwargs.get('auth'), (42, 'abcdef123456'))
 
     def test_city_ok(self, get):
         self._setup_get(get, 'city', 200, self.country)