Setting the User-Agent header when making HTTP calls. (#38)

Author: hiranya911

firebase_admin/db.py

@@ -23,16 +23,20 @@
 import collections
 import json
 import numbers
+import sys
 
 import requests
 import six
 from six.moves import urllib
 
+import firebase_admin
 from firebase_admin import utils
 
 _DB_ATTRIBUTE = '_database'
 _INVALID_PATH_CHARACTERS = '[].#$'
 _RESERVED_FILTERS = ('$key', '$value', '$priority')
+_USER_AGENT = 'Firebase/HTTP/{0}/{1}.{2}/AdminPython'.format(
+    firebase_admin.__version__, sys.version_info.major, sys.version_info.minor)
 
 
 def reference(path='/', app=None):
@@ -385,8 +389,7 @@ def _querystr(self):
     def get(self):
         """Executes this Query and returns the results.
 
-        The results will be returned as a sorted list or an OrderedDict, except in the case of
-        order-by-priority queries.
+        The results will be returned as a sorted list or an OrderedDict.
 
         Returns:
           object: Decoded JSON result of the Query.
@@ -551,7 +554,7 @@ def __init__(self, **kwargs):
         Keyword Args:
           url: Firebase Realtime Database URL.
           auth: An instance of requests.auth.AuthBase for authenticating outgoing HTTP requests.
-          session: An HTTP session created using the the requests module.
+          session: An HTTP session created using the requests module.
           auth_override: A dictionary representing auth variable overrides or None (optional).
               Defaults to empty dict, which provides admin privileges. A None value here provides
               un-authenticated guest privileges.
@@ -587,8 +590,11 @@ def from_app(cls, app):
         if auth_override is not None and not isinstance(auth_override, dict):
             raise ValueError('Invalid databaseAuthVariableOverride option: "{0}". Override '
                              'value must be a dict or None.'.format(auth_override))
+
+        session = requests.Session()
+        session.headers.update({'User-Agent': _USER_AGENT})
         return _Client(url='https://{0}'.format(parsed.netloc), auth=_OAuth(app),
-                       session=requests.Session(), auth_override=auth_override)
+                       session=session, auth_override=auth_override)
 
     def request(self, method, urlpath, **kwargs):
         return self._do_request(method, urlpath, **kwargs).json()

tests/test_db.py

@@ -16,6 +16,7 @@
 import collections
 import datetime
 import json
+import sys
 
 import pytest
 from requests import adapters
@@ -148,6 +149,7 @@ def test_get_value(self, data):
         assert recorder[0].method == 'GET'
         assert recorder[0].url == 'https://test.firebaseio.com/test.json'
         assert recorder[0].headers['Authorization'] == 'Bearer mock-token'
+        assert recorder[0].headers['User-Agent'] == db._USER_AGENT
 
     @pytest.mark.parametrize('data', valid_values)
     def test_order_by_query(self, data):
@@ -233,7 +235,7 @@ def test_update_children_default(self):
         assert len(recorder) is 0
 
     @pytest.mark.parametrize('update', [
-        None, {}, {None:'foo'}, {'foo': None}, '', 'foo', 0, 1, list(), tuple()
+        None, {}, {None:'foo'}, {'foo': None}, '', 'foo', 0, 1, list(), tuple(), _Object()
     ])
     def test_set_invalid_update(self, update):
         ref = db.reference('/test')
@@ -253,6 +255,7 @@ def test_push(self, data):
         assert recorder[0].url == 'https://test.firebaseio.com/test.json'
         assert json.loads(recorder[0].body.decode()) == data
         assert recorder[0].headers['Authorization'] == 'Bearer mock-token'
+        assert recorder[0].headers['User-Agent'] == db._USER_AGENT
 
     def test_push_default(self):
         ref = db.reference('/test')
@@ -263,6 +266,7 @@ def test_push_default(self):
         assert recorder[0].url == 'https://test.firebaseio.com/test.json'
         assert json.loads(recorder[0].body.decode()) == ''
         assert recorder[0].headers['Authorization'] == 'Bearer mock-token'
+        assert recorder[0].headers['User-Agent'] == db._USER_AGENT
 
     def test_push_none_value(self):
         ref = db.reference('/test')
@@ -278,6 +282,7 @@ def test_delete(self):
         assert recorder[0].method == 'DELETE'
         assert recorder[0].url == 'https://test.firebaseio.com/test.json'
         assert recorder[0].headers['Authorization'] == 'Bearer mock-token'
+        assert recorder[0].headers['User-Agent'] == db._USER_AGENT
 
     def test_get_root_reference(self):
         ref = db.reference()
@@ -344,6 +349,7 @@ def test_get_value(self):
         assert recorder[0].method == 'GET'
         assert recorder[0].url == 'https://test.firebaseio.com/test.json?' + query_str
         assert recorder[0].headers['Authorization'] == 'Bearer mock-token'
+        assert recorder[0].headers['User-Agent'] == db._USER_AGENT
 
     def test_set_value(self):
         ref = db.reference('/test')
@@ -356,6 +362,7 @@ def test_set_value(self):
         assert recorder[0].url == 'https://test.firebaseio.com/test.json?' + query_str
         assert json.loads(recorder[0].body.decode()) == data
         assert recorder[0].headers['Authorization'] == 'Bearer mock-token'
+        assert recorder[0].headers['User-Agent'] == db._USER_AGENT
 
     def test_order_by_query(self):
         ref = db.reference('/test')
@@ -367,6 +374,7 @@ def test_order_by_query(self):
         assert recorder[0].method == 'GET'
         assert recorder[0].url == 'https://test.firebaseio.com/test.json?' + query_str
         assert recorder[0].headers['Authorization'] == 'Bearer mock-token'
+        assert recorder[0].headers['User-Agent'] == db._USER_AGENT
 
     def test_range_query(self):
         ref = db.reference('/test')
@@ -379,6 +387,7 @@ def test_range_query(self):
         assert recorder[0].method == 'GET'
         assert recorder[0].url == 'https://test.firebaseio.com/test.json?' + query_str
         assert recorder[0].headers['Authorization'] == 'Bearer mock-token'
+        assert recorder[0].headers['User-Agent'] == db._USER_AGENT
 
 
 class TestDatabseInitialization(object):
@@ -407,7 +416,7 @@ def test_valid_db_url(self, url):
 
     @pytest.mark.parametrize('url', [
         None, '', 'foo', 'http://test.firebaseio.com', 'https://google.com',
-        True, False, 1, 0, dict(), list(), tuple(),
+        True, False, 1, 0, dict(), list(), tuple(), _Object()
     ])
     def test_invalid_db_url(self, url):
         firebase_admin.initialize_app(credentials.Base(), {'databaseURL' : url})
@@ -428,7 +437,8 @@ def test_valid_auth_override(self, override):
             encoded = json.dumps(override, separators=(',', ':'))
             assert ref._client._auth_override == 'auth_variable_override={0}'.format(encoded)
 
-    @pytest.mark.parametrize('override', ['', 'foo', 0, 1, True, False, list(), tuple()])
+    @pytest.mark.parametrize('override', [
+        '', 'foo', 0, 1, True, False, list(), tuple(), _Object()])
     def test_invalid_auth_override(self, override):
         firebase_admin.initialize_app(credentials.Base(), {
             'databaseURL' : 'https://test.firebaseio.com',
@@ -448,6 +458,11 @@ def test_app_delete(self):
         with pytest.raises(ValueError):
             db.reference()
 
+    def test_user_agent_format(self):
+        expected = 'Firebase/HTTP/{0}/{1}.{2}/AdminPython'.format(
+            firebase_admin.__version__, sys.version_info.major, sys.version_info.minor)
+        assert db._USER_AGENT == expected
+
 
 @pytest.fixture(params=['foo', '$key', '$value'])
 def initquery(request):
@@ -472,7 +487,7 @@ class TestQuery(object):
     ref = db.Reference(path='foo')
 
     @pytest.mark.parametrize('path', [
-        '', None, '/', '/foo', 0, 1, True, False, dict(), list(), tuple(),
+        '', None, '/', '/foo', 0, 1, True, False, dict(), list(), tuple(), _Object(),
         '$foo', '.foo', '#foo', '[foo', 'foo]', '$key', '$value', '$priority'
     ])
     def test_invalid_path(self, path):
@@ -519,7 +534,7 @@ def test_multiple_limits(self):
         with pytest.raises(ValueError):
             query.limit_to_first(1)
 
-    @pytest.mark.parametrize('limit', [None, -1, 'foo', 1.2, list(), dict(), tuple()])
+    @pytest.mark.parametrize('limit', [None, -1, 'foo', 1.2, list(), dict(), tuple(), _Object()])
     def test_invalid_limit(self, limit):
         query = self.ref.order_by_child('foo')
         with pytest.raises(ValueError):