box-view-api

<html> <head> <meta charset="utf-8"> <title>Box View API: Tests Results</title> <link rel="stylesheet" href="docGen.css" /> <script src="http://code.jquery.com/jquery-1.10.1.min.js"></script> </head> <body> <h1>Box View API: Tests Results</h1> <div id="test-results"> <section class="suite"> <h1>Box View API: Test framework tests</h1> <dl> <dt class="test pass collapsed">should be a truthy global</dt> <dd class="test pass collapsed"><pre><code>assert(framework, 'Expected global framework to be truthy, not: '+framework);</code></pre></dd> <dt class="test pass collapsed">should be an object</dt> <dd class="test pass collapsed"><pre><code>assert(typeof framework === 'object', 'Expected framework to be an object, not: '+(typeof framework));</code></pre></dd> <section class="suite"> <h1>.assert</h1> <dl> <dt class="test pass collapsed">should be truthy</dt> <dd class="test pass collapsed"><pre><code>assert(framework.assert, 'Expected framework.assert to be truthy, not: '+framework.assert);</code></pre></dd> <dt class="test pass collapsed">should be a function</dt> <dd class="test pass collapsed"><pre><code>assert(typeof framework.assert === 'function', 'Expected framework.assert to be a function, not: '+(typeof framework.assert));</code></pre></dd> </dl> </section> <section class="suite"> <h1>.url</h1> <dl> <dt class="test pass collapsed">should be truthy</dt> <dd class="test pass collapsed"><pre><code>assert(framework.url, 'Expected framework.url to be truthy, not: '+framework.url);</code></pre></dd> <dt class="test pass collapsed">should be an object</dt> <dd class="test pass collapsed"><pre><code>assert(typeof framework.url === 'object', 'Expected framework.url to be an object, not: '+(typeof framework.url));</code></pre></dd> </dl> </section> <section class="suite"> <h1>.path</h1> <dl> <dt class="test pass collapsed">should be truthy</dt> <dd class="test pass collapsed"><pre><code>assert(framework.path, 'Expected framework.path to be truthy, not: '+framework.path);</code></pre></dd> <dt class="test pass collapsed">should be an object</dt> <dd class="test pass collapsed"><pre><code>assert(typeof framework.path === 'object', 'Expected framework.path to be an object, not: '+(typeof framework.path));</code></pre></dd> </dl> </section> <section class="suite"> <h1>.qs</h1> <dl> <dt class="test pass collapsed">should be truthy</dt> <dd class="test pass collapsed"><pre><code>assert(framework.qs, 'Expected framework.qs to be truthy, not: '+framework.qs);</code></pre></dd> <dt class="test pass collapsed">should be an object</dt> <dd class="test pass collapsed"><pre><code>assert(typeof framework.qs === 'object', 'Expected framework.qs to be an object, not: '+(typeof framework.qs));</code></pre></dd> </dl> </section> <section class="suite"> <h1>.inspect</h1> <dl> <dt class="test pass collapsed">should be truthy</dt> <dd class="test pass collapsed"><pre><code>assert(framework.inspect, 'Expected framework.inspect to be truthy, not: '+framework.inspect);</code></pre></dd> <dt class="test pass collapsed">should be a function</dt> <dd class="test pass collapsed"><pre><code>assert(typeof framework.inspect === 'function', 'Expected framework.inspect to be a function, not: '+(typeof framework.inspect));</code></pre></dd> </dl> </section> <section class="suite"> <h1>.exec</h1> <dl> <dt class="test pass collapsed">should be truthy</dt> <dd class="test pass collapsed"><pre><code>assert(framework.exec, 'Expected framework.exec to be truthy, not: '+framework.exec);</code></pre></dd> <dt class="test pass collapsed">should be a function</dt> <dd class="test pass collapsed"><pre><code>assert(typeof framework.exec === 'function', 'Expected framework.exec to be a function, not: '+(typeof framework.exec));</code></pre></dd> </dl> </section> <section class="suite"> <h1>.throwsError</h1> <dl> <dt class="test pass collapsed">should be truthy</dt> <dd class="test pass collapsed"><pre><code>assert(framework.throwsError, 'Expected framework.throwsError to be truthy, not: '+framework.throwsError);</code></pre></dd> <dt class="test pass collapsed">should be a function</dt> <dd class="test pass collapsed"><pre><code>assert(typeof framework.throwsError === 'function', 'Expected framework.throwsError to be a function, not: '+(typeof framework.throwsError));</code></pre></dd> </dl> </section> <section class="suite"> <h1>.values</h1> <dl> <dt class="test pass collapsed">should be truthy</dt> <dd class="test pass collapsed"><pre><code>assert(framework.values, 'Expected framework.values to be truthy, not: '+framework.values);</code></pre></dd> <dt class="test pass collapsed">should be an object</dt> <dd class="test pass collapsed"><pre><code>assert(typeof framework.values === 'object', 'Expected framework.values to be an object, not: '+(typeof framework.values));</code></pre></dd> <section class="suite"> <h1>.invalidParamList</h1> <dl> <dt class="test pass collapsed">should be truthy</dt> <dd class="test pass collapsed"><pre><code>assert(framework.values.invalidParamList, 'Expected framework.values.invalidParamList to be truthy, not: '+framework.values.invalidParamList);</code></pre></dd> <dt class="test pass collapsed">should be an object</dt> <dd class="test pass collapsed"><pre><code>assert(typeof framework.values.invalidParamList === 'object', 'Expected framework.values.invalidParamList to be an object, not: '+(typeof framework.values.invalidParamList));</code></pre></dd> </dl> </section> </dl> </section> <section class="suite"> <h1>.instanceMethodTests</h1> <dl> <dt class="test pass collapsed">should be truthy</dt> <dd class="test pass collapsed"><pre><code>assert(framework.instanceMethodTests, 'Expected framework.instanceMethodTests to be truthy, not: ' + framework.instanceMethodTests);</code></pre></dd> <dt class="test pass collapsed">should be a function</dt> <dd class="test pass collapsed"><pre><code>assert(typeof framework.instanceMethodTests === 'function', 'Expected framework.instanceMethodTests to be a function, not: ' + (typeof framework.instanceMethodTests));</code></pre></dd> </dl> </section> <section class="suite"> <h1>.boxView</h1> <dl> <dt class="test pass collapsed">should be truthy</dt> <dd class="test pass collapsed"><pre><code>assert(framework.boxView, 'Expected framework.boxView to be truthy, not: '+framework.boxView);</code></pre></dd> <dt class="test pass collapsed">should be an object</dt> <dd class="test pass collapsed"><pre><code>assert(typeof framework.boxView === 'object', 'Expected framework.boxView to be an object, not: '+(typeof framework.boxView));</code></pre></dd> <section class="suite"> <h1>.validApiKey</h1> <dl> <dt class="test pass collapsed">should be a string</dt> <dd class="test pass collapsed"><pre><code>assert(typeof framework.boxView.validApiKey === 'string', 'Expected framework.boxView.validApiKey to be a string, not: '+(typeof framework.boxView.validApiKey));</code></pre></dd> <dt class="test pass collapsed">should be non blank</dt> <dd class="test pass collapsed"><pre><code>assert(typeof framework.boxView.validApiKey === 'string' && framework.boxView.validApiKey.length > 0, 'Expected framework.boxView.validApiKey to be non-blank');</code></pre></dd> </dl> </section> <section class="suite"> <h1>.dummyApiKey</h1> <dl> <dt class="test pass collapsed">should be a string</dt> <dd class="test pass collapsed"><pre><code>assert(typeof framework.boxView.dummyApiKey === 'string', 'Expected framework.boxView.dummyApiKey to be a string, not: ' + (typeof framework.boxView.dummyApiKey));</code></pre></dd> <dt class="test pass collapsed">should be non blank</dt> <dd class="test pass collapsed"><pre><code>assert(typeof framework.boxView.dummyApiKey === 'string' && framework.boxView.validApiKey.length > 0, 'Expected framework.boxView.dummyApiKey to be non-blank');</code></pre></dd> </dl> </section> </dl> </section> </dl> </section> <section class="suite"> <h1>Box View API: NodeJS API: base</h1> <dl> <section class="suite"> <h1>constructor</h1> <dl> <dt class="test pass collapsed">should throw an error with no API Key</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function(){new API();});</code></pre></dd> <dt class="test pass collapsed">should throw an error if too many args are passed</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function(){new API(framework.boxView.dummyApiKey, 1);});</code></pre></dd> <dt class="test pass collapsed">should throw errors with invalid API Token parameters</dt> <dd class="test pass collapsed"><pre><code>framework.values.invalidParamList.forEach(function(e) { framework.throwsError(function() { new API(e.value); }, 'Expected an error with an API Token of type '+e.name); });</code></pre></dd> <dt class="test pass collapsed">should NOT throw an error with a non-empty API Key string</dt> <dd class="test pass collapsed"><pre><code>new API(framework.boxView.dummyApiKey);</code></pre></dd> </dl> </section> <section class="suite"> <h1>instance</h1> <dl> <dt class="test pass collapsed">should have a uriString function</dt> <dd class="test pass collapsed"><pre><code>framework.assert(typeof instance.uriString === 'function');</code></pre></dd> <dt class="test pass collapsed">should have a post function</dt> <dd class="test pass collapsed"><pre><code>framework.assert(typeof instance.post === 'function');</code></pre></dd> <dt class="test pass collapsed">should have a put function</dt> <dd class="test pass collapsed"><pre><code>framework.assert(typeof instance.put === 'function');</code></pre></dd> <dt class="test pass collapsed">should have a get function</dt> <dd class="test pass collapsed"><pre><code>framework.assert(typeof instance.get === 'function');</code></pre></dd> <dt class="test pass collapsed">should have a del function</dt> <dd class="test pass collapsed"><pre><code>framework.assert(typeof instance.del === 'function');</code></pre></dd> <section class="suite"> <h1>.uriString()</h1> <dl> <dt class="test pass collapsed">should throw errors with invalid resource parameters</dt> <dd class="test pass collapsed"><pre><code>framework.values.invalidParamList.forEach(function(e) { framework.throwsError(function() { instance.uriString(e.value); }, 'Expected an error with a resource param of type '+e.name); });</code></pre></dd> <dt class="test pass collapsed">should create the correct uri for a resource (https://view-api.box.com/1/some/resource)</dt> <dd class="test pass collapsed"><pre><code>framework.assert(uriResource === uriBase, 'URI is not correct URI base: '+uriResource);</code></pre></dd> <dt class="test pass collapsed">should create a uri from a querystring which starts with the resource URI (https://view-api.box.com/1/some/resource)</dt> <dd class="test pass collapsed"><pre><code>framework.assert(uriFromQS.indexOf(uriBase) === 0, 'URI does not start with resource URI: '+uriFromQS);</code></pre></dd> <dt class="test pass collapsed">should create a uri from a query hash which starts with the resource URI (https://view-api.box.com/1/some/resource)</dt> <dd class="test pass collapsed"><pre><code>framework.assert(uriFromQuery.indexOf(uriBase) === 0, 'URI does not start with resource URI: '+uriFromQuery);</code></pre></dd> </dl> </section> <section class="suite"> <h1>.post()</h1> <dl> <dt class="test pass collapsed">should not throw an error when called with a non-blank string resource, and a function callback</dt> <dd class="test pass collapsed"><pre><code>getInstance()[method].apply(getInstance(), goodParams[i].args);</code></pre></dd> <dt class="test pass collapsed">should not throw an error when called with a non-blank string resource, an options hash, and a function callback</dt> <dd class="test pass collapsed"><pre><code>getInstance()[method].apply(getInstance(), goodParams[i].args);</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with no parameters</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a callback only</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, no options, no callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, an options hash, no callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, an options hash, a callback, and a extra parameter</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a blank string resource, an options hash, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-string resource, an options hash, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, non-object options, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, an options hash, and a non function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> </dl> </section> <section class="suite"> <h1>.put()</h1> <dl> <dt class="test pass collapsed">should not throw an error when called with a non-blank string resource, and a function callback</dt> <dd class="test pass collapsed"><pre><code>getInstance()[method].apply(getInstance(), goodParams[i].args);</code></pre></dd> <dt class="test pass collapsed">should not throw an error when called with a non-blank string resource, an options hash, and a function callback</dt> <dd class="test pass collapsed"><pre><code>getInstance()[method].apply(getInstance(), goodParams[i].args);</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with no parameters</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a callback only</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, no options, no callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, an options hash, no callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, an options hash, a callback, and a extra parameter</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a blank string resource, an options hash, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-string resource, an options hash, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, non-object options, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, an options hash, and a non function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> </dl> </section> <section class="suite"> <h1>.get()</h1> <dl> <dt class="test pass collapsed">should not throw an error when called with a non-blank string resource, and a function callback</dt> <dd class="test pass collapsed"><pre><code>getInstance()[method].apply(getInstance(), goodParams[i].args);</code></pre></dd> <dt class="test pass collapsed">should not throw an error when called with a non-blank string resource, an options hash, and a function callback</dt> <dd class="test pass collapsed"><pre><code>getInstance()[method].apply(getInstance(), goodParams[i].args);</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with no parameters</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a callback only</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, no options, no callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, an options hash, no callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, an options hash, a callback, and a extra parameter</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a blank string resource, an options hash, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-string resource, an options hash, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, non-object options, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, an options hash, and a non function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> </dl> </section> <section class="suite"> <h1>.del()</h1> <dl> <dt class="test pass collapsed">should not throw an error when called with a non-blank string resource, and a function callback</dt> <dd class="test pass collapsed"><pre><code>getInstance()[method].apply(getInstance(), goodParams[i].args);</code></pre></dd> <dt class="test pass collapsed">should not throw an error when called with a non-blank string resource, an options hash, and a function callback</dt> <dd class="test pass collapsed"><pre><code>getInstance()[method].apply(getInstance(), goodParams[i].args);</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with no parameters</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a callback only</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, no options, no callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, an options hash, no callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, an options hash, a callback, and a extra parameter</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a blank string resource, an options hash, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-string resource, an options hash, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, non-object options, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string resource, an options hash, and a non function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> </dl> </section> </dl> </section> </dl> </section> <section class="suite"> <h1>Box View API: NodeJS API: document</h1> <dl> <section class="suite"> <h1>constructor</h1> <dl> <dt class="test pass collapsed">should throw an error with no API Token</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function() { new API(); });</code></pre></dd> <dt class="test pass collapsed">should throw an error if too many params are passed</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function() { new API(framework.boxView.dummyApiKey, 1); });</code></pre></dd> <dt class="test pass collapsed">should throw an error with a undefined param</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function() { new API(framework.values.invalidParamList[k].value); });</code></pre></dd> <dt class="test pass collapsed">should throw an error with a null param</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function() { new API(framework.values.invalidParamList[k].value); });</code></pre></dd> <dt class="test pass collapsed">should throw an error with a number param</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function() { new API(framework.values.invalidParamList[k].value); });</code></pre></dd> <dt class="test pass collapsed">should throw an error with a boolean, true param</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function() { new API(framework.values.invalidParamList[k].value); });</code></pre></dd> <dt class="test pass collapsed">should throw an error with a boolean, false param</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function() { new API(framework.values.invalidParamList[k].value); });</code></pre></dd> <dt class="test pass collapsed">should throw an error with a object param</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function() { new API(framework.values.invalidParamList[k].value); });</code></pre></dd> <dt class="test pass collapsed">should throw an error with a function param</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function() { new API(framework.values.invalidParamList[k].value); });</code></pre></dd> <dt class="test pass collapsed">should throw an error with a empty array param</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function() { new API(framework.values.invalidParamList[k].value); });</code></pre></dd> <dt class="test pass collapsed">should throw an error with a empty string param</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function() { new API(framework.values.invalidParamList[k].value); });</code></pre></dd> <dt class="test pass collapsed">should NOT throw an error with a non-empty API Token string</dt> <dd class="test pass collapsed"><pre><code>new API(framework.boxView.dummyApiKey);</code></pre></dd> </dl> </section> <section class="suite"> <h1>instance</h1> <dl> <dt class="test pass collapsed">should have an uploadUrl function</dt> <dd class="test pass collapsed"><pre><code>framework.assert(typeof instance.uploadUrl === 'function');</code></pre></dd> <dt class="test pass collapsed">should have a list function</dt> <dd class="test pass collapsed"><pre><code>framework.assert(typeof instance.list === 'function');</code></pre></dd> <dt class="test pass collapsed">should have an info function</dt> <dd class="test pass collapsed"><pre><code>framework.assert(typeof instance.info === 'function');</code></pre></dd> <dt class="test pass collapsed">should have a changeName function</dt> <dd class="test pass collapsed"><pre><code>framework.assert(typeof instance.changeName === 'function');</code></pre></dd> <dt class="test pass collapsed">should have a download function</dt> <dd class="test pass collapsed"><pre><code>framework.assert(typeof instance.download === 'function');</code></pre></dd> <dt class="test pass collapsed">should have a remove function</dt> <dd class="test pass collapsed"><pre><code>framework.assert(typeof instance.remove === 'function');</code></pre></dd> <dt class="test pass collapsed">should have a poll function</dt> <dd class="test pass collapsed"><pre><code>framework.assert(typeof instance.poll === 'function');</code></pre></dd> <section class="suite"> <h1>.uploadUrl()</h1> <dl> <dt class="test pass collapsed">should not throw an error when called with non-blank string url and filename parameters, and function callback</dt> <dd class="test pass collapsed"><pre><code>getInstance()[method].apply(getInstance(), goodParams[i].args);</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with no parameters</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a single string parameter</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a single function parameter</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with non-blank string url and filename parameters, and no callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a string parameter and a function parameter</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a blank string url parameter, a non-blank string filename parameter and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string url parameter, a blank string filename parameter and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with non-blank string url and filename parameters, and a non-function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with non-blank string url and filename parameters, a function callback, and some other parameter</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> </dl> </section> <section class="suite"> <h1>.list()</h1> <dl> <dt class="test pass collapsed">should not throw an error when called with a function callback</dt> <dd class="test pass collapsed"><pre><code>getInstance()[method].apply(getInstance(), goodParams[i].args);</code></pre></dd> <dt class="test pass collapsed">should not throw an error when called with an options hash, and a function callback</dt> <dd class="test pass collapsed"><pre><code>getInstance()[method].apply(getInstance(), goodParams[i].args);</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with no parameters</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a single non-function parameter</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-object options parameter, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with an options hash, a function callback, and another parameter</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> </dl> </section> <section class="suite"> <h1>.info()</h1> <dl> <dt class="test pass collapsed">should not throw an error when called with a non-blank string document id, and a function callback</dt> <dd class="test pass collapsed"><pre><code>getInstance()[method].apply(getInstance(), goodParams[i].args);</code></pre></dd> <dt class="test pass collapsed">should not throw an error when called with a non-blank string document id, a non-blank string of fields, and a function callback</dt> <dd class="test pass collapsed"><pre><code>getInstance()[method].apply(getInstance(), goodParams[i].args);</code></pre></dd> <dt class="test pass collapsed">should not throw an error when called with a non-blank string document id, an array of field names, and a function callback</dt> <dd class="test pass collapsed"><pre><code>getInstance()[method].apply(getInstance(), goodParams[i].args);</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with no parameters</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a blank string document id, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-string document id, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string document id, a non-string / non-array field names, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string document id, a non-blank string of field names, a function callback, and some additional parameter</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> </dl> </section> <section class="suite"> <h1>.changeName()</h1> <dl> <dt class="test pass collapsed">should not throw an error when called with a non-blank string document id, a non-blank string name, and a function callback</dt> <dd class="test pass collapsed"><pre><code>getInstance()[method].apply(getInstance(), goodParams[i].args);</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with no parameters</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string document id, a non-blank string name, and a no function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string document id, a non-blank string name, and a non- function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a blank string document id, a non-blank string name, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-string document id, a non-blank string name, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string document id, a blank string name, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string document id, a non-string name, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with non-blank string document id and name, a function callback, and some additional parameter</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> </dl> </section> <section class="suite"> <h1>.download()</h1> <dl> <dt class="test pass collapsed">should not throw an error when called with a non-blank string document id, a pdf download type, a write stream, and a function callback</dt> <dd class="test pass collapsed"><pre><code>getInstance()[method].apply(getInstance(), goodParams[i].args);</code></pre></dd> <dt class="test pass collapsed">should not throw an error when called with a non-blank string document id, a zip download type, a write stream, and a function callback</dt> <dd class="test pass collapsed"><pre><code>getInstance()[method].apply(getInstance(), goodParams[i].args);</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with no parameters</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string document id, a non-zip / non-pdf download type, a write stream, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string document id, a pdf download type, no write stream, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string document id, a zip download type, no write stream, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string document id, a pdf download type, a non write stream, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string document id, a zip download type, a non write stream, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string document id, a pdf download type, no write stream, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string document id, a zip download type, no write stream, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string document id, a pdf download type, a write stream, and no function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string document id, a zip download type, a write stream, and no function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string document id, a pdf download type, a write stream, and a non function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a non-blank string document id, a zip download type, a write stream, and a non function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a blank string document id, a pdf download type, a write stream, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error when called with a blank string document id, a zip download type, a write stream, and a function callback</dt> <dd class="test pass collapsed"><pre><code>framework.throwsError(function () { getInstance()[method].apply(getInstance(), badParams[i].args); });</code></pre></dd> <dt class="test pass collapsed">should throw an error whe