Extended maintenance of Ruby versions 1.8.7 and 1.9.2 will end on July 31, 2014. Read more

In Files

  • open-uri.rb

Methods

OpenURI::OpenRead

Mixin for HTTP and FTP URIs.

Public Instance Methods

open(*rest, &block) click to toggle source

#open provides `open' for URI::HTTP and URI::FTP.

#open takes optional 3 arguments as: #open([mode [, perm]] [, options]) [{|io| ... }]

`mode’, `perm’ is same as Kernel#open.

However, `mode’ must be read mode because #open doesn’t support write mode (yet). Also `perm’ is just ignored because it is meaningful only for file creation.

`options’ must be a hash.

Each pairs which key is a string in the hash specify a extra header field for HTTP. I.e. it is ignored for FTP without HTTP proxy.

The hash may include other options which key is a symbol:

:proxy

Synopsis:

:proxy => "http://proxy.foo.com:8000/"
:proxy => URI.parse("http://proxy.foo.com:8000/")
:proxy => true
:proxy => false
:proxy => nil

If :proxy option is specified, the value should be String, URI, boolean or nil. When String or URI is given, it is treated as proxy URI. When true is given or the option itself is not specified, environment variable `scheme_proxy’ is examined. `scheme’ is replaced by `http’, `https’ or `ftp’. When false or nil is given, the environment variables are ignored and connection will be made to a server directly.

:proxy_http_basic_authentication

Synopsis:

:proxy_http_basic_authentication => ["http://proxy.foo.com:8000/", "proxy-user", "proxy-password"]
:proxy_http_basic_authentication => [URI.parse("http://proxy.foo.com:8000/"), "proxy-user", "proxy-password"]

If :proxy option is specified, the value should be an Array with 3 elements. It should contain a proxy URI, a proxy user name and a proxy password. The proxy URI should be a String, an URI or nil. The proxy user name and password should be a String.

If nil is given for the proxy URI, this option is just ignored.

If :proxy and :proxy_http_basic_authentication is specified, ArgumentError is raised.

:http_basic_authentication

Synopsis:

:http_basic_authentication=>[user, password]

If :http_basic_authentication is specified, the value should be an array which contains 2 strings: username and password. It is used for HTTP Basic authentication defined by RFC 2617.

:content_length_proc

Synopsis:

:content_length_proc => lambda {|content_length| ... }

If :content_length_proc option is specified, the option value procedure is called before actual transfer is started. It takes one argument which is expected content length in bytes.

If two or more transfer is done by HTTP redirection, the procedure is called only one for a last transfer.

When expected content length is unknown, the procedure is called with nil. It is happen when HTTP response has no Content-Length header.

:progress_proc

Synopsis:

:progress_proc => lambda {|size| ...}

If :progress_proc option is specified, the proc is called with one argument each time when `open’ gets content fragment from network. The argument `size’ `size’ is a accumulated transferred size in bytes.

If two or more transfer is done by HTTP redirection, the procedure is called only one for a last transfer.

:progress_proc and :content_length_proc are intended to be used for progress bar. For example, it can be implemented as follows using Ruby/ProgressBar.

pbar = nil
open("http://...",
  :content_length_proc => lambda {|t|
    if t && 0 < t
      pbar = ProgressBar.new("...", t)
      pbar.file_transfer_mode
    end
  },
  :progress_proc => lambda {|s|
    pbar.set s if pbar
  }) {|f| ... }
:read_timeout

Synopsis:

:read_timeout=>nil     (no timeout)
:read_timeout=>10      (10 second)

:read_timeout option specifies a timeout of read for http connections.

:ssl_ca_cert

Synopsis:

:ssl_ca_cert=>filename

:ssl_ca_cert is used to specify CA certificate for SSL. If it is given, default certificates are not used.

:ssl_verify_mode

Synopsis:

:ssl_verify_mode=>mode

:ssl_verify_mode is used to specify openssl verify mode.

#open returns an IO like object if block is not given. Otherwise it yields the IO object and return the value of the block. The IO object is extended with OpenURI::Meta.

:ftp_active_mode

Synopsis:

:ftp_active_mode=>bool

:ftp_active_mode=>true is used to make ftp active mode. Note that the active mode is default in Ruby 1.8 or prior. Ruby 1.9 uses passive mode by default.

:redirect

Synopsis:

:redirect=>bool

:redirect=>false is used to disable HTTP redirects at all. OpenURI::HTTPRedirect exception raised on redirection. It is true by default. The true means redirections between http and ftp is permitted.

 
               # File open-uri.rb, line 670
def open(*rest, &block)
  OpenURI.open_uri(self, *rest, &block)
end
            
read(options={}) click to toggle source

#read) reads a content referenced by self and returns the content as string. The string is extended with OpenURI::Meta. The argument `options' is same as #open.

 
               # File open-uri.rb, line 678
def read(options={})
  self.open(options) {|f|
    str = f.read
    Meta.init str, f
    str
  }
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus