rspec-webservice_matchers 1.4.6 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 301bff8ff03e8860581b9c5b384b1ad69defd7f3
-  data.tar.gz: 99bf6e38a2c4e81d6ed31d209ab62f15a662bd4b
+  metadata.gz: 5f010c192b642b65ee3b60e1e8fa6d60aa4166c8
+  data.tar.gz: 0363d1f7fbe3032c6268964b4f23f845e79996e8
 SHA512:
-  metadata.gz: 05411b388dbe46901b03bf312ce54d3aed2fb105856c87118099be5c5fd7836b8e1b909772b7400695f0d9ca4d6fdb043c395cf7e5e6f3f96e30ce8cce9acc66
-  data.tar.gz: a3cd931442454b0cc94fc933ef0af07edb9cc1edfdb66a38b1cfb39f43861f7a56e0706522538f1a0c3cdac133b35b85573079a510faf2d102464fd05e3ee31b
+  metadata.gz: 3d7e514a44a4fef365fdd968fdc66a72cb15779305cc12d152069d8ef08e727d200ad8f410ecae8f9ad16fd925fa31080b5ab4ce70da3abbdbf85c4adb09dc8f
+  data.tar.gz: b93ac4024054368135ff8d6577165c9ba9e9c248c6baf223515069a56aba7814e7304e4f826258e936925cc5c441edc3d61e38ffd76f67be51a3b60a86b24b2d

data/lib/rspec/webservice_matchers.rb

@@ -1,61 +1,23 @@
 require 'rspec/webservice_matchers/version'
 require 'faraday'
 require 'faraday_middleware'
+require 'pry'
 
 # Seconds
-TIMEOUT = 5 
+TIMEOUT = 5
 OPEN_TIMEOUT = 2
 
-
 module RSpec
+  # RSpec Custom Matchers
+  # See https://www.relishapp.com/rspec/rspec-expectations/v/2-3/docs/custom-matchers/define-matcher
   module WebserviceMatchers
-
-    def self.has_valid_ssl_cert?(domain_name_or_url)
-      # Normalize the input: remove 'http(s)://' if it's there
-      if %r|^https?://(.+)$| === domain_name_or_url
-        domain_name_or_url = $1
-      end
-
-      # Test by seeing if Curl retrieves without complaining
-      begin
-        connection.head("https://#{domain_name_or_url}")
-        return true
-      rescue
-        # Not serving SSL, expired, or incorrect domain name in certificate
-        return false
-      end
-    end
-
-
-    # Return true if the given page has status 200,
-    # and follow a few redirects if necessary.
-    def self.up?(url_or_domain_name)
-      url  = RSpec::WebserviceMatchers.make_url(url_or_domain_name)
-      conn = RSpec::WebserviceMatchers.connection(follow: true)
-      response = conn.head(url)
-      response.status == 200
-    end
-
-
-    def self.try_ssl_connection(domain_name_or_url)
-      # Normalize the input: remove 'http(s)://' if it's there
-      if %r|^https?://(.+)$| === domain_name_or_url
-        domain_name_or_url = $1
-      end
-      connection.head("https://#{domain_name_or_url}")
-    end
-
-
-    # RSpec Custom Matchers ###########################################
-    # See https://www.relishapp.com/rspec/rspec-expectations/v/2-3/docs/custom-matchers/define-matcher
-
     # Test whether https is correctly implemented
     RSpec::Matchers.define :have_a_valid_cert do
       error_message = nil
 
       match do |domain_name_or_url|
         begin
-          RSpec::WebserviceMatchers.try_ssl_connection(domain_name_or_url)
+          WebserviceMatchers.try_ssl_connection(domain_name_or_url)
           true
         rescue Exception => e
           error_message = e.message
@@ -68,37 +30,36 @@ module RSpec
       end
     end
 
-
     # Pass successfully if we get a 301 to the place we intend.
     RSpec::Matchers.define :redirect_permanently_to do |expected|
       error_message = actual_status = actual_location = nil
 
       match do |url_or_domain_name|
         begin
-          response = RSpec::WebserviceMatchers.connection.head(RSpec::WebserviceMatchers.make_url url_or_domain_name)
-          expected = RSpec::WebserviceMatchers.make_url(expected)
+          response = WebserviceMatchers.connection.head(WebserviceMatchers.make_url url_or_domain_name)
+          expected = WebserviceMatchers.make_url(expected)
           actual_location = response.headers['location']
           actual_status   = response.status
 
-          (actual_status == 301) && (%r|#{expected}/?| === actual_location)
+          (actual_status == 301) && (/#{expected}\/?/.match(actual_location))
         rescue Exception => e
           error_message = e.message
-          false  
+          false
         end
       end
 
       failure_message_for_should do
-        if ! error_message.nil?
+        if !error_message.nil?
           error_message
         else
           mesgs = []
           if [302, 307].include? actual_status
             mesgs << "received a temporary redirect, status #{actual_status}"
           end
-          if ! actual_location.nil? && ! (%r|#{expected}/?| === actual_location)
+          if !actual_location.nil? && ! (%r|#{expected}/?| === actual_location)
             mesgs << "received location #{actual_location}"
           end
-          if ! [301, 302, 307].include? actual_status
+          if ![301, 302, 307].include? actual_status
             mesgs << "not a redirect: received status #{actual_status}"
           end
           mesgs.join('; ').capitalize
@@ -106,37 +67,37 @@ module RSpec
       end
     end
 
-
     # Pass successfully if we get a 302 or 307 to the place we intend.
     RSpec::Matchers.define :redirect_temporarily_to do |expected|
+      include RSpec
       error_message = actual_status = actual_location = nil
 
       match do |url_or_domain_name|
         begin
-          response = RSpec::WebserviceMatchers.connection.head(RSpec::WebserviceMatchers.make_url url_or_domain_name)
-          expected = RSpec::WebserviceMatchers.make_url(expected)
+          response = WebserviceMatchers.connection.head(WebserviceMatchers.make_url url_or_domain_name)
+          expected = WebserviceMatchers.make_url(expected)
           actual_location = response.headers['location']
           actual_status   = response.status
 
-          [302, 307].include?(actual_status) && (%r|#{expected}/?| === actual_location)
+          [302, 307].include?(actual_status) && (/#{expected}\/?/ =~ actual_location)
         rescue Exception => e
           error_message = e.message
-          false  
+          false
         end
       end
 
       failure_message_for_should do
-        if ! error_message.nil?
+        if !error_message.nil?
           error_message
         else
           mesgs = []
           if actual_status == 301
             mesgs << "received a permanent redirect, status #{actual_status}"
           end
-          if ! actual_location.nil? && ! (%r|#{expected}/?| === actual_location)
+          if !actual_location.nil? && ! (%r|#{expected}/?| === actual_location)
             mesgs << "received location #{actual_location}"
           end
-          if ! [301, 302, 307].include? actual_status
+          if ![301, 302, 307].include? actual_status
             mesgs << "not a redirect: received status #{actual_status}"
           end
           mesgs.join('; ').capitalize
@@ -144,7 +105,6 @@ module RSpec
       end
     end
 
-
     # This is a high level matcher which checks three things:
     # 1. Permanent redirect
     # 2. to an https url
@@ -154,18 +114,17 @@ module RSpec
 
       match do |domain_name|
         begin
-          response = RSpec::WebserviceMatchers.connection.head("http://#{domain_name}")
+          response = WebserviceMatchers.connection.head("http://#{domain_name}")
           new_url  = response.headers['location']
           actual_status  = response.status
-          if new_url =~ /^(https?)/
-            actual_protocol = $1
-          end
-          actual_valid_cert = RSpec::WebserviceMatchers.has_valid_ssl_cert?(new_url)
+          /^(?<protocol>https?)/ =~ new_url
+          actual_protocol = protocol || nil
+          actual_valid_cert = WebserviceMatchers.valid_ssl_cert?(new_url)
           (actual_status == 301) &&
             (actual_protocol == 'https') &&
             (actual_valid_cert == true)
-        rescue Faraday::Error::ConnectionFailed => e
-          error_msg = "Connection failed"
+        rescue Faraday::Error::ConnectionFailed
+          error_msg = 'Connection failed'
           false
         end
       end
@@ -183,7 +142,7 @@ module RSpec
           if !actual_protocol.nil? && actual_protocol != 'https'
             mesgs << "destination uses protocol #{actual_protocol.upcase}"
           end
-          if ! actual_valid_cert
+          if !actual_valid_cert
             mesgs << "there's no valid SSL certificate"
           end
           mesgs.join('; ').capitalize
@@ -192,18 +151,17 @@ module RSpec
 
     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|
+    RSpec::Matchers.define :be_status do |expected_code|
       actual_code = nil
-      
+
       match do |url_or_domain_name|
-        url         = RSpec::WebserviceMatchers.make_url(url_or_domain_name)
-        response    = RSpec::WebserviceMatchers.connection.head(url)
-        actual_code = response.status
-        expected    = expected.to_i
-        actual_code == expected
+        url           = WebserviceMatchers.make_url(url_or_domain_name)
+        response      = WebserviceMatchers.connection.head(url)
+        actual_code   = response.status
+        expected_code = expected_code.to_i
+        actual_code   == expected_code
       end
 
       failure_message_for_should do
@@ -211,15 +169,14 @@ module RSpec
       end
     end
 
-
     # Pass when the response code is 200, following redirects
     # if necessary.
     RSpec::Matchers.define :be_up do
       actual_status = nil
 
       match do |url_or_domain_name|
-        url  = RSpec::WebserviceMatchers.make_url(url_or_domain_name)
-        conn = RSpec::WebserviceMatchers.connection(follow: true)
+        url  = WebserviceMatchers.make_url(url_or_domain_name)
+        conn = WebserviceMatchers.connection(follow: true)
         response = conn.head(url)
         actual_status = response.status
         actual_status == 200
@@ -230,6 +187,26 @@ module RSpec
       end
     end
 
+    # Return true if the given page has status 200,
+    # and follow a few redirects if necessary.
+    def self.up?(url_or_domain_name)
+      url  = make_url(url_or_domain_name)
+      conn = connection(follow: true)
+      response = conn.head(url)
+      response.status == 200
+    end
+
+    def self.valid_ssl_cert?(domain_name_or_url)
+      try_ssl_connection(domain_name_or_url)
+      true
+    rescue
+      # Not serving SSL, expired, or incorrect domain name in certificate
+      false
+    end
+
+    def self.try_ssl_connection(domain_name_or_url)
+      connection.head("https://#{remove_protocol(domain_name_or_url)}")
+    end
 
     private
 
@@ -237,22 +214,25 @@ module RSpec
       Faraday.new do |c|
         c.options[:timeout] = TIMEOUT
         c.options[:open_timeout] = TIMEOUT
-        if follow
-          c.use FaradayMiddleware::FollowRedirects, limit: 4          
-        end
+        c.use(FaradayMiddleware::FollowRedirects, limit: 4) if follow
         c.adapter :net_http
-      end      
+      end
     end
 
     # Ensure that the given string is a URL,
     # making it into one if necessary.
     def self.make_url(url_or_domain_name)
-      unless %r|^https?://| === url_or_domain_name
-        "http://#{url_or_domain_name}"
-      else
+      if %r{^https?://} =~ url_or_domain_name
         url_or_domain_name
+      else
+        "http://#{url_or_domain_name}"
       end
     end
 
+    # Normalize the input: remove 'http(s)://' if it's there
+    def self.remove_protocol(domain_name_or_url)
+      %r{^https?://(?<name>.+)$} =~ domain_name_or_url
+      name || domain_name_or_url
+    end
   end
 end

data/lib/rspec/webservice_matchers/version.rb

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

data/rspec-webservice_matchers.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
   spec.add_development_dependency 'webmock'
+  spec.add_development_dependency "codeclimate-test-reporter"
 
   spec.add_runtime_dependency 'rspec', '~> 2'
   spec.add_runtime_dependency 'faraday'

data/spec/rspec/webservice_matchers/ssl_spec.rb

@@ -1,31 +1,28 @@
 require 'spec_helper'
 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. (?)
     expect('www.eff.org').to have_a_valid_cert
-  end  
+  end
 
   it 'fails if the server is not serving SSL at all' do
     expect {
-      expect('www.psu.edu').to have_a_valid_cert    
+      expect('www.psu.edu').to have_a_valid_cert
     }.to fail
   end
 
   it 'provides a relevant error message' do
     expect {
-      expect('www.psu.edu').to have_a_valid_cert    
-    }.to fail_matching(/no route to host/i)
+      expect('www.psu.edu').to have_a_valid_cert
+    }.to fail_matching(/(no route to host)|(connection refused)/i)
   end
 
   it "provides a relevant error message when the domain name doesn't exist" do
     expect {
-      expect('sdfgkljhsdfghjkhsdfgj.edu').to have_a_valid_cert    
+      expect('sdfgkljhsdfghjkhsdfgj.edu').to have_a_valid_cert
     }.to fail_matching(/not known/i)
   end
 
@@ -36,7 +33,6 @@ describe 'have_a_valid_cert matcher' do
   end
 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

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 require 'webmock/rspec'
 
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-webservice_matchers
 version: !ruby/object:Gem::Version
-  version: 1.4.6
+  version: '2.0'
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-18 00:00:00.000000000 Z
+date: 2014-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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