github-pages-health-check 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0dbdf2a06e0dd18317636a5ba612d2a9981265b7
-  data.tar.gz: 1bab87a2e891996ec1bd64bfe5ba1160c3e5fb01
+  metadata.gz: a5c72a3c5e782d9a27d272b02043fa00e0e103a2
+  data.tar.gz: 635f03b9715d8c2865c8ccea3f7b530d69d47597
 SHA512:
-  metadata.gz: c0d9742f1de9b2b73fa4c46bacbfa3f684e68b1a9695da15e91541d0a6a3fc5359676b83ea69f06fb5e63836d3a94bb3ff736e74d2269083057413555f684da0
-  data.tar.gz: a21cc8495ef9e39e7f7e8991c9e4a831df5f86b6dcfbbe8ca6af67d9a5f67e94e192b0c7f8da36308796d365c46af0f9bf0610a5f08a2e88f2899b41cfb6d5f3
+  metadata.gz: a07681c650945cbc8a924967d1fc53d57d8cb72c5a80d1cbd90dd9b25fe060e04fef795797c51104f06217ccfcfa65784a352607d8e3c90f9c04486566004cca
+  data.tar.gz: 002eb4f6d72eea2fd1db10d12083690ef8a4ce8f5587f5a049bee52fec6af7bb057b0878dc32df1d7e629f8b661846e724239a5c1e24182e084dd14ac462788b

data/.rubocop.yml

@@ -17,13 +17,14 @@
 #
 
 AllCops:
+  TargetRubyVersion: 2.4
   Exclude:
     - 'bin/**/*'
     - 'script/**/*'
     - 'vendor/**/*'
     - 'test-site/**/*'
 
-Lint/EndAlignment:
+Layout/EndAlignment:
   Severity: error
 
 Lint/UnreachableCode:
@@ -119,9 +120,6 @@ Style/PercentLiteralDelimiters:
     '%W': '()'
     '%x': '()'
 
-AllCops:
-  TargetRubyVersion: 2.2
-
 Style/Documentation:
   Enabled: false
 
@@ -149,3 +147,10 @@ Style/DoubleNegation:
 Layout/EmptyLineAfterMagicComment:
   Exclude:
     - script/*
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  Severity: error
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/github-pages-health-check.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require File.expand_path("../lib/github-pages-health-check/version", __FILE__)
+require File.expand_path("lib/github-pages-health-check/version", __dir__)
 
 Gem::Specification.new do |s|
   s.required_ruby_version = ">= 2.2.0"
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.require_paths         = ["lib"]
 
   s.add_dependency("addressable", "~> 2.3")
-  s.add_dependency("net-dns", "~> 0.8")
+  s.add_dependency("dnsruby", "~> 1.60")
   s.add_dependency("octokit", "~> 4.0")
   s.add_dependency("public_suffix", "~> 2.0")
   s.add_dependency("typhoeus", "~> 1.3")

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

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require "net/dns"
-require "net/dns/resolver"
+require "dnsruby"
 require "addressable/uri"
 require "ipaddr"
 require "public_suffix"
@@ -25,6 +24,7 @@ module GitHubPages
     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"
@@ -34,9 +34,9 @@ module GitHubPages
     # DNS and HTTP timeout, in seconds
     TIMEOUT = 5
 
-    HUMAN_NAME = "GitHub Pages Health Check".freeze
-    URL = "https://github.com/github/pages-health-check".freeze
-    USER_AGENT = "Mozilla/5.0 (compatible; #{HUMAN_NAME}/#{VERSION}; +#{URL})".freeze
+    HUMAN_NAME = "GitHub Pages Health Check"
+    URL = "https://github.com/github/pages-health-check"
+    USER_AGENT = "Mozilla/5.0 (compatible; #{HUMAN_NAME}/#{VERSION}; +#{URL})"
 
     TYPHOEUS_OPTIONS = {
       :followlocation => true,

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "dnsruby"
+require "public_suffix"
+
+module GitHubPages
+  module HealthCheck
+    class CAA
+      attr_reader :host
+      attr_reader :error
+
+      def initialize(host)
+        @host = host
+      end
+
+      def errored?
+        records # load the records first
+        !error.nil?
+      end
+
+      def lets_encrypt_allowed?
+        return false if errored?
+        return true unless records_present?
+        records.any? { |r| r.property_value == "letsencrypt.org" }
+      end
+
+      def records_present?
+        return false if errored?
+        records && !records.empty?
+      end
+
+      def records
+        @records ||= (get_caa_records(host) | get_caa_records(PublicSuffix.domain(host)))
+      end
+
+      def get_caa_records(domain)
+        resolver = Dnsruby::Resolver.new
+        resolver.retry_times = 2
+        resolver.query_timeout = 2
+        nspack = begin
+          resolver.query(domain, "CAA", "IN")
+        rescue StandardError => e
+          @error = e
+          return []
+        end
+        nspack.answer.select { |r| r.type == "CAA" && r.property_tag == "issue" }
+      end
+    end
+  end
+end

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

@@ -21,7 +21,7 @@ module GitHubPages
 
       # Internal: Does this CDN control this address?
       def controls_ip?(address)
-        ranges.any? { |range| range.include?(address) }
+        ranges.any? { |range| range.include?(address.to_s) }
       end
 
       private

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

@@ -28,7 +28,7 @@ module GitHubPages
       end
 
       def to_hash
-        @hash ||= begin
+        @to_hash ||= begin
           hash = {}
           self.class::HASH_METHODS.each do |method|
             hash[method] = public_send(method)

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

@@ -78,6 +78,7 @@ module GitHubPages
         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
       ].freeze
 
       def initialize(host)
@@ -151,7 +152,7 @@ module GitHubPages
 
       # Is the domain's first response an A record to a valid GitHub Pages IP?
       def pointed_to_github_pages_ip?
-        a_record? && CURRENT_IP_ADDRESSES.include?(dns.first.value)
+        a_record? && CURRENT_IP_ADDRESSES.include?(dns.first.address.to_s)
       end
 
       # Is the domain's first response a CNAME to a pages domain?
@@ -226,10 +227,8 @@ module GitHubPages
         return unless valid_domain?
         @dns = Timeout.timeout(TIMEOUT) do
           GitHubPages::HealthCheck.without_warnings do
-            unless host.nil?
-              resolver.search(absolute_domain, Net::DNS::A).answer +
-                resolver.search(absolute_domain, Net::DNS::MX).answer
-            end
+            next if host.nil?
+            resolver.query(absolute_domain, Dnsruby::Types::ANY).answer
           end
         end
       rescue StandardError
@@ -237,7 +236,10 @@ module GitHubPages
       end
 
       def resolver
-        @resolver ||= Net::DNS::Resolver.new
+        @resolver ||= Dnsruby::Resolver.new
+        @resolver.retry_times = 2
+        @resolver.query_timeout = 2
+        @resolver
       end
 
       # Are we even able to get the DNS record?
@@ -251,14 +253,14 @@ module GitHubPages
         return unless dns?
 
         dns.any? do |answer|
-          answer.is_a?(Net::DNS::RR::A) && legacy_ip?(answer.address.to_s)
+          answer.type == Dnsruby::Types::A && legacy_ip?(answer.address.to_s)
         end
       end
 
       # Is this domain's first response an A record?
       def a_record?
         return unless dns?
-        dns.first.class == Net::DNS::RR::A
+        dns.first.type == Dnsruby::Types::A
       end
 
       # Is this domain's first response a CNAME record?
@@ -272,13 +274,13 @@ module GitHubPages
       # The domain to which this domain's CNAME resolves
       # Returns nil if the domain is not a CNAME
       def cname
-        return unless dns.first.class == Net::DNS::RR::CNAME
+        return unless dns.first.type == Dnsruby::Types::CNAME
         @cname ||= Domain.new(dns.first.cname.to_s)
       end
 
       def mx_records_present?
         return unless dns?
-        dns.any? { |answer| answer.class == Net::DNS::RR::MX }
+        dns.any? { |answer| answer.type == Dnsruby::Types::MX }
       end
 
       def served_by_pages?
@@ -318,8 +320,23 @@ module GitHubPages
         redirect.scheme == "https" && redirect.host == host
       end
 
+      # Can an HTTPS certificate be issued for this domain?
+      def https_eligible?
+        (cname_to_github_user_domain? || fastly_ip?) && caa.lets_encrypt_allowed?
+      end
+
+      # Any errors querying CAA records
+      def caa_error
+        return nil if caa.error.nil?
+        caa.error.class.name
+      end
+
       private
 
+      def caa
+        @caa ||= GitHubPages::HealthCheck::CAA.new(absolute_domain)
+      end
+
       # The domain's response to HTTP(S) requests, following redirects
       def response
         return @response if defined? @response
@@ -387,7 +404,7 @@ module GitHubPages
       def cdn_ip?(cdn)
         return unless dns?
 
-        a_records = dns.select { |answer| answer.class == Net::DNS::RR::A }
+        a_records = dns.select { |answer| answer.type == Dnsruby::Types::A }
         return false if !a_records || a_records.empty?
 
         a_records.all? do |answer|
@@ -395,8 +412,8 @@ module GitHubPages
         end
       end
 
-      def legacy_ip?(ip)
-        LEGACY_IP_ADDRESSES.include?(ip)
+      def legacy_ip?(ip_addr)
+        LEGACY_IP_ADDRESSES.include?(ip_addr)
       end
     end
   end

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

@@ -3,8 +3,8 @@
 module GitHubPages
   module HealthCheck
     class Error < StandardError
-      DOCUMENTATION_BASE = "https://help.github.com".freeze
-      DOCUMENTATION_PATH = "/categories/github-pages-basics/".freeze
+      DOCUMENTATION_BASE = "https://help.github.com"
+      DOCUMENTATION_PATH = "/categories/github-pages-basics/"
       LOCAL_ONLY = false # Error is only used when running locally
 
       attr_reader :repository, :domain
@@ -30,7 +30,7 @@ module GitHubPages
       # Error message, with get more info URL appended
       def message_with_url
         msg = message.gsub(/\s+/, " ").squeeze(" ").strip
-        msg << "." unless msg =~ /\.$/ # add trailing period if not there
+        msg << "." unless msg.match?(/\.$/) # add trailing period if not there
         "#{msg} #{more_info}"
       end
       alias message_formatted message_with_url

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Dir[File.expand_path("../errors/*_error.rb", __FILE__)].each do |f|
+Dir[File.expand_path("errors/*_error.rb", __dir__)].each do |f|
   require f
 end
 

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

@@ -4,7 +4,7 @@ module GitHubPages
   module HealthCheck
     module Errors
       class BuildError < GitHubPages::HealthCheck::Error
-        DOCUMENTATION_PATH = "/articles/troubleshooting-jekyll-builds/".freeze
+        DOCUMENTATION_PATH = "/articles/troubleshooting-jekyll-builds/"
         LOCAL_ONLY = true
       end
     end

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

@@ -4,7 +4,7 @@ module GitHubPages
   module HealthCheck
     module Errors
       class DeprecatedIPError < GitHubPages::HealthCheck::Error
-        DOCUMENTATION_PATH = "/articles/setting-up-a-custom-domain-with-github-pages/".freeze
+        DOCUMENTATION_PATH = "/articles/setting-up-a-custom-domain-with-github-pages/"
 
         def message
           <<-MSG

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

@@ -4,7 +4,7 @@ module GitHubPages
   module HealthCheck
     module Errors
       class InvalidARecordError < GitHubPages::HealthCheck::Error
-        DOCUMENTATION_PATH = "/articles/setting-up-a-custom-domain-with-github-pages/".freeze
+        DOCUMENTATION_PATH = "/articles/setting-up-a-custom-domain-with-github-pages/"
 
         def message
           <<-MSG

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

@@ -4,7 +4,7 @@ module GitHubPages
   module HealthCheck
     module Errors
       class InvalidCNAMEError < GitHubPages::HealthCheck::Error
-        DOCUMENTATION_PATH = "/articles/setting-up-a-custom-domain-with-github-pages/".freeze
+        DOCUMENTATION_PATH = "/articles/setting-up-a-custom-domain-with-github-pages/"
 
         def message
           <<-MSG

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

@@ -4,7 +4,7 @@ module GitHubPages
   module HealthCheck
     module Errors
       class InvalidDNSError < GitHubPages::HealthCheck::Error
-        DOCUMENTATION_PATH = "/articles/setting-up-a-custom-domain-with-github-pages/".freeze
+        DOCUMENTATION_PATH = "/articles/setting-up-a-custom-domain-with-github-pages/"
 
         def message
           "Domain's DNS record could not be retrieved"

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

@@ -4,7 +4,7 @@ module GitHubPages
   module HealthCheck
     module Errors
       class InvalidDomainError < GitHubPages::HealthCheck::Error
-        DOCUMENTATION_PATH = "/articles/setting-up-a-custom-domain-with-github-pages/".freeze
+        DOCUMENTATION_PATH = "/articles/setting-up-a-custom-domain-with-github-pages/"
 
         def message
           "Domain is not a valid domain"

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

@@ -4,7 +4,7 @@ module GitHubPages
   module HealthCheck
     module Errors
       class NotServedByPagesError < GitHubPages::HealthCheck::Error
-        DOCUMENTATION_PATH = "/articles/setting-up-a-custom-domain-with-github-pages/".freeze
+        DOCUMENTATION_PATH = "/articles/setting-up-a-custom-domain-with-github-pages/"
 
         def message
           "Domain does not resolve to the GitHub Pages server"

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

@@ -4,7 +4,7 @@ module GitHubPages
   module HealthCheck
     class Printer
       PRETTY_LEFT_WIDTH = 11
-      PRETTY_JOINER = " | ".freeze
+      PRETTY_JOINER = " | "
 
       attr_reader :health_check
 

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

@@ -12,7 +12,7 @@ module GitHubPages
       ].freeze
 
       def initialize(name_with_owner, access_token: nil)
-        unless name_with_owner =~ REPO_REGEX
+        unless name_with_owner.match?(REPO_REGEX)
           raise Errors::InvalidRepositoryError
         end
         parts = name_with_owner.split("/")
@@ -45,11 +45,11 @@ module GitHubPages
       alias reason build_error
 
       def build_duration
-        last_build.duration if last_build
+        last_build&.duration
       end
 
       def last_built
-        last_build.updated_at if last_build
+        last_build&.updated_at
       end
 
       def domain

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

@@ -14,7 +14,7 @@ module GitHubPages
       end
 
       def check!
-        [domain, repository].each { |check| check.check! if check }
+        [domain, repository].each { |check| check&.check! }
         true
       end
 

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

@@ -2,6 +2,6 @@
 
 module GitHubPages
   module HealthCheck
-    VERSION = "1.4.0".freeze
+    VERSION = "1.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-pages-health-check
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - GitHub, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-16 00:00:00.000000000 Z
+date: 2018-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: net-dns
+  name: dnsruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.60'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.60'
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -182,6 +182,7 @@ files:
 - config/fastly-ips.txt
 - github-pages-health-check.gemspec
 - lib/github-pages-health-check.rb
+- lib/github-pages-health-check/caa.rb
 - lib/github-pages-health-check/cdn.rb
 - lib/github-pages-health-check/cdns/cloudflare.rb
 - lib/github-pages-health-check/cdns/fastly.rb