Module: Typhoeus

Extended by:

Request::Actions, Request::Callbacks::Types

Defined in:

sig/lib/typhoeus/typhoeus.rbs,
sig/lib/typhoeus/typhoeus.rbs,
sig/lib/typhoeus/typhoeus.rbs,
sig/lib/typhoeus/typhoeus.rbs,
sig/lib/typhoeus/typhoeus.rbs,
sig/lib/typhoeus/typhoeus.rbs,
sig/lib/typhoeus/typhoeus.rbs,
sig/lib/typhoeus/typhoeus.rbs,
sig/lib/typhoeus/typhoeus.rbs,
sig/lib/typhoeus/typhoeus.rbs,
sig/lib/typhoeus/typhoeus.rbs,
sig/lib/typhoeus/typhoeus.rbs,
sig/lib/typhoeus/typhoeus.rbs,
sig/lib/typhoeus/typhoeus.rbs,
sig/lib/typhoeus/typhoeus.rbs,
sig/lib/typhoeus/typhoeus.rbs,
sig/lib/typhoeus/typhoeus.rbs,
sig/lib/typhoeus/typhoeus.rbs

Defined Under Namespace

Classes: EasyFactory, Errors, Expectation, Request, Response

Constant Summary

USER_AGENT =

Returns:

• (::String)

VERSION =

Returns:

• (::String)

Instance Attribute Summary

• #block_connection ⇒ Object

  Returns the value of attribute block_connection.

• #cache ⇒ Object

  Returns the value of attribute cache.

• #cached ⇒ Object writeonly

  Sets the attribute cached.

• #memoize ⇒ Object

  Returns the value of attribute memoize.

• #proxy ⇒ Object

  Returns the value of attribute proxy.

• #user_agent ⇒ Object

  Returns the value of attribute user_agent.

• #verbose ⇒ Object

  Returns the value of attribute verbose.

Class Method Summary

• .before { ... } ⇒ Object
• .clear ⇒ Object
• .configure {|arg0| ... } ⇒ Object
• .easies ⇒ Object
• .get ⇒ Object
• .release ⇒ Object
• .stub { ... } ⇒ Object
• .with_connection { ... } ⇒ Object
• .with_easy {|arg0| ... } ⇒ Object

Instance Method Summary

• #appconnect_time ⇒ Object
• #blocked? ⇒ Object
• #cache_ttl ⇒ Object
• #cacheable? ⇒ Object
• #cached? ⇒ Object
• #connect_time ⇒ Object
• #debug_info ⇒ Object
• #delete ⇒ Object
• #effective_url ⇒ Object
• #execute_callbacks ⇒ Object
• #execute_headers_callbacks ⇒ Object
• #failure? ⇒ Object
• #finish ⇒ Object
• #first_header_line ⇒ Object
• #get ⇒ Object
• #has_bad_response_code? ⇒ Object
• #has_good_response_code? ⇒ Object
• #head ⇒ Object
• #headers ⇒ Object
• #http_version ⇒ Object
• #httpauth_avail ⇒ Object
• #marshal_dump ⇒ Object
• #marshal_load ⇒ Object
• #memoizable? ⇒ Object
• #modified? ⇒ Object
• #namelookup_time ⇒ Object
• #on_body { ... } ⇒ Object
• #on_complete {|arg0| ... } ⇒ void
• #on_failure { ... } ⇒ Object
• #on_headers { ... } ⇒ Object
• #on_progress { ... } ⇒ Object
• #on_success { ... } ⇒ Object
• #options ⇒ Object
• #patch ⇒ Object
• #post ⇒ Object
• #pretransfer_time ⇒ Object
• #primary_ip ⇒ Object
• #put ⇒ Object
• #redirect_count ⇒ Object
• #redirect_time ⇒ Object
• #redirections ⇒ Object
• #request_size ⇒ Object
• #response ⇒ Object
• #response= ⇒ Object
• #response_body ⇒ Object
• #response_code ⇒ Object
• #response_headers ⇒ Object
• #return_code ⇒ Object
• #return_message ⇒ Object
• #run ⇒ Object
• #starttransfer_time ⇒ Object
• #status_message ⇒ Object
• #streaming? ⇒ Object
• #success? ⇒ Object
• #timed_out? ⇒ Object
• #total_time ⇒ Object

Instance Attribute Details

#block_connection ⇒ Object

Returns the value of attribute block_connection.

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 3

def block_connection
  @block_connection
end

#cache ⇒ Object

Returns the value of attribute cache.

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 9

def cache
  @cache
end

#cached=(value) ⇒ Object (writeonly)

Sets the attribute cached

Parameters:

• value (Object) —

  the value to set the attribute cached to.

# File 'sig/lib/typhoeus/typhoeus.rbs', line 277

def cached=(value)
  @cached = value
end

#memoize ⇒ Object

Returns the value of attribute memoize.

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 5

def memoize
  @memoize
end

#proxy ⇒ Object

Returns the value of attribute proxy.

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 13

def proxy
  @proxy
end

#user_agent ⇒ Object

Returns the value of attribute user_agent.

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 11

def user_agent
  @user_agent
end

#verbose ⇒ Object

Returns the value of attribute verbose.

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 7

def verbose
  @verbose
end

Class Method Details

.before { ... } ⇒ Object

Yields:

Yield Returns:

• (Object)

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 113

def self.before: () { () -> untyped } -> untyped

.clear ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 97

def self.clear: () -> untyped

.configure {|arg0| ... } ⇒ Object

Yields:

Yield Parameters:

• arg0 (Object)

Yield Returns:

• (Object)

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 109

def self.configure: () { (untyped) -> untyped } -> untyped

.easies ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 101

def self.easies: () -> untyped

.get ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 95

def self.get: () -> untyped

.release ⇒ Object

Parameters:

• easy (Object)

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 93

def self.release: (untyped easy) -> untyped

.stub { ... } ⇒ Object

Parameters:

• base_url (Object)
• options (::Hash[untyped, untyped])

Yields:

Yield Returns:

• (Object)

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 111

def self.stub: (untyped base_url, ?::Hash[untyped, untyped] options) { () -> untyped } -> untyped

.with_connection { ... } ⇒ Object

Yields:

Yield Returns:

• (Object)

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 115

def self.with_connection: () { () -> untyped } -> untyped

.with_easy {|arg0| ... } ⇒ Object

Yields:

Yield Parameters:

• arg0 (Object)

Yield Returns:

• (Object)

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 99

def self.with_easy: () { (untyped) -> untyped } -> untyped

Instance Method Details

#appconnect_time ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 319

def appconnect_time: () -> untyped

#blocked? ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 146

def blocked?: () -> untyped

#cache_ttl ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 156

def cache_ttl: () -> untyped

#cacheable? ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 152

def cacheable?: () -> untyped

#cached? ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 279

def cached?: () -> untyped

#connect_time ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 323

def connect_time: () -> untyped

#debug_info ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 337

def debug_info: () -> untyped

#delete ⇒ Object

Parameters:

• base_url (Object)
• options (::Hash[untyped, untyped])

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 128

def delete: (untyped base_url, ?::Hash[untyped, untyped] options) -> untyped

#effective_url ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 329

def effective_url: () -> untyped

#execute_callbacks ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 165

def execute_callbacks: () -> untyped

#execute_headers_callbacks ⇒ Object

Parameters:

• response (Object)

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 163

def execute_headers_callbacks: (untyped response) -> untyped

#failure? ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 374

def failure?: () -> untyped

#finish ⇒ Object

Parameters:

• response (Object)
• bypass_memoization (Object, nil)

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 199

def finish: (untyped response, ?untyped? bypass_memoization) -> untyped

#first_header_line ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 380

def first_header_line: () -> untyped

#get ⇒ Object

Parameters:

• base_url (Object)
• options (::Hash[untyped, untyped])

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 122

def get: (untyped base_url, ?::Hash[untyped, untyped] options) -> untyped

#has_bad_response_code? ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 384

def has_bad_response_code?: () -> untyped

#has_good_response_code? ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 382

def has_good_response_code?: () -> untyped

#head ⇒ Object

Parameters:

• base_url (Object)
• options (::Hash[untyped, untyped])

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 130

def head: (untyped base_url, ?::Hash[untyped, untyped] options) -> untyped

#headers ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 339

def headers: () -> untyped

#http_version ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 370

def http_version: () -> untyped

#httpauth_avail ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 313

def httpauth_avail: () -> untyped

#marshal_dump ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 183

def marshal_dump: () -> untyped

#marshal_load ⇒ Object

Parameters:

• attributes (Object)

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 185

def marshal_load: (untyped attributes) -> untyped

#memoizable? ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 192

def memoizable?: () -> untyped

#modified? ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 376

def modified?: () -> untyped

#namelookup_time ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 325

def namelookup_time: () -> untyped

#on_body { ... } ⇒ Object

Yields:

Yield Returns:

• (Object)

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 265

def on_body: () { () -> untyped } -> untyped

#on_complete {|arg0| ... } ⇒ void

This method returns an undefined value.

Yields:

Yield Parameters:

• arg0 (Typhoeus::Response)

Yield Returns:

• (void)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 170

def on_complete: () { (Typhoeus::Response) -> void } -> void

#on_failure { ... } ⇒ Object

Yields:

Yield Returns:

• (Object)

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 174

def on_failure: () { () -> untyped } -> untyped

#on_headers { ... } ⇒ Object

Yields:

Yield Returns:

• (Object)

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 176

def on_headers: () { () -> untyped } -> untyped

#on_progress { ... } ⇒ Object

Yields:

Yield Returns:

• (Object)

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 178

def on_progress: () { () -> untyped } -> untyped

#on_success { ... } ⇒ Object

Yields:

Yield Returns:

• (Object)

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 172

def on_success: () { () -> untyped } -> untyped

#options ⇒ Object

Parameters:

• base_url (Object)
• options (::Hash[untyped, untyped])

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 134

def options: (untyped base_url, ?::Hash[untyped, untyped] options) -> untyped

#patch ⇒ Object

Parameters:

• base_url (Object)
• options (::Hash[untyped, untyped])

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 132

def patch: (untyped base_url, ?::Hash[untyped, untyped] options) -> untyped

#post ⇒ Object

Parameters:

• base_url (Object)
• options (::Hash[untyped, untyped])

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 124

def post: (untyped base_url, ?::Hash[untyped, untyped] options) -> untyped

#pretransfer_time ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 321

def pretransfer_time: () -> untyped

#primary_ip ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 331

def primary_ip: () -> untyped

#put ⇒ Object

Parameters:

• base_url (Object)
• options (::Hash[untyped, untyped])

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 126

def put: (untyped base_url, ?::Hash[untyped, untyped] options) -> untyped

#redirect_count ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 333

def redirect_count: () -> untyped

#redirect_time ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 327

def redirect_time: () -> untyped

#redirections ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 341

def redirections: () -> untyped

#request_size ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 335

def request_size: () -> untyped

#response ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 260

def response: () -> untyped

#response= ⇒ Object

Parameters:

• response (Object)
• value (Object)

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 150

def response=: (untyped response) -> untyped

#response_body ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 307

def response_body: () -> untyped

#response_code ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 311

def response_code: () -> untyped

#response_headers ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 309

def response_headers: () -> untyped

#return_code ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 303

def return_code: () -> untyped

#return_message ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 305

def return_message: () -> untyped

#run ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 139

def run: () -> untyped

#starttransfer_time ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 317

def starttransfer_time: () -> untyped

#status_message ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 368

def status_message: () -> untyped

#streaming? ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 267

def streaming?: () -> untyped

#success? ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 372

def success?: () -> untyped

#timed_out? ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 378

def timed_out?: () -> untyped

#total_time ⇒ Object

Returns:

• (Object)

# File 'sig/lib/typhoeus/typhoeus.rbs', line 315

def total_time: () -> untyped