Merge pull request #2 from ochanje210/master

Allowing to exclude secret on demand
marckrenn · Dec 28, 2016 · 69458f8 · 69458f8
2 parents 9723779 + 95c9554
commit 69458f8
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -75,7 +75,8 @@ This module is based on [Firebase's REST API](https://firebase.google.com/docs/r
 | :---                                                                                                                                                    |
 | [**1) Properties**](https://github.com/marckrenn/framer-Firebase#1-properties)                                                                          |
 | \|--- [firebase**.projectID**, **.secret**](https://github.com/marckrenn/framer-Firebase#-firebaseprojectid-firebasesecret)                             |
-| \|--- [firebase**.debug**](https://github.com/marckrenn/framer-Firebase#-firebasedebug)                                                                 |
+| \|--- [firebase**.secret**](https://github.com/marckrenn/framer-Firebase#-firebasesecret)                                   |
+| \|--- [firebase**.debug**](https://github.com/marckrenn/framer-Firebase#-firebasedebug)                                                                |
 | \|--- [firebase**.status**](https://github.com/marckrenn/framer-Firebase#-firebasestatus-read-only)                                                     |
 | [**2) Methods**](https://github.com/marckrenn/framer-Firebase#2-methods)                                                                                |
 | \|--- [firebase**.get**()](https://github.com/marckrenn/framer-Firebase#-firebasegetpath-callback-parameters)                                           |
@@ -113,6 +114,24 @@ firebase = new Firebase
 
 <br />
 
+#### • firebase.secret
+---
+If you wish not to share your *secret*, please follow the next steps.
+
+1. Simply, do not use *secret* on your code. (remove it if you have already)
+2. Go to *Console* → *YourProject* → *Database* → *RULES*
+3. Change the rules of `.read` and `.write` to `true` like the following:
+```json
+{
+  "rules": {
+    ".read": "true",
+    ".write": "true"
+  }
+}
+```
+
+<br />
+
 #### • firebase.debug
 ---
 If set to **true**, relevant connection messages will be logged to the console.

diff --git a/firebase.coffee b/firebase.coffee
@@ -26,16 +26,17 @@ class exports.Firebase extends Framer.BaseClass
 		@secret    = @options.secret    ?= null
 		@debug     = @options.debug     ?= false
 		@_status                        ?= "disconnected"
-		super
 
+		@secretEndPoint = if @secret then "?auth=#{@secret}" else ""
+		super
 
 		console.log "Firebase: Connecting to Firebase Project '#{@projectID}' ... \n URL: 'https://#{@projectID}.firebaseio.com'" if @debug
 		@.onChange "connection"
 
 
 	request = (project, secret, path, callback, method, data, parameters, debug) ->
 
-		url = "https://#{project}.firebaseio.com#{path}.json?auth=#{secret}"
+		url = "https://#{project}.firebaseio.com#{path}.json#{secret}"
 
 
 		unless parameters is undefined
@@ -87,11 +88,11 @@ class exports.Firebase extends Framer.BaseClass
 
 	# Available methods
 
-	get:    (path, callback,       parameters) -> request(@projectID, @secret, path, callback, "GET",    null, parameters, @debug)
-	put:    (path, data, callback, parameters) -> request(@projectID, @secret, path, callback, "PUT",    data, parameters, @debug)
-	post:   (path, data, callback, parameters) -> request(@projectID, @secret, path, callback, "POST",   data, parameters, @debug)
-	patch:  (path, data, callback, parameters) -> request(@projectID, @secret, path, callback, "PATCH",  data, parameters, @debug)
-	delete: (path, callback,       parameters) -> request(@projectID, @secret, path, callback, "DELETE", null, parameters, @debug)
+	get:    (path, callback,       parameters) -> request(@projectID, @secretEndPoint, path, callback, "GET",    null, parameters, @debug)
+	put:    (path, data, callback, parameters) -> request(@projectID, @secretEndPoint, path, callback, "PUT",    data, parameters, @debug)
+	post:   (path, data, callback, parameters) -> request(@projectID, @secretEndPoint, path, callback, "POST",   data, parameters, @debug)
+	patch:  (path, data, callback, parameters) -> request(@projectID, @secretEndPoint, path, callback, "PATCH",  data, parameters, @debug)
+	delete: (path, callback,       parameters) -> request(@projectID, @secretEndPoint, path, callback, "DELETE", null, parameters, @debug)
 
 
 
@@ -100,7 +101,7 @@ class exports.Firebase extends Framer.BaseClass
 
 		if path is "connection"
 
-			url = "https://#{@projectID}.firebaseio.com/.json?auth=#{@secret}"
+			url = "https://#{@projectID}.firebaseio.com/.json#{@secretEndPoint}"
 			currentStatus = "disconnected"
 			source = new EventSource(url)
 
@@ -121,7 +122,7 @@ class exports.Firebase extends Framer.BaseClass
 
 		else
 
-			url = "https://#{@projectID}.firebaseio.com#{path}.json?auth=#{@secret}"
+			url = "https://#{@projectID}.firebaseio.com#{path}.json#{@secretEndPoint}"
 			source = new EventSource(url)
 			console.log "Firebase: Listening to changes made to '#{path}' \n URL: '#{url}'" if @debug