#7 v1.0.2

* adds `profileDecorator` configuration option (change format of profile data stored on Firebase)
* exposes firebase through `getFirebase` function that can be passed as the third argument when creating thunk actions
* adds `updateProfileOnLogin` configuration option that toggles whether or not account is updated when logging in

Author: prescottprue

README.md

@@ -199,15 +199,71 @@ The simple example implemented using decorators built from the output of [create
 
 An example that user Material UI built on top of the output of [create-react-app](https://github.com/facebookincubator/create-react-app)'s eject command.  Shows a list of todo items and allows you to add to them. This is what is deployed to [react-redux-firebase.firebaseapp.com](https://react-redux-firebase.firebaseapp.com/).
 
+## Using with `redux-thunk`
+If you user using `redux-thunk`, make sure to set up your thunk middleware using it's redux-thunk's `withExtraArgument` method so that firebase is available within your actions. Here is an example `createStore` function that adds `getFirebase` as third argument along with a thunk that uses it:
+
+createStore:
+
+```javascript
+import { applyMiddleware, compose, createStore } from 'redux';
+import thunk from 'redux-thunk';
+import { reduxReactFirebase } from 'react-redux-firebase';
+import makeRootReducer from './reducers';
+import { getFirebase } from 'react-redux-firebase';
+
+const fbConfig = {} // your firebase config
+
+const store = createStore(
+  makeRootReducer(),
+  initialState,
+  compose(
+    applyMiddleware([
+      thunk.withExtraArgument(getFirebase) // Pass getFirebase function as extra argument
+    ]),
+    reduxReactFirebase(fbConfig, { userProfile: 'users', enableLogging: false })
+  )
+);
+
+```
+Action:
+
+```javascript
+const sendNotification = (payload) => {
+  type: NOTIFICATION,
+  payload
+}
+export const addTodo = (newTodo) =>
+  (dispatch, getState, getFirebase) => {
+    const firebase = getFirebase()
+    firebase
+      .push('todos', newTodo)
+      .then(() => {
+        dispatch(sendNotification('Todo Added'))
+      })
+  };
+
+```
 
 ## Generator
 
 [generator-react-firebase](https://github.com/prescottprue/generator-react-firebase) uses react-redux-firebase when opting to include redux
 
-## In the future
-- Redux Form Example
-- More Unit Tests/Coverage
-- Ideas are welcome :)
+## FAQ
+
+1. How is this different than [`redux-react-firebase`](https://github.com/tiberiuc/redux-react-firebase)?
+
+This library was actually originally forked from redux-react-firebase, but adds extended functionality such as:
+* populate functionality
+* profileDecorator - change format of profile stored on Firebase
+* getFirebase - access to firebase that fires actions
+* capability for thunk integration - using `getFirebase` and `thunk.withExtraArgument`
+
+Bottom line: The auth of redux-react-firebase was absent when functionality was needed by me and others, so this library was created.
+
+2. Why use redux if I have Firebase?
+
+This isn't a super quick answer, so I wrote up [a medium article to explain](https://medium.com/@prescottprue/firebase-with-redux-82d04f8675b9)
+
 
 ## Contributors
 - [Prescott Prue](https://github.com/prescottprue)

package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-redux-firebase",
-  "version": "1.0.1",
-  "description": "A Higher Order Component to use Firebase version 3 with Redux",
+  "version": "1.0.2",
+  "description": "Redux integration for Firebase. Comes with a Higher Order Component for use with React.",
   "main": "dist/index.js",
   "module": "src/index.js",
   "jsnext:main": "src/index.js",
@@ -36,15 +36,10 @@
     {
       "name": "Rahav Lussato",
       "url": "https://github.com/RahavLussato"
-    },
-    {
-      "name": "Tiberiu Craciun",
-      "email": "[email protected]",
-      "url": "https://github.com/tiberiuc"
     }
   ],
   "dependencies": {
-    "firebase": "^3.5.0",
+    "firebase": "^3.5.2",
     "immutable": "^3.8.1",
     "jwt-decode": "^2.1.0",
     "lodash": "^4.16.4"
@@ -55,27 +50,27 @@
     "redux": "^3.0.5"
   },
   "devDependencies": {
-    "babel-cli": "^6.16.0",
-    "babel-core": "^6.17.0",
-    "babel-eslint": "^7.0.0",
+    "babel-cli": "^6.18.0",
+    "babel-core": "^6.18.0",
+    "babel-eslint": "^7.1.0",
     "babel-plugin-add-module-exports": "^0.2.1",
     "babel-plugin-es6-promise": "^1.0.0",
     "babel-plugin-lodash": "^3.2.9",
     "babel-plugin-transform-decorators-legacy": "^1.3.4",
-    "babel-preset-es2015": "^6.16.0",
+    "babel-preset-es2015": "^6.18.0",
     "babel-preset-react": "^6.16.0",
     "babel-preset-stage-1": "^6.16.0",
     "chai": "^3.5.0",
     "codecov": "^1.0.1",
-    "eslint": "^3.7.1",
-    "eslint-config-standard": "^6.2.0",
+    "eslint": "^3.9.0",
+    "eslint-config-standard": "^6.2.1",
     "eslint-config-standard-react": "^4.2.0",
     "eslint-plugin-babel": "^3.3.0",
     "eslint-plugin-promise": "^3.0.0",
     "eslint-plugin-react": "^6.4.1",
     "eslint-plugin-standard": "^2.0.1",
     "isparta": "^4.0.0",
-    "jsdom": "^9.8.0",
+    "jsdom": "^9.8.3",
     "mocha": "^3.1.2",
     "react-addons-test-utils": "^15.3.2",
     "react-dom": "^15.3.2",

src/actions/auth.js

@@ -8,7 +8,7 @@ import {
   AUTHENTICATION_INIT_FINISHED,
   defaultJWTKeys
 } from '../constants'
-import { capitalize, omit, isArray, isString } from 'lodash'
+import { capitalize, omit, isArray, isString, isFunction } from 'lodash'
 import jwtDecode from 'jwt-decode'
 
 /**
@@ -172,8 +172,9 @@ export const createUserProfile = (dispatch, firebase, userData, profile) =>
     .child(`${firebase._.config.userProfile}/${userData.uid}`)
     .once('value')
     .then(profileSnap =>
-      // Update the profile
-      profileSnap.ref.update(profile)
+      !firebase._.config.updateProfileOnLogin && profileSnap.val() !== null
+        ? profile
+        : profileSnap.ref.update(profile) // Update the profile
         .then(() => profile)
         .catch(err => {
           // Error setting profile
@@ -204,39 +205,54 @@ export const login = (dispatch, firebase, credentials) => {
 
   return firebase.auth()[method](...params)
     .then((userData) => {
-      // Handle null response from getRedirectResult before redirect has happen
+      // Handle null response from getRedirectResult before redirect has happened
       if (!userData) return Promise.resolve(null)
 
       // For email auth return uid (createUser is used for creating a profile)
       if (userData.email) return userData.uid
 
+      const { profileDecorator } = firebase._.config
+
       // For token auth, the user key doesn't exist. Instead, return the JWT.
       if (method === 'signInWithCustomToken') {
         // Extract the extra data in the JWT token for user object
         const { stsTokenManager: { accessToken }, uid } = userData.toJSON()
         const jwtData = jwtDecode(accessToken)
         const extraJWTData = omit(jwtData, defaultJWTKeys)
+
+        // Handle profile decorator
+        const profileData = profileDecorator && isFunction(profileDecorator)
+          ? profileDecorator(Object.assign(userData.toJSON(), extraJWTData))
+          : extraJWTData
+
         return createUserProfile(
           dispatch,
           firebase,
           { uid },
-          extraJWTData
+          profileData
         )
       }
 
       // Create profile when logging in with external provider
       const { user } = userData
-      return createUserProfile(
-        dispatch,
-        firebase,
-        user,
-        Object.assign(
+
+      // Handle profile decorator
+      const profileData = profileDecorator && isFunction(profileDecorator)
+        ? profileDecorator(user)
+        : Object.assign(
           {},
           {
             email: user.email,
+            displayName: user.providerData[0].displayName || user.email,
             providerData: user.providerData
           }
         )
+
+      return createUserProfile(
+        dispatch,
+        firebase,
+        user,
+        profileData
       )
     })
     .catch(err => {

src/compose.js

@@ -1,11 +1,13 @@
 import Firebase from 'firebase'
 import { authActions, queryActions } from './actions'
+let firebaseInstance
 
-export default (config, otherConfig) =>
-  next => (reducer, initialState) => {
+export default (config, otherConfig) => next =>
+  (reducer, initialState) => {
     const defaultConfig = {
       userProfile: null,
-      enableLogging: false
+      enableLogging: false,
+      updateProfileOnLogin: true
     }
 
     const store = next(reducer, initialState)
@@ -104,6 +106,16 @@ export default (config, otherConfig) =>
     authActions.init(dispatch, firebase)
 
     store.firebase = firebase
+    firebaseInstance = firebase
 
     return store
   }
+
+// Expose Firebase instance
+export const getFirebase = () => {
+  if (!firebaseInstance) {
+    console.error('Firebase instance does not yet exist. Check your compose function.')
+    return null
+  }
+  return firebaseInstance
+}

src/index.js

@@ -1,5 +1,5 @@
 import connect from './connect'
-import compose from './compose'
+import compose, { getFirebase } from './compose'
 import reducer from './reducer'
 import * as helpers from './helpers'
 
@@ -9,5 +9,6 @@ module.exports = {
   firebaseStateReducer: reducer,
   reduxReactFirebase: compose,
   reduxFirebase: compose,
+  getFirebase,
   helpers
 }