Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

spotter

0.2.0 • Public • Published

Spotter

Fetch the HTTP response codes for a CSV formatted list of URL's.

Background

You have a list of URLs and you want to check how HTTP requests are handled by the HTTP server? Spotter will asynchronously send HTTP HEAD requests and list the returned HTTP response statuscode for each URL.

This project relies on request-promise, lodash and bluebird.

Status: Currently under development.

Command line tool

Installation

You can install spotter locally via $ npm install spotter or as a global package via $sudo npm install -g spotter.

Or just clone this repository:

$ git clone https://github.com/netsensei/spotter.git
$ sudo npm link

Usage

You have a CSV file with a 'url' column which contains a number of url's.

$ spotter list.csv --column url

The CSV file will be overwritten. The original data will be kept, but an additional column "response" will be added. This column holds the HTTP resonse code.

API

Use spotter in your own code like this:

var spotter = require('spotter');
var options = {
  pace: false,
  followRedirect: true,
  maxRedirects: 3
}
var column = "url";
 
var data = [
  { title: "CNN", url: "http://cnn.com" },
  { title: "NY Times", url: "http://nytimes.com" }
]
 
spotter(data, column, options).then(function(result) {
  // do stuff
}

This method accepts the following options

  • pace: set to true or false. Display the pace progress bar (default: false).
  • followRedirect: set to true or false. Follow HTTP 3xx responses as redirects (default: true)
  • maxRedirects: the maximum number of redirects to follow (default: 3)

FAQ

Q: Spotter throws this error:

(node) warning: possible EventEmitter memory leak detected. 11 listeners added. Use emitter.setMaxListeners() to increase limit.

A: The request library has created too many event listeners which are still active or haven't been cleaned up by Node. See: this issue for an detailled explanation.

Q: How many redirects does Spotter follow?

By default, Spotter follows 3 redirects (3xx codes).

License

The MIT License (MIT)

Copyright (c) 2015 Matthias Vandermaesen

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.

Install

npm i spotter

DownloadsWeekly Downloads

1

Version

0.2.0

License

MIT

Last publish

Collaborators

  • avatar