github-pages-health-check 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 091625c0c7a6bde1c78784374bf9f2a0c5dbec4f
-  data.tar.gz: 89d2ec351698812775d18dc61abdb5c3aa9cdd63
+  metadata.gz: ac3f04f1179ebe2da4aba38ad08dfd5939855fb6
+  data.tar.gz: cc6745a890b982f0a6e6b066760177e512d23b3a
 SHA512:
-  metadata.gz: 594c1a1021d27affdb275f780576aeb048402e6588f55c8e88478efce1162cb516c60aec7f7671b57e26ec467f0a16b6f895d1a205918a9dd8f268f0dfaa3c4e
-  data.tar.gz: 7fe3282947ef56e8741dd38a21beea57ee860dfe09bc8e48fe248ead030b4f1f04d20177e4b1dc12f57b0fc47381d8ba821d33b27a4eb84a57e971ffd07a706a
+  metadata.gz: 03633518d82ee979a23eaa4c10ec36a2e55771bbeaf3af5074f784b89a096c9ce3979c33aeaf6bb04f87621eb65aa302d0743d626457d1c1eff3be3fefe05a4f
+  data.tar.gz: 7c04a0b9cd18c6d89a1bc1b539377867f350019beb6239a6a78fb69ba47931f70eb0d29e895788418375feb14134d969887f4f2edd6174b60fa64e175e2f5da5

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

@@ -1,5 +1,6 @@
 require "net/dns"
 require "net/dns/resolver"
+require "addressable/uri"
 require "ipaddr"
 require "public_suffix"
 require "singleton"
@@ -29,6 +30,16 @@ class GitHubPages
       192.30.252.154
     ]
 
+    TYPHOEUS_OPTIONS = {
+      :followlocation  => true,
+      :timeout         => 10,
+      :accept_encoding => "gzip",
+      :method          => :head,
+      :headers         => {
+        "User-Agent"   => "Mozilla/5.0 (compatible; GitHub Pages Health Check/#{VERSION}; +https://github.com/github/pages-health-check)"
+      }
+    }
+
     def initialize(domain)
       @domain = domain
     end
@@ -37,9 +48,21 @@ class GitHubPages
       dns.all? { |answer| answer.class == Net::DNS::RR::A && CloudFlare.controls_ip?(answer.address) }
     end
 
+    # Does this non-GitHub-pages domain proxy a GitHub Pages site?
+    #
+    # This can be:
+    #   1. A Cloudflare-owned IP address
+    #   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 true if cloudflare_ip?
+      return false if pointed_to_github_pages_ip? || pointed_to_github_user_domain?
+      served_by_pages?
+    end
+
     # Returns an array of DNS answers
     def dns
-      @dns ||= without_warnings { Net::DNS::Resolver.start(absolute_domain).answer  } if domain
+      @dns ||= without_warnings { Net::DNS::Resolver.start(absolute_domain).answer } if domain
     rescue Exception
       false
     end
@@ -101,6 +124,8 @@ class GitHubPages
 
     def to_hash
       {
+        :uri                            => uri.to_s,
+        :proxied?                       => proxied?,
         :cloudflare_ip?                 => cloudflare_ip?,
         :old_ip_address?                => old_ip_address?,
         :a_record?                      => a_record?,
@@ -116,9 +141,15 @@ class GitHubPages
         :reason                         => reason
       }
     end
+    alias_method :to_h, :to_hash
 
     def served_by_pages?
-      response = Typhoeus.head(uri, followlocation: true)
+      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.success? && response.headers["Server"] == "GitHub.com"
     end
 
@@ -129,7 +160,7 @@ class GitHubPages
     # Runs all checks, raises an error if invalid
     def check!
       return unless dns
-      return if cloudflare_ip?
+      return if proxied?
       raise DeprecatedIP if a_record? && old_ip_address?
       raise InvalidARecord if valid_domain? && a_record? && !should_be_a_record?
       raise InvalidCNAME if valid_domain? && !github_domain? && !apex_domain? && !pointed_to_github_user_domain?
@@ -187,7 +218,7 @@ class GitHubPages
     end
 
     def uri
-      @uri ||= URI("#{scheme}://#{domain}")
+      @uri ||= Addressable::URI.new(:host => domain, :scheme => scheme, :path => "/").normalize
     end
   end
 end

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

@@ -1,5 +1,5 @@
 class GitHubPages
   class HealthCheck
-    VERSION = "0.3.2"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-pages-health-check
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - GitHub, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-06 00:00:00.000000000 Z
+date: 2015-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-dns
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -70,30 +84,44 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.21'
 description: Checks your GitHub Pages site for commons DNS configuration issues.
 email: support@github.com
 executables: []