module ProxyFetcher

Ruby / JRuby lib for managing proxies

Constants

Error: Base exception class for all the ProxyFetcher exceptions.

Public Class Methods

config() click to toggle source

Returns ProxyFetcher configuration.

@return [ProxyFetcher::Configuration]

Configuration object.

@example

ProxyFetcher.config

#=> #<ProxyFetcher::Configuration:0x0000000241eec8 @user_agent="Mozilla/5.0, ...", @pool_size=10,
       @client_timeout=3, @proxy_validation_timeout=3, @provider_proxies_load_timeout=30,
       @http_client=ProxyFetcher::HTTPClient, @proxy_validator=ProxyFetcher::ProxyValidator,
       @providers=[:free_proxy_list, ...], @adapter=ProxyFetcher::Document::NokogiriAdapter>

# File lib/proxy_fetcher.rb, line 69
def config
  @__config_definition_lock__.synchronize do
    @config ||= ProxyFetcher::Configuration.new
  end
end

configure() { |config| ... } click to toggle source

@yieldreturn [optional, types, …] description

@return [ProxyFetcher::Configuration]

Configuration object.

# File lib/proxy_fetcher.rb, line 83
def configure
  @__config_access_lock__.synchronize { yield config }
end

gem_version() click to toggle source

ProxyFetcher gem version.

# File lib/proxy_fetcher/version.rb, line 6
def self.gem_version
  Gem::Version.new VERSION::STRING
end

logger() click to toggle source

Returns ProxyFetcher logger instance.

@return [Logger, ProxyFetcher::NullLogger] logger object

# File lib/proxy_fetcher.rb, line 91
def logger
  return @logger if defined?(@logger)

  @logger = config.logger || NullLogger.new
end

Private Class Methods

configure_adapter!() click to toggle source

Configures default adapter if it isn't defined by the user. @api private

# File lib/proxy_fetcher.rb, line 102
def configure_adapter!
  config.adapter = Configuration::DEFAULT_ADAPTER if config.adapter.nil?
end