site-inspector 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6884b52732376fcd208b761e6b441f52c8ff383d
-  data.tar.gz: a6d6268ce73a44108f4ec490da07d7b23257981d
+SHA256:
+  metadata.gz: 9da6e03626519a29904ac4f663565104f6793e9fedae46f786f268ea7beaf870
+  data.tar.gz: 100c9e6f24fd2f5ded3cc7239d37f30852eb7c7cd4a0c69651fc1d260c0043c6
 SHA512:
-  metadata.gz: c0c672eb141da7b5522b4ea9191024a13d08f37c3d91b11b8771f649596ff38f587cc98a95ce6cf6bb80f6f060d71068a51c45d132517e7a6a4237f7cb54d9d8
-  data.tar.gz: a1251d75b522286e2ff9889b347b4bf73440b2932f89acc9b4840d1b2c40ad7cbded89feca80e278f8120f9b1976d658860a75bd747c25921df4b55efcd365e8
+  metadata.gz: 974095f3bc91b3a83c90ef9fa9879942e66e3a4927b0e1d83a0cba2727c9f7e301ab151a3f0bac1ff507d3a16549c64af4be23fdd245ede0ac0dc25401096ba2
+  data.tar.gz: 16378f1054392ef3aa472469860367bab3c4d276bd57eaec9131382109aa85218ad535d82477d215d7c0294f310e82eac987275fd1b7d5148c5d3a1e722c8ab5

data/.gitignore

@@ -5,4 +5,4 @@ Gemfile.lock
 /.env
 /tmp
 /cache
-node_modules
+node_modules

data/.rubocop.yml

@@ -1,13 +1,14 @@
-Metrics/LineLength:
-  Enabled: false
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
 
-Style/AlignHash:
-  EnforcedHashRocketStyle: table
-  EnforcedColonStyle: table
+AllCops:
+  NewCops: enable
 
-Lint/EndAlignment:
-  AlignWith: variable
-  AutoCorrect: true
+Layout/LineLength:
+  Enabled: false
 
 Metrics/MethodLength:
   Enabled: false
@@ -18,7 +19,7 @@ Metrics/AbcSize:
 Style/Documentation:
   Enabled: false
 
-Style/FileName:
+Naming/FileName:
   Enabled: false
 
 Metrics/CyclomaticComplexity:
@@ -29,6 +30,13 @@ Style/DoubleNegation:
 
 Metrics/ClassLength:
   Enabled: false
-  
+
 Style/ClassVars:
   Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Security/MarshalLoad:
+  Exclude:
+    - lib/site-inspector/disk_cache.rb

data/.rubocop_todo.yml

@@ -0,0 +1,139 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-11-13 02:59:59 UTC using RuboCop version 1.3.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'site-inspector.gemspec'
+
+# Offense count: 3
+# Configuration parameters: AllowComments, AllowEmptyLambdas.
+Lint/EmptyBlock:
+  Exclude:
+    - 'spec/site_inspector_domain_spec.rb'
+
+# Offense count: 1
+Lint/NoReturnInBeginEndBlocks:
+  Exclude:
+    - 'lib/site-inspector/endpoint.rb'
+
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 9
+
+# Offense count: 3
+# Configuration parameters: EnforcedStyleForLeadingUnderscores.
+# SupportedStylesForLeadingUnderscores: disallowed, required, optional
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'lib/site-inspector/checks/accessibility.rb'
+
+# Offense count: 23
+# Configuration parameters: Prefixes.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/checks/site_inspector_endpoint_content_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_dns_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_sniffer_spec.rb'
+    - 'spec/site_inspector_domain_spec.rb'
+    - 'spec/site_inspector_endpoint_spec.rb'
+
+# Offense count: 1
+RSpec/EmptyExampleGroup:
+  Exclude:
+    - 'spec/checks/site_inspector_endpoint_accessibility_spec.rb'
+
+# Offense count: 24
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/checks/site_inspector_endpoint_dns_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_hsts_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_https_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_sniffer_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_wappalyzer_spec.rb'
+    - 'spec/site_inspector_disk_cache_spec.rb'
+    - 'spec/site_inspector_domain_spec.rb'
+    - 'spec/site_inspector_endpoint_spec.rb'
+    - 'spec/site_inspector_spec.rb'
+
+# Offense count: 15
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
+# Include: **/*_spec*rb*, **/spec/**/*
+RSpec/FilePath:
+  Exclude:
+    - 'spec/checks/site_inspector_endpoint_accessibility_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_check_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_content_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_cookies_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_dns_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_headers_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_hsts_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_https_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_sniffer_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_wappalyzer_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_whois_spec.rb'
+    - 'spec/site_inspector_cache_spec.rb'
+    - 'spec/site_inspector_disk_cache_spec.rb'
+    - 'spec/site_inspector_domain_spec.rb'
+    - 'spec/site_inspector_endpoint_spec.rb'
+
+# Offense count: 55
+RSpec/MultipleExpectations:
+  Max: 5
+
+# Offense count: 240
+# Configuration parameters: IgnoreSharedExamples.
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/checks/site_inspector_endpoint_accessibility_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_check_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_content_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_cookies_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_dns_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_headers_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_hsts_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_https_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_sniffer_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_wappalyzer_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_whois_spec.rb'
+    - 'spec/site_inspector_cache_spec.rb'
+    - 'spec/site_inspector_disk_cache_spec.rb'
+    - 'spec/site_inspector_domain_spec.rb'
+    - 'spec/site_inspector_endpoint_spec.rb'
+
+# Offense count: 2
+RSpec/RepeatedDescription:
+  Exclude:
+    - 'spec/checks/site_inspector_endpoint_content_spec.rb'
+
+# Offense count: 9
+RSpec/RepeatedExample:
+  Exclude:
+    - 'spec/checks/site_inspector_endpoint_accessibility_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_content_spec.rb'
+    - 'spec/site_inspector_domain_spec.rb'
+
+# Offense count: 2
+RSpec/RepeatedExampleGroupDescription:
+  Exclude:
+    - 'spec/site_inspector_domain_spec.rb'
+
+# Offense count: 30
+RSpec/SubjectStub:
+  Exclude:
+    - 'spec/checks/site_inspector_endpoint_accessibility_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_dns_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_headers_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_hsts_spec.rb'
+    - 'spec/checks/site_inspector_endpoint_https_spec.rb'
+    - 'spec/site_inspector_endpoint_spec.rb'

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.6.6

data/Gemfile

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
+gem 'sniffles', github: 'wa0x6e/sniffles'
+
 gemspec

data/Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require './lib/site-inspector'
 require 'rspec/core/rake_task'
 

data/bin/site-inspector

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'mercenary'
 require 'oj'
@@ -6,11 +7,11 @@ require 'yaml'
 require 'colorator'
 require_relative '../lib/site-inspector'
 
-def stringify_keys_deep!(h)
-  h.keys.each do |k|
+def stringify_keys_deep!(hash)
+  hash.each_key do |k|
     ks = k.respond_to?(:to_s) ? k.to_s : k
-    h[ks] = h.delete k # Preserve order even when k == ks
-    stringify_keys_deep! h[ks] if h[ks].is_a? Hash
+    hash[ks] = hash.delete k # Preserve order even when k == ks
+    stringify_keys_deep! h[ks] if hash[ks].is_a? Hash
   end
 end
 
@@ -45,8 +46,8 @@ Mercenary.program(:"site-inspector") do |p|
       yaml = YAML.dump Oj.load(json)
 
       # Colorize bools
-      yaml.gsub!(/\: (true|ok)$/, ': ' + 'true'.green)
-      yaml.gsub!(/\: false$/, ': ' + 'false'.red)
+      yaml.gsub!(/: (true|ok)$/, ": #{'true'.green}")
+      yaml.gsub!(/: false$/, ": #{'false'.red}")
 
       puts yaml
     end

data/lib/cliver/dependency_ext.rb

@@ -1,21 +1,24 @@
+# frozen_string_literal: true
+
 module Cliver
   class Dependency
     # Memoized shortcut for detect
     # Returns the path to the detected dependency
     # Raises an error if the dependency was not satisfied
     def path
-      @detected_path ||= detect!
+      @path ||= detect!
     end
 
     # Returns the version of the resolved dependency
     def version
-      return @detected_version if defined? @detected_version
+      return @version if defined? @version
+
       version = installed_versions.find { |p, _v| p == path }
       @detected_version = version.nil? ? nil : version[1]
     end
 
     def major_version
-      version.split('.').first if version
+      version&.split('.')&.first
     end
   end
 end

data/lib/site-inspector.rb

@@ -1,10 +1,15 @@
+# frozen_string_literal: true
+
 require 'open-uri'
 require 'addressable/uri'
 require 'public_suffix'
 require 'typhoeus'
 require 'parallel'
 require 'cliver'
+require 'whois'
 require 'cgi'
+require 'resolv'
+require 'dotenv/load'
 
 require_relative 'site-inspector/cache'
 require_relative 'site-inspector/disk_cache'
@@ -19,6 +24,8 @@ require_relative 'site-inspector/checks/hsts'
 require_relative 'site-inspector/checks/https'
 require_relative 'site-inspector/checks/sniffer'
 require_relative 'site-inspector/checks/cookies'
+require_relative 'site-inspector/checks/whois'
+require_relative 'site-inspector/checks/wappalyzer'
 require_relative 'site-inspector/endpoint'
 require_relative 'site-inspector/version'
 require_relative 'cliver/dependency_ext'
@@ -29,12 +36,12 @@ class SiteInspector
 
     def cache
       @cache ||= if ENV['CACHE']
-        SiteInspector::DiskCache.new
-      elsif Object.const_defined?('Rails')
-        SiteInspector::RailsCache.new
-      else
-        SiteInspector::Cache.new
-      end
+                   SiteInspector::DiskCache.new
+                 elsif Object.const_defined?('Rails')
+                   SiteInspector::RailsCache.new
+                 else
+                   SiteInspector::Cache.new
+                 end
     end
 
     def timeout
@@ -47,11 +54,11 @@ class SiteInspector
 
     def typhoeus_defaults
       defaults = {
-        followlocation:  false,
-        timeout:         SiteInspector.timeout,
+        followlocation: false,
+        timeout: SiteInspector.timeout,
         accept_encoding: 'gzip',
-        method:          :head,
-        headers:         {
+        method: :head,
+        headers: {
           'User-Agent' => "Mozilla/5.0 (compatible; SiteInspector/#{SiteInspector::VERSION}; +https://github.com/benbalter/site-inspector)"
         }
       }
@@ -67,7 +74,7 @@ class SiteInspector
 end
 
 if ENV['DEBUG']
-  Ethon.logger = Logger.new(STDOUT)
+  Ethon.logger = Logger.new($stdout)
   Ethon.logger.level = Logger::DEBUG
   Typhoeus::Config.verbose = true
 end

data/lib/site-inspector/cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SiteInspector
   class Cache
     def memory

data/lib/site-inspector/checks/accessibility.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'open3'
 
@@ -7,24 +9,28 @@ class SiteInspector
       class Pa11yError < RuntimeError; end
 
       STANDARDS = {
-        section508: 'Section508', # Default standard
-        wcag2a:     'WCAG2A',
-        wcag2aa:    'WCAG2AA',
-        wcag2aaa:   'WCAG2AAA'
-      }
+        wcag2a: 'WCAG2A', # Default standard
+        wcag2aa: 'WCAG2AA',
+        wcag2aaa: 'WCAG2AAA',
+        section508: 'Section508'
+      }.freeze
 
       DEFAULT_LEVEL = :error
 
-      REQUIRED_PA11Y_VERSION = '~> 2.1'
+      REQUIRED_PA11Y_VERSION = '~> 5.0'
 
       class << self
         def pa11y_version
-          @pa11y_version ||= pa11y.version
+          @pa11y_version ||= begin
+            output, status = run_command('--version')
+            output.strip if status.exitstatus.zero?
+          end
         end
 
         def pa11y?
           return @pa11y_detected if defined? @pa11y_detected
-          @pa11y_detected = !!(pa11y.detect)
+
+          @pa11y_detected = !!pa11y.detect
         end
 
         def enabled?
@@ -35,9 +41,13 @@ class SiteInspector
           @pa11y ||= begin
             node_bin = File.expand_path('../../../node_modules/pa11y/bin', File.dirname(__FILE__))
             path = ['*', node_bin].join(File::PATH_SEPARATOR)
-            Cliver::Dependency.new('pa11y', REQUIRED_PA11Y_VERSION, path: path)
+            Cliver::Dependency.new('pa11y.js', REQUIRED_PA11Y_VERSION, path: path)
           end
         end
+
+        def run_command(args)
+          Open3.capture2e(pa11y.detect, *args)
+        end
       end
 
       def level
@@ -45,12 +55,13 @@ class SiteInspector
       end
 
       def level=(level)
-        fail ArgumentError, "Invalid level '#{level}'" unless [:error, :warning, :notice].include?(level)
+        raise ArgumentError, "Invalid level '#{level}'" unless %i[error warning notice].include?(level)
+
         @level = level
       end
 
       def standard?(standard)
-        STANDARDS.keys.include?(standard)
+        STANDARDS.key?(standard)
       end
 
       def standard
@@ -58,7 +69,8 @@ class SiteInspector
       end
 
       def standard=(standard)
-        fail ArgumentError, "Unknown standard '#{standard}'" unless standard?(standard)
+        raise ArgumentError, "Unknown standard '#{standard}'" unless standard?(standard)
+
         @standard = standard
       end
 
@@ -75,7 +87,7 @@ class SiteInspector
       rescue Pa11yError
         nil
       end
-      alias_method :to_h, :check
+      alias to_h check
 
       def method_missing(method_sym, *arguments, &block)
         if standard?(method_sym)
@@ -85,7 +97,7 @@ class SiteInspector
         end
       end
 
-      def respond_to?(method_sym, include_private = false)
+      def respond_to_missing?(method_sym, include_private = false)
         if standard?(method_sym)
           true
         else
@@ -97,7 +109,7 @@ class SiteInspector
 
       def run_pa11y(standard)
         self.class.pa11y.detect! unless ENV['SKIP_PA11Y_CHECK']
-        fail ArgumentError, "Unknown standard '#{standard}'" unless standard?(standard)
+        raise ArgumentError, "Unknown standard '#{standard}'" unless standard?(standard)
 
         args = [
           '--standard', STANDARDS[standard],
@@ -105,23 +117,19 @@ class SiteInspector
           '--level',    level.to_s,
           endpoint.uri.to_s
         ]
-        output, status = run_command(args)
+        output, status = self.class.run_command(args)
 
         # Pa11y exit codes: https://github.com/nature/pa11y#exit-codes
         # 0: No errors, 1: Technical error within pa11y, 2: accessibility error (configurable via --level)
-        fail Pa11yError if status == 1
+        raise Pa11yError if status.exitstatus == 1
 
         {
-          valid:   status == 0,
+          valid: status.exitstatus.zero?,
           results: JSON.parse(output)
         }
       rescue Pa11yError, JSON::ParserError
         raise Pa11yError, "Command `pa11y #{args.join(' ')}` failed: #{output}"
       end
-
-      def run_command(args)
-        Open3.capture2e(self.class.pa11y.path, *args)
-      end
     end
   end
 end