Oose-sdk NPM | npm.io

oose-sdk

OOSE Software Development Kit

API Usage

$ npm install oose-sdk --save

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

oose.api.updateConfig({
  prism: {
    host: 'prism.oose.io',
    port: 5972
  }
})

//store the user session
var session = {}

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

Mock Usage

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

oose.api.updateConfig({
  prism: {
    port: 3001,
    host: '127.0.0.1'
  }
})

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

Changelog

3.1.2

Prism jobDetail no longer users api.validateResponse as jobDetail may throw false errors just from reporting the job status

3.1.1

Remove UserError being thrown by validate response
Validate response will also now forward raw responses
Update tp promisepipe 2.1.1

3.1.0

Add Job API to Prism

3.0.1

Does not export the Shredder object. Job object coming in 3.1
Fix issues with mime 2.0 support
Update license file to match package.json of GPL3+

3.0.0

Updated to work with OOSE 3.0.0 which is switching to Couchbase
Implements Shredder into the OOSE system which has been renamed to Job

2.2.2

Upgrade dependencies
Fix bug with authentication mapping

2.2.1

Change mock structure to support the idea of the "hash" name for identifying files vs the "sha1" name that predetermined the type of hash being used.

2.2.0

Drop old access setup shortcuts that were related dynamic services
BREAKING CHANGE: api.prism(), api.store() need to replaced with api.setupAccess('prism',config.prism) and api.setupAccess('store',config.store)

2.1.0

Update dependencies and bluebird implementation

2.0.2

URL builder helpers no longer produce protocol forced URLs such as (http://)

2.0.1

Fix issue with keygen passing configuration params
Fix issue with Prism class wrongfully falling back on configuration params

2.0.0

Update packages and dependencies
Drop API methods removed in OOSE 2.0.0
passwordReset

1.4.1

Remove a mistakenly left console log.

1.4.0

Upgraded to run with node 4.x
Skipped version 1.3.x to match the main OOSE release of 1.4.0
Upgraded all dependencies
Fixed bug that causes timeout msecs not a number issue

1.2.0

Purchases now require the file extension and will no longer supply it this is a breaking change to all integrations.

1.1.10

Since node has started checking SSL certs without giving the user a chance to intervene we have to set rejectUnauthorized: false by default now. Have also had to add process.env.NODE_TLS_REJECT_UNAUTHORIZED = 0 unfortunately.