diff options
author | Matt Muller <mamuller@amazon.com> | 2020-02-21 13:55:07 -0800 |
---|---|---|
committer | Hiroshi SHIBATA <hsbt@ruby-lang.org> | 2020-03-26 18:06:14 +0900 |
commit | 92a238a21caa6e8c9e4823b8bee67e37a362a9f8 (patch) | |
tree | 18918830458573b5bd9573c3156e5836fff473e3 /lib | |
parent | 844ff7ea45b79e95eaed4b725fd0cf5c33874058 (diff) | |
download | ruby-92a238a21caa6e8c9e4823b8bee67e37a362a9f8.tar.gz |
[ruby/uri] Add support for WebSockets
https://github.com/ruby/uri/commit/805a95786a
Diffstat (limited to 'lib')
-rw-r--r-- | lib/uri/ws.rb | 85 | ||||
-rw-r--r-- | lib/uri/wss.rb | 23 |
2 files changed, 108 insertions, 0 deletions
diff --git a/lib/uri/ws.rb b/lib/uri/ws.rb new file mode 100644 index 0000000000..45ef62ff8c --- /dev/null +++ b/lib/uri/ws.rb @@ -0,0 +1,85 @@ +# frozen_string_literal: false +# = uri/ws.rb +# +# Author:: Matt Muller <mamuller@amazon.com> +# License:: You can redistribute it and/or modify it under the same term as Ruby. +# Revision:: $Id$ +# +# See URI for general documentation +# + +require_relative 'generic' + +module URI + + # + # The syntax of WS URIs is defined in RFC6455 section 3. + # + # Note that the Ruby URI library allows WS 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 WS < Generic + # A Default port of 80 for URI::WS. + DEFAULT_PORT = 80 + + # An Array of the available components for URI::WS. + COMPONENT = %i[ + scheme + userinfo host port + path + query + ].freeze + + # + # == Description + # + # Creates a new URI::WS object from components, with syntax checking. + # + # The components accepted are userinfo, host, port, path, and query. + # + # 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]</code>. + # + # Example: + # + # uri = URI::WS.build(host: 'www.example.com', path: '/foo/bar') + # + # uri = URI::WS.build([nil, "www.example.com", nil, "/path", "query"]) + # + # Currently, if passed userinfo components this method generates + # invalid WS URIs as per RFC 1738. + # + def self.build(args) + tmp = Util.make_components_hash(self, args) + super(tmp) + end + + # + # == Description + # + # Returns the full path for a WS URI, 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::WS.build(path: '/foo/bar', query: 'test=true') + # uri.request_uri # => "/foo/bar?test=true" + # + def request_uri + return unless @path + + url = @query ? "#@path?#@query" : @path.dup + url.start_with?(?/.freeze) ? url : ?/ + url + end + end + + @@schemes['WS'] = WS + +end diff --git a/lib/uri/wss.rb b/lib/uri/wss.rb new file mode 100644 index 0000000000..ab78a58869 --- /dev/null +++ b/lib/uri/wss.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: false +# = uri/wss.rb +# +# Author:: Matt Muller <mamuller@amazon.com> +# License:: You can redistribute it and/or modify it under the same term as Ruby. +# Revision:: $Id$ +# +# See URI for general documentation +# + +require_relative 'ws' + +module URI + + # The default port for WSS URIs is 443, and the scheme is 'wss:' rather + # than 'ws:'. Other than that, WSS URIs are identical to WS URIs; + # see URI::WS. + class WSS < WS + # A Default port of 443 for URI::WSS + DEFAULT_PORT = 443 + end + @@schemes['WSS'] = WSS +end |