webmention 0.1.6 → 1.0.0

data/lib/webmention/client.rb

@@ -1,190 +1,47 @@
 module Webmention
   class Client
-    # Public: Returns a URI of the url initialized with.
-    attr_reader :url
+    def initialize(source)
+      raise ArgumentError, "source must be a String (given #{source.class.name})" unless source.is_a?(String)
 
-    # Public: Returns an array of links contained within the url.
-    attr_reader :links
+      @source = source
 
-    # Public: Create a new client
-    #
-    # url - The url you want us to crawl.
-    def initialize(url)
-      @url = URI.parse(url)
-      @links ||= Set.new
-
-      unless Webmention::Client.valid_http_url? @url
-        raise ArgumentError.new "#{@url} is not a valid HTTP or HTTPS URI."
-      end
-    end
-
-    # Public: Crawl the url this client was initialized with.
-    #
-    # Returns the number of links found.
-    def crawl
-      @links ||= Set.new
-      if @url.nil?
-        raise ArgumentError.new "url is nil."
-      end
-
-      Nokogiri::HTML(open(self.url)).css('.h-entry a').each do |link|
-        link = link.attribute('href').to_s
-        if Webmention::Client.valid_http_url? link
-          @links.add link
-        end
-      end
-
-      return @links.count
+      raise ArgumentError, 'source must be an absolute URL (e.g. https://example.com)' unless source_uri.absolute?
     end
 
-    # Public: Sends mentions to each of the links found in the page.
-    #
-    # Returns the number of links mentioned.
-    def send_mentions
-      if self.links.nil? or self.links.empty?
-        self.crawl
-      end
-
-      cnt = 0
-      self.links.each do |link|
-        endpoint = Webmention::Client.supports_webmention? link
-        if endpoint
-          cnt += 1 if Webmention::Client.send_mention endpoint, self.url, link
-        end
-      end
-
-      return cnt
+    def send_all_mentions
+      mentioned_urls.each_with_object({}) { |url, hash| hash[url] = send_mention(url) }
     end
 
-    # Public: Send a mention to an endoint about a link from a link.
-    #
-    # endpoint - URL to send mention to.
-    # source - Source of mention (your page).
-    # target - The link that was mentioned in the source page.
-    #
-    # Returns a boolean.
-    def self.send_mention endpoint, source, target, full_response=false
-      data = {
-        :source => source,
-        :target => target,
-      }
-
-      # Ensure the endpoint is an absolute URL
-      endpoint = absolute_endpoint endpoint, target
+    def mentioned_urls
+      raise UnsupportedMimeTypeError, "Unsupported MIME Type: #{source_response.mime_type}" unless parser_for_mime_type
 
-      begin
-        response = HTTParty.post(endpoint, {
-          :body => data
-        })
-
-        if full_response
-          return response
-        else
-          return response.code == 200 || response.code == 202
-        end
-      rescue
-        return false
-      end
+      @mentioned_urls ||= parser_for_mime_type.new(source_response).results
     end
 
-    # Public: Fetch a url and check if it supports webmention
-    #
-    # url - URL to check
-    #
-    # Returns false if does not support webmention, returns string
-    # of url to ping if it does.
-    def self.supports_webmention? url
-      return false if !Webmention::Client.valid_http_url? url
-
-      doc = nil
-
-      begin
-        response = HTTParty.get(url, {
-          :timeout => 3,
-          :headers => {
-            'User-Agent' => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/29.0.1547.57 Safari/537.36 (https://rubygems.org/gems/webmention)",
-            'Accept' => '*/*'
-          }
-        })
-
-        # First check the HTTP Headers
-        if !response.headers['Link'].nil?
-          endpoint = self.discover_webmention_endpoint_from_header response.headers['Link']
-          return endpoint if endpoint
-        end
+    def send_mention(target)
+      endpoint = IndieWeb::Endpoints.get(target).webmention
 
-        # Do we support webmention?
-        endpoint = self.discover_webmention_endpoint_from_html response.body.to_s
-        return endpoint if endpoint
+      return unless endpoint
 
-        # TODO: Move to supports_pingback? method
-        # Last chance, do we support Pingback?
-        # if !doc.css('link[rel="pingback"]').empty?
-        #   return doc.css('link[rel="pingback"]').attribute("href").value
-        # end
-
-      rescue EOFError
-      rescue Errno::ECONNRESET
-      end
-
-      return false
+      HttpRequest.post(Addressable::URI.parse(endpoint), source: @source, target: target)
+    rescue IndieWeb::Endpoints::IndieWebEndpointsError => exception
+      raise Webmention.const_get(exception.class.name.split('::').last), exception
     end
 
-    def self.discover_webmention_endpoint_from_html html
-      doc = Nokogiri::HTML(html)
-      if !doc.css('[rel~="webmention"]').css('[href]').empty?
-        doc.css('[rel~="webmention"]').css('[href]').attribute("href").value
-      elsif !doc.css('[rel="http://webmention.org/"]').css('[href]').empty?
-        doc.css('[rel="http://webmention.org/"]').css('[href]').attribute("href").value
-      elsif !doc.css('[rel="http://webmention.org"]').css('[href]').empty?
-        doc.css('[rel="http://webmention.org"]').css('[href]').attribute("href").value
-      else
-        false
-      end
-    end
+    private
 
-    def self.discover_webmention_endpoint_from_header header
-      if matches = header.match(%r{<([^>]+)>; rel="[^"]*\s?webmention\s?[^"]*"})
-        return matches[1]
-      elsif matches = header.match(%r{<([^>]+)>; rel=webmention})
-          return matches[1]
-      elsif matches = header.match(%r{rel="[^"]*\s?webmention\s?[^"]*"; <([^>]+)>})
-        return matches[1]
-      elsif matches = header.match(%r{rel=webmention; <([^>]+)>})
-        return matches[1]
-      elsif matches = header.match(%r{<([^>]+)>; rel="http://webmention\.org/?"})
-        return matches[1]
-      elsif matches = header.match(%r{rel="http://webmention\.org/?"; <([^>]+)>})
-        return matches[1]
-      end
-      return false
+    def parser_for_mime_type
+      @parser_for_mime_type ||= Parsers.registered[source_response.mime_type]
     end
 
-    # Public: Use URI to parse a url and check if it is HTTP or HTTPS.
-    #
-    # url - URL to check
-    #
-    # Returns a boolean.
-    def self.valid_http_url? url
-      if url.is_a? String
-        url = URI.parse(url)
-      end
-
-      return (url.is_a? URI::HTTP or url.is_a? URI::HTTPS)
+    def source_response
+      @source_response ||= HttpRequest.get(source_uri)
     end
 
-    # Public: Takes an endpoint and ensures an absolute URL is returned
-    #
-    # endpoint - Endpoint which may be an absolute or relative URL
-    # url - URL of the webmention
-    #
-    # Returns original endpoint if it is already an absolute URL; constructs
-    # new absolute URL using relative endpoint if not
-    def self.absolute_endpoint endpoint, url
-      unless Webmention::Client.valid_http_url? endpoint
-        endpoint = URI.join(url, endpoint).to_s
-      end
-      endpoint
+    def source_uri
+      @source_uri ||= Addressable::URI.parse(@source)
+    rescue Addressable::URI::InvalidURIError => exception
+      raise InvalidURIError, exception
     end
   end
 end

data/lib/webmention/exceptions.rb

@@ -0,0 +1,15 @@
+module Webmention
+  class WebmentionClientError < StandardError; end
+
+  class ArgumentError < WebmentionClientError; end
+
+  class ConnectionError < WebmentionClientError; end
+
+  class InvalidURIError < WebmentionClientError; end
+
+  class TimeoutError < WebmentionClientError; end
+
+  class TooManyRedirectsError < WebmentionClientError; end
+
+  class UnsupportedMimeTypeError < WebmentionClientError; end
+end

data/lib/webmention/http_request.rb

@@ -0,0 +1,41 @@
+module Webmention
+  class HttpRequest
+    # Defaults derived from Webmention specification examples
+    # https://www.w3.org/TR/webmention/#limits-on-get-requests
+    # rubocop:disable Layout/AlignHash
+    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
+    # rubocop:enable Layout/AlignHash
+
+    class << self
+      def get(uri)
+        request(:get, uri)
+      end
+
+      def post(uri, **options)
+        request(:post, uri, form: options)
+      end
+
+      private
+
+      def request(method, uri, **options)
+        HTTP::Client.new(HTTP_CLIENT_OPTS).request(method, uri, options)
+      rescue HTTP::ConnectionError,
+             HTTP::TimeoutError,
+             HTTP::Redirector::TooManyRedirectsError => exception
+        raise Webmention.const_get(exception.class.name.split('::').last), exception
+      end
+    end
+  end
+end

data/lib/webmention/parsers.rb

@@ -0,0 +1,29 @@
+module Webmention
+  module Parsers
+    extend Registerable
+
+    class BaseParser
+      def initialize(response)
+        raise ArgumentError, "response must be an HTTP::Response (given #{response.class.name})" unless response.is_a?(HTTP::Response)
+
+        @response = response
+
+        raise UnsupportedMimeTypeError, "Unsupported MIME Type: #{response.mime_type}" unless self.class.mime_types.include?(response.mime_type)
+      end
+
+      def results
+        @results ||= parse_response_body
+      end
+
+      private
+
+      def response_body
+        @response_body ||= @response.body.to_s
+      end
+
+      def response_url
+        @response_url ||= @response.uri.to_s
+      end
+    end
+  end
+end

data/lib/webmention/parsers/html_parser.rb

@@ -0,0 +1,73 @@
+module Webmention
+  module Parsers
+    class HtmlParser < BaseParser
+      def self.mime_types
+        ['text/html']
+      end
+
+      Parsers.register(self)
+
+      HTML_ATTRIBUTE_MAP = {
+        cite:   %w[blockquote del ins q],
+        data:   %w[object],
+        href:   %w[a area],
+        poster: %w[video],
+        src:    %w[audio embed img source track video],
+        srcset: %w[img source]
+      }.freeze
+
+      CSS_SELECTORS_MAP = HTML_ATTRIBUTE_MAP.each_with_object({}) do |(attribute, elements), hash|
+        hash[attribute] = elements.map { |element| "#{element}[#{attribute}]" }
+      end
+
+      private
+
+      def doc
+        @doc ||= Nokogiri::HTML(response_body)
+      end
+
+      # Parse an HTML string for URLs
+      #
+      # @return [Array] the URLs
+      def parse_response_body
+        CSS_SELECTORS_MAP
+          .each_with_object([]) { |(*args), array| array << search_node(*args) }
+          .flatten
+          .map { |url| Absolutely.to_abs(base: response_url, relative: url) }
+          .uniq
+      end
+
+      def root_node
+        @root_node ||= doc.css('.h-entry .e-content').first || doc.css('.h-entry').first || doc.css('body')
+      end
+
+      def search_node(attribute, selectors)
+        NodeParser.nodes_from(root_node, selectors).map { |node| NodeParser.values_from(node, attribute) }.reject(&:empty?)
+      end
+
+      module NodeParser
+        class << self
+          # Search a node for matching elements
+          #
+          # @param node [Nokogiri::XML::Element]
+          # @param selectors [Array]
+          # @return [Nokogiri::XML::NodeSet]
+          def nodes_from(node, selectors)
+            node.css(*selectors)
+          end
+
+          # Derive attribute values from a single node
+          #
+          # @param node [Nokogiri::XML::Element]
+          # @param attribute [Symbol]
+          # @return [Array] the HTML attribute values
+          def values_from(node, attribute)
+            return Array(node[attribute]) unless attribute == :srcset
+
+            node[attribute].split(',').map { |value| value.strip.match(/^\S+/).to_s }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/webmention/registerable.rb

@@ -0,0 +1,11 @@
+module Webmention
+  module Registerable
+    def register(klass)
+      klass.mime_types.each { |mime_type| registered[mime_type] = klass }
+    end
+
+    def registered
+      @registered ||= {}
+    end
+  end
+end

data/lib/webmention/version.rb

@@ -1,3 +1,3 @@
 module Webmention
-  VERSION = "0.1.6"
+  VERSION = '1.0.0'.freeze
 end

data/webmention.gemspec

@@ -1,34 +1,43 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'webmention/version'
 
-Gem::Specification.new do |s|
-  s.name          = 'webmention'
-  s.version       = Webmention::VERSION
-  s.date          = '2017-06-27'
-  s.homepage      = 'https://github.com/indieweb/mention-client-ruby'
-  s.summary       = 'A gem for sending webmention (and pingback) notifications'
-  s.authors       = [
-    'Aaron Parecki',
-    'Nat Welch'
-  ]
-
-  s.email         = 'aaron@parecki.com'
-
-  s.files         = `git ls-files`.split($/)
-  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths = ['lib']
-
-  s.required_ruby_version = '>= 1.9.3'
-
-  s.add_dependency 'json'
-  s.add_dependency 'nokogiri'
-  s.add_dependency 'httparty', '~> 0.15.5'
-  s.add_dependency 'link_header', '~> 0.0.8'
-
-  s.add_development_dependency 'bundler'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'minitest'
-  s.add_development_dependency 'webmock'
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = ['>= 2.4', '< 2.7']
+
+  spec.name          = 'webmention'
+  spec.version       = Webmention::VERSION
+  spec.authors       = ['Aaron Parecki', 'Nat Welch']
+  spec.email         = ['aaron@parecki.com']
+
+  spec.summary       = 'Webmention notification client'
+  spec.description   = 'A Ruby gem for sending webmention notifications.'
+  spec.homepage      = 'https://github.com/indieweb/webmention-client-ruby'
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|test)/}) }
+
+  spec.require_paths = ['lib']
+
+  spec.metadata = {
+    'bug_tracker_uri' => "#{spec.homepage}/issues",
+    'changelog_uri'   => "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md"
+  }
+
+  spec.add_development_dependency 'minitest', '~> 5.11'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'reek', '~> 5.4'
+  spec.add_development_dependency 'rubocop', '~> 0.72.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.4'
+  spec.add_development_dependency 'simplecov', '~> 0.17.0'
+  spec.add_development_dependency 'simplecov-console', '~> 0.5.0'
+  spec.add_development_dependency 'webmock', '~> 3.6'
+
+  spec.add_runtime_dependency 'absolutely', '~> 3.0'
+  spec.add_runtime_dependency 'addressable', '~> 2.6'
+  spec.add_runtime_dependency 'http', '~> 5.0.0.pre'
+  spec.add_runtime_dependency 'indieweb-endpoints', '~> 0.6.0'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.10'
 end