site-inspector 3.1.0 → 3.1.1

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

@@ -4,15 +4,15 @@ class SiteInspector
       class LocalhostError < StandardError; end
 
       def self.resolver
-        require "dnsruby"
+        require 'dnsruby'
         @resolver ||= begin
           resolver = Dnsruby::Resolver.new
-          resolver.config.nameserver = ["8.8.8.8", "8.8.4.4"]
+          resolver.config.nameserver = ['8.8.8.8', '8.8.4.4']
           resolver
         end
       end
 
-      def query(type="ANY")
+      def query(type = 'ANY')
         SiteInspector::Endpoint::Dns.resolver.query(host.to_s, type).answer
       rescue Dnsruby::ResolvTimeout, Dnsruby::ServFail, Dnsruby::NXDomain
         []
@@ -22,20 +22,21 @@ class SiteInspector
         @records ||= query
       end
 
-      def has_record?(type)
+      def record?(type)
         records.any? { |record| record.type == type } || query(type).count != 0
       end
+      alias_method :has_record?, :record?
 
       def dnssec?
-        @dnssec ||= has_record? "DNSKEY"
+        @dnssec ||= has_record? 'DNSKEY'
       end
 
       def ipv6?
-        @ipv6 ||= has_record? "AAAA"
+        @ipv6 ||= has_record? 'AAAA'
       end
 
       def cdn
-        detect_by_hostname "cdn"
+        detect_by_hostname 'cdn'
       end
 
       def cdn?
@@ -43,7 +44,7 @@ class SiteInspector
       end
 
       def cloud_provider
-        detect_by_hostname "cloud"
+        detect_by_hostname 'cloud'
       end
 
       def cloud?
@@ -52,7 +53,7 @@ class SiteInspector
 
       def google_apps?
         @google ||= records.any? do |record|
-          record.type == "MX" && record.exchange.to_s =~ /google(mail)?\.com\.?$/
+          record.type == 'MX' && record.exchange.to_s =~ /google(mail)?\.com\.?\z/i
         end
       end
 
@@ -75,7 +76,7 @@ class SiteInspector
       end
 
       def cnames
-        @cnames ||= records.select { |record| record.type == "CNAME" }.map do |record|
+        @cnames ||= records.select { |record| record.type == 'CNAME' }.map do |record|
           PublicSuffix.parse(record.cname.to_s)
         end
       end
@@ -85,15 +86,15 @@ class SiteInspector
       end
 
       def to_h
-        return { :error => LocalhostError } if localhost?
+        return { error: LocalhostError } if localhost?
         {
-          :dnssec => dnssec?,
-          :ipv6   => ipv6?,
-          :cdn    => cdn,
-          :cloud_provider => cloud_provider,
-          :google_apps => google_apps?,
-          :hostname => hostname,
-          :ip => ip
+          dnssec:         dnssec?,
+          ipv6:           ipv6?,
+          cdn:            cdn,
+          cloud_provider: cloud_provider,
+          google_apps:    google_apps?,
+          hostname:       hostname,
+          ip:             ip
         }
       end
 
@@ -115,7 +116,7 @@ class SiteInspector
 
       def detect_by_hostname(type)
         haystack = load_data(type)
-        needle = haystack.find do |name, domain|
+        needle = haystack.find do |_name, domain|
           cnames.any? do |cname|
             domain == cname.tld || domain == "#{cname.sld}.#{cname.tld}"
           end
@@ -124,7 +125,7 @@ class SiteInspector
         return needle[0].to_sym if needle
         return nil unless hostname
 
-        needle = haystack.find do |name, domain|
+        needle = haystack.find do |_name, domain|
           domain == hostname.tld || domain == "#{hostname.sld}.#{hostname.tld}"
         end
 

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

@@ -1,7 +1,6 @@
 class SiteInspector
   class Endpoint
     class Headers < Check
-
       # TODO: kill this
       def strict_transport_security?
         !!strict_transport_security
@@ -19,33 +18,33 @@ class SiteInspector
 
       # TODO: kill this
       def strict_transport_security
-        headers["strict-transport-security"]
+        headers['strict-transport-security']
       end
 
       def content_security_policy
-        headers["content-security-policy"]
+        headers['content-security-policy']
       end
 
       def click_jacking_protection
-        headers["x-frame-options"]
+        headers['x-frame-options']
       end
 
       def server
-        headers["server"]
+        headers['server']
       end
 
       def xss_protection
-        headers["x-xss-protection"]
+        headers['x-xss-protection']
       end
 
       # more specific checks than presence of headers
       def xss_protection?
-        xss_protection == "1; mode=block"
+        xss_protection == '1; mode=block'
       end
 
       # Returns an array of hashes of downcased key/value header pairs (or an empty hash)
       def all
-        @all ||= (response && response.headers) ? Hash[response.headers.map{ |k,v| [k.downcase,v] }] : {}
+        @all ||= (response && response.headers) ? Hash[response.headers.map { |k, v| [k.downcase, v] }] : {}
       end
       alias_method :headers, :all
 
@@ -55,11 +54,11 @@ class SiteInspector
 
       def to_h
         {
-          :strict_transport_security => strict_transport_security || false,
-          :content_security_policy => content_security_policy || false,
-          :click_jacking_protection => click_jacking_protection || false,
-          :server => server,
-          :xss_protection => xss_protection || false,
+          strict_transport_security: strict_transport_security || false,
+          content_security_policy:   content_security_policy || false,
+          click_jacking_protection:  click_jacking_protection || false,
+          server:                    server,
+          xss_protection:            xss_protection || false
         }
       end
     end

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

@@ -3,7 +3,6 @@ class SiteInspector
     # Utility parser for HSTS headers.
     # RFC: http://tools.ietf.org/html/rfc6797
     class Hsts < Check
-
       def valid?
         return false unless header
         pairs.none? { |key, value| "#{key}#{value}" =~ /[\s\'\"]/ }
@@ -28,17 +27,17 @@ class SiteInspector
 
       # Google's minimum max-age for automatic preloading
       def preload_ready?
-        include_subdomains? and preload? and max_age >= 10886400
+        include_subdomains? && preload? && max_age >= 10_886_400
       end
 
       def to_h
         {
-          valid: valid?,
-          max_age: max_age,
+          valid:              valid?,
+          max_age:            max_age,
           include_subdomains: include_subdomains?,
-          preload: preload?,
-          enabled: enabled?,
-          preload_ready: preload_ready?
+          preload:            preload?,
+          enabled:            enabled?,
+          preload_ready:      preload_ready?
         }
       end
 
@@ -49,7 +48,7 @@ class SiteInspector
       end
 
       def header
-        @header ||= headers["strict-transport-security"]
+        @header ||= headers['strict-transport-security']
       end
 
       def directives
@@ -60,7 +59,7 @@ class SiteInspector
         @pairs ||= begin
           pairs = {}
           directives.each do |directive|
-            key, value = directive.downcase.split("=")
+            key, value = directive.downcase.split('=')
 
             if value =~ /\".*\"/
               value = value.sub(/^\"/, '')

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

@@ -1,9 +1,8 @@
 class SiteInspector
   class Endpoint
     class Https < Check
-
       def scheme?
-        scheme == "https"
+        scheme == 'https'
       end
 
       def valid?
@@ -24,8 +23,8 @@ class SiteInspector
 
       def to_h
         {
-          valid: valid?,
-          return_code: response.return_code,
+          valid:       valid?,
+          return_code: response.return_code
         }
       end
 
@@ -34,7 +33,6 @@ class SiteInspector
       def scheme
         @scheme ||= request.base_url.scheme
       end
-
     end
   end
 end

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

@@ -1,7 +1,6 @@
 class SiteInspector
   class Endpoint
     class Sniffer < Check
-
       OPEN_SOURCE_FRAMEWORKS = [
         # Sniffles
         :drupal,
@@ -20,9 +19,9 @@ class SiteInspector
         cms = sniff :cms
         return cms unless cms.nil?
         return :expression_engine if endpoint.cookies.any? { |c| c.keys.first =~ /^exp_/ }
-        return :php if endpoint.cookies["PHPSESSID"]
-        return :coldfusion if endpoint.cookies["CFID"] && endpoint.cookies["CFTOKEN"]
-        return :cowboy if endpoint.headers.server.to_s.downcase == "cowboy"
+        return :php if endpoint.cookies['PHPSESSID']
+        return :coldfusion if endpoint.cookies['CFID'] && endpoint.cookies['CFTOKEN']
+        return :cowboy if endpoint.headers.server.to_s.downcase == 'cowboy'
         nil
       end
 
@@ -44,10 +43,10 @@ class SiteInspector
 
       def to_h
         {
-          :framework   => framework,
-          :analytics   => analytics,
-          :javascript  => javascript,
-          :advertising => advertising
+          framework:   framework,
+          analytics:   analytics,
+          javascript:  javascript,
+          advertising: advertising
         }
       end
 
@@ -55,7 +54,7 @@ class SiteInspector
 
       def sniff(type)
         require 'sniffles'
-        results = Sniffles.sniff(endpoint.content.body, type).select { |name, meta| meta[:found] }
+        results = Sniffles.sniff(endpoint.content.body, type).select { |_name, meta| meta[:found] }
         results.keys.first if results
       rescue
         nil

data/lib/site-inspector/domain.rb

@@ -1,23 +1,22 @@
 class SiteInspector
   class Domain
-
     attr_reader :host
 
     def initialize(host)
       host = host.downcase
-      host = host.sub /^https?\:/, ""
-      host = host.sub /^\/+/, ""
-      host = host.sub /^www\./, ""
+      host = host.sub(/^https?\:/, '')
+      host = host.sub(%r{^/+}, '')
+      host = host.sub(/^www\./, '')
       uri = Addressable::URI.parse "//#{host}"
       @host = uri.host
     end
 
     def endpoints
       @endpoints ||= [
-        Endpoint.new("https://#{host}", :domain => self),
-        Endpoint.new("https://www.#{host}", :domain => self),
-        Endpoint.new("http://#{host}", :domain => self),
-        Endpoint.new("http://www.#{host}", :domain => self)
+        Endpoint.new("https://#{host}", domain: self),
+        Endpoint.new("https://www.#{host}", domain: self),
+        Endpoint.new("http://#{host}", domain: self),
+        Endpoint.new("http://www.#{host}", domain: self)
       ]
     end
 
@@ -37,16 +36,15 @@ class SiteInspector
 
     # Does *any* endpoint return a 200 or 300 response code?
     def up?
-      endpoints.any? { |e| e.up? }
+      endpoints.any?(&:up?)
     end
 
     # Does *any* endpoint respond to HTTP?
     # TODO: needs to allow an invalid chain.
     def responds?
-      endpoints.any? { |e| e.responds? }
+      endpoints.any?(&:responds?)
     end
 
-
     # TODO: These weren't present before, and may not be useful.
     # Can you connect to www?
     def www?
@@ -84,7 +82,7 @@ class SiteInspector
     # TODO: don't need to require that the HTTPS cert is valid for this purpose.
     def enforces_https?
       return false unless https?
-      endpoints.select { |e| e.http? }.all? { |e| !e.up? || (e.redirect && e.redirect.https?) }
+      endpoints.select(&:http?).all? { |e| !e.up? || (e.redirect && e.redirect.https?) }
     end
 
     # we can say that a canonical HTTPS site "defaults" to HTTPS,
@@ -93,7 +91,7 @@ class SiteInspector
     #
     # TODO: not implemented.
     def defaults_https?
-      raise "Not implemented. Halp?"
+      fail 'Not implemented. Halp?'
     end
 
     # HTTPS is "downgraded" if both:
@@ -128,10 +126,10 @@ class SiteInspector
       return false unless www?
 
       # Are both root endpoints down?
-      return true if endpoints.select { |e| e.root? }.all? { |e| !e.up? }
+      return true if endpoints.select(&:root?).all? { |e| !e.up? }
 
       # Does either root endpoint redirect to a www endpoint?
-      endpoints.select { |e| e.root? }.any? { |e| e.redirect && e.redirect.www? }
+      endpoints.select(&:root?).any? { |e| e.redirect && e.redirect.www? }
     end
 
     # A domain is "canonically" at https if:
@@ -159,10 +157,10 @@ class SiteInspector
       return false unless https?
 
       # Both http endpoints are down
-      return true if endpoints.select { |e| e.http? }.all? { |e| !e.up? }
+      return true if endpoints.select(&:http?).all? { |e| !e.up? }
 
       # at least one http endpoint redirects immediately to https
-      endpoints.select { |e| e.http? }.any? { |e| e.redirect && e.redirect.https? }
+      endpoints.select(&:http?).any? { |e| e.redirect && e.redirect.https? }
     end
 
     # A domain redirects if
@@ -175,7 +173,7 @@ class SiteInspector
 
     # The first endpoint to respond with a redirect
     def redirect
-      endpoints.find { |e| e.external_redirect? }
+      endpoints.find(&:external_redirect?)
     end
 
     # HSTS on the canonical domain?
@@ -223,7 +221,7 @@ class SiteInspector
     #  :all - return information about all endpoints
     #
     # Returns a complete hash of the domain's information
-    def to_h(options={})
+    def to_h(options = {})
       prefetch
 
       hash = {
@@ -244,19 +242,17 @@ class SiteInspector
         canonical_endpoint: canonical_endpoint.to_h(options)
       }
 
-      if options["all"]
-        hash.merge!({
-          endpoints: {
-            https: {
-              root: endpoints[0].to_h(options),
-              www:  endpoints[1].to_h(options)
-            },
-            http: {
-              root: endpoints[2].to_h(options),
-              www:  endpoints[3].to_h(options)
-            }
-          }
-        })
+      if options['all']
+        hash.merge!(endpoints: {
+                      https: {
+                        root: endpoints[0].to_h(options),
+                        www:  endpoints[1].to_h(options)
+                      },
+                      http:  {
+                        root: endpoints[2].to_h(options),
+                        www:  endpoints[3].to_h(options)
+                      }
+                    })
       end
 
       hash

data/lib/site-inspector/endpoint.rb

@@ -17,12 +17,12 @@ class SiteInspector
     # endpoint - (string) the endpoint to query (e.g., `https://example.com`)
     # options  - A hash of options
     #   domain - the parent domain object, if passed, facilitates caching of redirects
-    def initialize(host, options={})
+    def initialize(host, options = {})
       @uri = Addressable::URI.parse(host.downcase)
       # The root URL always has an implict path of "/", even if not requested
       # Make it explicit to facilitate caching and prevent a potential redirect
-      @uri.path = "/"
-      @host = uri.host.sub(/^www\./, "")
+      @uri.path = '/'
+      @host = uri.host.sub(/^www\./, '')
       @checks = {}
       @domain = options[:domain]
     end
@@ -72,24 +72,24 @@ class SiteInspector
 
     # Does the endpoint return a 2xx or 3xx response code?
     def up?
-      response && response_code.start_with?("2") || response_code.start_with?("3")
+      response && response_code.start_with?('2') || response_code.start_with?('3')
     end
 
     # Does the server respond at all?
     def responds?
-       response.code != 0 && !timed_out?
+      response.code != 0 && !timed_out?
     end
 
     # If the domain is a redirect, what's the first endpoint we're redirected to?
     def redirect
-      return unless response && response_code.start_with?("3")
+      return unless response && response_code.start_with?('3')
 
       @redirect ||= begin
-        redirect = Addressable::URI.parse(headers["location"])
+        redirect = Addressable::URI.parse(headers['location'])
 
         # This is a relative redirect, but we still need the absolute URI
         if redirect.relative?
-          redirect.path = "/#{redirect.path}" unless redirect.path[0] == "/"
+          redirect.path = "/#{redirect.path}" unless redirect.path[0] == '/'
           redirect.host = host
           redirect.scheme = scheme
         end
@@ -116,12 +116,12 @@ class SiteInspector
       return redirect unless redirect.redirect?
 
       @resolves_to ||= begin
-        response = request(:followlocation => true)
+        response = request(followlocation: true)
 
         # Workaround for Webmock not playing nicely with Typhoeus redirects
         if response.mock?
-          if response.headers["Location"]
-            url = response.headers["Location"]
+          if response.headers['Location']
+            url = response.headers['Location']
           else
             url = response.request.url
           end
@@ -142,7 +142,7 @@ class SiteInspector
     end
 
     def inspect
-      "#<SiteInspector::Endpoint uri=\"#{uri.to_s}\">"
+      "#<SiteInspector::Endpoint uri=\"#{uri}\">"
     end
 
     # Returns information about the endpoint
@@ -154,37 +154,39 @@ class SiteInspector
     #   a hash of check symbols and bools representing which checks should be run
     #
     # Returns the hash representing the endpoint and its checks
-    def to_h(options={})
+    def to_h(options = {})
       hash = {
-        uri: uri.to_s,
-        host: host,
-        www: www?,
-        https: https?,
-        scheme: scheme,
-        up: up?,
-        responds: responds?,
-        timed_out: timed_out?,
-        redirect: redirect?,
-        external_redirect: external_redirect?,
+        uri:               uri.to_s,
+        host:              host,
+        www:               www?,
+        https:             https?,
+        scheme:            scheme,
+        up:                up?,
+        responds:          responds?,
+        timed_out:         timed_out?,
+        redirect:          redirect?,
+        external_redirect: external_redirect?
       }
 
       # Either they've specifically asked for a check, or we throw everything at them
       checks = SiteInspector::Endpoint.checks.select { |c| options.keys.include?(c.name) }
       checks = SiteInspector::Endpoint.checks if checks.empty?
 
-      Parallel.each(checks, :in_threads => 4) do |check|
-        hash[check.name] = self.send(check.name).to_h
+      Parallel.each(checks, in_threads: 4) do |check|
+        hash[check.name] = send(check.name).to_h
       end
 
       hash
     end
 
     def self.checks
-      ObjectSpace.each_object(Class).select { |klass| klass < Check }.select { |check| check.enabled? }
+      return @checks if defined? @checks
+      @checks = ObjectSpace.each_object(Class).select { |klass| klass < Check }.select(&:enabled?)
     end
 
     def method_missing(method_sym, *arguments, &block)
-      if check = SiteInspector::Endpoint.checks.find { |c| c.name == method_sym }
+      check = SiteInspector::Endpoint.checks.find { |c| c.name == method_sym }
+      if check
         @checks[method_sym] ||= check.new(self)
       else
         super
@@ -209,11 +211,8 @@ class SiteInspector
     # Try to return the existing endpoint, rather than create a new one
     def find_or_create_by_uri(uri)
       uri = Addressable::URI.parse(uri.downcase)
-      if domain && cached_endpoint = domain.endpoints.find { |e| e.uri.to_s == uri.to_s }
-        cached_endpoint
-      else
-        Endpoint.new(uri.to_s)
-      end
+      cached_endpoint = domain.endpoints.find { |e| e.uri.to_s == uri.to_s } if domain
+      cached_endpoint || Endpoint.new(uri.to_s)
     end
   end
 end