Upgraded to the Firebase 3.x.x SDK (#717)

Author: abeisgoat

.gitignore

@@ -2,4 +2,6 @@ dist/
 node_modules/
 bower_components/
 tests/coverage/
-.idea
+
+.idea
+tests/key.json

.jshintrc

@@ -1,7 +1,7 @@
 {
   "predef": [
     "angular",
-    "Firebase"
+    "firebase"
   ],
   "bitwise": true,
   "browser": true,

.travis.yml

@@ -5,6 +5,8 @@ sudo: false
 addons:
   sauce_connect: true
 before_install:
+- openssl aes-256-cbc -K $encrypted_d1b4272f4052_key -iv $encrypted_d1b4272f4052_iv
+  -in tests/key.json.enc -out tests/key.json -d
 - export CHROME_BIN=chromium-browser
 - export DISPLAY=:99.0
 - sh -e /etc/init.d/xvfb start
@@ -17,10 +19,11 @@ before_script:
 - grunt install
 - phantomjs --version
 script:
-- sh ./tests/travis.sh
+- '[ -e tests/key.json ] && sh ./tests/travis.sh || false'
 after_script:
 - cat ./tests/coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
 env:
   global:
+  - ANGULARFIRE_TEST_DB_URL=https://angularfire-dae2e.firebaseio.com
   - secure: mGHp1rQI11OvbBQn3PnBT5kuyo26gFl8U+nNq0Ot4opgSBX9JaHqS8Dx63uALWWU9qjy08/Mn68t/sKhayH1+XrPDIenOy/XEkkSAG60qAAowD9dRo3WaIMSOcWWYDeqdZOAWZ3LiXvjLO4Swagz5ejz7UtY/ws4CcTi2n/fp7c=
   - secure: Eao+hPFWKrHb7qUGEzLg7zdTCE//gb3arf5UmI9Z3i+DydSu/AwExXuywJYUj4/JNm/z8zyJ3j1/mdTyyt9VVyrnQNnyGH1b2oCUHkrs1NLwh5Oe4YcqUYROzoEKdDInvmjVJnIfUEM07htGMGvsLsX4MW2tqVHvD2rOwkn8C9s=

Gruntfile.js

@@ -94,9 +94,6 @@ module.exports = function(grunt) {
       options: {
         configFile: 'tests/automatic_karma.conf.js'
       },
-      manual: {
-        configFile: 'tests/manual_karma.conf.js'
-      },
       singlerun: {},
       watch: {
          autowatch: true,
@@ -145,7 +142,6 @@ module.exports = function(grunt) {
   grunt.registerTask('test', ['test:unit', 'test:e2e']);
   grunt.registerTask('test:unit', ['karma:singlerun']);
   grunt.registerTask('test:e2e', ['concat', 'connect:testserver', 'protractor:singlerun']);
-  grunt.registerTask('test:manual', ['karma:manual']);
 
   // Travis CI testing
   //grunt.registerTask('test:travis', ['build', 'test:unit', 'connect:testserver', 'protractor:saucelabs']);

README.md

@@ -1,21 +1,37 @@
+# AngularFire [![Build Status](https://travis-ci.org/firebase/angularfire.svg?branch=master)](https://travis-ci.org/firebase/angularfire) [![Coverage Status](https://coveralls.io/repos/firebase/angularfire/badge.svg?branch=master&service=github)](https://coveralls.io/github/firebase/angularfire?branch=master) [![Version](https://badge.fury.io/gh/firebase%2Fangularfire.svg)](http://badge.fury.io/gh/firebase%2Fangularfire)
 
-# AngularFire
 
-[![Build Status](https://travis-ci.org/firebase/angularfire.svg?branch=master)](https://travis-ci.org/firebase/angularfire)
-[![Coverage Status](https://coveralls.io/repos/firebase/angularfire/badge.svg?branch=master&service=github)](https://coveralls.io/github/firebase/angularfire?branch=master)
-[![Version](https://badge.fury.io/gh/firebase%2Fangularfire.svg)](http://badge.fury.io/gh/firebase%2Fangularfire)
-[![Join Slack](https://img.shields.io/badge/slack-join-brightgreen.svg)](https://firebase-community.appspot.com/)
-
-AngularFire is the officially supported [AngularJS](http://angularjs.org/) binding for
-[Firebase](http://www.firebase.com/?utm_medium=web&utm_source=angularfire). Firebase is a
-backend service that provides data storage, authentication, and static website hosting for your Angular app.
+AngularFire is the officially supported [AngularJS](https://angularjs.org/) binding for
+[Firebase](https://firebase.google.com/). Firebase is a
+backend service that provides data storage, authentication, and static website hosting for your
+Angular app.
 
 AngularFire is a complement to the core Firebase client. It provides you with three Angular
 services:
   * `$firebaseObject` - synchronized objects
   * `$firebaseArray` - synchronized collections
   * `$firebaseAuth` - authentication, user management, routing
 
+Join our [Firebase + Angular Google Group](https://groups.google.com/forum/#!forum/firebase-angular)
+to ask questions, provide feedback, and share apps you've built with AngularFire.
+
+
+## Table of Contents
+
+ * [Getting Started With Firebase](#getting-started-with-firebase)
+ * [Downloading AngularFire](#downloading-angularfire)
+ * [Documentation](#documentation)
+ * [Examples](#examples)
+ * [Migration Guides](#migration-guides)
+ * [Contributing](#contributing)
+
+
+## Getting Started With Firebase
+
+AngularFire requires [Firebase](https://firebase.google.com/) in order to authenticate users and sync
+and store data. Firebase is a suite of integrated products designed to help you develop your app,
+grow your user base, and earn money. You can [sign up here for a free account](https://console.firebase.google.com/).
+
 
 ## Downloading AngularFire
 
@@ -26,18 +42,12 @@ In order to use AngularFire in your project, you need to include the following f
 <script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.5.0/angular.min.js"></script>
 
 <!-- Firebase -->
-<script src="https://cdn.firebase.com/js/client/2.4.0/firebase.js"></script>
+<script src="https://www.gstatic.com/firebasejs/3.0.3/firebase.js"></script>
 
 <!-- AngularFire -->
-<script src="https://cdn.firebase.com/libs/angularfire/1.2.0/angularfire.min.js"></script>
+<script src="https://cdn.firebase.com/libs/angularfire/2.0.0/angularfire.min.js"></script>
 ```
 
-Use the URL above to download both the minified and non-minified versions of AngularFire from the
-Firebase CDN. You can also download them from the
-[releases page of this GitHub repository](https://github.com/firebase/angularfire/releases).
-[Firebase](https://www.firebase.com/docs/web/quickstart.html?utm_medium=web&utm_source=angularfire) and
-[Angular](https://angularjs.org/) libraries can be downloaded directly from their respective websites.
-
 You can also install AngularFire via npm and Bower and its dependencies will be downloaded
 automatically:
 
@@ -49,28 +59,34 @@ $ npm install angularfire --save
 $ bower install angularfire --save
 ```
 
-Once you've included AngularFire and its dependencies into your project, you will have access to
-the `$firebase` service.
 
+## Documentation
 
-## Getting Started with Firebase
+* [Quickstart](docs/quickstart.md)
+* [Guide](docs/guide/README.md)
+* [API Reference](https://angularfire.firebaseapp.com/api.html)
 
-AngularFire uses Firebase for data storage and authentication. You can [sign up here for a free
-account](https://www.firebase.com/signup/?utm_medium=web&utm_source=angularfire).
 
+## Examples
 
-## Documentation
+### Full Examples
 
-The Firebase docs have a [quickstart](https://www.firebase.com/docs/web/bindings/angular/quickstart.html?utm_medium=web&utm_source=angularfire),
-[guide](https://www.firebase.com/docs/web/bindings/angular/guide?utm_medium=web&utm_source=angularfire),
-and [full API reference](https://www.firebase.com/docs/web/bindings/angular/api.html?utm_medium=web&utm_source=angularfire)
-for AngularFire.
+* [Wait And Eat](https://github.com/gordonmzhu/angular-course-demo-app-v2)
+* [TodoMVC](https://github.com/tastejs/todomvc/tree/master/examples/firebase-angular)
+* [Tic-Tac-Tic-Tac-Toe](https://github.com/jwngr/tic-tac-tic-tac-toe/)
+* [Firereader](http://github.com/firebase/firereader)
+* [Firepoker](https://github.com/Wizehive/Firepoker)
 
-We also have a [tutorial](https://www.firebase.com/tutorial/#tutorial/angular/0?utm_medium=web&utm_source=angularfire)
-to help you get started with AngularFire.
+### Recipes
 
-Join our [Firebase + Angular Google Group](https://groups.google.com/forum/#!forum/firebase-angular)
-to ask questions, provide feedback, and share apps you've built with AngularFire.
+* [Date Object To A Firebase Timestamp Using `$extend`](http://jsfiddle.net/katowulf/syuzw9k1/)
+* [Filter a `$FirebaseArray`](http://jsfiddle.net/firebase/ku8uL0pr/)
+
+
+## Migration Guides
+
+* [Migrating from AngularFire `1.x.x` to `2.x.x`](docs/migration/1XX-to-2XX.md)
+* [Migrating from AngularFire `0.9.x` to `1.x.x`](docs/migration/09X-to-1XX.md)
 
 
 ## Contributing

bower.json

@@ -26,6 +26,6 @@
   ],
   "dependencies": {
     "angular": "^1.3.0",
-    "firebase": "2.x.x"
+    "firebase": "3.x.x"
   }
 }

docs/guide/README.md

@@ -0,0 +1,8 @@
+# AngularFire Guide
+
+1. [Introduction to AngularFire](introduction-to-angularfire.md) - Learn about what AngularFire is and how to integrate it into your Angular app.
+2. [Synchronized Objects](synchronized-objects.md) - Create synchronized objects and experience three-way data binding.
+3. [Synchronized Arrays](synchronized-arrays.md) - Create and modify arrays which stay in sync with the database.
+4. [User Authentication](user-auth.md) - AngularFire handles user authentication and session management for you.
+5. [Extending the Services](extending-services.md) - Advanced users can extend the functionality of the built-in AngularFire services.
+6. [Beyond AngularFire](beyond-angularfire.md) - AngularFire is not the only way to use Angular and Firebase together.

docs/guide/beyond-angularfire.md

@@ -0,0 +1,87 @@
+# Beyond AngularFire | AngularFire Guide
+
+## Table of Contents
+
+* [Overview](#overview)
+* [Best Practices](#best-practices)
+* [Deploying Your App](#deploying-your-app)
+* [Next Steps](#next-steps)
+
+
+## Overview
+
+AngularFire greatly simplifies bindings and abstracts a lot of the internal workings of Angular,
+such as how to notify the compiler when changes occur. However, it does not attempt to replicate
+the entire Firebase client library's API.
+
+There are plenty of use cases for dropping down to the SDK level and using it directly. This
+section will cover a few best practices and techniques for grabbing data directly from our
+database using the JavaScript client library.
+
+This is easiest to accomplish with an example, so read the comments carefully.
+
+```js
+app.controller("SampleCtrl", ["$scope", "$timeout", function($scope, $timeout) {
+  // create a reference to our Firebase database
+  var ref = firebase.database.ref();
+
+  // read data from the database into a local scope variable
+  ref.on("value", function(snapshot) {
+    // Since this event will occur outside Angular's $apply scope, we need to notify Angular
+    // each time there is an update. This can be done using $scope.$apply or $timeout. We
+    // prefer to use $timeout as it a) does not throw errors and b) ensures all levels of the
+    // scope hierarchy are refreshed (necessary for some directives to see the changes)
+    $timeout(function() {
+      $scope.data = snapshot.val();
+    });
+  });
+}]);
+```
+
+Synchronizing simple data like this is trivial. When we start operating on synchronized arrays
+and dealing with bindings, things get a little more interesting. For a comparison of the
+bare-bones work needed to synchronize an array, examine
+[a naive comparison of AngularFire versus the vanilla Firebase client library](https://gist.github.com/katowulf/a8466f4d66a4cea7af7c), and look at
+[Firebase.getAsArray()](https://github.com/katowulf/Firebase.getAsArray) for a more
+fully functional synchronized array implementation and the work involved.
+
+
+## Best Practices
+
+When using the vanilla Firebase client library with Angular, it is best to keep the following things
+in mind:
+
+* **Wrap events in `$timeout()`**: Wrap all server notifications in
+`$timeout()` to ensure the Angular compiler is notified of changes.
+* **Use `$window.Firebase`**: This allows test units and end-to-end
+tests to spy on the Firebase client library and replace it with mock functions. It also avoids the linter warnings about
+globals.
+* **Mock Firebase for testing**: Use mocks for unit tests. A non-supported,
+third-party mock of the Firebase classes can be
+[found here](https://github.com/katowulf/mockfirebase). The
+[AngularFire unit tests](https://github.com/firebase/angularfire/blob/master/tests/unit)
+can be used as an example of mocking `Firebase` classes.
+
+
+## Deploying Your App
+
+Once you are done building your application, you'll need a way to share it with the world. To
+deploy your Angular applications free, fast, and without fuss, do it Firebase style! Our
+production-grade hosting service serves your content over HTTPS and is backed by a global CDN.
+You can deploy your application for free at your very own subdomain of `firebaseapp.com`
+or you can host it at any custom domain on one of our paid plans. Check out
+[Firebase Hosting](https://firebase.google.com/docs/hosting/) for more information.
+
+
+## Next Steps
+
+There are many additional resources for learning about using Firebase with Angular applications:
+
+* Browse the [AngularFire API documentation](https://angularfire.firebaseapp.com/api.html).
+* The [`angularfire-seed`](https://github.com/firebase/angularfire-seed) repo contains a template
+project to help you get started.
+* Check out the [various examples that use AngularFire](../README.md).
+* Join our [AngularFire mailing list](https://groups.google.com/forum/#!forum/firebase-angular) to
+keep up to date with any announcements and learn from the AngularFire community.
+* The [`angularfire` tag on Stack Overflow](http://stackoverflow.com/questions/tagged/angularfire)
+has answers to a lot of code-related questions.