Add snippets to the admin repo (firebase#130)

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

snippets/auth/get_service_account_tokens.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)

snippets/auth/index.py

@@ -0,0 +1,309 @@
+# Copyright 2018 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.
+
+import sys
+# [START import_sdk]
+import firebase_admin
+# [END import_sdk]
+from firebase_admin import credentials
+from firebase_admin import auth
+
+sys.path.append("lib")
+
+def initialize_sdk_with_service_account():
+    # [START initialize_sdk_with_service_account]
+    import firebase_admin
+    from firebase_admin import credentials
+
+    cred = credentials.Certificate('path/to/serviceAccountKey.json')
+    default_app = firebase_admin.initialize_app(cred)
+    # [END initialize_sdk_with_service_account]
+    firebase_admin.delete_app(default_app)
+
+def initialize_sdk_with_application_default():
+    # [START initialize_sdk_with_application_default]
+    default_app = firebase_admin.initialize_app()
+    # [END initialize_sdk_with_application_default]
+    firebase_admin.delete_app(default_app)
+
+def initialize_sdk_with_refresh_token():
+    # [START initialize_sdk_with_refresh_token]
+    cred = credentials.RefreshToken('path/to/refreshToken.json')
+    default_app = firebase_admin.initialize_app(cred)
+    # [END initialize_sdk_with_refresh_token]
+    firebase_admin.delete_app(default_app)
+
+def access_services_default():
+    cred = credentials.Certificate('path/to/service.json')
+    # [START access_services_default]
+    # Import the Firebase service
+    from firebase_admin import auth
+
+    # Initialize the default app
+    default_app = firebase_admin.initialize_app(cred)
+    print default_app.name  # "[DEFAULT]"
+
+    # Retrieve services via the auth package...
+    # auth.create_custom_token(...)
+    # [END access_services_default]
+    firebase_admin.delete_app(default_app)
+
+def access_services_nondefault():
+    cred = credentials.Certificate('path/to/service.json')
+    other_cred = credentials.Certificate('path/to/other_service.json')
+
+    # [START access_services_nondefault]
+    # Initialize the default app
+    default_app = firebase_admin.initialize_app(cred)
+
+    #  Initialize another app with a different config
+    other_app = firebase_admin.initialize_app(cred, name='other')
+
+    print default_app.name    # "[DEFAULT]"
+    print other_app.name      # "other"
+
+    # Retrieve default services via the auth package...
+    # auth.create_custom_token(...)
+
+    # Use the `app` argument to retrieve the other app's services
+    # auth.create_custom_token(..., app=other_app)
+    # [END access_services_nondefault]
+    firebase_admin.delete_app(default_app)
+    firebase_admin.delete_app(other_app)
+
+def create_token_uid():
+    cred = credentials.Certificate('path/to/service.json')
+    default_app = firebase_admin.initialize_app(cred)
+    # [START create_token_uid]
+    uid = 'some-uid'
+
+    custom_token = auth.create_custom_token(uid)
+    # [END create_token_uid]
+    firebase_admin.delete_app(default_app)
+    return custom_token
+
+def create_token_with_claims():
+    cred = credentials.Certificate('path/to/service.json')
+    default_app = firebase_admin.initialize_app(cred)
+    # [START create_token_with_claims]
+    uid = 'some-uid'
+    additional_claims = {
+        'premiumAccount': True
+    }
+
+    custom_token = auth.create_custom_token(uid, additional_claims)
+    # [END create_token_with_claims]
+    firebase_admin.delete_app(default_app)
+    return custom_token
+
+def verify_token_uid(id_token):
+    cred = credentials.Certificate('path/to/service.json')
+    default_app = firebase_admin.initialize_app(cred)
+    # [START verify_token_uid]
+    # id_token comes from the client app (shown above)
+
+    decoded_token = auth.verify_id_token(id_token)
+    uid = decoded_token['uid']
+    # [END verify_token_uid]
+    print uid
+    firebase_admin.delete_app(default_app)
+
+def verify_token_uid_check_revoke(id_token):
+    cred = credentials.Certificate('path/to/service.json')
+    default_app = firebase_admin.initialize_app(cred)
+    # [START verify_token_id_check_revoked]
+    try:
+        # Verify the ID token while checking if the token is revoked by
+        # passing check_revoked=True.
+        decoded_token = auth.verify_id_token(id_token, check_revoked=True)
+        # Token is valid and not revoked.
+        uid = decoded_token['uid']
+    except auth.AuthError as exc:
+        if exc.code == 'ID_TOKEN_REVOKED':
+            # Token revoked, inform the user to reauthenticate or signOut().
+            pass
+        else:
+            # Token is invalid
+            pass
+    # [END verify_token_id_check_revoked]
+    firebase_admin.delete_app(default_app)
+    return uid
+
+def revoke_refresh_token_uid():
+    cred = credentials.Certificate('path/to/service.json')
+    default_app = firebase_admin.initialize_app(cred)
+    # [START revoke_tokens]
+    # Revoke tokens on the backend.
+    auth.revoke_refresh_tokens(uid)
+    user = auth.get_user(uid)
+    # Convert to seconds as the auth_time in the token claims is in seconds.
+    revocation_second = user.tokens_valid_after_timestamp / 1000
+    print 'Tokens revoked at: {0}'.format(revocation_second)
+    # [END revoke_tokens]
+    # [START save_revocation_in_db]
+    metadata_ref = firebase_admin.db.reference("metadata/" + uid)
+    metadata_ref.set({'revokeTime': revocation_second})
+    # [END save_revocation_in_db]
+    print uid
+    firebase_admin.delete_app(default_app)
+
+def get_user(uid):
+    # [START get_user]
+    from firebase_admin import auth
+
+    user = auth.get_user(uid)
+    print 'Successfully fetched user data: {0}'.format(user.uid)
+    # [END get_user]
+
+def get_user_by_email():
+    email = 'user@example.com'
+    # [START get_user_by_email]
+    from firebase_admin import auth
+
+    user = auth.get_user_by_email(email)
+    print 'Successfully fetched user data: {0}'.format(user.uid)
+    # [END get_user_by_email]
+
+def get_user_by_phone_number():
+    phone = '+1 555 555 0100'
+    # [START get_user_by_phone]
+    from firebase_admin import auth
+
+    user = auth.get_user_by_phone_number(phone)
+    print 'Successfully fetched user data: {0}'.format(user.uid)
+    # [END get_user_by_phone]
+
+def create_user():
+    # [START create_user]
+    user = auth.create_user(
+        email='user@example.com',
+        email_verified=False,
+        phone_number='+15555550100',
+        password='secretPassword',
+        display_name='John Doe',
+        photo_url='http://www.example.com/12345678/photo.png',
+        disabled=False)
+    print 'Sucessfully created new user: {0}'.format(user.uid)
+    # [END create_user]
+    return user.uid
+
+def create_user_with_id():
+    # [START create_user_with_id]
+    user = auth.create_user(
+        uid='some-uid', email='user@example.com', phone_number='+15555550100')
+    print 'Sucessfully created new user: {0}'.format(user.uid)
+    # [END create_user_with_id]
+
+def update_user(uid):
+    # [START update_user]
+    user = auth.update_user(
+        uid,
+        email='user@example.com',
+        phone_number='+15555550100',
+        email_verified=True,
+        password='newPassword',
+        display_name='John Doe',
+        photo_url='http://www.example.com/12345678/photo.png',
+        disabled=True)
+    print 'Sucessfully updated user: {0}'.format(user.uid)
+    # [END update_user]
+
+def delete_user(uid):
+    # [START delete_user]
+    auth.delete_user(uid)
+    print 'Successfully deleted user'
+    # [END delete_user]
+
+def set_custom_user_claims(uid):
+    # [START set_custom_user_claims]
+    # Set admin privilege on the user corresponding to uid.
+    auth.set_custom_user_claims(uid, {'admin': True})
+    # The new custom claims will propagate to the user's ID token the
+    # next time a new one is issued.
+    # [END set_custom_user_claims]
+
+    id_token = 'id_token'
+    # [START verify_custom_claims]
+    # Verify the ID token first.
+    claims = auth.verify_id_token(id_token)
+    if claims['admin'] is True:
+        # Allow access to requested admin resource.
+        pass
+    # [END verify_custom_claims]
+
+    # [START read_custom_user_claims]
+    # Lookup the user associated with the specified uid.
+    user = auth.get_user(uid)
+    # The claims can be accessed on the user record.
+    print user.custom_claims.get('admin')
+    # [END read_custom_user_claims]
+
+def set_custom_user_claims_script():
+    # [START set_custom_user_claims_script]
+    user = auth.get_user_by_email('user@admin.example.com')
+    # Confirm user is verified
+    if user.email_verified:
+        # Add custom claims for additional privileges.
+        # This will be picked up by the user on token refresh or next sign in on new device.
+        auth.set_custom_user_claims(user.uid, {
+            'admin': True
+        })
+    # [END set_custom_user_claims_script]
+
+def set_custom_user_claims_incremental():
+    # [START set_custom_user_claims_incremental]
+    user = auth.get_user_by_email('user@admin.example.com')
+    # Add incremental custom claim without overwriting existing claims.
+    current_custom_claims = user.custom_claims
+    if current_custom_claims.get('admin'):
+        # Add level.
+        current_custom_claims['accessLevel'] = 10
+        # Add custom claims for additional privileges.
+        auth.set_custom_user_claims(user.uid, current_custom_claims)
+    # [END set_custom_user_claims_incremental]
+
+def list_all_users():
+    # [START list_all_users]
+    # Start listing users from the beginning, 1000 at a time.
+    page = auth.list_users()
+    while page:
+        for user in page.users:
+            print 'User: ' + user.uid
+        # Get next batch of users.
+        page = page.get_next_page()
+
+    # Iterate through all users. This will still retrieve users in batches,
+    # buffering no more than 1000 users in memory at a time.
+    for user in auth.list_users().iterate_all():
+        print 'User: ' + user.uid
+    # [END list_all_users]
+
+initialize_sdk_with_service_account()
+initialize_sdk_with_application_default()
+#initialize_sdk_with_refresh_token()
+access_services_default()
+access_services_nondefault()
+create_token_uid()
+token_with_claims = create_token_with_claims()
+#verify_token_uid()
+
+uid = create_user()
+create_user_with_id()
+get_user(uid)
+get_user_by_email()
+get_user_by_phone_number()
+update_user(uid)
+set_custom_user_claims(uid)
+list_all_users()
+delete_user(uid)