node package manager
Easy sharing. Manage teams and permissions with one click. Create a free org »

vpl

VPL Build Status NPM version

Generate short urls

Getting Started

Install the module with:

$ npm install -g vpl
var VPL = require('vpl');
//Create new instance of VPL 
var api = new VPL();

Documentation

.generate(url, shortCode, callback)

Parameter: url Type: String Example: http://badges.enytc.com/for/npm/vpl

Parameter: shortCode Type: String Example: mybadges

Parameter: callback Type: Function Example:

function(err, data) {
    
}

The generate method is responsible to generate new short urls

How to use this method

api.generate('http://badges.enytc.com/for/npm/vpl', 'mybadges', function(err, data) {
    console.log(data.url);
});

.getUrl(shortCode, callback)

Parameter: shortCode Type: String Example: mybadges

Parameter: callback Type: Function Example:

function(err, data) {
    
}

The getUrl method is responsible to get a long url using the passed shortCode

How to use this method

api.getUrl('mybadges', function(err, data) {
    console.log(data.short);
});

Contributing

  1. Fork it vaiprala/vpl
  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. Create new Pull Request

See the CONTRIBUTING Guidelines

Support

If you have any problem or suggestion please open an issue here.

License

The BSD License

Copyright (c) 2014, EnyTC Corporation

All rights reserved.

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

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

  • 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.

  • Neither the name of the EnyTC Corporation 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.