Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nisaacson/couch-profile
Store profile information in couchdb
https://github.com/nisaacson/couch-profile
Last synced: about 1 month ago
JSON representation
Store profile information in couchdb
- Host: GitHub
- URL: https://github.com/nisaacson/couch-profile
- Owner: nisaacson
- Created: 2013-02-20T02:29:40.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2013-03-17T00:51:01.000Z (over 11 years ago)
- Last Synced: 2024-09-13T17:53:32.227Z (2 months ago)
- Language: JavaScript
- Size: 227 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Store profile information in couchdb
[](https://travis-ci.org/nisaacson/couch-profile)
[](https://david-dm.org/nisaacson/couch-profile)
Dependency tracking by [David](https://david-dm.org/)
# Installation
```bash
npm install couch-profile
```
# Usage
To use the module you will first need to setup a [cradle](https://github.com/cloudhead/cradle) connection. A few views are needed in your database to use couch profiles. Look in the /docs/ folder to see the views needed. You can easily create these view using the [couchdb-update-views](https://github.com/nisaacson/couchdb-update-views)
## API
Look at index.js to see the full public api available. The following functions are available for use
- findProfile
- getOrCreateProfile
- checkPassword
- hashPassword
## Instatiate Views
```bash
npm install -g couchdb-update-views
couchdb-update-views --config --docsDir /docs
```
## Get Or Create Profile
This will automatically create a new profile if needed. Use **findProfile** if you just want to lookup a profile without creating one
```javascript
var couchProfile = require('couch-profile')
var db =
var profileData = {
db: db,
email: '[email protected]',
password: 'barPass' // this will be salted and hashed before storage
}
couchProfile.getOrCreateProfile(profileData, function(err, profile) {
if (err) {
inspect(err, 'error getting profile')
return
}
inspect(profile, 'got couch profile')
})
```
## Find Profile
Lookup a profile but don't create new ones
```javascript
var couchProfile = require('couch-profile')
var db =
var profileData = {
db: db,
email: '[email protected]'
}
couchProfile.getProfile(profileData, function(err, profile) {
if (err) {
inspect(err, 'error getting profile')
return
}
inspect(profile, 'got couch profile')
})
```
## Passwords
If you create a profile with a **password** field, it will be salted and hashed and stored in a hash field. The actual password value is not stored. Hashing is done with the native nodejs bcrypt implementation [https://github.com/shaneGirish/bcrypt-nodejs](https://github.com/shaneGirish/bcrypt-nodejs)
```javascript
var bcrypt = require('bcrypt-nodejs')
var couchProfile = require('couch-profile')
var password = 'fooBarPass'
couchProfile.hashPassword(profileData, function(err, profile) {
if (err) {
inspect(err, 'error hashing password')
return
}
inspect(password, 'original raw password')
inspect(reply, 'hashed password')
bcrypt.compare(password, hash, function (err, reply) {
if (err) {
inspect(err, 'erorr checking if hashed password matches')
return
}
inspect(reply, 'does hash check out? ')
})
})
```