Class: Mechanize

Inherits:
Object
  • Object
show all
Defined in:
lib/mechanize.rb

Overview

The Mechanize library is used for automating interactions with a website. It can follow links and submit forms. Form fields can be populated and submitted. A history of URLs is maintained and can be queried.

Example

require 'mechanize'
require 'logger'

agent = Mechanize.new
agent.log = Logger.new "mech.log"
agent.user_agent_alias = 'Mac Safari'

page = agent.get "http://www.google.com/"
search_form = page.form_with :name => "f"
search_form.field_with(:name => "q").value = "Hello"

search_results = agent.submit search_form
puts search_results.body

Issues with mechanize

If you think you have a bug with mechanize, but aren’t sure, please file a ticket at github.com/tenderlove/mechanize/issues

Here are some common problems you may experience with mechanize

Problems connecting to SSL sites

Mechanize defaults to validating SSL certificates using the default CA certificates for your platform. At this time, Windows users do not have integration between the OS default CA certificates and OpenSSL. #cert_store explains how to download and use Mozilla’s CA certificates to allow SSL sites to work.

Problems with content-length

Some sites return an incorrect content-length value. Unlike a browser, mechanize raises an error when the content-length header does not match the response length since it does not know if there was a connection problem or if the mismatch is a server bug.

The error raised, Mechanize::ResponseReadError, can be converted to a parsed Page, File, etc. depending upon the content-type:

agent = Mechanize.new
uri = URI 'http://example/invalid_content_length'

begin
  page = agent.get uri
rescue Mechanize::ResponseReadError => e
  page = e.force_parse
end

Defined Under Namespace

Modules: ElementMatcher, Parser Classes: ContentTypeError, Cookie, CookieJar, Download, Error, File, FileConnection, FileRequest, FileResponse, FileSaver, Form, HTTP, Headers, History, Page, PluggableParser, RedirectLimitReachedError, RedirectNotGetOrHeadError, ResponseCodeError, ResponseReadError, RobotsDisallowedError, TestCase, UnauthorizedError, UnsupportedSchemeError, Util

Constant Summary collapse

VERSION =

The version of Mechanize you are using.

'2.1.1'
AGENT_ALIASES =

Supported User-Agent aliases for use with user_agent_alias=. The description in parenthesis is for informative purposes and is not part of the alias name.

  • Linux Firefox (3.6.1)

  • Linux Konqueror (3)

  • Linux Mozilla

  • Mac Firefox (3.6)

  • Mac Mozilla

  • Mac Safari (5)

  • Mac Safari 4

  • Mechanize (default)

  • Windows IE 6

  • Windows IE 7

  • Windows IE 8

  • Windows IE 9

  • Windows Mozilla

  • iPhone (3.0)

Example:

agent = Mechanize.new
agent.user_agent_alias = 'Mac Safari'

{
  'Mechanize' => "Mechanize/#{VERSION} Ruby/#{ruby_version} (http://github.com/tenderlove/mechanize/)",
  'Linux Firefox' => 'Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.2.1) Gecko/20100122 firefox/3.6.1',
  'Linux Konqueror' => 'Mozilla/5.0 (compatible; Konqueror/3; Linux)',
  'Linux Mozilla' => 'Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.4) Gecko/20030624',
  'Mac FireFox' => 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2) Gecko/20100115 Firefox/3.6',
  'Mac Mozilla' => 'Mozilla/5.0 (Macintosh; U; PPC Mac OS X Mach-O; en-US; rv:1.4a) Gecko/20030401',
  'Mac Safari 4' => 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_2; de-at) AppleWebKit/531.21.8 (KHTML, like Gecko) Version/4.0.4 Safari/531.21.10',
  'Mac Safari' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_2) AppleWebKit/534.51.22 (KHTML, like Gecko) Version/5.1.1 Safari/534.51.22',
  'Windows IE 6' => 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)',
  'Windows IE 7' => 'Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; .NET CLR 1.1.4322; .NET CLR 2.0.50727)',
  'Windows IE 8' => 'Mozilla/5.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; .NET CLR 1.1.4322; .NET CLR 2.0.50727)',
  'Windows IE 9' => 'Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Trident/5.0)',
  'Windows Mozilla' => 'Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.4b) Gecko/20030516 Mozilla Firebird/0.6',
  'iPhone' => 'Mozilla/5.0 (iPhone; U; CPU like Mac OS X; en) AppleWebKit/420+ (KHTML, like Gecko) Version/3.0 Mobile/1C28 Safari/419.3',
}

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|_self| ... } ⇒ Mechanize

Creates a new mechanize instance. If a block is given, the created instance is yielded to the block for setting up pre-connection state such as SSL parameters or proxies:

agent = Mechanize.new do |a|
  a.proxy_host = 'proxy.example'
  a.proxy_port = 8080
end

Yields:

  • (_self)

Yield Parameters:

  • _self (Mechanize) —

    the object that the method was called on



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/mechanize.rb', line 147

def initialize
  @agent = Mechanize::HTTP::Agent.new
  @agent.context = self
  @log = nil

  # attr_accessors
  @agent.user_agent = AGENT_ALIASES['Mechanize']
  @watch_for_set    = nil
  @history_added    = nil

  # attr_readers
  @pluggable_parser = PluggableParser.new

  @keep_alive_time  = 0

  # Proxy
  @proxy_addr = nil
  @proxy_port = nil
  @proxy_user = nil
  @proxy_pass = nil

  @html_parser = self.class.html_parser

  @default_encoding = nil
  @force_default_encoding = false

  # defaults
  @agent.max_history = 50

  yield self if block_given?

  @agent.set_proxy @proxy_addr, @proxy_port, @proxy_user, @proxy_pass
  @agent.set_http
end

Class Attribute Details

.html_parser ⇒ Object

Default HTML parser for all mechanize instances

Mechanize.html_parser = Nokogiri::XML



505
506
507
 
# File 'lib/mechanize.rb', line 505

def html_parser
  @html_parser
end

.log ⇒ Object

Default logger for all mechanize instances

Mechanize.log = Logger.new $stderr



512
513
514
 
# File 'lib/mechanize.rb', line 512

def log
  @log
end

Instance Attribute Details

#agent ⇒ Object (readonly)

:section: Utilities



1022
1023
1024
 
# File 'lib/mechanize.rb', line 1022

def agent
  @agent
end

#default_encoding ⇒ Object

A default encoding name used when parsing HTML parsing. When set it is used after any other encoding. The default is nil.



520
521
522
 
# File 'lib/mechanize.rb', line 520

def default_encoding
  @default_encoding
end

#force_default_encoding ⇒ Object

Overrides the encodings given by the HTTP server and the HTML page with the default_encoding when set to true.



526
527
528
 
# File 'lib/mechanize.rb', line 526

def force_default_encoding
  @force_default_encoding
end

#history_added ⇒ Object

Callback which is invoked with the page that was added to history.



259
260
261
 
# File 'lib/mechanize.rb', line 259

def history_added
  @history_added
end

#html_parser ⇒ Object

The HTML parser to be used when parsing documents



531
532
533
 
# File 'lib/mechanize.rb', line 531

def html_parser
  @html_parser
end

#keep_alive_time ⇒ Object

HTTP/1.0 keep-alive time. This is no longer supported by mechanize as it now uses net-http-persistent which only supports HTTP/1.1 persistent connections



538
539
540
 
# File 'lib/mechanize.rb', line 538

def keep_alive_time
  @keep_alive_time
end

#pluggable_parser ⇒ Object (readonly)

:nodoc:



1024
1025
1026
 
# File 'lib/mechanize.rb', line 1024

def pluggable_parser
  @pluggable_parser
end

#proxy_addr ⇒ Object (readonly)

The HTTP proxy address



543
544
545
 
# File 'lib/mechanize.rb', line 543

def proxy_addr
  @proxy_addr
end

#proxy_pass ⇒ Object (readonly)

The HTTP proxy password



548
549
550
 
# File 'lib/mechanize.rb', line 548

def proxy_pass
  @proxy_pass
end

#proxy_port ⇒ Object (readonly)

The HTTP proxy port



553
554
555
 
# File 'lib/mechanize.rb', line 553

def proxy_port
  @proxy_port
end

#proxy_user ⇒ Object (readonly)

The HTTP proxy username



558
559
560
 
# File 'lib/mechanize.rb', line 558

def proxy_user
  @proxy_user
end

#watch_for_set ⇒ Object

The value of watch_for_set is passed to pluggable parsers for retrieved content



877
878
879
 
# File 'lib/mechanize.rb', line 877

def watch_for_set
  @watch_for_set
end

Class Method Details

.inherited(child) ⇒ Object

:nodoc:



131
132
133
134
135
 
# File 'lib/mechanize.rb', line 131

def self.inherited(child) # :nodoc:
  child.html_parser ||= html_parser
  child.log ||= log
  super
end

Instance Method Details

#auth(user, password, domain = nil) ⇒ Object Also known as: basic_auth

Sets the user and password to be used for HTTP authentication. sets the optional domain for NTLM authentication



564
565
566
567
568
 
# File 'lib/mechanize.rb', line 564

def auth(user, password, domain = nil)
  @agent.user     = user
  @agent.password = password
  @agent.domain = domain
end

#back ⇒ Object

Equivalent to the browser back button. Returns the previous page visited.



189
190
191
 
# File 'lib/mechanize.rb', line 189

def back
  @agent.history.pop
end

#ca_file ⇒ Object

Path to an OpenSSL server certificate file



887
888
889
 
# File 'lib/mechanize.rb', line 887

def ca_file
  @agent.ca_file
end

#ca_file=(ca_file) ⇒ Object

Sets the certificate file used for SSL connections



894
895
896
 
# File 'lib/mechanize.rb', line 894

def ca_file= ca_file
  @agent.ca_file = ca_file
end

#cert ⇒ Object

An OpenSSL client certificate or the path to a certificate file.



901
902
903
 
# File 'lib/mechanize.rb', line 901

def cert
  @agent.cert
end

#cert=(cert) ⇒ Object

Sets the OpenSSL client certificate cert to the given path or certificate instance



909
910
911
 
# File 'lib/mechanize.rb', line 909

def cert= cert
  @agent.cert = cert
end

#cert_store ⇒ Object

An OpenSSL certificate store for verifying server certificates. This defaults to the default certificate store for your system.

If your system does not ship with a default set of certificates you can retrieve a copy of the set from Mozilla here: curl.haxx.se/docs/caextract.html

(Note that this set does not have an HTTPS download option so you may wish to use the firefox-db2pem.sh script to extract the certificates from a local install to avoid man-in-the-middle attacks.)

After downloading or generating a cacert.pem from the above link you can create a certificate store from the pem file like this:

cert_store = OpenSSL::X509::Store.new
cert_store.add_file 'cacert.pem'

And have mechanize use it with:

agent.cert_store = cert_store



935
936
937
 
# File 'lib/mechanize.rb', line 935

def cert_store
  @agent.cert_store
end

#cert_store=(cert_store) ⇒ Object

Sets the OpenSSL certificate store to store.

See also #cert_store



944
945
946
 
# File 'lib/mechanize.rb', line 944

def cert_store= cert_store
  @agent.cert_store = cert_store
end

#certificate ⇒ Object

What is this?

Why is it different from #cert?



953
954
955
 
# File 'lib/mechanize.rb', line 953

def certificate # :nodoc:
  @agent.certificate
end

#click(link) ⇒ Object

If the parameter is a string, finds the button or link with the value of the string on the current page and clicks it. Otherwise, clicks the Mechanize::Page::Link object passed in. Returns the page fetched.



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/mechanize.rb', line 286

def click link
  case link
  when Page::Link then
    referer = link.page || current_page()
    if @agent.robots
      if (referer.is_a?(Page) and referer.parser.nofollow?) or
         link.rel?('nofollow') then
        raise RobotsDisallowedError.new(link.href)
      end
    end
    if link.rel?('noreferrer')
      href = @agent.resolve(link.href, link.page || current_page)
      referer = Page.new(nil, {'content-type'=>'text/html'})
    else
      href = link.href
    end
    get href, [], referer
  when String, Regexp then
    if real_link = page.link_with(:text => link)
      click real_link
    else
      button = nil
      form = page.forms.find do |f|
        button = f.button_with(:value => link)
        button.is_a? Form::Submit
      end
      submit form, button if form
    end
  else
    referer = current_page()
    href = link.respond_to?(:href) ? link.href :
      (link['href'] || link['src'])
    get href, [], referer
  end
end

#conditional_requests ⇒ Object

Are If-Modified-Since conditional requests enabled?



575
576
577
 
# File 'lib/mechanize.rb', line 575

def conditional_requests
  @agent.conditional_requests
end

#conditional_requests=(enabled) ⇒ Object

Disables If-Modified-Since conditional requests (enabled by default)



582
583
584
 
# File 'lib/mechanize.rb', line 582

def conditional_requests= enabled
  @agent.conditional_requests = enabled
end

#content_encoding_hooks ⇒ Object

A list of hooks to call before reading response header ‘content-encoding’.

The hook is called with the agent making the request, the URI of the request, the response an IO containing the response body.



252
253
254
 
# File 'lib/mechanize.rb', line 252

def content_encoding_hooks
  @agent.content_encoding_hooks
end

#cookie_jar ⇒ Object

A Mechanize::CookieJar which stores cookies



589
590
591
 
# File 'lib/mechanize.rb', line 589

def cookie_jar
  @agent.cookie_jar
end

#cookie_jar=(cookie_jar) ⇒ Object

Replaces the cookie jar with cookie_jar



596
597
598
 
# File 'lib/mechanize.rb', line 596

def cookie_jar= cookie_jar
  @agent.cookie_jar = cookie_jar
end

#cookies ⇒ Object

Returns a list of cookies stored in the cookie jar.



603
604
605
 
# File 'lib/mechanize.rb', line 603

def cookies
  @agent.cookie_jar.to_a
end

#current_page ⇒ Object Also known as: page

Returns the latest page loaded by Mechanize



196
197
198
 
# File 'lib/mechanize.rb', line 196

def current_page
  @agent.current_page
end

#delete(uri, query_params = {}, headers = {}) ⇒ Object

DELETE uri with query_params, and setting headers:

delete('http://example/', {'q' => 'foo'}, {})



327
328
329
330
331
 
# File 'lib/mechanize.rb', line 327

def delete(uri, query_params = {}, headers = {})
  page = @agent.fetch(uri, :delete, headers, query_params)
  add_to_history(page)
  page
end

#follow_meta_refresh ⇒ Object

Follow HTML meta refresh and HTTP Refresh headers. If set to :anywhere meta refresh tags outside of the head element will be followed.



611
612
613
 
# File 'lib/mechanize.rb', line 611

def follow_meta_refresh
  @agent.follow_meta_refresh
end

#follow_meta_refresh=(follow) ⇒ Object

Controls following of HTML meta refresh and HTTP Refresh headers in responses.



619
620
621
 
# File 'lib/mechanize.rb', line 619

def follow_meta_refresh= follow
  @agent.follow_meta_refresh = follow
end

#follow_meta_refresh_self ⇒ Object

Follow an HTML meta refresh and HTTP Refresh headers that have no “url=” in the content attribute.

Defaults to false to prevent infinite refresh loops.



629
630
631
 
# File 'lib/mechanize.rb', line 629

def follow_meta_refresh_self
  @agent.follow_meta_refresh_self
end

#follow_meta_refresh_self=(follow) ⇒ Object

Alters the following of HTML meta refresh and HTTP Refresh headers that point to the same page.



637
638
639
 
# File 'lib/mechanize.rb', line 637

def follow_meta_refresh_self= follow
  @agent.follow_meta_refresh_self = follow
end

#get(uri, parameters = [], referer = nil, headers = {}) {|page| ... } ⇒ Object

GET the uri with the given request parameters, referer and headers.

The referer may be a URI or a page.

Yields:



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/mechanize.rb', line 339

def get(uri, parameters = [], referer = nil, headers = {})
  method = :get

  referer ||=
    if uri.to_s =~ %r{\Ahttps?://}
      Page.new(nil, {'content-type'=>'text/html'})
    else
      current_page || Page.new(nil, {'content-type'=>'text/html'})
    end

  # FIXME: Huge hack so that using a URI as a referer works.  I need to
  # refactor everything to pass around URIs but still support
  # Mechanize::Page#base
  unless Mechanize::Parser === referer then
    referer = referer.is_a?(String) ?
    Page.new(URI.parse(referer), {'content-type' => 'text/html'}) :
      Page.new(referer, {'content-type' => 'text/html'})
  end

  # fetch the page
  headers ||= {}
  page = @agent.fetch uri, method, headers, parameters, referer
  add_to_history(page)
  yield page if block_given?
  page
end

#get_file(url) ⇒ Object

GET url and return only its contents



369
370
371
 
# File 'lib/mechanize.rb', line 369

def get_file(url)
  get(url).body
end

#gzip_enabled ⇒ Object

Is gzip compression of responses enabled?



644
645
646
 
# File 'lib/mechanize.rb', line 644

def gzip_enabled
  @agent.gzip_enabled
end

#gzip_enabled=(enabled) ⇒ Object

Disables HTTP/1.1 gzip compression (enabled by default)



651
652
653
 
# File 'lib/mechanize.rb', line 651

def gzip_enabled=enabled
  @agent.gzip_enabled = enabled
end

#head(uri, query_params = {}, headers = {}) {|page| ... } ⇒ Object

HEAD uri with query_params, and setting headers:

head('http://example/', {'q' => 'foo'}, {})

Yields:



378
379
380
381
382
383
 
# File 'lib/mechanize.rb', line 378

def head(uri, query_params = {}, headers = {})
  # fetch the page
  page = @agent.fetch(uri, :head, headers, query_params)
  yield page if block_given?
  page
end

#history ⇒ Object

The history of this mechanize run



205
206
207
 
# File 'lib/mechanize.rb', line 205

def history
  @agent.history
end

#idle_timeout ⇒ Object

Connections that have not been used in this many seconds will be reset.



658
659
660
 
# File 'lib/mechanize.rb', line 658

def idle_timeout
  @agent.idle_timeout
end

#idle_timeout=(idle_timeout) ⇒ Object

Sets the idle timeout to idle_timeout. The default timeout is 5 seconds. If you experience “too many connection resets”, reducing this value may help.



666
667
668
 
# File 'lib/mechanize.rb', line 666

def idle_timeout= idle_timeout
  @agent.idle_timeout = idle_timeout
end

#keep_alive ⇒ Object

Are HTTP/1.1 keep-alive connections enabled?



673
674
675
 
# File 'lib/mechanize.rb', line 673

def keep_alive
  @agent.keep_alive
end

#keep_alive=(enable) ⇒ Object

Disable HTTP/1.1 keep-alive connections if enable is set to false. If you are experiencing “too many connection resets” errors setting this to false will eliminate them.

You should first investigate reducing idle_timeout.



684
685
686
 
# File 'lib/mechanize.rb', line 684

def keep_alive= enable
  @agent.keep_alive = enable
end

#key ⇒ Object

An OpenSSL private key or the path to a private key



960
961
962
 
# File 'lib/mechanize.rb', line 960

def key
  @agent.key
end

#key=(key) ⇒ Object

Sets the OpenSSL client key to the given path or key instance



967
968
969
 
# File 'lib/mechanize.rb', line 967

def key= key
  @agent.key = key
end

#log ⇒ Object

The current logger. If no logger has been set Mechanize.log is used.



691
692
693
 
# File 'lib/mechanize.rb', line 691

def log
  @log || Mechanize.log
end

#log=(logger) ⇒ Object

Sets the logger used by this instance of mechanize



698
699
700
 
# File 'lib/mechanize.rb', line 698

def log= logger
  @log = logger
end

#max_file_buffer ⇒ Object

Responses larger than this will be written to a Tempfile instead of stored in memory. The default is 10240 bytes



706
707
708
 
# File 'lib/mechanize.rb', line 706

def max_file_buffer
  @agent.max_file_buffer
end

#max_file_buffer=(bytes) ⇒ Object

Sets the maximum size of a response body that will be stored in memory to bytes



714
715
716
 
# File 'lib/mechanize.rb', line 714

def max_file_buffer= bytes
  @agent.max_file_buffer = bytes
end

#max_history ⇒ Object

Maximum number of items allowed in the history.



212
213
214
 
# File 'lib/mechanize.rb', line 212

def max_history
  @agent.history.max_size
end

#max_history=(length) ⇒ Object

Sets the maximum number of items allowed in the history to length.

Setting the maximum history length to nil will make the history size unlimited. Take care when doing this, mechanize stores page bodies in the temporary files directory for pages in the history. For a long-running mechanize program this can be quite large.



224
225
226
 
# File 'lib/mechanize.rb', line 224

def max_history= length
  @agent.history.max_size = length
end

#open_timeout ⇒ Object

Length of time to wait until a connection is opened in seconds



721
722
723
 
# File 'lib/mechanize.rb', line 721

def open_timeout
  @agent.open_timeout
end

#open_timeout=(open_timeout) ⇒ Object

Sets the connection open timeout to open_timeout



728
729
730
 
# File 'lib/mechanize.rb', line 728

def open_timeout= open_timeout
  @agent.open_timeout = open_timeout
end

#parse(uri, response, body) ⇒ Object

Parses the body of the response from uri using the pluggable parser that matches its content type



1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
 
# File 'lib/mechanize.rb', line 1030

def parse uri, response, body
  content_type = nil

  unless response['Content-Type'].nil?
    data, = response['Content-Type'].split ';', 2
    content_type, = data.downcase.split ',', 2 unless data.nil?
  end

  # Find our pluggable parser
  parser_klass = @pluggable_parser.parser content_type

  unless parser_klass <= Mechanize::Download then
    body = case body
           when IO, Tempfile, StringIO then
             body.read
           else
             body
           end
  end

  parser_klass.new uri, response, body, response.code do |parser|
    parser.mech = self if parser.respond_to? :mech=

    parser.watch_for_set = @watch_for_set if
      @watch_for_set and parser.respond_to?(:watch_for_set=)
  end
end

#pass ⇒ Object

OpenSSL client key password



974
975
976
 
# File 'lib/mechanize.rb', line 974

def pass
  @agent.pass
end

#pass=(pass) ⇒ Object

Sets the client key password to pass



981
982
983
 
# File 'lib/mechanize.rb', line 981

def pass= pass
  @agent.pass = pass
end

#post(uri, query = {}, headers = {}) ⇒ Object

POST to the given uri with the given query. The query is specified by either a string, or a list of key-value pairs represented by a hash or an array of arrays.

Examples:

agent.post 'http://example.com/', "foo" => "bar"

agent.post 'http://example.com/', [%w[foo bar]]

agent.post('http://example.com/', "<message>hello</message>",
           'Content-Type' => 'application/xml')



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/mechanize.rb', line 398

def post(uri, query={}, headers={})
  return request_with_entity(:post, uri, query, headers) if String === query

  node = {}
  # Create a fake form
  class << node
    def search(*args); []; end
  end
  node['method'] = 'POST'
  node['enctype'] = 'application/x-www-form-urlencoded'

  form = Form.new(node)

  query.each { |k, v|
    if v.is_a?(IO)
      form.enctype = 'multipart/form-data'
      ul = Form::FileUpload.new({'name' => k.to_s},::File.basename(v.path))
      ul.file_data = v.read
      form.file_uploads << ul
    else
      form.fields << Form::Field.new({'name' => k.to_s},v)
    end
  }
  post_form(uri, form, headers)
end

#post_connect_hooks ⇒ Object

A list of hooks to call after retrieving a response. Hooks are called with the agent and the response returned.



265
266
267
 
# File 'lib/mechanize.rb', line 265

def post_connect_hooks
  @agent.post_connect_hooks
end

#pre_connect_hooks ⇒ Object

A list of hooks to call before making a request. Hooks are called with the agent and the request to be performed.



273
274
275
 
# File 'lib/mechanize.rb', line 273

def pre_connect_hooks
  @agent.pre_connect_hooks
end

#pretty_print(q) ⇒ Object

:nodoc:



1058
1059
1060
1061
1062
1063
1064
1065
 
# File 'lib/mechanize.rb', line 1058

def pretty_print(q) # :nodoc:
  q.object_group(self) {
    q.breakable
    q.pp cookie_jar
    q.breakable
    q.pp current_page
  }
end

#put(uri, entity, headers = {}) ⇒ Object

PUT to uri with entity, and setting headers:

put('http://example/', 'new content', {'Content-Type' => 'text/plain'})



429
430
431
 
# File 'lib/mechanize.rb', line 429

def put(uri, entity, headers = {})
  request_with_entity(:put, uri, entity, headers)
end

#read_timeout ⇒ Object

Length of time to wait for data from the server



735
736
737
 
# File 'lib/mechanize.rb', line 735

def read_timeout
  @agent.read_timeout
end

#read_timeout=(read_timeout) ⇒ Object

Sets the timeout for each chunk of data read from the server to read_timeout. A single request may read many chunks of data.



743
744
745
 
# File 'lib/mechanize.rb', line 743

def read_timeout= read_timeout
  @agent.read_timeout = read_timeout
end

#redirect_ok ⇒ Object Also known as: follow_redirect?

Controls how mechanize deals with redirects. The following values are allowed:

:all, true

All 3xx redirects are followed (default)

:permanent

Only 301 Moved Permanantly redirects are followed

false

No redirects are followed



755
756
757
 
# File 'lib/mechanize.rb', line 755

def redirect_ok
  @agent.redirect_ok
end

#redirect_ok=(follow) ⇒ Object

Sets the mechanize redirect handling policy. See redirect_ok for allowed values



765
766
767
 
# File 'lib/mechanize.rb', line 765

def redirect_ok= follow
  @agent.redirect_ok = follow
end

#redirection_limit ⇒ Object

Maximum number of redirections to follow



772
773
774
 
# File 'lib/mechanize.rb', line 772

def redirection_limit
  @agent.redirection_limit
end

#redirection_limit=(limit) ⇒ Object

Sets the maximum number of redirections to follow to limit



779
780
781
 
# File 'lib/mechanize.rb', line 779

def redirection_limit= limit
  @agent.redirection_limit = limit
end

#request_headers ⇒ Object

A hash of custom request headers that will be sent on every request



786
787
788
 
# File 'lib/mechanize.rb', line 786

def request_headers
  @agent.request_headers
end

#request_headers=(request_headers) ⇒ Object

Replaces the custom request headers that will be sent on every request with request_headers



794
795
796
 
# File 'lib/mechanize.rb', line 794

def request_headers= request_headers
  @agent.request_headers = request_headers
end

#request_with_entity(verb, uri, entity, headers = {}) ⇒ Object

Makes an HTTP request to url using HTTP method verb. entity is used as the request body, if allowed.



437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/mechanize.rb', line 437

def request_with_entity(verb, uri, entity, headers = {})
  cur_page = current_page || Page.new(nil, {'content-type'=>'text/html'})

  headers = {
    'Content-Type' => 'application/octet-stream',
    'Content-Length' => entity.size.to_s,
  }.update headers

  page = @agent.fetch uri, verb, headers, [entity], cur_page
  add_to_history(page)
  page
end

#retry_change_requests ⇒ Object

Retry POST and other non-idempotent requests. See RFC 2616 9.1.2.



801
802
803
 
# File 'lib/mechanize.rb', line 801

def retry_change_requests
  @agent.retry_change_requests
end

#retry_change_requests=(retry_change_requests) ⇒ Object

When setting retry_change_requests to true you are stating that, for all the URLs you access with mechanize, making POST and other non-idempotent requests is safe and will not cause data duplication or other harmful results.

If you are experiencing “too many connection resets” errors you should instead investigate reducing the idle_timeout or disabling keep_alive connections.



815
816
817
 
# File 'lib/mechanize.rb', line 815

def retry_change_requests= retry_change_requests
  @agent.retry_change_requests = retry_change_requests
end

#robots ⇒ Object

Will /robots.txt files be obeyed?



822
823
824
 
# File 'lib/mechanize.rb', line 822

def robots
  @agent.robots
end

#robots=(enabled) ⇒ Object

When enabled mechanize will retrieve and obey robots.txt files



830
831
832
 
# File 'lib/mechanize.rb', line 830

def robots= enabled
  @agent.robots = enabled
end

#scheme_handlers ⇒ Object

The handlers for HTTP and other URI protocols.



837
838
839
 
# File 'lib/mechanize.rb', line 837

def scheme_handlers
  @agent.scheme_handlers
end

#scheme_handlers=(scheme_handlers) ⇒ Object

Replaces the URI scheme handler table with scheme_handlers



844
845
846
 
# File 'lib/mechanize.rb', line 844

def scheme_handlers= scheme_handlers
  @agent.scheme_handlers = scheme_handlers
end

#set_proxy(address, port, user = nil, password = nil) ⇒ Object

Sets the proxy address at port with an optional user and password



1070
1071
1072
1073
1074
1075
1076
1077
1078
 
# File 'lib/mechanize.rb', line 1070

def set_proxy address, port, user = nil, password = nil
  @proxy_addr = address
  @proxy_port = port
  @proxy_user = user
  @proxy_pass = password

  @agent.set_proxy address, port, user, password
  @agent.set_http
end

#submit(form, button = nil, headers = {}) ⇒ Object

Submits form with an optional button.

Without a button:

page = agent.get('http://example.com')
agent.submit(page.forms.first)

With a button:

agent.submit(page.forms.first, page.forms.first.buttons.first)



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/mechanize.rb', line 462

def submit(form, button=nil, headers={})
  form.add_button_to_query(button) if button

  case form.method.upcase
  when 'POST'
    post_form(form.action, form, headers)
  when 'GET'
    get(form.action.gsub(/\?[^\?]*$/, ''),
        form.build_query,
        form.page,
        headers)
  else
    raise ArgumentError, "unsupported method: #{form.method.upcase}"
  end
end

#transact ⇒ Object

Runs given block, then resets the page history as it was before. self is given as a parameter to the block. Returns the value of the block.



482
483
484
485
486
487
488
489
 
# File 'lib/mechanize.rb', line 482

def transact
  history_backup = @agent.history.dup
  begin
    yield self
  ensure
    @agent.history = history_backup
  end
end

#user_agent ⇒ Object

The identification string for the client initiating a web request



851
852
853
 
# File 'lib/mechanize.rb', line 851

def user_agent
  @agent.user_agent
end

#user_agent=(user_agent) ⇒ Object

Sets the User-Agent used by mechanize to user_agent. See also user_agent_alias



859
860
861
 
# File 'lib/mechanize.rb', line 859

def user_agent= user_agent
  @agent.user_agent = user_agent
end

#user_agent_alias=(name) ⇒ Object

Set the user agent for the Mechanize object based on the given name.

See also AGENT_ALIASES



868
869
870
871
 
# File 'lib/mechanize.rb', line 868

def user_agent_alias= name
  self.user_agent = AGENT_ALIASES[name] ||
    raise(ArgumentError, "unknown agent alias #{name.inspect}")
end

#verify_callback ⇒ Object

A callback for additional certificate verification. See OpenSSL::SSL::SSLContext#verify_callback

The callback can be used for debugging or to ignore errors by always returning true. Specifying nil uses the default method that was valid when the SSLContext was created



993
994
995
 
# File 'lib/mechanize.rb', line 993

def verify_callback
  @agent.verify_callback
end

#verify_callback=(verify_callback) ⇒ Object

Sets the OpenSSL certificate verification callback



1000
1001
1002
 
# File 'lib/mechanize.rb', line 1000

def verify_callback= verify_callback
  @agent.verify_callback = verify_callback
end

#verify_mode ⇒ Object

the OpenSSL server certificate verification method. The default is OpenSSL::SSL::VERIFY_PEER and certificate verification uses the default system certificates. See also cert_store



1009
1010
1011
 
# File 'lib/mechanize.rb', line 1009

def verify_mode
  @agent.verify_mode
end

#verify_mode=(verify_mode) ⇒ Object

Sets the OpenSSL server certificate verification method.



1016
1017
1018
 
# File 'lib/mechanize.rb', line 1016

def verify_mode= verify_mode
  @agent.verify_mode = verify_mode
end

#visited?(url) ⇒ Boolean Also known as: visited_page

Returns a visited page for the url passed in, otherwise nil

Returns:

  • (Boolean) 


231
232
233
234
235
 
# File 'lib/mechanize.rb', line 231

def visited? url
  url = url.href if url.respond_to? :href

  @agent.visited_page url
end