site-inspector 1.0.2 → 2.0.0

data/spec/site_inspector_endpoint_spec.rb

@@ -0,0 +1,224 @@
+require 'spec_helper'
+
+describe SiteInspector::Endpoint do
+
+  subject { SiteInspector::Endpoint.new("http://example.com") }
+
+  it "downcases the host" do
+    endpoint = SiteInspector::Endpoint.new("http://EXAMPLE.com")
+    expect(endpoint.host).to eql("example.com")
+  end
+
+  it "strips www from the host" do
+    endpoint = SiteInspector::Endpoint.new("http://www.example.com")
+    expect(endpoint.host).to eql("example.com")
+  end
+
+  it "returns the uri" do
+    expect(subject.uri.to_s).to eql("http://example.com")
+  end
+
+  it "knows if an endpoint is www" do
+    expect(subject.www?).to eql(false)
+    expect(subject.root?).to eql(true)
+
+    endpoint = SiteInspector::Endpoint.new("http://www.example.com")
+    expect(endpoint.www?).to eql(true)
+    expect(endpoint.root?).to eql(false)
+  end
+
+  it "knows if an endpoint is http" do
+    stub_request(:get, "http://example.com/").
+      to_return(:status => 200, :body => "content")
+
+    stub_request(:get, "https://example.com/").
+      to_return(:status => 500, :body => "content")
+
+    expect(subject.https?).to eql(false)
+    expect(subject.http?).to eql(true)
+  end
+
+  it "knows if an endpoint is https" do
+    stub_request(:get, "http://example.com/").
+      to_return(:status => 200, :body => "content")
+
+    stub_request(:get, "https://example.com/").
+      to_return(:status => 200, :body => "content")
+
+    endpoint = SiteInspector::Endpoint.new("https://example.com")
+    expect(endpoint.https?).to eql(true)
+    expect(endpoint.http?).to eql(false)
+  end
+
+  it "knows the scheme" do
+    expect(subject.scheme).to eql("http")
+
+    endpoint = SiteInspector::Endpoint.new("https://example.com")
+    expect(endpoint.scheme).to eql("https")
+  end
+
+  context "requests" do
+
+    it "requests a URL" do
+      stub = stub_request(:get, "http://example.com/").
+           to_return(:status => 200, :body => "content")
+
+      expect(subject.request.body).to eql("content")
+      expect(stub).to have_been_requested
+    end
+
+    it "requests a requested path" do
+      stub = stub_request(:get, "http://example.com/foo").
+           to_return(:status => 200, :body => "content")
+
+      expect(subject.request(:path => "foo").body).to eql("content")
+      expect(stub).to have_been_requested
+    end
+
+    it "requests with typhoeus options" do
+      stub_request(:get, "http://example.com/").
+           to_return(:status => 301, :headers => { :location => "http://example.com/foo" } )
+
+      response = subject.request(:followlocation => true)
+      expect(response.request.options[:followlocation]).to eql(true)
+    end
+
+    it "returns the response" do
+      stub = stub_request(:get, "http://example.com/").
+           to_return(:status => 200, :body => "content")
+
+      expect(subject.response.body).to eql("content")
+      expect(subject.response.body).to eql("content")
+      expect(stub).to have_been_requested.once
+    end
+
+    it "knows if there's a response" do
+      stub_request(:get, "http://example.com/").
+           to_return(:status => 200, :body => "content")
+
+      expect(subject.response?).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)
+
+      allow(subject).to receive(:response) { Typhoeus::Response.new(:return_code => :operation_timedout) }
+      expect(subject.response?).to eql(false)
+    end
+
+    it "knows the response code" do
+      stub_request(:get, "http://example.com/").
+           to_return(:status => 200)
+
+      expect(subject.response_code).to eql("200")
+    end
+
+    it "knows if a response has timed out" do
+      allow(subject).to receive(:response) { Typhoeus::Response.new(:return_code => :operation_timedout) }
+      expect(subject.timed_out?).to eql(true)
+    end
+
+    it "considers a 200 response code to be up" do
+      stub_request(:get, "http://example.com/").
+           to_return(:status => 200)
+
+      expect(subject.up?).to eql(true)
+      expect(subject.down?).to eql(false)
+
+    end
+
+    it "considers a 301 response code to be up" do
+      stub_request(:get, "http://example.com/").
+           to_return(:status => 301)
+
+      expect(subject.up?).to eql(true)
+      expect(subject.down?).to eql(false)
+    end
+
+    it "doesn't consider a 500 response code to be up" do
+      stub_request(:get, "http://example.com/").
+           to_return(:status => 500)
+
+      expect(subject.up?).to eql(false)
+      expect(subject.down?).to eql(true)
+    end
+  end
+
+  context "redirects" do
+    it "knows when there's a redirect" do
+      stub_request(:get, "http://example.com/").
+        to_return(:status => 301, :headers => { :location => "http://www.example.com" } )
+
+      expect(subject.redirect?).to eql(true)
+    end
+
+    it "returns the redirect" do
+      stub_request(:get, "http://example.com/").
+        to_return(:status => 301, :headers => { :location => "http://www.example.com" } )
+
+      stub_request(:get, "http://www.example.com/").
+        to_return(:status => 200)
+
+      expect(subject.redirect.uri.to_s).to eql("http://www.example.com")
+    end
+
+    it "handles relative redirects" do
+      stub_request(:get, "http://example.com/").
+           to_return(:status => 301, :headers => { :location => "/foo" } )
+
+      expect(subject.redirect?).to eql(false)
+    end
+
+    it "handles relative redirects without a leading slash" do
+      stub_request(:get, "http://example.com/").
+           to_return(:status => 301, :headers => { :location => "foo" } )
+
+      expect(subject.redirect?).to eql(false)
+    end
+
+    it "knows what it resolves to" do
+      stub_request(:get, "http://example.com/").
+        to_return(:status => 301, :headers => { :location => "http://www.example.com" } )
+
+      stub_request(:get, "http://www.example.com/").
+        to_return(:status => 200)
+
+      expect(subject.redirect?).to eql(true)
+      expect(subject.resolves_to.uri.to_s).to eql("http://www.example.com")
+    end
+
+    it "detects external redirects" do
+      stub_request(:get, "http://example.com/").
+        to_return(:status => 301, :headers => { :location => "http://www.example.gov" } )
+
+      expect(subject.redirect?).to eql(true)
+      expect(subject.external_redirect?).to eql(true)
+    end
+
+    it "knows internal redirects are not external redirects" do
+      stub_request(:get, "http://example.com/").
+        to_return(:status => 301, :headers => { :location => "https://example.com" } )
+
+      expect(subject.external_redirect?).to eql(false)
+    end
+  end
+
+  context "checks" do
+    it "identifies checks" do
+      expect(SiteInspector::Endpoint.checks.count).to eql(6)
+    end
+
+    SiteInspector::Endpoint.checks.each do |check|
+      it "responds to the #{check} check" do
+
+        stub_request(:get, "http://example.com/").
+          to_return(:status => 200)
+
+        expect(subject.send(check.name)).to_not be_nil
+        expect(subject.send(check.name).class).to eql(check)
+
+      end
+    end
+  end
+end

data/spec/site_inspector_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe SiteInspector do
+
+  before do
+    SiteInspector.instance_variable_set("@cache", nil)
+    SiteInspector.instance_variable_set("@timeout", nil)
+  end
+
+  it "defaults to ephemeral cache" do
+    with_env "CACHE", nil do
+      expect(SiteInspector.cache.class).to be(SiteInspector::Cache)
+    end
+  end
+
+  it "uses disk cache when requested" do
+    with_env "CACHE", "/tmp" do
+      expect(SiteInspector.cache.class).to be(SiteInspector::DiskCache)
+    end
+  end
+
+  it "returns the default timeout" do
+    expect(SiteInspector.timeout).to eql(10)
+  end
+
+  it "honors custom timeouts" do
+    SiteInspector.timeout = 20
+    expect(SiteInspector.timeout).to eql(20)
+  end
+
+  it "returns a domain when inspecting" do
+    expect(SiteInspector.inspect("example.com").class).to be(SiteInspector::Domain)
+  end
+
+  it "returns the typhoeus defaults" do
+    expected = {
+      :accept_encoding => "gzip",
+      :followlocation => false,
+      :timeout => 10,
+      :headers => {
+        "User-Agent" => "Mozilla/5.0 (compatible; SiteInspector/#{SiteInspector::VERSION}; +https://github.com/benbalter/site-inspector-ruby)"
+      }
+    }
+    expect(SiteInspector.typhoeus_defaults).to eql(expected)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require "bundler/setup"
+require 'webmock/rspec'
+require 'fileutils'
+require_relative "../lib/site-inspector"
+
+WebMock.disable_net_connect!
+
+def with_env(key, value)
+  old_env = ENV[key]
+  ENV[key] = value
+  yield
+  ENV[key] = old_env
+end
+
+def tmpdir
+  File.expand_path "../tmp", File.dirname(__FILE__)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: site-inspector
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-01 00:00:00.000000000 Z
+date: 2015-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -109,103 +109,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.11'
 - !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: rake
+  name: mercenary
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
-  type: :development
+        version: '0.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: colorator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
+        version: '0.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '10.4'
 - !ruby/object:Gem::Dependency
-  name: rerun
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -220,20 +206,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: guard-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 description: Returns information about a domain's technology and capabilities
 email: ben@balter.com
 executables:
@@ -241,16 +213,49 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Guardfile
 - LICENSE
+- README.md
+- Rakefile
 - bin/site-inspector
 - lib/data/cdn.yml
 - lib/data/cloud.yml
 - lib/site-inspector.rb
 - lib/site-inspector/cache.rb
-- lib/site-inspector/compliance.rb
-- lib/site-inspector/dns.rb
-- lib/site-inspector/headers.rb
-- lib/site-inspector/sniffer.rb
+- lib/site-inspector/checks/check.rb
+- lib/site-inspector/checks/content.rb
+- lib/site-inspector/checks/dns.rb
+- lib/site-inspector/checks/headers.rb
+- lib/site-inspector/checks/hsts.rb
+- lib/site-inspector/checks/https.rb
+- lib/site-inspector/checks/sniffer.rb
+- lib/site-inspector/disk_cache.rb
+- lib/site-inspector/domain.rb
+- lib/site-inspector/endpoint.rb
+- lib/site-inspector/rails_cache.rb
+- lib/site-inspector/version.rb
+- script/bootstrap
+- script/cibuild
+- script/console
+- script/release
+- site-inspector.gemspec
+- spec/checks/site_inspector_endpoint_check_spec.rb
+- spec/checks/site_inspector_endpoint_content_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/site_inspector_cache_spec.rb
+- spec/site_inspector_disc_cache_spec.rb
+- spec/site_inspector_domain_spec.rb
+- spec/site_inspector_endpoint_spec.rb
+- spec/site_inspector_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/benbalter/site-inspector-ruby
 licenses:
 - MIT
@@ -275,4 +280,17 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Ruby port and v2 of Site Inspector (http://github.com/benbalter/site-inspector)
-test_files: []
+test_files:
+- spec/checks/site_inspector_endpoint_check_spec.rb
+- spec/checks/site_inspector_endpoint_content_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/site_inspector_cache_spec.rb
+- spec/site_inspector_disc_cache_spec.rb
+- spec/site_inspector_domain_spec.rb
+- spec/site_inspector_endpoint_spec.rb
+- spec/site_inspector_spec.rb
+- spec/spec_helper.rb