github-pages-health-check 0.6.1 → 1.0.0

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

@@ -0,0 +1,71 @@
+module GitHubPages
+  module HealthCheck
+    class Printer
+      PRETTY_LEFT_WIDTH = 11
+      PRETTY_JOINER = " | "
+
+      attr_reader :health_check
+
+      def initialize(health_check)
+        @health_check = health_check
+      end
+
+      def simple_string
+        require 'yaml'
+        health_check.to_hash.to_yaml.sub(/\A---\n/, "").gsub(/^:/, "")
+      end
+
+      def pretty_print
+        values = health_check.to_hash
+        output = StringIO.new
+
+        # Header
+        output.puts new_line "Domain", "#{values[:uri]}"
+        output.puts ("-" * (PRETTY_LEFT_WIDTH + 1)) + "|" + "-" * 50
+
+        output.puts new_line "DNS", "does not resolve" if not values[:dns_resolves?]
+
+        # Valid?
+        output.write new_line "State", "#{values[:valid?] ? "valid" : "invalid"}"
+        output.puts " - is #{"NOT " if not values[:served_by_pages?]}served by Pages"
+
+        # What's wrong?
+        output.puts new_line "Reason", "#{values[:reason]}" if not values[:valid?]
+        output.puts new_line nil, "pointed to user domain"  if values[:pointed_to_github_user_domain?]
+        output.puts new_line nil, "pointed to pages IP"     if values[:pointed_to_github_pages_ip?]
+
+        # DNS Record info
+        output.write new_line "Record Type", "#{values[:a_record?] ? "A" : values[:cname_record?] ? "CNAME" : "other"}"
+        output.puts values[:should_be_a_record?] ? ", should be A record" : ", should be CNAME"
+
+        ip_problems = []
+        ip_problems << "not apex domain" if not values[:apex_domain?]
+        ip_problems << "invalid domain" if not values[:valid_domain?]
+        ip_problems << "old ip address used" if values[:old_ip_address?]
+        output.puts new_line "IP Problems", "#{ip_problems.size > 0 ? ip_problems.join(", ") : "none"} "
+
+        if values[:proxied?]
+          output.puts new_line "Proxied", "yes, through #{values[:cloudflare_ip?] ? "CloudFlare" : "unknown"}"
+        end
+
+        output.puts new_line "Domain", "*.github.com/io domain" if values[:pages_domain?]
+
+        output.string
+      end
+
+      def new_line(left = nil, right = nil)
+        if left and right
+          ljust(left) + PRETTY_JOINER + right
+        elsif left
+          ljust(left)
+        elsif right
+          " " * (PRETTY_LEFT_WIDTH + PRETTY_JOINER.size) + right
+        end
+      end
+
+      def ljust(line)
+        line.ljust(PRETTY_LEFT_WIDTH)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+module GitHubPages
+  module HealthCheck
+    class Repository < Checkable
+
+      attr_reader :name, :owner
+
+      REPO_REGEX = %r{\A[a-z0-9_\-]+/[a-z0-9_\-\.]+\z}i
+      
+      HASH_METHODS = [
+        :name_with_owner, :built?, :last_built,  :build_duration, :build_error
+      ].freeze
+
+      def initialize(name_with_owner, access_token: nil)
+        unless name_with_owner =~ REPO_REGEX
+          raise Errors::InvalidRepositoryError
+        end
+        parts = name_with_owner.split("/")
+        @owner = parts.first
+        @name  = parts.last
+        @access_token = access_token || ENV["OCTOKIT_ACCESS_TOKEN"]
+      end
+
+      def name_with_owner
+        @name_with_owner ||= [owner,name].join("/")
+      end
+      alias_method :nwo, :name_with_owner
+
+      def check!
+        raise Errors::BuildError, build_error unless built?
+        true
+      end
+
+      def last_build
+        @last_build ||= client.latest_pages_build(name_with_owner)
+      end
+
+      def built?
+        last_build && last_build.status == "built"
+      end
+
+      def build_error
+        last_build.error.message unless built?
+      end
+      alias_method :reason, :build_error
+
+      def build_duration
+        last_build.duration unless last_build.nil?
+      end
+
+      def last_built
+        last_build.updated_at unless last_build.nil?
+      end
+
+      def domain
+        @domain ||= GitHubPages::HealthCheck::Domain.new(cname)
+      end
+
+      private
+
+      def client
+        raise Errors::MissingAccessTokenError if @access_token.nil?
+        @client ||= Octokit::Client.new(access_token: @access_token)
+      end
+
+      def pages_info
+        @pages_info ||= client.pages(name_with_owner)
+      end
+
+      def cname
+        pages_info.cname
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module GitHubPages
+  module HealthCheck
+    class Site < Checkable
+
+      attr_reader :repository, :domain
+
+      def initialize(repository_or_domain, access_token: nil)
+        @repository = Repository.new(repository_or_domain, access_token: access_token)
+        @domain = @repository.domain
+      rescue GitHubPages::HealthCheck::Errors::InvalidRepositoryError
+        @repository = nil
+        @domain = Domain.new(repository_or_domain)
+      end
+
+      def check!
+        domain.check!
+        repository.check! unless repository.nil?
+        true
+      end
+
+      def to_hash
+        hash = domain.to_hash.dup
+        hash = hash.merge(repository.to_hash) unless repository.nil?
+        hash[:valid?] = valid?
+        hash[:reason] = reason
+        hash
+      end
+      alias_method :to_h, :to_hash
+      alias_method :as_json, :to_hash
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
-class GitHubPages
-  class HealthCheck
-    VERSION = "0.6.1"
+module GitHubPages
+  module HealthCheck
+    VERSION = "1.0.0"
   end
 end

data/script/bootstrap

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -ex
+
+bundle install

data/script/check

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# Usage: script/check [DOMAIN]
+
+require_relative "../lib/github-pages-health-check"
+
+if ARGV.count != 1
+  puts "Usage: script/check [DOMAIN]"
+  exit 1
+end
+
+puts GitHubPages::HealthCheck.check(ARGV[0])

data/script/check-cloudflare-ips

@@ -0,0 +1,17 @@
+#!/bin/bash -e
+
+script/update-cloudflare-ips >/dev/null 2>&1
+
+# `git diff --quiet` suppresses output and sets a return code
+# 0 - no changes
+# 1 - changes
+if git diff -w --quiet --cached config/cloudflare-ips.txt
+then
+  echo CloudFlare IP list is up-to-date.
+  exit 0
+else
+  echo git reset config/cloudflare-ips.txt
+  git reset --quiet config/cloudflare-ips.txt
+  echo '*** CloudFlare IP list is out of date! Run script/update-cloudflare-ips!'
+  exit 1
+fi

data/script/cibuild

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+set -ex
+
+script/bootstrap
+
+script/test
+script/check-cloudflare-ips
+bundle exec gem build github-pages-health-check.gemspec

data/script/console

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -ex
+
+bundle exec pry -r "./lib/github-pages-health-check"

data/script/release

@@ -0,0 +1,42 @@
+#!/bin/sh
+# Tag and push a release.
+
+set -e
+
+# Make sure we're in the project root.
+
+cd $(dirname "$0")/..
+
+# Make sure the darn thing works
+
+bundle update
+
+# Build a new gem archive.
+
+rm -rf github-pages-health-check-*.gem
+gem build -q github-pages-health-check.gemspec
+
+# Make sure we're on the master branch.
+
+(git branch | grep -q '* master') || {
+  echo "Only release from the master branch."
+  exit 1
+}
+
+# Figure out what version we're releasing.
+
+tag=v`ls github-pages-health-check-*.gem | sed 's/^github-pages-health-check-\(.*\)\.gem$/\1/'`
+
+# Make sure we haven't released this version before.
+
+git fetch -t origin
+
+(git tag -l | grep -q "$tag") && {
+  echo "Whoops, there's already a '${tag}' tag."
+  exit 1
+}
+
+# Tag it and bag it.
+
+gem push github-pages-health-check-*.gem && git tag "$tag" &&
+  git push origin master && git push origin "$tag"

data/script/test

@@ -0,0 +1,2 @@
+#!/bin/sh
+bundle exec rspec $@

data/script/update-cloudflare-ips

@@ -0,0 +1,14 @@
+#!/bin/bash -e
+#/ Usage script/update-cloudflare-ips
+#/ updates config/cloudflare-ips.txt
+
+source=https://www.cloudflare.com/ips-v4
+dest=config/cloudflare-ips.txt
+
+echo '====>' Downloading $source
+curl --silent --fail $source | tee $dest
+echo # cover for a missing newline
+
+echo '====>' git add $dest
+git diff -w $dest
+git add --verbose $dest

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-pages-health-check
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 1.0.0
 platform: ruby
 authors:
 - GitHub, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-09 00:00:00.000000000 Z
+date: 2016-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-dns
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -122,23 +136,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Checks your GitHub Pages site for commons DNS configuration issues.
 email: support@github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
 - LICENSE.md
+- README.md
 - config/cloudflare-ips.txt
+- github-pages-health-check.gemspec
 - lib/github-pages-health-check.rb
+- lib/github-pages-health-check/checkable.rb
 - lib/github-pages-health-check/cloudflare.rb
+- lib/github-pages-health-check/domain.rb
 - lib/github-pages-health-check/error.rb
-- lib/github-pages-health-check/errors/deprecated_ip.rb
-- lib/github-pages-health-check/errors/invalid_a_record.rb
-- lib/github-pages-health-check/errors/invalid_cname.rb
-- lib/github-pages-health-check/errors/invalid_dns.rb
-- lib/github-pages-health-check/errors/not_served_by_pages.rb
+- lib/github-pages-health-check/errors.rb
+- lib/github-pages-health-check/errors/build_error.rb
+- lib/github-pages-health-check/errors/deprecated_ip_error.rb
+- lib/github-pages-health-check/errors/invalid_a_record_error.rb
+- lib/github-pages-health-check/errors/invalid_cname_error.rb
+- lib/github-pages-health-check/errors/invalid_dns_error.rb
+- lib/github-pages-health-check/errors/invalid_domain_error.rb
+- lib/github-pages-health-check/errors/invalid_repository_error.rb
+- lib/github-pages-health-check/errors/missing_access_token_error.rb
+- lib/github-pages-health-check/errors/not_served_by_pages_error.rb
+- lib/github-pages-health-check/printer.rb
+- lib/github-pages-health-check/repository.rb
+- lib/github-pages-health-check/site.rb
 - lib/github-pages-health-check/version.rb
+- script/bootstrap
+- script/check
+- script/check-cloudflare-ips
+- script/cibuild
+- script/console
+- script/release
+- script/test
+- script/update-cloudflare-ips
 homepage: https://github.com/github/github-pages-health-check
 licenses:
 - MIT

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

@@ -1,9 +0,0 @@
-class GitHubPages
-  class HealthCheck
-    class DeprecatedIP < Error
-      def message
-        "A record points to deprecated IP address"
-      end
-    end
-  end
-end

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

@@ -1,9 +0,0 @@
-class GitHubPages
-  class HealthCheck
-    class InvalidARecord < Error
-      def message
-        "Should not be an A record"
-      end
-    end
-  end
-end

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

@@ -1,9 +0,0 @@
-class GitHubPages
-  class HealthCheck
-    class InvalidCNAME < Error
-      def message
-        "CNAME does not point to GitHub Pages"
-      end
-    end
-  end
-end