rspec-webservice_matchers 2.0 → 3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f010c192b642b65ee3b60e1e8fa6d60aa4166c8
-  data.tar.gz: 0363d1f7fbe3032c6268964b4f23f845e79996e8
+  metadata.gz: da5e8521d806264714169e3d9427a4cccfd979d9
+  data.tar.gz: 9b3c233b836035216d277fbbf687b5873531064e
 SHA512:
-  metadata.gz: 3d7e514a44a4fef365fdd968fdc66a72cb15779305cc12d152069d8ef08e727d200ad8f410ecae8f9ad16fd925fa31080b5ab4ce70da3abbdbf85c4adb09dc8f
-  data.tar.gz: b93ac4024054368135ff8d6577165c9ba9e9c248c6baf223515069a56aba7814e7304e4f826258e936925cc5c441edc3d61e38ffd76f67be51a3b60a86b24b2d
+  metadata.gz: 4ce03e800829b9c0b6bb9976d355d154821da201e92995c10a0989b0c2e295a357464dcfd7aa1573b2b8f1a0d58c15378b4d4cb1b74dac2660f7bf0551506267
+  data.tar.gz: f5abc5dafeeddfe2b4648fb81671874972bacfe8cdc4f3acd605617f5b320ffe741fa67af24fb1c99e6c3c7fab8f03757728be4622c73d885561017a2a63cc58

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+matchers.komodoproject
+.idea/

data/README.md

@@ -1,11 +1,10 @@
 # RSpec::WebserviceMatchers
 
-[![Gem Version](https://badge.fury.io/rb/rspec-webservice_matchers.png)](http://badge.fury.io/rb/rspec-webservice_matchers) [![Build Status](https://travis-ci.org/dogweather/rspec-webservice_matchers.png?branch=master)](https://travis-ci.org/dogweather/rspec-webservice_matchers)
+[![Gem Version](https://badge.fury.io/rb/rspec-webservice_matchers.png)](http://badge.fury.io/rb/rspec-webservice_matchers) [![Build Status](https://travis-ci.org/dogweather/rspec-webservice_matchers.png?branch=master)](https://travis-ci.org/dogweather/rspec-webservice_matchers) [![Code Climate](https://codeclimate.com/github/dogweather/rspec-webservice_matchers.png)](https://codeclimate.com/github/dogweather/rspec-webservice_matchers)
 
-This [gem](https://rubygems.org/gems/rspec-webservice_matchers) enables you to black-box test a web app's server configuration. For example, whether its SSL certificate is correctly configured and not expired. It's a tool for doing **Test Driven Devops**. (I just made that up.) See [my blog post](http://robb.weblaws.org/2014/01/16/new-open-source-library-for-test-driven-devops/) for more about my motivations for making this.
+This [gem](https://rubygems.org/gems/rspec-webservice_matchers) enables you to black-box test a web app's server configuration. For example, whether its SSL certificate is correctly configured and not expired. It's a tool for doing **Test Driven Devops** (I just made that up). See [the introductory blog post](http://robb.weblaws.org/2014/01/16/new-open-source-library-for-test-driven-devops/) for more about the motivations for making this.
 
-This library takes a very minimalist approach: it simply adds new RSpec matchers,
-and so you can use your own RSpec writing style; there's no new DSL to learn.
+This library takes a minimalist approach: it simply adds new RSpec matchers. Therefore, you can use your own RSpec writing style; there's no new DSL to learn.
 
 Installation
 ------------
@@ -19,12 +18,12 @@ These new RSpec matchers:
 
                                | Notes
 -------------------------------|------------------------------------------------
-**be_status**                  |  
-**be_up**                      | Follows redirects if necessary and checks for 200
-**have_a_valid_cert**          | 
-**enforce_https_everywhere**   | See the [EFF project](https://www.eff.org/https-everywhere)
-**redirect_permanently_to**    | Checks for 301
-**redirect_temporarily_to**    | Checks for 302 or 307
+**be_status**                  | A low-level matcher to explicitly check for a 200, 503, or any other code
+**be_up**                      | Looks for a 200, but will follow up to four redirects
+**have_a_valid_cert**          | Will fail if there's no cert, or it's expired or incorrectly configured
+**enforce_https_everywhere**   | Passes if the site will _only_ allow SSL connections. See the [EFF project, HTTP Everywhere](https://www.eff.org/https-everywhere)
+**redirect_permanently_to**    | Checks for 301 and a correct destination URL
+**redirect_temporarily_to**    | Checks for 302 or 307 and a correct destination
 
 
 Example

data/lib/rspec/webservice_matchers.rb

@@ -36,7 +36,7 @@ module RSpec
 
       match do |url_or_domain_name|
         begin
-          response = WebserviceMatchers.connection.head(WebserviceMatchers.make_url url_or_domain_name)
+          response = WebserviceMatchers.recheck_on_timeout { WebserviceMatchers.connection.head(WebserviceMatchers.make_url url_or_domain_name) }
           expected = WebserviceMatchers.make_url(expected)
           actual_location = response.headers['location']
           actual_status   = response.status
@@ -74,7 +74,7 @@ module RSpec
 
       match do |url_or_domain_name|
         begin
-          response = WebserviceMatchers.connection.head(WebserviceMatchers.make_url url_or_domain_name)
+          response = WebserviceMatchers.recheck_on_timeout { WebserviceMatchers.connection.head(WebserviceMatchers.make_url url_or_domain_name) }
           expected = WebserviceMatchers.make_url(expected)
           actual_location = response.headers['location']
           actual_status   = response.status
@@ -114,7 +114,7 @@ module RSpec
 
       match do |domain_name|
         begin
-          response = WebserviceMatchers.connection.head("http://#{domain_name}")
+          response = WebserviceMatchers.recheck_on_timeout { WebserviceMatchers.connection.head("http://#{domain_name}") }
           new_url  = response.headers['location']
           actual_status  = response.status
           /^(?<protocol>https?)/ =~ new_url
@@ -158,7 +158,7 @@ module RSpec
 
       match do |url_or_domain_name|
         url           = WebserviceMatchers.make_url(url_or_domain_name)
-        response      = WebserviceMatchers.connection.head(url)
+        response      = WebserviceMatchers.recheck_on_timeout { WebserviceMatchers.connection.head(url) }
         actual_code   = response.status
         expected_code = expected_code.to_i
         actual_code   == expected_code
@@ -177,7 +177,7 @@ module RSpec
       match do |url_or_domain_name|
         url  = WebserviceMatchers.make_url(url_or_domain_name)
         conn = WebserviceMatchers.connection(follow: true)
-        response = conn.head(url)
+        response = WebserviceMatchers.recheck_on_timeout { conn.head(url) }
         actual_status = response.status
         actual_status == 200
       end
@@ -192,7 +192,7 @@ module RSpec
     def self.up?(url_or_domain_name)
       url  = make_url(url_or_domain_name)
       conn = connection(follow: true)
-      response = conn.head(url)
+      response = recheck_on_timeout { conn.head(url) }
       response.status == 200
     end
 
@@ -205,9 +205,10 @@ module RSpec
     end
 
     def self.try_ssl_connection(domain_name_or_url)
-      connection.head("https://#{remove_protocol(domain_name_or_url)}")
+      recheck_on_timeout { connection.head("https://#{remove_protocol(domain_name_or_url)}") }
     end
 
+
     private
 
     def self.connection(follow: false)
@@ -234,5 +235,13 @@ module RSpec
       %r{^https?://(?<name>.+)$} =~ domain_name_or_url
       name || domain_name_or_url
     end
+
+    def self.recheck_on_timeout
+      begin
+        yield
+      rescue Faraday::Error::TimeoutError
+        yield
+      end
+    end
   end
 end

data/lib/rspec/webservice_matchers/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module WebserviceMatchers
-    VERSION = '2.0'
+    VERSION = '3.0'
   end
 end

data/rspec-webservice_matchers.gemspec

@@ -4,25 +4,25 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rspec/webservice_matchers/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rspec-webservice_matchers"
-  spec.version       = RSpec::WebserviceMatchers::VERSION
-  spec.authors       = ["Robb Shecter"]
-  spec.email         = ["robb@weblaws.org"]
-  spec.description   = %q{Black-box web app configuration testing}
-  spec.summary       = %q{Black-box web app configuration testing}
-  spec.homepage      = "https://github.com/dogweather/rspec-webservice_matchers"
-  spec.license       = "MIT"
+  spec.name        = 'rspec-webservice_matchers'
+  spec.version     = RSpec::WebserviceMatchers::VERSION
+  spec.authors     = ['Robb Shecter']
+  spec.email       = ['robb@weblaws.org']
+  spec.description = 'Black-box web app configuration testing'
+  spec.summary     = 'Black-box web app configuration testing'
+  spec.homepage    = 'https://github.com/dogweather/rspec-webservice_matchers'
+  spec.license     = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'webmock'
-  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency 'codeclimate-test-reporter'
 
   spec.add_runtime_dependency 'rspec', '~> 2'
   spec.add_runtime_dependency 'faraday'

data/spec/rspec/webservice_matchers/protcol_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 require 'rspec/webservice_matchers'
 
-
 describe 'be_status' do
   it 'can check 200 for successful resource requests' do
     'http://a-page.com/a/page.txt'.should be_status 200
@@ -28,8 +27,11 @@ describe 'be_status' do
       expect('http://notfound.com/no.txt').to be_status 200
     }.to fail_matching(/404/)
   end
-end
 
+  it 'succeeds even if the site times out on the first try' do
+    'http://www.timeout-once.com'.should be_status 200
+  end
+end
 
 describe 'be_up' do
   it 'follows redirects when necessary' do
@@ -50,4 +52,8 @@ describe 'be_up' do
       expect('http://notfound.com/no.txt').to be_up
     }.to fail_matching(/404/)
   end
+
+  it 'succeeds even if the site times out on the first try' do
+    'http://www.timeout-once.com'.should be_up
+  end
 end

data/spec/rspec/webservice_matchers/public_api_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'rspec/webservice_matchers'
+
+describe '#up?' do
+  it 'follows redirects when necessary' do
+    RSpec::WebserviceMatchers.up?('perm-redirector.com').should be_true
+    RSpec::WebserviceMatchers.up?('temp-redirector.org').should be_true
+  end
+
+  it 'retries timeout errors once' do
+    RSpec::WebserviceMatchers.up?('http://www.timeout-once.com').should be_true
+  end
+end

data/spec/rspec/webservice_matchers/redirect_spec.rb

@@ -1,10 +1,9 @@
 require 'spec_helper'
 require 'rspec/webservice_matchers'
 
-
 describe 'redirect_permanently_to' do
   it 'passes when receiving a 301 to the given URL' do
-    expect('http://perm-redirector.com').to redirect_permanently_to 'http://www.website.com/' 
+    expect('http://perm-redirector.com').to redirect_permanently_to 'http://www.website.com/'
   end
 
   it 'handles domain names gracefully' do
@@ -13,7 +12,7 @@ describe 'redirect_permanently_to' do
 
   it 'handles a missing final slash' do
     expect('perm-redirector.com').to redirect_permanently_to 'www.website.com'
-  end 
+  end
 
   it 'gives a good error message for the wrong redirect type' do
     expect {
@@ -30,17 +29,16 @@ describe 'redirect_permanently_to' do
   it 'gives a good error message for a non-redirect status' do
     expect {
       expect('notfound.com').to redirect_permanently_to 'http://the-wrong-site.com/'
-    }.to fail_matching(/404/i)    
+    }.to fail_matching(/404/i)
   end
 
   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/'
-    }.to fail_matching(/not known/i)    
-  end    
+    }.to fail_matching(/not known/i)
+  end
 end
 
-
 describe 'redirect_temporarily_to' do
   it 'passes when it gets a 302' do
     'http://temp-redirector.org'.should redirect_temporarily_to 'http://a-page.com/a/page.txt'
@@ -48,7 +46,7 @@ describe 'redirect_temporarily_to' do
 
   it 'handles domain names gracefully' do
     'temp-redirector.org'.should redirect_temporarily_to 'a-page.com/a/page.txt'
-  end 
+  end
 
   it 'passes when it gets a 307' do
     'temp-307-redirector.net'.should redirect_temporarily_to 'a-page.com/a/page.txt'

data/spec/spec_helper.rb

@@ -1,31 +1,34 @@
-require "codeclimate-test-reporter"
+require 'codeclimate-test-reporter'
 CodeClimate::TestReporter.start
 
 require 'webmock/rspec'
 
 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)
 
     WebMock.stub_request(:any, 'perm-redirector.com')
-      .to_return(status: 301, headers: {Location: 'http://www.website.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'})
+      .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'})
+      .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'})
 
     WebMock.allow_net_connect!
   end
 end
 
-
 module RSpec
+  # Matchers to help test RSpec matchers
   module Matchers
     def fail
       raise_error(RSpec::Expectations::ExpectationNotMetError)
@@ -39,4 +42,4 @@ module RSpec
       raise_error(RSpec::Expectations::ExpectationNotMetError, regex)
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-webservice_matchers
 version: !ruby/object:Gem::Version
-  version: '2.0'
+  version: '3.0'
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-25 00:00:00.000000000 Z
+date: 2014-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -139,6 +139,7 @@ files:
 - lib/rspec/webservice_matchers/version.rb
 - rspec-webservice_matchers.gemspec
 - spec/rspec/webservice_matchers/protcol_spec.rb
+- spec/rspec/webservice_matchers/public_api_spec.rb
 - spec/rspec/webservice_matchers/redirect_spec.rb
 - spec/rspec/webservice_matchers/ssl_spec.rb
 - spec/spec_helper.rb
@@ -168,6 +169,7 @@ specification_version: 4
 summary: Black-box web app configuration testing
 test_files:
 - spec/rspec/webservice_matchers/protcol_spec.rb
+- spec/rspec/webservice_matchers/public_api_spec.rb
 - spec/rspec/webservice_matchers/redirect_spec.rb
 - spec/rspec/webservice_matchers/ssl_spec.rb
 - spec/spec_helper.rb