Check that proxies are working, verify their anonymity level (transparent, anonymous, or elite), lookup their geographic location by IP address, check for other capabilities such as tunneling and available protocols (HTTP/S, SOCKS4/5).
Add to your application via npm
:
npm install proxy-verifier --save
This will install proxy-verifier
and add it to your application's package.json
file.
testAll(proxy[, options], cb)
Runs all test methods for the given proxy. The options
argument is passed through to every test method.
Usage:
var ProxyVerifier = require('proxy-verifier');
var proxy = {
ipAddress: '127.0.0.1',
port: 8888,
protocol: 'http'
};
ProxyVerifier.testAll(proxy, function(error, result) {
if (error) {
// Some unusual error occurred.
} else {
// The result object will contain success/error information.
}
});
Sample result
:
{
anonymityLevel: 'elite',
protocols: {
http: {
ok: true
}
},
tunnel: {
ok: true
}
}
testProtocol(proxy[, options], cb)
Check that the proxy works with the specified protocol. The options
argument is passed through to the request()
method which uses request.
Usage:
var ProxyVerifier = require('proxy-verifier');
var proxy = {
ipAddress: '127.0.0.1',
port: 8080,
protocol: 'http'
};
ProxyVerifier.testProtocol(proxy, function(error, result) {
if (error) {
// Some unusual error occurred.
} else {
// The result object will contain success/error information.
}
});
Sample result
when the proxy is working:
{
ok: true
}
Sample result
when the proxy is not working:
{
ok: false,
error: {
message: 'socket hang up',
code: 'ECONNRESET'
}
}
testProtocols(proxy[, options], cb)
Check that the proxy works with the specified protocols. The options
argument is passed through to the request()
method which uses request.
Usage:
var ProxyVerifier = require('proxy-verifier');
var proxy = {
ipAddress: '127.0.0.1',
port: 8080,
protocols: ['http', 'https']
};
ProxyVerifier.testProtocols(proxy, function(error, results) {
if (error) {
// Some unusual error occurred.
} else {
// The results object contains a result object for each protocol.
}
});
Sample results
when the proxy is working for all its protocols:
{
http: {
ok: true
},
https: {
ok: true
}
}
Sample results
when the proxy is not working for any of the protocols:
{
http: {
ok: false,
error: {
message: 'socket hang up',
code: 'ECONNRESET'
}
},
https: {
ok: false,
error: {
message: 'socket hang up',
code: 'ECONNRESET'
}
}
}
testAnonymityLevel(proxy[, options], cb)
Check the anonymity level of the proxy. The options
argument is passed through to the request()
method which uses request.
Usage:
var ProxyVerifier = require('proxy-verifier');
var proxy = {
ipAddress: '127.0.0.1',
port: 8080,
protocol: 'http'
};
ProxyVerifier.testAnonymityLevel(proxy, function(error, anonymityLevel) {
if (error) {
// Some unusual error occurred.
} else {
// anonymityLevel will be a string equal to "transparent", "anonymous", or "elite".
}
});
Anonymity levels explained:
testTunnel(proxy[, options], cb)
Check to see if the proxy supports HTTP tunneling. The options
argument is passed through to the request()
method which uses request.
Usage:
var ProxyVerifier = require('proxy-verifier');
var proxy = {
ipAddress: '127.0.0.1',
port: 8888,
protocol: 'http'
};
ProxyVerifier.testTunnel(proxy, function(error, result) {
if (error) {
// Some unusual error occurred.
} else {
// The result object will contain success/error information.
}
});
Sample result
when the proxy supports tunneling:
{
ok: true
}
Sample result
when the proxy does not support tunneling:
{
ok: false,
error: {
message: 'socket hang up',
code: 'ECONNRESET'
}
}
Use this method to create your custom tests. Example usage:
ProxyVerifier.test(proxy, {
testUrl: 'https://www.google.com/?q=test',
testFn: function(data, status, headers) {
// Check the response data, status, and headers.
// Throw an error if the test failed.
throw new Error('Test failed!');
// Do nothing if the test passed.
}
}, function(error, results) {
// Do something with error or results.
});
There are a number of ways you can contribute:
readme.md
file. If you see a mistake, or think something should be clarified or expanded upon, please submit a pull requestBefore you contribute code, please read through at least some of the source code for the project. I would appreciate it if any pull requests for source code changes follow the coding style of the rest of the project.
Now if you're still interested, you'll need to get your local environment configured.
First, you'll need to pull down the code from GitHub:
git clone https://github.com/chill117/proxy-verifier.git
Second, you'll need to install the project dependencies as well as the dev dependencies. To do this, simply run the following from the directory you created in step 1:
npm install
This project includes an automated regression test suite. To run the tests:
npm test
See changelog.md
This software is MIT licensed:
A short, permissive software license. Basically, you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source. There are many variations of this license in use.
This project is free and open-source. If you would like to show your appreciation by helping to fund the project's continued development and maintenance, you can find available options here.