Module: Zenrows

Defined in:
lib/zenrows.rb,
lib/zenrows/hooks.rb,
lib/zenrows/proxy.rb,
lib/zenrows/client.rb,
lib/zenrows/errors.rb,
lib/zenrows/railtie.rb,
lib/zenrows/version.rb,
lib/zenrows/api_client.rb,
lib/zenrows/api_response.rb,
lib/zenrows/backends/base.rb,
lib/zenrows/configuration.rb,
lib/zenrows/css_extractor.rb,
lib/zenrows/hooks/context.rb,
lib/zenrows/js_instructions.rb,
lib/zenrows/backends/http_rb.rb,
lib/zenrows/backends/net_http.rb,
lib/zenrows/instrumented_client.rb,
lib/zenrows/hooks/log_subscriber.rb

Overview

ZenRows Ruby client for web scraping proxy

Examples:

Basic configuration and usage

Zenrows.configure do |config|
  config.api_key = 'YOUR_API_KEY'
end

client = Zenrows::Client.new
http = client.http(js_render: true, premium_proxy: true)
response = http.get('https://example.com')

With JavaScript instructions

instructions = Zenrows::JsInstructions.build do
  click '.load-more'
  wait 2000
  scroll_to :bottom
end

http = client.http(js_render: true, js_instructions: instructions)

Author:

  • Ernest Bursa

Since:

  • 0.1.0

Defined Under Namespace

Modules: Backends Classes: ApiClient, ApiResponse, AuthenticationError, BotDetectedError, Client, Configuration, ConfigurationError, CssExtractor, Error, HookConfigurator, Hooks, InstrumentedClient, JsInstructions, Proxy, ProxyError, Railtie, RateLimitError, TimeoutError, WaitTimeError

Constant Summary collapse

VERSION =

Since:

  • 0.1.0

"0.4.0"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Configuration

Returns Global configuration instance.

Returns:

Since:

  • 0.1.0



49
50
51
 
# File 'lib/zenrows.rb', line 49

def configuration
  @configuration ||= Configuration.new
end

.configure {|Configuration| ... } ⇒ Configuration

Configure Zenrows with a block

Examples:

Zenrows.configure do |config|
  config.api_key = 'YOUR_API_KEY'
end

Yields:

Returns:

Since:

  • 0.1.0



64
65
66
67
 
# File 'lib/zenrows.rb', line 64

def configure
  yield(configuration) if block_given?
  configuration
end

.reset_configuration! ⇒ void

This method returns an undefined value.

Reset configuration to defaults

Since:

  • 0.1.0



72
73
74
 
# File 'lib/zenrows.rb', line 72

def reset_configuration!
  @configuration = Configuration.new
end