omft-utils/README.md

Various utility function to be used with Oracle Managed File Transfer(MFT)

# omft-utils

Utility functions for use with Oracle MFT - Managed File Transfer nodeJS modules and applications.

## Installation

npm install omft-utils --save

## Usage

[See examples folder](examples)

* doSub.js
* genRequest.js
* isbin.js
* nobody.js
* notemps.js
* parseCallout.js
* templates.js
* template.js


### Function parseCalloutArgs
#### Parse arguments from an MFT callout

    var outils = require('omft-utils');
    var ar = [];
    ar[0] = 'file=test.xml'
    ar[1] = 'outfile=out.xml outdir=/tmp/mft'
    var o = outils.parseCalloutArgs(ar);
    console.log('o.file: ' +o.file);
    console.log('o.outfile: ' +o.outfile);
    console.log('o.outdir: ' +o.outdir);


### Function genUploadRequest 
#### Returns a payload for any type of MFT request. SOAP, WSA, WSSE ... 
#### Takes an options object as an argument so it is easy to extend.

This is a basic SOAP JSON config file that supports comments.

```
var opts = {
  "type": "SOAP",             // Inline or Binary XML
  "ctype": "binary",          // "text" 
  "reqtemps": true,           // require templates of false means only payload substitution if template not found
  "retbody": true,            // or 'false' which means don't return file for things like WSA when file is outside the SOAP payload 
  "file": process.argv[1],
  "maxsize": 26214400,        // 25MB limits the size of the SOAP payload. WSA can be higher value
  "templatedir": path.join(__dirname, '../files') // overrides the default template dir
};

outils.genUploadRequest(opts, function(er, fsz, bdy) {
  if (er) {
    console.log('genRequestTest SOAP: error ' +er);
    process.exit(1);
  }
  console.log('SUCCESS: filesize is ' +fsz);
  console.log('file is   ' +opts.file);
  console.log('type is    ' +opts.type);
  console.log('ctype is   ' +opts.ctype);
  console.log('maxsize is   ' +opts.maxsize);
  console.log('templatedir is   ' +opts.templatedir);
  console.log('Body is   ' +bdy);
});
```

### Function varSub
#### A simple paramterized substitution templating interface
#### Takes date string and subvar object as arguments with optional delimeter as 3rd argument
#### Returns the substituted result
```
var ts = new Date().toISOString();
var data =  'Hello %%NAME%% it is now %%ISOTIME%%';
var vals = {'NAME': 'Dave', 'isoTIME': ts};
console.log(outils.varSub(data, vals));
```

### Function isBinary
#### Checks the file type before upload
#### Arguments are "filespec, buffer"
#### Returns true for binary, false for text or error for file not found

```
// simple example
var f1 = process.argv[1];
var f2 = './test/binfile';
var f3 = 'NOFILE';
var result,s;

try {
  console.log(outils.isBinary(f1, '')); // returns true
  console.log(outils.isBinary(f2, '')); // returns false
  console.log(outils.isBinary(f3, '')); // throws error
} catch (e) {
  console.log(e);
};
```

### TEMPLATE SUBSTITUTION VARIABLES
#### The following default template variables are supported.

See the [examples/templates.js](examples/template.js).

File variables follow the [Node Path Parse](https://nodejs.org/api/path.html#path_path_parse_pathstring) implementation

```
%%FILEPATH%%   /user/me/test/foo.bar
%%FILEBASE%%   foo.bar    
%%FILENAME%%   foo
%%FILEEXT%%    .bar
%%FILEDIR%%    test
%%ISOTIME%%    2029-05-15T18:36:07.428Z  
%%USERNAME%%   JANE
%%PASSWORD%%   TARZAN
``

## Test

npm install chai

npm test

## Contributing

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## History

Created: May 3, 2015

## Credits

Dave Berry A.K.A (bigfiles)

## License

ISC