webmention-endpoint 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44d656cb6bdecf2ed67ff6dc978c1ff93735c706
-  data.tar.gz: 2bce5bbb6e3c2b0ba283749c2c59c7c12ba09a1d
+  metadata.gz: 0d245a49f0a3fe53fdee075040a00815e6165d6c
+  data.tar.gz: '09cde84455b4cc0652c4f02f7f76ba2c1e50092f'
 SHA512:
-  metadata.gz: a7f7773495fa464aae5b582acd008d327815089ec5d3815ce58a0dece1c2790ce468f18c2c31340a55cf237cd628de2085bdc895bb00920c92bca2289df980b2
-  data.tar.gz: f24d832906bf72d03de05c0182da820bcece136ae08c44aeb576a66f74bd033e6a789fbd3053a70938ec3809c5bd9331c4f67241e1ce857f497bd7b27c404e8b
+  metadata.gz: 91b061d760180be8fda3aa7ce5a879309d63ce1c71131ac7f4affc88b2b9956d6f8f9d3f73e857d97f5182a30f84ce179fa878eb84a3187c07e94f911b6b7610
+  data.tar.gz: ed7b10de7d833d3178e6d9e4b08e65b5b40dd3f7195e87e0a046b627ae1d94b1c5a96924906938e9169a24a12e7f50eb87a9bd2dfe1358f6944862ee7a7431df

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.0.0 / 2018-07-17
+
+- Adds new `Webmention::Endpoint::Client` and `Webmention::Endpoint::Response` classes and refactors `Webmention::Endpoint::Discover` API ([a05d041](https://github.com/jgarber623/webmention-endpoint-ruby/commit/a05d041)).
+- Updates specs ([706f39b](https://github.com/jgarber623/webmention-endpoint-ruby/commit/706f39b)) and documentation ([7110b8c](https://github.com/jgarber623/webmention-endpoint-ruby/commit/7110b8c)).
+
 ## 0.3.1 / 2018-07-05
 
 - Updates [Absolutely](https://github.com/jgarber623/absolutely) to v1.1.0 ([4a62800](https://github.com/jgarber623/webmention-endpoint-ruby/commit/4a62800)).

data/README.md

@@ -11,7 +11,7 @@
 
 ## Key Features
 
-- Compliant with [Section 3.1.2](https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint) of [the W3C's Webmention specification](https://www.w3.org/TR/webmention/).
+- Compliant with [Section 3.1.2](https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint) of [the W3C's Webmention Recommendation](https://www.w3.org/TR/webmention/).
 - Passes all Endpoint Discovery tests on [webmention.rocks](https://webmention.rocks).
 - Supports Ruby 2.4 and newer.
 
@@ -51,7 +51,7 @@ endpoint = Webmention::Endpoint.discover('https://webmention.rocks/test/1')
 puts endpoint # returns String: 'https://webmention.rocks/test/1/webmention'
 ```
 
-This example will search `https://webmention.rocks/test/1` for a valid Webmention endpoint in accordance with the rules described in [the W3C's Webmention specification](https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint). In this case, the program returns a string: `https://webmention.rocks/test/1/webmention`.
+This example will search `https://webmention.rocks/test/1` for a valid Webmention endpoint in accordance with the rules described in [the W3C's Webmention Recommendation](https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint). In this case, the program returns a string: `https://webmention.rocks/test/1/webmention`.
 
 If no endpoint is discovered at the provided URL, the program will return `nil`:
 
@@ -65,18 +65,15 @@ puts endpoint.nil? # returns Boolean: true
 
 ### Advanced Usage
 
-Should the need arise, you may work directly with the `Webmention::Endpoint::Discover` class:
+Should the need arise, you may work directly with the `Webmention::Endpoint::Client` class:
 
 ```ruby
 require 'webmention/endpoint'
 
-discoverer = Webmention::Endpoint::Discover.new('https://webmention.rocks/test/1')
+client = Webmention::Endpoint::Client.new('https://webmention.rocks/test/1')
 
-puts discoverer.url      # returns String: 'https://webmention.rocks/test/1'
-puts discoverer.endpoint # returns String: 'https://webmention.rocks/test/1/webmention'
-
-puts discoverer.uri      # returns Addressable::URI
-puts discoverer.response # returns HTTP::Response
+puts client.response # returns HTTP::Response
+puts client.endpoint # returns String: 'https://webmention.rocks/test/1/webmention'
 ```
 
 ### Exception Handling

data/lib/webmention/endpoint.rb

@@ -5,12 +5,14 @@ require 'nokogiri'
 
 require 'webmention/endpoint/version'
 require 'webmention/endpoint/error'
+require 'webmention/endpoint/client'
 require 'webmention/endpoint/discover'
+require 'webmention/endpoint/response'
 
 module Webmention
   module Endpoint
     def self.discover(url)
-      Discover.new(url).endpoint
+      Client.new(url).endpoint
     end
   end
 end

data/lib/webmention/endpoint/client.rb

@@ -0,0 +1,21 @@
+module Webmention
+  module Endpoint
+    class Client
+      def initialize(url)
+        raise ArgumentError, "url must be a String (given #{url.class.name})" unless url.is_a?(String)
+
+        @uri = Addressable::URI.parse(url)
+      rescue Addressable::URI::InvalidURIError => error
+        raise InvalidURIError, error
+      end
+
+      def endpoint
+        @endpoint ||= Discover.new(response).endpoint
+      end
+
+      def response
+        @response ||= Response.new(@uri).response
+      end
+    end
+  end
+end

data/lib/webmention/endpoint/discover.rb

@@ -1,11 +1,6 @@
 module Webmention
   module Endpoint
     class Discover
-      HTTP_HEADERS_OPTS = {
-        accept: '*/*',
-        user_agent: 'Webmention Endpoint Discovery (https://rubygems.org/gems/webmention-endpoint)'
-      }.freeze
-
       # 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
@@ -18,44 +13,26 @@ module Webmention
       # 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})?"?/
 
-      attr_reader :uri, :url
-
-      def initialize(url)
-        raise ArgumentError, "url must be a String (given #{url.class.name})" unless url.is_a?(String)
+      def initialize(response)
+        raise ArgumentError, "response must be an HTTP::Response (given #{response.class.name})" unless response.is_a?(HTTP::Response)
 
-        @url = url
-        @uri = Addressable::URI.parse(url)
-      rescue Addressable::URI::InvalidURIError => error
-        raise InvalidURIError, error
+        @response = response
       end
 
       def endpoint
         return unless endpoint_from_http_request
 
-        @endpoint ||= Absolutely.to_absolute_uri(base: url, relative: 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 ||= HTTP.follow.headers(HTTP_HEADERS_OPTS).timeout(
-          connect: 10,
-          read: 10
-        ).get(uri)
-      rescue HTTP::ConnectionError => error
-        raise ConnectionError, error
-      rescue HTTP::TimeoutError => error
-        raise TimeoutError, error
-      rescue HTTP::Redirector::TooManyRedirectsError => error
-        raise TooManyRedirectsError, error
-      end
-
       private
 
       def endpoint_from_body
-        return unless response.mime_type == 'text/html'
+        return unless @response.mime_type == 'text/html'
 
-        doc = Nokogiri::HTML(response.body.to_s)
+        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
@@ -64,7 +41,7 @@ module Webmention
       end
 
       def endpoint_from_headers
-        link_headers = response.headers.get('link')
+        link_headers = @response.headers.get('link')
 
         return unless link_headers
 

data/lib/webmention/endpoint/response.rb

@@ -0,0 +1,29 @@
+module Webmention
+  module Endpoint
+    class Response
+      HTTP_HEADERS_OPTS = {
+        accept: '*/*',
+        user_agent: 'Webmention Endpoint Discovery (https://rubygems.org/gems/webmention-endpoint)'
+      }.freeze
+
+      def initialize(uri)
+        raise ArgumentError, "uri must be an Addressable::URI (given #{uri.class.name})" unless uri.is_a?(Addressable::URI)
+
+        @uri = uri
+      end
+
+      def response
+        @response ||= HTTP.follow.headers(HTTP_HEADERS_OPTS).timeout(
+          connect: 10,
+          read: 10
+        ).get(@uri)
+      rescue HTTP::ConnectionError => error
+        raise ConnectionError, error
+      rescue HTTP::TimeoutError => error
+        raise TimeoutError, error
+      rescue HTTP::Redirector::TooManyRedirectsError => error
+        raise TooManyRedirectsError, error
+      end
+    end
+  end
+end

data/lib/webmention/endpoint/version.rb

@@ -1,5 +1,5 @@
 module Webmention
   module Endpoint
-    VERSION = '0.3.1'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

data/webmention-endpoint.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.16', '>= 1.16.2'
   spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.1'
   spec.add_development_dependency 'rspec', '~> 3.7'
-  spec.add_development_dependency 'rubocop', '~> 0.57.2'
+  spec.add_development_dependency 'rubocop', '~> 0.58.0'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.27'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'
   spec.add_development_dependency 'simplecov-console', '~> 0.4.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webmention-endpoint
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-05 00:00:00.000000000 Z
+date: 2018-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,14 +70,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.2
+        version: 0.58.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.2
+        version: 0.58.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -210,8 +210,10 @@ files:
 - README.md
 - 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/version.rb
 - webmention-endpoint.gemspec
 homepage: https://github.com/jgarber623/webmention-endpoint-ruby