ultra-safe-box 0.0.1

data/webmock-3.26.2/lib/webmock/request_pattern.rb

@@ -0,0 +1,428 @@
+# frozen_string_literal: true
+
+module WebMock
+
+  module RSpecMatcherDetector
+    def rSpecHashIncludingMatcher?(matcher)
+      matcher.class.name =~ /R?Spec::Mocks::ArgumentMatchers::HashIncludingMatcher/
+    end
+
+    def rSpecHashExcludingMatcher?(matcher)
+      matcher.class.name =~ /R?Spec::Mocks::ArgumentMatchers::HashExcludingMatcher/
+    end
+  end
+
+  class RequestPattern
+
+    attr_reader :method_pattern, :uri_pattern, :body_pattern, :headers_pattern
+
+    def initialize(method, uri, options = {})
+      @method_pattern  = MethodPattern.new(method)
+      @uri_pattern     = create_uri_pattern(uri)
+      @body_pattern    = nil
+      @headers_pattern = nil
+      @with_block      = nil
+      assign_options(options)
+    end
+
+    def with(options = {}, &block)
+      raise ArgumentError.new('#with method invoked with no arguments. Either options hash or block must be specified. Created a block with do..end? Try creating it with curly braces {} instead.') if options.empty? && !block_given?
+      assign_options(options)
+      @with_block = block
+      self
+    end
+
+    def matches?(request_signature)
+      content_type = request_signature.headers['Content-Type'] if request_signature.headers
+      content_type = content_type.split(';').first if content_type
+      @method_pattern.matches?(request_signature.method) &&
+        @uri_pattern.matches?(request_signature.uri) &&
+        (@body_pattern.nil? || @body_pattern.matches?(request_signature.body, content_type || "")) &&
+        (@headers_pattern.nil? || @headers_pattern.matches?(request_signature.headers)) &&
+        (@with_block.nil? || @with_block.call(request_signature))
+    end
+
+    def to_s
+      string = "#{@method_pattern.to_s.upcase}".dup
+      string << " #{@uri_pattern.to_s}"
+      string << " with body #{@body_pattern.to_s}" if @body_pattern
+      string << " with headers #{@headers_pattern.to_s}" if @headers_pattern
+      string << " with given block" if @with_block
+      string
+    end
+
+    private
+
+
+    def assign_options(options)
+      options = WebMock::Util::HashKeysStringifier.stringify_keys!(options, deep: true)
+      HashValidator.new(options).validate_keys('body', 'headers', 'query', 'basic_auth')
+      set_basic_auth_as_headers!(options)
+      @body_pattern = BodyPattern.new(options['body']) if options.has_key?('body')
+      @headers_pattern = HeadersPattern.new(options['headers']) if options.has_key?('headers')
+      @uri_pattern.add_query_params(options['query']) if options.has_key?('query')
+    end
+
+    def set_basic_auth_as_headers!(options)
+      if basic_auth = options.delete('basic_auth')
+        validate_basic_auth!(basic_auth)
+        options['headers'] ||= {}
+        options['headers']['Authorization'] = WebMock::Util::Headers.basic_auth_header(basic_auth[0],basic_auth[1])
+      end
+    end
+
+    def validate_basic_auth!(basic_auth)
+      if !basic_auth.is_a?(Array) || basic_auth.map{|e| e.is_a?(String)}.uniq != [true]
+        raise "The basic_auth option value should be an array which contains 2 strings: username and password"
+      end
+    end
+
+    def create_uri_pattern(uri)
+      if uri.is_a?(Regexp)
+        URIRegexpPattern.new(uri)
+      elsif uri.is_a?(Addressable::Template)
+        URIAddressablePattern.new(uri)
+      elsif uri.respond_to?(:call)
+        URICallablePattern.new(uri)
+      elsif uri.is_a?(::URI::Generic)
+        URIStringPattern.new(uri.to_s)
+      elsif uri.respond_to?(:to_str)
+        URIStringPattern.new(uri.to_str)
+      else
+        raise ArgumentError.new("URI should be a String, Regexp, Addressable::Template, a callable object, or respond to #to_str. Got: #{uri.class}")
+      end
+    end
+  end
+
+
+  class MethodPattern
+    def initialize(pattern)
+      @pattern = pattern
+    end
+
+    def matches?(method)
+      @pattern == method || @pattern == :any
+    end
+
+    def to_s
+      @pattern.to_s
+    end
+  end
+
+
+  class URIPattern
+    include RSpecMatcherDetector
+
+    def initialize(pattern)
+      @pattern = if pattern.is_a?(Addressable::URI) \
+                    || pattern.is_a?(Addressable::Template)
+        pattern
+      elsif pattern.respond_to?(:call)
+        pattern
+      else
+        WebMock::Util::URI.normalize_uri(pattern)
+      end
+      @query_params = nil
+    end
+
+    def add_query_params(query_params)
+      @query_params = if query_params.is_a?(Hash)
+        query_params
+      elsif query_params.is_a?(WebMock::Matchers::HashIncludingMatcher) \
+              || query_params.is_a?(WebMock::Matchers::HashExcludingMatcher)
+        query_params
+      elsif rSpecHashIncludingMatcher?(query_params)
+        WebMock::Matchers::HashIncludingMatcher.from_rspec_matcher(query_params)
+      elsif rSpecHashExcludingMatcher?(query_params)
+        WebMock::Matchers::HashExcludingMatcher.from_rspec_matcher(query_params)
+      else
+        WebMock::Util::QueryMapper.query_to_values(query_params, notation: Config.instance.query_values_notation)
+      end
+    end
+
+    def matches?(uri)
+      pattern_matches?(uri) && query_params_matches?(uri)
+    end
+
+    def to_s
+      str = pattern_inspect
+      str += " with query params #{@query_params.inspect}" if @query_params
+      str
+    end
+
+    private
+
+    def pattern_inspect
+      @pattern.inspect
+    end
+
+    def query_params_matches?(uri)
+      @query_params.nil? || @query_params == WebMock::Util::QueryMapper.query_to_values(uri.query, notation: Config.instance.query_values_notation)
+    end
+  end
+
+  class URICallablePattern  < URIPattern
+    private
+
+    def pattern_matches?(uri)
+      @pattern.call(uri)
+    end
+  end
+
+  class URIRegexpPattern  < URIPattern
+    private
+
+    def pattern_matches?(uri)
+      WebMock::Util::URI.variations_of_uri_as_strings(uri).any? { |u| u.match(@pattern) }
+    end
+  end
+
+  class URIAddressablePattern  < URIPattern
+    def add_query_params(query_params)
+      @@add_query_params_warned ||= false
+      if not @@add_query_params_warned
+        @@add_query_params_warned = true
+        warn "WebMock warning: ignoring query params in RFC 6570 template and checking them with WebMock"
+      end
+      super(query_params)
+    end
+
+    private
+
+    def pattern_matches?(uri)
+      if @query_params.nil?
+        # Let Addressable check the whole URI
+        matches_with_variations?(uri)
+      else
+        # WebMock checks the query, Addressable checks everything else
+        matches_with_variations?(uri.omit(:query))
+      end
+    end
+
+    def pattern_inspect
+      @pattern.pattern.inspect
+    end
+
+    def matches_with_variations?(uri)
+      template =
+        begin
+          Addressable::Template.new(WebMock::Util::URI.heuristic_parse(@pattern.pattern))
+        rescue Addressable::URI::InvalidURIError
+          Addressable::Template.new(@pattern.pattern)
+        end
+      WebMock::Util::URI.variations_of_uri_as_strings(uri).any? { |u|
+        template_matches_uri?(template, u)
+      }
+    end
+
+    def template_matches_uri?(template, uri)
+      template.match(uri)
+    rescue Addressable::URI::InvalidURIError
+      false
+    end
+  end
+
+  class URIStringPattern < URIPattern
+    def add_query_params(query_params)
+      super
+      if @query_params.is_a?(Hash) || @query_params.is_a?(String)
+        query_hash = (WebMock::Util::QueryMapper.query_to_values(@pattern.query, notation: Config.instance.query_values_notation) || {}).merge(@query_params)
+        @pattern.query = WebMock::Util::QueryMapper.values_to_query(query_hash, notation: WebMock::Config.instance.query_values_notation)
+        @query_params = nil
+      end
+    end
+
+    private
+
+    def pattern_matches?(uri)
+      if @pattern.is_a?(Addressable::URI)
+        if @query_params
+          uri.omit(:query) === @pattern
+        else
+          uri === @pattern
+        end
+      else
+        false
+      end
+    end
+
+    def pattern_inspect
+      WebMock::Util::URI.strip_default_port_from_uri_string(@pattern.to_s)
+    end
+  end
+
+
+  class BodyPattern
+    include RSpecMatcherDetector
+
+    BODY_FORMATS = {
+      'text/xml'               => :xml,
+      'application/xml'        => :xml,
+      'application/json'       => :json,
+      'text/json'              => :json,
+      'application/javascript' => :json,
+      'text/javascript'        => :json,
+      'text/html'              => :html,
+      'application/x-yaml'     => :yaml,
+      'text/yaml'              => :yaml,
+      'text/plain'             => :plain
+    }
+
+    attr_reader :pattern
+
+    def initialize(pattern)
+      @pattern = if pattern.is_a?(Hash)
+        normalize_hash(pattern)
+      elsif rSpecHashIncludingMatcher?(pattern)
+        WebMock::Matchers::HashIncludingMatcher.from_rspec_matcher(pattern)
+      else
+        pattern
+      end
+    end
+
+    def matches?(body, content_type = "")
+      assert_non_multipart_body(content_type)
+
+      if (@pattern).is_a?(Hash)
+        return true if @pattern.empty?
+        matching_body_hashes?(body_as_hash(body, content_type), @pattern, content_type)
+      elsif (@pattern).is_a?(Array)
+        matching_body_array?(body_as_hash(body, content_type), @pattern, content_type)
+      elsif (@pattern).is_a?(WebMock::Matchers::HashArgumentMatcher)
+        @pattern == body_as_hash(body, content_type)
+      else
+        empty_string?(@pattern) && empty_string?(body) ||
+          @pattern == body ||
+          @pattern === body
+      end
+    end
+
+    def to_s
+      @pattern.inspect
+    end
+
+    private
+
+    def body_as_hash(body, content_type)
+      case body_format(content_type)
+      when :json then
+        WebMock::Util::Parsers::JSON.parse(body)
+      when :xml then
+        WebMock::Util::Parsers::XML.parse(body)
+      else
+        WebMock::Util::QueryMapper.query_to_values(body, notation: Config.instance.query_values_notation)
+      end
+    rescue WebMock::Util::Parsers::ParseError
+      nil
+    end
+
+    def body_format(content_type)
+      normalized_content_type = content_type.sub(/\A(application\/)[a-zA-Z0-9.-]+\+(json|xml)\Z/,'\1\2')
+      BODY_FORMATS[normalized_content_type]
+    end
+
+    def assert_non_multipart_body(content_type)
+      if content_type =~ %r{^multipart/form-data}
+        raise ArgumentError.new("WebMock does not support matching body for multipart/form-data requests yet :(")
+      end
+    end
+
+    # Compare two hashes for equality
+    #
+    # For two hashes to match they must have the same length and all
+    # values must match when compared using `#===`.
+    #
+    # The following hashes are examples of matches:
+    #
+    #     {a: /\d+/} and {a: '123'}
+    #
+    #     {a: '123'} and {a: '123'}
+    #
+    #     {a: {b: /\d+/}} and {a: {b: '123'}}
+    #
+    #     {a: {b: 'wow'}} and {a: {b: 'wow'}}
+    #
+    # @param [Hash] query_parameters typically the result of parsing
+    #   JSON, XML or URL encoded parameters.
+    #
+    # @param [Hash] pattern which contains keys with a string, hash or
+    #   regular expression value to use for comparison.
+    #
+    # @return [Boolean] true if the paramaters match the comparison
+    #   hash, false if not.
+    def matching_body_hashes?(query_parameters, pattern, content_type)
+      return false unless query_parameters.is_a?(Hash)
+      return false unless query_parameters.keys.sort == pattern.keys.sort
+
+      query_parameters.all? do |key, actual|
+        expected = pattern[key]
+        matching_values(actual, expected, content_type)
+      end
+    end
+
+    def matching_body_array?(query_parameters, pattern, content_type)
+      return false unless query_parameters.is_a?(Array)
+      return false unless query_parameters.length == pattern.length
+
+      query_parameters.each_with_index do |actual, index|
+        expected = pattern[index]
+        return false unless matching_values(actual, expected, content_type)
+      end
+
+      true
+    end
+
+    def matching_values(actual, expected, content_type)
+      return matching_body_hashes?(actual, expected, content_type) if actual.is_a?(Hash) && expected.is_a?(Hash)
+      return matching_body_array?(actual, expected, content_type) if actual.is_a?(Array) && expected.is_a?(Array)
+
+      expected = WebMock::Util::ValuesStringifier.stringify_values(expected) if url_encoded_body?(content_type)
+      expected === actual
+    end
+
+    def empty_string?(string)
+      string.nil? || string == ""
+    end
+
+    def normalize_hash(hash)
+      Hash[WebMock::Util::HashKeysStringifier.stringify_keys!(hash, deep: true).sort]
+    end
+
+    def url_encoded_body?(content_type)
+      content_type =~ %r{^application/x-www-form-urlencoded}
+    end
+  end
+
+  class HeadersPattern
+    def initialize(pattern)
+      @pattern = WebMock::Util::Headers.normalize_headers(pattern) || {}
+    end
+
+    def matches?(headers)
+      if empty_headers?(@pattern)
+        empty_headers?(headers)
+      else
+        return false if empty_headers?(headers)
+        @pattern.each do |key, value|
+          return false unless headers.has_key?(key) && value === headers[key]
+        end
+        true
+      end
+    end
+
+    def to_s
+      WebMock::Util::Headers.sorted_headers_string(@pattern)
+    end
+
+    def pp_to_s
+      WebMock::Util::Headers.pp_headers_string(@pattern)
+    end
+
+    private
+
+    def empty_headers?(headers)
+      headers.nil? || headers == {}
+    end
+  end
+
+end

data/webmock-3.26.2/lib/webmock/request_registry.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module WebMock
+
+  class RequestRegistry
+    include Singleton
+
+    attr_accessor :requested_signatures
+
+    def initialize
+      reset!
+    end
+
+    def reset!
+      self.requested_signatures = Util::HashCounter.new
+    end
+
+    def times_executed(request_pattern)
+      self.requested_signatures.select do |request_signature|
+        request_pattern.matches?(request_signature)
+      end.inject(0) { |sum, (_, times_executed)| sum + times_executed }
+    end
+
+    def to_s
+      if requested_signatures.hash.empty?
+        "No requests were made."
+      else
+        text = "".dup
+        self.requested_signatures.each do |request_signature, times_executed|
+          text << "#{request_signature} was made #{times_executed} time#{times_executed == 1 ? '' : 's' }\n"
+        end
+        text
+      end
+    end
+
+  end
+end

data/webmock-3.26.2/lib/webmock/request_signature.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module WebMock
+
+  class RequestSignature
+
+    attr_accessor :method, :uri, :body
+    attr_reader :headers
+
+    def initialize(method, uri, options = {})
+      self.method = method.to_sym
+      self.uri = uri.is_a?(Addressable::URI) ? uri : WebMock::Util::URI.normalize_uri(uri)
+      assign_options(options)
+    end
+
+    def to_s
+      string = "#{self.method.to_s.upcase}".dup
+      string << " #{WebMock::Util::URI.strip_default_port_from_uri_string(self.uri.to_s)}"
+      string << " with body '#{body.to_s}'" if body && body.to_s != ''
+      if headers && !headers.empty?
+        string << " with headers #{WebMock::Util::Headers.sorted_headers_string(headers)}"
+      end
+      string
+    end
+
+    def headers=(headers)
+      @headers = WebMock::Util::Headers.normalize_headers(headers)
+    end
+
+    def hash
+      self.to_s.hash
+    end
+
+    def eql?(other)
+      self.to_s == other.to_s
+    end
+    alias == eql?
+
+    def url_encoded?
+      !!(headers&.fetch('Content-Type', nil)&.start_with?('application/x-www-form-urlencoded'))
+    end
+
+    def json_headers?
+      !!(headers&.fetch('Content-Type', nil)&.start_with?('application/json'))
+    end
+
+    private
+
+    def assign_options(options)
+      self.body = options[:body] if options.has_key?(:body)
+      self.headers = options[:headers] if options.has_key?(:headers)
+    end
+
+  end
+
+end

data/webmock-3.26.2/lib/webmock/request_signature_snippet.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "pp"
+
+module WebMock
+  class RequestSignatureSnippet
+
+    attr_reader :request_signature, :request_stub
+
+    def initialize(request_signature)
+      @request_signature = request_signature
+      @request_stub = RequestStub.from_request_signature(request_signature)
+    end
+
+    def stubbing_instructions
+      return unless WebMock.show_stubbing_instructions?
+
+      "You can stub this request with the following snippet:\n\n" +
+        WebMock::StubRequestSnippet.new(request_stub).to_s
+    end
+
+    def request_stubs
+      return if WebMock::StubRegistry.instance.request_stubs.empty?
+
+      text = "registered request stubs:\n".dup
+      WebMock::StubRegistry.instance.request_stubs.each do |stub|
+        text << "\n#{WebMock::StubRequestSnippet.new(stub).to_s(false)}"
+        add_body_diff(stub, text) if WebMock.show_body_diff?
+      end
+      text
+    end
+
+    private
+
+    def add_body_diff(stub, text)
+      body_diff_str = signature_stub_body_diff(stub)
+      text << "\n\n#{body_diff_str}" unless body_diff_str.empty?
+    end
+
+    def signature_stub_body_diff(stub)
+      diff = RequestBodyDiff.new(request_signature, stub).body_diff
+      diff.empty? ? "" : "Body diff:\n #{pretty_print_to_string(diff)}"
+    end
+
+    def request_params
+      @request_params ||=
+        if request_signature.json_headers?
+          JSON.parse(request_signature.body)
+        else
+          ""
+        end
+    end
+
+    def pretty_print_to_string(string_to_print)
+      StringIO.open("".dup) do |stream|
+        PP.pp(string_to_print, stream)
+        stream.rewind
+        stream.read
+      end
+    end
+
+  end
+end