site-inspector 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56a9e64300435fa494e8ae17ca710b46238bcffd
-  data.tar.gz: 1e552e430d8f1fea10eba7d873e1ae17aab00415
+  metadata.gz: 6884b52732376fcd208b761e6b441f52c8ff383d
+  data.tar.gz: a6d6268ce73a44108f4ec490da07d7b23257981d
 SHA512:
-  metadata.gz: 96eaaa8846783ef2b9dfe5b76e84ebd3c160139c425c69edc25761828690b2d508770aa842e234cbb63e9f6ecaa8bb7ffc7b2121a9449d934928938a9a9ec637
-  data.tar.gz: b3b4d86a6b6ead26b17eb380b27a5da37afd645c582b94b53860eb1948e28c8cf6baec1c088ace2a53ebdb4e755a316bb635236b9b46c36cb60f1012581c5500
+  metadata.gz: c0c672eb141da7b5522b4ea9191024a13d08f37c3d91b11b8771f649596ff38f587cc98a95ce6cf6bb80f6f060d71068a51c45d132517e7a6a4237f7cb54d9d8
+  data.tar.gz: a1251d75b522286e2ff9889b347b4bf73440b2932f89acc9b4840d1b2c40ad7cbded89feca80e278f8120f9b1976d658860a75bd747c25921df4b55efcd365e8

data/.rubocop.yml

@@ -0,0 +1,34 @@
+Metrics/LineLength:
+  Enabled: false
+
+Style/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Lint/EndAlignment:
+  AlignWith: variable
+  AutoCorrect: true
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+  
+Style/ClassVars:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.1.4
+2.3.0

data/Gemfile

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

data/Guardfile

@@ -1,7 +1,7 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'rake', :task => 'test' do
+guard 'rake', task: 'test' do
   watch(%r{^test/.+$})
   watch(%r{^lib/.+$})
   watch(%r{^views/.+$})

data/README.md

@@ -150,7 +150,7 @@ Uses the `pa11y` CLI to run automated accessibility tests. Requires `node`. To i
 ```ruby
 class SiteInspector
   class Endpoint
-    class Mention
+    class Mention < Check
       def mentions_ben?
         endpoint.content.body =~ /ben/i
       end
@@ -159,6 +159,11 @@ class SiteInspector
 end
 ```
 
+This check can then be used as follows:
+```
+domain.canonical_endpoint.mention.mentions_ben?
+```
+
 Checks can call the `endpoint` object, which, contains the request, response, and other checks. Custom checks are automatically exposed as endpoint methods.
 
 ## Contributing

data/Rakefile

@@ -1,8 +1,8 @@
 require './lib/site-inspector'
 require 'rspec/core/rake_task'
 
-desc "Run specs"
+desc 'Run specs'
 RSpec::Core::RakeTask.new do |t|
   t.pattern = 'spec/**/*_spec.rb'
-  t.rspec_opts = ["--order", "rand", "--color"]
+  t.rspec_opts = ['--order', 'rand', '--color']
 end

data/bin/site-inspector

@@ -1,27 +1,27 @@
 #!/usr/bin/env ruby
 
-require "mercenary"
-require "oj"
+require 'mercenary'
+require 'oj'
 require 'yaml'
 require 'colorator'
-require_relative "../lib/site-inspector"
+require_relative '../lib/site-inspector'
 
 def stringify_keys_deep!(h)
-    h.keys.each 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].kind_of? Hash
-    end
+  h.keys.each 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
+  end
 end
 
 Mercenary.program(:"site-inspector") do |p|
   p.version SiteInspector::VERSION
   p.description "Returns information about a domain's technology and capabilities"
-  p.syntax "site-inspector <command> <domain> [options]"
+  p.syntax 'site-inspector <command> <domain> [options]'
 
   p.command(:inspect) do |c|
-    c.syntax "inspect <domain> [options]"
-    c.description "inspects a domain"
+    c.syntax 'inspect <domain> [options]'
+    c.description 'inspects a domain'
     c.option 'json', '-j', '--json', 'JSON encode the output'
     c.option 'all', '-a', '--all', 'return results for all endpoints (defaults to only the canonical endpoint)'
 
@@ -30,7 +30,7 @@ Mercenary.program(:"site-inspector") do |p|
     end
 
     c.action do |args, options|
-      next c.logger.fatal "Must specify a domain" if args.length != 1
+      next c.logger.fatal 'Must specify a domain' if args.length != 1
 
       # Build our domain hash as requested
       domain = SiteInspector.inspect(args[0])
@@ -38,15 +38,15 @@ Mercenary.program(:"site-inspector") do |p|
       json = Oj.dump(hash, indent: 2, mode: :compat)
 
       # Dump the JSON and run
-      next puts json if options["json"]
+      next puts json if options['json']
 
       # This is a dirty, dirty hack, but it's a simple way to stringify keys recursively
       # And format the output in a human-readable way
       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

@@ -0,0 +1,21 @@
+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!
+    end
+
+    # Returns the version of the resolved dependency
+    def version
+      return @detected_version if defined? @detected_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
+    end
+  end
+end

data/lib/site-inspector.rb

@@ -21,11 +21,11 @@ require_relative 'site-inspector/checks/sniffer'
 require_relative 'site-inspector/checks/cookies'
 require_relative 'site-inspector/endpoint'
 require_relative 'site-inspector/version'
+require_relative 'cliver/dependency_ext'
 
 class SiteInspector
   class << self
-
-    attr_writer :timeout, :cache
+    attr_writer :timeout, :cache, :typhoeus_options
 
     def cache
       @cache ||= if ENV['CACHE']
@@ -46,15 +46,17 @@ class SiteInspector
     end
 
     def typhoeus_defaults
-      {
-        :followlocation => false,
-        :timeout => SiteInspector.timeout,
-        :accept_encoding => "gzip",
-        :method => :head,
-        :headers => {
-          "User-Agent" => "Mozilla/5.0 (compatible; SiteInspector/#{SiteInspector::VERSION}; +https://github.com/benbalter/site-inspector)"
+      defaults = {
+        followlocation:  false,
+        timeout:         SiteInspector.timeout,
+        accept_encoding: 'gzip',
+        method:          :head,
+        headers:         {
+          'User-Agent' => "Mozilla/5.0 (compatible; SiteInspector/#{SiteInspector::VERSION}; +https://github.com/benbalter/site-inspector)"
         }
       }
+      defaults.merge! @typhoeus_options if @typhoeus_options
+      defaults
     end
 
     # Returns a thread-safe, memoized hydra instance
@@ -64,8 +66,8 @@ class SiteInspector
   end
 end
 
-if ENV["DEBUG"]
-  Ethon.logger = Logger.new(STDOUT);
+if ENV['DEBUG']
+  Ethon.logger = Logger.new(STDOUT)
   Ethon.logger.level = Logger::DEBUG
   Typhoeus::Config.verbose = true
 end

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

@@ -15,19 +15,29 @@ class SiteInspector
 
       DEFAULT_LEVEL = :error
 
+      REQUIRED_PA11Y_VERSION = '~> 2.1'
+
       class << self
         def pa11y_version
-          output, status = Open3.capture2e("pa11y", "--version")
-          output.strip if status == 0
+          @pa11y_version ||= pa11y.version
         end
 
         def pa11y?
-          !!(Cliver.detect('pa11y'))
+          return @pa11y_detected if defined? @pa11y_detected
+          @pa11y_detected = !!(pa11y.detect)
         end
 
         def enabled?
           @@enabled && pa11y?
         end
+
+        def pa11y
+          @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)
+          end
+        end
       end
 
       def level
@@ -35,7 +45,7 @@ class SiteInspector
       end
 
       def level=(level)
-        raise ArgumentError, "Invalid level '#{level}'" unless [:error, :warning, :notice].include?(level)
+        fail ArgumentError, "Invalid level '#{level}'" unless [:error, :warning, :notice].include?(level)
         @level = level
       end
 
@@ -48,7 +58,7 @@ class SiteInspector
       end
 
       def standard=(standard)
-        raise ArgumentError, "Unknown standard '#{standard}'" unless standard?(standard)
+        fail ArgumentError, "Unknown standard '#{standard}'" unless standard?(standard)
         @standard = standard
       end
 
@@ -57,11 +67,11 @@ class SiteInspector
       end
 
       def errors
-        check[:results].count { |r| r["type"] == "error" } if check
+        check[:results].count { |r| r['type'] == 'error' } if check
       end
 
       def check
-        @check ||= pa11y(standard)
+        @check ||= run_pa11y(standard)
       rescue Pa11yError
         nil
       end
@@ -69,7 +79,7 @@ class SiteInspector
 
       def method_missing(method_sym, *arguments, &block)
         if standard?(method_sym)
-          pa11y(method_sym)
+          run_pa11y(method_sym)
         else
           super
         end
@@ -85,32 +95,32 @@ class SiteInspector
 
       private
 
-      def pa11y(standard)
-        Cliver.assert('pa11y')
-        raise ArgumentError, "Unknown standard '#{standard}'" unless standard?(standard)
+      def run_pa11y(standard)
+        self.class.pa11y.detect! unless ENV['SKIP_PA11Y_CHECK']
+        fail ArgumentError, "Unknown standard '#{standard}'" unless standard?(standard)
 
         args = [
-          "--standard", STANDARDS[standard],
-          "--reporter", "json",
-          "--level",    level.to_s,
+          '--standard', STANDARDS[standard],
+          '--reporter', 'json',
+          '--level',    level.to_s,
           endpoint.uri.to_s
         ]
         output, status = 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)
-        raise Pa11yError if status == 1
+        fail Pa11yError if status == 1
 
         {
           valid:   status == 0,
           results: JSON.parse(output)
         }
       rescue Pa11yError, JSON::ParserError
-        raise Pa11yError, "Command `pa11y #{args.join(" ")}` failed: #{output}"
+        raise Pa11yError, "Command `pa11y #{args.join(' ')}` failed: #{output}"
       end
 
       def run_command(args)
-        Open3.capture2e("pa11y", *args)
+        Open3.capture2e(self.class.pa11y.path, *args)
       end
     end
   end

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

@@ -1,7 +1,6 @@
 class SiteInspector
   class Endpoint
     class Check
-
       attr_reader :endpoint
 
       # A check is an abstract class that takes an Endpoint object
@@ -34,11 +33,10 @@ class SiteInspector
       end
 
       class << self
-
         @@enabled = true
 
         def name
-          self.to_s.split('::').last.downcase.to_sym
+          to_s.split('::').last.downcase.to_sym
         end
 
         def enabled?

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

@@ -9,7 +9,7 @@ class SiteInspector
       # The default Check#response method is from a HEAD request
       # The content check has a special response which includes the body from a GET request
       def response
-        @response ||= endpoint.request(:method => :get)
+        @response ||= endpoint.request(method: :get)
       end
 
       def document
@@ -19,19 +19,19 @@ class SiteInspector
       alias_method :doc, :document
 
       def body
-        @body ||= document.to_s.force_encoding("UTF-8").encode("UTF-8", :invalid => :replace, :replace => "")
+        @body ||= document.to_s.force_encoding('UTF-8').encode('UTF-8', invalid: :replace, replace: '')
       end
 
       def robots_txt?
-        @bodts_txt ||= path_exists?("robots.txt") if proper_404s?
+        @bodts_txt ||= path_exists?('robots.txt') if proper_404s?
       end
 
       def sitemap_xml?
-        @sitemap_xml ||= path_exists?("sitemap.xml") if proper_404s?
+        @sitemap_xml ||= path_exists?('sitemap.xml') if proper_404s?
       end
 
       def humans_txt?
-        @humans_txt ||= path_exists?("humans.txt") if proper_404s?
+        @humans_txt ||= path_exists?('humans.txt') if proper_404s?
       end
 
       def doctype
@@ -41,7 +41,7 @@ class SiteInspector
       def prefetch
         return unless endpoint.up?
         options = SiteInspector.typhoeus_defaults.merge(followlocation: true)
-        ["robots.txt", "sitemap.xml", "humans.txt", random_path].each do |path|
+        ['robots.txt', 'sitemap.xml', 'humans.txt', random_path].each do |path|
           request = Typhoeus::Request.new(URI.join(endpoint.uri, path), options)
           SiteInspector.hydra.queue(request)
         end

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

@@ -1,7 +1,6 @@
 class SiteInspector
   class Endpoint
     class Cookies < Check
-
       def any?(&block)
         if cookie_header.nil? || cookie_header.empty?
           false
@@ -14,7 +13,7 @@ class SiteInspector
       alias_method :cookies?, :any?
 
       def all
-        @cookies ||= cookie_header.map { |c| CGI::Cookie::parse(c) } if cookies?
+        @cookies ||= cookie_header.map { |c| CGI::Cookie.parse(c) } if cookies?
       end
 
       def [](key)
@@ -22,14 +21,14 @@ class SiteInspector
       end
 
       def secure?
-        pairs = cookie_header.join("; ").split("; ") # CGI::Cookies#Parse doesn't seem to like secure headers
-        pairs.any? { |c| c.downcase == "secure" } && pairs.any? { |c| c.downcase == "httponly" }
+        pairs = cookie_header.join('; ').split('; ') # CGI::Cookies#Parse doesn't seem to like secure headers
+        pairs.any? { |c| c.downcase == 'secure' } && pairs.any? { |c| c.downcase == 'httponly' }
       end
 
       def to_h
         {
-          :cookie? => any?,
-          :secure? => secure?
+          cookie?: any?,
+          secure?: secure?
         }
       end
 
@@ -37,9 +36,8 @@ class SiteInspector
 
       def cookie_header
         # Cookie header may be an array or string, always return an array
-        [endpoint.headers.all["set-cookie"]].flatten.compact
+        [endpoint.headers.all['set-cookie']].flatten.compact
       end
-
     end
   end
 end