rspec-webservice_matchers 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89064b80f84f72a5fd43886b4ef08bddfdd25eab
-  data.tar.gz: d0da9d277e5023d76d52fd5ca524492434266b10
+  metadata.gz: c61a14a2ef20872e409fb4d49f0009e987abdd4b
+  data.tar.gz: ed10304376894e7cdfcd83fee505791c931a12ce
 SHA512:
-  metadata.gz: 338608ed8145220d05925acf13eb5bad0aba255f5452154af1c01f91e188142dd857a45e02caa2dbcf9f7bea05b50e4d190e70fc2635ce75dcc949f883ee0c0f
-  data.tar.gz: 0bc6ca8f292510bc568e5e1bf4735d76fe426bc104eec4454f919c6e261dc9f72bce935f4bc6ab5a89754b764822404b9cb92c47f558951d787d6867bbd0c8f9
+  metadata.gz: 66899e9f493857af03f4d40f032b6b8094c6e19ab1a2b8ff1f4062854939fcc0c72b0cd4cddff90c06f5bd8c1f54ec44da3c3d4278e05be98c83e6815d767d12
+  data.tar.gz: 14dadfd238f5f4e4c46571a96f9896b07f29f8aa2b49ff905f8fcc147d88eb5a40b5002f0afb574eb90b8d8a6c02fdc774e114592667212f9b5eea26f01c63b7

data/README.md

@@ -2,7 +2,7 @@
 
 [![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)
 
-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.)
+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 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.

data/lib/rspec/webservice_matchers.rb

@@ -3,6 +3,11 @@ require 'faraday'
 require 'faraday_middleware'
 require 'pry'
 
+# Seconds
+TIMEOUT = 5 
+OPEN_TIMEOUT = 2
+
+
 module RSpec
   module WebserviceMatchers
 
@@ -14,8 +19,7 @@ module RSpec
 
       # Test by seeing if Curl retrieves without complaining
       begin
-        conn = Faraday.new
-        response = conn.head("https://#{domain_name_or_url}")
+        connection.head("https://#{domain_name_or_url}")
         return true
       rescue
         # Not serving SSL, expired, or incorrect domain name in certificate
@@ -37,19 +41,19 @@ module RSpec
     # Pass successfully if we get a 301 to the place we intend.
     RSpec::Matchers.define :redirect_permanently_to do |expected|
       match do |url|
-        response = Faraday.new.head(url)
+        response = RSpec::WebserviceMatchers.connection.head(url)
         # binding.pry
         response.status == 301 && response.headers['location'] == expected
       end
-    end    
+    end
 
     # Pass successfully if we get a 302 or 307 to the place we intend.
     RSpec::Matchers.define :redirect_temporarily_to do |expected|
       match do |url|
-        response = Faraday.new.head(url)
+        response = RSpec::WebserviceMatchers.connection.head(url)
         [302, 307].include?(response.status) && response.headers['location'] == expected
       end
-    end    
+    end
 
     # This is a high level matcher which checks three things:
     # 1. Permanent redirect
@@ -57,28 +61,30 @@ module RSpec
     # 3. which is correctly configured
     RSpec::Matchers.define :enforce_https_everywhere do
       match do |domain_name|
-        response = Faraday.new.head("http://#{domain_name}")
+        response = RSpec::WebserviceMatchers.connection.head("http://#{domain_name}")
         new_url  = response.headers['location']
         (response.status == 301) && (/https/ === new_url) && (RSpec::WebserviceMatchers.has_valid_ssl_cert?(new_url))
       end
-    end   
+    end
 
     # Pass when a URL returns the expected status code
     # Codes are defined in http://www.rfc-editor.org/rfc/rfc2616.txt
     RSpec::Matchers.define :be_status do |expected|
       match do |url_or_domain_name|
         url      = RSpec::WebserviceMatchers.make_url(url_or_domain_name)
-        response = Faraday.new.head(url)
+        response = RSpec::WebserviceMatchers.connection.head(url)
         response.status == expected
       end
     end
 
-    #Pass when the response code is 200, following redirects
-    #if necessary.
+    # Pass when the response code is 200, following redirects
+    # if necessary.
     RSpec::Matchers.define :be_up do
-      match do |url_or_domain_name|        
+      match do |url_or_domain_name|
         url  = RSpec::WebserviceMatchers.make_url(url_or_domain_name)
         conn = Faraday.new do |c|
+          c.options[:timeout] = TIMEOUT
+          c.options[:open_timeout] = TIMEOUT
           c.use FaradayMiddleware::FollowRedirects, limit: 5
           c.adapter :net_http
         end
@@ -90,6 +96,14 @@ module RSpec
 
     private
 
+    def self.connection
+      Faraday.new do |c|
+        c.options[:timeout] = TIMEOUT
+        c.options[:open_timeout] = TIMEOUT
+        c.adapter :net_http
+      end      
+    end
+
     # Ensure that the given string is a URL,
     # making it into one if necessary.
     def self.make_url(url_or_domain_name)

data/lib/rspec/webservice_matchers/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module WebserviceMatchers
-    VERSION = "1.1.2"
+    VERSION = "1.2.0"
   end
 end

data/rspec-webservice_matchers.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency 'webmock'
 
   spec.add_runtime_dependency 'rspec', '~> 2'
   spec.add_runtime_dependency 'faraday'

data/spec/rspec/webservice_matchers/protcol_spec.rb

@@ -1,15 +1,24 @@
+require 'webmock/rspec'
 require 'rspec/webservice_matchers'
 
 #
-# TODO: set up a test server or mocks for these.
+# TODO: set up mocks or VCR for the rest of these.
+# SEE:  http://www.slideshare.net/kjbuckley/testing-http-calls-with-webmock-and-vcr
 #
+
+WebMock.stub_request :any, 'http://www.website.com/a/page.txt'
+WebMock.stub_request :any, 'http://www.website.com/'
+
+WebMock.allow_net_connect!
+
+
 describe 'status_code' do
   it 'can check 200 for successful resource requests' do
-    'http://www.rfc-editor.org/rfc/rfc2616.txt'.should be_status 200
+    'http://www.website.com/a/page.txt'.should be_status 200
   end
 
   it 'handles domain names as well as URLs' do
-    'www.rfc-editor.org'.should be_status 200
+    'www.website.com'.should be_status 200
   end
 
   it 'can check 503 for the Service Unavailable status' do

data/spec/rspec/webservice_matchers/redirect_spec.rb

@@ -4,6 +4,7 @@ require 'rspec/webservice_matchers'
 # TODO: Set up a server for these. (Or a mock?) 
 #       Faraday supports testing: we can use that now.
 #
+
 describe 'redirect_permanently_to' do
   it 'passes when receiving a 301 to the given URL' do
     expect('http://weblaws.org').to redirect_permanently_to('http://www.weblaws.org/')

data/spec/rspec/webservice_matchers/ssl_spec.rb

@@ -1,16 +1,19 @@
 require 'rspec/webservice_matchers'
 
+# VCR may be the tool to use for this. Can it handle https? Would that work?
+
+
 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.
+    # TODO: set up a test server for this. (?)
     expect('www.eff.org').to have_a_valid_cert
   end  
 
   it 'fails if the server is not serving SSL at all' do
     expect {
       # www.psu.edu only supports HTTP, port 80.
-      # TODO: set up a test server for this.
+      # TODO: set up a test server for this. (?)
       expect('www.psu.edu').to have_a_valid_cert    
     }.to raise_error(RSpec::Expectations::ExpectationNotMetError)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-webservice_matchers
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-30 00:00:00.000000000 Z
+date: 2014-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement