sandro-fakeweb 1.2.5

data/Rakefile

@@ -0,0 +1,78 @@
+puts "Using ruby #{RUBY_VERSION}p#{RUBY_PATCHLEVEL}"
+
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+begin
+  require 'rdoc/task'
+rescue LoadError
+  puts "\nIt looks like you're using an old version of RDoc, but FakeWeb requires a newer one."
+  puts "You can try upgrading with `sudo gem install rdoc`.\n\n"
+  raise
+end
+
+task :default => :test
+
+desc "Run All Tests"
+Rake::TestTask.new :test do |test|
+  test.test_files = FileList["test/**/*.rb"].exclude("test/test_helper.rb")
+  test.verbose = false
+  test.warning = true
+end
+
+desc "Generate Documentation"
+RDoc::Task.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' << '--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/**/*.rb"].exclude("test/test_helper.rb")
+    t.rcov_opts << "--sort coverage"
+    t.rcov_opts << "--exclude gems"
+    t.warning = true
+  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,204 @@
+require 'singleton'
+require 'yaml'
+
+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'
+require 'fake_web/fixture'
+
+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
+
+  class << self
+    attr_reader :fixture_path
+    alias generate_fixtures? fixture_path
+
+    # Puts FakeWeb into generate_fixtures? mode wherein all responses are
+    # are saved into the provided directory +path+.
+    # You can later load the saved fixtures with +register_fixtures+
+    def generate_fixtures(path)
+      self.allow_net_connect = true
+      raise RuntimeError, "The path: #{path} is not a directory" unless File.directory? path
+      @fixture_path = path
+    end
+
+    # Loads the *.fixture files in the provided +path+ and registers the url
+    # and response objects for each fixture.
+    # Stops fixture generation such that FakeWeb.generate_fixtures? returns
+    # false
+    def register_fixtures(path)
+      stop_generating_fixtures!
+      Fixture.register(path)
+    end
+
+    # Disables fixture generation such that FakeWeb.generate_fixtures?
+    # returns false.
+    def stop_generating_fixtures!
+      @fixture_path = nil
+    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 an <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://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/", :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('http://www.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")
+  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 for 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
+
+  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,76 @@
+require 'net/http'
+require 'net/https'
+require 'stringio'
+
+module Net  #:nodoc: all
+
+  class BufferedIO
+    alias initialize_without_fakeweb initialize
+    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
+        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
+  end
+
+  class HTTP
+    class << self
+      alias socket_type_without_fakeweb socket_type
+      def socket_type
+        FakeWeb::StubSocket
+      end
+    end
+
+    alias request_without_fakeweb request
+    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"] =~ /^Basic /
+        userinfo = FakeWeb::Utility.decode_userinfo_from_header(request["authorization"])
+        userinfo = FakeWeb::Utility.encode_unsafe_chars_in_userinfo(userinfo) + "@"
+      else
+        userinfo = ""
+      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?
+        connect_without_fakeweb
+        response = request_without_fakeweb(request, body, &block)
+        if path = FakeWeb.generate_fixtures?
+          fixture_response = block_given? ? request_without_fakeweb(request, body) : response
+          FakeWeb::Fixture.new(path, method, uri, fixture_response).save
+        end
+        response
+      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 connect_without_fakeweb connect
+    def connect
+    end
+  end
+
+end

data/lib/fake_web/fixture.rb

@@ -0,0 +1,60 @@
+module FakeWeb
+  class Fixture
+    attr_reader :path, :method, :uri, :response
+
+    def self.register(path)
+      Dir.glob("#{path}/*.fixture") do |name|
+        fixture = YAML.load_file name
+        fixture.register
+      end
+    end
+
+    def initialize(path, method, uri, response)
+      @path = path
+      @method = method
+      @uri = uri
+      @response = response
+    end
+
+    def file_name
+      @file_name ||= generate_file_name
+    end
+
+    def register
+      FakeWeb.register_uri(method, uri, :response => response)
+    end
+
+    def save
+      Dir.chdir path do
+        File.open(file_name, 'w') do |f|
+          f.write self.to_yaml
+        end
+      end
+    end
+
+    private
+
+    def base_file_name
+      u = URI.parse(uri)
+      path = u.path.gsub(/^\/$/, '').gsub(/\/$/, '').gsub('/', '-')
+      "#{method.to_s.upcase}_#{u.host}#{path}"
+    end
+
+    def generate_file_name
+      name = base_file_name + ".fixture"
+      name = next_unique_file_name(name) if File.exists?(File.join(path, name))
+      name
+    end
+
+    def next_unique_file_name(name)
+      path = "."
+      count = 2
+      ext = File.extname(name)
+      while File.exists?(File.join(path, name)) do
+        name = "#{File.basename(name, ext).gsub(/_\d$/, '')}_#{count}#{ext}"
+        count += 1
+      end
+      name
+    end
+  end
+end

data/lib/fake_web/registry.rb

@@ -0,0 +1,127 @@
+module FakeWeb
+  class Registry #:nodoc:
+    include Singleton
+
+    attr_accessor :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)
+      !responses_for(method, uri).empty?
+    end
+
+    def response_for(method, uri, &block)
+      responses = responses_for(method, uri)
+      return nil if responses.empty?
+
+      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 responses_for(method, uri)
+      uri = normalize_uri(uri)
+
+      uri_map_matches(method, uri, URI) ||
+      uri_map_matches(:any,   uri, URI) ||
+      uri_map_matches(method, uri, Regexp) ||
+      uri_map_matches(:any,   uri, Regexp) ||
+      []
+    end
+
+    def uri_map_matches(method, uri, type_to_check = URI)
+      uris_to_check = variations_of_uri_as_strings(uri)
+
+      matches = uri_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)
+      uris = []
+      normalized_uri = normalize_uri(uri_object)
+
+      # all orderings of query parameters
+      query = normalized_uri.query
+      if query.nil? || query.empty?
+        uris << normalized_uri
+      else
+        FakeWeb::Utility.simple_array_permutation(query.split('&')) do |p|
+          current_permutation = normalized_uri.dup
+          current_permutation.query = p.join('&')
+          uris << current_permutation
+        end
+      end
+
+      uri_strings = uris.map { |uri| uri.to_s }
+
+      # including and omitting the default port
+      if normalized_uri.default_port == normalized_uri.port
+        uri_strings += uris.map { |uri|
+          uri.to_s.sub(/#{Regexp.escape(normalized_uri.request_uri)}$/,
+                       ":#{normalized_uri.port}#{normalized_uri.request_uri}")
+        }
+      end
+
+      uri_strings
+    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