Simple, flexible, fun to use HTTP agent with nice API and clean implementation
#agent-next
The idea is simple:
send(req, cb)
..url
, .headers
and .body
.status
, .headers
and .body
.Given that:
// cookie support? Easy!
function agent(req, cb) {
setCookies(req)
send(req, function(err, res) {
saveCookies(res)
cb(err, res)
})
}
// redirects? Easy!
function aagent(req, cb) {
agent(req, function(err, res) {
if (isRedirect(res)) return aagent(redirectRequest(req, res), cb)
cb(err, res)
})
}
// Everything is easy.
req
to errors, etc)Request
, Response
prototypes in the vein of superagent
Agent
abstraction as an easy way to setup your send
function and issueing requests.
It is tremendously simpler and far more flexible. For example, you can swap entire http implementation and still have all advanced functionality available.
basic
var agent = require('agent-next')()
agent
.get('http://google.com/search/q=hello+world')
.end(function(err, res) {
console.log(err || res.body)
})
advanced
// Setup an agent specifically for the Github API from scratch
var Agent = require('agent-next')
var github = Agent.basic()
.use(Agent.redirects(10))
.use(Agent.unzip())
.use(Agent.parser())
.use(Agent.serialize())
.use(Agent.baseUrl('https://api.github.com'))
.use(function(req, send, cb) {
req.headers['user-agent'] = 'test application'
req.headers['accept'] = 'application/vnd.github.preview'
send(req, function(err, res) {
if (err) return cb(err)
if (res.ok) return cb(null, res.body)
cb(new Error(res.body.message))
})
})
// get some info about agent-next
github
.get('/repos/eldargab/agent-next')
.end(function(err, msg) {
console.log(err || msg.description)
})
setup with options
var Agent = require('agent-next')
// superagent like
var agent = Agent()
// tweak
var agent = Agent({
cookies: true, // enable cookies
unzip: false, // disable gzip support
parser: fn, // set custom body parser
timeout: 30000,
baseUrl: 'http://example.com'
})
send
function accepts strings, buffers andreq.url
must be an instance of Agent.Url
, not a string or an arbitrary object.cb(err, res)
, not just cb(err)
.via npm
npm install agent-next
(The MIT License)
Copyright (c) 2013 Eldar Gabdullin [email protected]
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.