LinkScout

Welcome to LinkScout gem!

LinkScout helps users to find broken links by analysing response code or body.

It can take single or multiple URLs as input making it easy to handle link checking in larger batches.
It can also follow links through redirect chains making sure links eventually work for your users.

Installation

Add this line to your application’s Gemfile:

gem 'link_scout'

And then execute:

$ bundle

Or install it yourself as:

$ gem install link_scout

Usage

  options = {
    success: 200,
    follow: true,
    limit: 1,
    target: 'http://target.com',
    deeplink_param: 'deeplink',
    pattern: /abc/i,
    antipattern: /cde/i,
  }

Single URLS

  LinkScout::run(url, options)

  LinkScout::run(url: url, option: value)

Multiple with shared options

  LinkScout::run([url, url1, url2], options)

Multiple with individual options

  LinkScout::run([{ url: url }, { url: url1, option: value }])

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pcvg/link_scout/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the LinkScout project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.