rspec-webservice_matchers 4.10.0 → 4.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03bc4ee87b606016d8853436df80b164d0f4f5f4
-  data.tar.gz: 0429080abde8b75215e9ce6700e7ed6c84620a38
+  metadata.gz: 3a087dde9dd0b72fcfc3677cea0c7c3b7e706404
+  data.tar.gz: 30488dffd2af4fbe03a7d1906c97601506732a23
 SHA512:
-  metadata.gz: 7bdddc6c091db3c310fc7ded0457a1655d9c8cc8f2fff3fbe788c91601f74d81b35a19ff62930d36c3f4843621853fa4d693e0e6648bb219fd4346abdf9bd70e
-  data.tar.gz: 6e4f6b04be911e8a6f55898dcc78bc8ea8497d82978b3f9cf387cccbeb1dd447eb9ebf93565ca37db845d6902924a347227152cf6b13c600e435b5af50ce5d5f
+  metadata.gz: abe119853f955ad508086e23ffe2df8761591816bc8ee05b42972b549e5a895fc8506310080d3e422f5ee338ec114091b510efb5643cecaea00edffe22d624e0
+  data.tar.gz: 1ec4dff0037ef5a129e18edecfd198264bd2f195b668f5a6cd5a7b0bfb32afe138748f232d1d786a4a2dd3f699e3de3ed292b0362b0d9e5fb3677ad7bfc47f68

data/HISTORY.md

@@ -1,3 +1,7 @@
+4.11.0
+------
+Adds the full PageSpeed result to the `BeFast::TestResult`.
+
 4.10.0
 ------
 Refactoring lower-level code into new namespace.

data/lib/rspec/webservice_matchers/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module RSpec
   module WebserviceMatchers
-    VERSION = '4.10.0'
+    VERSION = '4.11.0'
   end
 end

data/lib/web_test/be_fast.rb

@@ -4,27 +4,34 @@ require 'json'
 require 'validated_object'
 require 'web_test/util'
 
+#
+# Runs PageSpeed on a URL.
+# See https://developers.google.com/speed/docs/insights/v2/reference/pagespeedapi/runpagespeed#response
+#
 module WebTest
   module BeFast
+
     class TestResult < ValidatedObject::Base
-      attr_accessor :success, :score
+      attr_accessor :success, :score, :response
       alias success? success
 
-      validates :success, inclusion: [true, false]
-      validates :score,   inclusion: 0..100
+      validates :success,  inclusion: [true, false]
+      validates :score,    inclusion: 0..100
+      validates :response, type: Hash
     end
 
 
-    def self.parse(json:)
-      response = JSON.parse(json)
-      unless response.key?('ruleGroups')
-        raise "Couldn't parse the PageSpeed response: #{response.inspect}"
+    def self.test(url:)
+      response = page_speed(url: url)
+
+      TestResult.new do |r|
+        r.score    = response.fetch(:score)
+        r.success  = r.score >= 85
+        r.response = response
       end
-      score = response.fetch('ruleGroups').fetch('SPEED').fetch('score')
-      { score: score }
     end
 
-    def self.page_speed_score(url:)
+    def self.page_speed(url:)
       url_param = CGI.escape(WebTest::Util.make_url(url))
       key       = ENV['WEBSERVICE_MATCHER_INSIGHTS_KEY']
       if key.nil?
@@ -34,15 +41,19 @@ module WebTest
       end
       endpoint  = 'https://www.googleapis.com/pagespeedonline/v2/runPagespeed'
       api_url   = "#{endpoint}?url=#{url_param}&screenshot=false&key=#{key}"
-      response = Faraday.get(api_url)
-      BeFast.parse(json: response.body).fetch(:score)
+      parse json: Faraday.get(api_url).body
     end
 
-    def self.test(url:)
-      TestResult.new do |r|
-        r.score   = BeFast.page_speed_score(url: url)
-        r.success = r.score >= 85
+    def self.parse(json:)
+      raw_response = JSON.parse(json)
+      unless raw_response.key?('ruleGroups')
+        raise "Couldn't parse the PageSpeed raw_response: #{raw_response.inspect}"
       end
+      score = raw_response.fetch('ruleGroups').fetch('SPEED').fetch('score')
+      {
+        score: score,
+        raw_response: raw_response
+      }
     end
   end
 end

data/spec/failure_matchers.rb

@@ -0,0 +1,16 @@
+module RSpec
+  # Matchers to help test RSpec matchers
+  module Matchers
+    def fail
+      raise_error(RSpec::Expectations::ExpectationNotMetError)
+    end
+
+    def fail_with(message)
+      raise_error(RSpec::Expectations::ExpectationNotMetError, message)
+    end
+
+    def fail_matching(regex)
+      raise_error(RSpec::Expectations::ExpectationNotMetError, regex)
+    end
+  end
+end

data/spec/rspec/webservice_matchers/page_speed_spec.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
 # Specs for all of the PageSpeed code and matchers.
-
 require 'spec_helper'
 require 'rspec/webservice_matchers'
 require 'web_test/util'
 
 
-SAMPLE_JSON_RESPONSE = 'spec/fixtures/pagespeed.json'
-
 describe RSpec::WebserviceMatchers::BeFast do
   describe '#be_fast' do
     it 'performs a Google PageSpeed Insights API query on a fast site' do

data/spec/rspec/webservice_matchers/protocol_spec.rb

@@ -64,8 +64,4 @@ describe 'be_up' do
   it 'succeeds even if the site times out on the first try' do
     expect('http://www.timeout-once.com').to be_up
   end
-
-  it 'works on cars.com' do
-    expect('http://cars.com').to be_up
-  end
 end

data/spec/rspec/webservice_matchers/redirect_spec.rb

@@ -35,7 +35,7 @@ describe 'redirect_permanently_to' do
 
   it 'gives a good error message when the hostname is bad' do
     expect {
-      expect('asdhfjadhsfksd.com').to redirect_permanently_to 'http://the-wrong-site.com/'
+      expect('not-a-domain.com').to redirect_permanently_to 'http://the-wrong-site.com/'
     }.to fail_matching(/not known/i)
   end
 end
@@ -73,7 +73,7 @@ describe 'redirect_temporarily_to' do
 
   it 'gives a good error message when the hostname is bad' do
     expect {
-      expect('234678234687234.com').to redirect_temporarily_to 'www.nowhere.com'
+      expect('not-a-domain.com').to redirect_temporarily_to 'www.nowhere.com'
     }.to fail_matching(/not known/i)
   end
 end

data/spec/rspec/webservice_matchers/ssl_spec.rb

@@ -2,61 +2,66 @@
 require 'spec_helper'
 require 'rspec/webservice_matchers'
 
-describe 'have_a_valid_cert matcher' do
-  it 'passes when SSL is properly configured' do
-    # EFF created the HTTPS Everywhere movement
-    # TODO: set up a test server for this. (?)
-    expect('www.eff.org').to have_a_valid_cert
-  end
+describe 'SSL tests' do
+  before(:each) { WebMock.allow_net_connect! }
+  after(:each)  { WebMock.disable_net_connect! }
 
-  it 'fails if the server is not serving SSL at all' do
-    expect {
-      expect('www.psu.edu').to have_a_valid_cert
-    }.to fail_matching(/443/)
-  end
+  describe 'have_a_valid_cert matcher' do
+    it 'passes when SSL is properly configured' do
+      # EFF created the HTTPS Everywhere movement
+      # TODO: set up a test server for this. (?)
+      expect('www.eff.org').to have_a_valid_cert
+    end
 
-  it 'provides a relevant error message' do
-    expect {
-      expect('www.psu.edu').to have_a_valid_cert
-    }.to fail_matching(/(unreachable)|(no route to host)|(connection refused)/i)
-  end
+    it 'fails if the server is not serving SSL at all' do
+      expect do
+        expect('www.psu.edu').to have_a_valid_cert
+      end.to fail_matching(/443/)
+    end
 
-  it "provides a relevant error message when the domain name doesn't exist" do
-    expect {
-      expect('sdfgkljhsdfghjkhsdfgj.edu').to have_a_valid_cert
-    }.to fail_matching(/not known/i)
-  end
+    it 'provides a relevant error message' do
+      expect do
+        expect('www.psu.edu').to have_a_valid_cert
+      end.to fail_matching(/(unreachable)|(no route to host)|(connection refused)/i)
+    end
 
-  it "provides a good error message when it's a redirect" do
-    expect {
-      # Can't figure out how to do this with WebMock.
-      expect('bloc.io').to have_a_valid_cert
-    }.to fail_matching(/redirect/i)
-  end
+    it "provides a relevant error message when the domain name doesn't exist" do
+      expect do
+        expect('sdfgkljhsdfghjkhsdfgj.edu').to have_a_valid_cert
+      end.to fail_matching(/not known/i)
+    end
 
-  # TODO: Find a good way to test this.
-  # it 'provides a good error message if the request times out' do
-  #   expect {
-  #     expect('www.myapp.com').to have_a_valid_cert
-  #   }.to fail_matching(/(timeout)|(execution expired)/)
-  # end
-end
+    it "provides a good error message when it's a redirect" do
+      expect do
+        # Can't figure out how to do this with WebMock.
+        expect('bloc.io').to have_a_valid_cert
+      end.to fail_matching(/redirect/i)
+    end
 
-# See https://www.eff.org/https-everywhere
-describe 'enforce_https_everywhere' do
-  it 'passes when http requests are redirected to valid https urls' do
-    expect('eff.org').to enforce_https_everywhere
+    # TODO: Find a good way to test this.
+    # it 'provides a good error message if the request times out' do
+    #   expect {
+    #     expect('www.myapp.com').to have_a_valid_cert
+    #   }.to fail_matching(/(timeout)|(execution expired)/)
+    # end
   end
 
-  it 'provides a relevant error message' do
-    expect {
-      expect('www.psu.edu').to enforce_https_everywhere
-    }.to fail_matching(/200/)
-  end
+  # See https://www.eff.org/https-everywhere
+  describe 'enforce_https_everywhere' do
+    it 'passes when http requests are redirected to valid https urls' do
+      expect('eff.org').to enforce_https_everywhere
+    end
+
+    it 'provides a relevant error message' do
+      expect do
+        expect('www.psu.edu').to enforce_https_everywhere
+      end.to fail_matching(/200/)
+    end
 
-  it "provides a relevant error message when the domain name doesn't exist" do
-    expect {
-      expect('asdhfjkalsdhfjklasdfhjkasdhfl.com').to enforce_https_everywhere
-    }.to fail_matching(/connection failed/i)
+    it "provides a relevant error message when the domain name doesn't exist" do
+      expect do
+        expect('asdhfjkalsdhfjklasdfhjkasdhfl.com').to enforce_https_everywhere
+      end.to fail_matching(/connection failed/i)
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,56 +1,5 @@
 # frozen_string_literal: true
-require 'webmock/rspec'
+require 'web_mock_config'
+require 'failure_matchers'
 
-RSpec.configure do |config|
-  config.before(:each) do
-    WebMock.stub_request :any, 'http://a-page.com/a/page.txt'
-    WebMock.stub_request :any, 'www.website.com'
-    WebMock.stub_request(:any, /notfound.com/).to_return(status: 404)
-    WebMock.stub_request(:any, 'outoforder.com').to_return(status: 503)
-
-    # A host which doesn't support HEAD
-    WebMock.stub_request(:head, 'appengine.com').to_return(status: 405)
-    WebMock.stub_request(:get,  'appengine.com').to_return(status: 200)
-
-    WebMock.stub_request(:any, 'perm-redirector.com')
-           .to_return(status: 301, headers: { Location: 'http://www.website.com/' })
-
-    WebMock.stub_request(:any, 'temp-redirector.org')
-           .to_return(status: 302, headers: { Location: 'http://a-page.com/a/page.txt' })
-
-    WebMock.stub_request(:any, 'temp-307-redirector.net')
-           .to_return(status: 307, headers: { Location: 'http://a-page.com/a/page.txt' })
-
-    # Timeout scenarios
-    WebMock.stub_request(:any, 'www.timeout.com').to_timeout
-    WebMock.stub_request(:any, 'www.timeout-once.com').to_timeout.then.to_return(body: 'abc')
-
-    # Insights API
-    key = ENV['WEBSERVICE_MATCHER_INSIGHTS_KEY']
-    WebMock.stub_request(:get, "https://www.googleapis.com/pagespeedonline/v2/runPagespeed?key=#{key}&screenshot=false&url=http://nonstop.qa")
-           .with(headers: { 'Accept' => '*/*', 'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent' => 'Faraday v0.9.2' })
-           .to_return(
-             status: 200,
-             body: IO.read('spec/fixtures/pagespeed.json'),
-             headers: {})
-
-    WebMock.allow_net_connect!
-  end
-end
-
-module RSpec
-  # Matchers to help test RSpec matchers
-  module Matchers
-    def fail
-      raise_error(RSpec::Expectations::ExpectationNotMetError)
-    end
-
-    def fail_with(message)
-      raise_error(RSpec::Expectations::ExpectationNotMetError, message)
-    end
-
-    def fail_matching(regex)
-      raise_error(RSpec::Expectations::ExpectationNotMetError, regex)
-    end
-  end
-end
+SAMPLE_PAGESPEED_JSON_RESPONSE = 'spec/fixtures/pagespeed.json'

data/spec/web_mock_config.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+require 'faraday'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    # HOSTS WHICH RETURN ERRORS
+    WebMock.stub_request(:any, /notfound.com/).to_return(status: 404)
+    WebMock.stub_request(:any, 'outoforder.com').to_return(status: 503)
+    WebMock.stub_request(:any, 'not-a-domain.com')
+           .to_raise(Faraday::ConnectionFailed.new('Failed to open TCP ' \
+                     'connection to asdhfjkahsdfadfd.com:80 ' \
+                     '(getaddrinfo: nodename nor servname provided, ' \
+                     'or not known)'))
+
+    # FUNCTIONING WEB PAGES
+    WebMock.stub_request :any, 'http://a-page.com/a/page.txt'
+    WebMock.stub_request :any, 'www.website.com'
+
+    # A HOST WHICH DOESN'T SUPPORT HEAD
+    WebMock.stub_request(:head, 'appengine.com').to_return(status: 405)
+    WebMock.stub_request(:get,  'appengine.com').to_return(status: 200)
+
+    # FUNCTIONING REDIRECTS
+    WebMock.stub_request(:head, 'perm-redirector.com')
+           .to_return(status: 301,
+                      body: '',
+                      headers: { Location: 'http://www.website.com/' })
+
+    WebMock.stub_request(:any, 'temp-redirector.org')
+           .to_return(status: 302,
+                      headers: { Location: 'http://a-page.com/a/page.txt' })
+
+    WebMock.stub_request(:any, 'temp-307-redirector.net')
+           .to_return(status: 307,
+                      headers: { Location: 'http://a-page.com/a/page.txt' })
+
+    # TIMEOUT SCENARIOS
+    WebMock.stub_request(:any, 'www.timeout.com').to_timeout
+    WebMock.stub_request(:any, 'www.timeout-once.com').to_timeout
+           .then.to_return(body: 'abc')
+
+    # PageSpeed Insights API
+    key = ENV['WEBSERVICE_MATCHER_INSIGHTS_KEY']
+    WebMock.stub_request(:get,
+                         'https://www.googleapis.com/pagespeedonline/v2/' \
+                         "runPagespeed?key=#{key}&screenshot=false" \
+                         '&url=http://nonstop.qa')
+           .to_return(
+             status: 200,
+             body: IO.read('spec/fixtures/pagespeed.json'),
+             headers: {})
+  end
+end

data/spec/web_test/be_fast_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'spec_helper'
 require 'web_test/be_fast'
 
 RSpec.describe WebTest::BeFast do
@@ -14,7 +15,7 @@ RSpec.describe WebTest::BeFast do
 
   describe '#parse' do
     it 'can parse the overall score' do
-      api_response = File.read(SAMPLE_JSON_RESPONSE)
+      api_response = File.read(SAMPLE_PAGESPEED_JSON_RESPONSE)
       data = WebTest::BeFast.parse json: api_response
       expect(data[:score]).to eq 85
     end
@@ -32,5 +33,14 @@ RSpec.describe WebTest::BeFast do
         WebTest::BeFast::TestResult.new { |r| r.success = true }
       end.to raise_error(ArgumentError, /score/i)
     end
+
+    it 'requires :response' do
+      expect do
+        WebTest::BeFast::TestResult.new { |r|
+          r.success = true
+          r.score = 90
+        }
+      end.to raise_error(ArgumentError, /response/i)      
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-webservice_matchers
 version: !ruby/object:Gem::Version
-  version: 4.10.0
+  version: 4.11.0
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-31 00:00:00.000000000 Z
+date: 2016-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -192,6 +192,7 @@ files:
 - lib/web_test/be_up.rb
 - lib/web_test/util.rb
 - rspec-webservice_matchers.gemspec
+- spec/failure_matchers.rb
 - spec/fixtures/pagespeed.json
 - spec/rspec/webservice_matchers/page_speed_spec.rb
 - spec/rspec/webservice_matchers/protocol_spec.rb
@@ -199,6 +200,7 @@ files:
 - spec/rspec/webservice_matchers/redirect_spec.rb
 - spec/rspec/webservice_matchers/ssl_spec.rb
 - spec/spec_helper.rb
+- spec/web_mock_config.rb
 - spec/web_test/be_fast_spec.rb
 - spec/web_test/be_up_spec.rb
 - spec/web_test/util_spec.rb
@@ -222,11 +224,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: Black-box web app configuration testing
 test_files:
+- spec/failure_matchers.rb
 - spec/fixtures/pagespeed.json
 - spec/rspec/webservice_matchers/page_speed_spec.rb
 - spec/rspec/webservice_matchers/protocol_spec.rb
@@ -234,6 +237,7 @@ test_files:
 - spec/rspec/webservice_matchers/redirect_spec.rb
 - spec/rspec/webservice_matchers/ssl_spec.rb
 - spec/spec_helper.rb
+- spec/web_mock_config.rb
 - spec/web_test/be_fast_spec.rb
 - spec/web_test/be_up_spec.rb
 - spec/web_test/util_spec.rb