Version v1.5.0-alpha (#136)

### Description
* Adds `updateProfile`, `updateAuth`, and `updateEmail` methods that dispatch associated start/success/failure actions
* Adds multiple features to populate - #132
* Uses `prop-types` instead of importing from react - #122 
* `distpatchOnUnsetListener` fixed to be `dispatchOnUnsetListener` (depreciation warning added along with a test confirm it is displayed)
* Do not include `dbPath` in response from `deleteFile` method if it is undefined (test added to check this case)
* `.eslintrc` file now using yaml format instead of JSON format (easier to read)
* Unnessesary global eslint comments removed from tests (no longer needed due to globals being moved to `.eslintrc`)
* `enableEmptyAuthChanges` config option added - #137

### Check List

- [X] All tests passing
- [X] Docs updated with any changes or examples
- [X] Added tests to ensure feature(s) work properly

### Relevant Issues
* [#122](https://github.com/prescottprue/react-redux-firebase/issues/#122)
* [#132](https://github.com/prescottprue/react-redux-firebase/issues/#132)
* [#137](https://github.com/prescottprue/react-redux-firebase/issues/#137)

Author: prescottprue

.eslintrc

@@ -1,24 +1,27 @@
-{
-  "parser"  : "babel-eslint",
-  "extends" : [
-    "standard",
-    "standard-react"
-  ],
-  "plugins": [
-    "babel"
-  ],
-  "env"     : {
-    "browser" : true
-  },
-  "globals" : {
-    "__DEV__"      : false,
-    "__PROD__"     : false,
-    "__DEBUG__"    : false,
-    "__COVERAGE__" : false,
-    "__BASENAME__" : false
-  },
-  "rules": {
-    "semi" : [2, "never"],
-    "no-console": "error"
-  }
-}
+root: true
+
+parser: babel-eslint
+
+extends: [standard, standard-react]
+plugins: [babel, react]
+
+env:
+  browser: true
+  es6: true
+  jasmine: true
+  node: true
+
+ecmaFeatures:
+  jsx: true
+  modules: true
+
+globals:
+  MockFirebase: true
+  sinon: true
+  Raven: true
+  __COVERAGE__: true
+  __DEV__: true
+
+rules:
+  semi: [2, 'never']
+  no-console: 'error'

examples/complete/material/src/routes/Account/containers/AccountContainer.js

@@ -42,7 +42,7 @@ export default class Account extends Component {
 
   updateAccount = (newData) =>
     this.props.firebase
-      .update(`${rfConfig.userProfile}/${this.props.auth.uid}`, newData)
+      .updateProfile(newData)
       .catch((err) => {
         console.error('Error updating account', err) // eslint-disable-line no-console
         // TODO: Display error to user

package.json

@@ -1,14 +1,14 @@
 {
   "name": "react-redux-firebase",
-  "version": "1.4.0",
+  "version": "1.5.0-alpha",
   "description": "Redux integration for Firebase. Comes with a Higher Order Component for use with React.",
   "browser": "dist/react-redux-firebase.js",
   "main": "lib/index.js",
   "module": "es/index.js",
   "jsnext:main": "es/index.js",
   "scripts": {
     "clean": "rimraf dist",
-    "lint": "eslint src/** test/**",
+    "lint": "eslint src/** tests/**",
     "lint:fix": "npm run lint -- --fix",
     "test": "mocha -R spec --compilers js:babel-core/register ./tests/setup.js ./tests/**/*.spec.js",
     "test:cov": "istanbul cover ./node_modules/mocha/bin/_mocha -- ./tests/** --recursive --report lcov --compilers js:babel-register --require babel-polyfill",

src/actions/auth.js

@@ -11,12 +11,12 @@ import {
 } from 'lodash'
 import jwtDecode from 'jwt-decode'
 import { actionTypes, defaultJWTProps } from '../constants'
+import { getLoginMethodAndParams } from '../utils/auth'
 import {
   promisesForPopulate,
   getPopulateObjs,
   getChildType
 } from '../utils/populate'
-import { getLoginMethodAndParams } from '../utils/auth'
 
 const {
   SET,
@@ -242,6 +242,10 @@ export const init = (dispatch, firebase) => {
 
   firebase.auth().onAuthStateChanged(authData => {
     if (!authData) {
+      // Run onAuthStateChanged if it exists in config and enableEmptyAuthChanges is set to true
+      if (isFunction(firebase._.config.onAuthStateChanged) && firebase._.config.enableEmptyAuthChanges) {
+        firebase._.config.onAuthStateChanged(authData, firebase, dispatch)
+      }
       return dispatch({ type: LOGOUT })
     }
 
@@ -251,11 +255,12 @@ export const init = (dispatch, firebase) => {
     dispatchLogin(dispatch, authData)
 
     // Run onAuthStateChanged if it exists in config
-    if (firebase._.config.onAuthStateChanged) {
+    if (isFunction(firebase._.config.onAuthStateChanged)) {
       firebase._.config.onAuthStateChanged(authData, firebase, dispatch)
     }
   })
 
+  // set redirect result callback if enableRedirectHandling set to true
   if (firebase._.config.enableRedirectHandling) {
     firebase.auth().getRedirectResult()
       .then((authData) => {
@@ -499,6 +504,122 @@ export const verifyPasswordResetCode = (dispatch, firebase, code) => {
     })
 }
 
+/**
+ * @description Update user profile
+ * @param {Function} dispatch - Action dispatch function
+ * @param {Object} firebase - Internal firebase object
+ * @param {Object} userData - User data object (response from authenticating)
+ * @param {Object} profile - Profile data to place in new profile
+ * @return {Promise}
+ * @private
+ */
+export const updateProfile = (dispatch, firebase, profileUpdate) => {
+  const { database, _: { config, authUid } } = firebase
+  dispatch({
+    type: actionTypes.PROFILE_UPDATE_START,
+    payload: profileUpdate
+  })
+  return database()
+    .ref(`${config.userProfile}/${authUid}`)
+    .update(profileUpdate)
+    .then((snap) => {
+      dispatch({
+        type: actionTypes.PROFILE_UPDATE_SUCCESS,
+        payload: snap.val()
+      })
+    })
+    .catch((payload) => {
+      dispatch({
+        type: actionTypes.PROFILE_UPDATE_ERROR,
+        payload
+      })
+    })
+}
+
+ /**
+  * @description Update Auth Object. Internally calls
+  * `firebase.auth().currentUser.updateProfile` as seen [in the firebase docs](https://firebase.google.com/docs/auth/web/manage-users#update_a_users_profile).
+  * @param {Function} dispatch - Action dispatch function
+  * @param {Object} firebase - Internal firebase object
+  * @param {Object} profileUpdate - Update to be auth object
+  * @return {Promise}
+  * @private
+  */
+export const updateAuth = (dispatch, firebase, authUpdate, updateInProfile) => {
+  dispatch({
+    type: actionTypes.AUTH_UPDATE_START,
+    payload: authUpdate
+  })
+  if (!firebase.auth().currentUser) {
+    const msg = 'User must be logged in to update auth.'
+    dispatch({
+      type: actionTypes.AUTH_UPDATE_ERROR,
+      payload: msg
+    })
+    return Promise.reject(msg)
+  }
+  return firebase.auth().currentUser
+    .updateProfile(authUpdate)
+    .then((payload) => {
+      dispatch({
+        type: actionTypes.AUTH_UPDATE_SUCCESS,
+        payload: firebase.auth().currentUser
+      })
+      if (updateInProfile) {
+        return updateProfile(dispatch, firebase, authUpdate)
+      }
+      return payload
+    })
+    .catch((payload) => {
+      dispatch({
+        type: actionTypes.AUTH_UPDATE_ERROR,
+        payload
+      })
+    })
+}
+
+/**
+ * @description Update user's email. Internally calls
+ * `firebase.auth().currentUser.updateEmail` as seen [in the firebase docs](https://firebase.google.com/docs/auth/web/manage-users#update_a_users_profile).
+ * @param {Function} dispatch - Action dispatch function
+ * @param {Object} firebase - Internal firebase object
+ * @param {String} newEmail - Update to be auth object
+ * @return {Promise}
+ * @private
+ */
+export const updateEmail = (dispatch, firebase, newEmail, updateInProfile) => {
+  dispatch({
+    type: actionTypes.EMAIL_UPDATE_START,
+    payload: newEmail
+  })
+  if (!firebase.auth().currentUser) {
+    const msg = 'User must be logged in to update email.'
+    dispatch({
+      type: actionTypes.EMAIL_UPDATE_ERROR,
+      payload: msg
+    })
+    return Promise.reject(msg)
+  }
+  return firebase.auth().currentUser
+    .updateEmail(newEmail)
+    .then((payload) => {
+      dispatch({
+        type: actionTypes.EMAIL_UPDATE_SUCCESS,
+        payload: newEmail
+      })
+      if (updateInProfile) {
+        return updateProfile(dispatch, firebase, { email: newEmail })
+      }
+      return payload
+    })
+    .catch((payload) => {
+      dispatch({
+        type: actionTypes.EMAIL_UPDATE_ERROR,
+        payload
+      })
+    })
+}
+
 export default {
   dispatchLoginError,
   dispatchUnauthorizedError,
@@ -512,5 +633,8 @@ export default {
   createUser,
   resetPassword,
   confirmPasswordReset,
-  verifyPasswordResetCode
+  verifyPasswordResetCode,
+  updateAuth,
+  updateProfile,
+  updateEmail
 }

src/compose.js

@@ -31,11 +31,17 @@ let firebaseInstance
  * auth redirect handling listener. (default: `true`)
  * @property {Function} config.onAuthStateChanged - Function run when auth state
  * changes. Argument Pattern: `(authData, firebase, dispatch)`
+ * @property {Boolean} config.enableEmptyAuthChanges - Whether or not to enable
+ * empty auth changes. When set to true, `onAuthStateChanged` will be fired with,
+ * empty auth changes such as undefined on initialization. See
+ * [#137](https://github.com/prescottprue/react-redux-firebase/issues/137) for
+ * more details. (default: `false`)
  * @property {Function} config.onRedirectResult - Function run when redirect
  * result is returned. Argument Pattern: `(authData, firebase, dispatch)`
  * @property {Object} config.customAuthParameters - Object for setting which
  * customAuthParameters are passed to external auth providers.
- * @property {Function} config.profileFactory - Factory for modifying how user profile is saved.
+ * @property {Function} config.profileFactory - Factory for modifying how user
+ * profile is saved.
  * @property {Function} config.uploadFileDataFactory - Factory for modifying
  * how file meta data is written during file uploads
  * @property {Array|String} config.profileParamsToPopulate - Parameters within
@@ -411,11 +417,44 @@ export default (fbConfig, otherConfig) => next =>
     const verifyPasswordResetCode = (code) =>
       authActions.verifyPasswordResetCode(dispatch, instance, code)
 
+    /**
+     * @description Update the currently logged in user's profile object
+     * @param {String} profileUpdate - Changes to apply to profile
+     * @return {Promise}
+     */
+    const updateProfile = (profile) =>
+      authActions.updateProfile(dispatch, instance, profile)
+
+    /**
+     * @description Update the currently logged in user's auth object. **Note**:
+     * changes Auth object **only**, not user's profile.
+     * @param {String} code - Password reset code to verify
+     * @return {Promise}
+     */
+    const updateAuth = (authUpdate) =>
+      authActions.updateAuth(dispatch, instance, authUpdate)
+
+    /**
+     * @description Update the currently logged in user's email. **Note**:
+     * changes email in Auth object only, not within user's profile.
+     * @param {String} newEmail - New email
+     * @param {Boolean} updateInProfile - Whether or not to update user's
+     * profile with email change.
+     * @return {Promise}
+     */
+    const updateEmail = (email, updateInProfile) =>
+      authActions.updateEmail(dispatch, instance, email, updateInProfile)
+
     /**
      * @name ref
      * @description Firebase ref function
      * @return {database.Reference}
      */
+   /**
+    * @name auth
+    * @description Firebase auth service instance including all Firebase auth methods
+    * @return {Auth}
+    */
    /**
     * @name database
     * @description Firebase database service instance including all Firebase storage methods
@@ -427,9 +466,9 @@ export default (fbConfig, otherConfig) => next =>
     * @return {Storage} Firebase storage service
     */
     /**
-     * @name auth
-     * @description Firebase auth service instance including all Firebase auth methods
-     * @return {Auth}
+     * @name messaging
+     * @description Firebase messaging service instance including all Firebase messaging methods
+     * @return {Messaging} Firebase messaging service
      */
     firebase.helpers = {
       ref: path => firebase.database().ref(path),
@@ -452,9 +491,11 @@ export default (fbConfig, otherConfig) => next =>
       verifyPasswordResetCode,
       watchEvent,
       unWatchEvent,
+      updateProfile,
+      updateAuth,
+      updateEmail,
       storage: (app) => firebase.storage(app),
-      messaging: (app) => firebase.messaging(app),
-      instance: firebase
+      messaging: (app) => firebase.messaging(app)
     }
 
     authActions.init(dispatch, instance)