~srushe/indieweb-authorship

Identify the author of an IndieWeb post using the Authorship algorithm
c5a58955 — Stephen Rushe 2 months ago
Support encoded emails within the h-card.
a0118e74 — Stephen Rushe 2 months ago
Upgrade Nokogiri to 1.11.2
7cdcdd54 — Stephen Rushe 8 months ago
Improve README.md

clone

read-only
https://git.sr.ht/~srushe/indieweb-authorship
read/write
git@git.sr.ht:~srushe/indieweb-authorship

You can also use your local clone with git send-email.

#Indieweb::Authorship

Indieweb::Authorship is a Ruby gem for identifying the author of an IndieWeb post using the authorship algorithm.

#Installation

Add this line to your application's Gemfile:

gem 'indieweb-authorship'

And then execute:

$ bundle

Or install it yourself as:

$ gem install indieweb-authorship

#Usage

#From a URL

You can simply provide a URL and the page will be retrieved before authorship is determined.

author = Indieweb::Authorship.identify(url)

#With pre-downloaded html (from a URL)

It is also possible to provide the html directly, along with the URL, in cases where you already have the page.

author = Indieweb::Authorship.identify(url, html)

#Output

If an author is identified then the output will be a hash containing the fields name (for the name of the author), photo (with a url for a photo of the author), and url (with a url for the page of the author). Some of these may be nil, but all will still be provided. If no author can be identified then the output will simply be a nil.

#Contributing

Bug reports can be added at https://code.deeden.co.uk/indieweb-authorship/issues, while patches are welcome at https://code.deeden.co.uk/indieweb-authorship/patches.

#License

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

#Code of Conduct

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.

#Credits

A number of the spec example files are from...