indieweb-endpoints 7.1.0 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d00bf075ce905d49768b047c4963ccc8fb260e3ce7c06a1305a10099bdf6e4a0
-  data.tar.gz: 2c50a4fe3f85d401ccf981e5ef4c374e35f2788a2a00422f52df08c7a7c9821f
+  metadata.gz: ee2f8e43786e217e42c08df7c1aeec438bd56aa9156d431c49bb8163216b6df7
+  data.tar.gz: 8336092d579bee80500f14a0f278e584c70d20f5bd51cf46012e080fc64af944
 SHA512:
-  metadata.gz: ed757712cf9c99812ebdf2eb514c37b4a78cf0fd9f86c416611ce64a854706eb0e7b08599be0681438a774b76dbc9e03b2bb8434107fd17dec37403686743182
-  data.tar.gz: cadd7fad871a5d33f88e9365f7b8b1300c331cd96f2716d17f24ae8eac9eec79c463f4e45c68cb18fa35d602393fd771d3face3723c0acc1e3ab46acba02f7c7
+  metadata.gz: 56fa47965f839f37ce65fb1d2d3445265c66b865d2d85486b45f3306b6e5c13b1e4c98d301f2507ebe72ed279e2dc5e1449c891fdbc4a6746ff9ca088f8b621d
+  data.tar.gz: 320cfd2300bf0ae34d69031bb78eaabf0526105b5ed761f9c6f607585047ee81a72a347e9998cd06f366e636321d1ac32f345b1017ed8d634aa0620d65145a28

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 7.2.0 / 2022-10-04
+
+- Add support for `indieauth-metadata` endpoint (35cc950)
+- Switch from pry-byebug to Ruby's debug gem (7ad8925)
+- Update development Ruby version to 2.6.10 (f105752)
+
 ## 7.1.0 / 2022-03-08
 
 - Refactor gem code (eba8115)

data/CONTRIBUTING.md

@@ -8,9 +8,9 @@ There are a couple ways you can help improve indieweb-endpoints-ruby:
 
 ## Getting Started
 
-indieweb-endpoints-ruby is developed using Ruby 2.6.9 and is additionally tested against Ruby 2.7, 3.0, and 3.1 using [GitHub Actions](https://github.com/indieweb/indieweb-endpoints-ruby/actions).
+indieweb-endpoints-ruby is developed using Ruby 2.6.10 and is additionally tested against Ruby 2.7, 3.0, and 3.1 using [GitHub Actions](https://github.com/indieweb/indieweb-endpoints-ruby/actions).
 
-Before making changes to indieweb-endpoints-ruby, you'll want to install Ruby 2.6.9. 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.6.9 using your method of choice, install the project's gems by running:
+Before making changes to indieweb-endpoints-ruby, you'll want to install Ruby 2.6.10. 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.6.10 using your method of choice, install the project's gems by running:
 
 ```sh
 bundle install
@@ -22,7 +22,7 @@ bundle install
 1. Install development dependencies as outlined above.
 1. Create a feature branch for the code changes you're looking to make: `git checkout -b my-new-feature`.
 1. _Write some code!_
-1. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `bin/ci`.
+1. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `bundle exec rspec`.
 1. Commit your changes: `git commit -am 'Add some new feature or fix some issue'`. _(See [this excellent article](https://chris.beams.io/posts/git-commit/) for tips on writing useful Git commit messages.)_
 1. Push the branch to your fork: `git push -u origin my-new-feature`.
 1. Create a new [pull request][pulls] and we'll review your changes.

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.6 (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.6.9 and is additionally tested against Ruby 2.7, 3.0, and 3.1 using [GitHub Actions](https://github.com/indieweb/indieweb-endpoints-ruby/actions).
+indieweb-endpoints-ruby is developed using Ruby 2.6.10 and is additionally tested against Ruby 2.7, 3.0, and 3.1 using [GitHub Actions](https://github.com/indieweb/indieweb-endpoints-ruby/actions).
 
 ## Installation
 
@@ -46,7 +46,7 @@ With indieweb-endpoints-ruby added to your project's `Gemfile` and installed, yo
 require 'indieweb/endpoints'
 
 IndieWeb::Endpoints.get('https://aaronparecki.com')
-#=> { 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" }
+#=> { authorization_endpoint: "https://aaronparecki.com/auth", "indieauth-metadata": "https://aaronparecki.com/.well-known/oauth-authorization-server", 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 and return a `Hash` of results. Each key in the returned `Hash` will have a value of either a `String` representing a URL or `nil`. The `redirect_uri` key's value will be either an `Array` or `nil` since a given URL may register multiple callback URLs.
@@ -80,7 +80,7 @@ From [httprb/http](https://github.com/httprb/http):
 
 - `IndieWeb::Endpoints::HttpError`
 
-From the Ruby Standard Library's [`OpenSSL::SSL::SSLError`](https://ruby-doc.org/stdlib-2.6.9/libdoc/openssl/rdoc/OpenSSL/SSL/SSLError.html):
+From the Ruby Standard Library's [`OpenSSL::SSL::SSLError`](https://ruby-doc.org/stdlib-2.6.10/libdoc/openssl/rdoc/OpenSSL/SSL/SSLError.html):
 
 - `IndieWeb::Endpoints::SSLError`
 

data/lib/indieweb/endpoints/client.rb

@@ -8,8 +8,9 @@ module IndieWeb
         user_agent: 'IndieWeb Endpoint Discovery (https://rubygems.org/gems/indieweb-endpoints)'
       }.freeze
 
-      # Create a new client with a URL to parse for IndieWeb endpoints
+      # Create a new client with a URL to parse for IndieWeb endpoints.
       #
+      # @example
       #   client = IndieWeb::Endpoints::Client.new('https://aaronparecki.com')
       #
       # @param url [String, HTTP::URI, #to_s] an absolute URL
@@ -25,17 +26,17 @@ module IndieWeb
         %(#<#{self.class.name}:#{format('%#0x', object_id)} uri: "#{uri}">)
       end
 
-      # A Hash of the discovered IndieWeb endpoints from the provided URL
+      # A Hash of the discovered IndieWeb endpoints from the provided URL.
       #
       # @return [Hash{Symbol => String, Array, nil}]
       def endpoints
         @endpoints ||= Parser.new(response).results
       end
 
-      # The HTTP::Response object returned by the provided URL
+      # The +HTTP::Response+ object returned by the provided URL.
       #
       # @return [HTTP::Response]
-      # @raise [IndieWeb::Endpoints::HttpError]
+      # @raise [IndieWeb::Endpoints::HttpError, IndieWeb::Endpoints::SSLError]
       def response
         @response ||= HTTP.follow(max_hops: 20)
                           .headers(HTTP_HEADERS_OPTS)

data/lib/indieweb/endpoints/parser.rb

@@ -13,6 +13,7 @@ module IndieWeb
       def results
         {
           authorization_endpoint: result_for(:authorization_endpoint),
+          'indieauth-metadata': result_for(:'indieauth-metadata'),
           micropub: result_for(:micropub),
           microsub: result_for(:microsub),
           redirect_uri: results_for(:redirect_uri),

data/lib/indieweb/endpoints/response_headers_parser.rb

@@ -10,7 +10,7 @@ module IndieWeb
         @uri = response.uri
       end
 
-      # @param headers [Symbol]
+      # @param identifier [Symbol]
       # @return [Array<String>, nil]
       def results_for(identifier)
         return unless parsed_headers.key?(identifier)

data/lib/indieweb/endpoints/version.rb

@@ -2,6 +2,6 @@
 
 module IndieWeb
   module Endpoints
-    VERSION = '7.1.0'
+    VERSION = '7.2.0'
   end
 end

data/lib/indieweb/endpoints.rb

@@ -18,12 +18,15 @@ module IndieWeb
     class InvalidURIError < Error; end
     class SSLError < Error; end
 
-    # Discover a URL's IndieAuth, Micropub, Microsub, and Webmention endpoints
+    # Discover a URL's IndieAuth, Micropub, Microsub, and Webmention endpoints.
     #
+    # Convenience method for {IndieWeb::Endpoints::Client#endpoints}.
+    #
+    # @example
     #   IndieWeb::Endpoints.get('https://aaronparecki.com')
     #
-    # @param url [String] an absolute URL
-    # @return [Hash{Symbol => String, Array, nil}]
+    # @param (see IndieWeb::Endpoints::Client#endpoints)
+    # @return (see IndieWeb::Endpoints::Client#endpoints)
     def self.get(url)
       Client.new(url).endpoints
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: indieweb-endpoints
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 7.2.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-09 00:00:00.000000000 Z
+date: 2022-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -76,7 +76,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/indieweb/indieweb-endpoints-ruby/issues
-  changelog_uri: https://github.com/indieweb/indieweb-endpoints-ruby/blob/v7.1.0/CHANGELOG.md
+  changelog_uri: https://github.com/indieweb/indieweb-endpoints-ruby/blob/v7.2.0/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.12
 signing_key: 
 specification_version: 4
 summary: Discover a URL’s IndieAuth, Micropub, Microsub, and Webmention endpoints.