https://github.com/pcvg/link_scout
LinkScout is a Broken URL Checker with several options
https://github.com/pcvg/link_scout
gem rails ruby ruby-on-rails rubygem
Last synced: 8 months ago
JSON representation
LinkScout is a Broken URL Checker with several options
- Host: GitHub
- URL: https://github.com/pcvg/link_scout
- Owner: pcvg
- License: mit
- Created: 2018-04-03T08:45:51.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-28T22:58:46.000Z (over 2 years ago)
- Last Synced: 2025-01-29T09:22:16.469Z (over 1 year ago)
- Topics: gem, rails, ruby, ruby-on-rails, rubygem
- Language: Ruby
- Homepage: https://rubygems.org/gems/link_scout
- Size: 74.2 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# LinkScout [](https://travis-ci.org/pcvg/link_scout) [](https://coveralls.io/github/pcvg/link_scout?branch=master) [](http://badge.fury.io/rb/link_scout)
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:
```ruby
gem 'link_scout'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install link_scout
## Usage
```ruby
options = {
success: 200,
follow: true,
limit: 1,
target: 'http://target.com',
deeplink_param: 'deeplink',
pattern: /abc/i,
antipattern: /cde/i,
}
```
### Single URLS
```ruby
LinkScout::run(url, options)
```
```ruby
LinkScout::run(url: url, option: value)
```
### Multiple with shared options
```ruby
LinkScout::run([url, url1, url2], options)
```
### Multiple with individual options
```ruby
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](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## 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](https://github.com/pcvg/link_scout/blob/master/CODE_OF_CONDUCT.md).