123456789_123456789_123456789_123456789_123456789_

Class: Gem::FakeFetcher

Relationships & Source Files
Inherits: Object
Defined in: lib/rubygems/test_utilities.rb

Overview

A fake RemoteFetcher for use in tests or to avoid real live HTTP requests when testing code that uses RubyGems.

Example:

@fetcher = Gem::FakeFetcher.new
@fetcher.data['http://gems.example.com/yaml'] = source_index.to_yaml
Gem::RemoteFetcher.fetcher = @fetcher

use nested array if multiple response is needed

@fetcher.data['http://gems.example.com/sequence'] = [['Success', 200, 'OK'], ['Failed', 401, 'Unauthorized']]

@fetcher.fetch_path('http://gems.example.com/sequence') # => ['Success', 200, 'OK']
@fetcher.fetch_path('http://gems.example.com/sequence') # => ['Failed', 401, 'Unauthorized']

# invoke RubyGems code

paths = @fetcher.paths
assert_equal 'http://gems.example.com/yaml', paths.shift
assert paths.empty?, paths.join(', ')

See RubyGems’ tests for more examples of FakeFetcher.

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new ⇒ FakeFetcher

[ GitHub ] 

  


# File 'lib/rubygems/test_utilities.rb', line 37



def initialize
  @data = {}
  @paths = []
end


  







Instance Attribute Details



  

    #data   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rubygems/test_utilities.rb', line 33



attr_reader :data


  








  

    #last_request   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rubygems/test_utilities.rb', line 34



attr_reader :last_request


  








  

    #paths   (rw)
  

  [ GitHub ]


  

  


# File 'lib/rubygems/test_utilities.rb', line 35



attr_accessor :paths


  







Instance Method Details



  

    #cache_update_path(uri, path = nil, update = true)  
  

  [ GitHub ]


  

  


# File 'lib/rubygems/test_utilities.rb', line 77



def cache_update_path(uri, path = nil, update = true)
  if data = fetch_path(uri)
    open(path, 'wb') { |io| io.write data } if path and update
    data
  else
    Gem.read_binary(path) if path
  end
end


  








  

    #download(spec, source_uri, install_dir = Gem.dir)  
  

  [ GitHub ]


  

  


# File 'lib/rubygems/test_utilities.rb', line 135



def download(spec, source_uri, install_dir = Gem.dir)
  name = File.basename spec.cache_file
  path = if Dir.pwd == install_dir  # see fetch_command
           install_dir
         else
           File.join install_dir, "cache"
         end

  path = File.join path, name

  if source_uri =~ /^http/
    File.open(path, "wb") do |f|
      f.write fetch_path(File.join(source_uri, "gems", name))
    end
  else
    FileUtils.cp source_uri, path
  end

  path
end


  








  

    #download_to_cache(dependency)  
  

  [ GitHub ]


  

  


# File 'lib/rubygems/test_utilities.rb', line 156



def download_to_cache(dependency)
  found, _ = Gem::SpecFetcher.fetcher.spec_for_dependency dependency

  return if found.empty?

  spec, source = found.first

  download spec, source.uri.to_s
end


  








  

    #fetch_path(path, mtime = nil, head = false)  
  

  [ GitHub ]


  

  


# File 'lib/rubygems/test_utilities.rb', line 64



def fetch_path(path, mtime = nil, head = false)
  data = find_data(path)

  if data.respond_to?(:call)
    data.call
  else
    if path.to_s =~ /gz$/ and not data.nil? and not data.empty?
      data = Gem::Util.gunzip data
    end
    data
  end
end


  








  

    #fetch_size(path)  
  



  

    
  





  
Raises:


    
  
  • 
    (ArgumentError)
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubygems/test_utilities.rb', line 120



def fetch_size(path)
  path = path.to_s
  @paths << path

  raise ArgumentError, 'need full URI' unless path =~ %r'^http://'

  unless @data.key? path
    raise Gem::RemoteFetcher::FetchError.new("no data for #{path}", path)
  end

  data = @data[path]

  data.respond_to?(:call) ? data.call : data.length
end


  








  

    #find_data(path, nargs = 3)  
  



  

    
  





  
Raises:


    
  
  • 
    (ArgumentError)
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubygems/test_utilities.rb', line 42



def find_data(path, nargs = 3)
  return File.read path.path if URI === path and 'file' == path.scheme

  if URI === path and "URI::#{path.scheme.upcase}" != path.class.name
    raise ArgumentError,
      "mismatch for scheme #{path.scheme} and class #{path.class}"
  end

  path = path.to_s
  @paths << path
  raise ArgumentError, 'need full URI' unless path =~ %r'^https?://'

  unless @data.key? path
    raise Gem::RemoteFetcher::FetchError.new("no data for #{path}", path)
  end

  data = @data[path]

  data.flatten! and return data.shift(nargs) if data.respond_to?(:flatten!)
  data
end


  








  

    #open_uri_or_path(path)  
  



  

    

Thanks, FakeWeb!


  



  [ GitHub ]


  

  


# File 'lib/rubygems/test_utilities.rb', line 87



def open_uri_or_path(path)
  data = find_data(path)
  body, code, msg = data

  response = Net::HTTPResponse.send(:response_class, code.to_s).new("1.0", code.to_s, msg)
  response.instance_variable_set(:@body, body)
  response.instance_variable_set(:@read, true)
  response
end


  








  

    #pretty_print(q)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rubygems/test_utilities.rb', line 110



def pretty_print(q) # :nodoc:
  q.group 2, '[FakeFetcher', ']' do
    q.breakable
    q.text 'URIs:'

    q.breakable
    q.pp @data.keys
  end
end


  








  

    #request(uri, request_class, last_modified = nil) {|@last_request| ... } 
  



  

    
  





  
Yields:





  [ GitHub ]


  

  


# File 'lib/rubygems/test_utilities.rb', line 97



def request(uri, request_class, last_modified = nil)
  data = find_data(uri)
  body, code, msg = (data.respond_to?(:call) ? data.call : data)

  @last_request = request_class.new uri.request_uri
  yield @last_request if block_given?

  response = Net::HTTPResponse.send(:response_class, code.to_s).new("1.0", code.to_s, msg)
  response.instance_variable_set(:@body, body)
  response.instance_variable_set(:@read, true)
  response
end