indieweb-endpoints 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: accf64f7588992215bc39dd8034bf0251c0e395ee81fd2d6ec2d025f4dafa0ef
-  data.tar.gz: d3c9b7e944ed51316819361532a351742d53e94aed123ac1e64d11e0842549ac
+  metadata.gz: d94a9697335de7e9dbc24727805991f0a6831195a9bc81c44d2b3b63c750c976
+  data.tar.gz: 62b63c314f17152b2934c8fe740dd0a986a400be3694ecceb64f07670a961de4
 SHA512:
-  metadata.gz: 8a6803dcefbf0b5d8ee7c63e680dfe595ff8f7821e1add6cbc1ea5c00279612e3b8d762bea8a20bd90fad6ea470d1da3d82a4518d8d60eae14a2e95c00773270
-  data.tar.gz: c5209fa68fdd2a68b277445860a7a98598a95d663e4ff69f3e43850942908724d942d1bf1d7e3bb0ad2607d72fc89ac6f5b9e8c2dc2b21414da19fc9add92539
+  metadata.gz: 286f0df5a086a15e6bbde85cc24a71fc4cbb175f6be98dc15fe52d7b8bc138bcffee098c3572db007b536c27d1c1575e951f371a77a7c46b8b2baf0493454e22
+  data.tar.gz: a4bd418e746511772973b50216962978350b34bf433c525b8cf44e03726e6d30d10939d60879518cf4000c4e1cf5245024606a52f7cf4f58b03a92f863e9058b

data/.reek.yml

@@ -4,6 +4,8 @@ detectors:
   UtilityFunction:
     exclude:
       - FixtureHelpers#read_fixture
+      - IndieWeb::Endpoints::Services::ResponseBodyParserService#parse
+      - IndieWeb::Endpoints::Services::ResponseHeadersParserService#parse
 
 exclude_paths:
   - vendor/

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.0.0 / 2019-07-08
+
+-  Refactor gem code using service objects approach (78511d7 and 9d2fee0)
+
 ## 0.7.0 / 2019-07-03
 
 - Update runtime and development dependencies (d99214b and 7692ab3)
@@ -25,13 +29,13 @@
 
 ## 0.3.0 / 2019-04-30
 
-- `IndieWeb::Endpoints::Client#endpoints` returns an `OpenStruct` instead of a `Hash (c209b0b).
+- `IndieWeb::Endpoints::Client#endpoints` returns an `OpenStruct` instead of a `Hash` (c209b0b).
 
 ## 0.2.0 / 2019-04-25
 
 - Subclass exceptions under `IndieWeb::Endpoints::Error` (667eec7)
 - Refactor parsers and `Registerable` module (3b96858)
-- Refactor Client#response method (c36fda3)
+- Refactor `Client#response` method (c36fda3)
 
 ## 0.1.0 / 2019-04-24
 

data/README.md

@@ -47,10 +47,10 @@ require 'indieweb/endpoints'
 
 endpoints = IndieWeb::Endpoints.get('https://aaronparecki.com')
 
-puts endpoints # => #<OpenStruct …>
+puts endpoints # => #<OpenStruct authorization_endpoint="https://aaronparecki.com/auth", micropub="https://aaronparecki.com/micropub", microsub="https://aperture.p3k.io/microsub/1", redirect_uri=nil, token_endpoint="https://aaronparecki.com/auth/token", webmention="https://webmention.io/aaronpk/webmention">
 ```
 
-This example will search `https://aaronparecki.com` for valid IndieAuth, Micropub, and Webmention endpoints. In this case, the program returns an `OpenStruct` with the following attributes:
+This example will search `https://aaronparecki.com` for valid IndieAuth, Micropub, and Webmention endpoints. In this case, the program returns an `OpenStruct` with the following attributes (represented below as a `Hash`):
 
 ```ruby
 {
@@ -72,11 +72,18 @@ Should the need arise, you may work with the `IndieWeb::Endpoints::Client` class
 ```ruby
 require 'indieweb/endpoints'
 
-client = IndieWeb::Endpoints.client('https://aaronparecki.com')
+client = IndieWeb::Endpoints::Client.new('https://aaronparecki.com')
 
-puts client.response             # => #<HTTP::Response …>
-puts client.endpoints            # => #<OpenStruct …>
-puts client.endpoints.webmention # => 'https://webmention.io/aaronpk/webmention'
+puts client.response # => #<HTTP::Response/1.1 200 OK {…}>
+
+endpoints = client.endpoints
+
+puts endpoints.authorization_endpoint # => 'https://aaronparecki.com/auth'
+puts endpoints.micropub               # => 'https://aaronparecki.com/micropub'
+puts endpoints.microsub               # => 'https://aperture.p3k.io/microsub/1'
+puts endpoints.redirect_uri           # => nil
+puts endpoints.token_endpoint         # => 'https://aaronparecki.com/auth/token'
+puts endpoints.webmention             # => 'https://webmention.io/aaronpk/webmention'
 ```
 
 ### Exception Handling

data/lib/indieweb/endpoints.rb

@@ -9,11 +9,15 @@ require 'nokogiri'
 require 'indieweb/endpoints/version'
 require 'indieweb/endpoints/exceptions'
 
-require 'indieweb/endpoints/client'
-require 'indieweb/endpoints/http_request'
-require 'indieweb/endpoints/registerable'
+require 'indieweb/endpoints/concerns/registerable'
+
+require 'indieweb/endpoints/services/http_request_service'
+require 'indieweb/endpoints/services/response_body_parser_service'
+require 'indieweb/endpoints/services/response_headers_parser_service'
 
+require 'indieweb/endpoints/client'
 require 'indieweb/endpoints/parsers'
+
 require 'indieweb/endpoints/parsers/authorization_endpoint_parser'
 require 'indieweb/endpoints/parsers/micropub_parser'
 require 'indieweb/endpoints/parsers/microsub_parser'
@@ -23,14 +27,8 @@ require 'indieweb/endpoints/parsers/webmention_parser'
 
 module IndieWeb
   module Endpoints
-    class << self
-      def client(url)
-        Client.new(url)
-      end
-
-      def get(url)
-        client(url).endpoints
-      end
+    def self.get(url)
+      Client.new(url).endpoints
     end
   end
 end

data/lib/indieweb/endpoints/client.rb

@@ -16,8 +16,12 @@ module IndieWeb
       end
 
       def response
-        @response ||= HttpRequest.get(@uri)
+        @response ||= Services::HttpRequestService.new.get(uri)
       end
+
+      private
+
+      attr_accessor :uri
     end
   end
 end

data/lib/indieweb/endpoints/concerns/registerable.rb

@@ -0,0 +1,15 @@
+module IndieWeb
+  module Endpoints
+    module Concerns
+      module Registerable
+        def register(klass)
+          registered[klass.identifier] = klass
+        end
+
+        def registered
+          @registered ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/indieweb/endpoints/parsers.rb

@@ -1,11 +1,9 @@
 module IndieWeb
   module Endpoints
     module Parsers
-      extend Registerable
+      extend Concerns::Registerable
 
       class BaseParser
-        attr_reader :response
-
         def initialize(response)
           raise ArgumentError, "response must be an HTTP::Response (given #{response.class.name})" unless response.is_a?(HTTP::Response)
 
@@ -13,93 +11,29 @@ module IndieWeb
         end
 
         def results
-          return unless results_from_http_request
+          mapped_results.shift
+        end
+
+        private
+
+        attr_reader :response
 
-          @results ||= Absolutely.to_abs(base: response.uri.to_s, relative: results_from_http_request)
+        def mapped_results
+          @mapped_results ||= results_from_http_request.map { |endpoint| Absolutely.to_abs(base: response.uri.to_s, relative: endpoint) }.uniq.sort
         rescue Absolutely::InvalidURIError => exception
           raise InvalidURIError, exception
         end
 
-        private
-
         def results_from_body
-          BaseLinkElementParser.new(response, self.class.identifier).results
+          @results_from_body ||= Services::ResponseBodyParserService.new.parse(response, self.class.identifier)
         end
 
         def results_from_headers
-          BaseLinkHeaderParser.new(response, self.class.identifier).results
+          @results_from_headers ||= Services::ResponseHeadersParserService.new.parse(response, self.class.identifier)
         end
 
         def results_from_http_request
-          @results_from_http_request ||= results_from_headers || results_from_body || nil
-        end
-
-        class BaseLinkElementParser
-          attr_reader :identifier, :response
-
-          def initialize(response, identifier)
-            @response = response
-            @identifier = identifier
-          end
-
-          def results
-            link_element['href'] if response_is_html && link_element
-          end
-
-          private
-
-          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_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 response_is_html
-            @response_is_html ||= response.mime_type == 'text/html'
-          end
-        end
-
-        class BaseLinkHeaderParser
-          attr_reader :identifier, :response
-
-          def initialize(response, identifier)
-            @response = response
-            @identifier = identifier
-          end
-
-          def results
-            return unless link_headers
-
-            link_headers.shift.target_uri
-          end
-
-          private
-
-          def link_headers
-            @link_headers ||= begin
-              return unless parsed_link_headers
-
-              # 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 parsed_link_headers
-            @parsed_link_headers ||= LinkHeaderParser.parse(response.headers.get('link'), base: response.uri.to_s).by_relation_type[identifier]
-          end
+          @results_from_http_request ||= [results_from_headers, results_from_body].flatten.compact
         end
       end
     end

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

@@ -9,39 +9,9 @@ module IndieWeb
         Parsers.register(self)
 
         def results
-          return unless results_from_http_request.any?
+          return unless mapped_results.any?
 
-          @results ||= results_from_http_request.map { |endpoint| Absolutely.to_abs(base: response.uri.to_s, relative: endpoint) }.uniq.sort
-        rescue Absolutely::InvalidURIError => exception
-          raise InvalidURIError, exception
-        end
-
-        private
-
-        def results_from_body
-          RedirectUriLinkElementParser.new(response, self.class.identifier).results
-        end
-
-        def results_from_headers
-          RedirectUriLinkHeaderParser.new(response, self.class.identifier).results
-        end
-
-        def results_from_http_request
-          @results_from_http_request ||= [results_from_headers, results_from_body].flatten.compact
-        end
-
-        class RedirectUriLinkElementParser < BaseLinkElementParser
-          def results
-            link_elements.map { |element| element['href'] } if response_is_html && link_elements.any?
-          end
-        end
-
-        class RedirectUriLinkHeaderParser < BaseLinkHeaderParser
-          def results
-            return unless link_headers
-
-            link_headers.map(&:target_uri)
-          end
+          mapped_results
         end
       end
     end

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

@@ -10,22 +10,13 @@ module IndieWeb
 
         private
 
-        def results_from_body
-          WebmentionLinkElementParser.new(response, self.class.identifier).results
+        def results_for_node(node)
+          Services::ResponseBodyParserService.new.parse(response, self.class.identifier, node)
         end
 
-        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_elements_css_selector
-            @link_elements_css_selector ||= %([rel~="#{identifier}"][href]:not([href*="#"]))
-          end
+        # https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint
+        def results_from_body
+          @results_from_body ||= results_for_node('link') + results_for_node('a')
         end
       end
     end

data/lib/indieweb/endpoints/services/http_request_service.rb

@@ -0,0 +1,39 @@
+module IndieWeb
+  module Endpoints
+    module Services
+      class HttpRequestService
+        # Defaults derived from Webmention specification examples
+        # https://www.w3.org/TR/webmention/#limits-on-get-requests
+        HTTP_CLIENT_OPTS = {
+          follow: {
+            max_hops: 20
+          },
+          headers: {
+            accept: '*/*',
+            user_agent: 'IndieWeb Endpoint Discovery (https://rubygems.org/gems/indieweb-endpoints)'
+          },
+          timeout_options: {
+            connect_timeout: 5,
+            read_timeout: 5
+          }
+        }.freeze
+
+        def initialize
+          @client = HTTP::Client.new(HTTP_CLIENT_OPTS)
+        end
+
+        def get(uri)
+          client.request(:get, uri)
+        rescue HTTP::ConnectionError,
+               HTTP::TimeoutError,
+               HTTP::Redirector::TooManyRedirectsError => exception
+          raise IndieWeb::Endpoints.const_get(exception.class.name.split('::').last), exception
+        end
+
+        private
+
+        attr_accessor :client
+      end
+    end
+  end
+end

data/lib/indieweb/endpoints/services/response_body_parser_service.rb

@@ -0,0 +1,14 @@
+module IndieWeb
+  module Endpoints
+    module Services
+      class ResponseBodyParserService
+        def parse(response, identifier, node = 'link')
+          return unless response.mime_type == 'text/html'
+
+          # Reject endpoints that contain a fragment identifier
+          Nokogiri::HTML(response.body.to_s).css(%(#{node}[rel~="#{identifier}"][href]:not([href*="#"]))).map { |element| element['href'] }
+        end
+      end
+    end
+  end
+end

data/lib/indieweb/endpoints/services/response_headers_parser_service.rb

@@ -0,0 +1,16 @@
+module IndieWeb
+  module Endpoints
+    module Services
+      class ResponseHeadersParserService
+        def parse(response, identifier)
+          headers = LinkHeaderParser.parse(response.headers.get('link'), base: response.uri.to_s).by_relation_type[identifier]
+
+          return unless headers
+
+          # Reject endpoints that contain a fragment identifier
+          headers.reject { |header| Addressable::URI.parse(header.target_uri).fragment }.map(&:target_uri)
+        end
+      end
+    end
+  end
+end

data/lib/indieweb/endpoints/version.rb

@@ -1,5 +1,5 @@
 module IndieWeb
   module Endpoints
-    VERSION = '0.7.0'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: indieweb-endpoints
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-03 00:00:00.000000000 Z
+date: 2019-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -233,8 +233,8 @@ files:
 - indieweb-endpoints.gemspec
 - lib/indieweb/endpoints.rb
 - lib/indieweb/endpoints/client.rb
+- lib/indieweb/endpoints/concerns/registerable.rb
 - lib/indieweb/endpoints/exceptions.rb
-- lib/indieweb/endpoints/http_request.rb
 - lib/indieweb/endpoints/parsers.rb
 - lib/indieweb/endpoints/parsers/authorization_endpoint_parser.rb
 - lib/indieweb/endpoints/parsers/micropub_parser.rb
@@ -242,14 +242,16 @@ files:
 - lib/indieweb/endpoints/parsers/redirect_uri_parser.rb
 - lib/indieweb/endpoints/parsers/token_endpoint_parser.rb
 - lib/indieweb/endpoints/parsers/webmention_parser.rb
-- lib/indieweb/endpoints/registerable.rb
+- lib/indieweb/endpoints/services/http_request_service.rb
+- lib/indieweb/endpoints/services/response_body_parser_service.rb
+- lib/indieweb/endpoints/services/response_headers_parser_service.rb
 - lib/indieweb/endpoints/version.rb
 homepage: https://github.com/indieweb/indieweb-endpoints-ruby
 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.7.0/CHANGELOG.md
+  changelog_uri: https://github.com/indieweb/indieweb-endpoints-ruby/blob/v1.0.0/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/indieweb/endpoints/http_request.rb

@@ -1,29 +0,0 @@
-module IndieWeb
-  module Endpoints
-    class HttpRequest
-      # Defaults derived from Webmention specification examples
-      # https://www.w3.org/TR/webmention/#limits-on-get-requests
-      HTTP_CLIENT_OPTS = {
-        follow: {
-          max_hops: 20
-        },
-        headers: {
-          accept: '*/*',
-          user_agent: 'IndieWeb Endpoint Discovery (https://rubygems.org/gems/indieweb-endpoints)'
-        },
-        timeout_options: {
-          connect_timeout: 5,
-          read_timeout: 5
-        }
-      }.freeze
-
-      def self.get(uri)
-        HTTP::Client.new(HTTP_CLIENT_OPTS).request(:get, uri)
-      rescue HTTP::ConnectionError,
-             HTTP::TimeoutError,
-             HTTP::Redirector::TooManyRedirectsError => exception
-        raise IndieWeb::Endpoints.const_get(exception.class.name.split('::').last), exception
-      end
-    end
-  end
-end

data/lib/indieweb/endpoints/registerable.rb

@@ -1,13 +0,0 @@
-module IndieWeb
-  module Endpoints
-    module Registerable
-      def register(klass)
-        registered[klass.identifier] = klass
-      end
-
-      def registered
-        @registered ||= {}
-      end
-    end
-  end
-end