github-pages-health-check 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42efe0c8aed8e2ed80f9ac52320d85bf88de688e
-  data.tar.gz: 5b574275227155b07aa0cb39107f9a6d09527d5e
+  metadata.gz: 772a584d8e1bf36334d9bb61fece099e0b03191d
+  data.tar.gz: 52ca8bb64c040312f08c42ffb5ce41b3bf7a3cf8
 SHA512:
-  metadata.gz: eb6ec54346c93947a6afeddf8788c501cd2344e2ebaaaeb18494701ca63e31a485720e586d9b5c69bc62287aeee517fd7290c767d2f95b5ffa34f601f6921a31
-  data.tar.gz: c7affa539aafe96ec648c756d776ad71e8d5040092fb4f25a261e33aee6e3369a2fef9fb469f5e1a3df5b542ab4695c5ea97723f547b7c7f43e62b810b8d4e6a
+  metadata.gz: fbe626e01d4231bcb1f62b032bf1c1e46a3bf565e41923bcec764adaa233ad5a14d14107395aaff624147d359956757d84a3f9617f2003fe7b0400766e193286
+  data.tar.gz: 7d5ac6b67c15fb6e6d5517be3d237919c21b529177bdf68c3a16e01f7ee7cde5948e0e63d13318ac7dcd5dbe52f41260594c76965cb4d7ddc85daf69578ca1cc

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

@@ -6,12 +6,14 @@ require "public_suffix"
 require "singleton"
 require "net/http"
 require 'typhoeus'
+require 'timeout'
 require_relative "github-pages-health-check/version"
 require_relative "github-pages-health-check/cloudflare"
 require_relative "github-pages-health-check/error"
 require_relative "github-pages-health-check/errors/deprecated_ip"
 require_relative "github-pages-health-check/errors/invalid_a_record"
 require_relative "github-pages-health-check/errors/invalid_cname"
+require_relative "github-pages-health-check/errors/invalid_dns"
 require_relative "github-pages-health-check/errors/not_served_by_pages"
 
 class GitHubPages
@@ -30,9 +32,12 @@ class GitHubPages
       192.30.252.154
     ]
 
+    # DNS and HTTP timeout, in seconds
+    TIMEOUT = 10
+
     TYPHOEUS_OPTIONS = {
       :followlocation  => true,
-      :timeout         => 10,
+      :timeout         => TIMEOUT,
       :accept_encoding => "gzip",
       :method          => :head,
       :headers         => {
@@ -45,7 +50,9 @@ class GitHubPages
     end
 
     def cloudflare_ip?
-      dns.all? { |answer| answer.class == Net::DNS::RR::A && CloudFlare.controls_ip?(answer.address) }
+      dns.all? do |answer|
+        answer.class == Net::DNS::RR::A && CloudFlare.controls_ip?(answer.address)
+      end if dns?
     end
 
     # Does this non-GitHub-pages domain proxy a GitHub Pages site?
@@ -55,6 +62,7 @@ class GitHubPages
     #   2. A site that returns GitHub.com server headers, but isn't CNAME'd to a GitHub domain
     #   3. A site that returns GitHub.com server headers, but isn't CNAME'd to a GitHub IP
     def proxied?
+      return unless dns?
       return true if cloudflare_ip?
       return false if pointed_to_github_pages_ip? || pointed_to_github_user_domain?
       served_by_pages?
@@ -62,24 +70,36 @@ class GitHubPages
 
     # Returns an array of DNS answers
     def dns
-      @dns ||= without_warnings { Net::DNS::Resolver.start(absolute_domain).answer } if domain
+      @dns ||= Timeout::timeout(TIMEOUT) do
+        without_warnings do
+          Net::DNS::Resolver.start(absolute_domain).answer if domain
+        end
+      end
     rescue Exception
-      false
+      nil
+    end
+
+    # Are we even able to get the DNS record?
+    def dns?
+      !dns.nil?
     end
+    alias_method :dns_resolves?, :dns
 
     # Does this domain have *any* A record that points to the legacy IPs?
     def old_ip_address?
-      dns.any? { |answer| answer.class == Net::DNS::RR::A && LEGACY_IP_ADDRESSES.include?(answer.address.to_s) }
+      dns.any? do |answer|
+        answer.class == Net::DNS::RR::A && LEGACY_IP_ADDRESSES.include?(answer.address.to_s)
+      end if dns?
     end
 
     # Is this domain's first response an A record?
     def a_record?
-      dns.first.class == Net::DNS::RR::A
+      dns.first.class == Net::DNS::RR::A if dns?
     end
 
     # Is this domain's first response a CNAME record?
     def cname_record?
-      dns.first.class == Net::DNS::RR::CNAME
+      dns.first.class == Net::DNS::RR::CNAME if dns?
     end
 
     # Is this a valid domain that PublicSuffix recognizes?
@@ -102,12 +122,12 @@ class GitHubPages
 
     # Is the domain's first response a CNAME to a pages domain?
     def pointed_to_github_user_domain?
-      dns.first.class == Net::DNS::RR::CNAME && pages_domain?(dns.first.cname.to_s)
+      dns.first.class == Net::DNS::RR::CNAME && pages_domain?(dns.first.cname.to_s) if dns?
     end
 
     # Is the domain's first response an A record to a valid GitHub Pages IP?
     def pointed_to_github_pages_ip?
-      dns.first.class == Net::DNS::RR::A && CURRENT_IP_ADDRESSES.include?(dns.first.value)
+      dns.first.class == Net::DNS::RR::A && CURRENT_IP_ADDRESSES.include?(dns.first.value) if dns?
     end
 
     # Is the given cname a pages domain?
@@ -125,6 +145,7 @@ class GitHubPages
     def to_hash
       {
         :uri                            => uri.to_s,
+        :dns_resolves?                  => dns?,
         :proxied?                       => proxied?,
         :cloudflare_ip?                 => cloudflare_ip?,
         :old_ip_address?                => old_ip_address?,
@@ -144,14 +165,16 @@ class GitHubPages
     alias_method :to_h, :to_hash
 
     def served_by_pages?
-      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)
+      @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
+
+        (response.mock? || response.return_code == :ok) && response.headers["Server"] == "GitHub.com"
       end
-      
-      (response.mock? || response.return_code == :ok) && response.headers["Server"] == "GitHub.com"
     end
 
     def to_json
@@ -160,7 +183,7 @@ class GitHubPages
 
     # Runs all checks, raises an error if invalid
     def check!
-      return unless dns
+      raise InvalidDNS unless dns?
       return if proxied?
       raise DeprecatedIP if a_record? && old_ip_address?
       raise InvalidARecord if valid_domain? && a_record? && !should_be_a_record?

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

@@ -1,5 +1,5 @@
 class GitHubPages
   class HealthCheck
-    VERSION = "0.4.2"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-pages-health-check
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - GitHub, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-12 00:00:00.000000000 Z
+date: 2015-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-dns