indieauth_discovery 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64aec7aba0f75ed8c80dbfc68dba30a3a321d0275b8d8a991772357eba013caa
-  data.tar.gz: 18fee04fbe53329ffa4410a3a4b7712fa0204688423b54ecabe23780668177e8
+  metadata.gz: 85ce1354360eb82468c0b95b5b0bb2b890fe730903495f2a524f8a3139fc88ca
+  data.tar.gz: 1d62542282b3a37e9eac460e2f34ea5d1d39f513cfa106130f949812f3579938
 SHA512:
-  metadata.gz: 289ed40bac4fba8ffec7e968fb0c244f9325978078cff9f2720e4e0f991e3a083bc78c5dc8d98853f50dcbc4e10dcc0b17b3988172c63820d4eeb67f45b92c21
-  data.tar.gz: cb523fa2da8aa2263ffc1fd2059acf3a83cf059d49185b593a993c17ad0e687d2c4b3c15ea7963458c993614595667c383c0258bb4c80e6c69fd0e4a1b7d39cd
+  metadata.gz: b931adb9b684d36571b3019da778d15d4a89a9f0831744a4dfd5286f53a8db7aa012f0d64222ea20a60f4857d86b013d4aa46968dc8c19b36d11a03c6c9ca8af
+  data.tar.gz: 3f54b19e8808d4cfc0e8b0cd64ea2d304cef5cf062b72575ff631429030d85f2a0b9810464f506ce62464ee238617ee6da1240561f144dd3587837d4b1cd482e

data/.editorconfig

@@ -4,6 +4,9 @@ root = true
 charset = utf-8
 end_of_line = lf
 insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
 
 [{Dangerfile,Gemfile,Rakefile}]
 indent_style = space

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+ko_fi: craftyphotons

data/.github/workflows/verify.yml

@@ -18,7 +18,7 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
 
       - name: Ruby gem cache
-        uses: actions/cache@v2.1.0
+        uses: actions/cache@v2.1.1
         with:
           path: vendor/bundle
           key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
@@ -54,7 +54,7 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
 
       - name: Ruby gem cache
-        uses: actions/cache@v2.1.0
+        uses: actions/cache@v2.1.1
         with:
           path: vendor/bundle
           key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}

data/CHANGELOG.md

@@ -5,6 +5,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+## [0.1.1]
+
+### Fixes
+
+* Use the last permanent redirect before any temporary redirects when canonicalizing URLs [#3](https://github.com/craftyphotons/indieauth_discovery/issues/3).
+
 ## [0.1.0]
 
 Initial release! :tada:
@@ -15,4 +21,5 @@ Initial release! :tada:
 * Authorization, token, and MicroPub endpoint discovery from user profiles
 
 [Unreleased]: https://github.com/craftyphotons/indieauth_discovery/compare/v0.1.0...HEAD
+[0.1.1]: https://github.com/craftyphotons/indieauth_discovery/releases/tag/v0.1.1
 [0.1.0]: https://github.com/craftyphotons/indieauth_discovery/releases/tag/v0.1.0

data/Gemfile

@@ -5,11 +5,13 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'bundler-audit', '~> 0.7'
+gem 'byebug', '~> 11.1'
 gem 'coveralls', '~> 0.8'
+gem 'pry', '~> 0.13'
 gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.9'
-gem 'rubocop', '~> 0.89'
-gem 'rubocop-performance', '~> 1.7'
-gem 'rubocop-rspec', '~> 1.42'
+gem 'rubocop', '~> 0.90'
+gem 'rubocop-performance', '~> 1.8'
+gem 'rubocop-rspec', '~> 1.43'
 gem 'webmock', '~> 3.8'
 gem 'yard', '~> 0.9'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    indieauth_discovery (0.1.0)
+    indieauth_discovery (0.1.1)
       faraday (~> 1.0)
       faraday_middleware (~> 1.0)
       link-header-parser (~> 2.0)
@@ -18,6 +18,8 @@ GEM
     bundler-audit (0.7.0.1)
       bundler (>= 1.2.0, < 3)
       thor (>= 0.18, < 2)
+    byebug (11.1.3)
+    coderay (1.1.3)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
@@ -36,6 +38,7 @@ GEM
     json (2.3.1)
     link-header-parser (2.0.0)
       absolutely (~> 4.0)
+    method_source (1.0.0)
     mini_portile2 (2.4.0)
     multipart-post (2.1.1)
     nokogiri (1.10.10)
@@ -43,6 +46,9 @@ GEM
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     public_suffix (4.0.5)
     rainbow (3.0.0)
     rake (13.0.1)
@@ -61,7 +67,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.89.1)
+    rubocop (0.90.0)
       parallel (~> 1.10)
       parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
@@ -72,10 +78,10 @@ GEM
       unicode-display_width (>= 1.4.0, < 2.0)
     rubocop-ast (0.3.0)
       parser (>= 2.7.1.4)
-    rubocop-performance (1.7.1)
-      rubocop (>= 0.82.0)
-    rubocop-rspec (1.42.0)
+    rubocop-performance (1.8.0)
       rubocop (>= 0.87.0)
+    rubocop-rspec (1.43.2)
+      rubocop (~> 0.87)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
     simplecov (0.16.1)
@@ -101,13 +107,15 @@ PLATFORMS
 
 DEPENDENCIES
   bundler-audit (~> 0.7)
+  byebug (~> 11.1)
   coveralls (~> 0.8)
   indieauth_discovery!
+  pry (~> 0.13)
   rake (~> 13.0)
   rspec (~> 3.9)
-  rubocop (~> 0.89)
-  rubocop-performance (~> 1.7)
-  rubocop-rspec (~> 1.42)
+  rubocop (~> 0.90)
+  rubocop-performance (~> 1.8)
+  rubocop-rspec (~> 1.43)
   webmock (~> 3.8)
   yard (~> 0.9)
 

data/README.md

@@ -5,6 +5,8 @@
 [![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/craftyphotons/indieauth_discovery?style=for-the-badge)](https://codeclimate.com/github/craftyphotons/indieauth_discovery)
  
 [![Coveralls github branch](https://img.shields.io/coveralls/github/craftyphotons/indieauth_discovery/main?style=for-the-badge)](https://coveralls.io/github/craftyphotons/indieauth_discovery)
+ 
+[![Gem](https://img.shields.io/gem/v/indieauth_discovery?style=for-the-badge)](https://rubygems.org/gems/indieauth_discovery)
 
 Profile and client discovery for [Ruby](https://www.ruby-lang.org/en)-based [IndieAuth](https://indieauth.spec.indieweb.org) clients and providers.
 
@@ -101,4 +103,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the IndieauthDiscovery project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/indieauth_discovery/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the IndieauthDiscovery project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/craftyphotons/indieauth_discovery/blob/main/CODE_OF_CONDUCT.md).

data/lib/indieauth_discovery/url.rb

@@ -9,11 +9,12 @@ require_relative './errors'
 module IndieAuthDiscovery
   # Canonicalization for IndieAuth client and user profile URLs.
   class URL
-    attr_reader :original_url, :canonical_url
+    attr_reader :original_url, :canonical_url, :redirects
 
     def initialize(original_url)
       @original_url = original_url.to_s
       @canonical_url = original_url.to_s
+      @redirects = []
     end
 
     def self.canonicalize(original_url)
@@ -51,6 +52,8 @@ module IndieAuthDiscovery
 
     FARADAY_ERRORS = [Faraday::ConnectionFailed, Faraday::TimeoutError].freeze
 
+    PERMANENT_REDIRECTS = [301, 308].freeze
+
     def normalize_url(url)
       URI.parse(url).normalize
     end
@@ -93,26 +96,31 @@ module IndieAuthDiscovery
 
     # @see https://indieauth.spec.indieweb.org/#redirect-examples
     def follow_redirects(uri, response)
-      return uri unless [301, 302].include?(response.status)
+      return uri unless [300, 301, 302, 303, 304, 307, 308].include?(response.status)
+
+      redirector(uri).head
+      redirects.each do |redirect|
+        status = redirect[:status]
+        break unless PERMANENT_REDIRECTS.include?(status)
 
-      redirects = []
-      redirector(uri, redirects).head
+        uri = redirect[:url] if PERMANENT_REDIRECTS.include?(status)
+      end
 
-      uri = redirects.last if redirects.any? && redirects.last != uri
       uri
     end
 
-    def redirector(uri, redirects)
+    def redirector(uri)
       @redirector ||=
-        begin
-          callback = ->(old_env, new_env) { redirects << new_env.url.to_s if old_env.status == 301 }
-          Faraday.new(url: uri) do |faraday|
-            faraday.use(FaradayMiddleware::FollowRedirects, callback: callback)
-            faraday.adapter(Faraday.default_adapter)
-          end
+        Faraday.new(url: uri) do |faraday|
+          faraday.use(FaradayMiddleware::FollowRedirects, callback: method(:redirect_callback))
+          faraday.adapter(Faraday.default_adapter)
         end
     end
 
+    def redirect_callback(old_env, new_env)
+      redirects << { url: new_env.url.to_s, status: old_env.status }
+    end
+
     def raise_invalid_url_error(url)
       raise InvalidURLError.new(:invalid_url, 'URL must begin with http:// or https://', url)
     end

data/lib/indieauth_discovery/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IndieAuthDiscovery
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: indieauth_discovery
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tony Burns
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-13 00:00:00.000000000 Z
+date: 2020-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/FUNDING.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
@@ -94,7 +95,6 @@ files:
 - bin/setup
 - indieauth_discovery.gemspec
 - lib/indieauth_discovery.rb
-- lib/indieauth_discovery/client.rb
 - lib/indieauth_discovery/errors.rb
 - lib/indieauth_discovery/profile.rb
 - lib/indieauth_discovery/url.rb

data/lib/indieauth_discovery/client.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require 'faraday'
-require 'faraday_middleware/response/follow_redirects'
-require 'link-header-parser'
-require 'nokogiri'
-
-require_relative './errors'
-require_relative './url'
-
-module IndieAuthDiscovery
-  # Client information discovery according to the IndieAuth spec.
-  #
-  # @see https://indieauth.spec.indieweb.org/#client-information-discovery
-  class Profile
-    attr_reader :profile_url, :authorization_endpoint, :token_endpoint, :response
-
-    def initialize(default_scheme: :https)
-      @default_scheme = default_scheme
-    end
-
-    def call(url)
-      @profile_url = URL.canonicalize(url)
-      retrieve
-      discover
-    end
-
-    private
-
-    def retrieve
-      @response ||= get_follow_redirects(profile_url)
-      @link_headers = parse_link_headers(response)
-      @profile_document = parse_html_document(response)
-    end
-
-    def discover
-      @authorization_endpoint = first_link('authorization_endpoint')
-      @token_endpoint = first_link('token_endpoint')
-    end
-
-    def parse_link_headers(response)
-      return {} unless response.headers['link']
-
-      LinkHeaderParser.parse(response.headers['link'], base: profile_url).group_by_relation_type
-    end
-
-    def parse_html_document(response)
-      return Nokogiri::HTML('') unless response.headers['content-type'].start_with?('text/html')
-
-      Nokogiri::HTML(response.body)
-    end
-
-    def first_link(rel)
-      @link_headers[rel.to_sym]&.first&.target_uri ||
-        @profile_document.at_xpath("//link[@rel='#{rel}']")&.attribute('href')&.to_s
-    end
-
-    def get_follow_redirects(url)
-      Faraday.new(url: url) do |faraday|
-        faraday.use(FaradayMiddleware::FollowRedirects)
-        faraday.adapter(Faraday.default_adapter)
-      end.get
-    end
-  end
-end