indieweb-endpoints 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cb1b27367683210b63651d8195e6d12013f994be97d8c216b2e2165429c4adb
-  data.tar.gz: 587e29ea23c02d6de575cefbc6a5f9a808c5e6b47bf662ee138ceaadba03c57f
+  metadata.gz: ab63e805300751b251c129c817104bbc47b4fb8d90d758b1310734a7f9591dcf
+  data.tar.gz: 45431916ee155fc23df530dae6ebf51298675a6f065ab1163391a482612b9a40
 SHA512:
-  metadata.gz: 1ca06c752aa3ff624d1ab3dbcad733d69bd5ab701ccdac754e7f5bc4e4d7c70ee8b42b23dd911448fb85fab44264e2e7f3c9c136cb23f5b4aaad282a21555ec7
-  data.tar.gz: adbb98ffc16e4664d8ea47a94bdfb32b5fbd552155716a1928bf3b62fbdd4bc545768d00ce046101db454b8a71752acdb14330c99e57c1597eca73b8b0e71b93
+  metadata.gz: 2fc61c949330b86b0b8eaf784de934be79ec1cd85b700fb6b1e44bb4e27f877fe2bea99be0c444ae4fd9fe5793cae7218d035f8e5a0ee3ffe5abacdee86f0393
+  data.tar.gz: a0e56ed6e7be2bc619a2fb68d62e8898ebf62a45710b96bf78c1c32079d7ffe57c16c5066071b427c91418def99af5667f3ecd6327b5ff6712da60f945ab4531

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.6.0 / 2019-06-15
+
+- Updates Parser-related classes to resolve [#2](https://github.com/indieweb/indieweb-endpoints-ruby/issues/2).
+
 ## 0.5.0 / 2019-05-09
 
 - Add support for Microsub endpoint discovery ([5e81d9f](https://github.com/indieweb/indieweb-endpoints-ruby/commit/5e81d9f)).

data/indieweb-endpoints.gemspec

@@ -28,15 +28,16 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'reek', '~> 5.4'
   spec.add_development_dependency 'rspec', '~> 3.8'
-  spec.add_development_dependency 'rubocop', '~> 0.68.1'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.1'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.32'
+  spec.add_development_dependency 'rubocop', '~> 0.71.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.3'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.33'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'
-  spec.add_development_dependency 'simplecov-console', '~> 0.4.2'
-  spec.add_development_dependency 'webmock', '~> 3.5'
+  spec.add_development_dependency 'simplecov-console', '~> 0.5.0'
+  spec.add_development_dependency 'webmock', '~> 3.6'
 
-  spec.add_runtime_dependency 'absolutely', '~> 2.1'
+  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 'link-header-parser', '~> 0.1.0'
   spec.add_runtime_dependency 'nokogiri', '~> 1.10'
 end

data/lib/indieweb/endpoints/parsers/redirect_uri_parser.rb

@@ -29,22 +29,18 @@ module IndieWeb
         def results_from_http_request
           @results_from_http_request ||= [results_from_headers, results_from_body].flatten.compact
         end
-      end
 
-      class RedirectUriLinkElementParser < LinkElementParser
-        def results
-          link_elements.map { |element| element['href'] } if response_is_html && link_elements.any?
+        class RedirectUriLinkElementParser < BaseLinkElementParser
+          def results
+            link_elements.map { |element| element['href'] } if response_is_html && link_elements.any?
+          end
         end
-      end
-
-      class RedirectUriLinkHeaderParser < LinkHeaderParser
-        def results
-          return unless link_headers.any?
 
-          link_headers.map do |header|
-            endpoint_match_data = header.match(REGEXP_TARGET_URI_PATTERN)
+        class RedirectUriLinkHeaderParser < BaseLinkHeaderParser
+          def results
+            return unless link_headers
 
-            endpoint_match_data[1] if endpoint_match_data
+            link_headers.map(&:target_uri)
           end
         end
       end

data/lib/indieweb/endpoints/parsers/webmention_parser.rb

@@ -13,19 +13,19 @@ module IndieWeb
         def results_from_body
           WebmentionLinkElementParser.new(response, self.class.identifier).results
         end
-      end
 
-      class WebmentionLinkElementParser < LinkElementParser
-        private
+        class WebmentionLinkElementParser < BaseLinkElementParser
+          private
 
-        def link_element
-          # Return first `a` or `link` element with valid `rel` attribute
-          # https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint
-          @link_element ||= link_elements.find { |element| %w[a link].include?(element.name) }
-        end
+          def link_element
+            # Return first `a` or `link` element with valid `rel` attribute
+            # https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint
+            @link_element ||= link_elements.find { |element| %w[a link].include?(element.name) }
+          end
 
-        def link_elements_css_selector
-          @link_elements_css_selector ||= %([rel~="#{identifier}"][href]:not([href*="#"]))
+          def link_elements_css_selector
+            @link_elements_css_selector ||= %([rel~="#{identifier}"][href]:not([href*="#"]))
+          end
         end
       end
     end

data/lib/indieweb/endpoints/parsers.rb

@@ -23,101 +23,83 @@ module IndieWeb
         private
 
         def results_from_body
-          LinkElementParser.new(response, self.class.identifier).results
+          BaseLinkElementParser.new(response, self.class.identifier).results
         end
 
         def results_from_headers
-          LinkHeaderParser.new(response, self.class.identifier).results
+          BaseLinkHeaderParser.new(response, self.class.identifier).results
         end
 
         def results_from_http_request
           @results_from_http_request ||= results_from_headers || results_from_body || nil
         end
-      end
 
-      class LinkElementParser
-        attr_reader :identifier, :response
+        class BaseLinkElementParser
+          attr_reader :identifier, :response
 
-        def initialize(response, identifier)
-          @response = response
-          @identifier = identifier
-        end
+          def initialize(response, identifier)
+            @response = response
+            @identifier = identifier
+          end
 
-        def results
-          link_element['href'] if response_is_html && link_element
-        end
+          def results
+            link_element['href'] if response_is_html && link_element
+          end
 
-        private
+          private
 
-        def doc
-          @doc ||= Nokogiri::HTML(response.body.to_s)
-        end
+          def doc
+            @doc ||= Nokogiri::HTML(response.body.to_s)
+          end
 
-        def link_element
-          # Return first `link` element with valid `rel` attribute
-          # https://www.w3.org/TR/indieauth/#discovery-1
-          # https://www.w3.org/TR/micropub/#endpoint-discovery
-          @link_element ||= link_elements.shift
-        end
+          def link_element
+            # Return first `link` element with valid `rel` attribute
+            # https://www.w3.org/TR/indieauth/#discovery-1
+            # https://www.w3.org/TR/micropub/#endpoint-discovery
+            @link_element ||= link_elements.shift
+          end
 
-        def link_elements
-          @link_elements ||= doc.css(link_elements_css_selector)
-        end
+          def link_elements
+            @link_elements ||= doc.css(link_elements_css_selector)
+          end
 
-        def link_elements_css_selector
-          @link_elements_css_selector ||= %(link[rel~="#{identifier}"][href]:not([href*="#"]))
-        end
+          def link_elements_css_selector
+            @link_elements_css_selector ||= %(link[rel~="#{identifier}"][href]:not([href*="#"]))
+          end
 
-        def response_is_html
-          @response_is_html ||= response.mime_type == 'text/html'
+          def response_is_html
+            @response_is_html ||= response.mime_type == 'text/html'
+          end
         end
-      end
 
-      class LinkHeaderParser
-        # Ultra-orthodox pattern matching allowed values in Link header `rel` parameter
-        # https://tools.ietf.org/html/rfc8288#section-3.3
-        REGEXP_REG_REL_TYPE_PATTERN = '[a-z\d][a-z\d\-\.]*'.freeze
+        class BaseLinkHeaderParser
+          attr_reader :identifier, :response
 
-        # Liberal pattern capturing a string of text (excepting the octothorp) between angle brackets
-        # https://tools.ietf.org/html/rfc5988#section-5.1
-        REGEXP_TARGET_URI_PATTERN = '^<(.[^#]*)>;'.freeze
+          def initialize(response, identifier)
+            @response = response
+            @identifier = identifier
+          end
 
-        attr_reader :identifier, :response
+          def results
+            return unless link_headers
 
-        def initialize(response, identifier)
-          @response = response
-          @identifier = identifier
-        end
-
-        def results
-          return unless link_header
+            link_headers.shift.target_uri
+          end
 
-          endpoint_match_data = link_header.match(/#{REGEXP_TARGET_URI_PATTERN}/)
+          private
 
-          return endpoint_match_data[1] if endpoint_match_data
-        end
-
-        private
+          def link_headers
+            @link_headers ||= begin
+              return unless parsed_link_headers
 
-        def discrete_link_headers
-          # Split Link headers with multiple values, flatten the resulting array, and strip whitespace
-          # https://webmention.rocks/test/19
-          @discrete_link_headers ||= response.headers.get('link').map { |header| header.split(',') }.flatten.map(&:strip)
-        end
-
-        def link_header
-          @link_header ||= link_headers.shift
-        end
-
-        def link_headers
-          # Reduce Link headers to those with valid `rel` attribute
-          @link_headers ||= discrete_link_headers.find_all { |header| header.match?(/#{REGEXP_TARGET_URI_PATTERN}\s*#{regexp_rel_paramater_pattern}/) }
-        end
+              # Reject endpoints that contain a fragment identifier
+              parsed_link_headers.reject { |parsed_link_header| Addressable::URI.parse(parsed_link_header.target_uri).fragment }
+            end
+          end
 
-        def regexp_rel_paramater_pattern
-          # Ultra-orthodox pattern matching Link header `rel` parameter including a matching identifier value
-          # https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint
-          @regexp_rel_paramater_pattern ||= %(rel="?(?:#{REGEXP_REG_REL_TYPE_PATTERN}+\s)?#{identifier}(?:\s#{REGEXP_REG_REL_TYPE_PATTERN})?"?)
+          def parsed_link_headers
+            @parsed_link_headers ||= LinkHeaderParser.parse(response.headers.get('link'), base: response.uri.to_s).by_relation_type[identifier]
+          end
         end
       end
     end

data/lib/indieweb/endpoints/version.rb

@@ -1,5 +1,5 @@
 module IndieWeb
   module Endpoints
-    VERSION = '0.5.0'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

data/lib/indieweb/endpoints.rb

@@ -1,6 +1,9 @@
+require 'ostruct'
+
 require 'absolutely'
 require 'addressable/uri'
 require 'http'
+require 'link-header-parser'
 require 'nokogiri'
 
 require 'indieweb/endpoints/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: indieweb-endpoints
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-10 00:00:00.000000000 Z
+date: 2019-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -58,42 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.68.1
+        version: 0.71.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.68.1
+        version: 0.71.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.32'
+        version: '1.33'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.32'
+        version: '1.33'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -114,42 +114,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: absolutely
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.0.0.pre
+- !ruby/object:Gem::Dependency
+  name: link-header-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -235,7 +249,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/indieweb/indieweb-endpoints-ruby/issues
-  changelog_uri: https://github.com/indieweb/indieweb-endpoints-ruby/blob/v0.5.0/CHANGELOG.md
+  changelog_uri: https://github.com/indieweb/indieweb-endpoints-ruby/blob/v0.6.0/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: