lvaldovinos/my-request

Request module based on superagent and supertest

my-request

Request module based on superagent and supertest

Installation

npm install my-request

Example code

Inspired by Supertest and Superagent, my-request uses the same logic than supertest to do a request example:

  var request = require('my-request'),
      myRequest = request.init('http://alonso-thoughtsapi.rhcloud.com');
  
  myRequest
    .get('/')
    .end(function(res) {
      console.log(res.body); // { hello: 'world' }
    });

API

#setPermanent(header)

Method that helps you set a header permanently, you set the header once, and it will remain on next requests

Arguments

header This is an object like this one:

  { "Authorization" : "Bearer dasasdas123qasd1.12312asdads12.da123",
    "Localization" : "http://www.example.com/resource/id"
  }

Example

  var request = require('my-request'),
      myRequest = request.init('http://alonso-thoughtsapi.rhcloud.com');
  
  myRequest
    .setPermanent({ Authorization : 'example-token' })
    .get('/')
    .end(function(res) {
      console.log(res.req._headers.authorization); //'example-token'
    });
    
  myRequest
    .get('/blogs')
    .end(function(res) {
      console.log(res.req._headers.authorization); //'example-token'
    });

#unsetPermanent()

Method that removes all permanent headers.

Example

  var request = require('my-request'),
      myRequest = request.init('http://alonso-thoughtsapi.rhcloud.com');
  
  myRequest
    .setPermanent({ Authorization : 'example-token',
                    Localization : 'example-loc' })
    .get('/')
    .end(function(res) {
      console.log(res.req._headers.authorization); //'example-token'
      console.log(res.req._headers.localization); //'example-loc'
    });
    
  myRequest.unsetPermanent();
  myRequest
    .get('/blogs')
    .end(function(res) {
      console.log(res.req._headers.authorization); //'undefined'
      console.log(res.req._headers.localization); //'undefined'
    });

Test

npm test

License

The MIT License (MIT)

Copyright (c) 2015 Luis Alonso Valdovinos Valencia

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.