Package Exports
- rets-promise
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (rets-promise) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
rets-promise
A RETS (Real Estate Transaction Standard) client for Node.js with a clean, promise-based interface.
Forked originally from rets-client, with the user-facing API rewritten with breaking changes to use a Promise-based interface. Promises in this module are provided by Bluebird. This library contains some CoffeeScript, but may be used just as easily in a Node app using Javascript or CoffeeScript.
The original module was developed against a server running RETS v1.7.2, so there may be incompatibilities with other versions. However, the developers at RealtyMaps want this library to work against any RETS server versions that are in current use, so issue tickets describing problems or (even better) pull requests that fix interactions with other RETS versions are welcomed.
Contributions
Issue tickets and pull requests are welcome. Unless a breaking refactor is necessary, the auth, metadata,
multipart, object, search, and utils files in lib/ should be kept JavaScript in order to facilitate PRs
to/from other rets-client forks.
Ideally, pull requests should include tests and match existing code style.
TODO
- Update dependency versions
- move off https://github.com/Gozala/crypto to use node-native crypto module instead
- add support for UA password as described here: https://github.com/sbruno81/rets-client/issues/1 -- might already be handled
- make sure listeners are deregistering so app will exit after logout
Example RETS Session
var rets = require('rets-promise');
var outputFields = function(obj, fields) {
for (var i=0; i<fields.length; i++) {
console.log(fields[i]+": "+obj[fields[i]]);
}
console.log("");
};
// establish connection to RETS server which auto-logs out when we're done
rets.getAutoLogoutClient(settings, function (client) {
//get resources metadata
return client.metadata.getResources()
.then(function (data) {
console.log("======================================");
console.log("======== Resources Metadata ========");
console.log("======================================");
outputFields(data, ['Version', 'Date']);
for (var dataItem = 0; dataItem < data.Resources.length; dataItem++) {
console.log("-------- Resource " + dataItem + " --------");
outputFields(data.Resources[dataItem], ['ResourceID', 'StandardName', 'VisibleName', 'ObjectVersion']);
}
}).then(function () {
//get class metadata
return client.metadata.getClass("Property");
}).then(function (data) {
console.log("===========================================================");
console.log("======== Class Metadata (from Property Resource) ========");
console.log("===========================================================");
outputFields(data, ['Version', 'Date', 'Resource']);
for (var classItem = 0; classItem < data.Classes.length; classItem++) {
console.log("-------- Table " + classItem + " --------");
outputFields(data.Classes[classItem], ['ClassName', 'StandardName', 'VisibleName', 'TableVersion']);
}
}).then(function () {
//get field data for open houses
return client.metadata.getTable("OpenHouse", "OPENHOUSE");
}).then(function (data) {
console.log("=============================================");
console.log("======== OpenHouse Table Metadata ========");
console.log("=============================================");
outputFields(data, ['Version', 'Date', 'Resource', 'Class']);
for (var tableItem = 0; tableItem < data.Fields.length; tableItem++) {
console.log("-------- Field " + tableItem + " --------");
outputFields(data.Fields[tableItem], ['MetadataEntryID', 'SystemName', 'ShortName', 'LongName', 'DataType']);
}
return data.Fields
}).then(function (fieldsData) {
var plucked = [];
for (var fieldItem = 0; fieldItem < fieldsData.length; fieldItem++) {
plucked.push(fieldsData[fieldItem].SystemName);
}
return plucked;
}).then(function (fields) {
//perform a query using DQML -- pass resource, class, and query, and optionally a limit
return client.search.query("OpenHouse", "OPENHOUSE", "(OpenHouseType=PUBLIC),(ActiveYN=1)")
.then(function (results) {
console.log("===========================================");
console.log("======== OpenHouse Query Results ========");
console.log("===========================================");
console.log("");
//iterate through search results
for (var dataItem = 0; dataItem < results.length; dataItem++) {
console.log("-------- Result " + dataItem + " --------");
outputFields(results[dataItem], fields);
}
});
}).then(function () {
// get photos
return client.objects.getPhotos("Property", "LargePhoto", photoId)
}).then(function (photoList) {
console.log("=================================");
console.log("======== Photo Results ========");
console.log("=================================");
for (var i = 0; i < photoList.length; i++) {
console.log("Photo " + (i + 1) + " MIME type: " + photoList[i].mime);
fs.writeFileSync(
"/tmp/photo" + (i + 1) + "." + photoList[i].mime.match(/\w+\/(\w+)/i)[1],
photoList[i].buffer
);
}
});
}).catch(function (error) {
console.log("ERROR: issue encountered: "+(error.stack||error));
});