Skip to content

Commit 741e9bd

Browse files
committed
1.1.2 Release
This commit signifies the 1.1.2 release of the project. This release contains minor revisions and additional testing. With this release test coverage is now complete. Signed-off-by: Lui de la Parra <[email protected]>
1 parent 6f9b288 commit 741e9bd

15 files changed

+198
-200
lines changed

README.md

Lines changed: 89 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ For in depth documentation head to the [`docs`](https://luidog.github.io/fms-api
66

77
## Installation
88

9-
This is a [Node.js](https://nodejs.org/) module available through the
10-
[npm registry](https://www.npmjs.com/). It can be installed using the
9+
This is a [Node.js](https://nodejs.org/) module available through the
10+
[npm registry](https://www.npmjs.com/). It can be installed using the
1111
[`npm`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally)
12-
or
12+
or
1313
[`yarn`](https://yarnpkg.com/en/)
1414
command line tools.
1515

@@ -31,7 +31,7 @@ const colors = require('colors');
3131
const environment = require('dotenv');
3232
const varium = require('varium');
3333
const { connect } = require('marpat');
34-
const { Filemaker } = require('./index.js');
34+
const { Filemaker } = require('fms-api-client');
3535
environment.config({ path: './tests/.env' });
3636

3737
varium(process.env, './tests/env.manifest');
@@ -219,6 +219,7 @@ const rewind = () => {
219219
};
220220

221221
setTimeout(() => rewind(), 10000);
222+
222223
```
223224

224225
## Tests
@@ -227,129 +228,132 @@ setTimeout(() => rewind(), 10000);
227228
npm install
228229
npm test
229230
```
230-
231231
```
232-
> [email protected] test /Users/luidelaparra/Documents/Development/fms-api-client
232+
233+
> [email protected] test /fms-api-client
233234
> nyc _mocha --recursive ./tests --timeout=30000
234235
Authentication Capabilities
235-
✓ should authenticate into FileMaker. (144ms)
236-
✓ should automatically request an authentication token (169ms)
237-
✓ should reuse a saved authentication token (164ms)
238-
✓ should log out of the filemaker. (158ms)
236+
✓ should authenticate into FileMaker. (238ms)
237+
✓ should automatically request an authentication token (172ms)
238+
✓ should reuse a saved authentication token (156ms)
239+
✓ should log out of the filemaker. (152ms)
239240
✓ should not attempt a logout if there is no valid token.
240-
✓ should reject if the logout request fails (153ms)
241-
✓ should reject if the authentication request fails (1407ms)
241+
✓ should reject if the logout request fails (163ms)
242+
✓ should reject if the authentication request fails (1405ms)
242243
Create Capabilities
243-
✓ should create FileMaker records. (160ms)
244-
✓ should reject bad data with an error (153ms)
245-
✓ should create FileMaker records with mixed types (157ms)
244+
✓ should create FileMaker records. (149ms)
245+
✓ should reject bad data with an error (158ms)
246+
✓ should create FileMaker records with mixed types (159ms)
246247
Delete Capabilities
247-
✓ should delete FileMaker records. (238ms)
248-
✓ should reject deletions that do not specify a recordId (161ms)
248+
✓ should delete FileMaker records. (249ms)
249+
✓ should reject deletions that do not specify a recordId (157ms)
249250
Edit Capabilities
250251
✓ should edit FileMaker records.
251-
✓ should reject bad data with an error (255ms)
252+
✓ should reject bad data with an error (240ms)
252253
Find Capabilities
253-
✓ should perform a find request (191ms)
254-
✓ should allow you to use an object instead of an array for a find (194ms)
255-
✓ should specify omit Criterea (189ms)
256-
✓ should allow additional parameters to manipulate the results (163ms)
257-
✓ should allow you to use numbers in the find query parameters (165ms)
258-
✓ should allow you to sort the results (191ms)
259-
✓ should return an empty array if the find does not return results (166ms)
260-
✓ should allow you run a pre request script (175ms)
261-
✓ should return a response even if a script fails (171ms)
262-
✓ should allow you to send a parameter to the pre request script (164ms)
263-
✓ should allow you run script after the find and before the sort (195ms)
264-
✓ should allow you to pass a parameter to a script after the find and before the sort (201ms)
265-
✓ should reject of there is an issue with the find request (155ms)
254+
✓ should perform a find request (199ms)
255+
✓ should allow you to use an object instead of an array for a find (163ms)
256+
✓ should specify omit Criterea (201ms)
257+
✓ should allow additional parameters to manipulate the results (167ms)
258+
✓ should allow you to use numbers in the find query parameters (153ms)
259+
✓ should allow you to sort the results (172ms)
260+
✓ should return an empty array if the find does not return results (156ms)
261+
✓ should allow you run a pre request script (172ms)
262+
✓ should return a response even if a script fails (182ms)
263+
✓ should allow you to send a parameter to the pre request script (162ms)
264+
✓ should allow you run script after the find and before the sort (181ms)
265+
✓ should allow you to pass a parameter to a script after the find and before the sort (177ms)
266+
✓ should reject of there is an issue with the find request (162ms)
266267
Get Capabilities
267-
✓ should get specific FileMaker records. (238ms)
268-
✓ should reject get requests that do not specify a recordId (234ms)
268+
✓ should get specific FileMaker records. (247ms)
269+
✓ should reject get requests that do not specify a recordId (235ms)
269270
Global Capabilities
270-
✓ should allow you to set FileMaker globals (167ms)
271-
✓ should reject with a message and code if it fails to set a global (158ms)
271+
✓ should allow you to set FileMaker globals (164ms)
272+
✓ should reject with a message and code if it fails to set a global (150ms)
272273
List Capabilities
273-
✓ should allow you to list records (194ms)
274-
✓ should allow you use parameters to modify the list response (160ms)
275-
✓ should should allow you to use numbers in parameters (158ms)
276-
✓ should modify requests to comply with DAPI name reservations (151ms)
277-
✓ should allow strings while complying with DAPI name reservations (156ms)
274+
✓ should allow you to list records (209ms)
275+
✓ should allow you use parameters to modify the list response (154ms)
276+
✓ should should allow you to use numbers in parameters (160ms)
277+
✓ should modify requests to comply with DAPI name reservations (152ms)
278+
✓ should allow strings while complying with DAPI name reservations (154ms)
278279
✓ should allow you to offset the list response (164ms)
279-
✓ should reject requests that use unexpected parameters (154ms)
280+
✓ should reject requests that use unexpected parameters (152ms)
280281
Script Capabilities
281-
✓ should allow you to trigger a script in FileMaker (171ms)
282-
✓ should allow you to trigger a script in FileMaker (175ms)
282+
✓ should allow you to trigger a script in FileMaker (169ms)
283+
✓ should allow you to trigger a script in FileMaker (183ms)
283284
✓ should allow you to trigger a script in a find (206ms)
284-
✓ should allow you to trigger a script in a list (158ms)
285-
✓ should allow reject a script that does not exist (151ms)
286-
✓ should allow return a result even if a script returns an error (167ms)
287-
✓ should parse script results if the results are json (169ms)
288-
✓ should not parse script results if the results are not json (163ms)
285+
✓ should allow you to trigger a script in a list (173ms)
286+
✓ should allow reject a script that does not exist (157ms)
287+
✓ should allow return a result even if a script returns an error (171ms)
288+
✓ should parse script results if the results are json (163ms)
289+
✓ should not parse script results if the results are not json (180ms)
289290
Storage
290291
✓ should allow an instance to be created
291292
✓ should allow an instance to be saved.
292293
✓ should allow an instance to be recalled
293294
✓ should allow insances to be listed
294295
✓ should allow you to remove an instance
295296
File Upload Capabilities
296-
✓ should allow you to upload a file to a new record (1644ms)
297-
✓ should allow you to upload a file to a specific container repetition (1346ms)
298-
✓ should reject with a message if it can not find the file to upload (157ms)
299-
✓ should allow you to upload a file to a specific record (1326ms)
297+
✓ should allow you to upload a file to a new record (1400ms)
298+
✓ should allow you to upload a file to a specific container repetition (1426ms)
299+
✓ should reject with a message if it can not find the file to upload (159ms)
300+
✓ should allow you to upload a file to a specific record (1417ms)
301+
✓ should allow you to upload a file to a specific record container repetition (1424ms)
302+
✓ should reject of the request is invalid (304ms)
300303
Data Usage Tracking Capabilities
301-
✓ should track API usage data. (167ms)
302-
✓ should allow you to reset usage data. (161ms)
304+
✓ should track API usage data. (164ms)
305+
✓ should allow you to reset usage data. (158ms)
303306
Utility Capabilities
304-
✓ should extract field while maintaining the array (243ms)
305-
✓ should extract field data while maintaining the object (236ms)
307+
✓ should extract field while maintaining the array (235ms)
308+
✓ should extract field data while maintaining the object (248ms)
306309
✓ should extract the recordId while maintaining the array (239ms)
307-
✓ should extract field data while maintaining the object (231ms)
308-
61 passing (15s)
310+
✓ should extract field data while maintaining the object (230ms)
311+
63 passing (16s)
309312
-----------------------|----------|----------|----------|----------|-------------------|
310313
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s |
311314
-----------------------|----------|----------|----------|----------|-------------------|
312-
All files | 100 | 95 | 100 | 100 | |
315+
All files | 100 | 100 | 100 | 100 | |
313316
fms-api-client | 100 | 100 | 100 | 100 | |
314317
index.js | 100 | 100 | 100 | 100 | |
315-
fms-api-client/src | 100 | 95 | 100 | 100 | |
316-
client.model.js | 100 | 94.74 | 100 | 100 | 194,581 |
318+
fms-api-client/src | 100 | 100 | 100 | 100 | |
319+
client.model.js | 100 | 100 | 100 | 100 | |
317320
connection.model.js | 100 | 100 | 100 | 100 | |
318321
credentials.model.js | 100 | 100 | 100 | 100 | |
319322
data.model.js | 100 | 100 | 100 | 100 | |
320323
index.js | 100 | 100 | 100 | 100 | |
321324
-----------------------|----------|----------|----------|----------|-------------------|
325+
322326
```
323327

324328
## Dependencies
325329

326-
* [axios](https://ghub.io/axios): Promise based HTTP client for the browser and node.js
327-
* [form-data](https://ghub.io/form-data): A library to create readable &quot;multipart/form-data&quot; streams. Can be used to submit forms and file uploads to other web applications.
328-
* [lodash](https://ghub.io/lodash): Lodash modular utilities.
329-
* [marpat](https://ghub.io/marpat): A class-based ES6 ODM for Mongo-like databases.
330-
* [moment](https://ghub.io/moment): Parse, validate, manipulate, and display dates
331-
* [object-sizeof](https://ghub.io/object-sizeof): Sizeof of a JavaScript object in Bytes
332-
* [prettysize](https://ghub.io/prettysize): Convert bytes to other sizes for prettier logging
330+
- [axios](https://ghub.io/axios): Promise based HTTP client for the browser and node.js
331+
- [form-data](https://ghub.io/form-data): A library to create readable &quot;multipart/form-data&quot; streams. Can be used to submit forms and file uploads to other web applications.
332+
- [lodash](https://ghub.io/lodash): Lodash modular utilities.
333+
- [marpat](https://ghub.io/marpat): A class-based ES6 ODM for Mongo-like databases.
334+
- [moment](https://ghub.io/moment): Parse, validate, manipulate, and display dates
335+
- [object-sizeof](https://ghub.io/object-sizeof): Sizeof of a JavaScript object in Bytes
336+
- [prettysize](https://ghub.io/prettysize): Convert bytes to other sizes for prettier logging
333337

334338
## Dev Dependencies
335339

336-
* [chai](https://ghub.io/chai): BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
337-
* [chai-as-promised](https://ghub.io/chai-as-promised): Extends Chai with assertions about promises.
338-
* [colors](https://ghub.io/colors): get colors in your node.js console
339-
* [coveralls](https://ghub.io/coveralls): takes json-cov output into stdin and POSTs to coveralls.io
340-
* [dotenv](https://ghub.io/dotenv): Loads environment variables from .env file
341-
* [eslint](https://ghub.io/eslint): An AST-based pattern checker for JavaScript.
342-
* [eslint-config-google](https://ghub.io/eslint-config-google): ESLint shareable config for the Google style
343-
* [eslint-config-prettier](https://ghub.io/eslint-config-prettier): Turns off all rules that are unnecessary or might conflict with Prettier.
344-
* [eslint-plugin-prettier](https://ghub.io/eslint-plugin-prettier): Runs prettier as an eslint rule
345-
* [jsdocs](https://ghub.io/jsdocs): jsdocs
346-
* [minami](https://ghub.io/minami): Clean and minimal JSDoc 3 Template / Theme
347-
* [mocha](https://ghub.io/mocha): simple, flexible, fun test framework
348-
* [mocha-lcov-reporter](https://ghub.io/mocha-lcov-reporter): LCOV reporter for Mocha
349-
* [nyc](https://ghub.io/nyc): the Istanbul command line interface
350-
* [package-json-to-readme](https://ghub.io/package-json-to-readme): Generate a README.md from package.json contents
351-
* [prettier](https://ghub.io/prettier): Prettier is an opinionated code formatter
352-
* [varium](https://ghub.io/varium): A strict parser and validator of environment config variables
340+
- [chai](https://ghub.io/chai): BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
341+
- [chai-as-promised](https://ghub.io/chai-as-promised): Extends Chai with assertions about promises.
342+
- [colors](https://ghub.io/colors): get colors in your node.js console
343+
- [coveralls](https://ghub.io/coveralls): takes json-cov output into stdin and POSTs to coveralls.io
344+
- [dotenv](https://ghub.io/dotenv): Loads environment variables from .env file
345+
- [eslint](https://ghub.io/eslint): An AST-based pattern checker for JavaScript.
346+
- [eslint-config-google](https://ghub.io/eslint-config-google): ESLint shareable config for the Google style
347+
- [eslint-config-prettier](https://ghub.io/eslint-config-prettier): Turns off all rules that are unnecessary or might conflict with Prettier.
348+
- [eslint-plugin-prettier](https://ghub.io/eslint-plugin-prettier): Runs prettier as an eslint rule
349+
- [jsdocs](https://ghub.io/jsdocs): jsdocs
350+
- [minami](https://ghub.io/minami): Clean and minimal JSDoc 3 Template / Theme
351+
- [mocha](https://ghub.io/mocha): simple, flexible, fun test framework
352+
- [mocha-lcov-reporter](https://ghub.io/mocha-lcov-reporter): LCOV reporter for Mocha
353+
- [nyc](https://ghub.io/nyc): the Istanbul command line interface
354+
- [package-json-to-readme](https://ghub.io/package-json-to-readme): Generate a README.md from package.json contents
355+
- [prettier](https://ghub.io/prettier): Prettier is an opinionated code formatter
356+
- [varium](https://ghub.io/varium): A strict parser and validator of environment config variables
353357

354358
## License
355359

docs/Client.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,7 @@ <h4 class="name" id="._filterResponse"><span class="type-signature">(private, st
576576

577577
<dt class="tag-source">Source:</dt>
578578
<dd class="tag-source"><ul class="dummy"><li>
579-
<a href="client.model.js.html">client.model.js</a>, <a href="client.model.js.html#line671">line 671</a>
579+
<a href="client.model.js.html">client.model.js</a>, <a href="client.model.js.html#line662">line 662</a>
580580
</li></ul></dd>
581581

582582

@@ -684,7 +684,7 @@ <h4 class="name" id="._isJson"><span class="type-signature">(private, static) </
684684

685685
<dt class="tag-source">Source:</dt>
686686
<dd class="tag-source"><ul class="dummy"><li>
687-
<a href="client.model.js.html">client.model.js</a>, <a href="client.model.js.html#line692">line 692</a>
687+
<a href="client.model.js.html">client.model.js</a>, <a href="client.model.js.html#line677">line 677</a>
688688
</li></ul></dd>
689689

690690

@@ -794,7 +794,7 @@ <h4 class="name" id="._namespace"><span class="type-signature">(private, static)
794794

795795
<dt class="tag-source">Source:</dt>
796796
<dd class="tag-source"><ul class="dummy"><li>
797-
<a href="client.model.js.html">client.model.js</a>, <a href="client.model.js.html#line707">line 707</a>
797+
<a href="client.model.js.html">client.model.js</a>, <a href="client.model.js.html#line692">line 692</a>
798798
</li></ul></dd>
799799

800800

@@ -1011,7 +1011,7 @@ <h4 class="name" id="._stringify"><span class="type-signature">(private, static)
10111011

10121012
<dt class="tag-source">Source:</dt>
10131013
<dd class="tag-source"><ul class="dummy"><li>
1014-
<a href="client.model.js.html">client.model.js</a>, <a href="client.model.js.html#line652">line 652</a>
1014+
<a href="client.model.js.html">client.model.js</a>, <a href="client.model.js.html#line645">line 645</a>
10151015
</li></ul></dd>
10161016

10171017

@@ -1174,7 +1174,7 @@ <h4 class="name" id="._toArray"><span class="type-signature">(private, static) <
11741174

11751175
<dt class="tag-source">Source:</dt>
11761176
<dd class="tag-source"><ul class="dummy"><li>
1177-
<a href="client.model.js.html">client.model.js</a>, <a href="client.model.js.html#line640">line 640</a>
1177+
<a href="client.model.js.html">client.model.js</a>, <a href="client.model.js.html#line633">line 633</a>
11781178
</li></ul></dd>
11791179

11801180

@@ -2092,7 +2092,7 @@ <h4 class="name" id=".fieldData"><span class="type-signature">(static) </span>fi
20922092

20932093
<dt class="tag-source">Source:</dt>
20942094
<dd class="tag-source"><ul class="dummy"><li>
2095-
<a href="client.model.js.html">client.model.js</a>, <a href="client.model.js.html#line724">line 724</a>
2095+
<a href="client.model.js.html">client.model.js</a>, <a href="client.model.js.html#line709">line 709</a>
20962096
</li></ul></dd>
20972097

20982098

@@ -3144,7 +3144,7 @@ <h4 class="name" id=".recordId"><span class="type-signature">(static) </span>rec
31443144

31453145
<dt class="tag-source">Source:</dt>
31463146
<dd class="tag-source"><ul class="dummy"><li>
3147-
<a href="client.model.js.html">client.model.js</a>, <a href="client.model.js.html#line746">line 746</a>
3147+
<a href="client.model.js.html">client.model.js</a>, <a href="client.model.js.html#line731">line 731</a>
31483148
</li></ul></dd>
31493149

31503150

@@ -5485,7 +5485,7 @@ <h5>Returns:</h5>
54855485
<br class="clear">
54865486

54875487
<footer>
5488-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat May 26 2018 21:17:52 GMT-0700 (PDT) using the Minami theme.
5488+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue May 29 2018 08:36:53 GMT-0700 (PDT) using the Minami theme.
54895489
</footer>
54905490

54915491
<script>prettyPrint();</script>

docs/Connection.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1363,7 +1363,7 @@ <h5>Returns:</h5>
13631363
<br class="clear">
13641364

13651365
<footer>
1366-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat May 26 2018 21:17:52 GMT-0700 (PDT) using the Minami theme.
1366+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue May 29 2018 08:36:53 GMT-0700 (PDT) using the Minami theme.
13671367
</footer>
13681368

13691369
<script>prettyPrint();</script>

docs/Credentials.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ <h5>Type:</h5>
317317
<br class="clear">
318318

319319
<footer>
320-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat May 26 2018 21:17:52 GMT-0700 (PDT) using the Minami theme.
320+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue May 29 2018 08:36:53 GMT-0700 (PDT) using the Minami theme.
321321
</footer>
322322

323323
<script>prettyPrint();</script>

docs/Data.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -933,7 +933,7 @@ <h5>Returns:</h5>
933933
<br class="clear">
934934

935935
<footer>
936-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat May 26 2018 21:17:52 GMT-0700 (PDT) using the Minami theme.
936+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue May 29 2018 08:36:53 GMT-0700 (PDT) using the Minami theme.
937937
</footer>
938938

939939
<script>prettyPrint();</script>

0 commit comments

Comments
 (0)