webmention 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b40b0711592d5a14c2d9dc53b638e697ce1278ed3d3a851e559d6eb51752c7d4
-  data.tar.gz: 8a5a3f9508a6f071cdcdb7fe5126909678538b20c1bf043110e0e06ea56e75d1
+  metadata.gz: 2939ada02eb29818ba6b84da3c64e7ce9f363cddc0299ddb423c60343fc202fc
+  data.tar.gz: 40e715d3602cebc2ef45261141b3cbf06de12661918ba746723e1785d689095e
 SHA512:
-  metadata.gz: 8eb087999adce5389f37333598e1edaee18e96e748b9b11eee41f5bbb1ecc6cb511e0951eeba831df62d210972e296d0d5090adf6e25a3666eb182b503454d7e
-  data.tar.gz: ccb4e243d5c050d6e912a47a4a1fa0ee02594211192e81737011db1ded8a88eac4bfd11f32749ffba7dea1b08a50d326ed446d0688bb1ce406095bbbc1f57a58
+  metadata.gz: c16e1234ec404e226d0c6f50362f0c53286416a2155094b372055f0f57e39d7ac8502d937ff101a835d7dcfe9be9fcd4716274af0acc521b7a7896dffa78753a
+  data.tar.gz: 620ed9d6bc592f1fe9174da42bc330592d459760e07e82a4b8f2b6361a3d377ab5c575d1de3a782c099e76b9c4b06ddaf65b2f08b8185897df91d963ed9bfb2a

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 2.1.0 / 2020-04-06
+
+- Refactor `BaseParser` class and remove `Registerable` module (b706229)
+- Refactor `HttpRequest` and `NodeParser` classes into Service Objects (f29c073 and 7456bf1)
+
 ## 2.0.0 / 2020-01-25
 
 - Add Ruby 2.7 to list of supported Ruby versions (c67ed14)

data/lib/webmention.rb

@@ -8,12 +8,14 @@ require 'webmention/version'
 require 'webmention/exceptions'
 
 require 'webmention/client'
-require 'webmention/http_request'
-require 'webmention/registerable'
 
 require 'webmention/parsers'
+require 'webmention/parsers/base_parser'
 require 'webmention/parsers/html_parser'
 
+require 'webmention/services/http_request_service'
+require 'webmention/services/node_parser_service'
+
 module Webmention
   class << self
     def client(source)

data/lib/webmention/client.rb

@@ -23,7 +23,7 @@ module Webmention
 
       return unless endpoint
 
-      HttpRequest.post(Addressable::URI.parse(endpoint), source: @source, target: target)
+      Services::HttpRequestService.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
@@ -35,7 +35,7 @@ module Webmention
     end
 
     def source_response
-      @source_response ||= HttpRequest.get(source_uri)
+      @source_response ||= Services::HttpRequestService.get(source_uri)
     end
 
     def source_uri

data/lib/webmention/parsers.rb

@@ -1,29 +1,11 @@
 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 self.register(klass)
+      klass.mime_types.each { |mime_type| registered[mime_type] = klass }
+    end
 
-      def response_url
-        @response_url ||= @response.uri.to_s
-      end
+    def self.registered
+      @registered ||= {}
     end
   end
 end

data/lib/webmention/parsers/base_parser.rb

@@ -0,0 +1,31 @@
+module Webmention
+  module Parsers
+    class BaseParser
+      class << self
+        attr_reader :mime_types
+      end
+
+      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

@@ -1,9 +1,7 @@
 module Webmention
   module Parsers
     class HtmlParser < BaseParser
-      def self.mime_types
-        ['text/html']
-      end
+      @mime_types = ['text/html']
 
       Parsers.register(self)
 
@@ -38,35 +36,11 @@ module Webmention
       end
 
       def root_node
-        @root_node ||= doc.css('.h-entry .e-content').first || doc.css('.h-entry').first || doc.css('body')
+        @root_node ||= doc.at_css('.h-entry .e-content') || doc.at_css('.h-entry') || 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
+        Services::NodeParserService.nodes_from(root_node, selectors).map { |node| Services::NodeParserService.values_from(node, attribute) }.reject(&:empty?)
       end
     end
   end

data/lib/webmention/services/http_request_service.rb

@@ -0,0 +1,47 @@
+module Webmention
+  module Services
+    module HttpRequestService
+      # Defaults derived from Webmention specification examples
+      # https://www.w3.org/TR/webmention/#limits-on-get-requests
+      # rubocop:disable Layout/HashAlignment
+      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/HashAlignment
+
+      class << self
+        def get(uri)
+          request(:get, uri)
+        end
+
+        def post(uri, **options)
+          request(:post, uri, form: options)
+        end
+
+        private
+
+        def client
+          @client ||= HTTP::Client.new(HTTP_CLIENT_OPTS)
+        end
+
+        def request(method, uri, **options)
+          client.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
+end

data/lib/webmention/services/node_parser_service.rb

@@ -0,0 +1,25 @@
+module Webmention
+  module Services
+    module NodeParserService
+      # Search a node for matching elements
+      #
+      # @param node [Nokogiri::XML::Element]
+      # @param selectors [Array]
+      # @return [Nokogiri::XML::NodeSet]
+      def self.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 self.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

data/lib/webmention/version.rb

@@ -1,3 +1,3 @@
 module Webmention
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.1.0'.freeze
 end

data/webmention.gemspec

@@ -28,16 +28,16 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.14'
   spec.add_development_dependency 'minitest-reporters', '~> 1.4'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'reek', '~> 5.6'
-  spec.add_development_dependency 'rubocop', '~> 0.79.0'
+  spec.add_development_dependency 'reek', '~> 6.0'
+  spec.add_development_dependency 'rubocop', '~> 0.81.0'
   spec.add_development_dependency 'rubocop-performance', '~> 1.5'
-  spec.add_development_dependency 'simplecov', '~> 0.17.1'
-  spec.add_development_dependency 'simplecov-console', '~> 0.6.0'
+  spec.add_development_dependency 'simplecov', '~> 0.18.5'
+  spec.add_development_dependency 'simplecov-console', '~> 0.7.2'
   spec.add_development_dependency 'webmock', '~> 3.8'
 
   spec.add_runtime_dependency 'absolutely', '~> 3.1'
   spec.add_runtime_dependency 'addressable', '~> 2.7'
-  spec.add_runtime_dependency 'http', '~> 4.3'
+  spec.add_runtime_dependency 'http', '~> 4.4'
   spec.add_runtime_dependency 'indieweb-endpoints', '~> 2.0'
   spec.add_runtime_dependency 'nokogiri', '~> 1.10'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webmention
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Aaron Parecki
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-25 00:00:00.000000000 Z
+date: 2020-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -59,28 +59,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.6'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.6'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 0.81.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 0.81.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -101,28 +101,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.18.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.18.5
 - !ruby/object:Gem::Dependency
   name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -171,14 +171,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.4'
 - !ruby/object:Gem::Dependency
   name: indieweb-endpoints
   requirement: !ruby/object:Gem::Requirement
@@ -231,10 +231,11 @@ files:
 - lib/webmention.rb
 - lib/webmention/client.rb
 - lib/webmention/exceptions.rb
-- lib/webmention/http_request.rb
 - lib/webmention/parsers.rb
+- lib/webmention/parsers/base_parser.rb
 - lib/webmention/parsers/html_parser.rb
-- lib/webmention/registerable.rb
+- lib/webmention/services/http_request_service.rb
+- lib/webmention/services/node_parser_service.rb
 - lib/webmention/version.rb
 - webmention.gemspec
 homepage: https://github.com/indieweb/webmention-client-ruby
@@ -242,7 +243,7 @@ licenses:
 - Apache-2.0
 metadata:
   bug_tracker_uri: https://github.com/indieweb/webmention-client-ruby/issues
-  changelog_uri: https://github.com/indieweb/webmention-client-ruby/blob/v2.0.0/CHANGELOG.md
+  changelog_uri: https://github.com/indieweb/webmention-client-ruby/blob/v2.1.0/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -261,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Webmention notification client

data/lib/webmention/http_request.rb

@@ -1,41 +0,0 @@
-module Webmention
-  class HttpRequest
-    # Defaults derived from Webmention specification examples
-    # https://www.w3.org/TR/webmention/#limits-on-get-requests
-    # rubocop:disable Layout/HashAlignment
-    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/HashAlignment
-
-    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/registerable.rb

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