github-pages-health-check 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55c8b9311f05c9c89c57e74f4e47700964f97b16
-  data.tar.gz: 7bf75965fb566b0bd9c6a5945cb073bea18a6fdc
+  metadata.gz: 132f9dcae46fe334470c7bc86fb3b98ba4e895cd
+  data.tar.gz: 0ff1b4b2bd51d97011f065208b779990d1a86184
 SHA512:
-  metadata.gz: 611f792db12ab0f8ea674a4368c2300126340a0da1a2d4d6c0e8974ac07b498a0d488d01b1ecd193c314b473357836b25743daa6f538ffd71be3462aca7b2806
-  data.tar.gz: af8a4e34b798af708a3df0cbe8dafaa5d49e7b987ba9e1ac846d1f215ce278f5f37d2f34c0e71dacfa22e5d8cf0366b8b3bd6675a87a9271c31d0a7a1c16fcb4
+  metadata.gz: d9e2d427d05ce7396e9cb1924230aa2736ea102da7b831615a2611153e67523ddf4f8190e01d5119fa67513d7230b39cf6231014b73df04505ca82e55e84f776
+  data.tar.gz: 7650c557747924073b9e2e46f2ba7107a4a3a2130ae5b2ea86d964f6ca5dcacd8e9efa13ec20d427f2de92189b3599d19c88b02e3ab4d399d1af03eb10dccee1

data/.ruby-version

@@ -1 +1 @@
-2.1.7-github
+2.3.1

data/github-pages-health-check.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.require_paths         = ['lib']
 
   s.add_dependency("net-dns", "~> 0.8")
-  s.add_dependency("public_suffix", "~> 1.4")
+  s.add_dependency("public_suffix", "~> 2.0")
   s.add_dependency("typhoeus", "~> 0.7")
   s.add_dependency("addressable", "~> 2.3")
   s.add_dependency("octokit", "~> 4.0")

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

@@ -21,11 +21,11 @@ module GitHubPages
 
       HASH_METHODS = [
         :host, :uri, :dns_resolves?, :proxied?, :cloudflare_ip?, :fastly_ip?,
-        :old_ip_address?, :a_record?, :cname_record?, :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?
+        :old_ip_address?, :a_record?, :cname_record?, :mx_records_present?,
+        :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
       ].freeze
 
       def initialize(host)
@@ -64,7 +64,7 @@ module GitHubPages
           return false unless valid_domain?
           return false if github_domain? || apex_domain?
           return true  if cname_to_pages_dot_github_dot_com? || cname_to_fastly?
-          !cname_to_github_user_domain?
+          !cname_to_github_user_domain? && should_be_cname_record?
         end
       end
 
@@ -72,7 +72,7 @@ module GitHubPages
       # Used as an escape hatch to prevent false positives on DNS checkes
       def valid_domain?
         return @valid if defined? @valid
-        @valid = PublicSuffix.valid?(host)
+        @valid = PublicSuffix.valid?(host, default_rule: nil)
       end
 
       # Is this domain an apex domain, meaning a CNAME would be innapropriate
@@ -94,7 +94,11 @@ module GitHubPages
 
       # Should the domain be an apex record?
       def should_be_a_record?
-        !pages_domain? && apex_domain?
+        !pages_domain? && (apex_domain? || mx_records_present?)
+      end
+
+      def should_be_cname_record?
+        !should_be_a_record?
       end
 
       # Is the domain's first response an A record to a valid GitHub Pages IP?
@@ -170,13 +174,20 @@ module GitHubPages
         return unless valid_domain?
         @dns = Timeout.timeout(TIMEOUT) do
           GitHubPages::HealthCheck.without_warnings do
-            Net::DNS::Resolver.start(absolute_domain).answer unless host.nil?
+            unless host.nil?
+              resolver.search(absolute_domain, Net::DNS::A).answer +
+                resolver.search(absolute_domain, Net::DNS::MX).answer
+            end
           end
         end
       rescue StandardError
         @dns = nil
       end
 
+      def resolver
+        @resolver ||= Net::DNS::Resolver.new
+      end
+
       # Are we even able to get the DNS record?
       def dns?
         !(dns.nil? || dns.empty?)
@@ -199,30 +210,28 @@ module GitHubPages
       # Is this domain's first response a CNAME record?
       def cname_record?
         return unless dns?
-        dns.first.class == Net::DNS::RR::CNAME
+        return false unless cname
+        cname.valid_domain?
       end
       alias cname? cname_record?
 
       # The domain to which this domain's CNAME resolves
       # Returns nil if the domain is not a CNAME
       def cname
-        return unless cname?
+        return unless dns.first.class == Net::DNS::RR::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 }
+      end
+
       def served_by_pages?
         return @served_by_pages if defined? @served_by_pages
         return unless dns_resolves?
 
         @served_by_pages = begin
-          response = Typhoeus.head(uri, TYPHOEUS_OPTIONS)
-
-          # Workaround for webmock not playing nicely with Typhoeus redirects
-          # See https://github.com/bblimke/webmock/issues/237
-          if response.mock? && response.headers["Location"]
-            response = Typhoeus.head(response.headers["Location"], TYPHOEUS_OPTIONS)
-          end
-
           return false unless response.mock? || response.return_code == :ok
           return true if response.headers["Server"] == "GitHub.com"
 
@@ -231,15 +240,59 @@ module GitHubPages
         end
       end
 
-      def uri
-        @uri ||= begin
-          options = { :host => host, :scheme => scheme, :path => "/" }
-          Addressable::URI.new(options).normalize.to_s
-        end
+      def uri(overrides={})
+        options = { :host => host, :scheme => scheme, :path => "/" }
+        options = options.merge(overrides)
+        Addressable::URI.new(options).normalize.to_s
+      end
+
+      # Does this domain respond to HTTPS requests with a valid cert?
+      def https?
+        https_response.return_code == :ok
+      end
+
+      # The response code of the HTTPS request, if it failed.
+      # Useful for diagnosing cert errors
+      def https_error
+        https_response.return_code unless https?
+      end
+
+      # Does this domain redirect HTTP requests to HTTPS?
+      def enforces_https?
+        return false unless https? && http_response.headers["Location"]
+        redirect = Addressable::URI.parse(http_response.headers["Location"])
+        redirect.scheme == "https" && redirect.host == host
       end
 
       private
 
+      # The domain's response to HTTP(S) requests, following redirects
+      def response
+        return @response if defined? @response
+
+        @response = Typhoeus.head(uri, TYPHOEUS_OPTIONS)
+
+        # Workaround for webmock not playing nicely with Typhoeus redirects
+        # See https://github.com/bblimke/webmock/issues/237
+        if @response.mock? && @response.headers["Location"]
+          @response = Typhoeus.head(response.headers["Location"], TYPHOEUS_OPTIONS)
+        end
+
+        @response
+      end
+
+      # The domain's response to HTTP requests, without following redirects
+      def http_response
+        options = TYPHOEUS_OPTIONS.merge(:followlocation => false )
+        @http_response ||= Typhoeus.head(uri(:scheme => "http"), options)
+      end
+
+      # The domain's response to HTTPS requests, without following redirects
+      def https_response
+        options = TYPHOEUS_OPTIONS.merge(:followlocation => false )
+        @https_response ||= Typhoeus.head(uri(:scheme => "https"), options)
+      end
+
       # Parse the URI. Accept either domain names or full URI's.
       # Used by the initializer so we can be more flexible with inputs.
       #

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

@@ -1,5 +1,5 @@
 module GitHubPages
   module HealthCheck
-    VERSION = "1.2.0"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-pages-health-check
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - GitHub, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-09 00:00:00.000000000 Z
+date: 2016-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-dns
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -215,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Checks your GitHub Pages site for commons DNS configuration issues