madmimi-alt

Mad Mimi Alternative Client

A fork of the clean, modern interface for the Mad Mimi API.

Unlike the original API, there is no Promise support here, to keep this module lightweight and as tribute to da jcrugzz.

For detailed usage instructions, see the Examples.

Installation

npm install madmimi-alt

Usage

var Madmimi = require('madmimi-alt');

// Create an instance for each set of requests that involve the same protocol (http/https), username (typically an email), and secret API key.
var mmClient = new Madmimi({
  secure: false, // false means endpoint involves http; default: true
  username: '[e-mail]',
  key: 'xxxxx'
});

Callbacks and errors

mmClient.post('/audience_lists/:list/add', {
  username: '[e-mail]',
  params: { list: 'Your-List' }
}, function callback(err, result) {
  if (err) return console.error(err);
  console.log('Success! ' + result);
});

Suppose you make a request (POST /audience_lists/:list/add) as above and a 404 response is returned. In response, this module will pass to the callback an error object with the following properties: { [Error] isBot: true, status: 'Not Found', code: 404 }. We will basically convert any response that has a status code >= 400 into an error object and pass it to the callback. This may be seen as unnecessary abstraction (due to usage of errbot in the source module) and will be most likely removed at a later time.

Motivation

The problem with the original Mad Mimi interface is that all API calls work with the same configurations object. If you wanted to call the API twice without waiting for one API call to complete, and each call involved different configurations (e.g., one call involved a https MadMimi endpoint e.g., https://api.madmimi.com while another call involved a http MM endpoint e.g., http://api.madmimi.com, this would present a problem.

This is resolved in this module because the constructor of interest from the original module's library is exposed, so that developers can create an instance with a separate configuration object for each set of requests they want to send involving the same configuration details (protocol (http/https), email, and secret API key).

License

Copyright (C) Nicholas Young, Original Machine LLC.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.