github-pages-health-check 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 491f20abd7228f543a6f4682b74918a9f32265ca0f0f015d41ae40e5163462e6
-  data.tar.gz: 1dcb08e4d692030537e2d1334c09edbcac2e4179fb7ad05fe23cb412c6401270
+  metadata.gz: ad338ea604a8549ea8d86009de6cdd7d8c578eb81d14d2f2ebf96b5fc7791cbe
+  data.tar.gz: 1241ab1285cf8d4e15cc9e56ee701b40241eede4740ce4090deb055c3b460ef0
 SHA512:
-  metadata.gz: 18bb1e7f1c7ece16a011ddd55c4f4238ab600be77013705857306cbbfd6d74e120b72f62ea853647c1b7d0a8affcc0dda222c7a22008645f4f66abe755c64634
-  data.tar.gz: b099817a6ebd5298f81a993f5c5c2b767bd291122f0262f81002bdb4a1fa315864f838698b9e192719f46fbbd4b7b0ceba59e92a3ad8fe10f94a3edf97aa5873
+  metadata.gz: aff974999ece850cf655e4cd1234806ddc8974c30e3b70eb1c3d8095d716c4be27ba23d343436bf28fd04f6ac3c9da0de676d079e25b0fc6d68b2e848b289c08
+  data.tar.gz: 44d14037c06a29e2be93da02040464894eedb72fa33b704a96dff152d31e438863e10fad54c69877182267e0f53949ee4d64e3e414a3748785c915e14f73cadf

data/lib/github-pages-health-check.rb

@@ -19,18 +19,19 @@ end
 
 module GitHubPages
   module HealthCheck
-    autoload :CDN,        "github-pages-health-check/cdn"
-    autoload :CloudFlare, "github-pages-health-check/cdns/cloudflare"
-    autoload :Fastly,     "github-pages-health-check/cdns/fastly"
-    autoload :Error,      "github-pages-health-check/error"
-    autoload :Errors,     "github-pages-health-check/errors"
-    autoload :CAA,        "github-pages-health-check/caa"
-    autoload :Checkable,  "github-pages-health-check/checkable"
-    autoload :Domain,     "github-pages-health-check/domain"
-    autoload :Repository, "github-pages-health-check/repository"
-    autoload :Resolver,   "github-pages-health-check/resolver"
-    autoload :Site,       "github-pages-health-check/site"
-    autoload :Printer,    "github-pages-health-check/printer"
+    autoload :CDN,            "github-pages-health-check/cdn"
+    autoload :CloudFlare,     "github-pages-health-check/cdns/cloudflare"
+    autoload :Fastly,         "github-pages-health-check/cdns/fastly"
+    autoload :Error,          "github-pages-health-check/error"
+    autoload :Errors,         "github-pages-health-check/errors"
+    autoload :CAA,            "github-pages-health-check/caa"
+    autoload :Checkable,      "github-pages-health-check/checkable"
+    autoload :Domain,         "github-pages-health-check/domain"
+    autoload :RedundantCheck, "github-pages-health-check/redundant_check"
+    autoload :Repository,     "github-pages-health-check/repository"
+    autoload :Resolver,       "github-pages-health-check/resolver"
+    autoload :Site,           "github-pages-health-check/site"
+    autoload :Printer,        "github-pages-health-check/printer"
 
     # DNS and HTTP timeout, in seconds
     TIMEOUT = 7

data/lib/github-pages-health-check/caa.rb

@@ -2,17 +2,18 @@
 
 require "dnsruby"
 require "public_suffix"
+require "github-pages-health-check/resolver"
 
 module GitHubPages
   module HealthCheck
     class CAA
-      attr_reader :host
-      attr_reader :error
+      attr_reader :host, :error, :nameservers
 
-      def initialize(host)
+      def initialize(host, nameservers: nil)
         raise ArgumentError, "host cannot be nil" if host.nil?
 
         @host = host
+        @nameservers = nameservers
       end
 
       def errored?
@@ -47,11 +48,15 @@ module GitHubPages
       end
 
       def query(domain)
-        GitHubPages::HealthCheck::Resolver.new(domain).query(Dnsruby::Types::CAA)
+        resolver(domain).query(Dnsruby::Types::CAA)
       rescue Dnsruby::ResolvError, Dnsruby::ResolvTimeout => e
         @error = e
         []
       end
+
+      def resolver(domain)
+        GitHubPages::HealthCheck::Resolver.new(domain, :nameservers => nameservers)
+      end
     end
   end
 end

data/lib/github-pages-health-check/domain.rb

@@ -3,7 +3,7 @@
 module GitHubPages
   module HealthCheck
     class Domain < Checkable
-      attr_reader :host
+      attr_reader :host, :resolver, :nameservers
 
       LEGACY_IP_ADDRESSES = [
         # Legacy GitHub Datacenter
@@ -85,16 +85,23 @@ module GitHubPages
         valid_domain? apex_domain? should_be_a_record?
         cname_to_github_user_domain? cname_to_pages_dot_github_dot_com?
         cname_to_fastly? pointed_to_github_pages_ip? pages_domain?
-        served_by_pages? valid_domain? https? enforces_https? https_error
-        https_eligible? caa_error
+        served_by_pages? valid? reason valid_domain?
+        https? enforces_https? https_error https_eligible? caa_error
       ].freeze
 
-      def initialize(host)
+      def self.redundant(host)
+        GitHubPages::HealthCheck::RedundantCheck.new(host).check
+      end
+
+      def initialize(host, nameservers: :default)
         unless host.is_a? String
           raise ArgumentError, "Expected string, got #{host.class}"
         end
 
         @host = normalize_host(host)
+        @nameservers = nameservers
+        @resolver = GitHubPages::HealthCheck::Resolver.new(host,
+          :nameservers => nameservers)
       end
 
       # Runs all checks, raises an error if invalid
@@ -269,10 +276,6 @@ module GitHubPages
         @dns = nil
       end
 
-      def resolver
-        @resolver ||= GitHubPages::HealthCheck::Resolver.new(absolute_domain)
-      end
-
       # Are we even able to get the DNS record?
       def dns?
         !(dns.nil? || dns.empty?)
@@ -371,7 +374,7 @@ module GitHubPages
       private
 
       def caa
-        @caa ||= GitHubPages::HealthCheck::CAA.new(host)
+        @caa ||= GitHubPages::HealthCheck::CAA.new(host, :nameservers => nameservers)
       end
 
       # The domain's response to HTTP(S) requests, following redirects

data/lib/github-pages-health-check/redundant_check.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module GitHubPages
+  module HealthCheck
+    class RedundantCheck
+      extend Forwardable
+
+      TIMEOUT = 5 # seconds
+
+      attr_reader :domain
+
+      def initialize(domain)
+        @domain = domain
+      end
+
+      def check
+        @check ||= (checks.find(&:valid?) || check_with_default_nameservers)
+      end
+
+      def_delegator :check, :reason, :reason
+      def_delegator :check, :valid?, :valid?
+
+      def https_eligible?
+        checks.any?(&:https_eligible?)
+      end
+
+      private
+
+      def checks
+        @checks ||= %i[default authoritative].map do |ns|
+          GitHubPages::HealthCheck::Domain.new(domain, :nameservers => ns)
+        end
+      end
+
+      def check_with_default_nameservers
+        @check_with_default_nameservers ||= checks.find { |c| c.nameservers == :default }
+      end
+    end
+  end
+end

data/lib/github-pages-health-check/repository.rb

@@ -54,7 +54,7 @@ module GitHubPages
 
       def domain
         return if cname.nil?
-        @domain ||= GitHubPages::HealthCheck::Domain.new(cname)
+        @domain ||= GitHubPages::HealthCheck::Domain.redundant(cname)
       end
 
       private

data/lib/github-pages-health-check/resolver.rb

@@ -4,50 +4,53 @@ module GitHubPages
   module HealthCheck
     class Resolver
       DEFAULT_RESOLVER_OPTIONS = {
-        :retry_times => 2,
+        :retry_times   => 2,
         :query_timeout => 5,
-        :dnssec => false
+        :dnssec        => false
       }.freeze
 
-      PREFERS_AUTHORITATIVE_ANSWER = [
-        Dnsruby::Types::A,
-        Dnsruby::Types::CAA,
-        Dnsruby::Types::MX
-      ].freeze
-
       class << self
         def default_resolver
           @default_resolver ||= Dnsruby::Resolver.new(DEFAULT_RESOLVER_OPTIONS)
         end
       end
 
-      attr_reader :domain
+      attr_reader :domain, :nameservers
 
-      def initialize(domain)
+      # Create a new resolver.
+      #
+      # domain - the domain we're getting answers for
+      # nameserver - (optional) a case
+      def initialize(domain, nameservers: :default)
         @domain = domain
+        @nameservers = nameservers
       end
 
       def query(type)
-        if PREFERS_AUTHORITATIVE_ANSWER.include?(type)
-          answer = authoritative_resolver.query(domain, type).answer
-          return answer unless answer.empty?
-        end
-
-        self.class.default_resolver.query(domain, type).answer
-      rescue Dnsruby::ResolvTimeout, Dnsruby::ResolvError
-        self.class.default_resolver.query(domain, type).answer
+        resolver.query(domain, type).answer
       end
 
       private
 
-      def authoritative_resolver
-        return self.class.default_resolver if nameservers.nil? || nameservers.empty?
-
-        Dnsruby::Resolver.new(DEFAULT_RESOLVER_OPTIONS.merge(:nameservers => nameservers))
+      def resolver
+        @resolver ||= case nameservers
+                      when :default
+                        self.class.default_resolver
+                      when :authoritative
+                        Dnsruby::Resolver.new(DEFAULT_RESOLVER_OPTIONS.merge(
+                          :nameservers => authoritative_nameservers
+                        ))
+                      when Array
+                        Dnsruby::Resolver.new(DEFAULT_RESOLVER_OPTIONS.merge(
+                          :nameservers => nameservers
+                        ))
+                      else
+                        raise "Invalid nameserver type: #{nameservers.inspect}"
+                      end
       end
 
-      def nameservers
-        @nameservers ||= begin
+      def authoritative_nameservers
+        @authoritative_nameservers ||= begin
           self.class.default_resolver.query(domain, Dnsruby::Types::NS).answer.map do |rr|
             next rr.nsdname.to_s if rr.type == Dnsruby::Types::NS
           end.compact

data/lib/github-pages-health-check/site.rb

@@ -10,7 +10,7 @@ module GitHubPages
         @domain = @repository.domain
       rescue GitHubPages::HealthCheck::Errors::InvalidRepositoryError
         @repository = nil
-        @domain = Domain.new(repository_or_domain)
+        @domain = Domain.redundant(repository_or_domain)
       end
 
       def check!

data/lib/github-pages-health-check/version.rb

@@ -2,6 +2,6 @@
 
 module GitHubPages
   module HealthCheck
-    VERSION = "1.9.0".freeze
+    VERSION = "1.10.0".freeze
   end
 end

data/script/cibuild

@@ -6,4 +6,6 @@ script/bootstrap
 
 script/test
 script/check-cdn-ips
+bundle exec script/check www.parkermoore.de | grep 'valid?: true'
+bundle exec script/check ben.balter.com | grep 'valid?: true'
 bundle exec gem build github-pages-health-check.gemspec

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-pages-health-check
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - GitHub, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2018-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -200,6 +200,7 @@ files:
 - lib/github-pages-health-check/errors/missing_access_token_error.rb
 - lib/github-pages-health-check/errors/not_served_by_pages_error.rb
 - lib/github-pages-health-check/printer.rb
+- lib/github-pages-health-check/redundant_check.rb
 - lib/github-pages-health-check/repository.rb
 - lib/github-pages-health-check/resolver.rb
 - lib/github-pages-health-check/site.rb