GSA/robots_tag_parser

Name: robots_tag_parser

Owner: U.S. General Services Administration

Description: A simple gem to parse X-Robots-Tag HTTP headers

Created: 2017-09-14 19:32:02.0

Updated: 2017-09-18 17:05:21.0

Pushed: 2017-09-26 22:13:37.0

Homepage: null

Size: 13

Language: Ruby

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

RobotsTagParser

A simple gem to parse X-Robots-Tag HTTP headers according to Google X-Robots-Tag HTTP header specifications.

CircleCI Code Climate Test Coverage

Installation

Add this line to your application's Gemfile:

'robots_tag_parser', git: 'https://github.com/GSA/robots_tag_parser'

And then execute:

$ bundle
Usage
Basic examples

Get rules applying to all user agents:

ers = { 'X-Robots-Tag' => ['noindex,noarchive', 'googlebot: nofollow'] }

tsTagParser.get_rules(headers: headers)
'noindex', 'noarchive']

Get rules applying to specific user agents (which include generic rules):

ers = { 'X-Robots-Tag' => ['noindex,noarchive', 'googlebot: nofollow'] }

tsTagParser.get_rules(headers: headers, user_agent: 'googlebot')
'noindex', 'noarchive', 'nofollow']
Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub.

License

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

Directives:

Source: https://developers.google.com/webmasters/control-crawl-index/docs/robots_meta_tag


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.