webtrap 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6588474ffa8dde283728eb5f92c5eff22fe4dcba
-  data.tar.gz: 6bbd81d456fb3a44a72c95a570c2b24dfb5df1a1
+  metadata.gz: a15e9e6f37a30d98232e8f3d32903ae6a8bc6a90
+  data.tar.gz: 8b30c18bed81414f5ee9fcc77eba9960ab0b37ae
 SHA512:
-  metadata.gz: de34495dfafe249c736524599a365bd9ad3e5dce325fa1421dadd04d65e5f248a8b20ec0f5e664d7d25b74ce73fc5f55165742ee8fe18accecd11d2b7dd2032a
-  data.tar.gz: 98a88a5212a5769ce493862ae11db94f4a54f7b273c0f2880dc081a6cb84dc300b092f52a6d5ecd63970b845dd11437905da019b964b770578fb8a67795ee81a
+  metadata.gz: 147dafeaf072c3603589c96954649695afe74fad643fd7664531b998fc3f404620695990a14ecbeab3ddf7361c6ef3a5bb0c61f8243b72ac8b840e8e680aa4b4
+  data.tar.gz: ed986d9cae9ca4bd8f98457a38948eb7d316e97065c2cfe3dce6737f10bffa6553a2ecc5e1867bd1592bbb25ed231dfa3cd828c4608ee38493bfa32f057b3bf9

data/.travis.yml

@@ -5,12 +5,10 @@ cache:
     - ../bundle
 bundler_args: "--standalone --path ../bundle"
 rvm:
-  - 2.0.0
-  - 2.1
   - 2.2.5
   - 2.3.3
   - 2.4.0
   - ruby-head
-before_install: gem install bundler -v 1.13.6
+before_install: gem install bundler
 script:
-  - bundle exec cucumber
+  - bundle exec rake

data/Gemfile

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec
 
 group :documentation do
+  gem "relish", "~> 0.7.1"
   gem "yard", "~> 0.9.8"
 end

data/Gemfile.lock

@@ -1,19 +1,23 @@
 PATH
   remote: .
   specs:
-    webtrap (0.0.0)
+    webtrap (0.0.1)
       equivalent-xml (~> 0.6.0)
+      rack (~> 2.0)
       rspec (~> 3.0)
-      sinatra (~> 1.0)
       webmock (~> 2.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     addressable (2.5.0)
       public_suffix (~> 2.0, >= 2.0.2)
+    archive-tar-minitar (0.6.1)
+      minitar (~> 0.6)
+      minitar-cli (~> 0.6)
     ast (2.3.0)
     builder (3.2.3)
+    coderay (1.1.1)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     cucumber (2.4.0)
@@ -28,24 +32,54 @@ GEM
       gherkin (~> 4.0)
     cucumber-wire (0.0.1)
     diff-lcs (1.3)
+    domain_name (0.5.20170223)
+      unf (>= 0.0.5, < 1.0.0)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
     gherkin (4.0.0)
     hashdiff (0.3.2)
+    hashie (3.5.5)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (2.0.3)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
     mini_portile2 (2.1.0)
+    minitar (0.6.1)
+    minitar-cli (0.6.1)
+      minitar (~> 0.6.0)
+      powerbar (~> 1.0)
     multi_json (1.12.1)
     multi_test (0.1.2)
+    netrc (0.11.0)
     nokogiri (1.6.8.1)
       mini_portile2 (~> 2.1.0)
     parser (2.4.0.0)
       ast (~> 2.2)
+    powerbar (1.0.18)
+      hashie (>= 1.1.0)
     powerpack (0.1.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-remote (0.1.8)
+      pry (~> 0.9)
+      slop (~> 3.0)
     public_suffix (2.0.5)
-    rack (1.6.5)
-    rack-protection (1.5.3)
-      rack
+    rack (2.0.1)
     rainbow (2.2.1)
-    rake (10.4.2)
+    rake (12.0.0)
+    relish (0.7.1)
+      archive-tar-minitar (>= 0.5.2)
+      json (>= 1.4.6)
+      rest-client (>= 1.7.2)
+    rest-client (2.0.1)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
@@ -67,11 +101,10 @@ GEM
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.8.1)
     safe_yaml (1.0.4)
-    sinatra (1.4.8)
-      rack (~> 1.5)
-      rack-protection (~> 1.4)
-      tilt (>= 1.3, < 3)
-    tilt (2.0.6)
+    slop (3.6.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
     unicode-display_width (1.1.3)
     webmock (2.3.2)
       addressable (>= 2.3.6)
@@ -85,10 +118,12 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.13)
   cucumber (~> 2.0)
-  rake (~> 10.0)
+  pry-remote (~> 0.1.8)
+  rake (~> 12.0)
+  relish (~> 0.7.1)
   rubocop (~> 0.47.1)
   webtrap!
   yard (~> 0.9.8)
 
 BUNDLED WITH
-   1.13.6
+   1.14.5

data/README.md

@@ -5,7 +5,11 @@ WebTrap
 [![Build Status](https://travis-ci.org/pfac/webtrap.svg?branch=master)](https://travis-ci.org/pfac/webtrap)
 [![Dependency Status](https://gemnasium.com/badges/github.com/pfac/webtrap.svg)](https://gemnasium.com/github.com/pfac/webtrap)
 [![Code Climate](https://codeclimate.com/github/pfac/webtrap/badges/gpa.svg)](https://codeclimate.com/github/pfac/webtrap)
-[![Inch CI](https://inch-ci.org/github/pfac/webtrap.svg?branch=master)](https://inch-ci.org/github/pfac/webtrap)
+
+Documentation:
+[![Usage Documentation](https://img.shields.io/badge/usage-0.1.0-brightgreen.svg?style=flat)](http://www.relishapp.com/pfac/webtrap/docs)
+[![API Documentation](https://img.shields.io/badge/api-0.1.0-brightgreen.svg?style=flat)](http://www.rubydoc.info/gems/webtrap)
+[![Documentation Coverage](https://inch-ci.org/github/pfac/webtrap.svg?branch=master)](https://inch-ci.org/github/pfac/webtrap)
 
 WebTrap allows you to write tests that assert on outgoing requests. This allows
 you to verify that such requests match the documentation of external services

data/lib/webtrap/rspec/matchers/send_request.rb

@@ -1,71 +1,102 @@
 # frozen_string_literal: true
 
 require "webmock/rspec"
+require "webtrap/shared"
+require "rack"
 
 module WebTrap
   module RSpec
     module Matchers
       # @api private
-      # Provides the implementation for `send_request`.
+      # Provides the implementation for <code>send_request</code>.
+      #
       # Not intended to be instantiated directly.
+      #
+      # @see http://www.rubydoc.info/github/rspec/rspec-expectations/RSpec/Matchers/MatcherProtocol RSpec Matcher Protocol
       class SendRequest
+        # Initialize a new matcher.
+        #
+        # Unless more constraints are chained, this matcher will pass as long
+        # as any HTTP request gets intercepted.
+        #
+        # @see Shared::Validators::RequestSentValidator
+        def initialize
+          add_validator(Shared::Validators::RequestSentValidator.new)
+        end
+
         # @api public
         # Specifies the XML payload of the request.
         #
         # The expectation will pass only if a request is sent with a payload
-        # that is considered equivalent to the reference. For further details
-        # see the {https://github.com/mbklein/equivalent-xml equivalent-xml}
-        # gem.
+        # that is considered equivalent to the reference.
         #
-        # @param xml [] The reference XML payload.
-        # @return [SendRequestWithXml]
-        #   The matcher to verify that a request is with a payload equivalent
-        #   to the reference.
+        # @param xml [String]
+        #   The reference XML payload.
+        # @return [SendRequest]
+        #   This matcher instance, to allow further chaining.
+        # @see Shared::Validators::EquivalentXmlContentValidator
         def with_xml(xml)
-          SendRequestWithXml.new(xml)
+          add_validator(Shared::Validators::EquivalentXmlContentValidator.new(xml))
+          self
         end
 
         # @api private
-        # Checks if the provided Proc sends an HTTP request.
+        # Whether a request was intercepted that matches all validators.
+        #
+        # Executes the provided proc, intercepting all transmitted HTTP requests
+        # and running them through the set of validators.
+        #
         # @param transmission_proc [Proc]
-        #   The proc that should send an HTTP request.
-        # @return
-        #   Whether an HTTP request was sent.
-        # @see {RSpec::Matchers::MatcherProtocol#matches?}
+        #   The proc that is expected to send the requests.
+        # @return {Boolean}
         def matches?(transmission_proc)
           perform_transmission(transmission_proc)
-          request_sent?
+          failure_message.nil?
         end
 
         # @api private
-        # Message to be shown if the expectation fails to pass.
+        # Message to be shown if no request is intercepted for which all
+        # validators are successful.
+        #
         # @return [String]
         def failure_message
-          "expected block to send an HTTP request, but nothing was sent out"
+          return if failed_validator.nil?
+          failed_validator.failure_message
         end
 
         # @api private
         # Allows the matcher to be used with block expectations.
-        # @return [TrueClass]
+        #
+        # @return [true]
         def supports_block_expectations?
           true
         end
 
         private
 
+        def validators
+          @_validators ||= []
+        end
+
+        def add_validator(validator)
+          validators << validator
+        end
+
+        def failed_validator
+          validators.find(&:failed?)
+        end
+
         def perform_transmission(transmission_proc)
           WebMock.disable_net_connect!
-          begin
-            transmission_proc.call
-            @request_sent = false
-          rescue WebMock::NetConnectNotAllowedError
-            @request_sent = true
-          end
+          WebMock::API.stub_request(:any, /.*/).to_rack(app)
+
+          transmission_proc.call
+
           WebMock.allow_net_connect!
         end
 
-        def request_sent?
-          @request_sent
+        def app
+          @_app ||= Shared::RackApp.new(validators)
         end
       end
     end

data/lib/webtrap/rspec/matchers.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-require "webtrap/rspec/matchers/send_request"
-require "webtrap/rspec/matchers/send_request_with_xml"
-
 module WebTrap
   module RSpec
-    # WebTrap::RSpec::Matchers provides the set of matchers available to define
-    # expections about outgoing requests.
+    # Set of matchers available to define expections about outgoing requests.
     module Matchers
-      # Passes if the block sends any HTTP request.
+      autoload :SendRequest, "webtrap/rspec/matchers/send_request"
+
+      # Passes if the expectation block sends an HTTP request.
+      #
+      # Constraints to specify the expected request can be chained.
       #
       # @return [SendRequest]
-      #   The matcher to verify that the request is sent.
+      #   The matcher instance to verify that a request is sent.
       def send_request
         SendRequest.new
       end

data/lib/webtrap/rspec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "webtrap/server"
-
 require "webtrap/rspec/matchers"
 
 module WebTrap

data/lib/webtrap/shared/rack_app.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# @api private
+# Rack applications used to intercept HTTP requests and apply a set of
+# validators on them.
+class WebTrap::Shared::RackApp
+  # Instantiate a new Rack application with the provided set of validators.
+  #
+  # @param validators [Array]
+  #   Set of validators used on the intercepted request to assert its validity.
+  # @example Intercept any request
+  #   require "webmock"
+  #   # ...
+  #   WebMock::API.stub_request(:any, /.*/).to_rack RackApp.new(validators)
+  def initialize(validators)
+    @validators = validators
+  end
+
+  # Handle an HTTP request.
+  #
+  # @param request [Hash]
+  #   Request environment, as defined by the Rack spec.
+  # @return [Array<Fixnum, Hash, Array>]
+  #   An empty successful response.
+  # @see http://www.rubydoc.info/github/rack/rack/master/file/SPEC
+  #   Rack spec
+  def call(request)
+    @validators.find do |v|
+      v.validate(request).failed?
+    end
+    [200, {}, []]
+  end
+end

data/lib/webtrap/shared/validators/equivalent_xml_content_validator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "equivalent-xml"
+
+# @api private
+# Validator for asserting a request was sent with an equivalent XML payload.
+#
+# @see https://github.com/mbklein/equivalent-xml
+#   equivalent-xml gem
+class WebTrap::Shared::Validators::EquivalentXmlContentValidator
+  # Instantiate a new validator with the provided payload.
+  #
+  # @param xml [String]
+  #   The XML payload requests will be compared against.
+  def initialize(xml)
+    @failed = true
+    @xml = xml
+  end
+
+  # Whether no request with an equivalent payload was validated.
+  #
+  # @return [Boolean]
+  def failed?
+    @failed
+  end
+
+  # The message to be used if no request is validated with an equivalent
+  # payload.
+  #
+  # @return [String]
+  def failure_message
+    "expected block to send an HTTP request with XML body, but payload was not equivalent"
+  end
+
+  # Validate if the request has an equivalent XML payload.
+  #
+  # @param request [Hash]
+  #   Request environment passed by {WebTrap::Shared::RackApp#call}.
+  # @return [EquivalentXmlContentValidator]
+  #   This validator instance.
+  def validate(request)
+    @failed = EquivalentXml.equivalent?(xml, request["rack.input"].string)
+    self
+  end
+
+  private
+
+  attr_reader :xml
+end

data/lib/webtrap/shared/validators/request_sent_validator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# @api private
+# Validator for asserting whether a request was sent.
+class WebTrap::Shared::Validators::RequestSentValidator
+  # Initialize a new validator.
+  def initialize
+    @failed = true
+  end
+
+  # Whether no request was validated.
+  #
+  # @return [Boolean]
+  def failed?
+    @failed
+  end
+
+  # The message to be used if no request is validated.
+  #
+  # @return [String]
+  def failure_message
+    "expected block to send an HTTP request, but nothing was sent out"
+  end
+
+  # Validate a request.
+  #
+  # Since validators are run against intercepted requests this validator will
+  # succeed for any request.
+  #
+  # @return [RequestSentValidator]
+  #   This validator instance.
+  def validate(_)
+    @failed = false
+    self
+  end
+end

data/lib/webtrap/shared/validators.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module WebTrap
+  module Shared
+    # @api private
+    # Validators used to assert constraints over the intercepted HTTP requests.
+    module Validators
+      autoload :EquivalentXmlContentValidator, "webtrap/shared/validators/equivalent_xml_content_validator"
+      autoload :RequestSentValidator, "webtrap/shared/validators/request_sent_validator"
+    end
+  end
+end

data/lib/webtrap/shared.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "webtrap/shared/validators"
+
+module WebTrap
+  # @api private
+  # Shared components used by all implementations for specific testing tools.
+  module Shared
+    autoload :RackApp, "webtrap/shared/rack_app"
+  end
+end

data/lib/webtrap/version.rb

@@ -2,5 +2,5 @@
 
 module WebTrap
   # Current version of the WebTrap gem.
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/webtrap.gemspec

@@ -36,12 +36,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "equivalent-xml", "~> 0.6.0"
+  spec.add_dependency "rack", "~> 2.0"
   spec.add_dependency "rspec", "~> 3.0"
-  spec.add_dependency "sinatra", "~> 1.0"
   spec.add_dependency "webmock", "~> 2.0"
 
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "cucumber", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry-remote", "~> 0.1.8"
+  spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rubocop", "~> 0.47.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webtrap
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Pedro Costa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-26 00:00:00.000000000 Z
+date: 2017-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -149,8 +163,11 @@ files:
 - lib/webtrap/rspec.rb
 - lib/webtrap/rspec/matchers.rb
 - lib/webtrap/rspec/matchers/send_request.rb
-- lib/webtrap/rspec/matchers/send_request_with_xml.rb
-- lib/webtrap/server.rb
+- lib/webtrap/shared.rb
+- lib/webtrap/shared/rack_app.rb
+- lib/webtrap/shared/validators.rb
+- lib/webtrap/shared/validators/equivalent_xml_content_validator.rb
+- lib/webtrap/shared/validators/request_sent_validator.rb
 - lib/webtrap/version.rb
 - webtrap.gemspec
 homepage: https://github.com/pfac/webtrap

data/lib/webtrap/rspec/matchers/send_request_with_xml.rb

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-require "equivalent-xml"
-require "webmock/rspec"
-
-module WebTrap
-  module RSpec
-    module Matchers
-      # @api private
-      # Used to specify the XML payload of the request.
-      class SendRequestWithXml < SendRequest
-        # Reference to be compared with the payload of outgoing XML requests.
-        attr_reader :expected_payload
-
-        # Allows the parameterization of the matcher with the reference payload.
-        # @param expected_payload []
-        #   Reference to be compared with the payload of outgoing XML requests.
-        def initialize(expected_payload)
-          @expected_payload = expected_payload
-        end
-
-        # @api private
-        # Checks if the provided Proc sends a request with an XML payload
-        # equivalent to the expected reference.
-        # @param transmission_proc [Proc]
-        #   The proc that should send a valid request.
-        # @return
-        #   Whether a request was sent with an equivalent XML payload.
-        # @see {RSpec::Matchers::MatcherProtocol#matches?}
-        def matches?(transmission_proc)
-          perform_transmission(transmission_proc)
-          request_sent? && valid_payload?
-        end
-
-        # @api private
-        # Message to be shown if the expectation fails to pass.
-        # @return [String]
-        # @see {RSpec::Matchers::MatcherProtocol#failure_message}
-        def failure_message
-          return super unless request_sent?
-
-          "expected block to send an HTTP request with XML body, but payload was not equivalent"
-        end
-
-        # @api private
-        # Allows the matcher to be used with block expectations.
-        # @return [TrueClass]
-        # @see {RSpec::Matchers::MatcherProtocol#supports_block_expectations?}
-        def supports_block_expectations?
-          true
-        end
-
-        private
-
-        def perform_transmission(transmission_proc)
-          WebMock.disable_net_connect!
-          WebMock::API.stub_request(:post, /.*/).to_rack(server)
-
-          transmission_proc.call
-
-          WebMock.allow_net_connect!
-        end
-
-        def server
-          expected_payload = self.expected_payload
-
-          @_server ||= ::Class.new(::WebTrap::Server) do
-            @payload_was_valid = false
-            @request_received = false
-
-            post "*" do
-              actual_payload = request.body.string
-
-              self.class.request_received = true
-              self.class.payload_was_valid = EquivalentXml.equivalent?(actual_payload, expected_payload)
-            end
-          end
-        end
-
-        def request_sent?
-          super || server.request_received?
-        end
-
-        def valid_payload?
-          server.payload_was_valid?
-        end
-      end
-    end
-  end
-end

data/lib/webtrap/server.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require "sinatra"
-
-module WebTrap
-  # Base class for creating fake web application to capture outgoing web
-  # requests and assert on them.
-  #
-  # Descendants of this class are in charge of setting the required rules to
-  # correctly intercept the target requests.
-  #
-  # Currently it is only used by SendRequestWithXml.
-  class Server < Sinatra::Base
-    @payload_was_valid = false
-    @request_received = false
-
-    class << self
-      # Set whether the payload met the matcher constraints.
-      # @param value [Boolean]
-      attr_writer :payload_was_valid
-
-      # Set whether a request was received at all.
-      # @param value [Boolean]
-      attr_writer :request_received
-    end
-
-    # Whether the payload met the matcher constraints.
-    # @return [Boolean] `false` by default.
-    def self.payload_was_valid?
-      @payload_was_valid
-    end
-
-    # Whether a request was received at all.
-    # @return [Boolean] `false` by default.
-    def self.request_received?
-      @request_received
-    end
-  end
-end