rspec-webservice_matchers 4.0.1 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4356f7c49634e7a88471c05598307e27aaf5fbd
-  data.tar.gz: cdb55236a82a22067581d25ee24591470d658047
+  metadata.gz: a235a451fd315c776f1f3d3b11755e2d93c88b73
+  data.tar.gz: 3826ce984adaae4a9cb9b49b361bd7f3b9aab6bf
 SHA512:
-  metadata.gz: 9c68cb9ac58edc93ae5cf0d16873a342e3d547ad32c35463fa0a315be5ac1d9d046d67ffede36e6dd4b46c254cea002504cb08ee16b8073192661e09d2fce550
-  data.tar.gz: df52ce370c307c92136d5da95cd3d361545d2b0674db8c19a7eca50e28d08e606becffc5a45da26d51de8d63f21c23302ff97679e529bee460b6dc87f5fe51e8
+  metadata.gz: 831a900c20d355fa637fd9f2b8146737457e379e4b1a22e8dd528a09de48fea8d5695e99e706a84887d593c1ea64c199a07ae4e937259b4645416fabb590aff4
+  data.tar.gz: a9b1d9a7a937a0ec451f40d3198b47d9b1868d1b5849211ca094d626f3b260d35fc8a9ea6fac3d67fd6f0ffe3e5d3565b3b0cce39d1ffa31779714151e66551c

data/README.md

@@ -1,9 +1,9 @@
 # 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) [![Code Climate](https://codeclimate.com/github/dogweather/rspec-webservice_matchers.png)](https://codeclimate.com/github/dogweather/rspec-webservice_matchers)
+[![Gem Version](https://badge.fury.io/rb/rspec-webservice_matchers.png)](http://badge.fury.io/rb/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 [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.
+A [gem](https://rubygems.org/gems/rspec-webservice_matchers) to black-box test a web server configuration. For example, whether a site's 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 my motivations.
 
 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.
 
@@ -36,7 +36,7 @@ Here's an example which uses them all:
 ```Ruby
 require 'rspec/webservice_matchers'
 
-describe 'My app' do 
+describe 'My app' do
   context 'www.myapp.com' do
     it { should be_up }
     it { should have_a_valid_cert }
@@ -60,5 +60,3 @@ Related Projects
 ----------------
 * [serverspec](http://serverspec.org)
 * [HTTP Assertions](https://github.com/dogweather/HTTP-Assertions): A precusor to this library. Written in the older test case / assert style.
-
-

data/lib/rspec/webservice_matchers/be_status.rb

@@ -2,18 +2,20 @@ require 'rspec/webservice_matchers/util'
 
 module RSpec
   module WebserviceMatchers
-    # 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_code|
-      actual_code = nil
-
-      match do |url_or_domain_name|
-        actual_code = Util.status(url_or_domain_name)
-        actual_code == expected_code.to_i
-      end
-
-      failure_message do
-        "Received status #{actual_code}"
+    module BeStatus
+      # 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_code|
+        actual_code = nil
+        
+        match do |url_or_domain_name|
+          actual_code = Util.status(url_or_domain_name)
+          actual_code == expected_code.to_i
+        end
+        
+        failure_message do
+          "Received status #{actual_code}"
+        end
       end
     end
   end

data/lib/rspec/webservice_matchers/be_up.rb

@@ -2,18 +2,20 @@ require 'rspec/webservice_matchers/util'
 
 module RSpec
   module WebserviceMatchers
-    # Pass when the response code is 200, following redirects
-    # if necessary.
-    RSpec::Matchers.define :be_up do
-      status = nil
+    module BeUp
+      # Pass when the response code is 200, following redirects
+      # if necessary.
+      RSpec::Matchers.define :be_up do
+        status = nil
 
-      match do |url_or_domain_name|
-        status = Util.status(url_or_domain_name, follow: true)
-        status == 200
-      end
+        match do |url_or_domain_name|
+          status = Util.status(url_or_domain_name, follow: true)
+          status == 200
+        end
 
-      failure_message do
-        "Received status #{status}"
+        failure_message do
+          "Received status #{status}"
+        end
       end
     end
   end

data/lib/rspec/webservice_matchers/enforce_https_everywhere.rb

@@ -1,47 +1,51 @@
 require 'faraday'
-
 require 'rspec/webservice_matchers/util'
+
 module RSpec
   module WebserviceMatchers
-    # This is a high level matcher which checks three things:
-    # 1. Permanent redirect
-    # 2. to an https url
-    # 3. which is correctly configured
-    RSpec::Matchers.define :enforce_https_everywhere do
-      error_msg = status = actual_protocol = actual_valid_cert = nil
+    module EnforceHttpsEverywhere
+      # This is a high level matcher which checks three things:
+      # 1. Permanent redirect
+      # 2. to an https url
+      # 3. which is correctly configured
+      RSpec::Matchers.define :enforce_https_everywhere do
+        error_msg = status = final_protocol = has_valid_cert = nil
+
+        match do |domain_name|
+          begin
+            status, new_url, final_protocol = get_info(domain_name)
+            meets_expectations?(status, final_protocol, Util.valid_cert?(new_url))
+          rescue Faraday::Error::ConnectionFailed
+            error_msg = 'Connection failed'
+            false
+          end
+        end
 
-      match do |domain_name|
-        begin
-          status, headers = Util.head("http://#{domain_name}")
-          new_url  = headers['location']
-          /^(?<protocol>https?)/ =~ new_url
-          actual_protocol = protocol || nil
-          actual_valid_cert = Util.valid_ssl_cert?(new_url)
-          (status == 301) &&
-            (actual_protocol == 'https') &&
-            (actual_valid_cert == true)
-        rescue Faraday::Error::ConnectionFailed
-          error_msg = 'Connection failed'
-          false
+        def get_info(domain_name)
+          status, headers = Util.head(domain_name)
+          location = headers['location']
+          /^(https?)/ =~ location
+          protocol = $1 || nil
+          [status, location, protocol]
         end
-      end
 
-      # Create a compound error message listing all of the
-      # relevant actual values received.
-      failure_message do
-        if !error_msg.nil?
-          error_msg
-        else
+        def meets_expectations?(status, protocol, valid_cert)
+          (status == 301) && (protocol == 'https') && valid_cert
+        end
+
+        # Create a compound error message listing all of the
+        # relevant actual values received.
+        failure_message do
+          error_msg || higher_level_errors(status, final_protocol, has_valid_cert)
+        end
+
+        def higher_level_errors(status, protocol, cert_is_valid)
           mesgs = []
-          if status != 301
-            mesgs << "received status #{status} instead of 301"
-          end
-          if !actual_protocol.nil? && actual_protocol != 'https'
-            mesgs << "destination uses protocol #{actual_protocol.upcase}"
-          end
-          if !actual_valid_cert
-            mesgs << "there's no valid SSL certificate"
+          mesgs << "received status #{status} instead of 301" if status != 301
+          if !protocol.nil? && protocol != 'https'
+            mesgs << "destination uses protocol #{protocol.upcase}"
           end
+          mesgs << "there's no valid SSL certificate" unless cert_is_valid
           mesgs.join('; ').capitalize
         end
       end

data/lib/rspec/webservice_matchers/have_a_valid_cert.rb

@@ -2,21 +2,23 @@ require 'rspec/webservice_matchers/util'
 
 module RSpec
   module WebserviceMatchers
-    # Is https is correctly implemented?
-    RSpec::Matchers.define :have_a_valid_cert do
-      error_message = nil
+    module HaveAValidCert
+      # Is https is correctly implemented?
+      RSpec::Matchers.define :have_a_valid_cert do
+        error_message = nil
 
-      match do |domain_name_or_url|
-        begin
-          Util.try_ssl_connection(domain_name_or_url)
-        rescue Exception => e
-          error_message = e.message
-          false
+        match do |domain_name_or_url|
+          begin
+            Util.try_ssl_connection(domain_name_or_url)
+          rescue Exception => e
+            error_message = e.message
+            false
+          end
         end
-      end
 
-      failure_message do
-        error_message
+        failure_message do
+          error_message
+        end
       end
     end
   end

data/lib/rspec/webservice_matchers/redirect_permanently_to.rb

@@ -2,37 +2,43 @@ require 'rspec/webservice_matchers/util'
 
 module RSpec
   module WebserviceMatchers
-    # Do we get a 301 to the place we intend?
-    RSpec::Matchers.define :redirect_permanently_to do |expected|
-      error_message = status = actual_location = nil
+    module RedirectPermanentlyTo
+      # Do we get a 301 to the place we intend?
+      RSpec::Matchers.define :redirect_permanently_to do |expected|
+        include RSpec
+        exception = status = actual_location = nil
 
-      match do |url_or_domain_name|
-        begin
-          status, headers = Util.head(url_or_domain_name)
-          actual_location = headers['location']
+        match do |url_or_domain_name|
+          begin
+            status, headers = Util.head(url_or_domain_name)
+            actual_location = headers['location']
 
-          (status == 301) && (/#{expected}\/?/.match(actual_location))
-        rescue Exception => e
-          error_message = e.message
-          false
+            Util.permanent_redirect?(status) &&
+              expected_location?(expected, actual_location)
+          rescue Exception => e
+            exception = e
+            false
+          end
         end
-      end
 
-      failure_message do
-        if !error_message.nil?
-          error_message
-        else
-          mesgs = []
-          if [302, 307].include? status
-            mesgs << "received a temporary redirect, status #{status}"
+        failure_message do
+          return Util.error_message(exception) if exception
+
+          errors = []
+          if Util.temp_redirect? status
+            errors << "received a temporary redirect, status #{status}"
           end
-          if !actual_location.nil? && ! (%r|#{expected}/?| === actual_location)
-            mesgs << "received location #{actual_location}"
+          unless expected_location?(expected, actual_location)
+            errors << "received location #{actual_location}"
           end
-          if ![301, 302, 307].include? status
-            mesgs << "not a redirect: received status #{status}"
+          unless Util.redirect? status
+            errors << "not a redirect: received status #{status}"
           end
-          mesgs.join('; ').capitalize
+          Util.error_message(errors)
+        end
+
+        def expected_location?(expected, actual)
+          actual =~ %r{#{expected}/?}
         end
       end
     end

data/lib/rspec/webservice_matchers/redirect_temporarily_to.rb

@@ -2,38 +2,44 @@ require 'rspec/webservice_matchers/util'
 
 module RSpec
   module WebserviceMatchers
-    # Do we get a 302 or 307 to the place we intend?
-    RSpec::Matchers.define :redirect_temporarily_to do |expected|
-      include RSpec
-      error_message = status = actual_location = nil
+    module RedirectTemporarilyTo
+      # Do we get a 302 or 307 to the place we intend?
+      RSpec::Matchers.define :redirect_temporarily_to do |expected|
+        include RSpec
+        status = actual_location = exception = nil
 
-      match do |url_or_domain_name|
-        begin
-          status, headers = Util.head(url_or_domain_name)
-          actual_location = headers['location']
+        match do |url_or_domain_name|
+          begin
+            status, headers = Util.head(url_or_domain_name)
+            actual_location = headers['location']
 
-          [302, 307].include?(status) && (/#{expected}\/?/ =~ actual_location)
-        rescue Exception => e
-          error_message = e.message
-          false
+            Util.temp_redirect?(status) &&
+              expected_location?(expected, actual_location)
+          rescue Exception => e
+            exception = e
+            false
+          end
         end
-      end
 
-      failure_message do
-        if !error_message.nil?
-          error_message
-        else
-          mesgs = []
-          if status == 301
-            mesgs << "received a permanent redirect, status #{status}"
+        failure_message do
+          return Util.error_message(exception) if exception
+
+          errors = []
+          if Util.permanent_redirect? status
+            errors << 'received a permanent redirect'
           end
-          if !actual_location.nil? && ! (%r|#{expected}/?| === actual_location)
-            mesgs << "received location #{actual_location}"
+          unless expected_location? expected, actual_location
+            errors << "received location #{actual_location}"
           end
-          if ![301, 302, 307].include? status
-            mesgs << "not a redirect: received status #{status}"
+          unless Util.redirect? status
+            errors << "not a redirect: received status #{status}"
           end
-          mesgs.join('; ').capitalize
+
+          Util.error_message(errors)
+        end
+
+        def expected_location?(expected, actual)
+          actual =~ %r{#{expected}/?}
         end
       end
     end

data/lib/rspec/webservice_matchers/util.rb

@@ -3,14 +3,33 @@ require 'faraday'
 require 'faraday_middleware'
 require 'pry'
 
-# Seconds
-TIMEOUT = 20
-OPEN_TIMEOUT = 20
+TIMEOUT_IN_SECONDS = 20
+OPEN_TIMEOUT_IN_SECONDS = 20
 
 module RSpec
   module WebserviceMatchers
-    # Refactored utility functions
     module Util
+      def self.error_message(errors)
+        return errors.message if errors.respond_to?(:message)
+        
+        errors
+          .map(&:to_s)
+          .join('; ')
+          .capitalize
+      end
+
+      def self.redirect?(status)
+        temp_redirect?(status) || permanent_redirect?(status)
+      end
+
+      def self.temp_redirect?(status)
+        [302, 307].include?(status)
+      end
+
+      def self.permanent_redirect?(status)
+        status == 301
+      end
+
       def self.status(url_or_domain_name, follow: false)
         head(url_or_domain_name, follow: follow)[0]
       end
@@ -30,7 +49,7 @@ module RSpec
         response.status == 200
       end
 
-      def self.valid_ssl_cert?(domain_name_or_url)
+      def self.valid_cert?(domain_name_or_url)
         try_ssl_connection(domain_name_or_url)
         true
       rescue
@@ -48,8 +67,8 @@ module RSpec
 
       def self.connection(follow: false)
         Faraday.new do |c|
-          c.options[:timeout] = TIMEOUT
-          c.options[:open_timeout] = OPEN_TIMEOUT
+          c.options[:timeout] = TIMEOUT_IN_SECONDS
+          c.options[:open_timeout] = OPEN_TIMEOUT_IN_SECONDS
           c.use(FaradayMiddleware::FollowRedirects, limit: 4) if follow
           c.adapter :excon
         end
@@ -72,11 +91,9 @@ module RSpec
       end
 
       def self.recheck_on_timeout
-        begin
-          yield
-        rescue Faraday::Error::TimeoutError
-          yield
-        end
+        yield
+      rescue Faraday::Error::TimeoutError
+        yield
       end
     end
   end

data/lib/rspec/webservice_matchers/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module WebserviceMatchers
-    VERSION = '4.0.1'
+    VERSION = '4.0.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-webservice_matchers
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.0.2
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-12 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -170,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: Black-box web app configuration testing