Version v1.4.0 Beta 2 (#100)

* fix using with yarn - `.npmignore` file removed so that `.yarn.lock` file will not be included in npm release (only files listed in package file `files` property)
* `pushWithMeta`, `setWithMeta`, and `updateWithMeta` methods added - write to firebase with createdAt/updatedAt and createdBy/updatedBy

Author: prescottprue

.npmignore

@@ -1,6 +1,6 @@
 {
   "name": "react-redux-firebase",
-  "version": "1.4.0-beta",
+  "version": "1.4.0-beta.2",
   "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",

package.json

@@ -3,6 +3,7 @@ import * as firebase from 'firebase'
 // import 'firebase/auth'
 // import 'firebase/database'
 // import 'firebase/storage'
+import { isObject } from 'lodash'
 import { defaultConfig } from './constants'
 import { validateConfig } from './utils'
 import { authActions, queryActions, storageActions } from './actions'
@@ -108,6 +109,30 @@ export default (fbConfig, otherConfig) => next =>
       configurable: true
     })
 
+    /**
+     * @private
+     * @description Calls a method and attaches meta to value object
+     * @param {String} method - Method to run with meta attached
+     * @param {String} path - Path to location on Firebase which to set
+     * @param {Object|String|Boolean|Number} value - Value to write to Firebase
+     * @param {Function} onComplete - Function to run on complete
+     * @return {Promise} Containing reference snapshot
+     */
+    const withMeta = (method, path, value, onComplete) => {
+      if (isObject(value)) {
+        const prefix = method === 'update' ? 'updated' : 'created'
+        const dataWithMeta = {
+          ...value,
+          [`${prefix}At`]: firebase.database.ServerValue.TIMESTAMP
+        }
+        if (instance.auth().currentUser) {
+          dataWithMeta[`${prefix}By`] = instance.auth().currentUser.uid
+        }
+        return rootRef.child(path)[method](dataWithMeta, onComplete)
+      }
+      return rootRef.child(path)[method](value, onComplete)
+    }
+
     /**
      * @description Sets data to Firebase.
      * @param {String} path - Path to location on Firebase which to set
@@ -127,6 +152,19 @@ export default (fbConfig, otherConfig) => next =>
     const set = (path, value, onComplete) =>
       rootRef.child(path).set(value, onComplete)
 
+    /**
+     * @description Sets data to Firebase along with meta data. Currently,
+     * this includes createdAt and createdBy. *Warning* using this function
+     * may have unintented consequences (setting createdAt even if data already
+     * exists)
+     * @param {String} path - Path to location on Firebase which to set
+     * @param {Object|String|Boolean|Number} value - Value to write to Firebase
+     * @param {Function} onComplete - Function to run on complete (`not required`)
+     * @return {Promise} Containing reference snapshot
+     */
+    const setWithMeta = (path, value, onComplete) =>
+       withMeta('set', path, value, onComplete)
+
     /**
      * @description Pushes data to Firebase.
      * @param {String} path - Path to location on Firebase which to push
@@ -146,6 +184,17 @@ export default (fbConfig, otherConfig) => next =>
     const push = (path, value, onComplete) =>
       rootRef.child(path).push(value, onComplete)
 
+    /**
+     * @description Pushes data to Firebase along with meta data. Currently,
+     * this includes createdAt and createdBy.
+     * @param {String} path - Path to location on Firebase which to set
+     * @param {Object|String|Boolean|Number} value - Value to write to Firebase
+     * @param {Function} onComplete - Function to run on complete (`not required`)
+     * @return {Promise} Containing reference snapshot
+     */
+    const pushWithMeta = (path, value, onComplete) =>
+      withMeta('push', path, value, onComplete)
+
     /**
      * @description Updates data on Firebase and sends new data.
      * @param {String} path - Path to location on Firebase which to update
@@ -165,6 +214,18 @@ export default (fbConfig, otherConfig) => next =>
     const update = (path, value, onComplete) =>
       rootRef.child(path).update(value, onComplete)
 
+    /**
+     * @description Updates data on Firebase along with meta. *Warning*
+     * using this function may have unintented consequences (setting
+     * createdAt even if data already exists)
+     * @param {String} path - Path to location on Firebase which to update
+     * @param {Object|String|Boolean|Number} value - Value to update to Firebase
+     * @param {Function} onComplete - Function to run on complete (`not required`)
+     * @return {Promise} Containing reference snapshot
+     */
+    const updateWithMeta = (path, value, onComplete) =>
+      withMeta('update', path, value, onComplete)
+
     /**
      * @description Removes data from Firebase at a given path.
      * @param {String} path - Path to location on Firebase which to remove
@@ -352,10 +413,13 @@ export default (fbConfig, otherConfig) => next =>
     firebase.helpers = {
       ref: path => firebase.database().ref(path),
       set,
+      setWithMeta,
       uniqueSet,
       push,
+      pushWithMeta,
       remove,
       update,
+      updateWithMeta,
       login,
       logout,
       uploadFile,

src/compose.js

@@ -7,7 +7,11 @@ const reducer = sinon.spy()
 const generateCreateStore = (params) =>
   compose(composeFunc(
     params ? omit(fbConfig, params) : fbConfig,
-    { userProfile: 'users', enableLogging: false, enableRedirectHandling: false }
+    {
+      userProfile: 'users',
+      enableLogging: false,
+      enableRedirectHandling: false
+    }
   ))(createStore)
 const helpers = generateCreateStore()(reducer).firebase.helpers
 
@@ -37,14 +41,36 @@ describe('Compose', () => {
       helpers.set('test', {some: 'asdf'})
     )
 
+    describe('setWithMeta', () => {
+      it('accepts object', () =>
+        helpers.setWithMeta('test', {some: 'asdf'})
+      )
+      it('does not attach meta to string', () =>
+        // TODO: confirm that data set actually does not include meta
+        helpers.setWithMeta('test', 'asdd')
+      )
+    })
+
     describe('push', () =>
       helpers.push('test', {some: 'asdf'})
     )
 
+    describe('pushWithMeta', () => {
+      it('accepts object', () =>
+        helpers.pushWithMeta('test', {some: 'asdf'})
+      )
+    })
+
     describe('update', () =>
       helpers.update('test', {some: 'asdf'})
     )
 
+    describe('updateWithMeta', () => {
+      it('accepts object', () =>
+        helpers.updateWithMeta('test', {some: 'asdf'})
+      )
+    })
+
     describe('uniqueSet', () =>{
       // remove test root after test are complete
       after(() =>