Shredder-sdk NPM

shredder-sdk

shredder Software Development Kit

API Usage

$ npm install shredder-sdk --save

'use strict';
var shredder = require('shredder-sdk')

shredder.api.updateConfig({
  master: {
    host: 'api.shredder.io',
    port: 5980
  }
})

//store the user session
var session = {}

//setup our api and login
var api = shredder.api.master()
api.postAsync({
  url: api.url('/user/login'),
  json: {
    username: 'myusername',
    password: 'mypassword'
  }
})
  .spread(api.validateResponse())
  .spread(function(res,body){
    console.log(body)
    session = body.session
  })
  .catch(api.handleNetworkError)
  .catch(shredder.NetworkError,function(err){
    console.log('A network error occurred: ' + err.message)
  })

Mock Usage

'use strict';
var shredder = require('shredder-sdk')

shredder.api.updateConfig({
  master: {
    port: 5980,
    host: '127.0.0.1'
  }
})

describe('my test',function(){
  before(function(){
    return shredder.mock.start(5980,'127.0.0.1')
  })
  after(function(){
    return shredder.mock.stop()
  })
  it('should be up',function(){
    var api = shredder.api.master()
    return api.postAsync(api.url('/ping'))
      .spread(function(res,body){
        expect(body.pong).to.equal('pong')
      })
  })
})

Changelog

2.0.0

Change to operate Couchdb rather than the Shredder master
Update dependencies and test across Node 6,8
Change from cradle to nano to provide Couchdb access
Drop Couchdb mock in favor of using real Couchdb
Matches Shredder 2.0.0 release.
Update dependencies
Update oose-sdk
Adjust calls to match oose-sdk changes

1.1.9

Fix to get the keygen tool actually working.

1.1.8

Fix to make sure keygen gets installed globally.

1.1.7

Enable sticky session support.
Add helper for generating session keys.
Shredder login now takes username and password at call time shredder.login(un,pw)