Simplify exception handling and update documentation

Author: jgarber623

README.md

@@ -70,17 +70,15 @@ client.endpoints
 
 ### Exception Handling
 
-There are several exceptions that may be raised by indieweb-endpoints-ruby's underlying dependencies. These errors are raised as subclasses of `IndieWebEndpointsError` (which itself is a subclass 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 [sporkmonger/addressable](https://github.com/sporkmonger/addressable):
 
 - `IndieWeb::Endpoints::InvalidURIError`
 
 From [httprb/http](https://github.com/httprb/http):
 
-- `IndieWeb::Endpoints::ConnectionError`
-- `IndieWeb::Endpoints::TimeoutError`
-- `IndieWeb::Endpoints::TooManyRedirectsError`
+- `IndieWeb::Endpoints::HttpError`
 
 ## Contributing
 

lib/indieweb/endpoints/client.rb

@@ -12,11 +12,7 @@ class Client
       #
       # @param url [String] an absolute URL
       def initialize(url)
-        raise ArgumentError, "url must be a String (given #{url.class})" unless url.is_a?(String)
-
-        @url = url
-
-        raise ArgumentError, "url (#{url}) must be an absolute URL (e.g. https://example.com)" unless uri.absolute? && uri.scheme.match?(/^https?$/)
+        @url = url.to_str
       end
 
       # @return [String]
@@ -34,10 +30,8 @@ def endpoints
       # @return [HTTP::Response]
       def response
         @response ||= HTTP.follow(max_hops: 20).headers(HTTP_HEADERS_OPTS).timeout(connect: 5, read: 5).get(uri)
-      rescue HTTP::ConnectionError,
-             HTTP::TimeoutError,
-             HTTP::Redirector::TooManyRedirectsError => exception
-        raise IndieWeb::Endpoints.const_get(exception.class.name.split('::').last), exception
+      rescue HTTP::Error => exception
+        raise HttpError, exception
       end
 
       private

lib/indieweb/endpoints/exceptions.rb

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

spec/lib/indieweb/endpoints/client_response_spec.rb

@@ -9,8 +9,8 @@
       request.to_raise(HTTP::ConnectionError)
     end
 
-    it 'raises a ConnectionError' do
-      expect { client.response }.to raise_error(IndieWeb::Endpoints::ConnectionError)
+    it 'raises an HttpError' do
+      expect { client.response }.to raise_error(IndieWeb::Endpoints::HttpError)
     end
   end
 
@@ -19,8 +19,8 @@
       request.to_raise(HTTP::TimeoutError)
     end
 
-    it 'raises a TimeoutError' do
-      expect { client.response }.to raise_error(IndieWeb::Endpoints::TimeoutError)
+    it 'raises an HttpError' do
+      expect { client.response }.to raise_error(IndieWeb::Endpoints::HttpError)
     end
   end
 
@@ -29,8 +29,36 @@
       request.to_raise(HTTP::Redirector::TooManyRedirectsError)
     end
 
-    it 'raises a TooManyRedirectsError' do
-      expect { client.response }.to raise_error(IndieWeb::Endpoints::TooManyRedirectsError)
+    it 'raises an HttpError' do
+      expect { client.response }.to raise_error(IndieWeb::Endpoints::HttpError)
+    end
+  end
+
+  context 'when given an invalid URL' do
+    let(:url) { 'http:' }
+
+    it 'raises an InvalidURIError' do
+      expect { client.response }.to raise_error(IndieWeb::Endpoints::InvalidURIError)
+    end
+  end
+
+  context 'when given a relative URL' do
+    let(:url) { '../foo/bar/biz/baz' }
+
+    it 'raises an HttpError' do
+      message = 'unknown scheme: '
+
+      expect { client.response }.to raise_error(IndieWeb::Endpoints::HttpError, message)
+    end
+  end
+
+  context 'when given a URL with an invalid protocol' do
+    let(:url) { 'file:///foo/bar/baz' }
+
+    it 'raises an HttpError' do
+      message = 'unknown scheme: file'
+
+      expect { client.response }.to raise_error(IndieWeb::Endpoints::HttpError, message)
     end
   end
 end

spec/lib/indieweb/endpoints/client_spec.rb

@@ -1,31 +1,7 @@
 RSpec.describe IndieWeb::Endpoints::Client do
-  context 'when not given a String' do
-    it 'raises an ArgumentError' do
-      message = 'url must be a String (given NilClass)'
-
-      expect { described_class.new(nil) }.to raise_error(IndieWeb::Endpoints::ArgumentError, message)
-    end
-  end
-
-  context 'when given an invalid URL' do
-    it 'raises an InvalidURIError' do
-      expect { described_class.new('http:') }.to raise_error(IndieWeb::Endpoints::InvalidURIError)
-    end
-  end
-
-  context 'when given a relative URL' do
-    it 'raises an ArgumentError' do
-      message = 'url (../foo/bar/biz/baz) must be an absolute URL (e.g. https://example.com)'
-
-      expect { described_class.new('../foo/bar/biz/baz') }.to raise_error(IndieWeb::Endpoints::ArgumentError, message)
-    end
-  end
-
-  context 'when given a URL with an invalid protocol' do
-    it 'raises an ArgumentError' do
-      message = 'url (file:///foo/bar/baz) must be an absolute URL (e.g. https://example.com)'
-
-      expect { described_class.new('file:///foo/bar/baz') }.to raise_error(IndieWeb::Endpoints::ArgumentError, message)
+  context 'when not given a String-like object' do
+    it 'raises a NoMethodError' do
+      expect { described_class.new(nil) }.to raise_error(NoMethodError)
     end
   end
 end