rspec-webservice_matchers 4.9.0 → 4.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f930e26ec837ba1ca066f2a911608b5c58edfc09
-  data.tar.gz: 0c2be7eae06450c998838d3e1530421ee9dcb6b2
+SHA256:
+  metadata.gz: 617b8cb74f6bc84677c5ead97e558a6b6b9755f9044bcaeccfb3f63cb986b1b9
+  data.tar.gz: 4309003b1b46bf0b06ad2990d984d137c0cfd72028ccacd2e871337a713d347b
 SHA512:
-  metadata.gz: 702e17e06e648086ce8c75c2838eb3997a7d44ccb741af282d22b46785fc5d44862966713e788c54acbe908f2290469fb170754c0fec303b8218dab3bfa7197b
-  data.tar.gz: 88be96f4ae2de62c765bb0a9fd6bc621e0024b6513ba945700922adeb4e76031f9b3e9ab04e9ed1247cb928bf305ee335679a4c9a96128245e44ab721c7c6ec6
+  metadata.gz: 5f6253513b26f6bf0adaf28934961912fca38756ddbcbc1cf4e16f70bfdf5c5511a14a353a2989c51a9ef08366fda27a1ef8ea831c9d44e37173363979bdeb87
+  data.tar.gz: 1e03ec8f1aa261bba4dad5a82222eb9a5c224336ead102478f3831068e501c50b5c13bfb628233415d3dc47f9258e729d4c8b196108529561ab692cda9f16efd

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.4', '2.5', '2.6', '2.7']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/HISTORY.md

@@ -1,3 +1,16 @@
+4.12.0
+------
+Refactoring.
+Change the Be fast test result for response to be the raw response.
+
+4.11.0
+------
+Adds the full PageSpeed result to the `BeFast::TestResult`.
+
+4.10.0
+------
+Refactoring lower-level code into new namespace.
+
 4.9.0
 -----
 Adds new API for `be_fast`.

data/README.md

@@ -1,7 +1,6 @@
 # RSpec::WebserviceMatchers
 
-[![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)
-
+![Ruby](https://github.com/dogweather/rspec-webservice_matchers/workflows/Ruby/badge.svg?branch=master) [![Maintainability](https://api.codeclimate.com/v1/badges/501f791f1ea83905e992/maintainability)](https://codeclimate.com/github/dogweather/rspec-webservice_matchers/maintainability) [![Gem Version](https://badge.fury.io/rb/rspec-webservice_matchers.svg)](https://badge.fury.io/rb/rspec-webservice_matchers)
 
 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:
 
@@ -9,13 +8,10 @@ A [gem](https://rubygems.org/gems/rspec-webservice_matchers) to black-box test a
 expect('github.com').to have_a_valid_cert
 ```
 
-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 the backstory and [Nonstop QA - a SaaS built on it](https://nonstop.qa).
+It's a tool for doing **Test Driven Devops** (I just made that up). See [my introductory blog post](https://dogsnog.blog/2014/01/16/new-open-source-library-for-test-driven-devops/) for the backstory.
 
 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.
 
-If you're too busy to install this and code the tests by hand, you can try the [new hosted service which runs these RSpec matchers in the cloud](http://nonstop.qa): [![QA Status](http://nonstop.qa/projects/20/badges/default.svg)](http://nonstop.qa/projects/20-nonstop-qa)
-
-
 
 
 Installation
@@ -28,15 +24,15 @@ What You Get
 ------------
 These new RSpec matchers:
 
-                               | Notes
--------------------------------|------------------------------------------------
-**be_up**                      | Looks for a 200, but will follow up to four redirects
-**be_fast**                    | Checks for Google [PageSpeed](https://developers.google.com/speed/pagespeed/insights/) score >= 85. Expects the environment variable `WEBSERVICE_MATCHER_INSIGHTS_KEY` to contain a [Google "server" API key](https://developers.google.com/speed/docs/insights/v2/getting-started) with PageSpeed Insights API enabled.
-**enforce_https_everywhere**   | Passes if the site will _only_ allow SSL connections. See the [EFF project, HTTPS Everywhere](https://www.eff.org/https-everywhere)
-**have_a_valid_cert**          | Will fail if there's no cert, or it's expired or incorrectly configured
-**be_status**                  | A low-level matcher to explicitly check for a 200, 503, or any other code
-**redirect_permanently_to**    | Checks for 301 and a correct destination URL
-**redirect_temporarily_to**    | Checks for 302 or 307 and a correct destination
+|                               | Notes
+|-------------------------------|------------------------------------------------
+|**be_up**                      | Looks for a 200, but will follow up to four redirects
+|**be_fast**                    | Checks for Google [PageSpeed](https://developers.google.com/speed/pagespeed/insights/) score >= 85. Expects the environment variable `WEBSERVICE_MATCHER_INSIGHTS_KEY` to contain a [Google "server" API key](https://developers.google.com/speed/docs/insights/v2/getting-started) with PageSpeed Insights API enabled.
+|**enforce_https_everywhere**   | Passes if the site will _only_ allow SSL connections. See the [EFF project, HTTPS Everywhere](https://www.eff.org/https-everywhere)
+|**have_a_valid_cert**          | Will fail if there's no cert, or it's expired or incorrectly configured
+|**be_status**                  | A low-level matcher to explicitly check for a 200, 503, or any other code
+|**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/circle.yml

@@ -1,3 +1,5 @@
 machine:
   ruby:
     version: 2.3.0
+    version: 2.4.3
+    version: 2.5.0

data/lib/rspec/webservice_matchers/be_fast.rb

@@ -1,59 +1,15 @@
 # frozen_string_literal: true
-require 'cgi'
-require 'json'
 require 'rspec/matchers'
-require 'rspec/webservice_matchers/util'
-require 'validated_object'
+require 'web_test/be_fast'
 
 module RSpec
   module WebserviceMatchers
     module BeFast
-
-      class TestResult < ValidatedObject::Base
-        attr_accessor :success, :score
-        alias success? success
-
-        validates :success, inclusion: [true, false]
-        validates :score, inclusion: (0..100)
-      end
-
-
-      def self.parse(json:)
-        response = JSON.parse(json)
-        unless response.key?('ruleGroups')
-          raise "Couldn't parse the PageSpeed response: #{response.inspect}"
-        end
-        score = response.fetch('ruleGroups').fetch('SPEED').fetch('score')
-        { score: score }
-      end
-
-      def self.page_speed_score(url:)
-        url_param = CGI.escape(Util.make_url(url))
-        key       = ENV['WEBSERVICE_MATCHER_INSIGHTS_KEY']
-        if key.nil?
-          raise 'be_fast requires the WEBSERVICE_MATCHER_INSIGHTS_KEY '\
-                'environment variable to be set to a Google PageSpeed '\
-                'Insights API key.'
-        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)
-      end
-
-      def self.test(url:)
-        TestResult.new do |r|
-          r.score   = BeFast.page_speed_score(url: url)
-          r.success = r.score >= 85
-        end
-      end
-
-
       RSpec::Matchers.define :be_fast do
         score = nil
 
         match do |url|
-          result = BeFast.test(url: url)
+          result = WebTest::BeFast.test(url: url)
           score = result.score
           result.success?
         end

data/lib/rspec/webservice_matchers/be_status.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'rspec/webservice_matchers/util'
+require 'web_test/util'
+
 
 module RSpec
   module WebserviceMatchers
@@ -10,7 +11,7 @@ module RSpec
         actual_code = nil
         
         match do |url_or_domain_name|
-          actual_code = Util.status(url_or_domain_name)
+          actual_code = WebTest::Util.status(url_or_domain_name)
           actual_code == expected_code.to_i
         end
         

data/lib/rspec/webservice_matchers/be_up.rb

@@ -1,37 +1,16 @@
 # frozen_string_literal: true
 require 'rspec/matchers'
-require 'rspec/webservice_matchers/util'
-require 'validated_object'
+require 'web_test/be_up'
 
 # Pass when the response code is 200, following redirects if necessary.
 module RSpec
   module WebserviceMatchers
     module BeUp
-
-      class TestResult < ValidatedObject::Base
-        attr_accessor :success, :status_code
-        alias success? success
-
-        validates :success,     inclusion: [true, false]
-        validates :status_code, inclusion: 100..510
-      end
-
-
-      def self.test(url:nil, domain:nil)
-        raise 'Must specify a url or domain' if url.nil? && domain.nil?
-
-        TestResult.new do |r|
-          r.status_code = Util.status(url || domain, follow: true)
-          r.success =     (r.status_code == 200)
-        end
-      end
-
-
       RSpec::Matchers.define :be_up do
         status = nil
 
         match do |url_or_domain_name|
-          result = BeUp.test(url: url_or_domain_name)
+          result = WebTest::BeUp.test(url: url_or_domain_name)
           status = result.status_code
           result.success?
         end
@@ -40,7 +19,6 @@ module RSpec
           "Received status #{status}"
         end
       end
-
     end
   end
 end

data/lib/rspec/webservice_matchers/enforce_https_everywhere.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require 'faraday'
-require 'rspec/webservice_matchers/util'
+require 'web_test/util'
+
 require 'rspec/webservice_matchers/redirect_helpers'
 
 module RSpec
@@ -14,10 +15,10 @@ module RSpec
         include RedirectHelpers
         error_msg = status = final_protocol = has_valid_cert = nil
 
-        match do |domain_name|
+        match do |domain_name_or_url|
           begin
-            status, new_url, final_protocol = get_info(domain_name)
-            meets_expectations?(status, final_protocol, Util.valid_cert?(new_url))
+            status, new_url, final_protocol = get_info(WebTest::Util.make_domain_name(domain_name_or_url))
+            meets_expectations?(status, final_protocol, WebTest::Util.valid_cert?(new_url))
           rescue Faraday::Error::ConnectionFailed
             error_msg = 'Connection failed'
             false
@@ -25,7 +26,7 @@ module RSpec
         end
 
         def get_info(domain_name)
-          status, headers = Util.head(domain_name)
+          status, headers = WebTest::Util.head(domain_name)
           location = headers['location']
           /^(https?)/ =~ location
           protocol = Regexp.last_match(1) || nil
@@ -51,7 +52,7 @@ module RSpec
             errors << "destination uses protocol #{protocol.upcase}"
           end
           errors << "there's no valid SSL certificate" unless cert_is_valid
-          Util.error_message(errors)
+          WebTest::Util.error_message(errors)
         end
       end
     end

data/lib/rspec/webservice_matchers/have_a_valid_cert.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'rspec/webservice_matchers/util'
+require 'web_test/util'
+
 require 'rspec/matchers'
 
 module RSpec
@@ -11,7 +12,7 @@ module RSpec
 
         match do |domain_name_or_url|
           begin
-            Util.try_ssl_connection(domain_name_or_url)
+            WebTest::Util.try_ssl_connection(domain_name_or_url)
           rescue Exception => e
             error_message = fix_for_excon_bug(e.message)
             false

data/lib/rspec/webservice_matchers/redirect_helpers.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
-require 'rspec/webservice_matchers/util'
+require 'web_test/util'
+
 
 module RSpec
   module WebserviceMatchers
     module RedirectHelpers
       def redirect_failure_message(exception, status, actual_location, kind)
-        return Util.error_message(exception) if exception
+        return WebTest::Util.error_message(exception) if exception
 
         errors = []
         if redirect? status
@@ -19,7 +20,7 @@ module RSpec
           errors << "not a redirect: received status #{status}"
         end
 
-        Util.error_message(errors)
+        WebTest::Util.error_message(errors)
       end
 
       def redirects_correctly?(status, actual_loc, expected_loc, kind)
@@ -27,7 +28,7 @@ module RSpec
       end
 
       def redirect_result(url_or_domain_name)
-        status, headers = Util.head(url_or_domain_name)
+        status, headers = WebTest::Util.head(url_or_domain_name)
         [status, headers['location']]
       end
 

data/lib/rspec/webservice_matchers/redirect_permanently_to.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'rspec/webservice_matchers/util'
+require 'web_test/util'
+
 require 'rspec/webservice_matchers/redirect_helpers'
 
 module RSpec

data/lib/rspec/webservice_matchers/redirect_temporarily_to.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'rspec/webservice_matchers/util'
+require 'web_test/util'
+
 require 'rspec/webservice_matchers/redirect_helpers'
 
 module RSpec

data/lib/rspec/webservice_matchers/version.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 module RSpec
   module WebserviceMatchers
-    VERSION = '4.9.0'
+    VERSION = '4.12.2'
   end
 end

data/lib/web_test/be_fast.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+require 'cgi'
+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, :response
+      alias success? success
+
+      validates :success,  type: Boolean
+      validates :score,    inclusion: 0..100
+      validates :response, type: Hash
+    end
+
+
+    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[:raw_response]
+      end
+    end
+
+    def self.page_speed(url:)
+      url_param = CGI.escape(WebTest::Util.make_url(url))
+      key       = ENV['WEBSERVICE_MATCHER_INSIGHTS_KEY']
+      if key.nil?
+        raise 'be_fast requires the WEBSERVICE_MATCHER_INSIGHTS_KEY '\
+              'environment variable to be set to a Google PageSpeed '\
+              'Insights API key.'
+      end
+      endpoint  = 'https://www.googleapis.com/pagespeedonline/v2/runPagespeed'
+      api_url   = "#{endpoint}?url=#{url_param}&screenshot=false&key=#{key}"
+      parse json: Faraday.get(api_url).body
+    end
+
+    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/lib/web_test/be_up.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'validated_object'
+require 'web_test/util'
+
+module WebTest
+  module BeUp
+    class TestResult < ValidatedObject::Base
+      attr_accessor :success, :status_code
+      alias success? success
+
+      validates :success,     type: Boolean
+      validates :status_code, inclusion: 100..510
+    end
+
+
+    def self.test(url:nil, domain:nil)
+      raise 'Must specify a url or domain' if url.nil? && domain.nil?
+
+      TestResult.new do |r|
+        r.status_code = WebTest::Util.status(url || domain, follow: true)
+        r.success     = (r.status_code == 200)
+      end
+    end
+  end
+end