webmention 5.0.0 → 7.0.0

data/lib/webmention/parsers/html_parser.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Webmention
   module Parsers
-    class HtmlParser < BaseParser
+    # @api private
+    class HtmlParser < Parser
       @mime_types = ['text/html']
 
-      Parsers.register(self)
+      Client.register_parser(self)
 
       HTML_ATTRIBUTES_MAP = {
         'cite'   => %w[blockquote del ins q],
@@ -14,52 +17,57 @@ module Webmention
         'srcset' => %w[img source]
       }.freeze
 
-      CSS_SELECTORS_ARRAY = HTML_ATTRIBUTES_MAP.flat_map { |attribute, names| names.map { |name| "#{name}[#{attribute}]" } }.freeze
+      CSS_SELECTORS_ARRAY = HTML_ATTRIBUTES_MAP.flat_map do |attribute, names|
+        names.map { |name| "#{name}[#{attribute}]" }
+      end.freeze
 
-      # Parse an HTML string for URLs
-      #
-      # @return [Array<String>] Unique external URLs whose scheme matches http/https
+      ROOT_NODE_SELECTORS_ARRAY = ['.h-entry .e-content', '.h-entry', 'body'].freeze
+
+      private_constant :HTML_ATTRIBUTES_MAP
+      private_constant :CSS_SELECTORS_ARRAY
+      private_constant :ROOT_NODE_SELECTORS_ARRAY
+
+      # @return [Array<String>] An array of absolute URLs.
       def results
-        @results ||= resolved_urls.uniq.select { |url| url.match?(%r{https?://}) }.reject { |url| url.match(/^#{response_url}(?:#.*)?$/) }
+        @results ||=
+          extract_urls_from(*url_attributes).map { |url| response_uri.join(url).to_s }
+                                            .grep(Parser::URI_REGEXP)
       end
 
       private
 
+      # @return [Nokogiri::HTML5::Document]
       def doc
-        @doc ||= Nokogiri::HTML(response_body)
+        Nokogiri.HTML5(response_body)
       end
 
-      def resolved_urls
-        UrlAttributesParser.parse(*url_attributes).map { |url| Absolutely.to_abs(base: response_url, relative: url) }
+      # @param attributes [Array<Nokogiri::XML::Attr>]
+      #
+      # @return [Array<String>]
+      def extract_urls_from(*attributes)
+        attributes.flat_map do |attribute|
+          if attribute.name == 'srcset'
+            attribute.value.split(',').map { |value| value.strip.match(/^\S+/).to_s }
+          else
+            attribute.value
+          end
+        end
       end
 
+      # @return [Nokogiri::XML::Element]
       def root_node
-        doc.at_css('.h-entry .e-content', '.h-entry') || doc.css('body')
+        doc.at_css(*ROOT_NODE_SELECTORS_ARRAY)
       end
 
+      # @return [Array<Nokogiri::XML::Attr>]
       def url_attributes
-        url_nodes.flat_map(&:attribute_nodes).select { |attribute| HTML_ATTRIBUTES_MAP.key?(attribute.name) }
+        url_nodes.flat_map(&:attribute_nodes).find_all { |attribute| HTML_ATTRIBUTES_MAP.key?(attribute.name) }
       end
 
+      # @return [Nokogiri::XML::NodeSet]
       def url_nodes
         root_node.css(*CSS_SELECTORS_ARRAY)
       end
-
-      module UrlAttributesParser
-        # @param attributes [Array<Nokogiri::XML::Attr>]
-        # @return [Array<String>]
-        def self.parse(*attributes)
-          attributes.flat_map { |attribute| value_from(attribute) }
-        end
-
-        # @param attribute [Nokogiri::XML::Attr]
-        # @return [String, Array<String>]
-        def self.value_from(attribute)
-          return attribute.value unless attribute.name == 'srcset'
-
-          attribute.value.split(',').map { |value| value.strip.match(/^\S+/).to_s }
-        end
-      end
     end
   end
 end

data/lib/webmention/parsers/json_parser.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Webmention
+  module Parsers
+    # @api private
+    class JsonParser < Parser
+      @mime_types = ['application/json']
+
+      Client.register_parser(self)
+
+      # @return [Array<String>] An array of absolute URLs.
+      def results
+        @results ||= extract_urls_from(JSON.parse(response_body))
+      end
+
+      private
+
+      # @param objs [Array<Hash, Array, String, Integer, Boolean, nil>]
+      #
+      # @return [Array<String>]
+      def extract_urls_from(*objs)
+        objs.flat_map do |obj|
+          return obj.flat_map { |value| extract_urls_from(value) }.compact if obj.is_a?(Array)
+          return extract_urls_from(obj.values) if obj.is_a?(Hash)
+
+          obj if obj.is_a?(String) && obj.match?(Parser::URI_REGEXP)
+        end
+      end
+    end
+  end
+end

data/lib/webmention/parsers/plaintext_parser.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Webmention
+  module Parsers
+    # @api private
+    class PlaintextParser < Parser
+      @mime_types = ['text/plain']
+
+      Client.register_parser(self)
+
+      # @return [Array<String>] An array of absolute URLs.
+      def results
+        @results ||= URI::DEFAULT_PARSER.extract(response_body, %w[http https])
+      end
+    end
+  end
+end

data/lib/webmention/request.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Webmention
+  class Request
+    # Defaults derived from Webmention specification examples.
+    # @see https://www.w3.org/TR/webmention/#limits-on-get-requests
+    HTTP_CLIENT_OPTS = {
+      follow: {
+        max_hops: 20
+      },
+      headers: {
+        accept: '*/*',
+        user_agent: 'Webmention Client (https://rubygems.org/gems/webmention)'
+      },
+      timeout_options: {
+        connect_timeout: 5,
+        read_timeout: 5
+      }
+    }.freeze
+
+    private_constant :HTTP_CLIENT_OPTS
+
+    # @return [Symbol]
+    attr_reader :method
+
+    # @return [HTTP::URI]
+    attr_reader :uri
+
+    # @return [Hash]
+    attr_reader :options
+
+    # Send an HTTP GET request to the supplied URL.
+    #
+    # @example
+    #   Request.get('https://jgarber.example/posts/100')
+    #
+    # @param url [String]
+    #
+    # @return [Webmention::Response, Webmention::ErrorResponse]
+    def self.get(url)
+      new(:get, url).perform
+    end
+
+    # Send an HTTP POST request with form-encoded data to the supplied URL.
+    #
+    # @example
+    #   Request.post(
+    #     'https://aaronpk.example/webmention',
+    #     source: 'https://jgarber.examples/posts/100',
+    #     target: 'https://aaronpk.example/notes/1',
+    #     vouch: 'https://tantek.example/notes/1'
+    #   )
+    #
+    # @param url [String]
+    # @param options [Hash{Symbol => String}]
+    # @option options [String] :source
+    #   An absolute URL representing a source document.
+    # @option options [String] :target
+    #   An absolute URL representing a target document.
+    # @option options [String] :vouch
+    #   An absolute URL representing a document vouching for the source document.
+    #   See https://indieweb.org/Vouch for additional details.
+    #
+    # @return [Webmention::Response, Webmention::ErrorResponse]
+    def self.post(url, **options)
+      new(:post, url, form: options.slice(:source, :target, :vouch)).perform
+    end
+
+    # Create a new Webmention::Request.
+    #
+    # @param method [Symbol]
+    # @param url [String]
+    # @param options [Hash{Symbol => String}]
+    #
+    # @return [Webmention::Request]
+    def initialize(method, url, **options)
+      @method = method.to_sym
+      @uri = HTTP::URI.parse(url.to_s)
+      @options = options
+    end
+
+    # :nocov:
+    # @return [String]
+    def inspect
+      "#<#{self.class}:#{format('%#0x', object_id)} " \
+        "method: #{method.upcase}, " \
+        "url: #{uri}>"
+    end
+    # :nocov:
+
+    # Submit the Webmention::Request.
+    #
+    # @return [Webmention::Response, Webmention::ErrorResponse]
+    def perform
+      Response.new(client.request(method, uri, options), self)
+    rescue HTTP::Error,
+           OpenSSL::SSL::SSLError => e
+      ErrorResponse.new(e.message, self)
+    end
+
+    private
+
+    def client
+      @client ||= HTTP::Client.new(HTTP_CLIENT_OPTS)
+    end
+  end
+end

data/lib/webmention/response.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Webmention
+  class Response
+    extend Forwardable
+
+    # @return [Webmention::Request]
+    attr_reader :request
+
+    # @!method
+    #   @return [HTTP::Headers]
+    def_delegator :@response, :headers
+
+    # @!method
+    #   @return [HTTP::Response::Body]
+    def_delegator :@response, :body
+
+    # @!method
+    #   @return [Integer]
+    def_delegator :@response, :code
+
+    # @!method
+    #   @return [String]
+    def_delegator :@response, :reason
+
+    # !@method
+    #   @return [String]
+    def_delegator :@response, :mime_type
+
+    # !@method
+    #   @return [HTTP::URI]
+    def_delegator :@response, :uri
+
+    # Create a new Webmention::Response.
+    #
+    # Instances of this class represent completed HTTP requests, the details
+    # of which may be accessed using the delegated <code>#code</code> and
+    # <code>#reason</code>) instance methods.
+    #
+    # @param response [HTTP::Response]
+    # @param request [Webmention::Request]
+    #
+    # @return [Webmention::Response]
+    def initialize(response, request)
+      @response = response
+      @request = request
+    end
+
+    # :nocov:
+    # @return [String]
+    def inspect
+      "#<#{self.class}:#{format('%#0x', object_id)} " \
+        "code: #{code.inspect}, " \
+        "reason: #{reason}, " \
+        "url: #{request.uri}>"
+    end
+    # :nocov:
+
+    # @return [Boolean]
+    def ok?
+      true
+    end
+  end
+end

data/lib/webmention/url.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Webmention
+  class Url
+    extend Forwardable
+
+    # @return [HTTP::URI]
+    attr_reader :uri
+
+    # @!method
+    #   @return [String]
+    def_delegator :uri, :to_s
+
+    # Create a new Webmention::Url.
+    #
+    # @param url [String, HTTP::URI, #to_s] An absolute URL.
+    #
+    # @return [Webmention::Url]
+    def initialize(url)
+      @uri = HTTP::URI.parse(url.to_s)
+    end
+
+    # :nocov:
+    # @return [String]
+    def inspect
+      "#<#{self.class}:#{format('%#0x', object_id)} " \
+        "uri: #{uri}>"
+    end
+    # :nocov:
+
+    # @return [Webmention::Response, Webmention::ErrorResponse]
+    def response
+      @response ||= Request.get(uri)
+    end
+
+    # @return [String, nil]
+    def webmention_endpoint
+      @webmention_endpoint ||= IndieWeb::Endpoints::Parser.new(response).results[:webmention] if response.ok?
+    end
+
+    # @return [Boolean]
+    def webmention_endpoint?
+      !webmention_endpoint.nil?
+    end
+  end
+end

data/lib/webmention/verification.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Webmention
+  class Verification
+    # @param source_url [Webmention::Url]
+    # @param target_url [Webmention::Url]
+    # @param vouch_url [Webmention::Url]
+    def initialize(source_url, target_url, vouch_url: nil)
+      @source_url = source_url
+      @target_url = target_url
+      @vouch_url = vouch_url
+    end
+
+    # :nocov:
+    # @return [String]
+    def inspect
+      "#<#{self.class}:#{format('%#0x', object_id)} " \
+        "source_url: #{source_url} " \
+        "target_url: #{target_url} " \
+        "vouch_url: #{vouch_url}>"
+    end
+    # :nocov:
+
+    # @return [Boolean]
+    def source_mentions_target?
+      @source_mentions_target ||= mentioned_urls(source_url.response).any?(target_url.to_s)
+    end
+
+    # @return [Boolean]
+    def verified?
+      return source_mentions_target? unless verify_vouch?
+
+      source_mentions_target? && vouch_mentions_source?
+    end
+
+    # @return [Boolean]
+    def verify_vouch?
+      !vouch_url.nil? && !vouch_url.to_s.strip.empty?
+    end
+
+    # @return [Boolean]
+    def vouch_mentions_source?
+      @vouch_mentions_source ||=
+        verify_vouch? && mentioned_domains(vouch_url.response).any?(source_url.uri.host)
+    end
+
+    private
+
+    # @return [Webmention::Url]
+    attr_reader :source_url
+
+    # @return [Webmention::Url]
+    attr_reader :target_url
+
+    # @return [Webmention::Url]
+    attr_reader :vouch_url
+
+    # @param response [Webmention::Response]
+    #
+    # @raise (see Webmention::Client#mentioned_urls)
+    #
+    # @return [Array<String>]
+    def mentioned_domains(response)
+      mentioned_urls(response).map { |url| HTTP::URI.parse(url).host }.uniq
+    end
+
+    # @param response [Webmention::Response]
+    #
+    # @raise (see Webmention::Client#mentioned_urls)
+    #
+    # @return [Array<String>]
+    def mentioned_urls(response)
+      Client.registered_parsers[response.mime_type]
+            .new(response.body, response.uri)
+            .results
+            .uniq
+    end
+  end
+end

data/lib/webmention/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Webmention
-  VERSION = '5.0.0'.freeze
+  VERSION = '7.0.0'
 end

data/lib/webmention.rb

@@ -1,38 +1,100 @@
-require 'absolutely'
-require 'addressable/uri'
+# frozen_string_literal: true
+
+require 'json'
+
 require 'http'
 require 'indieweb/endpoints'
 require 'nokogiri'
 
-require 'webmention/version'
-require 'webmention/exceptions'
-
-require 'webmention/client'
+require_relative 'webmention/version'
 
-require 'webmention/parsers'
-require 'webmention/parsers/base_parser'
-require 'webmention/parsers/html_parser'
+require_relative 'webmention/client'
+require_relative 'webmention/url'
+require_relative 'webmention/request'
+require_relative 'webmention/response'
+require_relative 'webmention/error_response'
+require_relative 'webmention/verification'
 
-require 'webmention/services/http_request_service'
+require_relative 'webmention/parser'
+require_relative 'webmention/parsers/html_parser'
+require_relative 'webmention/parsers/json_parser'
+require_relative 'webmention/parsers/plaintext_parser'
 
 module Webmention
-  # Create a new Webmention::Client
-  # Convenience method for Webmention::Client.new
+  # Retrieve unique URLs mentioned by the provided URL.
+  #
+  # @example
+  #   Webmention.mentioned_urls('https://jgarber.example/posts/100')
+  #
+  # @param url [String, HTTP::URI, #to_s] An absolute URL.
   #
-  #   client = Webmention.client('https://source.example.com/post/100')
+  # @raise [NoMethodError]
+  #   Raised when response is a Webmention::ErrorResponse or response is of an
+  #   unsupported MIME type.
   #
-  # @param source [String] An absolute URL representing the source document
-  # @return [Webmention::Client]
-  def self.client(source)
-    Client.new(source)
+  # @return [Array<String>]
+  def self.mentioned_urls(url)
+    Client.new(url).mentioned_urls
   end
 
-  # Send a webmention from the source URL to the target URL
+  # Send a webmention from a source URL to a target URL.
+  #
+  # @example Send a webmention
+  #   source = 'https://jgarber.example/posts/100'
+  #   target = 'https://aaronpk.example/notes/1'
+  #   Webmention.send_webmention(source, target)
+  #
+  # @example Send a webmention with a vouch URL
+  #   source = 'https://jgarber.example/posts/100'
+  #   target = 'https://aaronpk.example/notes/1'
+  #   Webmention.send_webmention(source, target, vouch: 'https://tantek.example/notes/1')
+  #
+  # @param source [String, HTTP::URI, #to_s]
+  #   An absolute URL representing a source document.
+  # @param target [String, HTTP::URI, #to_s]
+  #   An absolute URL representing a target document.
+  # @param vouch [String, HTTP::URI, #to_s]
+  #   An absolute URL representing a document vouching for the source document.
+  #   See https://indieweb.org/Vouch for additional details.
+  #
+  # @return [Webmention::Response, Webmention::ErrorResponse]
+  def self.send_webmention(source, target, vouch: nil)
+    Client.new(source, vouch: vouch).send_webmention(target)
+  end
+
+  # Send webmentions from a source URL to multiple target URLs.
+  #
+  # @example Send multiple webmentions
+  #   source = 'https://jgarber.example/posts/100'
+  #   targets = ['https://aaronpk.example/notes/1', 'https://adactio.example/notes/1']
+  #   Webmention.send_webmentions(source, targets)
+  #
+  # @example Send multiple webmentions with a vouch URL
+  #   source = 'https://jgarber.example/posts/100'
+  #   targets = ['https://aaronpk.example/notes/1', 'https://adactio.example/notes/1']
+  #   Webmention.send_webmentions(source, targets, vouch: 'https://tantek.example/notes/1')
+  #
+  # @param source [String, HTTP::URI, #to_s]
+  #   An absolute URL representing a source document.
+  # @param targets [Array<String, HTTP::URI, #to_s>]
+  #   An array of absolute URLs representing multiple target documents.
+  # @param vouch [String, HTTP::URI, #to_s]
+  #   An absolute URL representing a document vouching for the source document.
+  #   See https://indieweb.org/Vouch for additional details.
+  #
+  # @return [Array<Webmention::Response, Webmention::ErrorResponse>]
+  def self.send_webmentions(source, *targets, vouch: nil)
+    Client.new(source, vouch: vouch).send_webmentions(*targets)
+  end
+
+  # Verify that a source URL links to a target URL.
+  #
+  # @param (see Webmention.send_webmention)
+  #
+  # @raise (see Webmention::Client#mentioned_urls)
   #
-  # @param source [String] An absolute URL representing the source document
-  # @param target [String] An absolute URL representing the target document
-  # @return [HTTP::Response, nil]
-  def self.send_mention(source, target)
-    client(source).send_mention(target)
+  # @return [Boolean]
+  def self.verify_webmention(source, target, vouch: nil)
+    Client.new(source, vouch: vouch).verify_webmention(target)
   end
 end

data/webmention.gemspec

@@ -1,30 +1,33 @@
+# frozen_string_literal: true
+
 require_relative 'lib/webmention/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5', '< 2.8')
+  spec.required_ruby_version = '>= 2.7', '< 4'
 
   spec.name          = 'webmention'
   spec.version       = Webmention::VERSION
-  spec.authors       = ['Aaron Parecki', 'Nat Welch']
-  spec.email         = ['aaron@parecki.com']
+  spec.authors       = ['Jason Garber']
+  spec.email         = ['jason@sixtwothree.org']
 
   spec.summary       = 'Webmention notification client'
-  spec.description   = 'A Ruby gem for sending Webmention notifications.'
+  spec.description   = 'A Ruby gem for sending and verifying Webmention notifications.'
   spec.homepage      = 'https://github.com/indieweb/webmention-client-ruby'
   spec.license       = 'Apache-2.0'
 
-  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|test)/}) }
-  end
+  spec.files         = Dir['lib/**/*'].reject { |f| File.directory?(f) }
+  spec.files        += %w[LICENSE CHANGELOG.md CONTRIBUTING.md README.md USAGE.md]
+  spec.files        += %w[webmention.gemspec]
 
   spec.require_paths = ['lib']
 
-  spec.metadata['bug_tracker_uri'] = "#{spec.homepage}/issues"
-  spec.metadata['changelog_uri']   = "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md"
+  spec.metadata = {
+    'bug_tracker_uri'       => "#{spec.homepage}/issues",
+    'changelog_uri'         => "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md",
+    'rubygems_mfa_required' => 'true'
+  }
 
-  spec.add_runtime_dependency 'absolutely', '~> 5.0'
-  spec.add_runtime_dependency 'addressable', '~> 2.7'
-  spec.add_runtime_dependency 'http', '~> 4.4'
-  spec.add_runtime_dependency 'indieweb-endpoints', '~> 5.0'
-  spec.add_runtime_dependency 'nokogiri', '~> 1.10'
+  spec.add_runtime_dependency 'http', '~> 5.0'
+  spec.add_runtime_dependency 'indieweb-endpoints', '~> 8.0'
+  spec.add_runtime_dependency 'nokogiri', '>= 1.13'
 end