Version v1.4.0 (#133)

* `react-native` support (including [complete example](https://github.com/prescottprue/react-redux-firebase/tree/v1.4.0-beta/examples/complete/react-native) app as well as a [create your own recipe](/docs/recipes/react-native.md))
* Server Side Rendering Support ([#72](#72))
* Support for Boilerplates ([#53](#53))
* `pushWithMeta`, `setWithMeta`, and `updateWithMeta` methods added - write to firebase with createdAt/updatedAt and createdBy/updatedBy
* Fix for `unWatchEvent` helper dispatch mapping (#82)
* `populatedDataToJS` triggers `isLoaded` to be true only when all data is populated (instead of once for unpopulated data) [#121](#121)
* Support for `provider.setCustomParameters` on external auth providers (i.e. `provider.setCustomParameters({ prompt: 'select_account' })`)
* `notParsed` query param option added for not parsing when using `equalTo` (for searching numbers stored as strings)
* `profileParamsToPopulate` now works for `$key: true` lists (thanks @fej-snikduj)
* `onRedirectResult` config option added (runs when redirect result occurs)

* Improvements to Material Example
  * Projects route is now protected (using `UserIsAuthenticated` HOC from `utils/router`)
  * Todos list only displays first 8 (first at the top) - shows using ordering query params
  * Most main routes are now sync (more simple)
* Firebase Library dependency updated to [`v3.9.0`](https://firebase.google.com/support/release-notes/js)
* Fix for `unWatchEvent` helper dispatch mapping ([#82](#82))
* Firebase version is no longer fixed ([#109](#109))
* Only used parts of Firebase Library imported (shrinks bundle size)
* `build:size` npm script added to generate size report for minified bundle ([#107](#107))
* `user` and `credential` are now returned from login method (solves [#106](#106))
* `yarn.lock` file added
* Compose tests improved promise handling (better use of chai-as-promised)
* `profileParamsToPopulate` now accepts `key: true` lists - thanks [@fej-snikduj](https://github.com/fej-snikduj)

Author: prescottprue

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,8 +1,22 @@
 ### Description
 
-Write here
+<!-- Write Your Description Here -->
+
+### Questions
+<!-- Only include questions that apply to your pull request -->
+- Will a new version need to be released or is this a docs change?
+  - Which version should this be published as a part of? ("ASAP", "no idea", and specific version number)
+
+- Does this impact the external API?
+  - Will it need to be a breaking change?
 
 ### Check List
 
-- [ ] All test passed
-- [ ] Added test to ensure to fix/ensure properly.
+- [ ] All tests passing
+- [ ] Docs updated with any changes or examples
+- [ ] Added tests to ensure feature(s) work properly
+
+### Relevant Issues
+<!-- List Relevant Issues here like so:
+* [#1](https://github.com/prescottprue/react-redux-firebase/issues/#1)
+-->

.gitignore

@@ -1,12 +1,12 @@
 # Dependency directory
 node_modules
 examples/**/node_modules
-dist
 coverage
-_book
+dist
 es
 lib
+_book
 # Logs
 *.log
-
 .DS_Store
+examples/complete/react-native/ios/build

.npmignore

@@ -14,6 +14,7 @@ script:
   - npm run test:cov
 
 cache:
+  yarn: true
   directories:
     - node_modules
 

.travis.yml

@@ -1,7 +1,5 @@
 # react-redux-firebase
 
-[![Gitter][gitter-image]][gitter-url]
-
 [![NPM version][npm-image]][npm-url]
 [![NPM downloads][npm-downloads-image]][npm-url]
 [![Build Status][travis-image]][travis-url]
@@ -10,6 +8,9 @@
 [![Code Coverage][coverage-image]][coverage-url]
 [![Code Style][code-style-image]][code-style-url]
 
+[![Gitter][gitter-image]][gitter-url]
+[<img src="http://npm.packagequality.com/badge/react-redux-firebase.png" align="right"/>](http://packagequality.com/#?package=react-redux-firebase)
+
 > Redux bindings for Firebase. Includes Higher Order Component (HOC) for use with React.
 
 ## [Demo](https://demo.react-redux-firebase.com)
@@ -29,6 +30,8 @@ The [Material Example](https://github.com/prescottprue/react-redux-firebase/tree
 - [`redux-thunk`](https://github.com/gaearon/redux-thunk) and [`redux-observable`](https://redux-observable.js.org/) integrations
 - Action Types and other Constants exported for external use (such as in `redux-observable`)
 - Firebase v3+ support
+- Server Side Rendering Support
+- [`react-native` support](/docs/recipes/react-native.md)
 
 ## Install
 ```bash
@@ -183,6 +186,17 @@ export default compose(
 
 ```
 
+## Server Side Rendering
+
+Firebase's library requires XML request capability, so if you are using `react-redux-firebase` in a Server Side rendering environment, make sure you require `xmlhttprequest`.
+
+If you disagree with having to do this yourself, hop [on gitter](https://gitter.im/redux-firebase/Lobby) and let us know!
+
+```js
+// needed to fix "Error: The XMLHttpRequest compatibility library was not found."
+global.XMLHttpRequest = require('xmlhttprequest').XMLHttpRequest
+```
+
 ## [Docs](http://react-redux-firebase.com)
 See full documentation at [react-redux-firebase.com](http://react-redux-firebase.com)
 
@@ -254,9 +268,10 @@ import { pathToJS } from 'react-redux-firebase'
 export const addTodo = (newTodo) =>
   (dispatch, getState, getFirebase) => {
     const auth = pathToJS(getState.firebase, 'auth')
-    newTodo.owner = auth.uid
+    newTodo.createdBy = auth.uid //
     getFirebase()
       .push('todos', newTodo)
+      // using pushWithMeta instead would attach createdBy and createdAt automatically
       .then(() => {
         dispatch({
           type: 'TODO_CREATED',
@@ -351,6 +366,7 @@ The [examples folder](/examples) contains full applications that can be copied/a
   * `uniqueSet` method helper for only setting if location doesn't already exist
   * Object or String notation for paths (`[{ path: '/todos' }]` equivalent to `['/todos']`)
   * Action Types and other Constants are exposed for external usage (such as with `redux-observable`)
+  * Server Side Rendering Support
   * [Complete Firebase Auth Integration](http://react-redux-firebase.com/docs/auth.html#examples) including `signInWithRedirect` compatibility for OAuth Providers
 
   #### Well why not combine?

README.md

@@ -8,13 +8,16 @@
 * [Storage](/docs/storage.md)
 * [Recipes](/docs/recipes/README.md)
   * [Profile](/docs/recipes/profile.md)
-  * [Upload](/docs/recipes/upload.md)
+  * [Auth](/docs/recipes/auth.md)
   * [Actions](/docs/recipes/actions.md)
   * [Thunks](/docs/recipes/thunks.md)
   * [Epics](/docs/recipes/epics.md)
   * [Routing](/docs/recipes/routing.md)
-  * [Redux Form](/docs/recipes/redux-form.md)
   * [Populate](/docs/recipes/populate.md)
+  * [Upload](/docs/recipes/upload.md)
+  * [Redux Form](/docs/recipes/redux-form.md)
+  * [React Native](/docs/recipes/react-native.md)
+  * [Server Side Rendering](/docs/recipes/ssr.md)
 * [API Reference](/docs/api/README.md)
   * [constants](/docs/api/constants.md)
   * [firebaseConnect](/docs/api/connect.md)

SUMMARY.md

@@ -21,8 +21,15 @@ Middleware that handles configuration (placed in redux's
         profile when logging in. (default: `false`)
     -   `config.enableRedirectHandling` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not to enable
         auth redirect handling listener. (default: `true`)
+    -   `config.onAuthStateChanged` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** Function run when auth state
+        changes. Argument Pattern: `(authData, firebase, dispatch)`
+    -   `config.onRedirectResult` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** Function run when redirect
+        result is returned. Argument Pattern: `(authData, firebase, dispatch)`
+    -   `config.customAuthParameters` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Object for setting which
+        customAuthParameters are passed to external auth providers.
     -   `config.profileFactory` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** Factory for modifying how user profile is saved.
-    -   `config.uploadFileDataFactory` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** Factory for modifying how file meta data is written during file uploads
+    -   `config.uploadFileDataFactory` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** Factory for modifying
+        how file meta data is written during file uploads
     -   `config.profileParamsToPopulate` **([Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))** Parameters within
         profile object to populate
     -   `config.autoPopulateProfile` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not to
@@ -58,4 +65,18 @@ const createStoreWithFirebase = compose(
 const store = createStoreWithFirebase(rootReducer, initialState)
 ```
 
+_Custom Auth Parameters_
+
+```javascript
+// Follow Setup example with the following config:
+const config = {
+  customAuthParameters: {
+     google: {
+       // prompts user to select account on every google login
+       prompt: 'select_account'
+     }
+  }
+}
+```
+
 Returns **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** That accepts a component a returns a wrapped version of component

docs/api/compose.md

@@ -79,7 +79,7 @@ export default firebaseConnect()(SomeComponent)
 
 
 ##### Returns
-[**Promise**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) with authData in case of success or the error otherwise.
+[**Promise**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) with an object containing profile, user, (also credential if using oAuth provider) in case of success or the error otherwise.
 
 ##### Examples
 

docs/auth.md

@@ -95,7 +95,7 @@ Limit query results to the first n number of results.
   ```javascript
   @firebaseConnect([
     '/todos#limitToFirst=10'
-    // { path: '/todos', queryParams: [ 'orderByChild=owner', 'equalTo=123' ] } // object notation
+    // { path: '/todos', queryParams: [ 'orderByChild=createdBy', 'equalTo=123' ] } // object notation
   ])
   ```
 
@@ -128,7 +128,7 @@ Limit query results to include a range starting at a specific number
 
 **Internal Method**: [ `limitToLast`](https://firebase.google.com/docs/reference/js/firebase.database.Query#limitToLast)
 
-#### Example
+#### Examples
 
 1. Starting at the fifth item
   ```js
@@ -146,6 +146,9 @@ Limit query results to include a range starting at a specific number
   ```
 
 ## endAt
+
+#### Examples
+1. Usage with startAt
 ```js
 @firebaseConnect([
   'todos#orderByChild=added&startAt=1&endAt=5'
@@ -156,15 +159,41 @@ Limit query results to include a range starting at a specific number
 ## equalTo
 Limit query results with parameter equal to previous query method (i.e when used with orderByChild, it limits results with child equal to provided value). Internally runs [Firebase's `equalTo`](https://firebase.google.com/docs/reference/js/firebase.database.Query#equalTo).
 
+### Parsing
+The following are internally parsed:
+  * `null`
+  * `boolean`
+  * `number`
+
+This means the actual value will be parsed instead of the string containing the value. If you do not want this to happen, look at the `notParsed` query parameter below.
+
 #### Examples
 1. Order by child parameter
 ```js
 @firebaseConnect([
-  'todos#orderByChild=owner&equalTo=123',
-  // { path: '/todos', queryParams: [ 'orderByChild=owner', 'equalTo=123' ] } // object notation
+  'todos#orderByChild=createdBy&equalTo=ASD123',
+  // { path: '/todos', queryParams: [ 'orderByChild=createdBy', 'equalTo=ASD123' ] } // object notation
 ])
 ```
 
+## notParsed
+
+Can be used to keep internal parsing from happening. Useful when attempting to search a number string using `equalTo`
+
+#### Examples
+1. Order by child parameter equal to a number string. Equivalent of searching for `'123'` (where as not using `notParsed` would search for children equal to `123`)
+```js
+@firebaseConnect([
+  {
+    path: '/todos',
+    queryParams: [
+      'orderByChild=createdBy',
+      'notParsed', // keeps equalTo from automatically parsing
+      'equalTo=123'
+    ]
+  }
+])
+```
 
 ## Populate {#populate}
 

docs/queries.md

@@ -1,6 +1,64 @@
 # Actions
 react-redux-firebase comes with built in actions including `set`, `push`, and `update`
 
+## Components
+Firebase actions can be accessed within a component by using the `firebaseConnect` wrapper like so:
+
+#### Pure Component
+```js
+import React, { PropTypes } from 'react'
+import { firebaseConnect } from 'react-redux-firebase'
+
+const SimpleComponent = () => (
+  <button onClick={() => this.props.firebase.push({ some: 'data' })}>
+    Test Push
+  </button>
+)
+
+SimpleComponent.propTypes = {
+  firebase: PropTypes.shape({
+    push: PropTypes.func.isRequired
+  })
+}
+
+export default firebaseConnect()(SimpleComponent)
+```
+#### Stateful Component
+
+```js
+import React, { Component, PropTypes } from 'react'
+import { firebaseConnect } from 'react-redux-firebase'
+
+@firebaseConnect()
+export default class SimpleComponent extends Component {
+  static propTypes = {
+    firebase: PropTypes.shape({
+      push: PropTypes.func.isRequired
+    })
+  }
+
+  state = {
+    wasSent: false
+  }
+
+  testPush = () => {
+    this.props.firebase
+      .push({ some: 'data' })
+      .then(() => {
+        this.setState({ wasSent: true })
+      })
+  }
+
+  render() {
+    return (
+      <button onClick={this.testPush}>
+        Test Push
+      </button>
+    )
+  }
+}
+```
+
 ## Advanced Actions
 
 If you are looking to write advanced actions (i.e. multiple steps contained within one action), look at the [thunks section](/docs/recipes/thunks)