fcoury-fakeweb 1.2.0

data/Rakefile

@@ -0,0 +1,70 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+task :default => :test
+
+desc "Run All Tests"
+Rake::TestTask.new :test do |test|
+  test.test_files = ["test/**/*.rb"]
+  test.verbose = true
+end
+
+desc "Generate Documentation"
+Rake::RDocTask.new do |rdoc|
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_dir = "doc"
+  rdoc.rdoc_files.include("README.rdoc", "CHANGELOG", "LICENSE.txt", "lib/*.rb")
+  rdoc.title = "FakeWeb API Documentation"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.options << '--charset' << 'utf-8'
+end
+
+desc %{Update ".manifest" with the latest list of project filenames. Respect\
+.gitignore by excluding everything that git ignores. Update `files` and\
+`test_files` arrays in "*.gemspec" file if it's present.}
+task :manifest do
+  list = Dir['**/*'].sort
+  spec_file = Dir['*.gemspec'].first
+  list -= [spec_file] if spec_file
+
+  File.read('.gitignore').each_line do |glob|
+    glob = glob.chomp.sub(/^\//, '')
+    list -= Dir[glob]
+    list -= Dir["#{glob}/**/*"] if File.directory?(glob) and !File.symlink?(glob)
+    puts "excluding #{glob}"
+  end
+
+  if spec_file
+    spec = File.read spec_file
+    spec.gsub! /^(\s* s.(test_)?files \s* = \s* )( \[ [^\]]* \] | %w\( [^)]* \) )/mx do
+      assignment = $1
+      bunch = $2 ? list.grep(/^test\//) : list
+      '%s%%w(%s)' % [assignment, bunch.join(' ')]
+    end
+
+    File.open(spec_file,   'w') {|f| f << spec }
+  end
+  File.open('.manifest', 'w') {|f| f << list.join("\n") }
+end
+
+if RUBY_PLATFORM =~ /java/
+  puts "rcov support disabled (running under JRuby)."
+elsif RUBY_VERSION =~ /^1\.9/
+  puts "rcov support disabled (running under Ruby 1.9)"
+else
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.test_files = FileList['test/**/test*.rb'] 
+    t.rcov_opts << "--sort coverage"
+    t.rcov_opts << "--exclude gems"
+    t.rcov_opts << "--no-validator-links"
+  end
+end
+
+spec = eval(File.read(File.join(File.dirname(__FILE__), "fakeweb.gemspec")))
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar_gz = true
+  pkg.need_zip    = true
+end

data/lib/fake_web.rb

@@ -0,0 +1,176 @@
+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'
+
+module FakeWeb
+
+  # 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.
+  def self.allow_net_connect=(allowed)
+    @allow_net_connect = allowed
+  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.
+  def self.allow_net_connect?
+    @allow_net_connect
+  end
+  
+  # Enables or disables ignoring of query parameters for registered URIs.
+  #
+  # When you set <tt>FakeWeb.ignore_query_params = false</tt> (the default),
+  # all registered requests will fail unless they match the provided query
+  # parameters.
+  #
+  # When you set <tt>FakeWeb.ignore_query_params = true</tt>, though, any URIs
+  # that are supplied without query parameters will match the same URIs when
+  # they are requested, whether they have query parameters or not.
+  def self.ignore_query_params=(ignore)
+    @ignore_query_params = ignore
+  end
+  
+  # Pay attention to query parameters by default.
+  self.ignore_query_params = false
+  
+  # Returns +true+ if query parameters on a request should be ignored, or
+  # +false+ if matching query parameters are needed for the corresponding
+  # response to be supplied.
+  def self.ignore_query_params?
+    @ignore_query_params
+  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;
+
+  # call-seq:
+  #   FakeWeb.register_uri(method, uri, options)
+  #   FakeWeb.register_uri(uri, options)
+  #
+  # Register requests using the HTTP method specified by the symbol +method+ for
+  # +uri+ to be handled according to +options+. If no +method+ is specified, or
+  # you explicitly specify <tt>:any</tt>, the response will be reigstered for
+  # any request for +uri+. +uri+ can be a +String+ or a +URI+ object. +options+
+  # must be either a +Hash+ or an +Array+ of +Hashes+ (see below) that must
+  # contain any one of the following keys:
+  #
+  # <tt>:string</tt>::
+  #   Takes a +String+ argument that is returned as the body of the response.
+  #     FakeWeb.register_uri(:get, 'http://example.com/', :string => "Hello World!")
+  # <tt>:file</tt>::
+  #   Takes a valid filesystem path to a file that is slurped and returned as
+  #   the body of the response.
+  #     FakeWeb.register_uri(:post, 'http://example.com/', :file => "/tmp/my_response_body.txt")
+  # <tt>:response</tt>:: 
+  #   Either an <tt>Net::HTTPResponse</tt>, an +IO+ or a +String+.
+  # 
+  #   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://www.example.com/ > response_for_www.example.com
+  #
+  #   which can then be used in your test environment like so:
+  #
+  #     FakeWeb.register_uri(:get, 'http://www.example.com/', :response => 'response_for_www.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 provided response, you may optionally
+  # provide:
+  #
+  # <tt>:times</tt>::
+  #   The number of times this response will be used. Decremented by one each time it's called.
+  #   FakeWeb will use the final provided request indefinitely, regardless of its :times 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('http://www.example.com/', :response => "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('http://www.example.com/', :exception => Net::HTTPError)
+  #
+  def self.register_uri(*args)
+    method = :any
+    case args.length
+    when 3 then method, uri, options = *args
+    when 2 then         uri, options = *args
+    else   raise ArgumentError.new("wrong number of arguments (#{args.length} for method = :any, uri, options)")
+    end
+
+    Registry.instance.register_uri(method, uri, options)
+  end
+
+  # call-seq:
+  #   FakeWeb.response_for(method, uri)
+  #   FakeWeb.response_for(uri)
+  #
+  # Returns the faked Net::HTTPResponse object associated with +uri+.
+  def self.response_for(*args, &block) #:nodoc: :yields: response
+    method = :any
+    case args.length
+    when 2 then method, uri = args
+    when 1 then         uri = args.first
+    else   raise ArgumentError.new("wrong number of arguments (#{args.length} for method = :any, uri)")
+    end
+
+    Registry.instance.response_for(method, uri, &block)
+  end
+
+  # call-seq:
+  #   FakeWeb.registered_uri?(method, uri)
+  #   FakeWeb.registered_uri?(uri)
+  #
+  # Returns true if +uri+ is registered with FakeWeb. You can optionally
+  # specify +method+ to limit the search to a certain HTTP method (or use
+  # <tt>:any</tt> to explicitly check against any method).
+  def self.registered_uri?(*args)
+    method = :any
+    case args.length
+    when 2 then method, uri = args
+    when 1 then         uri = args.first
+    else   raise ArgumentError.new("wrong number of arguments (#{args.length} for method = :any, uri)")
+    end
+
+    Registry.instance.registered_uri?(method, uri)
+  end
+
+end

data/lib/fake_web/ext/net_http.rb

@@ -0,0 +1,62 @@
+require 'net/http'
+require 'net/https'
+require 'stringio'
+
+module Net  #:nodoc: all
+
+  class BufferedIO
+    def initialize(io, debug_output = nil)
+      @read_timeout = 60
+      @rbuf = ''
+      @debug_output = debug_output
+
+      @io = case io
+      when Socket, OpenSSL::SSL::SSLSocket, IO
+        io
+      when String
+        File.exists?(io) ? File.open(io, "r") : StringIO.new(io)
+      end
+      raise "Unable to create local socket" unless @io
+    end
+  end
+
+  class HTTP
+    def self.socket_type
+      FakeWeb::StubSocket
+    end
+
+    alias :original_net_http_request :request
+    alias :original_net_http_connect :connect
+
+    def request(request, body = nil, &block)
+      protocol = use_ssl? ? "https" : "http"
+
+      path = request.path
+      path = URI.parse(request.path).request_uri if request.path =~ /^http/
+
+      if request['authorization'].nil?
+        userinfo = ""
+      else
+        userinfo = request['authorization'].sub(/^Basic /, "").unpack("m").first + "@"
+      end
+
+      uri = "#{protocol}://#{userinfo}#{self.address}:#{self.port}#{path}"
+      method = request.method.downcase.to_sym
+
+      if FakeWeb.registered_uri?(method, uri)
+        @socket = Net::HTTP.socket_type.new
+        FakeWeb.response_for(method, uri, &block)
+      elsif FakeWeb.allow_net_connect?
+        original_net_http_connect
+        original_net_http_request(request, body, &block)
+      else
+        raise FakeWeb::NetConnectNotAllowedError,
+              "Real HTTP connections are disabled. Unregistered request: #{request.method} #{uri}"
+      end
+    end
+
+    def connect
+    end
+  end
+
+end

data/lib/fake_web/registry.rb

@@ -0,0 +1,83 @@
+module FakeWeb
+  class Registry #:nodoc:
+    include Singleton
+
+    attr_accessor :uri_map
+
+    def initialize
+      clean_registry
+    end
+
+    def clean_registry
+      self.uri_map = Hash.new do |hash, key|
+        hash[key] = Hash.new(&hash.default_proc)
+      end
+    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)
+      normalized_uri = normalize_uri(uri)
+      
+      uri_map[normalized_uri].has_key?(method) ||
+      uri_map[normalized_uri].has_key?(:any)
+    end
+
+    def registered_uri(method, uri)
+      uri = normalize_uri(uri)
+      registered = registered_uri?(method, uri)
+      if registered && uri_map[uri].has_key?(method)
+        uri_map[uri][method]
+      elsif registered
+        uri_map[uri][:any]
+      else
+        nil
+      end
+    end
+
+    def response_for(method, uri, &block)
+      responses = registered_uri(method, uri)
+      return nil if responses.nil?
+
+      next_response = responses.last
+      responses.each do |response|
+        if response.times and response.times > 0
+          response.times -= 1
+          next_response = response
+          break
+        end
+      end
+
+      next_response.response(&block)
+    end
+
+    private
+
+    def normalize_uri(uri)
+      normalized_uri =
+        case uri
+        when URI then uri
+        else
+          uri = 'http://' + uri unless uri.match('^https?://')
+          parsed_uri = URI.parse(uri)
+          parsed_uri.query = FakeWeb.ignore_query_params? ? nil :
+            sort_query_params(parsed_uri.query)
+          parsed_uri
+        end
+      normalized_uri.normalize
+    end
+
+    def sort_query_params(query)
+      if query.nil? || query.empty?
+        nil
+      else
+        query.split('&').sort.join('&')
+      end
+    end
+
+  end
+end

data/lib/fake_web/responder.rb

@@ -0,0 +1,99 @@
+module FakeWeb
+  class Responder #:nodoc:
+
+    attr_accessor :method, :uri, :options, :times
+
+    def initialize(method, uri, options, times)
+      self.method = method
+      self.uri = uri
+      self.options = options
+      self.times = times ? times : 1
+    end
+
+    def response(&block)
+      if has_baked_response?
+        response = baked_response
+      else
+        code, msg = meta_information
+        response = Net::HTTPResponse.send(:response_class, code.to_s).new(uri, code.to_s, msg)
+        response.instance_variable_set(:@body, content)
+      end
+
+      response.instance_variable_set(:@read, true)
+      response.extend FakeWeb::Response
+
+      optionally_raise(response)
+
+      yield response if block_given?
+
+      response
+    end
+
+    private
+
+    def content
+      [ :file, :string ].each do |map_option|
+        next unless options.has_key?(map_option)
+        return self.send("#{map_option}_response", options[map_option])
+      end
+
+      return ''
+    end
+
+    def file_response(path)
+      IO.read(path)
+    end
+
+    def string_response(string)
+      string
+    end
+
+    def baked_response
+      resp = case options[:response]
+      when Net::HTTPResponse then options[:response]
+      when String
+        socket = Net::BufferedIO.new(options[:response])
+        r = Net::HTTPResponse.read_new(socket)
+
+        # Store the oiriginal transfer-encoding
+        saved_transfer_encoding = r.instance_eval {
+          @header['transfer-encoding'] if @header.key?('transfer-encoding')
+        }
+
+        # read the body of response.
+        r.instance_eval { @header['transfer-encoding'] = nil }
+        r.reading_body(socket, true) {}
+
+        # Delete the transfer-encoding key from r.@header if there wasn't one,
+        # else restore the saved_transfer_encoding.
+        if saved_transfer_encoding.nil?
+          r.instance_eval { @header.delete('transfer-encoding') }
+        else
+          r.instance_eval { @header['transfer-encoding'] = saved_transfer_encoding }
+        end
+        r
+      else raise StandardError, "Handler unimplemented for response #{options[:response]}"
+      end
+    end
+
+    def has_baked_response?
+      options.has_key?(:response)
+    end
+
+    def optionally_raise(response)
+      return unless options.has_key?(:exception)
+      ex_alloc = options[:exception].allocate
+      ex_instance = case ex_alloc
+      when Net::HTTPError, OpenURI::HTTPError
+        options[:exception].new('Exception from FakeWeb', response)
+      else options[:exception].new
+      end
+      raise ex_instance
+    end
+
+    def meta_information
+      options.has_key?(:status) ? options[:status] : [200, 'OK']
+    end
+
+  end
+end