rets

Node.js client for RETS.

npm install rets
3 downloads in the last week
7 downloads in the last month

Node.js RETS Client

This is a (very) beta Node.js RETS client. The purpose of this module is to establish a connection to a RETS provider and perform most of the common queries. If you are experienced with RETS and would like to assist with this development your help would be very welcome.

Usage Example

Below is a very simple example that simply establishes a RETS connection with digest authentication and then loads an object containing all available classifications.


var RETS = require( 'rets' );

// Create Connection.
var client = RETS.createConnection({
  host: 'www.some-rets-provider.com',
  path: '/login.asps',
  user: 'ricky-bobby',
  pass: 'talladega'
});

// Trigger on successful connection.
client.once( 'connection.success', function connected( client ) {
  console.log( 'Connected to RETS as %s.', client.get( 'provider.name' ) )

  // Fetch classifications
  client.get_classifications( function have_meta( error, meta ) {

    if( error ) {
      console.log( 'Error while fetching classifications: %s.', error.message );
    } else {
      console.log( 'Fetched %d classifications.', Object.keys( meta.data ).length );
      console.log( 'Classification keys: %s.', Object.keys( meta.data ) );
    }

  });

});

// Trigger on connection failure.
client.once( 'connection.error', function connection_error( error, client ) {
  console.error( 'Connection failed: %s.', error.message );
});

If there are no errors, the above code should result in the following console messages:

  • Connected to RETS as "Ricky Bobby, Inc.".
  • Fetched 6 classifications.
  • Classification keys: REN,CML,MUL,LND,CMS,RES.

License

(The MIT License)

Copyright (c) 2013 Usability Dynamics, Inc. <info@usabilitydynamics.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you