Clean up.

Author: agentphantom

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 Phantom App Development
+Copyright (c) 2017 Phantom App Development
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,7 +2,7 @@
 
 Firebase is a back end platform that offers several services to aid in the development of apps and games, specially the ones that rely on server side infrastructure.
 
-Some of its services can be accessed by using RESTful techniques. This repository contains detailed guides and [examples](./examples) explaining how to use those services in your `Adobe AIR ` projects.
+Some of its services can be accessed by using a RESTful approach. This repository contains detailed guides and [examples](./examples) explaining how to use those services in your `Adobe AIR ` projects.
 
 You won't need an `ANE` for these guides, all of them work only using `StageWebView`, `URLRequest` and `URLLoader`.
 

auth/README.md

@@ -206,7 +206,12 @@ Once you have the profile information you might want to save it on an Object tha
 ## Obtaining and Refreshing an Access Token
 
 By default the `access_token` has an expiration time of 60 minutes, you can reset its expiration by requesting a fresh one.
-To obtain or refresh an `access_token` you only need to provide a `refreshToken` from a Sign In request and specify the `grant_type` as `"refresh_token"`.
+To obtain or refresh an `access_token` you only need to provide the following parameters:
+
+Name | Description
+---|---
+`refreshToken` | A long encoded String that contains user information. You can obtain it from a Sign In request.
+`grant_type` | Set to: `refresh_token`
 
 ```actionscript
 private function refreshToken(refreshToken:String):void

auth/email/README.md

@@ -35,7 +35,13 @@ private function errorHandler(event:flash.events.IOErrorEvent):void
 
 ## Registering a New User (Sign Up)
 
-To register a new user you only require to provide a valid formatted Email Address and a non weak Password.
+To register a new user you only require to provide the following parameters:
+
+Name | Description
+---|---
+`email` | A valid formatted Email Address.
+`password` | A non weak Password.
+`returnSecureToken` | Set to: `true`
 
 ```actionscript
 private function register(email:String, password:String):void
@@ -84,7 +90,13 @@ The `refreshToken` is used to get an `access_token` for Auth requests. For more
 
 ## Verifying Credentials (Sign In)
 
-To sign in an user you only require to provide their valid Email Address and Password and the `returnSecureToken` parameter.
+To sign in an user you only require to provide the following parameters:
+
+Name | Description
+---|---
+`email` | The user's Email Address.
+`password` | The user's Password.
+`returnSecureToken` | Set to: `true`
 
 ```actionscript
 private function login(email:String, password:String):void
@@ -135,10 +147,12 @@ The `refreshToken` is used to get an `access_token` for Auth requests. For more
 
 ## Password Reset
 
-To reset a password you only require to provide 2 parameters:
+To reset a password you only require to provide the following parameters:
 
-* `email` is the Email Address you want to send the Password recovery email.
-* `requestType` with the value: `PASSWORD_RESET`
+Name | Description
+---|---
+`email` | The Email Address you want to send the Password recovery email.
+`requestType` | Set to: `PASSWORD_RESET`
 
 ```actionscript
 private function resetPassword(emai:String):void
@@ -185,9 +199,11 @@ This is commonly used in message boards and ecommerce solutions.
 
 This method is similar to the Reset Password one, you need to provide the following parameters:
 
-* `email` is the email address you want to verify.
-* `requestType` with the value: `EMAIL_VERIFY`
-* `idToken` is a long encoded String that contains user information. You can obtain this String from the response Object in the Sign Up and Sign In methods. 
+Name | Description
+---|---
+`email` | The Email Address you want to verify.
+`requestType` | Set to: `EMAIL_VERIFY`
+`idToken` | A long encoded String that contains user information. You can obtain this String from the response in the Sign Up and Sign In methods. 
 
 ```actionscript
 private function verifyEmail(idToken:String, email:String):void
@@ -395,7 +411,12 @@ A successful response will look like the following JSON structure:
 ## Obtaining and Refreshing an Access Token
 
 By default the `access_token` has an expiration time of 60 minutes, you can reset its expiration by requesting a fresh one.
-To obtain or refresh an `access_token` you only need to provide a `refreshToken` from a Sign In request and specify the `grant_type` as `"refresh_token"`.
+To obtain or refresh an `access_token` you only need to provide the following parameters:
+
+Name | Description
+---|---
+`refreshToken` | A long encoded String that contains user information. You can obtain it from a Sign In request.
+`grant_type` | Set to: `refresh_token`
 
 ```actionscript
 private function refreshToken(refreshToken:String):void

database/README.md

@@ -155,11 +155,10 @@ private function loadNews():void
 private function newsLoaded(event:flash.events.Event):void
 {
     trace(event.currentTarget.data);
-    var rawData:Object = JSON.parse(event.currentTarget.data);								
 }
 ```
 
-A simple GET request (the default for `URLRequest`) is enough. Remember to always add `.json` after the name of the node you want to read.
+A simple `GET` request (the default for `URLRequest`) is enough. Remember to always add `.json` after the name of the node you want to read.
 
 To load a Private resource use the following code:
 
@@ -176,7 +175,6 @@ private function loadSpecialOffers(authToken:String):void
 private function offersLoaded(event:flash.events.Event):void
 {
     trace(event.currentTarget.data);
-    var rawData:Object = JSON.parse(event.currentTarget.data);								
 }
 ```
 
@@ -359,7 +357,7 @@ For example, we want that each user has their independent journal that they can
 }
 ```
 
-When you want to modify or read their journal you need to specify the users's `localId` (known as `uid` inside the rules)  and `authToken` as part of the URL.
+When you want to modify or read their journal you need to specify the users `localId` (known as `uid` inside the rules)  and `authToken` as part of the URL.
 
 ```actionscript
 private function loadPrivateJournal(localId:String, authToken:String):void
@@ -374,7 +372,6 @@ private function loadPrivateJournal(localId:String, authToken:String):void
 private function journalLoaded(event:flash.events.Event):void
 {
     trace(event.currentTarget.data);
-    var rawData:Object = JSON.parse(event.currentTarget.data);								
 }
 ```
 

storage/README.md

@@ -6,7 +6,7 @@ Files are stored the same way as in your personal computer, using a tree hierarc
 
 It is strongly recommended to avoid the use of special characters when naming files and folders.
 
-You need special care for the slash character `(/)`. I recommend using this helper function to URL encode them:
+You will need special care for the slash character `(/)`. I recommend using this helper function to URL encode them:
 
 ```actionscript
 private function formatUrl(url:String):String
@@ -84,11 +84,10 @@ service firebase.storage {
 }
 ```
 
-## Uploading a File
+## Prerequisites
 
-To upload a file you require to send it as a `ByteArray`. The following snippets show the most common scenarios.
 
-All of the examples use the following `Event.COMPLETE` and `IOErrorEvent.IOERROR` listeners.
+Since Firebase returns useful error information we will use the following `Event.COMPLETE` and `IOErrorEvent.IOERROR` listeners in all of our requests.
 
 ```actionscript
 private function uploadComplete(event:flash.events.Event):void
@@ -102,9 +101,11 @@ private function errorHandler(event:flash.events.Event):void
 }
 ```
 
-If you upload the same file to the same location, it will be replaced with new metadata.
+## Uploading from a fixed location
 
-### Uploading from a fixed location
+To upload a file you require to send it as a `ByteArray`. The following snippets show the most common scenarios.
+
+If you upload the same file to the same location, it will be replaced with new metadata.
 
 In this example we are uploading a file from a predefined location. A common example is syncing a save game after a game session:
 
@@ -119,7 +120,7 @@ private function uploadFile():void
     fileStream.readBytes(bytes);
     fileStream.close();
 				
-    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/"+"savegames%2F"+"savegame.data");
+    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/savegames%2F"+"savegame.data");
     request.method = URLRequestMethod.POST;
     request.data = bytes;
     request.contentType = "text/plain";
@@ -156,9 +157,9 @@ Your new file and a `savegames` folder will instantly appear in the Storage sect
 
 The `contentType` doesn't need to be accurate, but it is recommended to set it properly.
 
-### Uploading with Auth
+## Uploading with Auth
 
-Authorizing requests for Firebase Storage is a bit different than in Firebase Database. Instead of adding an `auth` parameter in the URL with the `authToken`, we add it into an `URLRequestHeader`.
+Authorizing requests for Firebase Storage is a bit different than in Firebase Database. Instead of adding an `auth` parameter in the URL with the `authToken`, we add it into a header.
 
 ```actionscript
 private function uploadFile(authToken:String):void
@@ -173,7 +174,7 @@ private function uploadFile(authToken:String):void
     
     var header:URLRequestHeader = new URLRequestHeader("Authorization", "Bearer "+authToken);			
 
-    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/"+"savegames%2F"+"savegame.data");
+    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/savegames%2F"+"savegame.data");
     request.method = URLRequestMethod.POST;
     request.data = bytes;
     request.contentType = "text/plain";
@@ -220,7 +221,7 @@ private function deleteFile():void
 {
     var header:URLRequestHeader = new URLRequestHeader("X-HTTP-Method-Override", "DELETE");			
 				
-    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/savegames%2Fsavegame.data");
+    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/savegames%2F"+"savegame.data");
     request.method = URLRequestMethod.POST;
     request.requestHeaders.push(header);
 				
@@ -233,15 +234,17 @@ private function deleteFile():void
 
 A successful response will return an [empty String](https://cloud.google.com/storage/docs/json_api/v1/objects/delete).
 
-Use the following snippet if you want to delete the same file using authentication:
+## Deleting a File with Auth
+
+To delete a file with authentication you only need to provide an `authToken` in the `Authorization` header and the file path in a `DELETE` request.
 
 ```actionscript
 private function deleteFile(authToken:String):void
 {
     var header:URLRequestHeader = new URLRequestHeader("X-HTTP-Method-Override", "DELETE");			
     var header2:URLRequestHeader = new URLRequestHeader("Authorization", "Bearer "+authToken);			
 			
-    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/savegames%2Fsavegame.data");
+    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/savegames%2F"+"savegame.data");
     request.method = URLRequestMethod.POST;
     request.requestHeaders.push(header);
     request.requestHeaders.push(header2);
@@ -255,7 +258,7 @@ private function deleteFile(authToken:String):void
 
 ## Updating Metadata
 
-To modify the metadata generated after your upload a file you will only require to indicate which fields do you need to update. This is very similar as updating the Firebase Database data.
+To modify the metadata generated after your upload a file you will only require to `JSON` encode which fields do you need to update and send them in a `PATCH` request. This is very similar as updating the Firebase Database data.
 
 Click [here](https://firebase.google.com/docs/storage/web/file-metadata) for a list of all the fields that can be modified. In the following example we are going to change the `contentType`.
 
@@ -302,19 +305,23 @@ A successful response will look like the following JSON structure:
 }
 ```
 
-Use the following snippet if you want to update the same file using authentication:
+## Updating Metadata with Auth
+
+To update metadata with authentication you need to provide an `authToken` in the `Authorization` header.
+
+You will also require to `JSON` encode which fields do you need to update and send them in a `PATCH` request.
 
 ```actionscript
-private function updateMetadata():void
+private function updateMetadata(authToken:String):void
 {
     var myObject:Object = new Object();
     myObject.contentType = "application/binary";
 				
     var header:URLRequestHeader = new URLRequestHeader("X-HTTP-Method-Override", "PATCH");			
     var header2:URLRequestHeader = new URLRequestHeader("Content-Type", "application/json");
-    var header3:URLRequestHeader = new URLRequestHeader("Authorization", "Bearer "+profile.authToken);         
+    var header3:URLRequestHeader = new URLRequestHeader("Authorization", "Bearer "+authToken);         
 		
-    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/"+"savegames%2F"+"savegame.data");
+    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/savegames%2F"+"savegame.data");
     request.method = URLRequestMethod.POST;
     request.data = JSON.stringify(myObject);
     request.requestHeaders.push(header);
@@ -328,11 +335,16 @@ private function updateMetadata():void
 }
 ```
 
-## Downloading Files
+## Downloading a File
 
 To download files from your Firebase Storage bucket you only require to send a `GET` request with the full path of the file and the parameter `alt=media`.
+You will also require the followinv values from the `JSON` structure.
 
-We are going to use the following JSON structure as our example:
+Name | Description
+---|---
+`name` | The path of the file including its name.
+`bucket` | Your Firebase Project ID plus the `appspot.com` domain.
+`downloadTokens` | A String used for downloading private files.
 
 ```json
 {
@@ -355,30 +367,30 @@ We are going to use the following JSON structure as our example:
 
 There are several ways to download files using the AIR runtime, we are going to use the easiest one: `navigateToURL()`.
 
-Use the following code to download a `public` file:
+The following example downloads a `public` file:
 
 ```actionscript
 private function downloadFile():void
 {
-    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/savegames%2Fsavegame.data?alt=media");
+    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/savegames%2F"+"savegame.data"+"?alt=media");
     navigateToURL(request);
 }
 ```
 
-Use the following code to download a `private` file:
+## Downloading a Private File
+
+Downloading `private` files doesn't require the `Authorization` header. You only require to provide the `token` parameter and the file path.
+
+The `token` parameter is the `downloadTokens` value from the `JSON` response when you upload a file.
 
 ```actionscript
 private function downloadFile(downloadTokens:String):void
 {
-    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/savegames%2Fsavegame.data?alt=media&token="+downloadTokens);
+    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/savegames%2F"+"savegame.data"+"?alt=media&token="+downloadTokens);
     navigateToURL(request);
 }
 ```
 
-Don't forget to encode the slash character from `(/)` to `%2F`.
-
-The `token` parameter refers to the `downloadTokens` value from the JSON response when you upload a file.
-
 ## Downloading Metadata
 
 You can download the information of any file in JSON format without downloading the file itself.
@@ -388,7 +400,7 @@ To download the metadata of a `public` file you only require to send a `GET` req
 ```actionscript
 private function downloadMetadata():void
 {
-    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/savegames%2Fsavegame.data");
+    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/savegames%2F"+"savegame.data");
     
     var loader:URLLoader = new URLLoader();
     loader.addEventListener(flash.events.event.COMPLETE, metadataLoaded);
@@ -401,14 +413,16 @@ private function metadataLoaded(event:flash.events.Event):void
 }
 ```
 
-Use the following snippet to download the metadata of a `private` file:
+## Downloading Private Metadata
+
+To download metadata from `private` files you require to provide an `authToken` in the `Authorization` header.
 
 ```actionscript
 private function downloadMetadata(authToken:String):void
 {
     var header:URLRequestHeader = new URLRequestHeader("Authorization", "Bearer "+authToken);         
 				
-    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/savegames%2Fsavegame.data");
+    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/savegames%2F"+"savegame.data");
     request.method = URLRequestMethod.POST;
     request.requestHeaders.push(header);
 
@@ -473,7 +487,7 @@ private function uploadPersonalFile(authToken:String, localId:String):void
 				
     var header:URLRequestHeader = new URLRequestHeader("Authorization", "Bearer "+authToken);			
 				
-    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/"+"savegames%2F"+localId+"%2Fsavegame.data");
+    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/savegames%2F"+localId+"%2F"+"savegame.data");
     request.method = URLRequestMethod.POST;
     request.data = bytes;
     request.contentType = "text/plain";