hearthside-mentionable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 723a8ed6c10216ddfd049ddba8f3ffaaf2b75a37726d78daf59ed57d12a96138
+  data.tar.gz: d2c45c68cb094a598c3b461e572115080a9ced58e0634ce5c59bf53e3a29dfa0
+SHA512:
+  metadata.gz: 489b52eb930a4f4dbf6ef166252478fce4dac7eacc0c8c5fb2a35242fafbde29fb49a7e350fc422765cdd69b896f150f0df41b5eed122822a5b25caea8810c68
+  data.tar.gz: 5c4ff163408a71d4803eddc334ec62a0b230ced76c502c3bfea406ed1d889cab658d53fcbf9a89f7bc640e92fde6e1a33d5ca233c762db6d03ab742d0725bb99

data/LICENSE.md

@@ -0,0 +1,33 @@
+Mentionable Copyright 2020 Caleb Hearth (“Licensor”)
+
+Hippocratic License Version Number: 2.1.
+
+Purpose. The purpose of this License is for the Licensor named above to permit the Licensee (as defined below) broad permission, if consistent with Human Rights Laws and Human Rights Principles (as each is defined below), to use and work with the Software (as defined below) within the full scope of Licensor’s copyright and patent rights, if any, in the Software, while ensuring attribution and protecting the Licensor from liability.
+
+Permission and Conditions. The Licensor grants permission by this license (“License”), free of charge, to the extent of Licensor’s rights under applicable copyright and patent law, to any person or entity (the “Licensee”) obtaining a copy of this software and associated documentation files (the “Software”), to do everything with the Software that would otherwise infringe (i) the Licensor’s copyright in the Software or (ii) any patent claims to the Software that the Licensor can license or becomes able to license, subject to all of the following terms and conditions:
+
+* Acceptance. This License is automatically offered to every person and entity subject to its terms and conditions. Licensee accepts this License and agrees to its terms and conditions by taking any action with the Software that, absent this License, would infringe any intellectual property right held by Licensor.
+
+* Notice. Licensee must ensure that everyone who gets a copy of any part of this Software from Licensee, with or without changes, also receives the License and the above copyright notice (and if included by the Licensor, patent, trademark and attribution notice). Licensee must cause any modified versions of the Software to carry prominent notices stating that Licensee changed the Software. For clarity, although Licensee is free to create modifications of the Software and distribute only the modified portion created by Licensee with additional or different terms, the portion of the Software not modified must be distributed pursuant to this License. If anyone notifies Licensee in writing that Licensee has not complied with this Notice section, Licensee can keep this License by taking all practical steps to comply within 30 days after the notice. If Licensee does not do so, Licensee’s License (and all rights licensed hereunder) shall end immediately.
+
+* Compliance with Human Rights Principles and Human Rights Laws.
+
+    1. Human Rights Principles.
+
+        (a) Licensee is advised to consult the articles of the United Nations Universal Declaration of Human Rights and the United Nations Global Compact that define recognized principles of international human rights (the “Human Rights Principles”). Licensee shall use the Software in a manner consistent with Human Rights Principles.
+
+        (b) Unless the Licensor and Licensee agree otherwise, any dispute, controversy, or claim arising out of or relating to (i) Section 1(a) regarding Human Rights Principles, including the breach of Section 1(a), termination of this License for breach of the Human Rights Principles, or invalidity of Section 1(a) or (ii) a determination of whether any Law is consistent or in conflict with Human Rights Principles pursuant to Section 2, below, shall be settled by arbitration in accordance with the Hague Rules on Business and Human Rights Arbitration (the “Rules”); provided, however, that Licensee may elect not to participate in such arbitration, in which event this License (and all rights licensed hereunder) shall end immediately. The number of arbitrators shall be one unless the Rules require otherwise.
+
+        Unless both the Licensor and Licensee agree to the contrary: (1) All documents and information concerning the arbitration shall be public and may be disclosed by any party; (2) The repository referred to under Article 43 of the Rules shall make available to the public in a timely manner all documents concerning the arbitration which are communicated to it, including all submissions of the parties, all evidence admitted into the record of the proceedings, all transcripts or other recordings of hearings and all orders, decisions and awards of the arbitral tribunal, subject only to the arbitral tribunal's powers to take such measures as may be necessary to safeguard the integrity of the arbitral process pursuant to Articles 18, 33, 41 and 42 of the Rules; and (3) Article 26(6) of the Rules shall not apply.
+
+    2. Human Rights Laws. The Software shall not be used by any person or entity for any systems, activities, or other uses that violate any Human Rights Laws.  “Human Rights Laws” means any applicable laws, regulations, or rules (collectively, “Laws”) that protect human, civil, labor, privacy, political, environmental, security, economic, due process, or similar rights; provided, however, that such Laws are consistent and not in conflict with Human Rights Principles (a dispute over the consistency or a conflict between Laws and Human Rights Principles shall be determined by arbitration as stated above).  Where the Human Rights Laws of more than one jurisdiction are applicable or in conflict with respect to the use of the Software, the Human Rights Laws that are most protective of the individuals or groups harmed shall apply.
+
+    3. Indemnity. Licensee shall hold harmless and indemnify Licensor (and any other contributor) against all losses, damages, liabilities, deficiencies, claims, actions, judgments, settlements, interest, awards, penalties, fines, costs, or expenses of whatever kind, including Licensor’s reasonable attorneys’ fees, arising out of or relating to Licensee’s use of the Software in violation of Human Rights Laws or Human Rights Principles.
+
+* Failure to Comply. Any failure of Licensee to act according to the terms and conditions of this License is both a breach of the License and an infringement of the intellectual property rights of the Licensor (subject to exceptions under Laws, e.g., fair use). In the event of a breach or infringement, the terms and conditions of this License may be enforced by Licensor under the Laws of any jurisdiction to which Licensee is subject. Licensee also agrees that the Licensor may enforce the terms and conditions of this License against Licensee through specific performance (or similar remedy under Laws) to the extent permitted by Laws. For clarity, except in the event of a breach of this License, infringement, or as otherwise stated in this License, Licensor may not terminate this License with Licensee.
+
+* Enforceability and Interpretation. If any term or provision of this License is determined to be invalid, illegal, or unenforceable by a court of competent jurisdiction, then such invalidity, illegality, or unenforceability shall not affect any other term or provision of this License or invalidate or render unenforceable such term or provision in any other jurisdiction; provided, however, subject to a court modification pursuant to the immediately following sentence, if any term or provision of this License pertaining to Human Rights Laws or Human Rights Principles is deemed invalid, illegal, or unenforceable against Licensee by a court of competent jurisdiction, all rights in the Software granted to Licensee shall be deemed null and void as between Licensor and Licensee. Upon a determination that any term or provision is invalid, illegal, or unenforceable, to the extent permitted by Laws, the court may modify this License to affect the original purpose that the Software be used in compliance with Human Rights Principles and Human Rights Laws as closely as possible. The language in this License shall be interpreted as to its fair meaning and not strictly for or against any party.
+
+* Disclaimer. TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES “AS IS,” WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR AND ANY OTHER CONTRIBUTOR SHALL NOT BE LIABLE TO ANYONE FOR ANY DAMAGES OR OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THIS LICENSE, UNDER ANY KIND OF LEGAL CLAIM.
+
+This Hippocratic License is an Ethical Source license (https://ethicalsource.dev) and is offered for use by licensors and licensees at their own risk, on an “AS IS” basis, and with no warranties express or implied, to the maximum extent permitted by Laws.

data/README.md

@@ -0,0 +1,56 @@
+# Mentionable
+
+An implementation of [Webmention], a web standard for mentions and conversyions
+across the web. With mentionable, people can reply by sending webmentions for:
+
+[Webmention]: <https://www.w3.org/TR/webmention/> "Webmention W3C Recommendation"
+
+- commenting
+- liking
+- reposting
+- mentioning / linking to
+- quote
+
+The `h-entry` specification provides for more types of reply, but these are what
+Mentionable currently supports.
+
+Mentionable sets up an endpoint in your Rails app to receive these Webmentions,
+confirms that the reply actually links back to a page you've published, and
+stores replies in the database for you to display or use as you please.
+
+Optionally, Mentionable can be configured to send Webmentions when content you
+create links to external sites. It does this by querying the link, performing
+[Webmention endpoint discovery], and notifying sites that are set up to receive
+Webmentions.
+
+[Webmention endpoint discovery]: <https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint>
+
+You can configure one or more objects to be queried upon creation by telling
+Mentionable what they are and what method to check for links.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mentionable'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install mentionable
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+
+See LICENSE.md

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Mentionable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/mentionable_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/mentionable .css

data/app/assets/stylesheets/mentionable/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/mentionable/mentions.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/mentionable/application_controller.rb

@@ -0,0 +1,5 @@
+module Mentionable
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/mentionable/mentions_controller.rb

@@ -0,0 +1,43 @@
+require_dependency "mentionable/application_controller"
+
+module Mentionable
+  class MentionsController < ApplicationController
+    skip_forgery_protection
+
+    def create
+      source = URI(params.fetch(:source) { missing_source_or_target; return })
+      target = URI(params.fetch(:target) { missing_source_or_target; return })
+
+      if source == target
+        render(
+          plain: "source URL cannot be the same as target URL",
+          status: :bad_request,
+        )
+        return
+      end
+
+      [source, target].each do |uri|
+        if !%w(http https).include? uri.scheme
+          render(
+            plain: "#{uri} is not a valid URL. Please use http:// or https://",
+            status: :bad_request,
+          )
+          return
+        end
+      end
+
+      Mentionable.config.request_verification_job.perform_later(source.to_s, target.to_s)
+
+      head :accepted
+    end
+
+    private
+
+    def missing_source_or_target
+      render(
+        plain: "source and target params are required and must be HTTP or HTTPS URLs",
+        status: :bad_request,
+      )
+    end
+  end
+end

data/app/helpers/mentionable/application_helper.rb

@@ -0,0 +1,11 @@
+module Mentionable
+  module ApplicationHelper
+    def webmention_link_tag(href = mentionable.mentions_url)
+      tag("link", { rel: "webmention", href: href })
+    end
+
+    def add_webmention_header(href = mentionable.mentions_url)
+      response.set_header("Link", %(<#{href}>; rel="webmention"))
+    end
+  end
+end

data/app/jobs/mentionable/application_job.rb

@@ -0,0 +1,4 @@
+module Mentionable
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/jobs/mentionable/confirm_mention_job.rb

@@ -0,0 +1,31 @@
+require "net/http"
+
+# Query a {Mention#source} to confirm that it mentions the {Mention#target}.
+# If the source mentions the target, the {Mention#status} is updated to
+# "verified", else it is updated to "failed".
+#
+# Defaults to caching the HTTP response on the {Mention}.
+class Mentionable::ConfirmMentionJob < ApplicationJob
+  queue_as :default
+
+  # @param mention [Mention] Mention to confirm
+  # @param cache [Boolean] Cache the HTTP response on the {Mention}
+  # @todo Look for href/src/srcset attribute values, not bare mentions of URLs.
+  #   Nokogiri?
+  # @todo Use per-media-type rules to determine whether the source document
+  #   mentions the target URL.
+  # @see https://www.w3.org/TR/webmention/#webmention-verification-p-3
+  def perform(mention, cache: true)
+    source_page = Net::HTTP.get(URI(mention.source))
+    mentioned_urls = URI.extract(source_page, %w[http https])
+    if mentioned_urls.include?(mention.target)
+      mention.status = "verified"
+    else
+      mention.status = "failed"
+    end
+    if cache
+      mention.html = source_page
+    end
+    mention.save!
+  end
+end

data/app/jobs/mentionable/save_mention_job.rb

@@ -0,0 +1,23 @@
+module Mentionable
+  # Job to save a {Mention} with the provided source and target.
+  # After persisting, a {Mentionable::Configuration#webmention_verification_job} is enqueued.
+  class SaveMentionJob < ApplicationJob
+    queue_as :default
+
+    # @param source [String] source URL of the Webmention source
+    # @param target [String] target URL of the Webmention target
+    # @param valid [Boolean] whether the target URL was valid in
+    #  {Mentionable::Configuration.verify_with_router_job
+    #  Mentionable.config.verify_with_router_job}
+    # @raise [ActiveRecord::RecordInvalid] if the {Mention} would be invalid
+    #   with the given source and target inputs.
+    def perform(source:, target:, valid:)
+      mention = Mentionable::Mention.create!({
+        source:,
+        target:,
+        status: valid ? :awaiting_verification : :target_not_recognized,
+      })
+      Mentionable.config.webmention_verification_job.perform_later(mention)
+    end
+  end
+end

data/app/jobs/mentionable/verify_with_router_job.rb

@@ -0,0 +1,27 @@
+module Mentionable
+  # Job to verify incoming webmentions that have passed the initial set of
+  # verifications (source and target both present, not identical, and are valid
+  # URLs).
+  #
+  # Verifies that the Rails router has a path that matches the target URL's
+  # path. Pass source, target, and validity to
+  # {Mentionable::Configuration#persistence_job
+  # Mentionable.config.persistence_job}.
+  class VerifyWithRouterJob < ApplicationJob
+    queue_as :default
+
+    def perform(source, target)
+      Mentionable.config.persistence_job
+        .perform_later(source:, target:, valid: valid_path(target))
+    end
+
+    private
+
+    def valid_path(target)
+      Rails.application.routes.recognize_path(target)
+      true
+    rescue ActionController::RoutingError
+      false
+    end
+  end
+end

data/app/mailers/mentionable/application_mailer.rb

@@ -0,0 +1,6 @@
+module Mentionable
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/mentionable/application_record.rb

@@ -0,0 +1,5 @@
+module Mentionable
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/mentionable/mention.rb

@@ -0,0 +1,18 @@
+module Mentionable
+  class Mention < ApplicationRecord
+    validates :target,
+      presence: true,
+      comparison: { other_than: :source, if: :source }
+    validates :source, presence: true
+    enum :status, [
+      :target_not_recognized,
+      :awaiting_verification,
+      :verified,
+      :failed,
+    ].to_h { [_1, _1.to_s] }
+
+    def microformat_items
+      H.from_html(html)
+    end
+  end
+end

data/app/views/layouts/mentionable/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Mentionable</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "mentionable/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Mentionable::Engine.routes.draw do
+  post "/webmention", to: "mentions#create", as: :mentions
+end

data/db/migrate/20200609182614_create_mentionable_mentions.rb

@@ -0,0 +1,10 @@
+class CreateMentionableMentions < ActiveRecord::Migration[6.0]
+  def change
+    create_table :mentionable_mentions do |t|
+      t.string :source, null: false
+      t.string :target, null: false
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20230121215844_add_status_and_html_and_microformats_to_mentions.rb

@@ -0,0 +1,6 @@
+class AddStatusAndHtmlAndMicroformatsToMentions < ActiveRecord::Migration[7.0]
+  def change
+    add_column :mentionable_mentions, :status, :string
+    add_column :mentionable_mentions, :html, :text
+  end
+end

data/lib/h/adr.rb

@@ -0,0 +1,30 @@
+class H::Adr
+  include ActiveModel::AttributeAssignment
+
+  attr_accessor :street_address
+  attr_accessor :extended_address
+  attr_accessor :post_office_box
+  attr_accessor :locality
+  attr_accessor :region
+  attr_accessor :postal_code
+  attr_accessor :country_name
+  attr_accessor :label
+  attr_accessor :geo
+  attr_accessor :latitude
+  attr_accessor :longitude
+  attr_accessor :altitude
+  attr_accessor :children
+
+  def initialize(properties: nil, children: nil)
+    if properties
+      # name will be ignored per https://microformats.org/wiki/h-adr#:~:text=there%20is%20no%20%22p%2Dname%22%20property%20in%20h%2Dadr
+      properties.delete(:name)
+      assign_attributes(properties.to_h { |k, v| [k.to_s.underscore.to_sym, v.first] })
+    end
+    @children = children&.flat_map { H.parse([_1]) }
+  end
+
+  def ==(other)
+    other.is_a?(self.class) && instance_values == other.instance_values
+  end
+end

data/lib/h/base.rb

@@ -0,0 +1,55 @@
+require "microformats"
+
+class H::Base
+  def self.plural_attributes = [] # :nodoc:
+  def self.date_attributes = [] # :nodoc:
+  def self.special_attributes = [] # :nodoc:
+
+  def self.from_html(html)
+    h = Microformats
+      .parse(html)
+      .items
+      .first
+      .to_hash
+    new(properties: h["properties"], children: h["children"])
+  end
+
+  def initialize(properties:, children: nil)
+    properties = properties&.with_indifferent_access
+    children = children&.map(&:with_indifferent_access)
+    singular_attributes = self.class.attributes -
+      self.class.plural_attributes -
+      self.class.date_attributes -
+      self.class.special_attributes
+
+    self.class.plural_attributes.each do |attribute|
+      if (items = properties[attribute.to_s.singularize.dasherize])
+        instance_variable_set("@#{attribute}", H.parse(items))
+      end
+    end
+    singular_attributes.each do |attribute|
+      if (item = properties[attribute.to_s.dasherize]&.first)
+        instance_variable_set("@#{attribute}", H.parse([item]).first)
+      end
+    end
+    self.class.date_attributes.each do |attribute|
+      if (date = properties[attribute]&.first)
+        instance_variable_set("@#{attribute}", DateTime.parse(date))
+      end
+    end
+    @children = children&.flat_map { H.parse([_1]) }
+  end
+
+  def inspect
+    attr_strings = self
+      .class
+      .attributes
+      .filter_map { (value = instance_variable_get("@#{_1}")) && " @#{_1}=#{value.inspect}" }
+      .join(",")
+    %[#<#{self.class.name}:#{object_id}#{attr_strings}>]
+  end
+
+  def ==(other)
+    other.is_a?(self.class) && instance_values == other.instance_values
+  end
+end

data/lib/h/card.rb

@@ -0,0 +1,52 @@
+require "microformats"
+
+class H::Card < H::Base
+  def self.attributes # :nodoc:
+    [
+      :name,
+      :honorific_prefix,
+      :given_name,
+      :additional_name,
+      :family_name,
+      :sort_string,
+      :honorific_suffix,
+      :nickname,
+      :emails,
+      :logo,
+      :photos,
+      :urls,
+      :uid,
+      :categories,
+      :adrs,
+      :post_office_box,
+      :extended_address,
+      :street_address,
+      :locality,
+      :region,
+      :postal_code,
+      :country_name,
+      :label,
+      :geo,
+      :latitude,
+      :longitude,
+      :altitude,
+      :tels,
+      :note,
+      :bday,
+      :key,
+      :orgs,
+      :job_title,
+      :role,
+      :impp,
+      :sex,
+      :gender_identity,
+      :anniversary,
+      :children,
+    ]
+  end
+
+  def self.plural_attributes = %i[emails photos urls categories adrs tels orgs]
+  def self.date_attributes = %i[bday anniversary]
+
+  attributes.each { attr_reader _1 }
+end

data/lib/h/cite.rb

@@ -0,0 +1,10 @@
+class H::Cite < H::Base
+  def self.attributes = %i[name published author url uid publication accessed content]
+  def self.date_attributes = %i[published accessed]
+
+  attr_accessor *attributes
+
+  def initialize(properties:, children: nil)
+    super
+  end
+end

data/lib/h/entry.rb

@@ -0,0 +1,51 @@
+class H::Entry < H::Base
+  def self.attributes # :nodoc:
+    [
+      :name,
+      :summary,
+      :content,
+      :published,
+      :updated,
+      :author,
+      :categories,
+      :url,
+      :uid,
+      :location,
+      :syndications,
+      :in_reply_to,
+      :rsvp,
+      :like_of,
+      :repost_of,
+      :comments,
+      :photos,
+      :videos,
+      :audios,
+      :likes,
+      :reposts,
+      :bookmark_of,
+      :featured,
+      :duration,
+      :size,
+      :listen_of,
+      :watch_of,
+      :read_of,
+      :translation_of,
+      :checkin,
+      :children,
+    ]
+  end
+
+  def self.plural_attributes
+    %i[categories syndications comments photos videos audios likes reposts in_reply_to]
+  end
+
+  def self.date_attributes = %i[published updated]
+  def self.special_attributes = %i[content]
+
+  attributes.each { attr_accessor _1 }
+
+  def initialize(properties:, children: nil)
+    super
+    @content = properties[:content]
+  end
+end

data/lib/h.rb

@@ -0,0 +1,35 @@
+module H
+  class << self
+    def from_html(html)
+      parse(Microformats.parse(html).to_h["items"])
+    end
+
+    def parse(items)
+      items.map do |item|
+        if item.is_a? String
+          item
+        else
+          item = item.to_hash.with_indifferent_access
+          case item[:type]&.first
+          when "h-adr"
+            H::Adr.new(properties: item[:properties], children: item[:children])
+          when "h-card"
+            H::Card.new(properties: item[:properties], children: item[:children])
+          when "h-cite"
+            H::Cite.new(properties: item[:properties], children: item[:children])
+          when "h-entry"
+            H::Entry.new(properties: item[:properties], children: item[:children])
+          else
+            item
+          end
+        end
+      end
+    end
+  end
+end
+
+require "h/base"
+require "h/adr"
+require "h/card"
+require "h/cite"
+require "h/entry"

data/lib/mentionable/configuration.rb

@@ -0,0 +1,61 @@
+module Mentionable
+  class Configuration
+    # The Mentionable request verification job to use when a new webmention is
+    # received. It is responsible for verifying the webmention per
+    # https://www.w3.org/TR/webmention/#request-verification and then enqueuing
+    # a {#persistence_job}.
+    #
+    # Defaults to {VerifyWithRouterJob}
+    # @return [Class] Mentionable request verification job
+    attr_accessor :request_verification_job
+
+    # The Mentionable persistence job is used when a source and target have been
+    # successfully verified to save the webmention. It should persist the
+    # webmention and then enqueue a {#webmention_verification_job} with the
+    # persisted record.
+    #
+    # Defaults to {SaveMentionJob}
+    # @return [Class] Mentionable persistence job
+    attr_accessor :persistence_job
+
+    # The Mentionable webmention verification job to use when a new webmention is
+    # received. It is responsible for verifying the webmention per
+    # https://www.w3.org/TR/webmention/#webmention-verification and optionally
+    # updating the {Mention} with a cache of the HTTP response and parsed
+    # microformat data.
+    #
+    # Defaults to {ConfirmMentionJob}
+    # @return [Class] Mentionable request verification job
+    attr_accessor :webmention_verification_job
+
+    def initialize
+      @request_verification_job = Mentionable::VerifyWithRouterJob
+      @persistence_job = Mentionable::SaveMentionJob
+      @webmention_verification_job = Mentionable::ConfirmMentionJob
+    end
+  end
+
+  # @return [Mentionable::Configuration] Mentionable's current config
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  # Set Mentionable's config
+  #
+  # @param config [Mentionable::Configuration]
+  def self.config=(config)
+    @config = config
+  end
+
+  # Modify Mentionable's current config
+  #
+  # @yieldparam [Mentionable::Configuration] config current Mentionable config
+  # ```
+  # Mentionable.configure do |config|
+  #   config.request_verification_job = Mentionable::VerifyWithRouterJob
+  # end
+  # ```
+  def self.configure
+    yield config
+  end
+end

data/lib/mentionable/engine.rb

@@ -0,0 +1,5 @@
+module Mentionable
+  class Engine < ::Rails::Engine
+    isolate_namespace Mentionable
+  end
+end

data/lib/mentionable/version.rb

@@ -0,0 +1,3 @@
+module Mentionable
+  VERSION = '0.1.0'
+end

data/lib/mentionable.rb

@@ -0,0 +1,6 @@
+require "mentionable/engine"
+require "mentionable/configuration"
+require "h"
+
+module Mentionable
+end

data/lib/tasks/mentionable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :mentionable do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: hearthside-mentionable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Caleb Hearth
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: microformats
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocktail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Webmention sending and receiving for Rails projects.
+email:
+- caleb@calebhearth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- app/assets/config/mentionable_manifest.js
+- app/assets/stylesheets/mentionable/application.css
+- app/assets/stylesheets/mentionable/mentions.css
+- app/controllers/mentionable/application_controller.rb
+- app/controllers/mentionable/mentions_controller.rb
+- app/helpers/mentionable/application_helper.rb
+- app/jobs/mentionable/application_job.rb
+- app/jobs/mentionable/confirm_mention_job.rb
+- app/jobs/mentionable/save_mention_job.rb
+- app/jobs/mentionable/verify_with_router_job.rb
+- app/mailers/mentionable/application_mailer.rb
+- app/models/mentionable/application_record.rb
+- app/models/mentionable/mention.rb
+- app/views/layouts/mentionable/application.html.erb
+- config/environment.rb
+- config/routes.rb
+- db/migrate/20200609182614_create_mentionable_mentions.rb
+- db/migrate/20230121215844_add_status_and_html_and_microformats_to_mentions.rb
+- lib/h.rb
+- lib/h/adr.rb
+- lib/h/base.rb
+- lib/h/card.rb
+- lib/h/cite.rb
+- lib/h/entry.rb
+- lib/mentionable.rb
+- lib/mentionable/configuration.rb
+- lib/mentionable/engine.rb
+- lib/mentionable/version.rb
+- lib/tasks/mentionable_tasks.rake
+homepage: https://github.com/calebthompson/mentionable
+licenses:
+- Hippocratic 2.1
+metadata: {}
+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.4.4
+signing_key:
+specification_version: 4
+summary: Webmentions on Rails
+test_files: []