webmention-endpoint 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a0d9fe079ebac42183737b07e6acfb57da0de38
-  data.tar.gz: cec22f15a30267aa4a8307e7a7cc991f26583fef
+  metadata.gz: f128c7d8a768bf568687aada16dbe1e9a16cccd8
+  data.tar.gz: d0098d15f6ff9f5602ff4942101faf3770c536ee
 SHA512:
-  metadata.gz: 80ddae4dc30607dbe1e7e8395888292cedb119fa3cb69280828ece69026e7fe6845c96eb0faf4d7539cb0b8343205a4d3ad8c88ed5c878ca1111711efaaef694
-  data.tar.gz: 6d18ff662c5d850d52fc2e03799d2ae52ccdffef8ef1eb031bd99390e5a55c233b322c48ac33bc674ae8ece51651003859f15dd984e4ebb2f94d4226b722cc71
+  metadata.gz: 50b40491e45e6c71198ff81c4b57acbb89e8338c1aee7d474b91c8dddfed996e6d060ad32db5c860c4f7e46abd740ad82cec3ee476456158fbcf47154bdb69c3
+  data.tar.gz: 0c283b3de0f2f72d0092214b2e9da15c566581209c208fb9fe6ae55c81dde5772336383fc5ebf9d83b7256dca1dbfd0f0969bf4e8a4475ec1b7450c8aa17677b

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 2.0.0 / 2018-08-18
+
+- Renames `Webmention::Endpoint::Response` class to `Webmention::Endpoint::Request` ([db485f3](https://github.com/jgarber623/webmention-endpoint-ruby/commit/db485f3)).
+- Removes `Webmention::Endpoint::Discover` class and moves its functionality to `Webmention::Endpoint::Client` ([a9ff0a9](https://github.com/jgarber623/webmention-endpoint-ruby/commit/a9ff0a9)).
+
 ## 1.0.1 / 2018-07-29
 
 - Raise an `ArgumentError` when `Client` instantiated with non-absolute URI ([64f161e](https://github.com/jgarber623/webmention-endpoint-ruby/commit/64f161e)).

data/lib/webmention/endpoint.rb

@@ -6,8 +6,7 @@ require 'nokogiri'
 require 'webmention/endpoint/version'
 require 'webmention/endpoint/error'
 require 'webmention/endpoint/client'
-require 'webmention/endpoint/discover'
-require 'webmention/endpoint/response'
+require 'webmention/endpoint/request'
 
 module Webmention
   module Endpoint

data/lib/webmention/endpoint/client.rb

@@ -1,6 +1,18 @@
 module Webmention
   module Endpoint
     class Client
+      # 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
+
+      # Liberal pattern matching a string of text between angle brackets
+      # https://tools.ietf.org/html/rfc5988#section-5.1
+      REGEXP_TARGET_URI_PATTERN = /^<(.*)>;/
+
+      # Ultra-orthodox pattern matching Link header `rel` parameter including a `webmention` value
+      # https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint-p-1
+      REGEXP_WEBMENTION_REL_PATTERN = /(?:;|\s)rel="?(?:#{REGEXP_REG_REL_TYPE_PATTERN}+\s)?webmention(?:\s#{REGEXP_REG_REL_TYPE_PATTERN})?"?/
+
       def initialize(url)
         raise ArgumentError, "url must be a String (given #{url.class.name})" unless url.is_a?(String)
 
@@ -12,11 +24,50 @@ module Webmention
       end
 
       def endpoint
-        @endpoint ||= Discover.new(response).endpoint
+        return unless endpoint_from_http_request
+
+        @endpoint ||= Absolutely.to_absolute_uri(base: response.uri.to_s, relative: endpoint_from_http_request)
+      rescue Absolutely::InvalidURIError => error
+        raise InvalidURIError, error
       end
 
       def response
-        @response ||= Response.new(@uri).response
+        @response ||= Request.new(@uri).response
+      end
+
+      private
+
+      def endpoint_from_body
+        return unless response.mime_type == 'text/html'
+
+        doc = Nokogiri::HTML(response.body.to_s)
+
+        # Search response body for first `a` or `link` element with valid `rel` and `href` attributes
+        link_element = doc.css('[rel~="webmention"][href]').select { |element| %w[a link].include?(element.name) }.shift
+
+        return link_element['href'] if link_element
+      end
+
+      def endpoint_from_headers
+        link_headers = response.headers.get('link')
+
+        return unless link_headers
+
+        # Split Link headers with multiple values, flatten the resulting array, and strip whitespace
+        # https://webmention.rocks/test/19
+        link_headers = link_headers.map { |header| header.split(',') }.flatten.map(&:strip)
+
+        webmention_header = link_headers.find { |header| header.match?(REGEXP_WEBMENTION_REL_PATTERN) }
+
+        return unless webmention_header
+
+        endpoint_match_data = webmention_header.match(REGEXP_TARGET_URI_PATTERN)
+
+        return endpoint_match_data[1] if endpoint_match_data
+      end
+
+      def endpoint_from_http_request
+        @endpoint_from_http_request ||= endpoint_from_headers || endpoint_from_body || nil
       end
     end
   end

data/lib/webmention/endpoint/{response.rb → request.rb}

@@ -1,6 +1,6 @@
 module Webmention
   module Endpoint
-    class Response
+    class Request
       HTTP_HEADERS_OPTS = {
         accept: '*/*',
         user_agent: 'Webmention Endpoint Discovery (https://rubygems.org/gems/webmention-endpoint)'

data/lib/webmention/endpoint/version.rb

@@ -1,5 +1,5 @@
 module Webmention
   module Endpoint
-    VERSION = '1.0.1'.freeze
+    VERSION = '2.0.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webmention-endpoint
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-29 00:00:00.000000000 Z
+date: 2018-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -211,9 +211,8 @@ files:
 - Rakefile
 - lib/webmention/endpoint.rb
 - lib/webmention/endpoint/client.rb
-- lib/webmention/endpoint/discover.rb
 - lib/webmention/endpoint/error.rb
-- lib/webmention/endpoint/response.rb
+- lib/webmention/endpoint/request.rb
 - lib/webmention/endpoint/version.rb
 - webmention-endpoint.gemspec
 homepage: https://github.com/jgarber623/webmention-endpoint-ruby

data/lib/webmention/endpoint/discover.rb

@@ -1,66 +0,0 @@
-module Webmention
-  module Endpoint
-    class Discover
-      # 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
-
-      # Liberal pattern matching a string of text between angle brackets
-      # https://tools.ietf.org/html/rfc5988#section-5.1
-      REGEXP_TARGET_URI_PATTERN = /^<(.*)>;/
-
-      # Ultra-orthodox pattern matching Link header `rel` parameter including a `webmention` value
-      # https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint-p-1
-      REGEXP_WEBMENTION_REL_PATTERN = /(?:;|\s)rel="?(?:#{REGEXP_REG_REL_TYPE_PATTERN}+\s)?webmention(?:\s#{REGEXP_REG_REL_TYPE_PATTERN})?"?/
-
-      def initialize(response)
-        raise ArgumentError, "response must be an HTTP::Response (given #{response.class.name})" unless response.is_a?(HTTP::Response)
-
-        @response = response
-      end
-
-      def endpoint
-        return unless endpoint_from_http_request
-
-        @endpoint ||= Absolutely.to_absolute_uri(base: @response.uri.to_s, relative: endpoint_from_http_request)
-      rescue Absolutely::InvalidURIError => error
-        raise InvalidURIError, error
-      end
-
-      private
-
-      def endpoint_from_body
-        return unless @response.mime_type == 'text/html'
-
-        doc = Nokogiri::HTML(@response.body.to_s)
-
-        # Search response body for first `a` or `link` element with valid `rel` and `href` attributes
-        link_element = doc.css('[rel~="webmention"][href]').select { |element| %w[a link].include?(element.name) }.shift
-
-        return link_element['href'] if link_element
-      end
-
-      def endpoint_from_headers
-        link_headers = @response.headers.get('link')
-
-        return unless link_headers
-
-        # Split Link headers with multiple values, flatten the resulting array, and strip whitespace
-        # https://webmention.rocks/test/19
-        link_headers = link_headers.map { |header| header.split(',') }.flatten.map(&:strip)
-
-        webmention_header = link_headers.find { |header| header.match?(REGEXP_WEBMENTION_REL_PATTERN) }
-
-        return unless webmention_header
-
-        endpoint_match_data = webmention_header.match(REGEXP_TARGET_URI_PATTERN)
-
-        return endpoint_match_data[1] if endpoint_match_data
-      end
-
-      def endpoint_from_http_request
-        @endpoint_from_http_request ||= endpoint_from_headers || endpoint_from_body || nil
-      end
-    end
-  end
-end