RubyGems - site-inspector - Versions diffs - 2.0.0 → 3.0.0 - Mend

site-inspector 2.0.0 → 3.0.0

Files changed (30) hide show

checksums.yaml +4 -4
data/.gitignore +2 -1
data/.travis.yml +4 -1
data/README.md +11 -2
data/lib/site-inspector/checks/accessibility.rb +114 -0
data/lib/site-inspector/checks/check.rb +4 -0
data/lib/site-inspector/checks/content.rb +6 -5
data/lib/site-inspector/checks/cookies.rb +45 -0
data/lib/site-inspector/checks/headers.rb +0 -16
data/lib/site-inspector/checks/sniffer.rb +28 -6
data/lib/site-inspector/disk_cache.rb +3 -1
data/lib/site-inspector/domain.rb +28 -10
data/lib/site-inspector/endpoint.rb +5 -8
data/lib/site-inspector/version.rb +1 -1
data/lib/site-inspector.rb +5 -1
data/package.json +23 -0
data/script/bootstrap +1 -0
data/script/cibuild +2 -0
data/site-inspector.gemspec +3 -2
data/spec/checks/site_inspector_endpoint_accessibility_spec.rb +81 -0
data/spec/checks/site_inspector_endpoint_check_spec.rb +4 -0
data/spec/checks/site_inspector_endpoint_content_spec.rb +20 -2
data/spec/checks/site_inspector_endpoint_cookies_spec.rb +72 -0
data/spec/checks/site_inspector_endpoint_headers_spec.rb +0 -10
data/spec/checks/site_inspector_endpoint_sniffer_spec.rb +99 -37
data/spec/{site_inspector_disc_cache_spec.rb → site_inspector_disk_cache_spec.rb} +13 -7
data/spec/site_inspector_domain_spec.rb +28 -6
data/spec/site_inspector_endpoint_spec.rb +32 -11
data/spec/site_inspector_spec.rb +1 -1
metadata +27 -6

data/spec/checks/site_inspector_endpoint_accessibility_spec.rb ADDED Viewed

@@ -0,0 +1,81 @@
+require 'spec_helper'
+describe SiteInspector::Endpoint::Accessibility do
+  subject do
+    endpoint = SiteInspector::Endpoint.new("http://example.com")
+    SiteInspector::Endpoint::Accessibility.new(endpoint)
+  end
+  it "retrieve's pa11y's version" do
+    expect(subject.class.pa11y_version).to match(/\d\.\d\.\d/)
+  end
+  it "responds to valid standards" do
+    expect(subject.respond_to?(:section508)).to eql(true)
+  end
+  it "knows the level" do
+    expect(subject.level).to eql(:error)
+  end
+  it "allows the user to set the level" do
+    subject.level = :warning
+    expect(subject.level).to eql(:warning)
+  end
+  it "errors on invalid levels" do
+    expect{subject.level="foo"}.to raise_error(ArgumentError)
+  end
+  it "knows the standard" do
+    expect(subject.standard).to eql(:section508)
+  end
+  it "allows the user to set the standard" do
+    subject.standard = :wcag2a
+    expect(subject.standard).to eql(:wcag2a)
+  end
+  it "errors on invalid standards" do
+    expect{subject.standard=:foo}.to raise_error(ArgumentError)
+  end
+  context "with pa11y installed" do
+    before do
+      stub_request(:get, "http://example.com/").to_return(:status => 200 )
+    end
+  end
+  context "with pa11y stub'd" do
+    before do
+      output = '[{"code":"Section508.L.NoContentAnchor","context":"<a href=\"foo\"></a>","message":"Anchor element found with a valid href attribute, but no link content has been supplied.","selector":"html > body > a","type":"error","typeCode":1}]'
+      allow(subject).to receive(:run_command) { [output, 2] }
+    end
+    it "knows if pa11y is installed" do
+      expect(subject.class.pa11y?).to eql(true)
+    end
+    it "knows if a site is valid" do
+      expect(subject.valid?).to eql(false)
+    end
+    it "counts the errors" do
+      expect(subject.errors).to eql(1)
+    end
+    it "runs the check" do
+      expect(subject.check[:valid]).to eql(false)
+      expect(subject.check[:results].first["code"]).to eql("Section508.L.NoContentAnchor")
+    end
+    it "runs a named check" do
+      expect(subject.check[:valid]).to eql(false)
+      expect(subject.check[:results].first["code"]).to eql("Section508.L.NoContentAnchor")
+    end
+  end
+end

data/spec/checks/site_inspector_endpoint_check_spec.rb CHANGED Viewed

@@ -31,4 +31,8 @@ describe SiteInspector::Endpoint::Check do
   it "returns the instance name" do
     expect(SiteInspector::Endpoint::Check.name).to eql(:check)
   end
+  it "enables the check" do
+    expect(SiteInspector::Endpoint::Check.enabled?).to eql(true)
+  end
 end

data/spec/checks/site_inspector_endpoint_content_spec.rb CHANGED Viewed

@@ -4,7 +4,7 @@ describe SiteInspector::Endpoint::Content do
   subject do
     body = <<-eos
-      <!DOCTYPE html>
+    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
       <html>
         <body>
           <h1>Some page</h1>
@@ -28,40 +28,52 @@ describe SiteInspector::Endpoint::Content do
   end
   it "returns the doctype" do
-    expect(subject.doctype).to eql("html")
+    expect(subject.doctype).to eql("-//W3C//DTD XHTML 1.0 Transitional//EN")
   end
   it "knows when robots.txt exists" do
+    stub_request(:get, /http\:\/\/example.com\/[a-z0-9]{32}/i).to_return(:status => 404)
     stub_request(:get, "http://example.com/robots.txt").
       to_return(:status => 200)
     expect(subject.robots_txt?).to eql(true)
   end
   it "knows when robots.txt doesn't exist" do
+    stub_request(:get, /http\:\/\/example.com\/[a-z0-9]{32}/i).to_return(:status => 404)
     stub_request(:get, "http://example.com/robots.txt").
       to_return(:status => 404)
     expect(subject.robots_txt?).to eql(false)
   end
   it "knows when sitemap.xml exists" do
+    stub_request(:get, /http\:\/\/example.com\/[a-z0-9]{32}/i).to_return(:status => 404)
     stub_request(:get, "http://example.com/sitemap.xml").
       to_return(:status => 200)
     expect(subject.sitemap_xml?).to eql(true)
   end
   it "knows when sitemap.xml exists" do
+    stub_request(:get, /http\:\/\/example.com\/[a-z0-9]{32}/i).to_return(:status => 404)
     stub_request(:get, "http://example.com/sitemap.xml").
       to_return(:status => 404)
     expect(subject.sitemap_xml?).to eql(false)
   end
   it "knows when humans.txt exists" do
+    stub_request(:get, /http\:\/\/example.com\/[a-z0-9]{32}/i).to_return(:status => 404)
     stub_request(:get, "http://example.com/humans.txt").
       to_return(:status => 200)
     expect(subject.humans_txt?).to eql(true)
   end
   it "knows when humans.txt doesn't exist" do
+    stub_request(:get, /http\:\/\/example.com\/[a-z0-9]{32}/i).to_return(:status => 404)
     stub_request(:get, "http://example.com/humans.txt").
       to_return(:status => 200)
     expect(subject.humans_txt?).to eql(true)
@@ -85,5 +97,11 @@ describe SiteInspector::Endpoint::Content do
       expect(path).to match /[a-z0-9]{32}/i
       expect(subject.send(:random_path)).to eql(path)
     end
+    it "doesn't say something exists when there are no 404s" do
+      stub_request(:get, /http\:\/\/example.com\/[a-z0-9]{32}/i).to_return(:status => 200)
+      stub_request(:get, "http://example.com/humans.txt").to_return(:status => 200)
+      expect(subject.humans_txt?).to eql(nil)
+    end
   end
 end

data/spec/checks/site_inspector_endpoint_cookies_spec.rb ADDED Viewed

@@ -0,0 +1,72 @@
+require 'spec_helper'
+describe SiteInspector::Endpoint::Cookies do
+  context "without cookies" do
+    subject do
+      stub_request(:get, "http://example.com/").
+        to_return(:status => 200, :body => "" )
+      endpoint = SiteInspector::Endpoint.new("http://example.com")
+      SiteInspector::Endpoint::Cookies.new(endpoint)
+    end
+    it "knows when there are no cookies" do
+      expect(subject.cookies?).to eql(false)
+      expect(subject.all).to eql(nil)
+    end
+  end
+  context "with cookies" do
+    subject do
+      cookies = [
+        CGI::Cookie::new(
+          "name"   => "foo",
+          "value"  => "bar",
+          "domain" => "example.com",
+          "path"   => "/"
+        ),
+        CGI::Cookie::new(
+          "name"   => "foo2",
+          "value"  => "bar2",
+          "domain" => "example.com",
+          "path"   => "/"
+        )
+      ].map { |c| c.to_s }
+      stub_request(:get, "http://example.com/").
+        to_return(:status => 200, :body => "", :headers => { "set-cookie" => cookies })
+      endpoint = SiteInspector::Endpoint.new("http://example.com")
+      SiteInspector::Endpoint::Cookies.new(endpoint)
+    end
+    it "knows when there are cookies" do
+      expect(subject.cookies?).to eql(true)
+      expect(subject.all.count).to eql(2)
+    end
+    it "returns a cookie by name" do
+      expect(subject["foo"].to_s).to match(/foo=bar/)
+    end
+    it "knows cookies aren't secure" do
+      expect(subject.secure?).to eql(false)
+    end
+  end
+  context "with secure cookies" do
+    subject do
+      cookies = [
+        "foo=bar; domain=example.com; path=/; secure; HttpOnly",
+        "foo2=bar2; domain=example.com; path=/"
+      ]
+      stub_request(:get, "http://example.com/").
+        to_return(:status => 200, :body => "", :headers => { "set-cookie" => cookies })
+      endpoint = SiteInspector::Endpoint.new("http://example.com")
+      SiteInspector::Endpoint::Cookies.new(endpoint)
+    end
+    it "knows cookies are secure" do
+      expect(subject.secure?).to eql(true)
+    end
+  end
+end

data/spec/checks/site_inspector_endpoint_headers_spec.rb CHANGED Viewed

@@ -61,14 +61,4 @@ describe SiteInspector::Endpoint::Headers do
     expect(subject.strict_transport_security).to eql("foo")
     expect(subject.strict_transport_security?).to eql(true)
   end
-  it "knows if there are cookies" do
-    expect(subject.cookies?).to eql(false)
-    stub_header "set-cookie", "foo"
-    expect(subject.cookies?).to eql(true)
-  end
-  it "knows if the cookies are secure" do
-  end
 end

data/spec/checks/site_inspector_endpoint_sniffer_spec.rb CHANGED Viewed

@@ -2,51 +2,113 @@ require 'spec_helper'
 describe SiteInspector::Endpoint::Sniffer do
-  subject do
-    body = <<-eos
-      <html>
-        <head>
-          <link rel='stylesheet' href='/wp-content/themes/foo/style.css type='text/css' media='all' />
-        </head>
-        <body>
-          <h1>Some page</h1>
-          <script>
-            jQuery(); googletag.pubads();
-          </script>
-          <script>
-            var _gaq=[['_setAccount','UA-12345678-1'],['_trackPageview']];
-            (function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
-            g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
-            s.parentNode.insertBefore(g,s)}(document,'script'));
-          </script>
-        </body>
-      </html>
-    eos
+  def stub_header(header, value)
+    allow(subject.endpoint.headers).to receive(:headers) { { header => value } }
+  end
+  def set_cookie(key, value)
+    cookies = [
+      CGI::Cookie::new(
+        "name" => "foo",
+        "value" => "bar",
+        "domain" => "example.com",
+        "path" => "/"
+      ),
+      CGI::Cookie::new(
+        "name" => key,
+        "value" => value,
+        "domain" => "example.com",
+        "path" => "/"
+      )
+    ].map { |c| c.to_s }
     stub_request(:get, "http://example.com/").
-      to_return(:status => 200, :body => body )
-    endpoint = SiteInspector::Endpoint.new("http://example.com")
-    SiteInspector::Endpoint::Sniffer.new(endpoint)
+      to_return(:status => 200, :body => "", :headers => { "set-cookie" => cookies } )
   end
-  it "sniffs" do
-    sniff = subject.send(:sniff, :cms)
-    expect(sniff.keys.first).to eql(:wordpress)
-  end
+  context "stubbed body" do
+    subject do
+      body = <<-eos
+        <html>
+          <head>
+            <link rel='stylesheet' href='/wp-content/themes/foo/style.css type='text/css' media='all' />
+          </head>
+          <body>
+            <h1>Some page</h1>
+            <script>
+              jQuery(); googletag.pubads();
+            </script>
+            <script>
+              var _gaq=[['_setAccount','UA-12345678-1'],['_trackPageview']];
+              (function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
+              g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
+              s.parentNode.insertBefore(g,s)}(document,'script'));
+            </script>
+          </body>
+        </html>
+      eos
-  it "detects the CMS" do
-    expect(subject.cms.keys.first).to eql(:wordpress)
-  end
+      stub_request(:get, "http://example.com/").
+        to_return(:status => 200, :body => body )
+      endpoint = SiteInspector::Endpoint.new("http://example.com")
+      SiteInspector::Endpoint::Sniffer.new(endpoint)
+    end
-  it "detects the analytics" do
-    expect(subject.analytics.keys.first).to eql(:google_analytics)
-  end
+    it "sniffs" do
+      sniff = subject.send(:sniff, :cms)
+      expect(sniff).to eql(:wordpress)
+    end
+    it "detects the CMS" do
+      expect(subject.framework).to eql(:wordpress)
+    end
+    it "detects the analytics" do
+      expect(subject.analytics).to eql(:google_analytics)
+    end
-  it "detects javascript" do
-    expect(subject.javascript.keys.first).to eql(:jquery)
+    it "detects javascript" do
+      expect(subject.javascript).to eql(:jquery)
+    end
+    it "detects advertising" do
+      expect(subject.advertising).to eql(:adsense)
+    end
+    it "knows wordpress is open source" do
+      expect(subject.open_source?).to eql(true)
+    end
   end
-  it "detects advertising" do
-    expect(subject.advertising.keys.first).to eql(:adsense)
+  context "no body" do
+    subject do
+      endpoint = SiteInspector::Endpoint.new("http://example.com")
+      SiteInspector::Endpoint::Sniffer.new(endpoint)
+    end
+    it "knows when something isn't open source" do
+      set_cookie("foo", "bar")
+      expect(subject.open_source?).to eql(false)
+    end
+    it "detects PHP" do
+      set_cookie("PHPSESSID", "1234")
+      expect(subject.framework).to eql(:php)
+      expect(subject.open_source?).to eql(true)
+    end
+    it "detects Expression Engine" do
+      set_cookie("exp_csrf_token", "1234")
+      expect(subject.framework).to eql(:expression_engine)
+      expect(subject.open_source?).to eql(true)
+    end
+    it "detects cowboy" do
+      stub_request(:get, "http://example.com/").
+        to_return(:status => 200, :body => "", :headers => { "server" => "Cowboy" } )
+      expect(subject.framework).to eql(:cowboy)
+      expect(subject.open_source?).to eql(true)
+    end
   end
 end

data/spec/{site_inspector_disc_cache_spec.rb → site_inspector_disk_cache_spec.rb} RENAMED Viewed

@@ -2,30 +2,36 @@ require 'spec_helper'
 describe SiteInspector::DiskCache do
   subject { SiteInspector::DiskCache.new(tmpdir) }
   before do
     FileUtils.rm_rf(tmpdir)
     Dir.mkdir(tmpdir)
   end
   it "should write a value to disk" do
-    path = File.expand_path "foo", tmpdir
+    foo = Typhoeus::Request.new("foo")
+    path = File.expand_path foo.cache_key, tmpdir
     expect(File.exists?(path)).to eql(false)
-    subject.set "foo", "bar"
+    subject.set foo, "bar"
     expect(File.exists?(path)).to eql(true)
     expect(File.open(path).read).to eql("I\"bar:ET")
   end
   it "should read a value from disk" do
-    path = File.expand_path "foo", tmpdir
+    foo = Typhoeus::Request.new("foo")
+    path = File.expand_path foo.cache_key, tmpdir
     File.write(path, "I\"bar:ET")
-    expect(subject.get("foo")).to eql("bar")
+    expect(subject.get(foo)).to eql("bar")
   end
   it "should calculate a file's path" do
-    path = File.expand_path "foo", tmpdir
-    expect(subject.send(:path, "foo")).to eql(path)
+    foo = Typhoeus::Request.new("foo")
+    path = File.expand_path foo.cache_key, tmpdir
+    expect(subject.send(:path, foo)).to eql(path)
   end
 end

data/spec/site_inspector_domain_spec.rb CHANGED Viewed

@@ -68,7 +68,29 @@ describe SiteInspector::Domain do
   end
   context "up" do
-    it "considers an domain up if at least one endpoint is up" do
+    it "considers a domain up if at least one endpoint is up" do
+      subject.endpoints.each do |endpoint|
+        unless endpoint.uri.to_s.start_with?("http://www")
+          allow(endpoint).to receive(:response) { Typhoeus::Response.new(code: 0) }
+        end
+      end
+      stub_request(:get, "http://www.example.com/").to_return(:status => 200)
+      expect(subject.up?).to eql(true)
+    end
+    it "doesn't consider a domain up when all endpoints are down" do
+      subject.endpoints.each do |endpoint|
+        allow(endpoint).to receive(:response) { Typhoeus::Response.new(code: 0) }
+      end
+      expect(subject.up?).to eql(false)
+    end
+  end
+  context "up" do
+    it "considers a domain up if at least one endpoint is up" do
       stub_request(:get, "https://example.com/").to_return(:status => 500)
       stub_request(:get, "https://www.example.com/").to_return(:status => 500)
       stub_request(:get, "http://example.com/").to_return(:status => 500)
@@ -77,7 +99,7 @@ describe SiteInspector::Domain do
       expect(subject.up?).to eql(true)
     end
-    it "doesn't consider an endpoint up when all endpoints are down" do
+    it "doesn't consider a domain up if all endpoints are down" do
       stub_request(:get, "https://example.com/").to_return(:status => 500)
       stub_request(:get, "https://www.example.com/").to_return(:status => 500)
       stub_request(:get, "http://example.com/").to_return(:status => 500)
@@ -94,7 +116,7 @@ describe SiteInspector::Domain do
       stub_request(:get, "http://example.com/").to_return(:status => 500)
       stub_request(:get, "http://www.example.com/").to_return(:status => 200)
-      expect(subject.up?).to eql(true)
+      expect(subject.www?).to eql(true)
     end
     it "doesn't consider a site www when no endpoint is www" do
@@ -103,7 +125,7 @@ describe SiteInspector::Domain do
       stub_request(:get, "http://example.com/").to_return(:status => 200)
       stub_request(:get, "http://www.example.com/").to_return(:status => 500)
-      expect(subject.up?).to eql(true)
+      expect(subject.www?).to eql(false)
     end
   end
@@ -166,11 +188,11 @@ describe SiteInspector::Domain do
     end
     it "detects when a domain downgrades to http" do
+      # TODO
     end
     it "detects when a domain enforces https" do
+      # TODO
     end
   end

data/spec/site_inspector_endpoint_spec.rb CHANGED Viewed

@@ -96,15 +96,15 @@ describe SiteInspector::Endpoint do
       stub_request(:get, "http://example.com/").
            to_return(:status => 200, :body => "content")
-      expect(subject.response?).to eql(true)
+      expect(subject.responds?).to eql(true)
     end
     it "knows when there's not a response" do
       allow(subject).to receive(:response) { Typhoeus::Response.new(code: 0) }
-      expect(subject.response?).to eql(false)
+      expect(subject.responds?).to eql(false)
       allow(subject).to receive(:response) { Typhoeus::Response.new(:return_code => :operation_timedout) }
-      expect(subject.response?).to eql(false)
+      expect(subject.responds?).to eql(false)
     end
     it "knows the response code" do
@@ -119,29 +119,50 @@ describe SiteInspector::Endpoint do
       expect(subject.timed_out?).to eql(true)
     end
-    it "considers a 200 response code to be up" do
+    it "considers a 200 response code to be live and a response" do
       stub_request(:get, "http://example.com/").
            to_return(:status => 200)
       expect(subject.up?).to eql(true)
-      expect(subject.down?).to eql(false)
+      expect(subject.responds?).to eql(true)
     end
-    it "considers a 301 response code to be up" do
+    it "considers a 301 response code to be live and a response" do
       stub_request(:get, "http://example.com/").
            to_return(:status => 301)
       expect(subject.up?).to eql(true)
-      expect(subject.down?).to eql(false)
+      expect(subject.responds?).to eql(true)
+    end
+    it "considers a 404 response code to be down but a response" do
+      stub_request(:get, "http://example.com/").
+           to_return(:status => 404)
+      expect(subject.up?).to eql(false)
+      expect(subject.responds?).to eql(true)
     end
-    it "doesn't consider a 500 response code to be up" do
+    it "considers a 500 response code to be down but a response" do
       stub_request(:get, "http://example.com/").
            to_return(:status => 500)
       expect(subject.up?).to eql(false)
-      expect(subject.down?).to eql(true)
+      expect(subject.responds?).to eql(true)
+    end
+    it "considers a 0 response code (error) to down and unresponsive" do
+      allow(subject).to receive(:response) { Typhoeus::Response.new(code: 0) }
+      expect(subject.up?).to eql(false)
+      expect(subject.responds?).to eql(false)
+    end
+    it "considers a timeout to be down and unresponsive" do
+      allow(subject).to receive(:response) { Typhoeus::Response.new(:return_code => :operation_timedout) }
+      expect(subject.up?).to eql(false)
+      expect(subject.responds?).to eql(false)
     end
   end
@@ -206,7 +227,7 @@ describe SiteInspector::Endpoint do
   context "checks" do
     it "identifies checks" do
-      expect(SiteInspector::Endpoint.checks.count).to eql(6)
+      expect(SiteInspector::Endpoint.checks.count).to eql(8)
     end
     SiteInspector::Endpoint.checks.each do |check|

data/spec/site_inspector_spec.rb CHANGED Viewed

@@ -38,7 +38,7 @@ describe SiteInspector do
       :followlocation => false,
       :timeout => 10,
       :headers => {
-        "User-Agent" => "Mozilla/5.0 (compatible; SiteInspector/#{SiteInspector::VERSION}; +https://github.com/benbalter/site-inspector-ruby)"
+        "User-Agent" => "Mozilla/5.0 (compatible; SiteInspector/#{SiteInspector::VERSION}; +https://github.com/benbalter/site-inspector)"
       }
     }
     expect(SiteInspector.typhoeus_defaults).to eql(expected)