typhoeus/typhoeus

View on GitHub
lib/typhoeus/request/block_connection.rb

Summary

Maintainability
A
0 mins
Test Coverage
module Typhoeus
  class Request

    # This module handles the blocked connection request mode on
    # the request side, where only stubbed requests
    # are allowed.
    # Connection blocking needs to be turned on:
    #   Typhoeus.configure do |config|
    #     config.block_connection = true
    #   end
    #
    # When trying to do real requests a NoStub error
    # is raised.
    #
    # @api private
    module BlockConnection

      # Overrides run in order to check before if block connection
      # is turned on. If thats the case a NoStub error is
      # raised.
      #
      # @example Run request.
      #   request.run
      #
      # @raise [Typhoeus::Errors::NoStub] If connection is blocked
      #   and no stub defined.
      def run
        if blocked?
          raise Typhoeus::Errors::NoStub.new(self)
        else
          super
        end
      end

      # Returns wether a request is blocked or not. Takes
      # request.block_connection and Typhoeus::Config.block_connection
      # into consideration.
      #
      # @example Blocked?
      #   request.blocked?
      #
      # @return [ Boolean ] True if blocked, false else.
      def blocked?
        if block_connection.nil?
          Typhoeus::Config.block_connection
        else
          block_connection
        end
      end
    end
  end
end