diff options
Diffstat (limited to 'lib/uri/http.rb')
| -rw-r--r-- | lib/uri/http.rb | 167 |
1 files changed, 114 insertions, 53 deletions
diff --git a/lib/uri/http.rb b/lib/uri/http.rb index 3e5b209d49..3c41cd4e93 100644 --- a/lib/uri/http.rb +++ b/lib/uri/http.rb @@ -1,76 +1,137 @@ +# frozen_string_literal: false +# = uri/http.rb # -# $Id$ +# Author:: Akira Yamada <akira@ruby-lang.org> +# License:: You can redistribute it and/or modify it under the same term as Ruby. # -# Copyright (c) 2001 akira yamada <akira@ruby-lang.org> -# You can redistribute it and/or modify it under the same term as Ruby. +# See URI for general documentation # -require 'uri/generic' +require_relative 'generic' module URI -=begin - -== URI::HTTP - -=== Super Class - -((<URI::Generic>)) - -=end - - # RFC1738 section 3.3. + # + # The syntax of HTTP URIs is defined in RFC1738 section 3.3. + # + # Note that the Ruby URI library allows HTTP URLs containing usernames and + # passwords. This is not legal as per the RFC, but used to be + # supported in Internet Explorer 5 and 6, before the MS04-004 security + # update. See <URL:http://support.microsoft.com/kb/834489>. + # class HTTP < Generic + # A Default port of 80 for URI::HTTP. DEFAULT_PORT = 80 - COMPONENT = [ - :scheme, - :userinfo, :host, :port, - :path, - :query, - :fragment + # An Array of the available components for URI::HTTP. + COMPONENT = %i[ + scheme + userinfo host port + path + query + fragment ].freeze -=begin - -=== Class Methods - ---- URI::HTTP::build - Create a new URI::HTTP object from components of URI::HTTP with - check. It is scheme, userinfo, host, port, path, query and - fragment. It provided by an Array of a Hash. - ---- URI::HTTP::new - Create a new URI::HTTP object from ``generic'' components with no - check. - -=end - + # + # == Description + # + # Creates a new URI::HTTP object from components, with syntax checking. + # + # The components accepted are userinfo, host, port, path, query, and + # fragment. + # + # The components should be provided either as an Array, or as a Hash + # with keys formed by preceding the component names with a colon. + # + # If an Array is used, the components must be passed in the + # order <code>[userinfo, host, port, path, query, fragment]</code>. + # + # Example: + # + # uri = URI::HTTP.build(host: 'www.example.com', path: '/foo/bar') + # + # uri = URI::HTTP.build([nil, "www.example.com", nil, "/path", + # "query", 'fragment']) + # + # Currently, if passed userinfo components this method generates + # invalid HTTP URIs as per RFC 1738. + # def self.build(args) - tmp = Util::make_components_hash(self, args) - return super(tmp) - end - - def initialize(*arg) - super(*arg) + tmp = Util.make_components_hash(self, args) + super(tmp) end -=begin + # Do not allow empty host names, as they are not allowed by RFC 3986. + def check_host(v) + ret = super -=== Instance Methods + if ret && v.empty? + raise InvalidComponentError, + "bad component(expected host component): #{v}" + end ---- URI::HTTP#request_uri + ret + end -=end + # + # == Description + # + # Returns the full path for an HTTP request, as required by Net::HTTP::Get. + # + # If the URI contains a query, the full path is URI#path + '?' + URI#query. + # Otherwise, the path is simply URI#path. + # + # Example: + # + # uri = URI::HTTP.build(path: '/foo/bar', query: 'test=true') + # uri.request_uri # => "/foo/bar?test=true" + # def request_uri - r = path_query - if r[0] != ?/ - r = '/' + r + return unless @path + + url = @query ? "#@path?#@query" : @path.dup + url.start_with?(?/.freeze) ? url : ?/ + url + end + + # + # == Description + # + # Returns the authority for an HTTP uri, as defined in + # https://www.rfc-editor.org/rfc/rfc3986#section-3.2. + # + # + # Example: + # + # URI::HTTP.build(host: 'www.example.com', path: '/foo/bar').authority #=> "www.example.com" + # URI::HTTP.build(host: 'www.example.com', port: 8000, path: '/foo/bar').authority #=> "www.example.com:8000" + # URI::HTTP.build(host: 'www.example.com', port: 80, path: '/foo/bar').authority #=> "www.example.com" + # + def authority + if port == default_port + host + else + "#{host}:#{port}" end + end - r + # + # == Description + # + # Returns the origin for an HTTP uri, as defined in + # https://www.rfc-editor.org/rfc/rfc6454. + # + # + # Example: + # + # URI::HTTP.build(host: 'www.example.com', path: '/foo/bar').origin #=> "http://www.example.com" + # URI::HTTP.build(host: 'www.example.com', port: 8000, path: '/foo/bar').origin #=> "http://www.example.com:8000" + # URI::HTTP.build(host: 'www.example.com', port: 80, path: '/foo/bar').origin #=> "http://www.example.com" + # URI::HTTPS.build(host: 'www.example.com', path: '/foo/bar').origin #=> "https://www.example.com" + # + def origin + "#{scheme}://#{authority}" end - end # HTTP + end - @@schemes['HTTP'] = HTTP -end # URI + register_scheme 'HTTP', HTTP +end |