indieweb-endpoints 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ea000fd8ce1b67e86979bf4e7b15a92fdadbf6c06930c1592a9bc9004a709f8
-  data.tar.gz: 61065c74af761a2284a4df12ca9ace1eff6e0d73880139ecc88a7c5ab0d60c22
+  metadata.gz: 2168f56d7a493faa4d1bd7a61e5ecc1cf52ca405baf43254ad3149fa6ad62460
+  data.tar.gz: 93c838259316804108f5a5b9c9950235f9283c08109aa1b1c2eb9f89c6d3eac2
 SHA512:
-  metadata.gz: a168817ddd7650e4e7bf54e2029427d70e682027f72658607c9c710bbc4646e7438f6b92f36b4a2b758ab1882220b0ea38a36d59e0ac80a3b595e016d0c0218a
-  data.tar.gz: 97ca5850e60dbb0a1509809cd2982ec8eea9d3158e15dcfaaf3279eb92509eb738e76bbbdd007a9d925a3879b05ef3b4801932bb284c2d288894a20e00776ad1
+  metadata.gz: a685fc02841e5433b183103679df93b9e6d2b0c530a0d6b3b8acf01adb41d17814a2778ac74ec876b3b70671ebbbfe76edcd414f1c6f8195838834d62d826b15
+  data.tar.gz: fbb870ada2afdb2b5b217fa224a6e43166e6faed8aa422d6e26c9cbd2375a2313ead2db29ec2e1d703423b856a6b80768d69100737c5a3709b8297a615b980f2

data/.reek.yml

@@ -1,9 +1,6 @@
 detectors:
   IrresponsibleModule:
     enabled: false
-  TooManyStatements:
-    exclude:
-      - IndieWeb::Endpoints::Client#response
   UtilityFunction:
     exclude:
       - FixtureHelpers#read_fixture

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.2.0 / 2019-04-25
+
+- Subclass exceptions under `IndieWeb::Endpoints::Error` ([667eec7](https://github.com/indieweb/indieweb-endpoints-ruby/commit/667eec7)).
+- Refactor parsers and `Registerable` module ([3b96858](https://github.com/indieweb/indieweb-endpoints-ruby/commit/3b96858)).
+- Refactor Client#response method ([c36fda3](https://github.com/indieweb/indieweb-endpoints-ruby/commit/c36fda3)).
+
 ## 0.1.0 / 2019-04-24
 
 - Initial release!

data/README.md

@@ -79,7 +79,7 @@ puts client.endpoints # => Hash
 
 ### Exception Handling
 
-There are several exceptions that may be raised by indieweb-endpoints-ruby's underlying dependencies. These errors are raised as subclasses of `StandardError`.
+There are several exceptions that may be raised by indieweb-endpoints-ruby's underlying dependencies. These errors are raised as subclasses of `IndieWeb::Endpoints::Error` (which itself is a subclass of `StandardError`).
 
 From [jgarber623/absolutely](https://github.com/jgarber623/absolutely) and  [sporkmonger/addressable](https://github.com/sporkmonger/addressable):
 

data/lib/indieweb/endpoints/client.rb

@@ -21,16 +21,11 @@ module IndieWeb
       end
 
       def response
-        @response ||= HTTP.follow.headers(HTTP_HEADERS_OPTS).timeout(
-          connect: 10,
-          read: 10
-        ).get(@url)
-      rescue HTTP::ConnectionError => exception
-        raise ConnectionError, exception
-      rescue HTTP::TimeoutError => exception
-        raise TimeoutError, exception
-      rescue HTTP::Redirector::TooManyRedirectsError => exception
-        raise TooManyRedirectsError, exception
+        @response ||= HTTP.follow.headers(HTTP_HEADERS_OPTS).timeout(connect: 10, read: 10).get(@url)
+      rescue HTTP::ConnectionError,
+             HTTP::TimeoutError,
+             HTTP::Redirector::TooManyRedirectsError => exception
+        raise IndieWeb::Endpoints.const_get(exception.class.name.split('::').last), exception
       end
     end
   end

data/lib/indieweb/endpoints/exceptions.rb

@@ -1,13 +1,15 @@
 module IndieWeb
   module Endpoints
-    class ArgumentError < StandardError; end
+    class Error < StandardError; end
 
-    class ConnectionError < StandardError; end
+    class ArgumentError < Error; end
 
-    class InvalidURIError < StandardError; end
+    class ConnectionError < Error; end
 
-    class TimeoutError < StandardError; end
+    class InvalidURIError < Error; end
 
-    class TooManyRedirectsError < StandardError; end
+    class TimeoutError < Error; end
+
+    class TooManyRedirectsError < Error; end
   end
 end

data/lib/indieweb/endpoints/parsers.rb

@@ -50,7 +50,7 @@ module IndieWeb
         end
 
         def link_elements_css_selector
-          @link_elements_css_selector ||= %(link[rel~="#{identifier}"][href])
+          @link_elements_css_selector ||= %(link[rel~="#{self.class.identifier}"][href])
         end
 
         def link_header
@@ -65,7 +65,7 @@ module IndieWeb
         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 ||= /(?:;|\s)rel="?(?:#{REGEXP_REG_REL_TYPE_PATTERN}+\s)?#{identifier}(?:\s#{REGEXP_REG_REL_TYPE_PATTERN})?"?/
+          @regexp_rel_paramater_pattern ||= /(?:;|\s)rel="?(?:#{REGEXP_REG_REL_TYPE_PATTERN}+\s)?#{self.class.identifier}(?:\s#{REGEXP_REG_REL_TYPE_PATTERN})?"?/
         end
 
         def results_from_body

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

@@ -2,13 +2,11 @@ module IndieWeb
   module Endpoints
     module Parsers
       class AuthorizationEndpointParser < BaseParser
-        Parsers.register(:authorization_endpoint, self)
-
-        private
-
-        def identifier
-          @identifier ||= :authorization_endpoint
+        def self.identifier
+          :authorization_endpoint
         end
+
+        Parsers.register(self)
       end
     end
   end

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

@@ -2,13 +2,11 @@ module IndieWeb
   module Endpoints
     module Parsers
       class MicropubParser < BaseParser
-        Parsers.register(:micropub, self)
-
-        private
-
-        def identifier
-          @identifier ||= :micropub
+        def self.identifier
+          :micropub
         end
+
+        Parsers.register(self)
       end
     end
   end

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

@@ -2,7 +2,11 @@ module IndieWeb
   module Endpoints
     module Parsers
       class RedirectUriParser < BaseParser
-        Parsers.register(:redirect_uri, self)
+        def self.identifier
+          :redirect_uri
+        end
+
+        Parsers.register(self)
 
         def results
           return unless results_from_http_request.any?
@@ -14,10 +18,6 @@ module IndieWeb
 
         private
 
-        def identifier
-          @identifier ||= :redirect_uri
-        end
-
         def results_from_body
           link_elements.map { |element| element['href'] } if response_is_html && link_elements.any?
         end

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

@@ -2,13 +2,11 @@ module IndieWeb
   module Endpoints
     module Parsers
       class TokenEndpointParser < BaseParser
-        Parsers.register(:token_endpoint, self)
-
-        private
-
-        def identifier
-          @identifier ||= :token_endpoint
+        def self.identifier
+          :token_endpoint
         end
+
+        Parsers.register(self)
       end
     end
   end

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

@@ -2,13 +2,13 @@ module IndieWeb
   module Endpoints
     module Parsers
       class WebmentionParser < BaseParser
-        Parsers.register(:webmention, self)
+        def self.identifier
+          :webmention
+        end
 
-        private
+        Parsers.register(self)
 
-        def identifier
-          @identifier ||= :webmention
-        end
+        private
 
         def link_element
           # Return first `a` or `link` element with valid `rel` attribute
@@ -17,7 +17,7 @@ module IndieWeb
         end
 
         def link_elements_css_selector
-          @link_elements_css_selector ||= %([rel~="#{identifier}"][href])
+          @link_elements_css_selector ||= %([rel~="#{self.class.identifier}"][href])
         end
       end
     end

data/lib/indieweb/endpoints/registerable.rb

@@ -1,8 +1,8 @@
 module IndieWeb
   module Endpoints
     module Registerable
-      def register(identifier, klass)
-        registered[identifier] = klass
+      def register(klass)
+        registered[klass.identifier] = klass
       end
 
       def registered

data/lib/indieweb/endpoints/version.rb

@@ -1,5 +1,5 @@
 module IndieWeb
   module Endpoints
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: indieweb-endpoints
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jason Garber