github-pages-health-check 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 132f9dcae46fe334470c7bc86fb3b98ba4e895cd
-  data.tar.gz: 0ff1b4b2bd51d97011f065208b779990d1a86184
+  metadata.gz: 6a5737c814130d1f5c193ea84af00ef871a4e8cd
+  data.tar.gz: a5e432b41f1e73b6607c5369d01c81736489e1cc
 SHA512:
-  metadata.gz: d9e2d427d05ce7396e9cb1924230aa2736ea102da7b831615a2611153e67523ddf4f8190e01d5119fa67513d7230b39cf6231014b73df04505ca82e55e84f776
-  data.tar.gz: 7650c557747924073b9e2e46f2ba7107a4a3a2130ae5b2ea86d964f6ca5dcacd8e9efa13ec20d427f2de92189b3599d19c88b02e3ab4d399d1af03eb10dccee1
+  metadata.gz: 04b31d07e1b0bd066a5957194e441ae37fb7964f205b8dd1eb53836276d25657825e8585fb25887b3bceba33179f997c72a3631915bd21ca4cbf6bd3bbb4b3c0
+  data.tar.gz: 2724939af6326eeeb9ae71a8ade4071e584912fb1c535e1f27e462328fb7e95176221fc85f996365cdb3532d9f3f74054cca38ada06dd5536ce54d36cad46174

data/.gitignore

@@ -4,3 +4,4 @@
 vendor/gems
 /bin
 .env
+spec/examples.txt

data/.rspec

@@ -1,2 +1,2 @@
 --color
---format progress
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,157 @@
+# Ruby linting configuration.
+# See https://github.com/styleguide/ruby for the Ruby style guide
+
+# We only worry about two kinds of issues: 'error' and anything less than that.
+# Error is not about severity, but about taste. Simple style choices that
+# never have a great excuse to be broken, such as 1.9 JSON-like hash syntax,
+# are errors. Choices that tend to have good exceptions in practice, such as
+# line length, are warnings.
+
+# If you'd like to make changes, a full list of available issues is at
+#   https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
+#
+# A list of configurable issues is at:
+#   https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+#
+# If you disable a check, document why.
+
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'script/**/*'
+    - 'vendor/**/*'
+    - 'test-site/**/*'
+
+Lint/EndAlignment:
+  Severity: error
+
+Lint/RescueException:
+  Exclude:
+    - lib/pages_jekyll.rb
+
+Lint/UnreachableCode:
+  Severity: error
+
+Lint/AmbiguousRegexpLiteral:
+  Exclude:
+    - 'features/step_definitions/pages_steps.rb'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Severity: error
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+  Severity: error
+
+Style/AlignHash:
+  SupportedLastArgumentHashStyles: always_ignore
+
+Style/AlignParameters:
+  Enabled: false # This is usually true, but we often want to roll back to
+                 # the start of a line.
+
+Style/Attr:
+  Enabled: false # We have no styleguide guidance here, and it seems to be
+                 # in frequent use.
+
+Style/ClassAndModuleChildren:
+  Enabled: false # module X<\n>module Y is just as good as module X::Y.
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '{}'
+    '%r': '{}'
+
+Metrics/LineLength:
+  Max: 90
+  Severity: warning
+  Exclude:
+    - github-pages-health-check.gemspec
+    - lib/github-pages-health-check/errors/*.rb
+
+Metrics/BlockLength:
+  Enabled: false
+  
+Style/MultilineTernaryOperator:
+  Severity: error
+
+Style/AndOr:
+  Severity: error
+
+Style/IndentationWidth:
+  Severity: error
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 20
+  Severity: error
+  Exclude:
+    - lib/github-pages-health-check/printer.rb
+
+Style/Alias:
+  Enabled: false # We have no guidance on alias vs alias_method
+
+Style/RedundantSelf:
+  Enabled: false # Sometimes a self.field is a bit more clear
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/FileName: #Rubocop doesn't like the Git*H*ub namespace
+  Enabled: false
+
+Metrics/ParameterLists: { Max: 4 }
+Metrics/AbcSize: { Max: 20 }
+
+Style/IndentHash: { EnforcedStyle: consistent }
+Style/SignalException: { EnforcedStyle: only_raise }
+Style/MultilineMethodCallIndentation: { EnforcedStyle: indented }
+Style/MultilineOperationIndentation: { EnforcedStyle: indented }
+Style/FirstParameterIndentation: { EnforcedStyle: consistent }
+Style/StringLiterals: { EnforcedStyle: double_quotes }
+Style/IndentArray: { EnforcedStyle: consistent }
+Style/ExtraSpacing: { AllowForAlignment: true }
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%q': '{}'
+    '%Q': '{}'
+    '%r': '{}'
+    '%s': '()'
+    '%w': '()'
+    '%W': '()'
+    '%x': '()'
+
+AllCops:
+  TargetRubyVersion: 2.2
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/ClassLength:
+  Exclude:
+    - lib/github-pages-health-check/domain.rb
+
+Metrics/CyclomaticComplexity:
+  Max: 8
+  Exclude:
+    - lib/github-pages-health-check/printer.rb
+
+Metrics/PerceivedComplexity:
+  Max: 8
+  Exclude:
+    - lib/github-pages-health-check/printer.rb
+
+Metrics/AbcSize:
+  Exclude:
+    - lib/github-pages-health-check/printer.rb
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source "https://rubygems.org"
 
 gemspec

data/github-pages-health-check.gemspec

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require File.expand_path("../lib/github-pages-health-check/version", __FILE__)
 
 Gem::Specification.new do |s|
@@ -12,7 +13,7 @@ Gem::Specification.new do |s|
   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.require_paths         = ["lib"]
 
   s.add_dependency("net-dns", "~> 0.8")
   s.add_dependency("public_suffix", "~> 2.0")
@@ -25,4 +26,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency("gem-release", "~> 0.7")
   s.add_development_dependency("webmock", "~> 1.21")
   s.add_development_dependency("dotenv", "~> 1.0")
+  s.add_development_dependency("rubocop", "~> 0.40")
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "net/dns"
 require "net/dns/resolver"
 require "addressable/uri"
@@ -11,14 +12,13 @@ require "timeout"
 require "octokit"
 require_relative "github-pages-health-check/version"
 
-if File.exists?(File.expand_path "../.env", File.dirname(__FILE__))
-  require 'dotenv'
+if File.exist?(File.expand_path("../.env", File.dirname(__FILE__)))
+  require "dotenv"
   Dotenv.load
 end
 
 module GitHubPages
   module HealthCheck
-
     autoload :CDN,        "github-pages-health-check/cdn"
     autoload :CloudFlare, "github-pages-health-check/cdns/cloudflare"
     autoload :Fastly,     "github-pages-health-check/cdns/fastly"
@@ -33,26 +33,31 @@ module GitHubPages
     # DNS and HTTP timeout, in seconds
     TIMEOUT = 5
 
+    HUMAN_NAME = "GitHub Pages Health Check".freeze
+    URL = "https://github.com/github/pages-health-check".freeze
+    USER_AGENT = "Mozilla/5.0 (compatible; #{HUMAN_NAME}/#{VERSION}; +#{URL})".freeze
+
     TYPHOEUS_OPTIONS = {
-      :followlocation  => true,
-      :timeout         => TIMEOUT,
+      :followlocation => true,
+      :timeout => TIMEOUT,
       :accept_encoding => "gzip",
-      :method          => :head,
-      :headers         => {
-        "User-Agent"   => "Mozilla/5.0 (compatible; GitHub Pages Health Check/#{VERSION}; +https://github.com/github/pages-health-check)"
+      :method => :head,
+      :headers => {
+        "User-Agent" => USER_AGENT
       }
-    }
+    }.freeze
 
     # surpress warn-level feedback due to unsupported record types
     def self.without_warnings(&block)
-      warn_level, $VERBOSE = $VERBOSE, nil
+      warn_level = $VERBOSE
+      $VERBOSE = nil
       result = block.call
       $VERBOSE = warn_level
       result
     end
 
     def self.check(repository_or_domain, access_token: nil)
-      Site.new repository_or_domain, access_token: access_token
+      Site.new repository_or_domain, :access_token => access_token
     end
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GitHubPages
   module HealthCheck
     class CDN

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GitHubPages
   module HealthCheck
     # Instance of the CloudFlare CDN for checking IP ownership

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GitHubPages
   module HealthCheck
     # Instance of the Fastly CDN for checking IP ownership

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

@@ -1,14 +1,14 @@
+# frozen_string_literal: true
 module GitHubPages
   module HealthCheck
     class Checkable
-
       # Array of symbolized methods to be included in the output hash
-      HASH_METHODS = []
+      HASH_METHODS = [].freeze
 
       def check!
         raise "Not implemented"
       end
-      alias_method :valid!, :check!
+      alias valid! check!
 
       # Runs all checks, returns true if valid, otherwise false
       def valid?
@@ -35,11 +35,11 @@ module GitHubPages
           hash
         end
       end
-      alias_method :[], :to_hash
-      alias_method :to_h, :to_hash
+      alias [] to_hash
+      alias to_h to_hash
 
       def to_json
-        require 'json'
+        require "json"
         to_hash.to_json
       end
 
@@ -50,7 +50,7 @@ module GitHubPages
       def to_s_pretty
         printer.pretty_print
       end
-      alias_method :pretty_print, :to_s_pretty
+      alias pretty_print to_s_pretty
 
       private
 

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

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
 module GitHubPages
   module HealthCheck
     class Domain < Checkable
-
       attr_reader :host
 
       LEGACY_IP_ADDRESSES = [
@@ -9,15 +9,29 @@ module GitHubPages
         "207.97.227.245",
         "204.232.175.78",
 
-        # Legacy Fastly Datacenter
+        # Aug. 2016 Fastly datacenter deprecation
         "199.27.73.133",
-        "199.27.76.133"
+        "199.27.76.133",
+
+        # Feb. 2017 Fastly datacenter deprecation
+        "185.31.17.133",
+        "185.31.18.133",
+        "185.31.19.133",
+        "199.27.74.133",
+        "199.27.75.133",
+        "199.27.79.133",
+        "23.235.39.133",
+        "23.235.43.133",
+        "23.235.44.133",
+        "23.235.46.133",
+        "23.235.47.133",
+        "45.32.88.68"
       ].freeze
 
-      CURRENT_IP_ADDRESSES = %w[
+      CURRENT_IP_ADDRESSES = %w(
         192.30.252.153
         192.30.252.154
-      ].freeze
+      ).freeze
 
       HASH_METHODS = [
         :host, :uri, :dns_resolves?, :proxied?, :cloudflare_ip?, :fastly_ip?,
@@ -38,13 +52,13 @@ module GitHubPages
 
       # Runs all checks, raises an error if invalid
       def check!
-        raise Errors::InvalidDomainError.new(domain: self) unless valid_domain?
-        raise Errors::InvalidDNSError.new(domain: self)    unless dns_resolves?
-        raise Errors::DeprecatedIPError.new(domain: self)      if deprecated_ip?
+        raise Errors::InvalidDomainError, :domain => self unless valid_domain?
+        raise Errors::InvalidDNSError, :domain => self    unless dns_resolves?
+        raise Errors::DeprecatedIPError, :domain => self if deprecated_ip?
         return true if proxied?
-        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?
+        raise Errors::InvalidARecordError, :domain => self    if invalid_a_record?
+        raise Errors::InvalidCNAMEError, :domain => self      if invalid_cname?
+        raise Errors::NotServedByPagesError, :domain => self  unless served_by_pages?
         true
       end
 
@@ -72,7 +86,7 @@ module GitHubPages
       # Used as an escape hatch to prevent false positives on DNS checkes
       def valid_domain?
         return @valid if defined? @valid
-        @valid = PublicSuffix.valid?(host, default_rule: nil)
+        @valid = PublicSuffix.valid?(host, :default_rule => nil)
       end
 
       # Is this domain an apex domain, meaning a CNAME would be innapropriate
@@ -80,14 +94,14 @@ module GitHubPages
         return @apex_domain if defined?(@apex_domain)
         return unless valid_domain?
 
-          answers = begin
-            Resolv::DNS.open { |dns|
-              dns.timeouts = TIMEOUT
-              dns.getresources(absolute_domain, Resolv::DNS::Resource::IN::NS)
-            }
-          rescue Timeout::Error, NoMethodError
-            []
+        answers = begin
+          Resolv::DNS.open do |dns|
+            dns.timeouts = TIMEOUT
+            dns.getresources(absolute_domain, Resolv::DNS::Resource::IN::NS)
           end
+        rescue Timeout::Error, NoMethodError
+          []
+        end
 
         @apex_domain = answers.any?
       end
@@ -136,7 +150,7 @@ module GitHubPages
 
       # Is this domain owned by GitHub?
       def github_domain?
-        !!host.match(/\.github\.com\z/)
+        !!host.downcase.end_with?("github.com")
       end
 
       # Is the host our Fastly CNAME?
@@ -158,13 +172,17 @@ module GitHubPages
       #
       # 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
+      #   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? || cname_to_github_user_domain?
-        return false if cname_to_pages_dot_github_dot_com? || cname_to_fastly? || fastly_ip?
+        return false if pointed_to_github_pages_ip?
+        return false if cname_to_github_user_domain?
+        return false if cname_to_pages_dot_github_dot_com?
+        return false if cname_to_fastly? || fastly_ip?
         served_by_pages?
       end
 
@@ -192,13 +210,15 @@ module GitHubPages
       def dns?
         !(dns.nil? || dns.empty?)
       end
-      alias_method :dns_resolves?, :dns?
+      alias dns_resolves? dns?
 
       # Does this domain have *any* A record that points to the legacy IPs?
       def old_ip_address?
+        return unless dns?
+
         dns.any? do |answer|
-          answer.class == Net::DNS::RR::A && LEGACY_IP_ADDRESSES.include?(answer.address.to_s)
-        end if dns?
+          answer.is_a?(Net::DNS::RR::A) && legacy_ip?(answer.address.to_s)
+        end
       end
 
       # Is this domain's first response an A record?
@@ -236,11 +256,11 @@ module GitHubPages
           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 }
+          response.headers.any? { |k, _v| k =~ /X-GitHub-Request-Id/i }
         end
       end
 
-      def uri(overrides={})
+      def uri(overrides = {})
         options = { :host => host, :scheme => scheme, :path => "/" }
         options = options.merge(overrides)
         Addressable::URI.new(options).normalize.to_s
@@ -283,13 +303,13 @@ module GitHubPages
 
       # The domain's response to HTTP requests, without following redirects
       def http_response
-        options = TYPHOEUS_OPTIONS.merge(:followlocation => false )
+        options = TYPHOEUS_OPTIONS.merge(:followlocation => false)
         @http_response ||= Typhoeus.head(uri(:scheme => "http"), options)
       end
 
       # The domain's response to HTTPS requests, without following redirects
       def https_response
-        options = TYPHOEUS_OPTIONS.merge(:followlocation => false )
+        options = TYPHOEUS_OPTIONS.merge(:followlocation => false)
         @https_response ||= Typhoeus.head(uri(:scheme => "https"), options)
       end
 
@@ -310,13 +330,14 @@ module GitHubPages
       # Return the hostname.
       def normalize_host(domain)
         domain = domain.strip.chomp(".")
-        host = Addressable::URI.parse(domain).host || Addressable::URI.parse("http://#{domain}").host
+        host = Addressable::URI.parse(domain).host
+        host ||= Addressable::URI.parse("http://#{domain}").host
         host unless host.to_s.empty?
       rescue Addressable::URI::InvalidURIError
         nil
       end
 
-      # Adjust `domain` so that it won't be searched for with /etc/resolv.conf's search rules.
+      # Adjust `domain` so that it won't be searched for with /etc/resolv.conf
       #
       #     GitHubPages::HealthCheck.new("anything.io").absolute_domain
       #     => "anything.io."
@@ -335,6 +356,10 @@ module GitHubPages
           answer.class == Net::DNS::RR::A && cdn.controls_ip?(answer.address)
         end
       end
+
+      def legacy_ip?(ip)
+        LEGACY_IP_ADDRESSES.include?(ip)
+      end
     end
   end
 end

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

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module GitHubPages
   module HealthCheck
     class Error < StandardError
-      DOCUMENTATION_BASE = "https://help.github.com"
-      DOCUMENTATION_PATH = "/categories/github-pages-basics/"
+      DOCUMENTATION_BASE = "https://help.github.com".freeze
+      DOCUMENTATION_PATH = "/categories/github-pages-basics/".freeze
       LOCAL_ONLY = false # Error is only used when running locally
 
       attr_reader :repository, :domain
@@ -28,17 +29,21 @@ module GitHubPages
       # 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 << "." unless msg =~ /\.$/ # add trailing period if not there
         "#{msg} #{more_info}"
       end
-      alias_method :message_formatted, :message_with_url
+      alias message_formatted message_with_url
 
       def to_s
-        "#{message_with_url} (#{self.class.name.split('::').last})".gsub("\n", " ").squeeze(" ").strip
+        "#{message_with_url} (#{name})".tr("\n", " ").squeeze(" ").strip
       end
 
       private
 
+      def name
+        self.class.name.split("::").last
+      end
+
       def username
         if repository.nil?
           "[YOUR USERNAME]"

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 Dir[File.expand_path("../errors/*_error.rb", __FILE__)].each do |f|
   require f
 end

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

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module GitHubPages
   module HealthCheck
     module Errors
       class BuildError < GitHubPages::HealthCheck::Error
-        DOCUMENTATION_PATH = '/articles/troubleshooting-jekyll-builds/'
+        DOCUMENTATION_PATH = "/articles/troubleshooting-jekyll-builds/".freeze
         LOCAL_ONLY = true
       end
     end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GitHubPages
   module HealthCheck
     module Errors

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

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
 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

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

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
 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

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

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
 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

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GitHubPages
   module HealthCheck
     module Errors

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GitHubPages
   module HealthCheck
     module Errors

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GitHubPages
   module HealthCheck
     module Errors

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GitHubPages
   module HealthCheck
     module Errors

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

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module GitHubPages
   module HealthCheck
     class Printer
       PRETTY_LEFT_WIDTH = 11
-      PRETTY_JOINER = " | "
+      PRETTY_JOINER = " | ".freeze
 
       attr_reader :health_check
 
@@ -11,7 +12,7 @@ module GitHubPages
       end
 
       def simple_string
-        require 'yaml'
+        require "yaml"
         hash = health_check.to_hash
         hash[:reason] = hash[:reason].to_s if hash[:reason]
         hash.to_yaml.sub(/\A---\n/, "").gsub(/^:/, "")
@@ -22,32 +23,49 @@ module GitHubPages
         output = StringIO.new
 
         # Header
-        output.puts new_line "Domain", "#{values[:uri]}"
-        output.puts ("-" * (PRETTY_LEFT_WIDTH + 1)) + "|" + "-" * 50
+        output.puts new_line "Domain", (values[:uri]).to_s
+        output.puts "-" * (PRETTY_LEFT_WIDTH + 1) + "|" + "-" * 50
 
-        output.puts new_line "DNS", "does not resolve" if not values[:dns_resolves?]
+        output.puts new_line "DNS", "does not resolve" unless 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"
+        output.write new_line "State", (values[:valid?] ? "valid" : "invalid").to_s
+        output.puts " - is #{"NOT " unless 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?]
+        output.puts new_line "Reason", (values[:reason]).to_s unless values[:valid?]
+
+        if values[:pointed_to_github_user_domain?]
+          output.puts new_line nil, "pointed to user domain"
+        end
+
+        if values[:pointed_to_github_pages_ip?]
+          output.puts new_line nil, "pointed to pages IP"
+        end
 
         # 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"
+        record_type = if values[:a_record?]
+                        "A"
+                      elsif values[:cname_record?]
+                        "CNAME"
+                      else
+                        "other"
+                      end
+        output.write new_line "Record Type", record_type
+        should_be = values[:should_be_a_record?] ? "A record" : "CNAME"
+        output.puts ", should be #{should_be}"
 
         ip_problems = []
-        ip_problems << "not apex domain" if not values[:apex_domain?]
-        ip_problems << "invalid domain" if not values[:valid_domain?]
+        ip_problems << "not apex domain" unless values[:apex_domain?]
+        ip_problems << "invalid domain" unless 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"} "
+
+        ip_problems_string = !ip_problems.empty? ? ip_problems.join(", ") : "none"
+        output.puts new_line "IP Problems", ip_problems_string
 
         if values[:proxied?]
-          output.puts new_line "Proxied", "yes, through #{values[:cloudflare_ip?] ? "CloudFlare" : "unknown"}"
+          proxy = values[:cloudflare_ip?] ? "CloudFlare" : "unknown"
+          output.puts new_line "Proxied", "yes, through #{proxy}"
         end
 
         output.puts new_line "Domain", "*.github.com/io domain" if values[:pages_domain?]
@@ -56,7 +74,7 @@ module GitHubPages
       end
 
       def new_line(left = nil, right = nil)
-        if left and right
+        if left && right
           ljust(left) + PRETTY_JOINER + right
         elsif left
           ljust(left)

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

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
 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
+        :name_with_owner, :built?, :last_built, :build_duration, :build_error
       ].freeze
 
       def initialize(name_with_owner, access_token: nil)
@@ -21,12 +21,12 @@ module GitHubPages
       end
 
       def name_with_owner
-        @name_with_owner ||= [owner,name].join("/")
+        @name_with_owner ||= [owner, name].join("/")
       end
-      alias_method :nwo, :name_with_owner
+      alias nwo name_with_owner
 
       def check!
-        raise Errors::BuildError.new(repository: self), build_error unless built?
+        raise Errors::BuildError.new(:repository => self), build_error unless built?
         true
       end
 
@@ -41,14 +41,14 @@ module GitHubPages
       def build_error
         last_build.error["message"] unless built?
       end
-      alias_method :reason, :build_error
+      alias reason build_error
 
       def build_duration
-        last_build.duration unless last_build.nil?
+        last_build.duration if last_build
       end
 
       def last_built
-        last_build.updated_at unless last_build.nil?
+        last_build.updated_at if last_build
       end
 
       def domain
@@ -60,7 +60,7 @@ module GitHubPages
 
       def client
         raise Errors::MissingAccessTokenError if @access_token.nil?
-        @client ||= Octokit::Client.new(access_token: @access_token)
+        @client ||= Octokit::Client.new(:access_token => @access_token)
       end
 
       def pages_info

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

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
 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)
+        @repository = Repository.new(repository_or_domain, :access_token => access_token)
         @domain = @repository.domain
       rescue GitHubPages::HealthCheck::Errors::InvalidRepositoryError
         @repository = nil
@@ -13,7 +13,7 @@ module GitHubPages
       end
 
       def check!
-        [domain, repository].each { |check| check.check! unless check.nil? }
+        [domain, repository].each { |check| check.check! if check }
         true
       end
 
@@ -24,8 +24,8 @@ module GitHubPages
         hash[:reason] = reason
         hash
       end
-      alias_method :to_h, :to_hash
-      alias_method :as_json, :to_hash
+      alias to_h to_hash
+      alias as_json to_hash
     end
   end
 end

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

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 module GitHubPages
   module HealthCheck
-    VERSION = "1.3.0"
+    VERSION = "1.3.1".freeze
   end
 end

data/script/check

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # Usage: script/check [DOMAIN]
 
 require_relative "../lib/github-pages-health-check"

data/script/test

@@ -1,2 +1,6 @@
 #!/bin/sh
+
+set -e
+
 bundle exec rspec $@
+bundle exec rubocop -D -S $@

data/script/update-cdn-ips

@@ -1,14 +1,15 @@
 #!/usr/bin/env ruby
-#/ Usage script/update-ips
-#/ updates config/cloudflare-ips.txt and config/fastly-ips.txt
+# frozen_string_literal: true
+# / Usage script/update-ips
+# / updates config/cloudflare-ips.txt and config/fastly-ips.txt
 
-require 'open-uri'
-require 'json'
+require "open-uri"
+require "json"
 
 SOURCES = {
-  cloudflare: "https://www.cloudflare.com/ips-v4",
-  fastly: "https://api.fastly.com/public-ip-list"
-}
+  :cloudflare => "https://www.cloudflare.com/ips-v4",
+  :fastly => "https://api.fastly.com/public-ip-list"
+}.freeze
 
 SOURCES.each do |source, url|
   file = "config/#{source}-ips.txt"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-pages-health-check
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - GitHub, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-28 00:00:00.000000000 Z
+date: 2017-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-dns
@@ -150,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
 description: Checks your GitHub Pages site for commons DNS configuration issues.
 email: support@github.com
 executables: []
@@ -158,6 +172,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile