Merged with master

Author: hiranya911

.travis.yml

@@ -5,10 +5,20 @@ python:
   - "3.5"
   - "3.6"
   - "pypy3.5"
-# command to install dependencies
-install: "pip install -r requirements.txt"
-before_script: 
-  - export PY_VERSION=`python -c 'import sys; print sys.version_info.major'`
-  - if [[ "$PY_VERSION" == '2' ]]; then ./lint.sh all; fi
-# command to run tests
-script: pytest
+
+jobs:
+  include:
+    - name: "Lint"
+      python: "2.7"
+      script: ./lint.sh all
+
+before_install:
+  - nvm install 8 && npm install -g firebase-tools
+script:
+  - pytest
+  - firebase emulators:exec --only database --project fake-project-id 'pytest integration/test_db.py'
+cache:
+  pip: true
+  npm: true
+  directories:
+  - $HOME/.cache/firebase/emulators

CONTRIBUTING.md

@@ -195,6 +195,18 @@ Now you can invoke the integration test suite as follows:
 pytest integration/ --cert scripts/cert.json --apikey scripts/apikey.txt
 ```
 
+### Emulator-based Integration Testing
+
+Some integration tests can run against emulators. This allows local testing
+without using real projects or credentials. For now, only the RTDB Emulator
+is supported.
+
+First, install the Firebase CLI, then run:
+
+```
+firebase emulators:exec --only database --project fake-project-id 'pytest integration/test_db.py'
+```
+
 ### Test Coverage
 
 To review the test coverage, run `pytest` with the `--cov` flag. To view a detailed line by line

firebase_admin/__init__.py

@@ -215,39 +215,15 @@ def __init__(self, name, credential, options):
         self._options = _AppOptions(options)
         self._lock = threading.RLock()
         self._services = {}
-        self._project_id = App._lookup_project_id(self._credential, self._options)
 
-    @classmethod
-    def _lookup_project_id(cls, credential, options):
-        """Looks up the Firebase project ID associated with an App.
-
-        This method first inspects the app options for a ``projectId`` entry. Then it attempts to
-        get the project ID from the credential used to initialize the app. If that also fails,
-        attempts to look up the ``GOOGLE_CLOUD_PROJECT`` and ``GCLOUD_PROJECT`` environment
-        variables.
-
-        Args:
-            credential: A Firebase credential instance.
-            options: A Firebase AppOptions instance.
-
-        Returns:
-            str: A project ID string or None.
+        App._validate_project_id(self._options.get('projectId'))
+        self._project_id_initialized = False
 
-        Raises:
-            ValueError: If a non-string project ID value is specified.
-        """
-        project_id = options.get('projectId')
-        if not project_id:
-            try:
-                project_id = credential.project_id
-            except AttributeError:
-                pass
-        if not project_id:
-            project_id = os.environ.get('GOOGLE_CLOUD_PROJECT', os.environ.get('GCLOUD_PROJECT'))
+    @classmethod
+    def _validate_project_id(cls, project_id):
         if project_id is not None and not isinstance(project_id, six.string_types):
             raise ValueError(
                 'Invalid project ID: "{0}". project ID must be a string.'.format(project_id))
-        return project_id
 
     @property
     def name(self):
@@ -263,8 +239,34 @@ def options(self):
 
     @property
     def project_id(self):
+        if not self._project_id_initialized:
+            self._project_id = self._lookup_project_id()
+            self._project_id_initialized = True
         return self._project_id
 
+    def _lookup_project_id(self):
+        """Looks up the Firebase project ID associated with an App.
+
+        If a ``projectId`` is specified in app options, it is returned. Then tries to
+        get the project ID from the credential used to initialize the app. If that also fails,
+        attempts to look up the ``GOOGLE_CLOUD_PROJECT`` and ``GCLOUD_PROJECT`` environment
+        variables.
+
+        Returns:
+            str: A project ID string or None.
+        """
+        project_id = self._options.get('projectId')
+        if not project_id:
+            try:
+                project_id = self._credential.project_id
+            except AttributeError:
+                pass
+        if not project_id:
+            project_id = os.environ.get('GOOGLE_CLOUD_PROJECT',
+                                        os.environ.get('GCLOUD_PROJECT'))
+        App._validate_project_id(self._options.get('projectId'))
+        return project_id
+
     def _get_service(self, name, initializer):
         """Returns the service instance identified by the given name.
 

firebase_admin/_messaging_utils.py

@@ -38,19 +38,21 @@ class Message(object):
         android: An instance of ``messaging.AndroidConfig`` (optional).
         webpush: An instance of ``messaging.WebpushConfig`` (optional).
         apns: An instance of ``messaging.ApnsConfig`` (optional).
+        fcm_options: An instance of ``messaging.FcmOptions`` (optional).
         token: The registration token of the device to which the message should be sent (optional).
         topic: Name of the FCM topic to which the message should be sent (optional). Topic name
             may contain the ``/topics/`` prefix.
         condition: The FCM condition to which the message should be sent (optional).
     """
 
     def __init__(self, data=None, notification=None, android=None, webpush=None, apns=None,
-                 token=None, topic=None, condition=None):
+                 fcm_options=None, token=None, topic=None, condition=None):
         self.data = data
         self.notification = notification
         self.android = android
         self.webpush = webpush
         self.apns = apns
+        self.fcm_options = fcm_options
         self.token = token
         self.topic = topic
         self.condition = condition
@@ -67,8 +69,10 @@ class MulticastMessage(object):
         android: An instance of ``messaging.AndroidConfig`` (optional).
         webpush: An instance of ``messaging.WebpushConfig`` (optional).
         apns: An instance of ``messaging.ApnsConfig`` (optional).
+        fcm_options: An instance of ``messaging.FcmOptions`` (optional).
     """
-    def __init__(self, tokens, data=None, notification=None, android=None, webpush=None, apns=None):
+    def __init__(self, tokens, data=None, notification=None, android=None, webpush=None, apns=None,
+                 fcm_options=None):
         _Validators.check_string_list('MulticastMessage.tokens', tokens)
         if len(tokens) > 100:
             raise ValueError('MulticastMessage.tokens must not contain more than 100 tokens.')
@@ -78,6 +82,7 @@ def __init__(self, tokens, data=None, notification=None, android=None, webpush=N
         self.android = android
         self.webpush = webpush
         self.apns = apns
+        self.fcm_options = fcm_options
 
 
 class Notification(object):
@@ -109,16 +114,18 @@ class AndroidConfig(object):
         data: A dictionary of data fields (optional). All keys and values in the dictionary must be
             strings. When specified, overrides any data fields set via ``Message.data``.
         notification: A ``messaging.AndroidNotification`` to be included in the message (optional).
+        fcm_options: A ``messaging.AndroidFcmOptions`` to be included in the message (optional).
     """
 
     def __init__(self, collapse_key=None, priority=None, ttl=None, restricted_package_name=None,
-                 data=None, notification=None):
+                 data=None, notification=None, fcm_options=None):
         self.collapse_key = collapse_key
         self.priority = priority
         self.ttl = ttl
         self.restricted_package_name = restricted_package_name
         self.data = data
         self.notification = notification
+        self.fcm_options = fcm_options
 
 
 class AndroidNotification(object):
@@ -167,6 +174,18 @@ def __init__(self, title=None, body=None, icon=None, color=None, sound=None, tag
         self.channel_id = channel_id
 
 
+class AndroidFcmOptions(object):
+    """Options for features provided by the FCM SDK for Android.
+
+    Args:
+        analytics_label: contains additional options for features provided by the FCM Android SDK
+            (optional).
+    """
+
+    def __init__(self, analytics_label=None):
+        self.analytics_label = analytics_label
+
+
 class WebpushConfig(object):
     """Webpush-specific options that can be included in a message.
 
@@ -281,14 +300,17 @@ class APNSConfig(object):
     Args:
         headers: A dictionary of headers (optional).
         payload: A ``messaging.APNSPayload`` to be included in the message (optional).
+        fcm_options: A ``messaging.APNSFcmOptions`` instance to be included in the message
+            (optional).
 
     .. _APNS Documentation: https://developer.apple.com/library/content/documentation\
         /NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html
     """
 
-    def __init__(self, headers=None, payload=None):
+    def __init__(self, headers=None, payload=None, fcm_options=None):
         self.headers = headers
         self.payload = payload
+        self.fcm_options = fcm_options
 
 
 class APNSPayload(object):
@@ -389,6 +411,29 @@ def __init__(self, title=None, subtitle=None, body=None, loc_key=None, loc_args=
         self.launch_image = launch_image
 
 
+class APNSFcmOptions(object):
+    """Options for features provided by the FCM SDK for iOS.
+
+    Args:
+        analytics_label: contains additional options for features provided by the FCM iOS SDK
+            (optional).
+    """
+
+    def __init__(self, analytics_label=None):
+        self.analytics_label = analytics_label
+
+
+class FcmOptions(object):
+    """Options for features provided by SDK.
+
+    Args:
+        analytics_label: contains additional options to use across all platforms (optional).
+    """
+
+    def __init__(self, analytics_label=None):
+        self.analytics_label = analytics_label
+
+
 class _Validators(object):
     """A collection of data validation utilities.
 
@@ -444,6 +489,14 @@ def check_string_list(cls, label, value):
             raise ValueError('{0} must not contain non-string values.'.format(label))
         return value
 
+    @classmethod
+    def check_analytics_label(cls, label, value):
+        """Checks if the given value is a valid analytics label."""
+        value = _Validators.check_string(label, value)
+        if value is not None and not re.match(r'^[a-zA-Z0-9-_.~%]{1,50}$', value):
+            raise ValueError('Malformed {}.'.format(label))
+        return value
+
 
 class MessageEncoder(json.JSONEncoder):
     """A custom JSONEncoder implementation for serializing Message instances into JSON."""
@@ -470,13 +523,29 @@ def encode_android(cls, android):
             'restricted_package_name': _Validators.check_string(
                 'AndroidConfig.restricted_package_name', android.restricted_package_name),
             'ttl': cls.encode_ttl(android.ttl),
+            'fcm_options': cls.encode_android_fcm_options(android.fcm_options),
         }
         result = cls.remove_null_values(result)
         priority = result.get('priority')
         if priority and priority not in ('high', 'normal'):
             raise ValueError('AndroidConfig.priority must be "high" or "normal".')
         return result
 
+    @classmethod
+    def encode_android_fcm_options(cls, fcm_options):
+        """Encodes a AndroidFcmOptions instance into a json."""
+        if fcm_options is None:
+            return None
+        if not isinstance(fcm_options, AndroidFcmOptions):
+            raise ValueError('AndroidConfig.fcm_options must be an instance of '
+                             'AndroidFcmOptions class.')
+        result = {
+            'analytics_label': _Validators.check_analytics_label(
+                'AndroidFcmOptions.analytics_label', fcm_options.analytics_label),
+        }
+        result = cls.remove_null_values(result)
+        return result
+
     @classmethod
     def encode_ttl(cls, ttl):
         """Encodes a AndroidConfig TTL duration into a string."""
@@ -555,7 +624,7 @@ def encode_webpush(cls, webpush):
             'headers': _Validators.check_string_dict(
                 'WebpushConfig.headers', webpush.headers),
             'notification': cls.encode_webpush_notification(webpush.notification),
-            'fcmOptions': cls.encode_webpush_fcm_options(webpush.fcm_options),
+            'fcm_options': cls.encode_webpush_fcm_options(webpush.fcm_options),
         }
         return cls.remove_null_values(result)
 
@@ -655,6 +724,7 @@ def encode_apns(cls, apns):
             'headers': _Validators.check_string_dict(
                 'APNSConfig.headers', apns.headers),
             'payload': cls.encode_apns_payload(apns.payload),
+            'fcm_options': cls.encode_apns_fcm_options(apns.fcm_options),
         }
         return cls.remove_null_values(result)
 
@@ -672,6 +742,20 @@ def encode_apns_payload(cls, payload):
             result[key] = value
         return cls.remove_null_values(result)
 
+    @classmethod
+    def encode_apns_fcm_options(cls, fcm_options):
+        """Encodes an APNSFcmOptions instance into JSON."""
+        if fcm_options is None:
+            return None
+        if not isinstance(fcm_options, APNSFcmOptions):
+            raise ValueError('APNSConfig.fcm_options must be an instance of APNSFcmOptions class.')
+        result = {
+            'analytics_label': _Validators.check_analytics_label(
+                'APNSFcmOptions.analytics_label', fcm_options.analytics_label),
+        }
+        result = cls.remove_null_values(result)
+        return result
+
     @classmethod
     def encode_aps(cls, aps):
         """Encodes an Aps instance into JSON."""
@@ -792,6 +876,7 @@ def default(self, obj): # pylint: disable=method-hidden
             'token': _Validators.check_string('Message.token', obj.token, non_empty=True),
             'topic': _Validators.check_string('Message.topic', obj.topic, non_empty=True),
             'webpush': MessageEncoder.encode_webpush(obj.webpush),
+            'fcm_options': MessageEncoder.encode_fcm_options(obj.fcm_options),
         }
         result['topic'] = MessageEncoder.sanitize_topic_name(result.get('topic'))
         result = MessageEncoder.remove_null_values(result)
@@ -800,6 +885,20 @@ def default(self, obj): # pylint: disable=method-hidden
             raise ValueError('Exactly one of token, topic or condition must be specified.')
         return result
 
+    @classmethod
+    def encode_fcm_options(cls, fcm_options):
+        """Encodes an FcmOptions instance into JSON."""
+        if fcm_options is None:
+            return None
+        if not isinstance(fcm_options, FcmOptions):
+            raise ValueError('Message.fcm_options must be an instance of FcmOptions class.')
+        result = {
+            'analytics_label': _Validators.check_analytics_label(
+                'FcmOptions.analytics_label', fcm_options.analytics_label),
+        }
+        result = cls.remove_null_values(result)
+        return result
+
 
 class ThirdPartyAuthError(exceptions.UnauthenticatedError):
     """APNs certificate or web push auth key was invalid or missing."""