github-pages-health-check 0.6.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a76a2726cf101e5e0b31295968533bc118eca9b
-  data.tar.gz: 78b1175bfb6c4de74c3a8a4303ab25a644805d86
+  metadata.gz: f39bbd059617a66074ecfefd2e099a8642f8f02a
+  data.tar.gz: 3d515c8fa894e296b042c23ca6729849f1fcc114
 SHA512:
-  metadata.gz: 4d121a12f58aabe94583eac1561bd76e87805ce0712aada99c31d84918c02717a46a226191b8a409adecb23f55c5007d7f23e7929099f34f3a5966b7e1dfd076
-  data.tar.gz: c25ace49dcb5c559791dc471b5ef847f0fb4a9b3d2a7718b21c489fbee01ec31e9bce61001fac55646932562b10f5bcdbe919a2dcd9681988fe52e7751c0905e
+  metadata.gz: 4687d324883562a5424f698643b1beed8bd737581e8d07ba0a5090990016dd68409790c4f075ca96e4fccef7c49b94ae0063cd7eaa0aa1cd3313e0216c55aac9
+  data.tar.gz: d3545668fa5b774dbf5b7d74ecbb1fc37ea97d36e55242f32221e087ba1bca1cc26f315126d4b9b3059a806f99175774c2b777918e4a2f4f87c4168ca6ee93eb

data/.gitignore

@@ -0,0 +1,6 @@
+/*.gem
+*.lock
+.bundle
+vendor/gems
+/bin
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-version

@@ -0,0 +1 @@
+2.1.7-github

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+script: "script/cibuild"
+install:
+  - sudo bash -c 'echo search github.com >> /etc/resolv.conf'
+cache: bundler
+rvm: 2.1.7

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,83 @@
+# GitHub Pages Health Check
+
+*Checks your GitHub Pages site for common DNS configuration issues*
+
+[![Build Status](https://travis-ci.org/github/pages-health-check.svg)](https://travis-ci.org/github/pages-health-check) [![Gem Version](https://badge.fury.io/rb/github-pages-health-check.svg)](http://badge.fury.io/rb/github-pages-health-check)
+
+## Installation
+
+`gem install github-pages-health-check`
+
+## Usage
+
+### Basic Usage
+
+```ruby
+> check = GitHubPages::HealthCheck::Site.new("choosealicense.com")
+=> #<GitHubPages::HealthCheck::Site @domain="choosealicense.com" valid?=true>
+> check.valid?
+=> true
+```
+
+### An invalid domain
+
+```ruby
+> check = GitHubPages::HealthCheck::Site.new("foo.github.com")
+> check.valid?
+=> false
+> check.valid!
+raises GitHubPages::HealthCheck::Errors::InvalidCNAMEError
+```
+
+
+### Retrieving specific checks
+
+``` ruby
+> check.domain.should_be_a_record?
+=> true
+> check.domain.a_record?
+=> true
+```
+
+### Getting checks in bulk
+
+```ruby
+> check.to_hash
+=> {
+ :cloudflare_ip?=>false,
+ :old_ip_address?=>false,
+ :a_record?=>true,
+ :cname_record?=>false,
+ :valid_domain?=>true,
+ :apex_domain?=>true,
+ :should_be_a_record?=>true,
+ :pointed_to_github_user_domain?=>false,
+ :pointed_to_github_pages_ip?=>false,
+ :pages_domain?=>false,
+ :valid?=>true
+}
+> check.to_json
+=> "{\"cloudflare_ip?\":false,\"old_ip_address?\":false,\"a_record?\":true,\"cname_record?\":false,\"valid_domain?\":true,\"apex_domain?\":true,\"should_be_a_record?\":true,\"pointed_to_github_user_domain?\":false,\"pointed_to_github_pages_ip?\":false,\"pages_domain?\":false,\"valid?\":true}"
+```
+
+### Getting the reason a domain is invalid
+
+```ruby
+> check = GitHubPages::HealthCheck::Site.new "developer.facebook.com"
+> check.valid?
+=> false
+> check.reason
+=> #<GitHubPages::HealthCheck::InvalidCNAME>
+> check.reason.message
+=> "CNAME does not point to GitHub Pages"
+```
+
+### Repository checks
+
+Repository checks require a personal access or OAuth token with `repo` or scope. This can be passed as the second argument to the Site or Repository constructors like so:
+
+```ruby
+check = GitHubPages::HealthCheck::Site.new "github/pages-health-check", access_token: "1234
+```
+
+You can also set `OCTOKIT_ACCESS_TOKEN` as an environmental variable, or via a `.env` file in your working directory.

data/github-pages-health-check.gemspec

@@ -0,0 +1,28 @@
+require File.expand_path("../lib/github-pages-health-check/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.required_ruby_version = ">= 1.9.3"
+
+  s.name                  = "github-pages-health-check"
+  s.version               = GitHubPages::HealthCheck::VERSION
+  s.summary               = "Checks your GitHub Pages site for commons DNS configuration issues"
+  s.description           = "Checks your GitHub Pages site for commons DNS configuration issues."
+  s.authors               = "GitHub, Inc."
+  s.email                 = "support@github.com"
+  s.homepage              = "https://github.com/github/github-pages-health-check"
+  s.license               = "MIT"
+  s.files                 = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.require_paths         = ['lib']
+
+  s.add_dependency("net-dns", "~> 0.8")
+  s.add_dependency("public_suffix", "~> 1.4")
+  s.add_dependency("typhoeus", "~> 0.7")
+  s.add_dependency("addressable", "~> 2.3")
+  s.add_dependency("octokit", "~> 4.0")
+
+  s.add_development_dependency("rspec", "~> 3.0")
+  s.add_development_dependency("pry", "~> 0.10")
+  s.add_development_dependency("gem-release", "~> 0.7")
+  s.add_development_dependency("webmock", "~> 1.21")
+  s.add_development_dependency("dotenv", "~> 1.0")
+end

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

@@ -8,30 +8,25 @@ require "net/http"
 require "typhoeus"
 require "resolv"
 require "timeout"
+require "octokit"
 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
-  class HealthCheck
-
-    attr_accessor :domain
+if File.exists?(File.expand_path "../.env", File.dirname(__FILE__))
+  require 'dotenv'
+  Dotenv.load
+end
 
-    LEGACY_IP_ADDRESSES = %w[
-      207.97.227.245
-      204.232.175.78
-      199.27.73.133
-    ]
+module GitHubPages
+  module HealthCheck
 
-    CURRENT_IP_ADDRESSES = %w[
-      192.30.252.153
-      192.30.252.154
-    ]
+    autoload :CloudFlare, "github-pages-health-check/cloudflare"
+    autoload :Error,      "github-pages-health-check/error"
+    autoload :Errors,     "github-pages-health-check/errors"
+    autoload :Checkable,  "github-pages-health-check/checkable"
+    autoload :Domain,     "github-pages-health-check/domain"
+    autoload :Repository, "github-pages-health-check/repository"
+    autoload :Site,       "github-pages-health-check/site"
+    autoload :Printer,    "github-pages-health-check/printer"
 
     # DNS and HTTP timeout, in seconds
     TIMEOUT = 10
@@ -46,238 +41,16 @@ class GitHubPages
       }
     }
 
-    def initialize(domain)
-      @domain = host_from_uri(domain)
-    end
-
-    def cloudflare_ip?
-      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?
-    #
-    # 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 unless dns?
-      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
-      if @dns.nil?
-        begin
-          @dns = Timeout::timeout(TIMEOUT) do
-            without_warnings do
-              Net::DNS::Resolver.start(absolute_domain).answer if domain
-            end
-          end
-          @dns ||= false
-        rescue Exception
-          @dns = false
-        end
-      end
-      @dns || nil
-    end
-
-    # Are we even able to get the DNS record?
-    def dns?
-      !dns.nil? && !dns.empty?
-    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? 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 if dns?
-    end
-
-    # Is this domain's first response a CNAME record?
-    def cname_record?
-      dns.first.class == Net::DNS::RR::CNAME if dns?
-    end
-
-    # Is this a valid domain that PublicSuffix recognizes?
-    # Used as an escape hatch to prevent false positives on DNS checkes
-    def valid_domain?
-      PublicSuffix.valid? domain
-    end
-
-    # Is this domain an apex domain, meaning a CNAME would be innapropriate
-    def apex_domain?
-      return @apex_domain if defined?(@apex_domain)
-
-      answers = Resolv::DNS.open { |dns|
-        dns.getresources(absolute_domain, Resolv::DNS::Resource::IN::NS)
-      }
-
-      @apex_domain = answers.any?
-    end
-
-    # Should the domain be an apex record?
-    def should_be_a_record?
-      !pages_domain? && apex_domain?
-    end
-
-    # 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) 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) if dns?
-    end
-
-    # Is the given cname a pages domain?
-    #
-    # domain - the domain to check, generaly the target of a cname
-    def pages_domain?(domain = domain())
-      !!domain.match(/^[\w-]+\.github\.(io|com)\.?$/i)
-    end
-
-    # Is this domain owned by GitHub?
-    def github_domain?
-      !!domain.match(/\.github\.com$/)
-    end
-
-    def to_hash
-      {
-        :uri                            => uri.to_s,
-        :dns_resolves?                  => dns?,
-        :proxied?                       => proxied?,
-        :cloudflare_ip?                 => cloudflare_ip?,
-        :old_ip_address?                => old_ip_address?,
-        :a_record?                      => a_record?,
-        :cname_record?                  => cname_record?,
-        :valid_domain?                  => valid_domain?,
-        :apex_domain?                   => apex_domain?,
-        :should_be_a_record?            => should_be_a_record?,
-        :pointed_to_github_user_domain? => pointed_to_github_user_domain?,
-        :pointed_to_github_pages_ip?    => pointed_to_github_pages_ip?,
-        :pages_domain?                  => pages_domain?,
-        :served_by_pages?               => served_by_pages?,
-        :valid?                         => valid?,
-        :reason                         => reason
-      }
-    end
-    alias_method :to_h, :to_hash
-
-    def served_by_pages?
-      return @served_by_pages if defined? @served_by_pages
-      @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"
-
-        # Typhoeus mangles the case of the header, compare insensitively
-        response.headers.any? { |k,v| k =~ /X-GitHub-Request-Id/i }
-      end
-    end
-
-    def to_json
-      to_hash.to_json
-    end
-
-    # Runs all checks, raises an error if invalid
-    def check!
-      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?
-      raise InvalidCNAME if valid_domain? && !github_domain? && !apex_domain? && !pointed_to_github_user_domain?
-      raise NotServedByPages unless served_by_pages?
-      true
-    end
-    alias_method :valid!, :check!
-
-    # Runs all checks, returns true if valid, otherwise false
-    def valid?
-      check!
-      true
-    rescue
-      false
-    end
-
-    # Return the error, if any
-    def reason
-      check!
-      nil
-    rescue GitHubPages::HealthCheck::Error => e
-      e
-    end
-
-    def inspect
-      "#<GitHubPages::HealthCheck @domain=\"#{domain}\" valid?=#{valid?}>"
-    end
-
-    def to_s
-      to_hash.inject(Array.new) do |all, pair|
-        all.push pair.join(": ")
-      end.join("\n")
-    end
-
-    private
-
     # surpress warn-level feedback due to unsupported record types
-    def without_warnings(&block)
+    def self.without_warnings(&block)
       warn_level, $VERBOSE = $VERBOSE, nil
       result = block.call
       $VERBOSE = warn_level
       result
     end
 
-    # Adjust `domain` so that it won't be searched for with /etc/resolv.conf's search rules.
-    #
-    #     GitHubPages::HealthCheck.new("anything.io").absolute_domain
-    #     => "anything.io."
-    def absolute_domain
-      domain.end_with?(".") ? domain : "#{domain}."
-    end
-
-    def scheme
-      @scheme ||= github_domain? ? "https" : "http"
-    end
-
-    def uri
-      @uri ||= Addressable::URI.new(:host => domain, :scheme => scheme, :path => "/").normalize
-    end
-
-    # Parse the URI. Accept either domain names or full URI's.
-    # Used by the initializer so we can be more flexible with inputs.
-    #
-    # domain - a URI or domain name.
-    #
-    # Examples
-    #
-    #   host_from_uri("benbalter.github.com")
-    #   # => 'benbalter.github.com'
-    #   host_from_uri("https://benbalter.github.com")
-    #   # => 'benbalter.github.com'
-    #   host_from_uri("benbalter.github.com/help-me-im-a-path/")
-    #   # => 'benbalter.github.com'
-    #
-    # Return the hostname.
-    def host_from_uri(domain)
-      Addressable::URI.parse(domain).host || Addressable::URI.parse("http://#{domain}").host
+    def self.check(repository_or_domain, access_token: nil)
+      Site.new repository_or_domain, access_token: access_token
     end
   end
 end

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

@@ -0,0 +1,62 @@
+module GitHubPages
+  module HealthCheck
+    class Checkable
+
+      # Array of symbolized methods to be included in the output hash
+      HASH_METHODS = []
+
+      def check!
+        raise "Not implemented"
+      end
+      alias_method :valid!, :check!
+
+      # Runs all checks, returns true if valid, otherwise false
+      def valid?
+        check!
+        true
+      rescue GitHubPages::HealthCheck::Error
+        false
+      end
+
+      # Returns the reason the check failed, if any
+      def reason
+        check!
+        nil
+      rescue GitHubPages::HealthCheck::Error => e
+        e
+      end
+
+      def to_hash
+        @hash ||= begin
+          hash = {}
+          self.class::HASH_METHODS.each do |method|
+            hash[method] = public_send(method)
+          end
+          hash
+        end
+      end
+      alias_method :[], :to_hash
+      alias_method :to_h, :to_hash
+
+      def to_json
+        require 'json'
+        to_hash.to_json
+      end
+
+      def to_s
+        printer.simple_string
+      end
+
+      def to_s_pretty
+        printer.pretty_print
+      end
+      alias_method :pretty_print, :to_s_pretty
+
+      private
+
+      def printer
+        @printer ||= GitHubPages::HealthCheck::Printer.new(self)
+      end
+    end
+  end
+end