link_rel_parser

LinkRelParser (Ruby)

Parse HTTP Link headers into a structured format

Version

0.1.0

Code Status

Installation

Add this line to your application's Gemfile:

gem "link_rel_parser"

And then execute:

bundle

Or install it yourself as:

gem install link_rel_parser

Usage

require "link_rel_parser"
LinkRelParser.parse("https://aaronparecki.com")

{
  "authorization_endpoint" => "https://aaronparecki.com/auth",
  "hub"                    => "https://switchboard.p3k.io/",
  "micropub"               => "https://aaronparecki.com/micropub",
  "self"                   => "https://aaronparecki.com/",
  "token_endpoint"         => "https://aaronparecki.com/auth/token",
}

Development

git clone [e-mail]:indieweb/link_rel_parser-ruby.git
cd link_rel_parser-ruby
bin/setup

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. Run bundle exec link_rel_parser to use the gem in this directory, ignoring other installed copies of this gem.

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.

Authors

• Shane Becker / @veganstraightedge

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/indieweb/link_rel_parser-ruby/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.

1. Fork it
2. Get it running (see Installation above)
3. Create your feature branch (git checkout -b my-new-feature)
4. Write your code and specs
5. Commit your changes (git commit -am 'Add some feature')
6. Push to the branch (git push origin my-new-feature)
7. Create new Pull Request

If you find bugs, have feature requests or questions, please file an issue.

Code of Conduct

Everyone interacting in the LinkRelParser (Ruby) codebase, issue tracker, chat room, and mailing lists is expected to follow the LinkRelParser (Ruby) code of conduct.

License

PUBLIC DOMAIN

Your heart is as free as the air you breathe.
The ground you stand on is liberated territory.

In legal text, LinkRelParser (Ruby) is dedicated to the public domain using Creative Commons -- CC0 1.0 Universal.

http://creativecommons.org/publicdomain/zero/1.0