Module: ProxyRb

Defined in:
lib/proxy_rb.rb,
lib/proxy_rb/api.rb,
lib/proxy_rb/cli.rb,
lib/proxy_rb/main.rb,
lib/proxy_rb/rspec.rb,
lib/proxy_rb/setup.rb,
lib/proxy_rb/errors.rb,
lib/proxy_rb/events.rb,
lib/proxy_rb/console.rb,
lib/proxy_rb/request.rb,
lib/proxy_rb/runtime.rb,
lib/proxy_rb/version.rb,
lib/proxy_rb/api/core.rb,
lib/proxy_rb/cucumber.rb,
lib/proxy_rb/resource.rb,
lib/proxy_rb/response.rb,
lib/proxy_rb/announcer.rb,
lib/proxy_rb/event_bus.rb,
lib/proxy_rb/proxy_url.rb,
lib/proxy_rb/http_proxy.rb,
lib/proxy_rb/credentials.rb,
lib/proxy_rb/initializer.rb,
lib/proxy_rb/initializer.rb,
lib/proxy_rb/initializer.rb,
lib/proxy_rb/initializer.rb,
lib/proxy_rb/console/help.rb,
lib/proxy_rb/matchers/all.rb,
lib/proxy_rb/simple_table.rb,
lib/proxy_rb/api/passwords.rb,
lib/proxy_rb/configuration.rb,
lib/proxy_rb/configuration.rb,
lib/proxy_rb/api/formatters.rb,
lib/proxy_rb/api/http_proxy.rb,
lib/proxy_rb/user_passwords.rb,
lib/proxy_rb/http_downloader.rb,
lib/proxy_rb/matchers/include.rb,
lib/proxy_rb/proxy_url_parser.rb,
lib/proxy_rb/password_fetchers.rb,
lib/proxy_rb/basic_configuration.rb,
lib/proxy_rb/drivers/basic_driver.rb,
lib/proxy_rb/configuration_wrapper.rb,
lib/proxy_rb/drivers/webkit_driver.rb,
lib/proxy_rb/drivers/selenium_driver.rb,
lib/proxy_rb/event_bus/name_resolver.rb,
lib/proxy_rb/basic_configuration/option.rb,
lib/proxy_rb/drivers/poltergeist_driver.rb,
lib/proxy_rb/user_passwords/vault_user_password.rb,
lib/proxy_rb/password_fetchers/basic_password_fetcher.rb,
lib/proxy_rb/password_fetchers/vault_password_fetcher.rb,
lib/proxy_rb/user_passwords/environment_user_password.rb,
lib/proxy_rb/password_fetchers/chaining_password_fetcher.rb,
lib/proxy_rb/basic_configuration/in_configuration_wrapper.rb,
lib/proxy_rb/password_fetchers/environment_password_fetcher.rb

Overview

ProxyRb

Defined Under Namespace

Modules: Api, Cucumber, Drivers, Events, Initializers, Matchers, PasswordFetcher, PasswordFetchers, Rspec, UserPasswords Classes: Announcer, BasicConfiguration, Cli, Configuration, ConfigurationWrapper, Console, Credentials, EventBus, EventNameResolveError, HttpDownloader, HttpProxy, Initializer, NoEventError, ProxyUrl, ProxyUrlParser, Request, Resource, ResourceNotDownloadableError, Response, Runtime, Setup, SimpleTable, UnknownOptionError, UrlTimeoutError

Constant Summary collapse

ANNOUNCERS = 
%i(
  proxy
  proxy_user
  resource
  resource_user
  http_response_headers
  status_code
).freeze
VERSION = 
'1.0.0'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.config ⇒ Object (readonly)

Returns the value of attribute config.



30
31
32
 
# File 'lib/proxy_rb/configuration.rb', line 30

def config
  @config
end

.logger ⇒ Object (readonly)

Returns the value of attribute logger.



25
26
27
 
# File 'lib/proxy_rb/main.rb', line 25

def logger
  @logger
end

Class Method Details

.configure(&block) ⇒ Object

Configure proxy_rb

Examples:

How to configure proxy_rb


ProxyRb.configure do |config|
  config.<option> = <value>
end


40
41
42
43
44
 
# File 'lib/proxy_rb/configuration.rb', line 40

def configure(&block)
  @config.configure(&block)

  self
end

.debug_mode_enabled? ⇒ Boolean

What kind of information can be announce while debugging

Returns:

  • (Boolean) 


28
29
30
 
# File 'lib/proxy_rb/main.rb', line 28

def debug_mode_enabled?
  debug_mode == true
end

.enable_debug_mode ⇒ Object 



32
33
34
35
 
# File 'lib/proxy_rb/main.rb', line 32

def enable_debug_mode
  self.debug_mode = true
  %w(pry byebug).each { |l| require l }
end

.require_files_matching_pattern(pattern) ⇒ Object 



37
38
39
40
41
 
# File 'lib/proxy_rb/main.rb', line 37

def require_files_matching_pattern(pattern)
  root = File.expand_path('../', __FILE__)
  path = File.join(root, pattern)
  Dir.glob(path).each { |f| require_relative f }
end