Merge branch 'remote-config-versions'

Change-Id: Id10297670b17ba82251e1b98ec5d1c2ea506cdfc

Author: kroikie

config/README.md

@@ -1,8 +1,8 @@
 Firebase Remote Config REST API Python Quickstart
 ===============================================
 
-The Firebase Remote Config Python quickstart app demonstrates retrieving and
-updating the Firebase Remote Config template.
+The [Firebase Remote Config](https://firebase.google.com/docs/remote-config/) Python quickstart
+app demonstrates retrieving and updating the Firebase Remote Config template.
 
 Introduction
 ------------
@@ -21,10 +21,11 @@ Getting started
 Run
 ---
 
-- From the `config` directory run `python configure.py --action=get` to retrieve the template.
-  - The returned template is stored in a file named `config.json`.
-  - Note the Etag printed to the console you will need to use it when publishing template updates.
-- Update the template.
+- Get active template
+  - From the `config` directory run `python configure.py --action=get` to retrieve the template.
+    - The returned template is stored in a file named `config.json`.
+    - Note the Etag printed to the console you will need to use it when publishing template updates.
+- Update the template
   - If your template already has parameters, adjust one or more of the values.
   - If your template is empty, update it to look like this:
 
@@ -58,28 +59,50 @@ Run
           }
         }
 
-- From the `config` directory run `python configure.py --action=publish --etag=<LATEST_ETAG>` to update the template.
-  - Be sure to set the etag to the one that was last printed in the console.
-- Confirm in the console that the template has been updated.
-  - At this point mobile clients can fetch the updated values.
+  - From the `config` directory run `python configure.py --action=publish --etag=<LATEST_ETAG>` to update the template.
+    - Be sure to set the etag to the one that was last printed in the console.
+  - Confirm in the console that the template has been updated.
+    - At this point mobile clients can fetch the updated values.
+- View existing versions
+  - From the `config` directory run `python configure.py --action=versions` to print the
+    last 5 template versions.
+- Roll back to an existing template
+  - From the `config` directory run `python configure.py --action=rollback --version=<TEMPLATE_VERSION_NUMBER>` to
+    activate the template with the matching version number. 
 
 Best practices
 --------------
 
 This section provides some additional information about how the Remote Config
 REST API should be used when retrieving and updating templates.
 
-### Etags ###
+### [Versions](https://firebase.google.com/docs/remote-config/templates) ###
 
-Eath time the Remote Config template is retrieved an Etag is included. This Etag is a
+Each time you update parameters, {{remote_config}} creates a
+new versioned {{remote_config}} template and stores the previous template as
+a version that you can retrieve or roll back to as needed.
+
+All non-active versions expire and are removed if they are older than 90 days or if
+there are more than 300 newer template versions. Since template versions expire, any
+versions that need to be retrieved later on should be persisted externally.
+
+Use the `listVersions` [query parameters](https://firebase.google.com/docs/reference/remote-config/rest/v1/projects.remoteConfig/listVersions#query-parameters)
+to filter the versions that are returned.
+
+### ETags ###
+
+Each time the Remote Config template it retrieved an ETag is included. This ETag is a
 unique identifier of the current template on the server. When submitting updates
-to the template you must include the latest Etag to ensure that your updates are consistent.
+to the template you must include the latest ETag to ensure that your updates are consistent.
 
 In the event that you want to completely overwrite the server's template use
-an Etag of "\*". Use this with caution since this operation cannot be undone.
+an ETag of "\*". Use this with caution since this operation cannot be undone.
+
+**NOTE:** To get the ETag your request must accept the gzip encoding. Add the header
+`Accept-Encoding: gzip` to receive the ETag in the response header `ETag`.
 
 Support
 -------
 
-- [Stack Overflow](https://stackoverflow.com/questions/tagged/firebase-cloud-messaging)
+- [Stack Overflow](https://stackoverflow.com/questions/tagged/firebase-remote-config)
 - [Firebase Support](https://firebase.google.com/support/)

config/configure.py

@@ -5,7 +5,7 @@
 from oauth2client.service_account import ServiceAccountCredentials
 
 
-PROJECT_ID = '<PROJECT_ID>'
+PROJECT_ID = 'PROJECT_ID'
 BASE_URL = 'https://firebaseremoteconfig.googleapis.com'
 REMOTE_CONFIG_ENDPOINT = 'v1/projects/' + PROJECT_ID + '/remoteConfig'
 REMOTE_CONFIG_URL = BASE_URL + '/' + REMOTE_CONFIG_ENDPOINT
@@ -44,6 +44,41 @@ def _get():
     print('Unable to get template')
     print(resp.text)
 
+def _listVersions():
+  """Print the last 5 Remote Config version's metadata."""
+  headers = {
+    'Authorization': 'Bearer ' + _get_access_token()
+  }
+  resp = requests.get(REMOTE_CONFIG_URL + ':listVersions?pageSize=5', headers=headers)
+
+  if resp.status_code == 200:
+    print('Versions:')
+    print(resp.text)
+  else:
+    print('Request to print template versions failed.')
+    print(resp.text)
+
+def _rollback(version):
+  """Roll back to an available version of Firebase Remote Config template.
+
+  :param version: The version of the template to roll back to.
+  """
+  headers = {
+    'Authorization': 'Bearer ' + _get_access_token()
+  }
+
+  json = {
+    "version_number": version
+  }
+  resp = requests.post(REMOTE_CONFIG_URL + ':rollback', headers=headers, json=json)
+
+  if resp.status_code == 200:
+    print('Rolled back to version: ' + version)
+    print(resp.text)
+    print('ETag from server: {}'.format(resp.headers['ETag']))
+  else:
+    print('Request to roll back to version ' + version + ' failed.')
+    print(resp.text)
 
 def _publish(etag):
   """Publish local template to Firebase server.
@@ -72,16 +107,23 @@ def main():
   parser = argparse.ArgumentParser()
   parser.add_argument('--action')
   parser.add_argument('--etag')
+  parser.add_argument('--version')
   args = parser.parse_args()
 
   if args.action and args.action == 'get':
     _get()
   elif args.action and args.action == 'publish' and args.etag:
     _publish(args.etag)
+  elif args.action and args.action == 'versions':
+    _listVersions()
+  elif args.action and args.action == 'rollback' and args.version:
+    _rollback(args.version)
   else:
     print('''Invalid command. Please use one of the following commands:
 python configure.py --action=get
-python configure.py --action=publish --etag=<LATEST_ETAG>''')
+python configure.py --action=publish --etag=<LATEST_ETAG>
+python configure.py --action=versions
+python configure.py --action=rollback --version=<TEMPLATE_VERSION_NUMBER>''')