cotweet-fakeweb 1.3.0

data/fakeweb.gemspec

@@ -0,0 +1,126 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cotweet-fakeweb}
+  s.version = "1.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Kampmeier", "Blaine Cook"]
+  s.date = %q{2010-08-22}
+  s.description = %q{FakeWeb is a helper for faking web requests in Ruby. It works at a global level, without modifying code or writing extensive stubs.}
+  s.email = ["chris@kampers.net", "romeda@gmail.com"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".autotest",
+     ".gitignore",
+     "CHANGELOG",
+     "LICENSE.txt",
+     "README.rdoc",
+     "Rakefile",
+     "fakeweb.gemspec",
+     "lib/fake_web.rb",
+     "lib/fake_web/ext/net_http.rb",
+     "lib/fake_web/registry.rb",
+     "lib/fake_web/responder.rb",
+     "lib/fake_web/response.rb",
+     "lib/fake_web/stub_socket.rb",
+     "lib/fake_web/utility.rb",
+     "lib/fakeweb.rb",
+     "test/fixtures/google_response_from_curl",
+     "test/fixtures/google_response_with_transfer_encoding",
+     "test/fixtures/google_response_without_transfer_encoding",
+     "test/fixtures/test_example.txt",
+     "test/fixtures/test_txt_file",
+     "test/test_allow_net_connect.rb",
+     "test/test_deprecations.rb",
+     "test/test_fake_authentication.rb",
+     "test/test_fake_web.rb",
+     "test/test_fake_web_open_uri.rb",
+     "test/test_helper.rb",
+     "test/test_last_request.rb",
+     "test/test_missing_open_uri.rb",
+     "test/test_missing_pathname.rb",
+     "test/test_other_net_http_libraries.rb",
+     "test/test_precedence.rb",
+     "test/test_query_string.rb",
+     "test/test_regexes.rb",
+     "test/test_response_headers.rb",
+     "test/test_trailing_slashes.rb",
+     "test/test_utility.rb",
+     "test/vendor/right_http_connection-1.2.4/History.txt",
+     "test/vendor/right_http_connection-1.2.4/Manifest.txt",
+     "test/vendor/right_http_connection-1.2.4/README.txt",
+     "test/vendor/right_http_connection-1.2.4/Rakefile",
+     "test/vendor/right_http_connection-1.2.4/lib/net_fix.rb",
+     "test/vendor/right_http_connection-1.2.4/lib/right_http_connection.rb",
+     "test/vendor/right_http_connection-1.2.4/setup.rb",
+     "test/vendor/samuel-0.2.1/.document",
+     "test/vendor/samuel-0.2.1/.gitignore",
+     "test/vendor/samuel-0.2.1/LICENSE",
+     "test/vendor/samuel-0.2.1/README.rdoc",
+     "test/vendor/samuel-0.2.1/Rakefile",
+     "test/vendor/samuel-0.2.1/VERSION",
+     "test/vendor/samuel-0.2.1/lib/samuel.rb",
+     "test/vendor/samuel-0.2.1/lib/samuel/net_http.rb",
+     "test/vendor/samuel-0.2.1/lib/samuel/request.rb",
+     "test/vendor/samuel-0.2.1/samuel.gemspec",
+     "test/vendor/samuel-0.2.1/test/request_test.rb",
+     "test/vendor/samuel-0.2.1/test/samuel_test.rb",
+     "test/vendor/samuel-0.2.1/test/test_helper.rb",
+     "test/vendor/samuel-0.2.1/test/thread_test.rb"
+  ]
+  s.homepage = %q{http://github.com/chrisk/fakeweb}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{fakeweb}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A tool for faking responses to HTTP requests}
+  s.test_files = [
+    "test/test_allow_net_connect.rb",
+     "test/test_deprecations.rb",
+     "test/test_fake_authentication.rb",
+     "test/test_fake_web.rb",
+     "test/test_fake_web_open_uri.rb",
+     "test/test_helper.rb",
+     "test/test_last_request.rb",
+     "test/test_missing_open_uri.rb",
+     "test/test_missing_pathname.rb",
+     "test/test_other_net_http_libraries.rb",
+     "test/test_precedence.rb",
+     "test/test_query_string.rb",
+     "test/test_regexes.rb",
+     "test/test_response_headers.rb",
+     "test/test_trailing_slashes.rb",
+     "test/test_utility.rb",
+     "test/vendor/right_http_connection-1.2.4/lib/net_fix.rb",
+     "test/vendor/right_http_connection-1.2.4/lib/right_http_connection.rb",
+     "test/vendor/right_http_connection-1.2.4/setup.rb",
+     "test/vendor/samuel-0.2.1/lib/samuel/net_http.rb",
+     "test/vendor/samuel-0.2.1/lib/samuel/request.rb",
+     "test/vendor/samuel-0.2.1/lib/samuel.rb",
+     "test/vendor/samuel-0.2.1/test/request_test.rb",
+     "test/vendor/samuel-0.2.1/test/samuel_test.rb",
+     "test/vendor/samuel-0.2.1/test/test_helper.rb",
+     "test/vendor/samuel-0.2.1/test/thread_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<mocha>, [">= 0.9.5"])
+    else
+      s.add_dependency(%q<mocha>, [">= 0.9.5"])
+    end
+  else
+    s.add_dependency(%q<mocha>, [">= 0.9.5"])
+  end
+end
+

data/lib/fake_web.rb

@@ -0,0 +1,215 @@
+require 'singleton'
+
+require 'fake_web/ext/net_http'
+require 'fake_web/registry'
+require 'fake_web/response'
+require 'fake_web/responder'
+require 'fake_web/stub_socket'
+require 'fake_web/utility'
+
+FakeWeb::Utility.record_loaded_net_http_replacement_libs
+FakeWeb::Utility.puts_warning_for_net_http_around_advice_libs_if_needed
+
+module FakeWeb
+
+  # Returns the version string for the copy of FakeWeb you have loaded.
+  VERSION = '1.3.0'
+
+  # Resets the FakeWeb Registry. This will force all subsequent web requests to
+  # behave as real requests.
+  def self.clean_registry
+    Registry.instance.clean_registry
+  end
+
+  # Enables or disables real HTTP connections for requests that don't match
+  # registered URIs.
+  #
+  # If you set <tt>FakeWeb.allow_net_connect = false</tt> and subsequently try
+  # to make a request to a URI you haven't registered with #register_uri, a
+  # NetConnectNotAllowedError will be raised. This is handy when you want to
+  # make sure your tests are self-contained, or want to catch the scenario
+  # when a URI is changed in implementation code without a corresponding test
+  # change.
+  #
+  # When <tt>FakeWeb.allow_net_connect = true</tt> (the default), requests to
+  # URIs not stubbed with FakeWeb are passed through to Net::HTTP.
+  #
+  # If you assign a +String+, +URI+, or +Regexp+ object, unstubbed requests
+  # will be allowed if they match that value. This is useful when you want to
+  # allow access to a local server for integration testing, while still
+  # preventing your tests from using the internet.
+  def self.allow_net_connect=(allowed)
+    case allowed
+    when String, URI, Regexp
+      @allow_all_connections = false
+      Registry.instance.register_passthrough_uri(allowed)
+    else
+      @allow_all_connections = allowed
+      Registry.instance.remove_passthrough_uri
+    end
+  end
+
+  # Enable pass-through to Net::HTTP by default.
+  self.allow_net_connect = true
+
+  # Returns +true+ if requests to URIs not registered with FakeWeb are passed
+  # through to Net::HTTP for normal processing (the default). Returns +false+
+  # if an exception is raised for these requests.
+  #
+  # If you've assigned a +String+, +URI+, or +Regexp+ to
+  # <tt>FakeWeb.allow_net_connect=</tt>, you must supply a URI to check
+  # against that filter. Otherwise, an ArgumentError will be raised.
+  def self.allow_net_connect?(uri = nil)
+    if Registry.instance.passthrough_uri_map.any?
+      raise ArgumentError, "You must supply a URI to test" if uri.nil?
+      Registry.instance.passthrough_uri_matches?(uri)
+    else
+      @allow_all_connections
+    end
+  end
+
+  # This exception is raised if you set <tt>FakeWeb.allow_net_connect =
+  # false</tt> and subsequently try to make a request to a URI you haven't
+  # stubbed.
+  class NetConnectNotAllowedError < StandardError; end;
+
+  # This exception is raised if a Net::HTTP request matches more than one of
+  # the stubs you've registered. To fix the problem, remove a duplicate
+  # registration or disambiguate any regular expressions by making them more
+  # specific.
+  class MultipleMatchingURIsError < StandardError; end;
+
+  # call-seq:
+  #   FakeWeb.register_uri(method, uri, options)
+  #
+  # Register requests using the HTTP method specified by the symbol +method+
+  # for +uri+ to be handled according to +options+. If you specify the method
+  # <tt>:any</tt>, the response will be reigstered for any request for +uri+.
+  # +uri+ can be a +String+, +URI+, or +Regexp+ object. +options+ must be either
+  # a +Hash+ or an +Array+ of +Hashes+ (see below), which must contain one of
+  # these two keys:
+  #
+  # <tt>:body</tt>::
+  #   A string which is used as the body of the response. If the string refers
+  #   to a valid filesystem path, the contents of that file will be read and used
+  #   as the body of the response instead. (This used to be two options,
+  #   <tt>:string</tt> and <tt>:file</tt>, respectively. These are now deprecated.)
+  # <tt>:response</tt>:: 
+  #   Either a <tt>Net::HTTPResponse</tt>, an +IO+, or a +String+ which is used
+  #   as the full response for the request.
+  # 
+  #   The easier way by far is to pass the <tt>:response</tt> option to
+  #   +register_uri+ as a +String+ or an (open for reads) +IO+ object which
+  #   will be used as the complete HTTP response, including headers and body.
+  #   If the string points to a readable file, this file will be used as the
+  #   content for the request.
+  # 
+  #   To obtain a complete response document, you can use the +curl+ command,
+  #   like so:
+  #   
+  #     curl -i http://example.com > response_from_example.com
+  #
+  #   which can then be used in your test environment like so:
+  #
+  #     FakeWeb.register_uri(:get, "http://example.com", :response => "response_from_example.com")
+  #
+  #   See the <tt>Net::HTTPResponse</tt>
+  #   documentation[http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/classes/Net/HTTPResponse.html]
+  #   for more information on creating custom response objects.
+  # 
+  # +options+ may also be an +Array+ containing a list of the above-described
+  # +Hash+. In this case, FakeWeb will rotate through each response. You can
+  # optionally repeat a response more than once before rotating:
+  #
+  # <tt>:times</tt>::
+  #   The number of times this response will be used before moving on to the
+  #   next one. The last response will be repeated indefinitely, regardless of
+  #   its <tt>:times</tt> parameter.
+  #
+  # Two optional arguments are also accepted:
+  #
+  # <tt>:status</tt>::
+  #   Passing <tt>:status</tt> as a two-value array will set the response code
+  #   and message. The defaults are <tt>200</tt> and <tt>OK</tt>, respectively.
+  #   Example:
+  #     FakeWeb.register_uri(:get, "http://example.com", :body => "Go away!", :status => [404, "Not Found"])
+  # <tt>:exception</tt>::
+  #   The argument passed via <tt>:exception</tt> will be raised when the
+  #   specified URL is requested. Any +Exception+ class is valid. Example:
+  #     FakeWeb.register_uri(:get, "http://example.com", :exception => Net::HTTPError)
+  #
+  # If you're using the <tt>:body</tt> response type, you can pass additional
+  # options to specify the HTTP headers to be used in the response. Example:
+  #
+  #   FakeWeb.register_uri(:get, "http://example.com/index.txt", :body => "Hello", :content_type => "text/plain")
+  #
+  # You can also pass an array of header values to include a header in the
+  # response more than once:
+  #
+  #   FakeWeb.register_uri(:get, "http://example.com", :set_cookie => ["name=value", "example=1"])
+  def self.register_uri(*args)
+    case args.length
+    when 3
+      Registry.instance.register_uri(*args)
+    when 2
+      print_missing_http_method_deprecation_warning(*args)
+      Registry.instance.register_uri(:any, *args)
+    else
+      raise ArgumentError.new("wrong number of arguments (#{args.length} for 3)")
+    end
+  end
+
+  # call-seq:
+  #   FakeWeb.response_for(method, uri)
+  #
+  # Returns the faked Net::HTTPResponse object associated with +method+ and +uri+.
+  def self.response_for(*args, &block) #:nodoc: :yields: response
+    case args.length
+    when 2
+      Registry.instance.response_for(*args, &block)
+    when 1
+      print_missing_http_method_deprecation_warning(*args)
+      Registry.instance.response_for(:any, *args, &block)
+    else
+      raise ArgumentError.new("wrong number of arguments (#{args.length} for 2)")
+    end
+  end
+
+  # call-seq:
+  #   FakeWeb.registered_uri?(method, uri)
+  #
+  # Returns true if a +method+ request for +uri+ is registered with FakeWeb.
+  # Specify a method of <tt>:any</tt> to check against all HTTP methods.
+  def self.registered_uri?(*args)
+    case args.length
+    when 2
+      Registry.instance.registered_uri?(*args)
+    when 1
+      print_missing_http_method_deprecation_warning(*args)
+      Registry.instance.registered_uri?(:any, *args)
+    else
+      raise ArgumentError.new("wrong number of arguments (#{args.length} for 2)")
+    end
+  end
+
+  # Returns the request object from the last request made via Net::HTTP.
+  def self.last_request
+    @last_request
+  end
+
+  def self.last_request=(request) #:nodoc:
+    @last_request = request
+  end
+
+  private
+
+  def self.print_missing_http_method_deprecation_warning(*args)
+    method = caller.first.match(/`(.*?)'/)[1]
+    new_args = args.map { |a| a.inspect }.unshift(":any")
+    new_args.last.gsub!(/^\{|\}$/, "").gsub!("=>", " => ") if args.last.is_a?(Hash)
+    $stderr.puts
+    $stderr.puts "Deprecation warning: FakeWeb requires an HTTP method argument (or use :any). Try this:"
+    $stderr.puts "  FakeWeb.#{method}(#{new_args.join(', ')})"
+    $stderr.puts "Called at #{caller[1]}"
+  end
+end

data/lib/fake_web/ext/net_http.rb

@@ -0,0 +1,72 @@
+require 'net/http'
+require 'net/https'
+require 'stringio'
+
+module Net  #:nodoc: all
+
+  class BufferedIO
+    def initialize_with_fakeweb(io, debug_output = nil)
+      @read_timeout = 60
+      @rbuf = ''
+      @debug_output = debug_output
+
+      @io = case io
+      when Socket, OpenSSL::SSL::SSLSocket, IO
+        io
+      when String
+        if !io.include?("\0") && File.exists?(io) && !File.directory?(io)
+          File.open(io, "r")
+        else
+          StringIO.new(io)
+        end
+      end
+      raise "Unable to create local socket" unless @io
+    end
+    alias_method :initialize_without_fakeweb, :initialize
+    alias_method :initialize, :initialize_with_fakeweb
+  end
+
+  class HTTP
+    class << self
+      def socket_type_with_fakeweb
+        FakeWeb::StubSocket
+      end
+      alias_method :socket_type_without_fakeweb, :socket_type
+      alias_method :socket_type, :socket_type_with_fakeweb
+    end
+
+    def request_with_fakeweb(request, body = nil, &block)
+      FakeWeb.last_request = request
+
+      uri = FakeWeb::Utility.request_uri_as_string(self, request)
+      method = request.method.downcase.to_sym
+
+      if FakeWeb.registered_uri?(method, uri)
+        @socket = Net::HTTP.socket_type.new
+        FakeWeb::Utility.produce_side_effects_of_net_http_request(request, body)
+        FakeWeb.response_for(method, uri, &block)
+      elsif FakeWeb.allow_net_connect?(uri)
+        connect_without_fakeweb
+        request_without_fakeweb(request, body, &block)
+      else
+        uri = FakeWeb::Utility.strip_default_port_from_uri(uri)
+        raise FakeWeb::NetConnectNotAllowedError,
+              "Real HTTP connections are disabled. Unregistered request: #{request.method} #{uri}"
+      end
+    end
+    alias_method :request_without_fakeweb, :request
+    alias_method :request, :request_with_fakeweb
+
+
+    def connect_with_fakeweb
+      unless @@alredy_checked_for_net_http_replacement_libs ||= false
+        FakeWeb::Utility.puts_warning_for_net_http_replacement_libs_if_needed
+        @@alredy_checked_for_net_http_replacement_libs = true
+      end
+      nil
+    end
+    alias_method :connect_without_fakeweb, :connect
+    alias_method :connect, :connect_with_fakeweb
+  end
+
+end

data/lib/fake_web/registry.rb

@@ -0,0 +1,127 @@
+module FakeWeb
+  class Registry #:nodoc:
+    include Singleton
+
+    attr_accessor :uri_map, :passthrough_uri_map
+
+    def initialize
+      clean_registry
+    end
+
+    def clean_registry
+      self.uri_map = Hash.new { |hash, key| hash[key] = {} }
+    end
+
+    def register_uri(method, uri, options)
+      uri_map[normalize_uri(uri)][method] = [*[options]].flatten.collect do |option|
+        FakeWeb::Responder.new(method, uri, option, option[:times])
+      end
+    end
+
+    def registered_uri?(method, uri)
+      !responders_for(method, uri).empty?
+    end
+
+    def response_for(method, uri, &block)
+      responders = responders_for(method, uri)
+      return nil if responders.empty?
+
+      next_responder = responders.last
+      responders.each do |responder|
+        if responder.times and responder.times > 0
+          responder.times -= 1
+          next_responder = responder
+          break
+        end
+      end
+
+      next_responder.response(&block)
+    end
+
+    def register_passthrough_uri(uri)
+      self.passthrough_uri_map = {normalize_uri(uri) => {:any => true}}
+    end
+
+    def remove_passthrough_uri
+      self.passthrough_uri_map = {}
+    end
+
+    def passthrough_uri_matches?(uri)
+      uri = normalize_uri(uri)
+      uri_map_matches(passthrough_uri_map, :any, uri, URI) ||
+      uri_map_matches(passthrough_uri_map, :any, uri, Regexp)
+    end
+
+    private
+
+    def responders_for(method, uri)
+      uri = normalize_uri(uri)
+
+      uri_map_matches(uri_map, method, uri, URI) ||
+      uri_map_matches(uri_map, :any,   uri, URI) ||
+      uri_map_matches(uri_map, method, uri, Regexp) ||
+      uri_map_matches(uri_map, :any,   uri, Regexp) ||
+      []
+    end
+
+    def uri_map_matches(map, method, uri, type_to_check = URI)
+      uris_to_check = variations_of_uri_as_strings(uri)
+
+      matches = map.select { |registered_uri, method_hash|
+        registered_uri.is_a?(type_to_check) && method_hash.has_key?(method)
+      }.select { |registered_uri, method_hash|
+        if type_to_check == URI
+          uris_to_check.include?(registered_uri.to_s)
+        elsif type_to_check == Regexp
+          uris_to_check.any? { |u| u.match(registered_uri) }
+        end
+      }
+
+      if matches.size > 1
+        raise MultipleMatchingURIsError,
+          "More than one registered URI matched this request: #{method.to_s.upcase} #{uri}"
+      end
+
+      matches.map { |_, method_hash| method_hash[method] }.first
+    end
+
+
+    def variations_of_uri_as_strings(uri_object)
+      normalized_uri = normalize_uri(uri_object.dup)
+      normalized_uri_string = normalized_uri.to_s
+
+      variations = [normalized_uri_string]
+
+      # if the port is implied in the original, add a copy with an explicit port
+      if normalized_uri.default_port == normalized_uri.port
+        variations << normalized_uri_string.sub(
+                        /#{Regexp.escape(normalized_uri.request_uri)}$/,
+                        ":#{normalized_uri.port}#{normalized_uri.request_uri}")
+      end
+
+      variations
+    end
+
+    def normalize_uri(uri)
+      return uri if uri.is_a?(Regexp)
+      normalized_uri =
+        case uri
+        when URI then uri
+        when String
+          uri = 'http://' + uri unless uri.match('^https?://')
+          URI.parse(uri)
+        end
+      normalized_uri.query = sort_query_params(normalized_uri.query)
+      normalized_uri.normalize
+    end
+
+    def sort_query_params(query)
+      if query.nil? || query.empty?
+        nil
+      else
+        query.split('&').sort.join('&')
+      end
+    end
+
+  end
+end