indieweb-endpoints 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66554d42a1533c2688aeb99e1e1a2ab802640ef6cfce21794c34ee9eef2d6b7a
-  data.tar.gz: 171055da85c2b49b5c02657006d87c43691ddd0eae08cd76ece4a7dacd9abe10
+  metadata.gz: 1788ffc5ea1dd7ec1a6d4c1839e19c4b208b38044a05aef7d618bad2485b7638
+  data.tar.gz: 4458a1d611d045035916ec9fc6f69c752f628a6c65776fbfdc0fdfc4bb823c83
 SHA512:
-  metadata.gz: e6d27232e1d39f0c388227e3acbeea0348f932e96849b6b31d1a417139b51aab1ae1a08f3fdf4fba8bf2b8ba2218f5fa93b4465040b9f0b584686bdf85fcaefc
-  data.tar.gz: 345f9bbc800fa538c0f7c7a03ff7b4f703c71f56d4efe69148c959bc6043f91b80c65be247d5d5f2b1f1ada3724e387d1720444c98c069aae605521d96259939
+  metadata.gz: cd530923575c34d392253a090fb9458c0709f6049ba055e9665879c067cc9571814b6079806773b3080c1b63def074b9331d8e9415855c91987acc56679090bb
+  data.tar.gz: 4f2836abdae4e424d2981b654d1d9a8b07cf84a970ee47571dca2235f85905c788136cc63ecde32d3ffbcc632e6f77e96d90aa6f3fc2c4f4bcb1d556d07ad587

data/.rubocop.yml

@@ -2,6 +2,9 @@ require:
   - rubocop-performance
   - rubocop-rspec
 
+Layout/AlignHash:
+  EnforcedHashRocketStyle: table
+
 Metrics/BlockLength:
   Exclude:
     - spec/**/*.rb

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 rvm:
   - 2.4.6
   - 2.5.5
-  - 2.6.2
+  - 2.6.3
 cache:
   - bundler
 before_install:

data/CHANGELOG.md

@@ -1,8 +1,14 @@
 # Changelog
 
+## 0.4.0 / 2019-05-01
+
+- Add `IndieWeb::Endpoints.client` method ([c4d42d0](https://github.com/indieweb/indieweb-endpoints-ruby/commit/c4d42d0)).
+- Rename base `Error` class to `IndieWebEndpointsError` ([d6d6f98](https://github.com/indieweb/indieweb-endpoints-ruby/commit/d6d6f98)).
+- Add `HttpRequest` class ([7864cbd](https://github.com/indieweb/indieweb-endpoints-ruby/commit/7864cbd)).
+
 ## 0.3.0 / 2019-04-30
 
-- `IndieWeb::Endpoints::Client#endpoints` returns an `OpenStruct` instead of a `Hash` ([c209b0b](https://github.com/indieweb/indieweb-endpoints-ruby/commit/c209b0b))
+- `IndieWeb::Endpoints::Client#endpoints` returns an `OpenStruct` instead of a `Hash` ([c209b0b](https://github.com/indieweb/indieweb-endpoints-ruby/commit/c209b0b)).
 
 ## 0.2.0 / 2019-04-25
 

data/CONTRIBUTING.md

@@ -8,7 +8,7 @@ There are a couple ways you can help improve indieweb-endpoints-ruby:
 
 ## Getting Started
 
-indieweb-endpoints-ruby is developed using Ruby 2.4.6 and is additionally tested against Ruby 2.5.5 and 2.6.2 using [Travis CI](https://travis-ci.com/indieweb/indieweb-endpoints-ruby).
+indieweb-endpoints-ruby is developed using Ruby 2.4.6 and is additionally tested against Ruby 2.5.5 and 2.6.3 using [Travis CI](https://travis-ci.com/indieweb/indieweb-endpoints-ruby).
 
 Before making changes to indieweb-endpoints-ruby, you'll want to install Ruby 2.4.6. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm). Once you've installed Ruby 2.4.6 using your method of choice, install the project's gems by running:
 

data/README.md

@@ -18,7 +18,7 @@
 
 Before installing and using indieweb-endpoints-ruby, you'll want to have [Ruby](https://www.ruby-lang.org) 2.4 (or newer) installed. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm).
 
-indieweb-endpoints-ruby is developed using Ruby 2.4.6 and is additionally tested against Ruby 2.5.5 and 2.6.2 using [Travis CI](https://travis-ci.com/indieweb/indieweb-endpoints-ruby).
+indieweb-endpoints-ruby is developed using Ruby 2.4.6 and is additionally tested against Ruby 2.5.5 and 2.6.3 using [Travis CI](https://travis-ci.com/indieweb/indieweb-endpoints-ruby).
 
 ## Installation
 
@@ -66,12 +66,12 @@ Each attribute will return either a `String` representing a URL or `nil`. The `r
 
 ### Advanced Usage
 
-Should the need arise, you may work directly with the `IndieWeb::Endpoints::Client` class:
+Should the need arise, you may work with the `IndieWeb::Endpoints::Client` class:
 
 ```ruby
 require 'indieweb/endpoints'
 
-client = IndieWeb::Endpoints::Client.new('https://aaronparecki.com')
+client = IndieWeb::Endpoints.client('https://aaronparecki.com')
 
 puts client.response             # => #<HTTP::Response …>
 puts client.endpoints            # => #<OpenStruct …>
@@ -80,7 +80,7 @@ puts client.endpoints.webmention # => 'https://webmention.io/aaronpk/webmention'
 
 ### Exception Handling
 
-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`).
+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`).
 
 From [jgarber623/absolutely](https://github.com/jgarber623/absolutely) and  [sporkmonger/addressable](https://github.com/sporkmonger/addressable):
 

data/indieweb-endpoints.gemspec

@@ -3,6 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'indieweb/endpoints/version'
 
+# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.required_ruby_version = ['>= 2.4', '< 2.7']
 
@@ -20,18 +21,24 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ['lib']
 
+  spec.metadata = {
+    'bug_tracker_uri' => "#{spec.homepage}/issues",
+    'changelog_uri'   => "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md"
+  }
+
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'reek', '~> 5.4'
   spec.add_development_dependency 'rspec', '~> 3.8'
-  spec.add_development_dependency 'rubocop', '~> 0.67.2'
+  spec.add_development_dependency 'rubocop', '~> 0.68.1'
   spec.add_development_dependency 'rubocop-performance', '~> 1.1'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.32'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'
   spec.add_development_dependency 'simplecov-console', '~> 0.4.2'
   spec.add_development_dependency 'webmock', '~> 3.5'
 
-  spec.add_runtime_dependency 'absolutely', '~> 2.0'
+  spec.add_runtime_dependency 'absolutely', '~> 2.1'
   spec.add_runtime_dependency 'addressable', '~> 2.6'
   spec.add_runtime_dependency 'http', '~> 5.0.0.pre'
   spec.add_runtime_dependency 'nokogiri', '~> 1.10'
 end
+# rubocop:enable Metrics/BlockLength

data/lib/indieweb/endpoints.rb

@@ -7,6 +7,7 @@ require 'indieweb/endpoints/version'
 require 'indieweb/endpoints/exceptions'
 
 require 'indieweb/endpoints/client'
+require 'indieweb/endpoints/http_request'
 require 'indieweb/endpoints/registerable'
 
 require 'indieweb/endpoints/parsers'
@@ -18,8 +19,14 @@ require 'indieweb/endpoints/parsers/webmention_parser'
 
 module IndieWeb
   module Endpoints
-    def self.get(url)
-      Client.new(url).endpoints
+    class << self
+      def client(url)
+        Client.new(url)
+      end
+
+      def get(url)
+        client(url).endpoints
+      end
     end
   end
 end

data/lib/indieweb/endpoints/client.rb

@@ -1,17 +1,12 @@
 module IndieWeb
   module Endpoints
     class Client
-      HTTP_HEADERS_OPTS = {
-        accept: '*/*',
-        user_agent: 'IndieAuth, Micropub, and Webmention Endpoint Discovery (https://rubygems.org/gems/indieweb-endpoints)'
-      }.freeze
-
       def initialize(url)
         raise ArgumentError, "url must be a String (given #{url.class.name})" unless url.is_a?(String)
 
-        @url = Addressable::URI.parse(url)
+        @uri = Addressable::URI.parse(url)
 
-        raise ArgumentError, 'url must be an absolute URL (e.g. https://example.com)' unless @url.absolute?
+        raise ArgumentError, 'url must be an absolute URL (e.g. https://example.com)' unless @uri.absolute?
       rescue Addressable::URI::InvalidURIError => exception
         raise InvalidURIError, exception
       end
@@ -21,11 +16,7 @@ module IndieWeb
       end
 
       def response
-        @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
+        @response ||= HttpRequest.get(@uri)
       end
     end
   end

data/lib/indieweb/endpoints/exceptions.rb

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

data/lib/indieweb/endpoints/http_request.rb

@@ -0,0 +1,18 @@
+module IndieWeb
+  module Endpoints
+    class HttpRequest
+      HTTP_HEADERS_OPTS = {
+        accept: '*/*',
+        user_agent: 'IndieAuth, Micropub, and Webmention Endpoint Discovery (https://rubygems.org/gems/indieweb-endpoints)'
+      }.freeze
+
+      def self.get(uri)
+        HTTP.follow.headers(HTTP_HEADERS_OPTS).timeout(connect: 10, read: 10).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/parsers.rb

@@ -21,7 +21,7 @@ module IndieWeb
         def results
           return unless results_from_http_request
 
-          @results ||= Absolutely.to_absolute_uri(base: @response.uri.to_s, relative: results_from_http_request)
+          @results ||= Absolutely.to_abs(base: @response.uri.to_s, relative: results_from_http_request)
         rescue Absolutely::InvalidURIError => exception
           raise InvalidURIError, exception
         end

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

@@ -11,7 +11,7 @@ module IndieWeb
         def results
           return unless results_from_http_request.any?
 
-          @results ||= results_from_http_request.map { |endpoint| Absolutely.to_absolute_uri(base: @response.uri.to_s, relative: endpoint) }.uniq.sort
+          @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

data/lib/indieweb/endpoints/version.rb

@@ -1,5 +1,5 @@
 module IndieWeb
   module Endpoints
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.4.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: indieweb-endpoints
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-30 00:00:00.000000000 Z
+date: 2019-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.2
+        version: 0.68.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.2
+        version: 0.68.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +220,7 @@ files:
 - lib/indieweb/endpoints.rb
 - lib/indieweb/endpoints/client.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
@@ -231,7 +232,9 @@ files:
 homepage: https://github.com/indieweb/indieweb-endpoints-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/indieweb/indieweb-endpoints-ruby/issues
+  changelog_uri: https://github.com/indieweb/indieweb-endpoints-ruby/blob/v0.4.0/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: