indieweb-authorship 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b71984e99aeca13f5754a3c35a571d6c67bef092e5bc95d5fe8a9cdb3cb8619a
+  data.tar.gz: ad55b917bc0b0c38a02255fe7441b737dff97656b131cf7d7754e5cf08917f4d
+SHA512:
+  metadata.gz: 0a635d08bb9e1989d3800e28fe142297ddf9aeb170ea0ff18d168763f28a63d2108fe415df350c0b16cb4e97a41b06f7a922d6752d964306119b01f490063e06
+  data.tar.gz: 0ebacadded5c1ad1b0d43d552ccf8129b80250da37d65fd8527ba1b1c0efca68c7a20fda9781f78cad6eb15ce25b196c9f9bde2ffa52557b67a5057d458fd130

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2019-10-15
+
+### Added
+- Initial release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at coc+authorship@deeden.co.uk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in indieweb-authorship.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    indieweb-authorship (0.1.0)
+      microformats (~> 4.0, >= 4.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    json (2.2.0)
+    microformats (4.1.0)
+      json (~> 2.1)
+      nokogiri (~> 1.8, >= 1.8.3)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    rake (12.3.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  indieweb-authorship!
+  rake (~> 12.3)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Stephen Rushe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Indieweb::Authorship
+
+Indieweb::Authorship is a Ruby gem for identifying the author of an IndieWeb post using the [authorship algorithm](http://indieweb.org/authorship#How_to_determine).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+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.
+
+```ruby
+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.
+
+```ruby
+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 and pull requests are welcome on GitHub at https://github.com/srushe/indieweb-authorship.
+
+## 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 Indieweb::Authorship project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/srushe/indieweb-authorship/blob/master/CODE_OF_CONDUCT.md).
+
+## Credits
+
+A number of the spec example files are from...
+
+  * https://github.com/aaronpk/XRay/tree/master/tests/data/author.example.com
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "indieweb/authorship"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/indieweb-authorship.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "indieweb/authorship/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "indieweb-authorship"
+  spec.version       = Indieweb::Authorship::VERSION
+  spec.authors       = ["Stephen Rushe"]
+  spec.email         = ["steve+authorship@deeden.co.uk"]
+
+  spec.summary       = 'Identify the author of an IndieWeb post'
+  spec.description   = 'Identify the author of an IndieWeb post using the Authorship algorithm'
+  spec.homepage      = "https://github.com/srushe/indieweb-authorship"
+  spec.license       = "MIT"
+
+  spec.metadata = {
+    'bug_tracker_uri' => 'https://github.com/srushe/indieweb-authorship/issues',
+    'changelog_uri'   => 'https://github.com/srushe/indieweb-authorship/blob/master/CHANGELOG.md',
+    'homepage_uri'    => 'https://github.com/srushe/indieweb-authorship/'
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "microformats", "~> 4.0", ">= 4.1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/indieweb/authorship.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require 'indieweb/authorship/version'
+require 'microformats'
+require 'net/http'
+
+module Indieweb
+  module Authorship
+    def self.identify(url, html = nil)
+      collection = microformats_from(html: html, url: url)
+
+      # 1. start with a particular h-entry to determine authorship for, and
+      #    no author. if no h-entry, then there's no post to find authorship
+      #    for, abort.
+      h_entry = hentry_from(collection['items'])
+      return if h_entry.nil?
+
+      # 3. if the h-entry has an author property, use that
+      if h_entry['properties'].key?('author')
+        author_data = h_entry['properties']['author']
+      end
+
+      # 4. otherwise if the h-entry has a parent h-feed with author property
+      #    use that - TODO
+      if author_data.nil?
+        author_data = h_feed_author_for(h_entry, items: collection['items'])
+      end
+
+      # 5. if an author property was found
+      unless author_data.nil?
+        hcard = author_data.find { |entry| hcard?(entry) }
+
+        # 5.1. if it has an h-card, use it, exit.
+        if !hcard.nil?
+          return hcard_data_for(
+            URI.join(url, hcard['properties']['url'][0]).to_s,
+            hcard['properties']['name'][0],
+            URI.join(url, hcard['properties']['photo'][0]).to_s
+          )
+
+        # 5.2. otherwise if author property is an http(s) URL, let the
+        #      author-page have that URL
+        elsif author_data[0].start_with?('http://', 'https://')
+          return find_author_from(url: author_data[0],
+                                  original_page_items: collection['items'])
+
+        # 5.3. otherwise use the author property as the author name, exit
+        else
+          return hcard_data_for(nil, author_data[0], nil)
+        end
+      end
+
+      # 6. if there is no author-page and the h-entry's page is a permalink
+      #    page, then
+      # 6.1. if the page has a rel-author link, let the author-page's URL
+      #      be the href of the rel-author link
+
+      # 7. if there is an author-page URL
+      return unless collection['rels'].key?('author')
+
+      find_author_from(url: collection['rels']['author'][0],
+                       original_page_items: collection['items'])
+    end
+
+    def self.microformats_from(html: nil, url:)
+      html ||= Net::HTTP.get(URI(url))
+      ::Microformats.parse(html, base: url)
+    end
+    private_class_method :microformats_from
+
+    def self.hcard?(data)
+      data.is_a?(Hash) && data.key?('type') &&
+        data['type'].is_a?(Array) && data['type'].include?('h-card')
+    end
+    private_class_method :hcard?
+
+    def self.hentry_from(source)
+      h_entry = source.find { |item| item['type'][0] == 'h-entry' }
+      return h_entry unless h_entry.nil?
+      source.each do |item|
+        if item['type'][0] == 'h-feed' && item.key?('children') && item['children'][0]['type'][0] == 'h-entry'
+          return item['children'][0]
+        end
+      end
+
+      nil
+    end
+    private_class_method :hentry_from
+
+    def self.hcards_from(source)
+      source.select { |entry| hcard?(entry) }
+    end
+    private_class_method :hcards_from
+
+    def self.h_feed_author_for(h_entry, items:)
+      h_feed = items.find do |item|
+        item['type'][0] == 'h-feed' && item['children'].include?(h_entry)
+      end
+      return if h_feed.nil?
+
+      h_feed['properties']['author']
+    end
+    private_class_method :h_feed_author_for
+
+    def self.hcard_data_for(url, name, photo)
+      {
+        'url' => url,
+        'name' => name,
+        'photo' => photo
+      }
+    end
+    private_class_method :hcard_data_for
+
+    def self.find_author_from(url:, original_page_items:)
+      # 7.1. get the author-page from that URL and parse it for microformats2
+      collection = microformats_from(url: url)
+
+      hcards = hcards_from(collection['items'])
+
+      # 7.2, 7.3, and 7.4
+      hcard_matching_url_uid_and_author_page(hcards, url) ||
+        hcard_matching_rel_me_link(hcards, url, collection['rels']) ||
+        hcard_matching_url_and_author_page_url(original_page_items, url)
+    end
+    private_class_method :find_author_from
+
+    # 7.2. if author-page has 1+ h-card with url == uid == author-page's
+    #      URL, then use first such h-card, exit.
+    def self.cards_with_matching_url_and_uid(hcards)
+      hcards = hcards.collect { |card| card['properties'] }
+      hcards.select do |card|
+        card.key?('url') && card.key?('uid') &&
+          card['url'] == card['uid']
+      end
+    end
+    private_class_method :cards_with_matching_url_and_uid
+
+    def self.hcard_matching_url_uid_and_author_page(hcards = [], author_page)
+      return if hcards.empty? || author_page.nil?
+
+      cards_with_matching_url_and_uid = cards_with_matching_url_and_uid(hcards)
+      hcard = cards_with_matching_url_and_uid.find do |card|
+        card['url'].include?(author_page)
+      end
+      return if hcard.nil?
+
+      hcard_data_for(author_page, hcard['name'][0], hcard['photo'][0])
+    end
+    private_class_method :hcard_matching_url_uid_and_author_page
+
+    # 7.3. else if author-page has 1+ h-card with url property which
+    #      matches the href of a rel-me link on the author-page (perhaps
+    #      the same hyperlink element as the u-url, though not required
+    #      to be), use first such h-card, exit.
+    def self.card_with_matching_rel_me_link(hcards, rels_me)
+      return if rels_me.nil?
+
+      hcards.find do |card|
+        !(card['properties']['url'] & rels_me).empty?
+      end
+    end
+    private_class_method :card_with_matching_rel_me_link
+
+    def self.hcard_matching_rel_me_link(hcards, url, rels = {})
+      hcard = card_with_matching_rel_me_link(hcards, rels['me'])
+      return if hcard.nil?
+
+      hcard_data_for(url,
+                     hcard['properties']['name'][0],
+                     hcard['properties']['photo'][0])
+    end
+    private_class_method :hcard_matching_rel_me_link
+
+    # 7.4. if the h-entry's page has 1+ h-card with url == author-page URL,
+    #      use first such h-card, exit.
+    def self.hcard_matching_url_and_author_page_url(items, url)
+      hcard = hcards_from(items).find do |card|
+        card['properties']['url'].include?(url)
+      end
+
+      hcard_data_for(url,
+                     hcard['properties']['name'][0],
+                     hcard['properties']['photo'][0])
+    end
+  end
+end

data/lib/indieweb/authorship/version.rb

@@ -0,0 +1,5 @@
+module Indieweb
+  module Authorship
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: indieweb-authorship
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Rushe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: microformats
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Identify the author of an IndieWeb post using the Authorship algorithm
+email:
+- steve+authorship@deeden.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- indieweb-authorship.gemspec
+- lib/indieweb/authorship.rb
+- lib/indieweb/authorship/version.rb
+homepage: https://github.com/srushe/indieweb-authorship
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/srushe/indieweb-authorship/issues
+  changelog_uri: https://github.com/srushe/indieweb-authorship/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/srushe/indieweb-authorship/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Identify the author of an IndieWeb post
+test_files: []