Module: OpenURI::Meta
- Defined in:
- lib/open-uri.rb
Overview
Mixin for holding meta-information.
Constant Summary collapse
- RE_LWS =
:stopdoc:
/[\r\n\t ]+/n
- RE_TOKEN =
%r{[^\x00- ()<>@,;:\\"/\[\]?={}\x7f]+}n
- RE_QUOTED_STRING =
%r{"(?:[\r\n\t !#-\[\]-~\x80-\xff]|\\[\x00-\x7f])*"}n
- RE_PARAMETERS =
%r{(?:;#{RE_LWS}?#{RE_TOKEN}#{RE_LWS}?=#{RE_LWS}?(?:#{RE_TOKEN}|#{RE_QUOTED_STRING})#{RE_LWS}?)*}n
Instance Attribute Summary collapse
-
#base_uri ⇒ Object
returns a URI that is the base of relative URIs in the data.
-
#meta ⇒ Object
readonly
returns a Hash that represents header fields.
-
#metas ⇒ Object
readonly
returns a Hash that represents header fields.
-
#status ⇒ Object
returns an Array that consists of status code and message.
Class Method Summary collapse
-
.init(obj, src = nil) ⇒ Object
:nodoc:.
Instance Method Summary collapse
-
#charset ⇒ Object
returns a charset parameter in Content-Type field.
-
#content_encoding ⇒ Object
Returns a list of encodings in Content-Encoding field as an array of strings.
-
#content_type ⇒ Object
returns “type/subtype” which is MIME Content-Type.
-
#content_type_parse ⇒ Object
:startdoc:.
-
#last_modified ⇒ Object
returns a Time that represents the Last-Modified field.
-
#meta_add_field(name, value) ⇒ Object
:nodoc:.
-
#meta_add_field2(name, values) ⇒ Object
:nodoc:.
-
#meta_setup_encoding ⇒ Object
:nodoc:.
Instance Attribute Details
#base_uri ⇒ Object
returns a URI that is the base of relative URIs in the data. It may differ from the URI supplied by a user due to redirection.
430 431 432 |
# File 'lib/open-uri.rb', line 430 def base_uri @base_uri end |
#meta ⇒ Object (readonly)
returns a Hash that represents header fields. The Hash keys are downcased for canonicalization. The Hash values are a field body. If there are multiple field with same field name, the field values are concatenated with a comma.
437 438 439 |
# File 'lib/open-uri.rb', line 437 def @meta end |
#metas ⇒ Object (readonly)
returns a Hash that represents header fields. The Hash keys are downcased for canonicalization. The Hash value are an array of field values.
442 443 444 |
# File 'lib/open-uri.rb', line 442 def @metas end |
#status ⇒ Object
returns an Array that consists of status code and message.
426 427 428 |
# File 'lib/open-uri.rb', line 426 def status @status end |
Class Method Details
.init(obj, src = nil) ⇒ Object
:nodoc:
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 |
# File 'lib/open-uri.rb', line 409 def Meta.init(obj, src=nil) # :nodoc: obj.extend Meta obj.instance_eval { @base_uri = nil @meta = {} # name to string. legacy. @metas = {} # name to array of strings. } if src obj.status = src.status obj.base_uri = src.base_uri src..each {|name, values| obj.(name, values) } end end |
Instance Method Details
#charset ⇒ Object
returns a charset parameter in Content-Type field. It is downcased for canonicalization.
If charset parameter is not given but a block is given, the block is called and its result is returned. It can be used to guess charset.
If charset parameter and block is not given, nil is returned except text type in HTTP. In that case, “iso-8859-1” is returned as defined by RFC2616 3.7.1.
528 529 530 531 532 533 534 535 536 537 538 539 540 |
# File 'lib/open-uri.rb', line 528 def charset type, *parameters = content_type_parse if pair = parameters.assoc('charset') pair.last.downcase elsif block_given? yield elsif type && %r{\Atext/} =~ type && @base_uri && /\Ahttp\z/i =~ @base_uri.scheme "iso-8859-1" # RFC2616 3.7.1 else nil end end |
#content_encoding ⇒ Object
Returns a list of encodings in Content-Encoding field as an array of strings.
The encodings are downcased for canonicalization.
546 547 548 549 550 551 552 553 |
# File 'lib/open-uri.rb', line 546 def content_encoding vs = @metas['content-encoding'] if vs && %r{\A#{RE_LWS}?#{RE_TOKEN}#{RE_LWS}?(?:,#{RE_LWS}?#{RE_TOKEN}#{RE_LWS}?)*}o =~ (v = vs.join(', ')) v.scan(RE_TOKEN).map {|content_coding| content_coding.downcase} else [] end end |
#content_type ⇒ Object
returns “type/subtype” which is MIME Content-Type. It is downcased for canonicalization. Content-Type parameters are stripped.
513 514 515 516 |
# File 'lib/open-uri.rb', line 513 def content_type type, *_ = content_type_parse type || 'application/octet-stream' end |
#content_type_parse ⇒ Object
:startdoc:
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 |
# File 'lib/open-uri.rb', line 491 def content_type_parse # :nodoc: vs = @metas['content-type'] # The last (?:;#{RE_LWS}?)? matches extra ";" which violates RFC2045. if vs && %r{\A#{RE_LWS}?(#{RE_TOKEN})#{RE_LWS}?/(#{RE_TOKEN})#{RE_LWS}?(#{RE_PARAMETERS})(?:;#{RE_LWS}?)?\z}no =~ vs.join(', ') type = $1.downcase subtype = $2.downcase parameters = [] $3.scan(/;#{RE_LWS}?(#{RE_TOKEN})#{RE_LWS}?=#{RE_LWS}?(?:(#{RE_TOKEN})|(#{RE_QUOTED_STRING}))/no) {|att, val, qval| if qval val = qval[1...-1].gsub(/[\r\n\t !#-\[\]-~\x80-\xff]+|(\\[\x00-\x7f])/n) { $1 ? $1[1,1] : $& } end parameters << [att.downcase, val] } ["#{type}/#{subtype}", *parameters] else nil end end |
#last_modified ⇒ Object
returns a Time that represents the Last-Modified field.
475 476 477 478 479 480 481 482 |
# File 'lib/open-uri.rb', line 475 def last_modified if vs = @metas['last-modified'] v = vs.join(', ') Time.httpdate(v) else nil end end |
#meta_add_field(name, value) ⇒ Object
:nodoc:
470 471 472 |
# File 'lib/open-uri.rb', line 470 def (name, value) # :nodoc: (name, [value]) end |
#meta_add_field2(name, values) ⇒ Object
:nodoc:
463 464 465 466 467 468 |
# File 'lib/open-uri.rb', line 463 def (name, values) # :nodoc: name = name.downcase @metas[name] = values @meta[name] = values.join(', ') if name == 'content-type' end |
#meta_setup_encoding ⇒ Object
:nodoc:
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 |
# File 'lib/open-uri.rb', line 444 def # :nodoc: charset = self.charset enc = nil if charset begin enc = Encoding.find(charset) rescue ArgumentError end end enc = Encoding::ASCII_8BIT unless enc if self.respond_to? :force_encoding self.force_encoding(enc) elsif self.respond_to? :string self.string.force_encoding(enc) else # Tempfile self.set_encoding enc end end |