Merge pull request firebase#2 from carsongee/feature/setup_deps

Feature/setup deps

Author: carsongee

.gitignore

@@ -9,3 +9,5 @@ dist/
 *~
 scripts/cert.json
 scripts/apikey.txt
+htmlcov/
+.pytest_cache/

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Unreleased
 
--
+- [changed] Improved error handling in FCM by mapping more server-side
+  errors to client-side error codes.
 
 # v2.9.0
 

firebase_admin/__about__.py

@@ -0,0 +1,21 @@
+# Copyright 2017 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""About information (version, etc) for Firebase Admin SDK."""
+
+__version__ = '2.9.0'
+__title__ = 'firebase_admin'
+__author__ = 'Firebase'
+__license__ = 'Apache License 2.0'
+__url__ = 'https://firebase.google.com/docs/admin/setup/'

firebase_admin/__init__.py

@@ -21,12 +21,9 @@
 import six
 
 from firebase_admin import credentials
+from firebase_admin.__about__ import __version__
 
 
-# Declaring module version as per https://www.python.org/dev/peps/pep-0396/#specification
-# Update this accordingly for each release.
-__version__ = '2.9.0'
-
 _apps = {}
 _apps_lock = threading.RLock()
 _clock = datetime.datetime.utcnow

firebase_admin/messaging.py

@@ -716,11 +716,18 @@ class _MessagingService(object):
     INTERNAL_ERROR = 'internal-error'
     UNKNOWN_ERROR = 'unknown-error'
     FCM_ERROR_CODES = {
-        'APNS_AUTH_ERROR': 'authentication-error',
+        # FCM v1 canonical error codes
+        'NOT_FOUND': 'registration-token-not-registered',
+        'PERMISSION_DENIED': 'mismatched-credential',
+        'RESOURCE_EXHAUSTED': 'message-rate-exceeded',
+        'UNAUTHENTICATED': 'invalid-apns-credentials',
+
+        # FCM v1 new error codes
+        'APNS_AUTH_ERROR': 'invalid-apns-credentials',
         'INTERNAL': INTERNAL_ERROR,
         'INVALID_ARGUMENT': 'invalid-argument',
         'QUOTA_EXCEEDED': 'message-rate-exceeded',
-        'SENDER_ID_MISMATCH': 'authentication-error',
+        'SENDER_ID_MISMATCH': 'mismatched-credential',
         'UNAVAILABLE': 'server-unavailable',
         'UNREGISTERED': 'registration-token-not-registered',
     }

lint.sh

@@ -32,10 +32,11 @@ set -o errexit
 set -o nounset
 
 SKIP_FOR_TESTS="redefined-outer-name,protected-access,missing-docstring,too-many-lines"
+SKIP_FOR_SNIPPETS="${SKIP_FOR_TESTS},reimported,unused-variable"
 
 if [[ "$#" -eq 1 && "$1" = "all" ]]
 then
-  CHECK_ALL=true  
+  CHECK_ALL=true
 elif [[ "$#" -eq  0 ]]
 then
   CHECK_ALL=false
@@ -49,8 +50,10 @@ then
   lintAllFiles "firebase_admin" ""
   lintAllFiles "tests" "$SKIP_FOR_TESTS"
   lintAllFiles "integration" "$SKIP_FOR_TESTS"
+  lintAllFiles "snippets" "$SKIP_FOR_SNIPPETS"
 else
   lintChangedFiles "firebase_admin" ""
   lintChangedFiles "tests" "$SKIP_FOR_TESTS"
   lintChangedFiles "integration" "$SKIP_FOR_TESTS"
+  lintChangedFiles "snippets" "$SKIP_FOR_SNIPPETS"
 fi

scripts/prepare_release.sh

@@ -55,9 +55,9 @@ if ! parseVersion "$VERSION"; then
     exit 1
 fi
 
-CUR_VERSION=$(grep "^__version__ =" ../firebase_admin/__init__.py | awk '{print $3}' | sed "s/'//g")
+CUR_VERSION=$(grep "^__version__ =" ../firebase_admin/__about__.py | awk '{print $3}' | sed "s/'//g")
 if [ -z "$CUR_VERSION" ]; then
-    echo "[ERROR] Failed to find the current version. Check firebase_admin/__init__.py for version declaration."
+    echo "[ERROR] Failed to find the current version. Check firebase_admin/__version__.py for version declaration."
     exit 1
 fi
 if ! parseVersion "$CUR_VERSION"; then
@@ -119,12 +119,12 @@ fi
 ##################################
 
 HOST=$(uname)
-echo "[INFO] Updating __init__.py and CHANGELOG.md"
+echo "[INFO] Updating __about__.py and CHANGELOG.md"
 if [ $HOST == "Darwin" ]; then
-    sed -i "" -e "s/__version__ = '$CUR_VERSION'/__version__ = '$VERSION'/" "../firebase_admin/__init__.py"
+    sed -i "" -e "s/__version__ = '$CUR_VERSION'/__version__ = '$VERSION'/" "../firebase_admin/__about__.py"
     sed -i "" -e "1 s/# Unreleased//" "../CHANGELOG.md"
 else
-    sed -i -e "s/__version__ = '$CUR_VERSION'/__version__ = '$VERSION'/" "../firebase_admin/__init__.py"
+    sed -i -e "s/__version__ = '$CUR_VERSION'/__version__ = '$VERSION'/" "../firebase_admin/__about__.py"
     sed -i -e "1 s/# Unreleased//" "../CHANGELOG.md"
 fi
 

setup.py

@@ -21,13 +21,18 @@
 from setuptools import find_packages
 from setuptools import setup
 
-import firebase_admin
-
 
 if sys.version_info < (2, 7):
     print('firebase_admin requires python2 version >= 2.7 or python3.', file=sys.stderr)
     sys.exit(1)
 
+# Read in the package meta data per recommendations from:
+# https://packaging.python.org/guides/single-sourcing-package-version/
+about_path = path.join(path.dirname(path.abspath(__file__)), 'firebase_admin', '__about__.py')
+about = {}
+with open(about_path) as fp:
+    exec(fp.read(), about)  # pylint: disable=exec-used
+
 
 long_description = ('The Firebase Admin Python SDK enables server-side (backend) Python developers '
                     'to integrate Firebase into their services and applications.')
@@ -43,16 +48,14 @@
     ':python_version<"3.4"': ('enum34>=1.0.4',),
 }
 
-version = firebase_admin.__version__
-
 setup(
-    name='firebase_admin',
-    version=version,
+    name=about['__title__'],
+    version=about['__version__'],
     description='Firebase Admin Python SDK',
     long_description=long_description,
-    url='https://firebase.google.com/docs/admin/setup/',
-    author='Firebase',
-    license='Apache License 2.0',
+    url=about['__url__'],
+    author=about['__author__'],
+    license=about['__license__'],
     keywords='firebase cloud development',
     extras_require=extras_require,
     install_requires=install_requires,

snippets/__init__.py

@@ -0,0 +1,27 @@
+# Copyright 2017 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# [START get_service_account_tokens]
+from firebase_admin import credentials
+
+cred = credentials.Certificate('path/to/serviceAccountKey.json')
+access_token_info = cred.get_access_token()
+
+access_token = access_token_info.access_token
+expiration_time = access_token_info.expiry
+# Attach access_token to HTTPS request in the "Authorization: Bearer" header
+# After expiration_time, you must generate a new access token
+# [END get_service_account_tokens]
+
+print 'The access token {} expires at {}'.format(access_token, expiration_time)