github-pages-health-check 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ae14ced41d6ce019b7d842dadd4eb7869c772f4
-  data.tar.gz: a55009148b66e16360fa82fef97fb12151645b04
+  metadata.gz: ac5d338582ae0432d783ad6e2ce77e87d1954c16
+  data.tar.gz: c91280a688eab7f1bfc1f916546edfb43171a436
 SHA512:
-  metadata.gz: 3f7294eea6132d79bb8b4894c841627af1bd7ab4f97a02dd24e8cb0b901ea564da11c338d7c017e2d7e73430e344510f82f6c9cee1253a5111704521c062b8ae
-  data.tar.gz: 0b1208f94e784bf3f9acfab628b5e5886ddd4569fd50186516bf7e62c8f4dce8dc3353ec268e4a94d2be951d8abe9895a4e07b0ac146e439b5c783eb573002b0
+  metadata.gz: 8bf0a5e6b95798219f6d89553e6fd2ff01219242fe8a89f12476fa234289737f664fd1d0b599f099c071aa6c692d186db7884d7bd12acc5dd52925151c8e4ba4
+  data.tar.gz: 4af63470b8f55dcaf48126cdac6543cd9f1a88d2c38c9f8c571116184fbf508d5ed4ce29877a6b39d608b05a9f8bd0c33c4ebea7556057a73d702d897c23931e

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

@@ -34,13 +34,13 @@ module GitHubPages
 
       # Runs all checks, raises an error if invalid
       def check!
-        raise Errors::InvalidDomainError unless valid_domain?
-        raise Errors::InvalidDNSError    unless dns_resolves?
+        raise Errors::InvalidDomainError.new(domain: self) unless valid_domain?
+        raise Errors::InvalidDNSError.new(domain: self)    unless dns_resolves?
         return true if proxied?
-        raise Errors::DeprecatedIPError      if deprecated_ip?
-        raise Errors::InvalidARecordError    if invalid_a_record?
-        raise Errors::InvalidCNAMEError      if invalid_cname?
-        raise Errors::NotServedByPagesError  unless served_by_pages?
+        raise Errors::DeprecatedIPError.new(domain: self)      if deprecated_ip?
+        raise Errors::InvalidARecordError.new(domain: self)    if invalid_a_record?
+        raise Errors::InvalidCNAMEError.new(domain: self)      if invalid_cname?
+        raise Errors::NotServedByPagesError.new(domain: self)  unless served_by_pages?
         true
       end
 

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

@@ -1,6 +1,18 @@
 module GitHubPages
   module HealthCheck
     class Error < StandardError
+      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
+
+      def initialize(repository: nil, domain: nil)
+        super
+        @repository = repository
+        @domain     = domain
+      end
+
       def self.inherited(base)
         subclasses << base
       end
@@ -8,6 +20,36 @@ module GitHubPages
       def self.subclasses
         @subclasses ||= []
       end
+
+      def message
+        "Something's wrong with your GitHub Pages site."
+      end
+
+      # 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} #{more_info}"
+      end
+      alias_method :message_formatted, :message_with_url
+
+      private
+
+      def username
+        if repository.nil?
+          "[YOUR USERNAME]"
+        else
+          repository.owner
+        end
+      end
+
+      def more_info
+        "For more information, see #{documentation_url}."
+      end
+
+      def documentation_url
+        URI.join(Error::DOCUMENTATION_BASE, self.class::DOCUMENTATION_PATH).to_s
+      end
     end
   end
 end

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

@@ -2,6 +2,8 @@ module GitHubPages
   module HealthCheck
     module Errors
       class BuildError < GitHubPages::HealthCheck::Error
+        DOCUMENTATION_PATH = '/articles/troubleshooting-jekyll-builds/'
+        LOCAL_ONLY = true
       end
     end
   end

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

@@ -2,8 +2,13 @@ module GitHubPages
   module HealthCheck
     module Errors
       class DeprecatedIPError < GitHubPages::HealthCheck::Error
+        DOCUMENTATION_PATH = "/articles/setting-up-a-custom-domain-with-github-pages/".freeze
+
         def message
-          "A record points to deprecated IP address"
+          <<-MSG
+            The custom domain for your GitHub Pages site is pointed at an outdated IP address.
+            You must update your site's DNS records if you'd like it to be available via your custom domain.
+           MSG
         end
       end
     end

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

@@ -2,8 +2,15 @@ module GitHubPages
   module HealthCheck
     module Errors
       class InvalidARecordError < GitHubPages::HealthCheck::Error
+        # rubocop:disable Metrics/LineLength
+        DOCUMENTATION_PATH = "/articles/setting-up-a-custom-domain-with-github-pages/".freeze
+
         def message
-          "Should not be an A record"
+          <<-MSG
+             Your site's DNS settings are using a custom subdomain, #{domain.host},
+             that's set up as an A record. We recommend you change this to a CNAME
+             record pointing at #{username}.github.io.
+           MSG
         end
       end
     end

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

@@ -2,8 +2,15 @@ module GitHubPages
   module HealthCheck
     module Errors
       class InvalidCNAMEError < GitHubPages::HealthCheck::Error
+        # rubocop:disable Metrics/LineLength
+        DOCUMENTATION_PATH = "/articles/setting-up-a-custom-domain-with-github-pages/".freeze
+
         def message
-          "CNAME does not point to GitHub Pages"
+          <<-MSG
+             Your site's DNS settings are using a custom subdomain, #{domain.host},
+             that's not set up with a correct CNAME record.  We recommend you set this
+             CNAME record to point at #{username}.github.io.
+           MSG
         end
       end
     end

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

@@ -2,6 +2,9 @@ module GitHubPages
   module HealthCheck
     module Errors
       class InvalidDNSError < GitHubPages::HealthCheck::Error
+        # rubocop:disable Metrics/LineLength
+        DOCUMENTATION_PATH = "/articles/setting-up-a-custom-domain-with-github-pages/".freeze
+
         def message
           "Domain's DNS record could not be retrieved"
         end

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

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

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

@@ -2,6 +2,7 @@ module GitHubPages
   module HealthCheck
     module Errors
       class InvalidRepositoryError < GitHubPages::HealthCheck::Error
+        LOCAL_ONLY = true
         def message
           "Repository is not a valid repository"
         end

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

@@ -2,6 +2,7 @@ module GitHubPages
   module HealthCheck
     module Errors
       class MissingAccessTokenError < GitHubPages::HealthCheck::Error
+        LOCAL_ONLY = true
         def message
           "Cannot retrieve repository information with a valid access token"
         end

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

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

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

@@ -26,7 +26,7 @@ module GitHubPages
       alias_method :nwo, :name_with_owner
 
       def check!
-        raise Errors::BuildError, build_error unless built?
+        raise Errors::BuildError.new(repository: self), build_error unless built?
         true
       end
 

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

@@ -1,5 +1,5 @@
 module GitHubPages
   module HealthCheck
-    VERSION = "1.1.1"
+    VERSION = "1.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-pages-health-check
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - GitHub, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-10 00:00:00.000000000 Z
+date: 2016-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-dns
@@ -212,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.1
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: Checks your GitHub Pages site for commons DNS configuration issues