RubyGems Documentation Index

': missing argument: -r (Gem::OptionParser::MissingArgument) # $ ruby optparse-test.rb -r my-library # You required my-library! # # === Type Coercion # # Gem::OptionParser supports the ability to coerce command line arguments # into objects for us. # # Gem::OptionParser comes with a few ready-to-use kinds of type # coercion. They are: # # - Date -- Anything accepted by +Date.parse+ (need to require +optparse/date+) # - DateTime -- Anything accepted by +DateTime.parse+ (need to require +optparse/date+) # - Time -- Anything accepted by +Time.httpdate+ or +Time.parse+ (need to require +optparse/time+) # - URI -- Anything accepted by +Gem::URI.parse+ (need to require +optparse/uri+) # - Shellwords -- Anything accepted by +Shellwords.shellwords+ (need to require +optparse/shellwords+) # - String -- Any non-empty string # - Integer -- Any integer. Will convert octal. (e.g. 124, -3, 040) # - Float -- Any float. (e.g. 10, 3.14, -100E+13) # - Numeric -- Any integer, float, or rational (1, 3.4, 1/3) # - DecimalInteger -- Like +Integer+, but no octal format. # - OctalInteger -- Like +Integer+, but no decimal format. # - DecimalNumeric -- Decimal integer or float. # - TrueClass -- Accepts '+, yes, true, -, no, false' and # defaults as +true+ # - FalseClass -- Same as +TrueClass+, but defaults to +false+ # - Array -- Strings separated by ',' (e.g. 1,2,3) # - Regexp -- Regular expressions. Also includes options. # # We can also add our own coercions, which we will cover below. # # ==== Using Built-in Conversions # # As an example, the built-in +Time+ conversion is used. The other built-in # conversions behave in the same way. # Gem::OptionParser will attempt to parse the argument # as a +Time+. If it succeeds, that time will be passed to the # handler block. Otherwise, an exception will be raised. # # require 'rubygems/vendor/optparse/lib/optparse' # require 'rubygems/vendor/optparse/lib/optparse/time' # Gem::OptionParser.new do |parser| # parser.on("-t", "--time [TIME]", Time, "Begin execution at given time") do |time| # p time # end # end.parse! # # Used: # # $ ruby optparse-test.rb -t nonsense # ... invalid argument: -t nonsense (Gem::OptionParser::InvalidArgument) # $ ruby optparse-test.rb -t 10-11-12 # 2010-11-12 00:00:00 -0500 # $ ruby optparse-test.rb -t 9:30 # 2014-08-13 09:30:00 -0400 # # ==== Creating Custom Conversions # # The +accept+ method on Gem::OptionParser may be used to create converters. # It specifies which conversion block to call whenever a class is specified. # The example below uses it to fetch a +User+ object before the +on+ handler receives it. # # require 'rubygems/vendor/optparse/lib/optparse' # # User = Struct.new(:id, :name) # # def find_user id # not_found = ->{ raise "No User Found for id #{id}" } # [ User.new(1, "Sam"), # User.new(2, "Gandalf") ].find(not_found) do |u| # u.id == id # end # end # # op = Gem::OptionParser.new # op.accept(User) do |user_id| # find_user user_id.to_i # end # # op.on("--user ID", User) do |user| # puts user # end # # op.parse! # # Used: # # $ ruby optparse-test.rb --user 1 # # # $ ruby optparse-test.rb --user 2 # # # $ ruby optparse-test.rb --user 3 # optparse-test.rb:15:in `block in find_user': No User Found for id 3 (RuntimeError) # # === Store options to a Hash # # The +into+ option of +order+, +parse+ and so on methods stores command line options into a Hash. # # require 'rubygems/vendor/optparse/lib/optparse' # # options = {} # Gem::OptionParser.new do |parser| # parser.on('-a') # parser.on('-b NUM', Integer) # parser.on('-v', '--verbose') # end.parse!(into: options) # # p options # # Used: # # $ ruby optparse-test.rb -a # {:a=>true} # $ ruby optparse-test.rb -a -v # {:a=>true, :verbose=>true} # $ ruby optparse-test.rb -a -b 100 # {:a=>true, :b=>100} # # === Complete example # # The following example is a complete Ruby program. You can run it and see the # effect of specifying various options. This is probably the best way to learn # the features of +optparse+. # # require 'rubygems/vendor/optparse/lib/optparse' # require 'rubygems/vendor/optparse/lib/optparse/time' # require 'ostruct' # require 'pp' # # class OptparseExample # Version = '1.0.0' # # CODES = %w[iso-2022-jp shift_jis euc-jp utf8 binary] # CODE_ALIASES = { "jis" => "iso-2022-jp", "sjis" => "shift_jis" } # # class ScriptOptions # attr_accessor :library, :inplace, :encoding, :transfer_type, # :verbose, :extension, :delay, :time, :record_separator, # :list # # def initialize # self.library = [] # self.inplace = false # self.encoding = "utf8" # self.transfer_type = :auto # self.verbose = false # end # # def define_options(parser) # parser.banner = "Usage: example.rb [options]" # parser.separator "" # parser.separator "Specific options:" # # # add additional options # perform_inplace_option(parser) # delay_execution_option(parser) # execute_at_time_option(parser) # specify_record_separator_option(parser) # list_example_option(parser) # specify_encoding_option(parser) # optional_option_argument_with_keyword_completion_option(parser) # boolean_verbose_option(parser) # # parser.separator "" # parser.separator "Common options:" # # No argument, shows at tail. This will print an options summary. # # Try it and see! # parser.on_tail("-h", "--help", "Show this message") do # puts parser # exit # end # # Another typical switch to print the version. # parser.on_tail("--version", "Show version") do # puts Version # exit # end # end # # def perform_inplace_option(parser) # # Specifies an optional option argument # parser.on("-i", "--inplace [EXTENSION]", # "Edit ARGV files in place", # "(make backup if EXTENSION supplied)") do |ext| # self.inplace = true # self.extension = ext || '' # self.extension.sub!(/\A\.?(?=.)/, ".") # Ensure extension begins with dot. # end # end # # def delay_execution_option(parser) # # Cast 'delay' argument to a Float. # parser.on("--delay N", Float, "Delay N seconds before executing") do |n| # self.delay = n # end # end # # def execute_at_time_option(parser) # # Cast 'time' argument to a Time object. # parser.on("-t", "--time [TIME]", Time, "Begin execution at given time") do |time| # self.time = time # end # end # # def specify_record_separator_option(parser) # # Cast to octal integer. # parser.on("-F", "--irs [OCTAL]", Gem::OptionParser::OctalInteger, # "Specify record separator (default \\0)") do |rs| # self.record_separator = rs # end # end # # def list_example_option(parser) # # List of arguments. # parser.on("--list x,y,z", Array, "Example 'list' of arguments") do |list| # self.list = list # end # end # # def specify_encoding_option(parser) # # Keyword completion. We are specifying a specific set of arguments (CODES # # and CODE_ALIASES - notice the latter is a Hash), and the user may provide # # the shortest unambiguous text. # code_list = (CODE_ALIASES.keys + CODES).join(', ') # parser.on("--code CODE", CODES, CODE_ALIASES, "Select encoding", # "(#{code_list})") do |encoding| # self.encoding = encoding # end # end # # def optional_option_argument_with_keyword_completion_option(parser) # # Optional '--type' option argument with keyword completion. # parser.on("--type [TYPE]", [:text, :binary, :auto], # "Select transfer type (text, binary, auto)") do |t| # self.transfer_type = t # end # end # # def boolean_verbose_option(parser) # # Boolean switch. # parser.on("-v", "--[no-]verbose", "Run verbosely") do |v| # self.verbose = v # end # end # end # # # # # Return a structure describing the options. # # # def parse(args) # # The options specified on the command line will be collected in # # *options*. # # @options = ScriptOptions.new # @args = Gem::OptionParser.new do |parser| # @options.define_options(parser) # parser.parse!(args) # end # @options # end # # attr_reader :parser, :options # end # class OptparseExample # # example = OptparseExample.new # options = example.parse(ARGV) # pp options # example.options # pp ARGV # # === Shell Completion # # For modern shells (e.g. bash, zsh, etc.), you can use shell # completion for command line options. # # === Further documentation # # The above examples, along with the accompanying # {Tutorial}[optparse/tutorial.rdoc], # should be enough to learn how to use this class. # If you have any questions, file a ticket at http://bugs.ruby-lang.org. # class Gem::OptionParser Gem::OptionParser::Version = "0.4.0" # :stopdoc: NoArgument = [NO_ARGUMENT = :NONE, nil].freeze RequiredArgument = [REQUIRED_ARGUMENT = :REQUIRED, true].freeze OptionalArgument = [OPTIONAL_ARGUMENT = :OPTIONAL, false].freeze # :startdoc: # # Keyword completion module. This allows partial arguments to be specified # and resolved against a list of acceptable values. # module Completion def self.regexp(key, icase) Regexp.new('\A' + Regexp.quote(key).gsub(/\w+\b/, '\&\w*'), icase) end def self.candidate(key, icase = false, pat = nil, &block) pat ||= Completion.regexp(key, icase) candidates = [] block.call do |k, *v| (if Regexp === k kn = "" k === key else kn = defined?(k.id2name) ? k.id2name : k pat === kn end) or next v << k if v.empty? candidates << [k, v, kn] end candidates end def candidate(key, icase = false, pat = nil) Completion.candidate(key, icase, pat, &method(:each)) end public def complete(key, icase = false, pat = nil) candidates = candidate(key, icase, pat, &method(:each)).sort_by {|k, v, kn| kn.size} if candidates.size == 1 canon, sw, * = candidates[0] elsif candidates.size > 1 canon, sw, cn = candidates.shift candidates.each do |k, v, kn| next if sw == v if String === cn and String === kn if cn.rindex(kn, 0) canon, sw, cn = k, v, kn next elsif kn.rindex(cn, 0) next end end throw :ambiguous, key end end if canon block_given? or return key, *sw yield(key, *sw) end end def convert(opt = nil, val = nil, *) val end end # # Map from option/keyword string to object with completion. # class OptionMap < Hash include Completion end # # Individual switch class. Not important to the user. # # Defined within Switch are several Switch-derived classes: NoArgument, # RequiredArgument, etc. # class Switch attr_reader :pattern, :conv, :short, :long, :arg, :desc, :block # # Guesses argument style from +arg+. Returns corresponding # Gem::OptionParser::Switch class (OptionalArgument, etc.). # def self.guess(arg) case arg when "" t = self when /\A=?\[/ t = Switch::OptionalArgument when /\A\s+\[/ t = Switch::PlacedArgument else t = Switch::RequiredArgument end self >= t or incompatible_argument_styles(arg, t) t end def self.incompatible_argument_styles(arg, t) raise(ArgumentError, "#{arg}: incompatible argument styles\n #{self}, #{t}", ParseError.filter_backtrace(caller(2))) end def self.pattern NilClass end def initialize(pattern = nil, conv = nil, short = nil, long = nil, arg = nil, desc = ([] if short or long), block = nil, &_block) raise if Array === pattern block ||= _block @pattern, @conv, @short, @long, @arg, @desc, @block = pattern, conv, short, long, arg, desc, block end # # Parses +arg+ and returns rest of +arg+ and matched portion to the # argument pattern. Yields when the pattern doesn't match substring. # def parse_arg(arg) # :nodoc: pattern or return nil, [arg] unless m = pattern.match(arg) yield(InvalidArgument, arg) return arg, [] end if String === m m = [s = m] else m = m.to_a s = m[0] return nil, m unless String === s end raise InvalidArgument, arg unless arg.rindex(s, 0) return nil, m if s.length == arg.length yield(InvalidArgument, arg) # didn't match whole arg return arg[s.length..-1], m end private :parse_arg # # Parses argument, converts and returns +arg+, +block+ and result of # conversion. Yields at semi-error condition instead of raising an # exception. # def conv_arg(arg, val = []) # :nodoc: if conv val = conv.call(*val) else val = proc {|v| v}.call(*val) end return arg, block, val end private :conv_arg # # Produces the summary text. Each line of the summary is yielded to the # block (without newline). # # +sdone+:: Already summarized short style options keyed hash. # +ldone+:: Already summarized long style options keyed hash. # +width+:: Width of left side (option part). In other words, the right # side (description part) starts after +width+ columns. # +max+:: Maximum width of left side -> the options are filled within # +max+ columns. # +indent+:: Prefix string indents all summarized lines. # def summarize(sdone = {}, ldone = {}, width = 1, max = width - 1, indent = "") sopts, lopts = [], [], nil @short.each {|s| sdone.fetch(s) {sopts << s}; sdone[s] = true} if @short @long.each {|s| ldone.fetch(s) {lopts << s}; ldone[s] = true} if @long return if sopts.empty? and lopts.empty? # completely hidden left = [sopts.join(', ')] right = desc.dup while s = lopts.shift l = left[-1].length + s.length l += arg.length if left.size == 1 && arg l < max or sopts.empty? or left << +'' left[-1] << (left[-1].empty? ? ' ' * 4 : ', ') << s end if arg left[0] << (left[1] ? arg.sub(/\A(\[?)=/, '\1') + ',' : arg) end mlen = left.collect {|ss| ss.length}.max.to_i while mlen > width and l = left.shift mlen = left.collect {|ss| ss.length}.max.to_i if l.length == mlen if l.length < width and (r = right[0]) and !r.empty? l = l.to_s.ljust(width) + ' ' + r right.shift end yield(indent + l) end while begin l = left.shift; r = right.shift; l or r end l = l.to_s.ljust(width) + ' ' + r if r and !r.empty? yield(indent + l) end self end def add_banner(to) # :nodoc: unless @short or @long s = desc.join to << " [" + s + "]..." unless s.empty? end to end def match_nonswitch?(str) # :nodoc: @pattern =~ str unless @short or @long end # # Main name of the switch. # def switch_name (long.first || short.first).sub(/\A-+(?:\[no-\])?/, '') end def compsys(sdone, ldone) # :nodoc: sopts, lopts = [], [] @short.each {|s| sdone.fetch(s) {sopts << s}; sdone[s] = true} if @short @long.each {|s| ldone.fetch(s) {lopts << s}; ldone[s] = true} if @long return if sopts.empty? and lopts.empty? # completely hidden (sopts+lopts).each do |opt| # "(-x -c -r)-l[left justify]" if /^--\[no-\](.+)$/ =~ opt o = $1 yield("--#{o}", desc.join("")) yield("--no-#{o}", desc.join("")) else yield("#{opt}", desc.join("")) end end end def pretty_print_contents(q) # :nodoc: if @block q.text ":" + @block.source_location.join(":") + ":" first = false else first = true end [@short, @long].each do |list| list.each do |opt| if first q.text ":" first = false end q.breakable q.text opt end end end def pretty_print(q) # :nodoc: q.object_group(self) {pretty_print_contents(q)} end # # Switch that takes no arguments. # class NoArgument < self # # Raises an exception if any arguments given. # def parse(arg, argv) yield(NeedlessArgument, arg) if arg conv_arg(arg) end def self.incompatible_argument_styles(*) end def self.pattern Object end def pretty_head # :nodoc: "NoArgument" end end # # Switch that takes an argument. # class RequiredArgument < self # # Raises an exception if argument is not present. # def parse(arg, argv) unless arg raise MissingArgument if argv.empty? arg = argv.shift end conv_arg(*parse_arg(arg, &method(:raise))) end def pretty_head # :nodoc: "Required" end end # # Switch that can omit argument. # class OptionalArgument < self # # Parses argument if given, or uses default value. # def parse(arg, argv, &error) if arg conv_arg(*parse_arg(arg, &error)) else conv_arg(arg) end end def pretty_head # :nodoc: "Optional" end end # # Switch that takes an argument, which does not begin with '-' or is '-'. # class PlacedArgument < self # # Returns nil if argument is not present or begins with '-' and is not '-'. # def parse(arg, argv, &error) if !(val = arg) and (argv.empty? or /\A-./ =~ (val = argv[0])) return nil, block, nil end opt = (val = parse_arg(val, &error))[1] val = conv_arg(*val) if opt and !arg argv.shift else val[0] = nil end val end def pretty_head # :nodoc: "Placed" end end end # # Simple option list providing mapping from short and/or long option # string to Gem::OptionParser::Switch and mapping from acceptable argument to # matching pattern and converter pair. Also provides summary feature. # class List # Map from acceptable argument types to pattern and converter pairs. attr_reader :atype # Map from short style option switches to actual switch objects. attr_reader :short # Map from long style option switches to actual switch objects. attr_reader :long # List of all switches and summary string. attr_reader :list # # Just initializes all instance variables. # def initialize @atype = {} @short = OptionMap.new @long = OptionMap.new @list = [] end def pretty_print(q) # :nodoc: q.group(1, "(", ")") do @list.each do |sw| next unless Switch === sw q.group(1, "(" + sw.pretty_head, ")") do sw.pretty_print_contents(q) end end end end # # See Gem::OptionParser.accept. # def accept(t, pat = /.*/m, &block) if pat pat.respond_to?(:match) or raise TypeError, "has no `match'", ParseError.filter_backtrace(caller(2)) else pat = t if t.respond_to?(:match) end unless block block = pat.method(:convert).to_proc if pat.respond_to?(:convert) end @atype[t] = [pat, block] end # # See Gem::OptionParser.reject. # def reject(t) @atype.delete(t) end # # Adds +sw+ according to +sopts+, +lopts+ and +nlopts+. # # +sw+:: Gem::OptionParser::Switch instance to be added. # +sopts+:: Short style option list. # +lopts+:: Long style option list. # +nlopts+:: Negated long style options list. # def update(sw, sopts, lopts, nsw = nil, nlopts = nil) # :nodoc: sopts.each {|o| @short[o] = sw} if sopts lopts.each {|o| @long[o] = sw} if lopts nlopts.each {|o| @long[o] = nsw} if nsw and nlopts used = @short.invert.update(@long.invert) @list.delete_if {|o| Switch === o and !used[o]} end private :update # # Inserts +switch+ at the head of the list, and associates short, long # and negated long options. Arguments are: # # +switch+:: Gem::OptionParser::Switch instance to be inserted. # +short_opts+:: List of short style options. # +long_opts+:: List of long style options. # +nolong_opts+:: List of long style options with "no-" prefix. # # prepend(switch, short_opts, long_opts, nolong_opts) # def prepend(*args) update(*args) @list.unshift(args[0]) end # # Appends +switch+ at the tail of the list, and associates short, long # and negated long options. Arguments are: # # +switch+:: Gem::OptionParser::Switch instance to be inserted. # +short_opts+:: List of short style options. # +long_opts+:: List of long style options. # +nolong_opts+:: List of long style options with "no-" prefix. # # append(switch, short_opts, long_opts, nolong_opts) # def append(*args) update(*args) @list.push(args[0]) end # # Searches +key+ in +id+ list. The result is returned or yielded if a # block is given. If it isn't found, nil is returned. # def search(id, key) if list = __send__(id) val = list.fetch(key) {return nil} block_given? ? yield(val) : val end end # # Searches list +id+ for +opt+ and the optional patterns for completion # +pat+. If +icase+ is true, the search is case insensitive. The result # is returned or yielded if a block is given. If it isn't found, nil is # returned. # def complete(id, opt, icase = false, *pat, &block) __send__(id).complete(opt, icase, *pat, &block) end def get_candidates(id) yield __send__(id).keys end # # Iterates over each option, passing the option to the +block+. # def each_option(&block) list.each(&block) end # # Creates the summary table, passing each line to the +block+ (without # newline). The arguments +args+ are passed along to the summarize # method which is called on every option. # def summarize(*args, &block) sum = [] list.reverse_each do |opt| if opt.respond_to?(:summarize) # perhaps Gem::OptionParser::Switch s = [] opt.summarize(*args) {|l| s << l} sum.concat(s.reverse) elsif !opt or opt.empty? sum << "" elsif opt.respond_to?(:each_line) sum.concat([*opt.each_line].reverse) else sum.concat([*opt.each].reverse) end end sum.reverse_each(&block) end def add_banner(to) # :nodoc: list.each do |opt| if opt.respond_to?(:add_banner) opt.add_banner(to) end end to end def compsys(*args, &block) # :nodoc: list.each do |opt| if opt.respond_to?(:compsys) opt.compsys(*args, &block) end end end end # # Hash with completion search feature. See Gem::OptionParser::Completion. # class CompletingHash < Hash include Completion # # Completion for hash key. # def match(key) *values = fetch(key) { raise AmbiguousArgument, catch(:ambiguous) {return complete(key)} } return key, *values end end # :stopdoc: # # Enumeration of acceptable argument styles. Possible values are: # # NO_ARGUMENT:: The switch takes no arguments. (:NONE) # REQUIRED_ARGUMENT:: The switch requires an argument. (:REQUIRED) # OPTIONAL_ARGUMENT:: The switch requires an optional argument. (:OPTIONAL) # # Use like --switch=argument (long style) or -Xargument (short style). For # short style, only portion matched to argument pattern is treated as # argument. # ArgumentStyle = {} NoArgument.each {|el| ArgumentStyle[el] = Switch::NoArgument} RequiredArgument.each {|el| ArgumentStyle[el] = Switch::RequiredArgument} OptionalArgument.each {|el| ArgumentStyle[el] = Switch::OptionalArgument} ArgumentStyle.freeze # # Switches common used such as '--', and also provides default # argument classes # DefaultList = List.new DefaultList.short['-'] = Switch::NoArgument.new {} DefaultList.long[''] = Switch::NoArgument.new {throw :terminate} COMPSYS_HEADER = <<'XXX' # :nodoc: typeset -A opt_args local context state line _arguments -s -S \ XXX def compsys(to, name = File.basename($0)) # :nodoc: to << "#compdef #{name}\n" to << COMPSYS_HEADER visit(:compsys, {}, {}) {|o, d| to << %Q[ "#{o}[#{d.gsub(/[\"\[\]]/, '\\\\\&')}]" \\\n] } to << " '*:file:_files' && return 0\n" end # # Default options for ARGV, which never appear in option summary. # Officious = {} # # --help # Shows option summary. # Officious['help'] = proc do |parser| Switch::NoArgument.new do |arg| puts parser.help exit end end # # --*-completion-bash=WORD # Shows candidates for command line completion. # Officious['*-completion-bash'] = proc do |parser| Switch::RequiredArgument.new do |arg| puts parser.candidate(arg) exit end end # # --*-completion-zsh[=NAME:FILE] # Creates zsh completion file. # Officious['*-completion-zsh'] = proc do |parser| Switch::OptionalArgument.new do |arg| parser.compsys(STDOUT, arg) exit end end # # --version # Shows version string if Version is defined. # Officious['version'] = proc do |parser| Switch::OptionalArgument.new do |pkg| if pkg begin require_relative 'optparse/version' rescue LoadError else show_version(*pkg.split(/,/)) or abort("#{parser.program_name}: no version found in package #{pkg}") exit end end v = parser.ver or abort("#{parser.program_name}: version unknown") puts v exit end end # :startdoc: # # Class methods # # # Initializes a new instance and evaluates the optional block in context # of the instance. Arguments +args+ are passed to #new, see there for # description of parameters. # # This method is *deprecated*, its behavior corresponds to the older #new # method. # def self.with(*args, &block) opts = new(*args) opts.instance_eval(&block) opts end # # Returns an incremented value of +default+ according to +arg+. # def self.inc(arg, default = nil) case arg when Integer arg.nonzero? when nil default.to_i + 1 end end def inc(*args) self.class.inc(*args) end # # Initializes the instance and yields itself if called with a block. # # +banner+:: Banner message. # +width+:: Summary width. # +indent+:: Summary indent. # def initialize(banner = nil, width = 32, indent = ' ' * 4) @stack = [DefaultList, List.new, List.new] @program_name = nil @banner = banner @summary_width = width @summary_indent = indent @default_argv = ARGV @require_exact = false @raise_unknown = true add_officious yield self if block_given? end def add_officious # :nodoc: list = base() Officious.each do |opt, block| list.long[opt] ||= block.call(self) end end # # Terminates option parsing. Optional parameter +arg+ is a string pushed # back to be the first non-option argument. # def terminate(arg = nil) self.class.terminate(arg) end def self.terminate(arg = nil) throw :terminate, arg end @stack = [DefaultList] def self.top() DefaultList end # # Directs to accept specified class +t+. The argument string is passed to # the block in which it should be converted to the desired class. # # +t+:: Argument class specifier, any object including Class. # +pat+:: Pattern for argument, defaults to +t+ if it responds to match. # # accept(t, pat, &block) # def accept(*args, &blk) top.accept(*args, &blk) end # # See #accept. # def self.accept(*args, &blk) top.accept(*args, &blk) end # # Directs to reject specified class argument. # # +t+:: Argument class specifier, any object including Class. # # reject(t) # def reject(*args, &blk) top.reject(*args, &blk) end # # See #reject. # def self.reject(*args, &blk) top.reject(*args, &blk) end # # Instance methods # # Heading banner preceding summary. attr_writer :banner # Program name to be emitted in error message and default banner, # defaults to $0. attr_writer :program_name # Width for option list portion of summary. Must be Numeric. attr_accessor :summary_width # Indentation for summary. Must be String (or have + String method). attr_accessor :summary_indent # Strings to be parsed in default. attr_accessor :default_argv # Whether to require that options match exactly (disallows providing # abbreviated long option as short option). attr_accessor :require_exact # Whether to raise at unknown option. attr_accessor :raise_unknown # # Heading banner preceding summary. # def banner unless @banner @banner = +"Usage: #{program_name} [options]" visit(:add_banner, @banner) end @banner end # # Program name to be emitted in error message and default banner, defaults # to $0. # def program_name @program_name || File.basename($0, '.*') end # for experimental cascading :-) alias set_banner banner= alias set_program_name program_name= alias set_summary_width summary_width= alias set_summary_indent summary_indent= # Version attr_writer :version # Release code attr_writer :release # # Version # def version (defined?(@version) && @version) || (defined?(::Version) && ::Version) end # # Release code # def release (defined?(@release) && @release) || (defined?(::Release) && ::Release) || (defined?(::RELEASE) && ::RELEASE) end # # Returns version string from program_name, version and release. # def ver if v = version str = +"#{program_name} #{[v].join('.')}" str << " (#{v})" if v = release str end end def warn(mesg = $!) super("#{program_name}: #{mesg}") end def abort(mesg = $!) super("#{program_name}: #{mesg}") end # # Subject of #on / #on_head, #accept / #reject # def top @stack[-1] end # # Subject of #on_tail. # def base @stack[1] end # # Pushes a new List. # def new @stack.push(List.new) if block_given? yield self else self end end # # Removes the last List. # def remove @stack.pop end # # Puts option summary into +to+ and returns +to+. Yields each line if # a block is given. # # +to+:: Output destination, which must have method <<. Defaults to []. # +width+:: Width of left side, defaults to @summary_width. # +max+:: Maximum length allowed for left side, defaults to +width+ - 1. # +indent+:: Indentation, defaults to @summary_indent. # def summarize(to = [], width = @summary_width, max = width - 1, indent = @summary_indent, &blk) nl = "\n" blk ||= proc {|l| to << (l.index(nl, -1) ? l : l + nl)} visit(:summarize, {}, {}, width, max, indent, &blk) to end # # Returns option summary string. # def help; summarize("#{banner}".sub(/\n?\z/, "\n")) end alias to_s help def pretty_print(q) # :nodoc: q.object_group(self) do first = true if @stack.size > 2 @stack.each_with_index do |s, i| next if i < 2 next if s.list.empty? if first first = false q.text ":" end q.breakable s.pretty_print(q) end end end end def inspect # :nodoc: require 'pp' pretty_print_inspect end # # Returns option summary list. # def to_a; summarize("#{banner}".split(/^/)) end # # Checks if an argument is given twice, in which case an ArgumentError is # raised. Called from Gem::OptionParser#switch only. # # +obj+:: New argument. # +prv+:: Previously specified argument. # +msg+:: Exception message. # def notwice(obj, prv, msg) # :nodoc: unless !prv or prv == obj raise(ArgumentError, "argument #{msg} given twice: #{obj}", ParseError.filter_backtrace(caller(2))) end obj end private :notwice SPLAT_PROC = proc {|*a| a.length <= 1 ? a.first : a} # :nodoc: # :call-seq: # make_switch(params, block = nil) # # :include: ../doc/optparse/creates_option.rdoc # def make_switch(opts, block = nil) short, long, nolong, style, pattern, conv, not_pattern, not_conv, not_style = [], [], [] ldesc, sdesc, desc, arg = [], [], [] default_style = Switch::NoArgument default_pattern = nil klass = nil q, a = nil has_arg = false opts.each do |o| # argument class next if search(:atype, o) do |pat, c| klass = notwice(o, klass, 'type') if not_style and not_style != Switch::NoArgument not_pattern, not_conv = pat, c else default_pattern, conv = pat, c end end # directly specified pattern(any object possible to match) if (!(String === o || Symbol === o)) and o.respond_to?(:match) pattern = notwice(o, pattern, 'pattern') if pattern.respond_to?(:convert) conv = pattern.method(:convert).to_proc else conv = SPLAT_PROC end next end # anything others case o when Proc, Method block = notwice(o, block, 'block') when Array, Hash case pattern when CompletingHash when nil pattern = CompletingHash.new conv = pattern.method(:convert).to_proc if pattern.respond_to?(:convert) else raise ArgumentError, "argument pattern given twice" end o.each {|pat, *v| pattern[pat] = v.fetch(0) {pat}} when Module raise ArgumentError, "unsupported argument type: #{o}", ParseError.filter_backtrace(caller(4)) when *ArgumentStyle.keys style = notwice(ArgumentStyle[o], style, 'style') when /^--no-([^\[\]=\s]*)(.+)?/ q, a = $1, $2 o = notwice(a ? Object : TrueClass, klass, 'type') not_pattern, not_conv = search(:atype, o) unless not_style not_style = (not_style || default_style).guess(arg = a) if a default_style = Switch::NoArgument default_pattern, conv = search(:atype, FalseClass) unless default_pattern ldesc << "--no-#{q}" (q = q.downcase).tr!('_', '-') long << "no-#{q}" nolong << q when /^--\[no-\]([^\[\]=\s]*)(.+)?/ q, a = $1, $2 o = notwice(a ? Object : TrueClass, klass, 'type') if a default_style = default_style.guess(arg = a) default_pattern, conv = search(:atype, o) unless default_pattern end ldesc << "--[no-]#{q}" (o = q.downcase).tr!('_', '-') long << o not_pattern, not_conv = search(:atype, FalseClass) unless not_style not_style = Switch::NoArgument nolong << "no-#{o}" when /^--([^\[\]=\s]*)(.+)?/ q, a = $1, $2 if a o = notwice(NilClass, klass, 'type') default_style = default_style.guess(arg = a) default_pattern, conv = search(:atype, o) unless default_pattern end ldesc << "--#{q}" (o = q.downcase).tr!('_', '-') long << o when /^-(\[\^?\]?(?:[^\\\]]|\\.)*\])(.+)?/ q, a = $1, $2 o = notwice(Object, klass, 'type') if a default_style = default_style.guess(arg = a) default_pattern, conv = search(:atype, o) unless default_pattern else has_arg = true end sdesc << "-#{q}" short << Regexp.new(q) when /^-(.)(.+)?/ q, a = $1, $2 if a o = notwice(NilClass, klass, 'type') default_style = default_style.guess(arg = a) default_pattern, conv = search(:atype, o) unless default_pattern end sdesc << "-#{q}" short << q when /^=/ style = notwice(default_style.guess(arg = o), style, 'style') default_pattern, conv = search(:atype, Object) unless default_pattern else desc.push(o) if o && !o.empty? end end default_pattern, conv = search(:atype, default_style.pattern) unless default_pattern if !(short.empty? and long.empty?) if has_arg and default_style == Switch::NoArgument default_style = Switch::RequiredArgument end s = (style || default_style).new(pattern || default_pattern, conv, sdesc, ldesc, arg, desc, block) elsif !block if style or pattern raise ArgumentError, "no switch given", ParseError.filter_backtrace(caller) end s = desc else short << pattern s = (style || default_style).new(pattern, conv, nil, nil, arg, desc, block) end return s, short, long, (not_style.new(not_pattern, not_conv, sdesc, ldesc, nil, desc, block) if not_style), nolong end # :call-seq: # define(*params, &block) # # :include: ../doc/optparse/creates_option.rdoc # def define(*opts, &block) top.append(*(sw = make_switch(opts, block))) sw[0] end # :call-seq: # on(*params, &block) # # :include: ../doc/optparse/creates_option.rdoc # def on(*opts, &block) define(*opts, &block) self end alias def_option define # :call-seq: # define_head(*params, &block) # # :include: ../doc/optparse/creates_option.rdoc # def define_head(*opts, &block) top.prepend(*(sw = make_switch(opts, block))) sw[0] end # :call-seq: # on_head(*params, &block) # # :include: ../doc/optparse/creates_option.rdoc # # The new option is added at the head of the summary. # def on_head(*opts, &block) define_head(*opts, &block) self end alias def_head_option define_head # :call-seq: # define_tail(*params, &block) # # :include: ../doc/optparse/creates_option.rdoc # def define_tail(*opts, &block) base.append(*(sw = make_switch(opts, block))) sw[0] end # # :call-seq: # on_tail(*params, &block) # # :include: ../doc/optparse/creates_option.rdoc # # The new option is added at the tail of the summary. # def on_tail(*opts, &block) define_tail(*opts, &block) self end alias def_tail_option define_tail # # Add separator in summary. # def separator(string) top.append(string, nil, nil) end # # Parses command line arguments +argv+ in order. When a block is given, # each non-option argument is yielded. When optional +into+ keyword # argument is provided, the parsed option values are stored there via # []= method (so it can be Hash, or OpenStruct, or other # similar object). # # Returns the rest of +argv+ left unparsed. # def order(*argv, into: nil, &nonopt) argv = argv[0].dup if argv.size == 1 and Array === argv[0] order!(argv, into: into, &nonopt) end # # Same as #order, but removes switches destructively. # Non-option arguments remain in +argv+. # def order!(argv = default_argv, into: nil, &nonopt) setter = ->(name, val) {into[name.to_sym] = val} if into parse_in_order(argv, setter, &nonopt) end def parse_in_order(argv = default_argv, setter = nil, &nonopt) # :nodoc: opt, arg, val, rest = nil nonopt ||= proc {|a| throw :terminate, a} argv.unshift(arg) if arg = catch(:terminate) { while arg = argv.shift case arg # long option when /\A--([^=]*)(?:=(.*))?/m opt, rest = $1, $2 opt.tr!('_', '-') begin sw, = complete(:long, opt, true) if require_exact && !sw.long.include?(arg) throw :terminate, arg unless raise_unknown raise InvalidOption, arg end rescue ParseError throw :terminate, arg unless raise_unknown raise $!.set_option(arg, true) end begin opt, cb, val = sw.parse(rest, argv) {|*exc| raise(*exc)} val = cb.call(val) if cb setter.call(sw.switch_name, val) if setter rescue ParseError raise $!.set_option(arg, rest) end # short option when /\A-(.)((=).*|.+)?/m eq, rest, opt = $3, $2, $1 has_arg, val = eq, rest begin sw, = search(:short, opt) unless sw begin sw, = complete(:short, opt) # short option matched. val = arg.delete_prefix('-') has_arg = true rescue InvalidOption raise if require_exact # if no short options match, try completion with long # options. sw, = complete(:long, opt) eq ||= !rest end end rescue ParseError throw :terminate, arg unless raise_unknown raise $!.set_option(arg, true) end begin opt, cb, val = sw.parse(val, argv) {|*exc| raise(*exc) if eq} rescue ParseError raise $!.set_option(arg, arg.length > 2) else raise InvalidOption, arg if has_arg and !eq and arg == "-#{opt}" end begin argv.unshift(opt) if opt and (!rest or (opt = opt.sub(/\A-*/, '-')) != '-') val = cb.call(val) if cb setter.call(sw.switch_name, val) if setter rescue ParseError raise $!.set_option(arg, arg.length > 2) end # non-option argument else catch(:prune) do visit(:each_option) do |sw0| sw = sw0 sw.block.call(arg) if Switch === sw and sw.match_nonswitch?(arg) end nonopt.call(arg) end end end nil } visit(:search, :short, nil) {|sw| sw.block.call(*argv) if !sw.pattern} argv end private :parse_in_order # # Parses command line arguments +argv+ in permutation mode and returns # list of non-option arguments. When optional +into+ keyword # argument is provided, the parsed option values are stored there via # []= method (so it can be Hash, or OpenStruct, or other # similar object). # def permute(*argv, into: nil) argv = argv[0].dup if argv.size == 1 and Array === argv[0] permute!(argv, into: into) end # # Same as #permute, but removes switches destructively. # Non-option arguments remain in +argv+. # def permute!(argv = default_argv, into: nil) nonopts = [] order!(argv, into: into, &nonopts.method(:<<)) argv[0, 0] = nonopts argv end # # Parses command line arguments +argv+ in order when environment variable # POSIXLY_CORRECT is set, and in permutation mode otherwise. # When optional +into+ keyword argument is provided, the parsed option # values are stored there via []= method (so it can be Hash, # or OpenStruct, or other similar object). # def parse(*argv, into: nil) argv = argv[0].dup if argv.size == 1 and Array === argv[0] parse!(argv, into: into) end # # Same as #parse, but removes switches destructively. # Non-option arguments remain in +argv+. # def parse!(argv = default_argv, into: nil) if ENV.include?('POSIXLY_CORRECT') order!(argv, into: into) else permute!(argv, into: into) end end # # Wrapper method for getopts.rb. # # params = ARGV.getopts("ab:", "foo", "bar:", "zot:Z;zot option") # # params["a"] = true # -a # # params["b"] = "1" # -b1 # # params["foo"] = "1" # --foo # # params["bar"] = "x" # --bar x # # params["zot"] = "z" # --zot Z # # Option +symbolize_names+ (boolean) specifies whether returned Hash keys should be Symbols; defaults to +false+ (use Strings). # # params = ARGV.getopts("ab:", "foo", "bar:", "zot:Z;zot option", symbolize_names: true) # # params[:a] = true # -a # # params[:b] = "1" # -b1 # # params[:foo] = "1" # --foo # # params[:bar] = "x" # --bar x # # params[:zot] = "z" # --zot Z # def getopts(*args, symbolize_names: false) argv = Array === args.first ? args.shift : default_argv single_options, *long_options = *args result = {} single_options.scan(/(.)(:)?/) do |opt, val| if val result[opt] = nil define("-#{opt} VAL") else result[opt] = false define("-#{opt}") end end if single_options long_options.each do |arg| arg, desc = arg.split(';', 2) opt, val = arg.split(':', 2) if val result[opt] = val.empty? ? nil : val define("--#{opt}=#{result[opt] || "VAL"}", *[desc].compact) else result[opt] = false define("--#{opt}", *[desc].compact) end end parse_in_order(argv, result.method(:[]=)) symbolize_names ? result.transform_keys(&:to_sym) : result end # # See #getopts. # def self.getopts(*args, symbolize_names: false) new.getopts(*args, symbolize_names: symbolize_names) end # # Traverses @stack, sending each element method +id+ with +args+ and # +block+. # def visit(id, *args, &block) # :nodoc: @stack.reverse_each do |el| el.__send__(id, *args, &block) end nil end private :visit # # Searches +key+ in @stack for +id+ hash and returns or yields the result. # def search(id, key) # :nodoc: block_given = block_given? visit(:search, id, key) do |k| return block_given ? yield(k) : k end end private :search # # Completes shortened long style option switch and returns pair of # canonical switch and switch descriptor Gem::OptionParser::Switch. # # +typ+:: Searching table. # +opt+:: Searching key. # +icase+:: Search case insensitive if true. # +pat+:: Optional pattern for completion. # def complete(typ, opt, icase = false, *pat) # :nodoc: if pat.empty? search(typ, opt) {|sw| return [sw, opt]} # exact match or... end ambiguous = catch(:ambiguous) { visit(:complete, typ, opt, icase, *pat) {|o, *sw| return sw} } exc = ambiguous ? AmbiguousOption : InvalidOption raise exc.new(opt, additional: self.method(:additional_message).curry[typ]) end private :complete # # Returns additional info. # def additional_message(typ, opt) return unless typ and opt and defined?(DidYouMean::SpellChecker) all_candidates = [] visit(:get_candidates, typ) do |candidates| all_candidates.concat(candidates) end all_candidates.select! {|cand| cand.is_a?(String) } checker = DidYouMean::SpellChecker.new(dictionary: all_candidates) DidYouMean.formatter.message_for(all_candidates & checker.correct(opt)) end def candidate(word) list = [] case word when '-' long = short = true when /\A--/ word, arg = word.split(/=/, 2) argpat = Completion.regexp(arg, false) if arg and !arg.empty? long = true when /\A-/ short = true end pat = Completion.regexp(word, long) visit(:each_option) do |opt| next unless Switch === opt opts = (long ? opt.long : []) + (short ? opt.short : []) opts = Completion.candidate(word, true, pat, &opts.method(:each)).map(&:first) if pat if /\A=/ =~ opt.arg opts.map! {|sw| sw + "="} if arg and CompletingHash === opt.pattern if opts = opt.pattern.candidate(arg, false, argpat) opts.map!(&:last) end end end list.concat(opts) end list end # # Loads options from file names as +filename+. Does nothing when the file # is not present. Returns whether successfully loaded. # # +filename+ defaults to basename of the program without suffix in a # directory ~/.options, then the basename with '.options' suffix # under XDG and Haiku standard places. # # The optional +into+ keyword argument works exactly like that accepted in # method #parse. # def load(filename = nil, into: nil) unless filename basename = File.basename($0, '.*') return true if load(File.expand_path(basename, '~/.options'), into: into) rescue nil basename << ".options" return [ # XDG ENV['XDG_CONFIG_HOME'], '~/.config', *ENV['XDG_CONFIG_DIRS']&.split(File::PATH_SEPARATOR), # Haiku '~/config/settings', ].any? {|dir| next if !dir or dir.empty? load(File.expand_path(basename, dir), into: into) rescue nil } end begin parse(*File.readlines(filename, chomp: true), into: into) true rescue Errno::ENOENT, Errno::ENOTDIR false end end # # Parses environment variable +env+ or its uppercase with splitting like a # shell. # # +env+ defaults to the basename of the program. # def environment(env = File.basename($0, '.*')) env = ENV[env] || ENV[env.upcase] or return require 'shellwords' parse(*Shellwords.shellwords(env)) end # # Acceptable argument classes # # # Any string and no conversion. This is fall-back. # accept(Object) {|s,|s or s.nil?} accept(NilClass) {|s,|s} # # Any non-empty string, and no conversion. # accept(String, /.+/m) {|s,*|s} # # Ruby/C-like integer, octal for 0-7 sequence, binary for 0b, hexadecimal # for 0x, and decimal for others; with optional sign prefix. Converts to # Integer. # decimal = '\d+(?:_\d+)*' binary = 'b[01]+(?:_[01]+)*' hex = 'x[\da-f]+(?:_[\da-f]+)*' octal = "0(?:[0-7]+(?:_[0-7]+)*|#{binary}|#{hex})?" integer = "#{octal}|#{decimal}" accept(Integer, %r"\A[-+]?(?:#{integer})\z"io) {|s,| begin Integer(s) rescue ArgumentError raise Gem::OptionParser::InvalidArgument, s end if s } # # Float number format, and converts to Float. # float = "(?:#{decimal}(?=(.)?)(?:\\.(?:#{decimal})?)?|\\.#{decimal})(?:E[-+]?#{decimal})?" floatpat = %r"\A[-+]?#{float}\z"io accept(Float, floatpat) {|s,| s.to_f if s} # # Generic numeric format, converts to Integer for integer format, Float # for float format, and Rational for rational format. # real = "[-+]?(?:#{octal}|#{float})" accept(Numeric, /\A(#{real})(?:\/(#{real}))?\z/io) {|s, d, f, n,| if n Rational(d, n) elsif f Float(s) else Integer(s) end } # # Decimal integer format, to be converted to Integer. # DecimalInteger = /\A[-+]?#{decimal}\z/io accept(DecimalInteger, DecimalInteger) {|s,| begin Integer(s, 10) rescue ArgumentError raise Gem::OptionParser::InvalidArgument, s end if s } # # Ruby/C like octal/hexadecimal/binary integer format, to be converted to # Integer. # OctalInteger = /\A[-+]?(?:[0-7]+(?:_[0-7]+)*|0(?:#{binary}|#{hex}))\z/io accept(OctalInteger, OctalInteger) {|s,| begin Integer(s, 8) rescue ArgumentError raise Gem::OptionParser::InvalidArgument, s end if s } # # Decimal integer/float number format, to be converted to Integer for # integer format, Float for float format. # DecimalNumeric = floatpat # decimal integer is allowed as float also. accept(DecimalNumeric, floatpat) {|s, f| begin if f Float(s) else Integer(s) end rescue ArgumentError raise Gem::OptionParser::InvalidArgument, s end if s } # # Boolean switch, which means whether it is present or not, whether it is # absent or not with prefix no-, or it takes an argument # yes/no/true/false/+/-. # yesno = CompletingHash.new %w[- no false].each {|el| yesno[el] = false} %w[+ yes true].each {|el| yesno[el] = true} yesno['nil'] = false # should be nil? accept(TrueClass, yesno) {|arg, val| val == nil or val} # # Similar to TrueClass, but defaults to false. # accept(FalseClass, yesno) {|arg, val| val != nil and val} # # List of strings separated by ",". # accept(Array) do |s, | if s s = s.split(',').collect {|ss| ss unless ss.empty?} end s end # # Regular expression with options. # accept(Regexp, %r"\A/((?:\\.|[^\\])*)/([[:alpha:]]+)?\z|.*") do |all, s, o| f = 0 if o f |= Regexp::IGNORECASE if /i/ =~ o f |= Regexp::MULTILINE if /m/ =~ o f |= Regexp::EXTENDED if /x/ =~ o case o = o.delete("imx") when "" when "u" s = s.encode(Encoding::UTF_8) when "e" s = s.encode(Encoding::EUC_JP) when "s" s = s.encode(Encoding::SJIS) when "n" f |= Regexp::NOENCODING else raise Gem::OptionParser::InvalidArgument, "unknown regexp option - #{o}" end else s ||= all end Regexp.new(s, f) end # # Exceptions # # # Base class of exceptions from Gem::OptionParser. # class ParseError < RuntimeError # Reason which caused the error. Reason = 'parse error' def initialize(*args, additional: nil) @additional = additional @arg0, = args @args = args @reason = nil end attr_reader :args attr_writer :reason attr_accessor :additional # # Pushes back erred argument(s) to +argv+. # def recover(argv) argv[0, 0] = @args argv end def self.filter_backtrace(array) unless $DEBUG array.delete_if(&%r"\A#{Regexp.quote(__FILE__)}:"o.method(:=~)) end array end def set_backtrace(array) super(self.class.filter_backtrace(array)) end def set_option(opt, eq) if eq @args[0] = opt else @args.unshift(opt) end self end # # Returns error reason. Override this for I18N. # def reason @reason || self.class::Reason end def inspect "#<#{self.class}: #{args.join(' ')}>" end # # Default stringizing method to emit standard error message. # def message "#{reason}: #{args.join(' ')}#{additional[@arg0] if additional}" end alias to_s message end # # Raises when ambiguously completable string is encountered. # class AmbiguousOption < ParseError const_set(:Reason, 'ambiguous option') end # # Raises when there is an argument for a switch which takes no argument. # class NeedlessArgument < ParseError const_set(:Reason, 'needless argument') end # # Raises when a switch with mandatory argument has no argument. # class MissingArgument < ParseError const_set(:Reason, 'missing argument') end # # Raises when switch is undefined. # class InvalidOption < ParseError const_set(:Reason, 'invalid option') end # # Raises when the given argument does not match required format. # class InvalidArgument < ParseError const_set(:Reason, 'invalid argument') end # # Raises when the given argument word can't be completed uniquely. # class AmbiguousArgument < InvalidArgument const_set(:Reason, 'ambiguous argument') end # # Miscellaneous # # # Extends command line arguments array (ARGV) to parse itself. # module Arguable # # Sets Gem::OptionParser object, when +opt+ is +false+ or +nil+, methods # Gem::OptionParser::Arguable#options and Gem::OptionParser::Arguable#options= are # undefined. Thus, there is no ways to access the Gem::OptionParser object # via the receiver object. # def options=(opt) unless @optparse = opt class << self undef_method(:options) undef_method(:options=) end end end # # Actual Gem::OptionParser object, automatically created if nonexistent. # # If called with a block, yields the Gem::OptionParser object and returns the # result of the block. If an Gem::OptionParser::ParseError exception occurs # in the block, it is rescued, a error message printed to STDERR and # +nil+ returned. # def options @optparse ||= Gem::OptionParser.new @optparse.default_argv = self block_given? or return @optparse begin yield @optparse rescue ParseError @optparse.warn $! nil end end # # Parses +self+ destructively in order and returns +self+ containing the # rest arguments left unparsed. # def order!(&blk) options.order!(self, &blk) end # # Parses +self+ destructively in permutation mode and returns +self+ # containing the rest arguments left unparsed. # def permute!() options.permute!(self) end # # Parses +self+ destructively and returns +self+ containing the # rest arguments left unparsed. # def parse!() options.parse!(self) end # # Substitution of getopts is possible as follows. Also see # Gem::OptionParser#getopts. # # def getopts(*args) # ($OPT = ARGV.getopts(*args)).each do |opt, val| # eval "$OPT_#{opt.gsub(/[^A-Za-z0-9_]/, '_')} = val" # end # rescue Gem::OptionParser::ParseError # end # def getopts(*args, symbolize_names: false) options.getopts(self, *args, symbolize_names: symbolize_names) end # # Initializes instance variable. # def self.extend_object(obj) super obj.instance_eval {@optparse = nil} end def initialize(*args) super @optparse = nil end end # # Acceptable argument classes. Now contains DecimalInteger, OctalInteger # and DecimalNumeric. See Acceptable argument classes (in source code). # module Acceptables const_set(:DecimalInteger, Gem::OptionParser::DecimalInteger) const_set(:OctalInteger, Gem::OptionParser::OctalInteger) const_set(:DecimalNumeric, Gem::OptionParser::DecimalNumeric) end end # ARGV is arguable by Gem::OptionParser ARGV.extend(Gem::OptionParser::Arguable) PK!ï_k#"")rubygems/vendor/net-http/lib/net/https.rbnu„[µü¤# frozen_string_literal: true =begin = net/https -- SSL/TLS enhancement for Gem::Net::HTTP. This file has been merged with net/http. There is no longer any need to require_relative 'https' to use HTTPS. See Gem::Net::HTTP for details on how to make HTTPS connections. == Info 'OpenSSL for Ruby 2' project Copyright (C) 2001 GOTOU Yuuzou All rights reserved. == Licence This program is licensed under the same licence as Ruby. (See the file 'LICENCE'.) =end require_relative 'http' require 'openssl' PK!´Ú$‘±S±S(rubygems/vendor/net-http/lib/net/http.rbnu„[µü¤# frozen_string_literal: true # # = net/http.rb # # Copyright (c) 1999-2007 Yukihiro Matsumoto # Copyright (c) 1999-2007 Minero Aoki # Copyright (c) 2001 GOTOU Yuuzou # # Written and maintained by Minero Aoki . # HTTPS support added by GOTOU Yuuzou . # # This file is derived from "http-access.rb". # # Documented by Minero Aoki; converted to RDoc by William Webber. # # This program is free software. You can re-distribute and/or # modify this program under the same terms of ruby itself --- # Ruby Distribution License or GNU General Public License. # # See Gem::Net::HTTP for an overview and examples. # require_relative '../../../net-protocol/lib/net/protocol' require_relative '../../../uri/lib/uri' require_relative '../../../resolv/lib/resolv' autoload :OpenSSL, 'openssl' module Gem::Net #:nodoc: # :stopdoc: class HTTPBadResponse < StandardError; end class HTTPHeaderSyntaxError < StandardError; end # :startdoc: # \Class \Gem::Net::HTTP provides a rich library that implements the client # in a client-server model that uses the \HTTP request-response protocol. # For information about \HTTP, see: # # - {Hypertext Transfer Protocol}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol]. # - {Technical overview}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Technical_overview]. # # == About the Examples # # :include: doc/net-http/examples.rdoc # # == Strategies # # - If you will make only a few GET requests, # consider using {OpenURI}[rdoc-ref:OpenURI]. # - If you will make only a few requests of all kinds, # consider using the various singleton convenience methods in this class. # Each of the following methods automatically starts and finishes # a {session}[rdoc-ref:Gem::Net::HTTP@Sessions] that sends a single request: # # # Return string response body. # Gem::Net::HTTP.get(hostname, path) # Gem::Net::HTTP.get(uri) # # # Write string response body to $stdout. # Gem::Net::HTTP.get_print(hostname, path) # Gem::Net::HTTP.get_print(uri) # # # Return response as Gem::Net::HTTPResponse object. # Gem::Net::HTTP.get_response(hostname, path) # Gem::Net::HTTP.get_response(uri) # data = '{"title": "foo", "body": "bar", "userId": 1}' # Gem::Net::HTTP.post(uri, data) # params = {title: 'foo', body: 'bar', userId: 1} # Gem::Net::HTTP.post_form(uri, params) # # - If performance is important, consider using sessions, which lower request overhead. # This {session}[rdoc-ref:Gem::Net::HTTP@Sessions] has multiple requests for # {HTTP methods}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods] # and {WebDAV methods}[https://en.wikipedia.org/wiki/WebDAV#Implementation]: # # Gem::Net::HTTP.start(hostname) do |http| # # Session started automatically before block execution. # http.get(path) # http.head(path) # body = 'Some text' # http.post(path, body) # Can also have a block. # http.put(path, body) # http.delete(path) # http.options(path) # http.trace(path) # http.patch(path, body) # Can also have a block. # http.copy(path) # http.lock(path, body) # http.mkcol(path, body) # http.move(path) # http.propfind(path, body) # http.proppatch(path, body) # http.unlock(path, body) # # Session finished automatically at block exit. # end # # The methods cited above are convenience methods that, via their few arguments, # allow minimal control over the requests. # For greater control, consider using {request objects}[rdoc-ref:Gem::Net::HTTPRequest]. # # == URIs # # On the internet, a URI # ({Universal Resource Identifier}[https://en.wikipedia.org/wiki/Uniform_Resource_Identifier]) # is a string that identifies a particular resource. # It consists of some or all of: scheme, hostname, path, query, and fragment; # see {URI syntax}[https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#Syntax]. # # A Ruby {Gem::URI::Generic}[rdoc-ref:Gem::URI::Generic] object # represents an internet URI. # It provides, among others, methods # +scheme+, +hostname+, +path+, +query+, and +fragment+. # # === Schemes # # An internet \Gem::URI has # a {scheme}[https://en.wikipedia.org/wiki/List_of_URI_schemes]. # # The two schemes supported in \Gem::Net::HTTP are 'https' and 'http': # # uri.scheme # => "https" # Gem::URI('http://example.com').scheme # => "http" # # === Hostnames # # A hostname identifies a server (host) to which requests may be sent: # # hostname = uri.hostname # => "jsonplaceholder.typicode.com" # Gem::Net::HTTP.start(hostname) do |http| # # Some HTTP stuff. # end # # === Paths # # A host-specific path identifies a resource on the host: # # _uri = uri.dup # _uri.path = '/todos/1' # hostname = _uri.hostname # path = _uri.path # Gem::Net::HTTP.get(hostname, path) # # === Queries # # A host-specific query adds name/value pairs to the URI: # # _uri = uri.dup # params = {userId: 1, completed: false} # _uri.query = Gem::URI.encode_www_form(params) # _uri # => # # Gem::Net::HTTP.get(_uri) # # === Fragments # # A {URI fragment}[https://en.wikipedia.org/wiki/URI_fragment] has no effect # in \Gem::Net::HTTP; # the same data is returned, regardless of whether a fragment is included. # # == Request Headers # # Request headers may be used to pass additional information to the host, # similar to arguments passed in a method call; # each header is a name/value pair. # # Each of the \Gem::Net::HTTP methods that sends a request to the host # has optional argument +headers+, # where the headers are expressed as a hash of field-name/value pairs: # # headers = {Accept: 'application/json', Connection: 'Keep-Alive'} # Gem::Net::HTTP.get(uri, headers) # # See lists of both standard request fields and common request fields at # {Request Fields}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Request_fields]. # A host may also accept other custom fields. # # == \HTTP Sessions # # A _session_ is a connection between a server (host) and a client that: # # - Is begun by instance method Gem::Net::HTTP#start. # - May contain any number of requests. # - Is ended by instance method Gem::Net::HTTP#finish. # # See example sessions at {Strategies}[rdoc-ref:Gem::Net::HTTP@Strategies]. # # === Session Using \Gem::Net::HTTP.start # # If you have many requests to make to a single host (and port), # consider using singleton method Gem::Net::HTTP.start with a block; # the method handles the session automatically by: # # - Calling #start before block execution. # - Executing the block. # - Calling #finish after block execution. # # In the block, you can use these instance methods, # each of which that sends a single request: # # - {HTTP methods}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods]: # # - #get, #request_get: GET. # - #head, #request_head: HEAD. # - #post, #request_post: POST. # - #delete: DELETE. # - #options: OPTIONS. # - #trace: TRACE. # - #patch: PATCH. # # - {WebDAV methods}[https://en.wikipedia.org/wiki/WebDAV#Implementation]: # # - #copy: COPY. # - #lock: LOCK. # - #mkcol: MKCOL. # - #move: MOVE. # - #propfind: PROPFIND. # - #proppatch: PROPPATCH. # - #unlock: UNLOCK. # # === Session Using \Gem::Net::HTTP.start and \Gem::Net::HTTP.finish # # You can manage a session manually using methods #start and #finish: # # http = Gem::Net::HTTP.new(hostname) # http.start # http.get('/todos/1') # http.get('/todos/2') # http.delete('/posts/1') # http.finish # Needed to free resources. # # === Single-Request Session # # Certain convenience methods automatically handle a session by: # # - Creating an \HTTP object # - Starting a session. # - Sending a single request. # - Finishing the session. # - Destroying the object. # # Such methods that send GET requests: # # - ::get: Returns the string response body. # - ::get_print: Writes the string response body to $stdout. # - ::get_response: Returns a Gem::Net::HTTPResponse object. # # Such methods that send POST requests: # # - ::post: Posts data to the host. # - ::post_form: Posts form data to the host. # # == \HTTP Requests and Responses # # Many of the methods above are convenience methods, # each of which sends a request and returns a string # without directly using \Gem::Net::HTTPRequest and \Gem::Net::HTTPResponse objects. # # You can, however, directly create a request object, send the request, # and retrieve the response object; see: # # - Gem::Net::HTTPRequest. # - Gem::Net::HTTPResponse. # # == Following Redirection # # Each returned response is an instance of a subclass of Gem::Net::HTTPResponse. # See the {response class hierarchy}[rdoc-ref:Gem::Net::HTTPResponse@Response+Subclasses]. # # In particular, class Gem::Net::HTTPRedirection is the parent # of all redirection classes. # This allows you to craft a case statement to handle redirections properly: # # def fetch(uri, limit = 10) # # You should choose a better exception. # raise ArgumentError, 'Too many HTTP redirects' if limit == 0 # # res = Gem::Net::HTTP.get_response(Gem::URI(uri)) # case res # when Gem::Net::HTTPSuccess # Any success class. # res # when Gem::Net::HTTPRedirection # Any redirection class. # location = res['Location'] # warn "Redirected to #{location}" # fetch(location, limit - 1) # else # Any other class. # res.value # end # end # # fetch(uri) # # == Basic Authentication # # Basic authentication is performed according to # {RFC2617}[http://www.ietf.org/rfc/rfc2617.txt]: # # req = Gem::Net::HTTP::Get.new(uri) # req.basic_auth('user', 'pass') # res = Gem::Net::HTTP.start(hostname) do |http| # http.request(req) # end # # == Streaming Response Bodies # # By default \Gem::Net::HTTP reads an entire response into memory. If you are # handling large files or wish to implement a progress bar you can instead # stream the body directly to an IO. # # Gem::Net::HTTP.start(hostname) do |http| # req = Gem::Net::HTTP::Get.new(uri) # http.request(req) do |res| # open('t.tmp', 'w') do |f| # res.read_body do |chunk| # f.write chunk # end # end # end # end # # == HTTPS # # HTTPS is enabled for an \HTTP connection by Gem::Net::HTTP#use_ssl=: # # Gem::Net::HTTP.start(hostname, :use_ssl => true) do |http| # req = Gem::Net::HTTP::Get.new(uri) # res = http.request(req) # end # # Or if you simply want to make a GET request, you may pass in a URI # object that has an \HTTPS URL. \Gem::Net::HTTP automatically turns on TLS # verification if the URI object has a 'https' :URI scheme: # # uri # => # # Gem::Net::HTTP.get(uri) # # == Proxy Server # # An \HTTP object can have # a {proxy server}[https://en.wikipedia.org/wiki/Proxy_server]. # # You can create an \HTTP object with a proxy server # using method Gem::Net::HTTP.new or method Gem::Net::HTTP.start. # # The proxy may be defined either by argument +p_addr+ # or by environment variable 'http_proxy'. # # === Proxy Using Argument +p_addr+ as a \String # # When argument +p_addr+ is a string hostname, # the returned +http+ has the given host as its proxy: # # http = Gem::Net::HTTP.new(hostname, nil, 'proxy.example') # http.proxy? # => true # http.proxy_from_env? # => false # http.proxy_address # => "proxy.example" # # These use default values. # http.proxy_port # => 80 # http.proxy_user # => nil # http.proxy_pass # => nil # # The port, username, and password for the proxy may also be given: # # http = Gem::Net::HTTP.new(hostname, nil, 'proxy.example', 8000, 'pname', 'ppass') # # => # # http.proxy? # => true # http.proxy_from_env? # => false # http.proxy_address # => "proxy.example" # http.proxy_port # => 8000 # http.proxy_user # => "pname" # http.proxy_pass # => "ppass" # # === Proxy Using 'ENV['http_proxy']' # # When environment variable 'http_proxy' # is set to a \Gem::URI string, # the returned +http+ will have the server at that URI as its proxy; # note that the \Gem::URI string must have a protocol # such as 'http' or 'https': # # ENV['http_proxy'] = 'http://example.com' # http = Gem::Net::HTTP.new(hostname) # http.proxy? # => true # http.proxy_from_env? # => true # http.proxy_address # => "example.com" # # These use default values. # http.proxy_port # => 80 # http.proxy_user # => nil # http.proxy_pass # => nil # # The \Gem::URI string may include proxy username, password, and port number: # # ENV['http_proxy'] = 'http://pname:ppass@example.com:8000' # http = Gem::Net::HTTP.new(hostname) # http.proxy? # => true # http.proxy_from_env? # => true # http.proxy_address # => "example.com" # http.proxy_port # => 8000 # http.proxy_user # => "pname" # http.proxy_pass # => "ppass" # # === Filtering Proxies # # With method Gem::Net::HTTP.new (but not Gem::Net::HTTP.start), # you can use argument +p_no_proxy+ to filter proxies: # # - Reject a certain address: # # http = Gem::Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'proxy.example') # http.proxy_address # => nil # # - Reject certain domains or subdomains: # # http = Gem::Net::HTTP.new('example.com', nil, 'my.proxy.example', 8000, 'pname', 'ppass', 'proxy.example') # http.proxy_address # => nil # # - Reject certain addresses and port combinations: # # http = Gem::Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'proxy.example:1234') # http.proxy_address # => "proxy.example" # # http = Gem::Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'proxy.example:8000') # http.proxy_address # => nil # # - Reject a list of the types above delimited using a comma: # # http = Gem::Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'my.proxy,proxy.example:8000') # http.proxy_address # => nil # # http = Gem::Net::HTTP.new('example.com', nil, 'my.proxy', 8000, 'pname', 'ppass', 'my.proxy,proxy.example:8000') # http.proxy_address # => nil # # == Compression and Decompression # # \Gem::Net::HTTP does not compress the body of a request before sending. # # By default, \Gem::Net::HTTP adds header 'Accept-Encoding' # to a new {request object}[rdoc-ref:Gem::Net::HTTPRequest]: # # Gem::Net::HTTP::Get.new(uri)['Accept-Encoding'] # # => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3" # # This requests the server to zip-encode the response body if there is one; # the server is not required to do so. # # \Gem::Net::HTTP does not automatically decompress a response body # if the response has header 'Content-Range'. # # Otherwise decompression (or not) depends on the value of header # {Content-Encoding}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-encoding-response-header]: # # - 'deflate', 'gzip', or 'x-gzip': # decompresses the body and deletes the header. # - 'none' or 'identity': # does not decompress the body, but deletes the header. # - Any other value: # leaves the body and header unchanged. # # == What's Here # # This is a categorized summary of methods and attributes. # # === \Gem::Net::HTTP Objects # # - {::new}[rdoc-ref:Gem::Net::HTTP.new]: # Creates a new instance. # - {#inspect}[rdoc-ref:Gem::Net::HTTP#inspect]: # Returns a string representation of +self+. # # === Sessions # # - {::start}[rdoc-ref:Gem::Net::HTTP.start]: # Begins a new session in a new \Gem::Net::HTTP object. # - {#started?}[rdoc-ref:Gem::Net::HTTP#started?] # (aliased as {#active?}[rdoc-ref:Gem::Net::HTTP#active?]): # Returns whether in a session. # - {#finish}[rdoc-ref:Gem::Net::HTTP#finish]: # Ends an active session. # - {#start}[rdoc-ref:Gem::Net::HTTP#start]: # Begins a new session in an existing \Gem::Net::HTTP object (+self+). # # === Connections # # - {:continue_timeout}[rdoc-ref:Gem::Net::HTTP#continue_timeout]: # Returns the continue timeout. # - {#continue_timeout=}[rdoc-ref:Gem::Net::HTTP#continue_timeout=]: # Sets the continue timeout seconds. # - {:keep_alive_timeout}[rdoc-ref:Gem::Net::HTTP#keep_alive_timeout]: # Returns the keep-alive timeout. # - {:keep_alive_timeout=}[rdoc-ref:Gem::Net::HTTP#keep_alive_timeout=]: # Sets the keep-alive timeout. # - {:max_retries}[rdoc-ref:Gem::Net::HTTP#max_retries]: # Returns the maximum retries. # - {#max_retries=}[rdoc-ref:Gem::Net::HTTP#max_retries=]: # Sets the maximum retries. # - {:open_timeout}[rdoc-ref:Gem::Net::HTTP#open_timeout]: # Returns the open timeout. # - {:open_timeout=}[rdoc-ref:Gem::Net::HTTP#open_timeout=]: # Sets the open timeout. # - {:read_timeout}[rdoc-ref:Gem::Net::HTTP#read_timeout]: # Returns the open timeout. # - {:read_timeout=}[rdoc-ref:Gem::Net::HTTP#read_timeout=]: # Sets the read timeout. # - {:ssl_timeout}[rdoc-ref:Gem::Net::HTTP#ssl_timeout]: # Returns the ssl timeout. # - {:ssl_timeout=}[rdoc-ref:Gem::Net::HTTP#ssl_timeout=]: # Sets the ssl timeout. # - {:write_timeout}[rdoc-ref:Gem::Net::HTTP#write_timeout]: # Returns the write timeout. # - {write_timeout=}[rdoc-ref:Gem::Net::HTTP#write_timeout=]: # Sets the write timeout. # # === Requests # # - {::get}[rdoc-ref:Gem::Net::HTTP.get]: # Sends a GET request and returns the string response body. # - {::get_print}[rdoc-ref:Gem::Net::HTTP.get_print]: # Sends a GET request and write the string response body to $stdout. # - {::get_response}[rdoc-ref:Gem::Net::HTTP.get_response]: # Sends a GET request and returns a response object. # - {::post_form}[rdoc-ref:Gem::Net::HTTP.post_form]: # Sends a POST request with form data and returns a response object. # - {::post}[rdoc-ref:Gem::Net::HTTP.post]: # Sends a POST request with data and returns a response object. # - {#copy}[rdoc-ref:Gem::Net::HTTP#copy]: # Sends a COPY request and returns a response object. # - {#delete}[rdoc-ref:Gem::Net::HTTP#delete]: # Sends a DELETE request and returns a response object. # - {#get}[rdoc-ref:Gem::Net::HTTP#get]: # Sends a GET request and returns a response object. # - {#head}[rdoc-ref:Gem::Net::HTTP#head]: # Sends a HEAD request and returns a response object. # - {#lock}[rdoc-ref:Gem::Net::HTTP#lock]: # Sends a LOCK request and returns a response object. # - {#mkcol}[rdoc-ref:Gem::Net::HTTP#mkcol]: # Sends a MKCOL request and returns a response object. # - {#move}[rdoc-ref:Gem::Net::HTTP#move]: # Sends a MOVE request and returns a response object. # - {#options}[rdoc-ref:Gem::Net::HTTP#options]: # Sends a OPTIONS request and returns a response object. # - {#patch}[rdoc-ref:Gem::Net::HTTP#patch]: # Sends a PATCH request and returns a response object. # - {#post}[rdoc-ref:Gem::Net::HTTP#post]: # Sends a POST request and returns a response object. # - {#propfind}[rdoc-ref:Gem::Net::HTTP#propfind]: # Sends a PROPFIND request and returns a response object. # - {#proppatch}[rdoc-ref:Gem::Net::HTTP#proppatch]: # Sends a PROPPATCH request and returns a response object. # - {#put}[rdoc-ref:Gem::Net::HTTP#put]: # Sends a PUT request and returns a response object. # - {#request}[rdoc-ref:Gem::Net::HTTP#request]: # Sends a request and returns a response object. # - {#request_get}[rdoc-ref:Gem::Net::HTTP#request_get] # (aliased as {#get2}[rdoc-ref:Gem::Net::HTTP#get2]): # Sends a GET request and forms a response object; # if a block given, calls the block with the object, # otherwise returns the object. # - {#request_head}[rdoc-ref:Gem::Net::HTTP#request_head] # (aliased as {#head2}[rdoc-ref:Gem::Net::HTTP#head2]): # Sends a HEAD request and forms a response object; # if a block given, calls the block with the object, # otherwise returns the object. # - {#request_post}[rdoc-ref:Gem::Net::HTTP#request_post] # (aliased as {#post2}[rdoc-ref:Gem::Net::HTTP#post2]): # Sends a POST request and forms a response object; # if a block given, calls the block with the object, # otherwise returns the object. # - {#send_request}[rdoc-ref:Gem::Net::HTTP#send_request]: # Sends a request and returns a response object. # - {#trace}[rdoc-ref:Gem::Net::HTTP#trace]: # Sends a TRACE request and returns a response object. # - {#unlock}[rdoc-ref:Gem::Net::HTTP#unlock]: # Sends an UNLOCK request and returns a response object. # # === Responses # # - {:close_on_empty_response}[rdoc-ref:Gem::Net::HTTP#close_on_empty_response]: # Returns whether to close connection on empty response. # - {:close_on_empty_response=}[rdoc-ref:Gem::Net::HTTP#close_on_empty_response=]: # Sets whether to close connection on empty response. # - {:ignore_eof}[rdoc-ref:Gem::Net::HTTP#ignore_eof]: # Returns whether to ignore end-of-file when reading a response body # with Content-Length headers. # - {:ignore_eof=}[rdoc-ref:Gem::Net::HTTP#ignore_eof=]: # Sets whether to ignore end-of-file when reading a response body # with Content-Length headers. # - {:response_body_encoding}[rdoc-ref:Gem::Net::HTTP#response_body_encoding]: # Returns the encoding to use for the response body. # - {#response_body_encoding=}[rdoc-ref:Gem::Net::HTTP#response_body_encoding=]: # Sets the response body encoding. # # === Proxies # # - {:proxy_address}[rdoc-ref:Gem::Net::HTTP#proxy_address]: # Returns the proxy address. # - {:proxy_address=}[rdoc-ref:Gem::Net::HTTP#proxy_address=]: # Sets the proxy address. # - {::proxy_class?}[rdoc-ref:Gem::Net::HTTP.proxy_class?]: # Returns whether +self+ is a proxy class. # - {#proxy?}[rdoc-ref:Gem::Net::HTTP#proxy?]: # Returns whether +self+ has a proxy. # - {#proxy_address}[rdoc-ref:Gem::Net::HTTP#proxy_address] # (aliased as {#proxyaddr}[rdoc-ref:Gem::Net::HTTP#proxyaddr]): # Returns the proxy address. # - {#proxy_from_env?}[rdoc-ref:Gem::Net::HTTP#proxy_from_env?]: # Returns whether the proxy is taken from an environment variable. # - {:proxy_from_env=}[rdoc-ref:Gem::Net::HTTP#proxy_from_env=]: # Sets whether the proxy is to be taken from an environment variable. # - {:proxy_pass}[rdoc-ref:Gem::Net::HTTP#proxy_pass]: # Returns the proxy password. # - {:proxy_pass=}[rdoc-ref:Gem::Net::HTTP#proxy_pass=]: # Sets the proxy password. # - {:proxy_port}[rdoc-ref:Gem::Net::HTTP#proxy_port]: # Returns the proxy port. # - {:proxy_port=}[rdoc-ref:Gem::Net::HTTP#proxy_port=]: # Sets the proxy port. # - {#proxy_user}[rdoc-ref:Gem::Net::HTTP#proxy_user]: # Returns the proxy user name. # - {:proxy_user=}[rdoc-ref:Gem::Net::HTTP#proxy_user=]: # Sets the proxy user. # # === Security # # - {:ca_file}[rdoc-ref:Gem::Net::HTTP#ca_file]: # Returns the path to a CA certification file. # - {:ca_file=}[rdoc-ref:Gem::Net::HTTP#ca_file=]: # Sets the path to a CA certification file. # - {:ca_path}[rdoc-ref:Gem::Net::HTTP#ca_path]: # Returns the path of to CA directory containing certification files. # - {:ca_path=}[rdoc-ref:Gem::Net::HTTP#ca_path=]: # Sets the path of to CA directory containing certification files. # - {:cert}[rdoc-ref:Gem::Net::HTTP#cert]: # Returns the OpenSSL::X509::Certificate object to be used for client certification. # - {:cert=}[rdoc-ref:Gem::Net::HTTP#cert=]: # Sets the OpenSSL::X509::Certificate object to be used for client certification. # - {:cert_store}[rdoc-ref:Gem::Net::HTTP#cert_store]: # Returns the X509::Store to be used for verifying peer certificate. # - {:cert_store=}[rdoc-ref:Gem::Net::HTTP#cert_store=]: # Sets the X509::Store to be used for verifying peer certificate. # - {:ciphers}[rdoc-ref:Gem::Net::HTTP#ciphers]: # Returns the available SSL ciphers. # - {:ciphers=}[rdoc-ref:Gem::Net::HTTP#ciphers=]: # Sets the available SSL ciphers. # - {:extra_chain_cert}[rdoc-ref:Gem::Net::HTTP#extra_chain_cert]: # Returns the extra X509 certificates to be added to the certificate chain. # - {:extra_chain_cert=}[rdoc-ref:Gem::Net::HTTP#extra_chain_cert=]: # Sets the extra X509 certificates to be added to the certificate chain. # - {:key}[rdoc-ref:Gem::Net::HTTP#key]: # Returns the OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object. # - {:key=}[rdoc-ref:Gem::Net::HTTP#key=]: # Sets the OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object. # - {:max_version}[rdoc-ref:Gem::Net::HTTP#max_version]: # Returns the maximum SSL version. # - {:max_version=}[rdoc-ref:Gem::Net::HTTP#max_version=]: # Sets the maximum SSL version. # - {:min_version}[rdoc-ref:Gem::Net::HTTP#min_version]: # Returns the minimum SSL version. # - {:min_version=}[rdoc-ref:Gem::Net::HTTP#min_version=]: # Sets the minimum SSL version. # - {#peer_cert}[rdoc-ref:Gem::Net::HTTP#peer_cert]: # Returns the X509 certificate chain for the session's socket peer. # - {:ssl_version}[rdoc-ref:Gem::Net::HTTP#ssl_version]: # Returns the SSL version. # - {:ssl_version=}[rdoc-ref:Gem::Net::HTTP#ssl_version=]: # Sets the SSL version. # - {#use_ssl=}[rdoc-ref:Gem::Net::HTTP#use_ssl=]: # Sets whether a new session is to use Transport Layer Security. # - {#use_ssl?}[rdoc-ref:Gem::Net::HTTP#use_ssl?]: # Returns whether +self+ uses SSL. # - {:verify_callback}[rdoc-ref:Gem::Net::HTTP#verify_callback]: # Returns the callback for the server certification verification. # - {:verify_callback=}[rdoc-ref:Gem::Net::HTTP#verify_callback=]: # Sets the callback for the server certification verification. # - {:verify_depth}[rdoc-ref:Gem::Net::HTTP#verify_depth]: # Returns the maximum depth for the certificate chain verification. # - {:verify_depth=}[rdoc-ref:Gem::Net::HTTP#verify_depth=]: # Sets the maximum depth for the certificate chain verification. # - {:verify_hostname}[rdoc-ref:Gem::Net::HTTP#verify_hostname]: # Returns the flags for server the certification verification at the beginning of the SSL/TLS session. # - {:verify_hostname=}[rdoc-ref:Gem::Net::HTTP#verify_hostname=]: # Sets he flags for server the certification verification at the beginning of the SSL/TLS session. # - {:verify_mode}[rdoc-ref:Gem::Net::HTTP#verify_mode]: # Returns the flags for server the certification verification at the beginning of the SSL/TLS session. # - {:verify_mode=}[rdoc-ref:Gem::Net::HTTP#verify_mode=]: # Sets the flags for server the certification verification at the beginning of the SSL/TLS session. # # === Addresses and Ports # # - {:address}[rdoc-ref:Gem::Net::HTTP#address]: # Returns the string host name or host IP. # - {::default_port}[rdoc-ref:Gem::Net::HTTP.default_port]: # Returns integer 80, the default port to use for HTTP requests. # - {::http_default_port}[rdoc-ref:Gem::Net::HTTP.http_default_port]: # Returns integer 80, the default port to use for HTTP requests. # - {::https_default_port}[rdoc-ref:Gem::Net::HTTP.https_default_port]: # Returns integer 443, the default port to use for HTTPS requests. # - {#ipaddr}[rdoc-ref:Gem::Net::HTTP#ipaddr]: # Returns the IP address for the connection. # - {#ipaddr=}[rdoc-ref:Gem::Net::HTTP#ipaddr=]: # Sets the IP address for the connection. # - {:local_host}[rdoc-ref:Gem::Net::HTTP#local_host]: # Returns the string local host used to establish the connection. # - {:local_host=}[rdoc-ref:Gem::Net::HTTP#local_host=]: # Sets the string local host used to establish the connection. # - {:local_port}[rdoc-ref:Gem::Net::HTTP#local_port]: # Returns the integer local port used to establish the connection. # - {:local_port=}[rdoc-ref:Gem::Net::HTTP#local_port=]: # Sets the integer local port used to establish the connection. # - {:port}[rdoc-ref:Gem::Net::HTTP#port]: # Returns the integer port number. # # === \HTTP Version # # - {::version_1_2?}[rdoc-ref:Gem::Net::HTTP.version_1_2?] # (aliased as {::is_version_1_2?}[rdoc-ref:Gem::Net::HTTP.is_version_1_2?] # and {::version_1_2}[rdoc-ref:Gem::Net::HTTP.version_1_2]): # Returns true; retained for compatibility. # # === Debugging # # - {#set_debug_output}[rdoc-ref:Gem::Net::HTTP#set_debug_output]: # Sets the output stream for debugging. # class HTTP < Protocol # :stopdoc: VERSION = "0.4.1" HTTPVersion = '1.1' begin require 'zlib' HAVE_ZLIB=true rescue LoadError HAVE_ZLIB=false end # :startdoc: # Returns +true+; retained for compatibility. def HTTP.version_1_2 true end # Returns +true+; retained for compatibility. def HTTP.version_1_2? true end # Returns +false+; retained for compatibility. def HTTP.version_1_1? #:nodoc: false end class << HTTP alias is_version_1_1? version_1_1? #:nodoc: alias is_version_1_2? version_1_2? #:nodoc: end # :call-seq: # Gem::Net::HTTP.get_print(hostname, path, port = 80) -> nil # Gem::Net::HTTP:get_print(uri, headers = {}, port = uri.port) -> nil # # Like Gem::Net::HTTP.get, but writes the returned body to $stdout; # returns +nil+. def HTTP.get_print(uri_or_host, path_or_headers = nil, port = nil) get_response(uri_or_host, path_or_headers, port) {|res| res.read_body do |chunk| $stdout.print chunk end } nil end # :call-seq: # Gem::Net::HTTP.get(hostname, path, port = 80) -> body # Gem::Net::HTTP:get(uri, headers = {}, port = uri.port) -> body # # Sends a GET request and returns the \HTTP response body as a string. # # With string arguments +hostname+ and +path+: # # hostname = 'jsonplaceholder.typicode.com' # path = '/todos/1' # puts Gem::Net::HTTP.get(hostname, path) # # Output: # # { # "userId": 1, # "id": 1, # "title": "delectus aut autem", # "completed": false # } # # With URI object +uri+ and optional hash argument +headers+: # # uri = Gem::URI('https://jsonplaceholder.typicode.com/todos/1') # headers = {'Content-type' => 'application/json; charset=UTF-8'} # Gem::Net::HTTP.get(uri, headers) # # Related: # # - Gem::Net::HTTP::Get: request class for \HTTP method +GET+. # - Gem::Net::HTTP#get: convenience method for \HTTP method +GET+. # def HTTP.get(uri_or_host, path_or_headers = nil, port = nil) get_response(uri_or_host, path_or_headers, port).body end # :call-seq: # Gem::Net::HTTP.get_response(hostname, path, port = 80) -> http_response # Gem::Net::HTTP:get_response(uri, headers = {}, port = uri.port) -> http_response # # Like Gem::Net::HTTP.get, but returns a Gem::Net::HTTPResponse object # instead of the body string. def HTTP.get_response(uri_or_host, path_or_headers = nil, port = nil, &block) if path_or_headers && !path_or_headers.is_a?(Hash) host = uri_or_host path = path_or_headers new(host, port || HTTP.default_port).start {|http| return http.request_get(path, &block) } else uri = uri_or_host headers = path_or_headers start(uri.hostname, uri.port, :use_ssl => uri.scheme == 'https') {|http| return http.request_get(uri, headers, &block) } end end # Posts data to a host; returns a Gem::Net::HTTPResponse object. # # Argument +url+ must be a URL; # argument +data+ must be a string: # # _uri = uri.dup # _uri.path = '/posts' # data = '{"title": "foo", "body": "bar", "userId": 1}' # headers = {'content-type': 'application/json'} # res = Gem::Net::HTTP.post(_uri, data, headers) # => # # puts res.body # # Output: # # { # "title": "foo", # "body": "bar", # "userId": 1, # "id": 101 # } # # Related: # # - Gem::Net::HTTP::Post: request class for \HTTP method +POST+. # - Gem::Net::HTTP#post: convenience method for \HTTP method +POST+. # def HTTP.post(url, data, header = nil) start(url.hostname, url.port, :use_ssl => url.scheme == 'https' ) {|http| http.post(url, data, header) } end # Posts data to a host; returns a Gem::Net::HTTPResponse object. # # Argument +url+ must be a URI; # argument +data+ must be a hash: # # _uri = uri.dup # _uri.path = '/posts' # data = {title: 'foo', body: 'bar', userId: 1} # res = Gem::Net::HTTP.post_form(_uri, data) # => # # puts res.body # # Output: # # { # "title": "foo", # "body": "bar", # "userId": "1", # "id": 101 # } # def HTTP.post_form(url, params) req = Post.new(url) req.form_data = params req.basic_auth url.user, url.password if url.user start(url.hostname, url.port, :use_ssl => url.scheme == 'https' ) {|http| http.request(req) } end # # \HTTP session management # # Returns integer +80+, the default port to use for \HTTP requests: # # Gem::Net::HTTP.default_port # => 80 # def HTTP.default_port http_default_port() end # Returns integer +80+, the default port to use for \HTTP requests: # # Gem::Net::HTTP.http_default_port # => 80 # def HTTP.http_default_port 80 end # Returns integer +443+, the default port to use for HTTPS requests: # # Gem::Net::HTTP.https_default_port # => 443 # def HTTP.https_default_port 443 end def HTTP.socket_type #:nodoc: obsolete BufferedIO end # :call-seq: # HTTP.start(address, port = nil, p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil, opts) -> http # HTTP.start(address, port = nil, p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil, opts) {|http| ... } -> object # # Creates a new \Gem::Net::HTTP object, +http+, via \Gem::Net::HTTP.new: # # - For arguments +address+ and +port+, see Gem::Net::HTTP.new. # - For proxy-defining arguments +p_addr+ through +p_pass+, # see {Proxy Server}[rdoc-ref:Gem::Net::HTTP@Proxy+Server]. # - For argument +opts+, see below. # # With no block given: # # - Calls http.start with no block (see #start), # which opens a TCP connection and \HTTP session. # - Returns +http+. # - The caller should call #finish to close the session: # # http = Gem::Net::HTTP.start(hostname) # http.started? # => true # http.finish # http.started? # => false # # With a block given: # # - Calls http.start with the block (see #start), which: # # - Opens a TCP connection and \HTTP session. # - Calls the block, # which may make any number of requests to the host. # - Closes the \HTTP session and TCP connection on block exit. # - Returns the block's value +object+. # # - Returns +object+. # # Example: # # hostname = 'jsonplaceholder.typicode.com' # Gem::Net::HTTP.start(hostname) do |http| # puts http.get('/todos/1').body # puts http.get('/todos/2').body # end # # Output: # # { # "userId": 1, # "id": 1, # "title": "delectus aut autem", # "completed": false # } # { # "userId": 1, # "id": 2, # "title": "quis ut nam facilis et officia qui", # "completed": false # } # # If the last argument given is a hash, it is the +opts+ hash, # where each key is a method or accessor to be called, # and its value is the value to be set. # # The keys may include: # # - #ca_file # - #ca_path # - #cert # - #cert_store # - #ciphers # - #close_on_empty_response # - +ipaddr+ (calls #ipaddr=) # - #keep_alive_timeout # - #key # - #open_timeout # - #read_timeout # - #ssl_timeout # - #ssl_version # - +use_ssl+ (calls #use_ssl=) # - #verify_callback # - #verify_depth # - #verify_mode # - #write_timeout # # Note: If +port+ is +nil+ and opts[:use_ssl] is a truthy value, # the value passed to +new+ is Gem::Net::HTTP.https_default_port, not +port+. # def HTTP.start(address, *arg, &block) # :yield: +http+ arg.pop if opt = Hash.try_convert(arg[-1]) port, p_addr, p_port, p_user, p_pass = *arg p_addr = :ENV if arg.size < 2 port = https_default_port if !port && opt && opt[:use_ssl] http = new(address, port, p_addr, p_port, p_user, p_pass) http.ipaddr = opt[:ipaddr] if opt && opt[:ipaddr] if opt if opt[:use_ssl] opt = {verify_mode: OpenSSL::SSL::VERIFY_PEER}.update(opt) end http.methods.grep(/\A(\w+)=\z/) do |meth| key = $1.to_sym opt.key?(key) or next http.__send__(meth, opt[key]) end end http.start(&block) end class << HTTP alias newobj new # :nodoc: end # Returns a new \Gem::Net::HTTP object +http+ # (but does not open a TCP connection or \HTTP session). # # With only string argument +address+ given # (and ENV['http_proxy'] undefined or +nil+), # the returned +http+: # # - Has the given address. # - Has the default port number, Gem::Net::HTTP.default_port (80). # - Has no proxy. # # Example: # # http = Gem::Net::HTTP.new(hostname) # # => # # http.address # => "jsonplaceholder.typicode.com" # http.port # => 80 # http.proxy? # => false # # With integer argument +port+ also given, # the returned +http+ has the given port: # # http = Gem::Net::HTTP.new(hostname, 8000) # # => # # http.port # => 8000 # # For proxy-defining arguments +p_addr+ through +p_no_proxy+, # see {Proxy Server}[rdoc-ref:Gem::Net::HTTP@Proxy+Server]. # def HTTP.new(address, port = nil, p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil, p_no_proxy = nil) http = super address, port if proxy_class? then # from Gem::Net::HTTP::Proxy() http.proxy_from_env = @proxy_from_env http.proxy_address = @proxy_address http.proxy_port = @proxy_port http.proxy_user = @proxy_user http.proxy_pass = @proxy_pass elsif p_addr == :ENV then http.proxy_from_env = true else if p_addr && p_no_proxy && !Gem::URI::Generic.use_proxy?(address, address, port, p_no_proxy) p_addr = nil p_port = nil end http.proxy_address = p_addr http.proxy_port = p_port || default_port http.proxy_user = p_user http.proxy_pass = p_pass end http end # Creates a new \Gem::Net::HTTP object for the specified server address, # without opening the TCP connection or initializing the \HTTP session. # The +address+ should be a DNS hostname or IP address. def initialize(address, port = nil) # :nodoc: @address = address @port = (port || HTTP.default_port) @ipaddr = nil @local_host = nil @local_port = nil @curr_http_version = HTTPVersion @keep_alive_timeout = 2 @last_communicated = nil @close_on_empty_response = false @socket = nil @started = false @open_timeout = 60 @read_timeout = 60 @write_timeout = 60 @continue_timeout = nil @max_retries = 1 @debug_output = nil @response_body_encoding = false @ignore_eof = true @proxy_from_env = false @proxy_uri = nil @proxy_address = nil @proxy_port = nil @proxy_user = nil @proxy_pass = nil @use_ssl = false @ssl_context = nil @ssl_session = nil @sspi_enabled = false SSL_IVNAMES.each do |ivname| instance_variable_set ivname, nil end end # Returns a string representation of +self+: # # Gem::Net::HTTP.new(hostname).inspect # # => "#" # def inspect "#<#{self.class} #{@address}:#{@port} open=#{started?}>" end # *WARNING* This method opens a serious security hole. # Never use this method in production code. # # Sets the output stream for debugging: # # http = Gem::Net::HTTP.new(hostname) # File.open('t.tmp', 'w') do |file| # http.set_debug_output(file) # http.start # http.get('/nosuch/1') # http.finish # end # puts File.read('t.tmp') # # Output: # # opening connection to jsonplaceholder.typicode.com:80... # opened # <- "GET /nosuch/1 HTTP/1.1\r\nAccept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3\r\nAccept: */*\r\nUser-Agent: Ruby\r\nHost: jsonplaceholder.typicode.com\r\n\r\n" # -> "HTTP/1.1 404 Not Found\r\n" # -> "Date: Mon, 12 Dec 2022 21:14:11 GMT\r\n" # -> "Content-Type: application/json; charset=utf-8\r\n" # -> "Content-Length: 2\r\n" # -> "Connection: keep-alive\r\n" # -> "X-Powered-By: Express\r\n" # -> "X-Ratelimit-Limit: 1000\r\n" # -> "X-Ratelimit-Remaining: 999\r\n" # -> "X-Ratelimit-Reset: 1670879660\r\n" # -> "Vary: Origin, Accept-Encoding\r\n" # -> "Access-Control-Allow-Credentials: true\r\n" # -> "Cache-Control: max-age=43200\r\n" # -> "Pragma: no-cache\r\n" # -> "Expires: -1\r\n" # -> "X-Content-Type-Options: nosniff\r\n" # -> "Etag: W/\"2-vyGp6PvFo4RvsFtPoIWeCReyIC8\"\r\n" # -> "Via: 1.1 vegur\r\n" # -> "CF-Cache-Status: MISS\r\n" # -> "Server-Timing: cf-q-config;dur=1.3000000762986e-05\r\n" # -> "Report-To: {\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=yOr40jo%2BwS1KHzhTlVpl54beJ5Wx2FcG4gGV0XVrh3X9OlR5q4drUn2dkt5DGO4GDcE%2BVXT7CNgJvGs%2BZleIyMu8CLieFiDIvOviOY3EhHg94m0ZNZgrEdpKD0S85S507l1vsEwEHkoTm%2Ff19SiO\"}],\"group\":\"cf-nel\",\"max_age\":604800}\r\n" # -> "NEL: {\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}\r\n" # -> "Server: cloudflare\r\n" # -> "CF-RAY: 778977dc484ce591-DFW\r\n" # -> "alt-svc: h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400\r\n" # -> "\r\n" # reading 2 bytes... # -> "{}" # read 2 bytes # Conn keep-alive # def set_debug_output(output) warn 'Gem::Net::HTTP#set_debug_output called after HTTP started', uplevel: 1 if started? @debug_output = output end # Returns the string host name or host IP given as argument +address+ in ::new. attr_reader :address # Returns the integer port number given as argument +port+ in ::new. attr_reader :port # Sets or returns the string local host used to establish the connection; # initially +nil+. attr_accessor :local_host # Sets or returns the integer local port used to establish the connection; # initially +nil+. attr_accessor :local_port # Returns the encoding to use for the response body; # see #response_body_encoding=. attr_reader :response_body_encoding # Sets the encoding to be used for the response body; # returns the encoding. # # The given +value+ may be: # # - An Encoding object. # - The name of an encoding. # - An alias for an encoding name. # # See {Encoding}[rdoc-ref:Encoding]. # # Examples: # # http = Gem::Net::HTTP.new(hostname) # http.response_body_encoding = Encoding::US_ASCII # => # # http.response_body_encoding = 'US-ASCII' # => "US-ASCII" # http.response_body_encoding = 'ASCII' # => "ASCII" # def response_body_encoding=(value) value = Encoding.find(value) if value.is_a?(String) @response_body_encoding = value end # Sets whether to determine the proxy from environment variable # 'ENV['http_proxy']'; # see {Proxy Using ENV['http_proxy']}[rdoc-ref:Gem::Net::HTTP@Proxy+Using+-27ENV-5B-27http_proxy-27-5D-27]. attr_writer :proxy_from_env # Sets the proxy address; # see {Proxy Server}[rdoc-ref:Gem::Net::HTTP@Proxy+Server]. attr_writer :proxy_address # Sets the proxy port; # see {Proxy Server}[rdoc-ref:Gem::Net::HTTP@Proxy+Server]. attr_writer :proxy_port # Sets the proxy user; # see {Proxy Server}[rdoc-ref:Gem::Net::HTTP@Proxy+Server]. attr_writer :proxy_user # Sets the proxy password; # see {Proxy Server}[rdoc-ref:Gem::Net::HTTP@Proxy+Server]. attr_writer :proxy_pass # Returns the IP address for the connection. # # If the session has not been started, # returns the value set by #ipaddr=, # or +nil+ if it has not been set: # # http = Gem::Net::HTTP.new(hostname) # http.ipaddr # => nil # http.ipaddr = '172.67.155.76' # http.ipaddr # => "172.67.155.76" # # If the session has been started, # returns the IP address from the socket: # # http = Gem::Net::HTTP.new(hostname) # http.start # http.ipaddr # => "172.67.155.76" # http.finish # def ipaddr started? ? @socket.io.peeraddr[3] : @ipaddr end # Sets the IP address for the connection: # # http = Gem::Net::HTTP.new(hostname) # http.ipaddr # => nil # http.ipaddr = '172.67.155.76' # http.ipaddr # => "172.67.155.76" # # The IP address may not be set if the session has been started. def ipaddr=(addr) raise IOError, "ipaddr value changed, but session already started" if started? @ipaddr = addr end # Sets or returns the numeric (\Integer or \Float) number of seconds # to wait for a connection to open; # initially 60. # If the connection is not made in the given interval, # an exception is raised. attr_accessor :open_timeout # Returns the numeric (\Integer or \Float) number of seconds # to wait for one block to be read (via one read(2) call); # see #read_timeout=. attr_reader :read_timeout # Returns the numeric (\Integer or \Float) number of seconds # to wait for one block to be written (via one write(2) call); # see #write_timeout=. attr_reader :write_timeout # Sets the maximum number of times to retry an idempotent request in case of # \Gem::Net::ReadTimeout, IOError, EOFError, Errno::ECONNRESET, # Errno::ECONNABORTED, Errno::EPIPE, OpenSSL::SSL::SSLError, # Gem::Timeout::Error. # The initial value is 1. # # Argument +retries+ must be a non-negative numeric value: # # http = Gem::Net::HTTP.new(hostname) # http.max_retries = 2 # => 2 # http.max_retries # => 2 # def max_retries=(retries) retries = retries.to_int if retries < 0 raise ArgumentError, 'max_retries should be non-negative integer number' end @max_retries = retries end # Returns the maximum number of times to retry an idempotent request; # see #max_retries=. attr_reader :max_retries # Sets the read timeout, in seconds, for +self+ to integer +sec+; # the initial value is 60. # # Argument +sec+ must be a non-negative numeric value: # # http = Gem::Net::HTTP.new(hostname) # http.read_timeout # => 60 # http.get('/todos/1') # => # # http.read_timeout = 0 # http.get('/todos/1') # Raises Gem::Net::ReadTimeout. # def read_timeout=(sec) @socket.read_timeout = sec if @socket @read_timeout = sec end # Sets the write timeout, in seconds, for +self+ to integer +sec+; # the initial value is 60. # # Argument +sec+ must be a non-negative numeric value: # # _uri = uri.dup # _uri.path = '/posts' # body = 'bar' * 200000 # data = < 60 # http.post(_uri.path, data, headers) # # => # # http.write_timeout = 0 # http.post(_uri.path, data, headers) # Raises Gem::Net::WriteTimeout. # def write_timeout=(sec) @socket.write_timeout = sec if @socket @write_timeout = sec end # Returns the continue timeout value; # see continue_timeout=. attr_reader :continue_timeout # Sets the continue timeout value, # which is the number of seconds to wait for an expected 100 Continue response. # If the \HTTP object does not receive a response in this many seconds # it sends the request body. def continue_timeout=(sec) @socket.continue_timeout = sec if @socket @continue_timeout = sec end # Sets or returns the numeric (\Integer or \Float) number of seconds # to keep the connection open after a request is sent; # initially 2. # If a new request is made during the given interval, # the still-open connection is used; # otherwise the connection will have been closed # and a new connection is opened. attr_accessor :keep_alive_timeout # Sets or returns whether to ignore end-of-file when reading a response body # with Content-Length headers; # initially +true+. attr_accessor :ignore_eof # Returns +true+ if the \HTTP session has been started: # # http = Gem::Net::HTTP.new(hostname) # http.started? # => false # http.start # http.started? # => true # http.finish # => nil # http.started? # => false # # Gem::Net::HTTP.start(hostname) do |http| # http.started? # end # => true # http.started? # => false # def started? @started end alias active? started? #:nodoc: obsolete # Sets or returns whether to close the connection when the response is empty; # initially +false+. attr_accessor :close_on_empty_response # Returns +true+ if +self+ uses SSL, +false+ otherwise. # See Gem::Net::HTTP#use_ssl=. def use_ssl? @use_ssl end # Sets whether a new session is to use # {Transport Layer Security}[https://en.wikipedia.org/wiki/Transport_Layer_Security]: # # Raises IOError if attempting to change during a session. # # Raises OpenSSL::SSL::SSLError if the port is not an HTTPS port. def use_ssl=(flag) flag = flag ? true : false if started? and @use_ssl != flag raise IOError, "use_ssl value changed, but session already started" end @use_ssl = flag end SSL_IVNAMES = [ :@ca_file, :@ca_path, :@cert, :@cert_store, :@ciphers, :@extra_chain_cert, :@key, :@ssl_timeout, :@ssl_version, :@min_version, :@max_version, :@verify_callback, :@verify_depth, :@verify_mode, :@verify_hostname, ] # :nodoc: SSL_ATTRIBUTES = [ :ca_file, :ca_path, :cert, :cert_store, :ciphers, :extra_chain_cert, :key, :ssl_timeout, :ssl_version, :min_version, :max_version, :verify_callback, :verify_depth, :verify_mode, :verify_hostname, ] # :nodoc: # Sets or returns the path to a CA certification file in PEM format. attr_accessor :ca_file # Sets or returns the path of to CA directory # containing certification files in PEM format. attr_accessor :ca_path # Sets or returns the OpenSSL::X509::Certificate object # to be used for client certification. attr_accessor :cert # Sets or returns the X509::Store to be used for verifying peer certificate. attr_accessor :cert_store # Sets or returns the available SSL ciphers. # See {OpenSSL::SSL::SSLContext#ciphers=}[rdoc-ref:OpenSSL::SSL::SSLContext#ciphers-3D]. attr_accessor :ciphers # Sets or returns the extra X509 certificates to be added to the certificate chain. # See {OpenSSL::SSL::SSLContext#add_certificate}[rdoc-ref:OpenSSL::SSL::SSLContext#add_certificate]. attr_accessor :extra_chain_cert # Sets or returns the OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object. attr_accessor :key # Sets or returns the SSL timeout seconds. attr_accessor :ssl_timeout # Sets or returns the SSL version. # See {OpenSSL::SSL::SSLContext#ssl_version=}[rdoc-ref:OpenSSL::SSL::SSLContext#ssl_version-3D]. attr_accessor :ssl_version # Sets or returns the minimum SSL version. # See {OpenSSL::SSL::SSLContext#min_version=}[rdoc-ref:OpenSSL::SSL::SSLContext#min_version-3D]. attr_accessor :min_version # Sets or returns the maximum SSL version. # See {OpenSSL::SSL::SSLContext#max_version=}[rdoc-ref:OpenSSL::SSL::SSLContext#max_version-3D]. attr_accessor :max_version # Sets or returns the callback for the server certification verification. attr_accessor :verify_callback # Sets or returns the maximum depth for the certificate chain verification. attr_accessor :verify_depth # Sets or returns the flags for server the certification verification # at the beginning of the SSL/TLS session. # OpenSSL::SSL::VERIFY_NONE or OpenSSL::SSL::VERIFY_PEER are acceptable. attr_accessor :verify_mode # Sets or returns whether to verify that the server certificate is valid # for the hostname. # See {OpenSSL::SSL::SSLContext#verify_hostname=}[rdoc-ref:OpenSSL::SSL::SSLContext#attribute-i-verify_mode]. attr_accessor :verify_hostname # Returns the X509 certificate chain (an array of strings) # for the session's socket peer, # or +nil+ if none. def peer_cert if not use_ssl? or not @socket return nil end @socket.io.peer_cert end # Starts an \HTTP session. # # Without a block, returns +self+: # # http = Gem::Net::HTTP.new(hostname) # # => # # http.start # # => # # http.started? # => true # http.finish # # With a block, calls the block with +self+, # finishes the session when the block exits, # and returns the block's value: # # http.start do |http| # http # end # # => # # http.started? # => false # def start # :yield: http raise IOError, 'HTTP session already opened' if @started if block_given? begin do_start return yield(self) ensure do_finish end end do_start self end def do_start connect @started = true end private :do_start def connect if use_ssl? # reference early to load OpenSSL before connecting, # as OpenSSL may take time to load. @ssl_context = OpenSSL::SSL::SSLContext.new end if proxy? then conn_addr = proxy_address conn_port = proxy_port else conn_addr = conn_address conn_port = port end debug "opening connection to #{conn_addr}:#{conn_port}..." s = Gem::Timeout.timeout(@open_timeout, Gem::Net::OpenTimeout) { begin TCPSocket.open(conn_addr, conn_port, @local_host, @local_port) rescue => e raise e, "Failed to open TCP connection to " + "#{conn_addr}:#{conn_port} (#{e.message})" end } s.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1) debug "opened" if use_ssl? if proxy? plain_sock = BufferedIO.new(s, read_timeout: @read_timeout, write_timeout: @write_timeout, continue_timeout: @continue_timeout, debug_output: @debug_output) buf = +"CONNECT #{conn_address}:#{@port} HTTP/#{HTTPVersion}\r\n" \ "Host: #{@address}:#{@port}\r\n" if proxy_user credential = ["#{proxy_user}:#{proxy_pass}"].pack('m0') buf << "Proxy-Authorization: Basic #{credential}\r\n" end buf << "\r\n" plain_sock.write(buf) HTTPResponse.read_new(plain_sock).value # assuming nothing left in buffers after successful CONNECT response end ssl_parameters = Hash.new iv_list = instance_variables SSL_IVNAMES.each_with_index do |ivname, i| if iv_list.include?(ivname) value = instance_variable_get(ivname) unless value.nil? ssl_parameters[SSL_ATTRIBUTES[i]] = value end end end @ssl_context.set_params(ssl_parameters) unless @ssl_context.session_cache_mode.nil? # a dummy method on JRuby @ssl_context.session_cache_mode = OpenSSL::SSL::SSLContext::SESSION_CACHE_CLIENT | OpenSSL::SSL::SSLContext::SESSION_CACHE_NO_INTERNAL_STORE end if @ssl_context.respond_to?(:session_new_cb) # not implemented under JRuby @ssl_context.session_new_cb = proc {|sock, sess| @ssl_session = sess } end # Still do the post_connection_check below even if connecting # to IP address verify_hostname = @ssl_context.verify_hostname # Server Name Indication (SNI) RFC 3546/6066 case @address when Gem::Resolv::IPv4::Regex, Gem::Resolv::IPv6::Regex # don't set SNI, as IP addresses in SNI is not valid # per RFC 6066, section 3. # Avoid openssl warning @ssl_context.verify_hostname = false else ssl_host_address = @address end debug "starting SSL for #{conn_addr}:#{conn_port}..." s = OpenSSL::SSL::SSLSocket.new(s, @ssl_context) s.sync_close = true s.hostname = ssl_host_address if s.respond_to?(:hostname=) && ssl_host_address if @ssl_session and Process.clock_gettime(Process::CLOCK_REALTIME) < @ssl_session.time.to_f + @ssl_session.timeout s.session = @ssl_session end ssl_socket_connect(s, @open_timeout) if (@ssl_context.verify_mode != OpenSSL::SSL::VERIFY_NONE) && verify_hostname s.post_connection_check(@address) end debug "SSL established, protocol: #{s.ssl_version}, cipher: #{s.cipher[0]}" end @socket = BufferedIO.new(s, read_timeout: @read_timeout, write_timeout: @write_timeout, continue_timeout: @continue_timeout, debug_output: @debug_output) @last_communicated = nil on_connect rescue => exception if s debug "Conn close because of connect error #{exception}" s.close end raise end private :connect def on_connect end private :on_connect # Finishes the \HTTP session: # # http = Gem::Net::HTTP.new(hostname) # http.start # http.started? # => true # http.finish # => nil # http.started? # => false # # Raises IOError if not in a session. def finish raise IOError, 'HTTP session not yet started' unless started? do_finish end def do_finish @started = false @socket.close if @socket @socket = nil end private :do_finish # # proxy # public # no proxy @is_proxy_class = false @proxy_from_env = false @proxy_addr = nil @proxy_port = nil @proxy_user = nil @proxy_pass = nil # Creates an \HTTP proxy class which behaves like \Gem::Net::HTTP, but # performs all access via the specified proxy. # # This class is obsolete. You may pass these same parameters directly to # \Gem::Net::HTTP.new. See Gem::Net::HTTP.new for details of the arguments. def HTTP.Proxy(p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil) #:nodoc: return self unless p_addr Class.new(self) { @is_proxy_class = true if p_addr == :ENV then @proxy_from_env = true @proxy_address = nil @proxy_port = nil else @proxy_from_env = false @proxy_address = p_addr @proxy_port = p_port || default_port end @proxy_user = p_user @proxy_pass = p_pass } end class << HTTP # Returns true if self is a class which was created by HTTP::Proxy. def proxy_class? defined?(@is_proxy_class) ? @is_proxy_class : false end # Returns the address of the proxy host, or +nil+ if none; # see Gem::Net::HTTP@Proxy+Server. attr_reader :proxy_address # Returns the port number of the proxy host, or +nil+ if none; # see Gem::Net::HTTP@Proxy+Server. attr_reader :proxy_port # Returns the user name for accessing the proxy, or +nil+ if none; # see Gem::Net::HTTP@Proxy+Server. attr_reader :proxy_user # Returns the password for accessing the proxy, or +nil+ if none; # see Gem::Net::HTTP@Proxy+Server. attr_reader :proxy_pass end # Returns +true+ if a proxy server is defined, +false+ otherwise; # see {Proxy Server}[rdoc-ref:Gem::Net::HTTP@Proxy+Server]. def proxy? !!(@proxy_from_env ? proxy_uri : @proxy_address) end # Returns +true+ if the proxy server is defined in the environment, # +false+ otherwise; # see {Proxy Server}[rdoc-ref:Gem::Net::HTTP@Proxy+Server]. def proxy_from_env? @proxy_from_env end # The proxy URI determined from the environment for this connection. def proxy_uri # :nodoc: return if @proxy_uri == false @proxy_uri ||= Gem::URI::HTTP.new( "http", nil, address, port, nil, nil, nil, nil, nil ).find_proxy || false @proxy_uri || nil end # Returns the address of the proxy server, if defined, +nil+ otherwise; # see {Proxy Server}[rdoc-ref:Gem::Net::HTTP@Proxy+Server]. def proxy_address if @proxy_from_env then proxy_uri&.hostname else @proxy_address end end # Returns the port number of the proxy server, if defined, +nil+ otherwise; # see {Proxy Server}[rdoc-ref:Gem::Net::HTTP@Proxy+Server]. def proxy_port if @proxy_from_env then proxy_uri&.port else @proxy_port end end # Returns the user name of the proxy server, if defined, +nil+ otherwise; # see {Proxy Server}[rdoc-ref:Gem::Net::HTTP@Proxy+Server]. def proxy_user if @proxy_from_env user = proxy_uri&.user unescape(user) if user else @proxy_user end end # Returns the password of the proxy server, if defined, +nil+ otherwise; # see {Proxy Server}[rdoc-ref:Gem::Net::HTTP@Proxy+Server]. def proxy_pass if @proxy_from_env pass = proxy_uri&.password unescape(pass) if pass else @proxy_pass end end alias proxyaddr proxy_address #:nodoc: obsolete alias proxyport proxy_port #:nodoc: obsolete private def unescape(value) require 'cgi/util' CGI.unescape(value) end # without proxy, obsolete def conn_address # :nodoc: @ipaddr || address() end def conn_port # :nodoc: port() end def edit_path(path) if proxy? if path.start_with?("ftp://") || use_ssl? path else "http://#{addr_port}#{path}" end else path end end # # HTTP operations # public # :call-seq: # get(path, initheader = nil) {|res| ... } # # Sends a GET request to the server; # returns an instance of a subclass of Gem::Net::HTTPResponse. # # The request is based on the Gem::Net::HTTP::Get object # created from string +path+ and initial headers hash +initheader+. # # With a block given, calls the block with the response body: # # http = Gem::Net::HTTP.new(hostname) # http.get('/todos/1') do |res| # p res # end # => # # # Output: # # "{\n \"userId\": 1,\n \"id\": 1,\n \"title\": \"delectus aut autem\",\n \"completed\": false\n}" # # With no block given, simply returns the response object: # # http.get('/') # => # # # Related: # # - Gem::Net::HTTP::Get: request class for \HTTP method GET. # - Gem::Net::HTTP.get: sends GET request, returns response body. # def get(path, initheader = nil, dest = nil, &block) # :yield: +body_segment+ res = nil request(Get.new(path, initheader)) {|r| r.read_body dest, &block res = r } res end # Sends a HEAD request to the server; # returns an instance of a subclass of Gem::Net::HTTPResponse. # # The request is based on the Gem::Net::HTTP::Head object # created from string +path+ and initial headers hash +initheader+: # # res = http.head('/todos/1') # => # # res.body # => nil # res.to_hash.take(3) # # => # [["date", ["Wed, 15 Feb 2023 15:25:42 GMT"]], # ["content-type", ["application/json; charset=utf-8"]], # ["connection", ["close"]]] # def head(path, initheader = nil) request(Head.new(path, initheader)) end # :call-seq: # post(path, data, initheader = nil) {|res| ... } # # Sends a POST request to the server; # returns an instance of a subclass of Gem::Net::HTTPResponse. # # The request is based on the Gem::Net::HTTP::Post object # created from string +path+, string +data+, and initial headers hash +initheader+. # # With a block given, calls the block with the response body: # # data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}' # http = Gem::Net::HTTP.new(hostname) # http.post('/todos', data) do |res| # p res # end # => # # # Output: # # "{\n \"{\\\"userId\\\": 1, \\\"id\\\": 1, \\\"title\\\": \\\"delectus aut autem\\\", \\\"completed\\\": false}\": \"\",\n \"id\": 201\n}" # # With no block given, simply returns the response object: # # http.post('/todos', data) # => # # # Related: # # - Gem::Net::HTTP::Post: request class for \HTTP method POST. # - Gem::Net::HTTP.post: sends POST request, returns response body. # def post(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+ send_entity(path, data, initheader, dest, Post, &block) end # :call-seq: # patch(path, data, initheader = nil) {|res| ... } # # Sends a PATCH request to the server; # returns an instance of a subclass of Gem::Net::HTTPResponse. # # The request is based on the Gem::Net::HTTP::Patch object # created from string +path+, string +data+, and initial headers hash +initheader+. # # With a block given, calls the block with the response body: # # data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}' # http = Gem::Net::HTTP.new(hostname) # http.patch('/todos/1', data) do |res| # p res # end # => # # # Output: # # "{\n \"userId\": 1,\n \"id\": 1,\n \"title\": \"delectus aut autem\",\n \"completed\": false,\n \"{\\\"userId\\\": 1, \\\"id\\\": 1, \\\"title\\\": \\\"delectus aut autem\\\", \\\"completed\\\": false}\": \"\"\n}" # # With no block given, simply returns the response object: # # http.patch('/todos/1', data) # => # # def patch(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+ send_entity(path, data, initheader, dest, Patch, &block) end # Sends a PUT request to the server; # returns an instance of a subclass of Gem::Net::HTTPResponse. # # The request is based on the Gem::Net::HTTP::Put object # created from string +path+, string +data+, and initial headers hash +initheader+. # # data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}' # http = Gem::Net::HTTP.new(hostname) # http.put('/todos/1', data) # => # # def put(path, data, initheader = nil) request(Put.new(path, initheader), data) end # Sends a PROPPATCH request to the server; # returns an instance of a subclass of Gem::Net::HTTPResponse. # # The request is based on the Gem::Net::HTTP::Proppatch object # created from string +path+, string +body+, and initial headers hash +initheader+. # # data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}' # http = Gem::Net::HTTP.new(hostname) # http.proppatch('/todos/1', data) # def proppatch(path, body, initheader = nil) request(Proppatch.new(path, initheader), body) end # Sends a LOCK request to the server; # returns an instance of a subclass of Gem::Net::HTTPResponse. # # The request is based on the Gem::Net::HTTP::Lock object # created from string +path+, string +body+, and initial headers hash +initheader+. # # data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}' # http = Gem::Net::HTTP.new(hostname) # http.lock('/todos/1', data) # def lock(path, body, initheader = nil) request(Lock.new(path, initheader), body) end # Sends an UNLOCK request to the server; # returns an instance of a subclass of Gem::Net::HTTPResponse. # # The request is based on the Gem::Net::HTTP::Unlock object # created from string +path+, string +body+, and initial headers hash +initheader+. # # data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}' # http = Gem::Net::HTTP.new(hostname) # http.unlock('/todos/1', data) # def unlock(path, body, initheader = nil) request(Unlock.new(path, initheader), body) end # Sends an Options request to the server; # returns an instance of a subclass of Gem::Net::HTTPResponse. # # The request is based on the Gem::Net::HTTP::Options object # created from string +path+ and initial headers hash +initheader+. # # http = Gem::Net::HTTP.new(hostname) # http.options('/') # def options(path, initheader = nil) request(Options.new(path, initheader)) end # Sends a PROPFIND request to the server; # returns an instance of a subclass of Gem::Net::HTTPResponse. # # The request is based on the Gem::Net::HTTP::Propfind object # created from string +path+, string +body+, and initial headers hash +initheader+. # # data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}' # http = Gem::Net::HTTP.new(hostname) # http.propfind('/todos/1', data) # def propfind(path, body = nil, initheader = {'Depth' => '0'}) request(Propfind.new(path, initheader), body) end # Sends a DELETE request to the server; # returns an instance of a subclass of Gem::Net::HTTPResponse. # # The request is based on the Gem::Net::HTTP::Delete object # created from string +path+ and initial headers hash +initheader+. # # http = Gem::Net::HTTP.new(hostname) # http.delete('/todos/1') # def delete(path, initheader = {'Depth' => 'Infinity'}) request(Delete.new(path, initheader)) end # Sends a MOVE request to the server; # returns an instance of a subclass of Gem::Net::HTTPResponse. # # The request is based on the Gem::Net::HTTP::Move object # created from string +path+ and initial headers hash +initheader+. # # http = Gem::Net::HTTP.new(hostname) # http.move('/todos/1') # def move(path, initheader = nil) request(Move.new(path, initheader)) end # Sends a COPY request to the server; # returns an instance of a subclass of Gem::Net::HTTPResponse. # # The request is based on the Gem::Net::HTTP::Copy object # created from string +path+ and initial headers hash +initheader+. # # http = Gem::Net::HTTP.new(hostname) # http.copy('/todos/1') # def copy(path, initheader = nil) request(Copy.new(path, initheader)) end # Sends a MKCOL request to the server; # returns an instance of a subclass of Gem::Net::HTTPResponse. # # The request is based on the Gem::Net::HTTP::Mkcol object # created from string +path+, string +body+, and initial headers hash +initheader+. # # data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}' # http.mkcol('/todos/1', data) # http = Gem::Net::HTTP.new(hostname) # def mkcol(path, body = nil, initheader = nil) request(Mkcol.new(path, initheader), body) end # Sends a TRACE request to the server; # returns an instance of a subclass of Gem::Net::HTTPResponse. # # The request is based on the Gem::Net::HTTP::Trace object # created from string +path+ and initial headers hash +initheader+. # # http = Gem::Net::HTTP.new(hostname) # http.trace('/todos/1') # def trace(path, initheader = nil) request(Trace.new(path, initheader)) end # Sends a GET request to the server; # forms the response into a Gem::Net::HTTPResponse object. # # The request is based on the Gem::Net::HTTP::Get object # created from string +path+ and initial headers hash +initheader+. # # With no block given, returns the response object: # # http = Gem::Net::HTTP.new(hostname) # http.request_get('/todos') # => # # # With a block given, calls the block with the response object # and returns the response object: # # http.request_get('/todos') do |res| # p res # end # => # # # Output: # # # # def request_get(path, initheader = nil, &block) # :yield: +response+ request(Get.new(path, initheader), &block) end # Sends a HEAD request to the server; # returns an instance of a subclass of Gem::Net::HTTPResponse. # # The request is based on the Gem::Net::HTTP::Head object # created from string +path+ and initial headers hash +initheader+. # # http = Gem::Net::HTTP.new(hostname) # http.head('/todos/1') # => # # def request_head(path, initheader = nil, &block) request(Head.new(path, initheader), &block) end # Sends a POST request to the server; # forms the response into a Gem::Net::HTTPResponse object. # # The request is based on the Gem::Net::HTTP::Post object # created from string +path+, string +data+, and initial headers hash +initheader+. # # With no block given, returns the response object: # # http = Gem::Net::HTTP.new(hostname) # http.post('/todos', 'xyzzy') # # => # # # With a block given, calls the block with the response body # and returns the response object: # # http.post('/todos', 'xyzzy') do |res| # p res # end # => # # # Output: # # "{\n \"xyzzy\": \"\",\n \"id\": 201\n}" # def request_post(path, data, initheader = nil, &block) # :yield: +response+ request Post.new(path, initheader), data, &block end # Sends a PUT request to the server; # returns an instance of a subclass of Gem::Net::HTTPResponse. # # The request is based on the Gem::Net::HTTP::Put object # created from string +path+, string +data+, and initial headers hash +initheader+. # # http = Gem::Net::HTTP.new(hostname) # http.put('/todos/1', 'xyzzy') # # => # # def request_put(path, data, initheader = nil, &block) #:nodoc: request Put.new(path, initheader), data, &block end alias get2 request_get #:nodoc: obsolete alias head2 request_head #:nodoc: obsolete alias post2 request_post #:nodoc: obsolete alias put2 request_put #:nodoc: obsolete # Sends an \HTTP request to the server; # returns an instance of a subclass of Gem::Net::HTTPResponse. # # The request is based on the Gem::Net::HTTPRequest object # created from string +path+, string +data+, and initial headers hash +header+. # That object is an instance of the # {subclass of Gem::Net::HTTPRequest}[rdoc-ref:Gem::Net::HTTPRequest@Request+Subclasses], # that corresponds to the given uppercase string +name+, # which must be # an {HTTP request method}[https://en.wikipedia.org/wiki/HTTP#Request_methods] # or a {WebDAV request method}[https://en.wikipedia.org/wiki/WebDAV#Implementation]. # # Examples: # # http = Gem::Net::HTTP.new(hostname) # http.send_request('GET', '/todos/1') # # => # # http.send_request('POST', '/todos', 'xyzzy') # # => # # def send_request(name, path, data = nil, header = nil) has_response_body = name != 'HEAD' r = HTTPGenericRequest.new(name,(data ? true : false),has_response_body,path,header) request r, data end # Sends the given request +req+ to the server; # forms the response into a Gem::Net::HTTPResponse object. # # The given +req+ must be an instance of a # {subclass of Gem::Net::HTTPRequest}[rdoc-ref:Gem::Net::HTTPRequest@Request+Subclasses]. # Argument +body+ should be given only if needed for the request. # # With no block given, returns the response object: # # http = Gem::Net::HTTP.new(hostname) # # req = Gem::Net::HTTP::Get.new('/todos/1') # http.request(req) # # => # # # req = Gem::Net::HTTP::Post.new('/todos') # http.request(req, 'xyzzy') # # => # # # With a block given, calls the block with the response and returns the response: # # req = Gem::Net::HTTP::Get.new('/todos/1') # http.request(req) do |res| # p res # end # => # # # Output: # # # # def request(req, body = nil, &block) # :yield: +response+ unless started? start { req['connection'] ||= 'close' return request(req, body, &block) } end if proxy_user() req.proxy_basic_auth proxy_user(), proxy_pass() unless use_ssl? end req.set_body_internal body res = transport_request(req, &block) if sspi_auth?(res) sspi_auth(req) res = transport_request(req, &block) end res end private # Executes a request which uses a representation # and returns its body. def send_entity(path, data, initheader, dest, type, &block) res = nil request(type.new(path, initheader), data) {|r| r.read_body dest, &block res = r } res end IDEMPOTENT_METHODS_ = %w/GET HEAD PUT DELETE OPTIONS TRACE/ # :nodoc: def transport_request(req) count = 0 begin begin_transport req res = catch(:response) { begin req.exec @socket, @curr_http_version, edit_path(req.path) rescue Errno::EPIPE # Failure when writing full request, but we can probably # still read the received response. end begin res = HTTPResponse.read_new(@socket) res.decode_content = req.decode_content res.body_encoding = @response_body_encoding res.ignore_eof = @ignore_eof end while res.kind_of?(HTTPInformation) res.uri = req.uri res } res.reading_body(@socket, req.response_body_permitted?) { yield res if block_given? } rescue Gem::Net::OpenTimeout raise rescue Gem::Net::ReadTimeout, IOError, EOFError, Errno::ECONNRESET, Errno::ECONNABORTED, Errno::EPIPE, Errno::ETIMEDOUT, # avoid a dependency on OpenSSL defined?(OpenSSL::SSL) ? OpenSSL::SSL::SSLError : IOError, Gem::Timeout::Error => exception if count < max_retries && IDEMPOTENT_METHODS_.include?(req.method) count += 1 @socket.close if @socket debug "Conn close because of error #{exception}, and retry" retry end debug "Conn close because of error #{exception}" @socket.close if @socket raise end end_transport req, res res rescue => exception debug "Conn close because of error #{exception}" @socket.close if @socket raise exception end def begin_transport(req) if @socket.closed? connect elsif @last_communicated if @last_communicated + @keep_alive_timeout < Process.clock_gettime(Process::CLOCK_MONOTONIC) debug 'Conn close because of keep_alive_timeout' @socket.close connect elsif @socket.io.to_io.wait_readable(0) && @socket.eof? debug "Conn close because of EOF" @socket.close connect end end if not req.response_body_permitted? and @close_on_empty_response req['connection'] ||= 'close' end req.update_uri address, port, use_ssl? req['host'] ||= addr_port() end def end_transport(req, res) @curr_http_version = res.http_version @last_communicated = nil if @socket.closed? debug 'Conn socket closed' elsif not res.body and @close_on_empty_response debug 'Conn close' @socket.close elsif keep_alive?(req, res) debug 'Conn keep-alive' @last_communicated = Process.clock_gettime(Process::CLOCK_MONOTONIC) else debug 'Conn close' @socket.close end end def keep_alive?(req, res) return false if req.connection_close? if @curr_http_version <= '1.0' res.connection_keep_alive? else # HTTP/1.1 or later not res.connection_close? end end def sspi_auth?(res) return false unless @sspi_enabled if res.kind_of?(HTTPProxyAuthenticationRequired) and proxy? and res["Proxy-Authenticate"].include?("Negotiate") begin require 'win32/sspi' true rescue LoadError false end else false end end def sspi_auth(req) n = Win32::SSPI::NegotiateAuth.new req["Proxy-Authorization"] = "Negotiate #{n.get_initial_token}" # Some versions of ISA will close the connection if this isn't present. req["Connection"] = "Keep-Alive" req["Proxy-Connection"] = "Keep-Alive" res = transport_request(req) authphrase = res["Proxy-Authenticate"] or return res req["Proxy-Authorization"] = "Negotiate #{n.complete_authentication(authphrase)}" rescue => err raise HTTPAuthenticationError.new('HTTP authentication failed', err) end # # utils # private def addr_port addr = address addr = "[#{addr}]" if addr.include?(":") default_port = use_ssl? ? HTTP.https_default_port : HTTP.http_default_port default_port == port ? addr : "#{addr}:#{port}" end # Adds a message to debugging output def debug(msg) return unless @debug_output @debug_output << msg @debug_output << "\n" end alias_method :D, :debug end end require_relative 'http/exceptions' require_relative 'http/header' require_relative 'http/generic_request' require_relative 'http/request' require_relative 'http/requests' require_relative 'http/response' require_relative 'http/responses' require_relative 'http/proxy_delta' require_relative 'http/backward' PK!ù³»0rubygems/vendor/net-http/lib/net/http/request.rbnu„[µü¤# frozen_string_literal: true # This class is the base class for \Gem::Net::HTTP request classes. # The class should not be used directly; # instead you should use its subclasses, listed below. # # == Creating a Request # # An request object may be created with either a Gem::URI or a string hostname: # # require 'rubygems/vendor/net-http/lib/net/http' # uri = Gem::URI('https://jsonplaceholder.typicode.com/') # req = Gem::Net::HTTP::Get.new(uri) # => # # req = Gem::Net::HTTP::Get.new(uri.hostname) # => # # # And with any of the subclasses: # # req = Gem::Net::HTTP::Head.new(uri) # => # # req = Gem::Net::HTTP::Post.new(uri) # => # # req = Gem::Net::HTTP::Put.new(uri) # => # # # ... # # The new instance is suitable for use as the argument to Gem::Net::HTTP#request. # # == Request Headers # # A new request object has these header fields by default: # # req.to_hash # # => # {"accept-encoding"=>["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"], # "accept"=>["*/*"], # "user-agent"=>["Ruby"], # "host"=>["jsonplaceholder.typicode.com"]} # # See: # # - {Request header Accept-Encoding}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Accept-Encoding] # and {Compression and Decompression}[rdoc-ref:Gem::Net::HTTP@Compression+and+Decompression]. # - {Request header Accept}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#accept-request-header]. # - {Request header User-Agent}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#user-agent-request-header]. # - {Request header Host}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#host-request-header]. # # You can add headers or override default headers: # # # res = Gem::Net::HTTP::Get.new(uri, {'foo' => '0', 'bar' => '1'}) # # This class (and therefore its subclasses) also includes (indirectly) # module Gem::Net::HTTPHeader, which gives access to its # {methods for setting headers}[rdoc-ref:Gem::Net::HTTPHeader@Setters]. # # == Request Subclasses # # Subclasses for HTTP requests: # # - Gem::Net::HTTP::Get # - Gem::Net::HTTP::Head # - Gem::Net::HTTP::Post # - Gem::Net::HTTP::Put # - Gem::Net::HTTP::Delete # - Gem::Net::HTTP::Options # - Gem::Net::HTTP::Trace # - Gem::Net::HTTP::Patch # # Subclasses for WebDAV requests: # # - Gem::Net::HTTP::Propfind # - Gem::Net::HTTP::Proppatch # - Gem::Net::HTTP::Mkcol # - Gem::Net::HTTP::Copy # - Gem::Net::HTTP::Move # - Gem::Net::HTTP::Lock # - Gem::Net::HTTP::Unlock # class Gem::Net::HTTPRequest < Gem::Net::HTTPGenericRequest # Creates an HTTP request object for +path+. # # +initheader+ are the default headers to use. Gem::Net::HTTP adds # Accept-Encoding to enable compression of the response body unless # Accept-Encoding or Range are supplied in +initheader+. def initialize(path, initheader = nil) super self.class::METHOD, self.class::REQUEST_HAS_BODY, self.class::RESPONSE_HAS_BODY, path, initheader end end PK!Š?sDII1rubygems/vendor/net-http/lib/net/http/backward.rbnu„[µü¤# frozen_string_literal: true # for backward compatibility # :enddoc: class Gem::Net::HTTP ProxyMod = ProxyDelta deprecate_constant :ProxyMod end module Gem::Net::NetPrivate HTTPRequest = ::Gem::Net::HTTPRequest deprecate_constant :HTTPRequest end module Gem::Net HTTPSession = HTTP HTTPInformationCode = HTTPInformation HTTPSuccessCode = HTTPSuccess HTTPRedirectionCode = HTTPRedirection HTTPRetriableCode = HTTPRedirection HTTPClientErrorCode = HTTPClientError HTTPFatalErrorCode = HTTPClientError HTTPServerErrorCode = HTTPServerError HTTPResponseReceiver = HTTPResponse HTTPResponceReceiver = HTTPResponse # Typo since 2001 deprecate_constant :HTTPSession, :HTTPInformationCode, :HTTPSuccessCode, :HTTPRedirectionCode, :HTTPRetriableCode, :HTTPClientErrorCode, :HTTPFatalErrorCode, :HTTPServerErrorCode, :HTTPResponseReceiver, :HTTPResponceReceiver end PK!M?´i4rubygems/vendor/net-http/lib/net/http/proxy_delta.rbnu„[µü¤# frozen_string_literal: true module Gem::Net::HTTP::ProxyDelta #:nodoc: internal use only private def conn_address proxy_address() end def conn_port proxy_port() end def edit_path(path) use_ssl? ? path : "http://#{addr_port()}#{path}" end end PK!É!Œ.1.18rubygems/vendor/net-http/lib/net/http/generic_request.rbnu„[µü¤# frozen_string_literal: true # # \HTTPGenericRequest is the parent of the Gem::Net::HTTPRequest class. # # Do not use this directly; instead, use a subclass of Gem::Net::HTTPRequest. # # == About the Examples # # :include: doc/net-http/examples.rdoc # class Gem::Net::HTTPGenericRequest include Gem::Net::HTTPHeader def initialize(m, reqbody, resbody, uri_or_path, initheader = nil) # :nodoc: @method = m @request_has_body = reqbody @response_has_body = resbody if Gem::URI === uri_or_path then raise ArgumentError, "not an HTTP Gem::URI" unless Gem::URI::HTTP === uri_or_path hostname = uri_or_path.hostname raise ArgumentError, "no host component for Gem::URI" unless (hostname && hostname.length > 0) @uri = uri_or_path.dup host = @uri.hostname.dup host << ":" << @uri.port.to_s if @uri.port != @uri.default_port @path = uri_or_path.request_uri raise ArgumentError, "no HTTP request path given" unless @path else @uri = nil host = nil raise ArgumentError, "no HTTP request path given" unless uri_or_path raise ArgumentError, "HTTP request path is empty" if uri_or_path.empty? @path = uri_or_path.dup end @decode_content = false if Gem::Net::HTTP::HAVE_ZLIB then if !initheader || !initheader.keys.any? { |k| %w[accept-encoding range].include? k.downcase } then @decode_content = true if @response_has_body initheader = initheader ? initheader.dup : {} initheader["accept-encoding"] = "gzip;q=1.0,deflate;q=0.6,identity;q=0.3" end end initialize_http_header initheader self['Accept'] ||= '*/*' self['User-Agent'] ||= 'Ruby' self['Host'] ||= host if host @body = nil @body_stream = nil @body_data = nil end # Returns the string method name for the request: # # Gem::Net::HTTP::Get.new(uri).method # => "GET" # Gem::Net::HTTP::Post.new(uri).method # => "POST" # attr_reader :method # Returns the string path for the request: # # Gem::Net::HTTP::Get.new(uri).path # => "/" # Gem::Net::HTTP::Post.new('example.com').path # => "example.com" # attr_reader :path # Returns the Gem::URI object for the request, or +nil+ if none: # # Gem::Net::HTTP::Get.new(uri).uri # # => # # Gem::Net::HTTP::Get.new('example.com').uri # => nil # attr_reader :uri # Returns +false+ if the request's header 'Accept-Encoding' # has been set manually or deleted # (indicating that the user intends to handle encoding in the response), # +true+ otherwise: # # req = Gem::Net::HTTP::Get.new(uri) # => # # req['Accept-Encoding'] # => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3" # req.decode_content # => true # req['Accept-Encoding'] = 'foo' # req.decode_content # => false # req.delete('Accept-Encoding') # req.decode_content # => false # attr_reader :decode_content # Returns a string representation of the request: # # Gem::Net::HTTP::Post.new(uri).inspect # => "#" # def inspect "\#<#{self.class} #{@method}>" end ## # Don't automatically decode response content-encoding if the user indicates # they want to handle it. def []=(key, val) # :nodoc: @decode_content = false if key.downcase == 'accept-encoding' super key, val end # Returns whether the request may have a body: # # Gem::Net::HTTP::Post.new(uri).request_body_permitted? # => true # Gem::Net::HTTP::Get.new(uri).request_body_permitted? # => false # def request_body_permitted? @request_has_body end # Returns whether the response may have a body: # # Gem::Net::HTTP::Post.new(uri).response_body_permitted? # => true # Gem::Net::HTTP::Head.new(uri).response_body_permitted? # => false # def response_body_permitted? @response_has_body end def body_exist? # :nodoc: warn "Gem::Net::HTTPRequest#body_exist? is obsolete; use response_body_permitted?", uplevel: 1 if $VERBOSE response_body_permitted? end # Returns the string body for the request, or +nil+ if there is none: # # req = Gem::Net::HTTP::Post.new(uri) # req.body # => nil # req.body = '{"title": "foo","body": "bar","userId": 1}' # req.body # => "{\"title\": \"foo\",\"body\": \"bar\",\"userId\": 1}" # attr_reader :body # Sets the body for the request: # # req = Gem::Net::HTTP::Post.new(uri) # req.body # => nil # req.body = '{"title": "foo","body": "bar","userId": 1}' # req.body # => "{\"title\": \"foo\",\"body\": \"bar\",\"userId\": 1}" # def body=(str) @body = str @body_stream = nil @body_data = nil str end # Returns the body stream object for the request, or +nil+ if there is none: # # req = Gem::Net::HTTP::Post.new(uri) # => # # req.body_stream # => nil # require 'stringio' # req.body_stream = StringIO.new('xyzzy') # => # # req.body_stream # => # # attr_reader :body_stream # Sets the body stream for the request: # # req = Gem::Net::HTTP::Post.new(uri) # => # # req.body_stream # => nil # require 'stringio' # req.body_stream = StringIO.new('xyzzy') # => # # req.body_stream # => # # def body_stream=(input) @body = nil @body_stream = input @body_data = nil input end def set_body_internal(str) #:nodoc: internal use only raise ArgumentError, "both of body argument and HTTPRequest#body set" if str and (@body or @body_stream) self.body = str if str if @body.nil? && @body_stream.nil? && @body_data.nil? && request_body_permitted? self.body = '' end end # # write # def exec(sock, ver, path) #:nodoc: internal use only if @body send_request_with_body sock, ver, path, @body elsif @body_stream send_request_with_body_stream sock, ver, path, @body_stream elsif @body_data send_request_with_body_data sock, ver, path, @body_data else write_header sock, ver, path end end def update_uri(addr, port, ssl) # :nodoc: internal use only # reflect the connection and @path to @uri return unless @uri if ssl scheme = 'https' klass = Gem::URI::HTTPS else scheme = 'http' klass = Gem::URI::HTTP end if host = self['host'] host.sub!(/:.*/m, '') elsif host = @uri.host else host = addr end # convert the class of the Gem::URI if @uri.is_a?(klass) @uri.host = host @uri.port = port else @uri = klass.new( scheme, @uri.userinfo, host, port, nil, @uri.path, nil, @uri.query, nil) end end private class Chunker #:nodoc: def initialize(sock) @sock = sock @prev = nil end def write(buf) # avoid memcpy() of buf, buf can huge and eat memory bandwidth rv = buf.bytesize @sock.write("#{rv.to_s(16)}\r\n", buf, "\r\n") rv end def finish @sock.write("0\r\n\r\n") end end def send_request_with_body(sock, ver, path, body) self.content_length = body.bytesize delete 'Transfer-Encoding' supply_default_content_type write_header sock, ver, path wait_for_continue sock, ver if sock.continue_timeout sock.write body end def send_request_with_body_stream(sock, ver, path, f) unless content_length() or chunked? raise ArgumentError, "Content-Length not given and Transfer-Encoding is not `chunked'" end supply_default_content_type write_header sock, ver, path wait_for_continue sock, ver if sock.continue_timeout if chunked? chunker = Chunker.new(sock) IO.copy_stream(f, chunker) chunker.finish else IO.copy_stream(f, sock) end end def send_request_with_body_data(sock, ver, path, params) if /\Amultipart\/form-data\z/i !~ self.content_type self.content_type = 'application/x-www-form-urlencoded' return send_request_with_body(sock, ver, path, Gem::URI.encode_www_form(params)) end opt = @form_option.dup require 'securerandom' unless defined?(SecureRandom) opt[:boundary] ||= SecureRandom.urlsafe_base64(40) self.set_content_type(self.content_type, boundary: opt[:boundary]) if chunked? write_header sock, ver, path encode_multipart_form_data(sock, params, opt) else require 'tempfile' file = Tempfile.new('multipart') file.binmode encode_multipart_form_data(file, params, opt) file.rewind self.content_length = file.size write_header sock, ver, path IO.copy_stream(file, sock) file.close(true) end end def encode_multipart_form_data(out, params, opt) charset = opt[:charset] boundary = opt[:boundary] require 'securerandom' unless defined?(SecureRandom) boundary ||= SecureRandom.urlsafe_base64(40) chunked_p = chunked? buf = +'' params.each do |key, value, h={}| key = quote_string(key, charset) filename = h.key?(:filename) ? h[:filename] : value.respond_to?(:to_path) ? File.basename(value.to_path) : nil buf << "--#{boundary}\r\n" if filename filename = quote_string(filename, charset) type = h[:content_type] || 'application/octet-stream' buf << "Content-Disposition: form-data; " \ "name=\"#{key}\"; filename=\"#{filename}\"\r\n" \ "Content-Type: #{type}\r\n\r\n" if !out.respond_to?(:write) || !value.respond_to?(:read) # if +out+ is not an IO or +value+ is not an IO buf << (value.respond_to?(:read) ? value.read : value) elsif value.respond_to?(:size) && chunked_p # if +out+ is an IO and +value+ is a File, use IO.copy_stream flush_buffer(out, buf, chunked_p) out << "%x\r\n" % value.size if chunked_p IO.copy_stream(value, out) out << "\r\n" if chunked_p else # +out+ is an IO, and +value+ is not a File but an IO flush_buffer(out, buf, chunked_p) 1 while flush_buffer(out, value.read(4096), chunked_p) end else # non-file field: # HTML5 says, "The parts of the generated multipart/form-data # resource that correspond to non-file fields must not have a # Content-Type header specified." buf << "Content-Disposition: form-data; name=\"#{key}\"\r\n\r\n" buf << (value.respond_to?(:read) ? value.read : value) end buf << "\r\n" end buf << "--#{boundary}--\r\n" flush_buffer(out, buf, chunked_p) out << "0\r\n\r\n" if chunked_p end def quote_string(str, charset) str = str.encode(charset, fallback:->(c){'&#%d;'%c.encode("UTF-8").ord}) if charset str.gsub(/[\\"]/, '\\\\\&') end def flush_buffer(out, buf, chunked_p) return unless buf out << "%x\r\n"%buf.bytesize if chunked_p out << buf out << "\r\n" if chunked_p buf.clear end def supply_default_content_type return if content_type() warn 'net/http: Content-Type did not set; using application/x-www-form-urlencoded', uplevel: 1 if $VERBOSE set_content_type 'application/x-www-form-urlencoded' end ## # Waits up to the continue timeout for a response from the server provided # we're speaking HTTP 1.1 and are expecting a 100-continue response. def wait_for_continue(sock, ver) if ver >= '1.1' and @header['expect'] and @header['expect'].include?('100-continue') if sock.io.to_io.wait_readable(sock.continue_timeout) res = Gem::Net::HTTPResponse.read_new(sock) unless res.kind_of?(Gem::Net::HTTPContinue) res.decode_content = @decode_content throw :response, res end end end end def write_header(sock, ver, path) reqline = "#{@method} #{path} HTTP/#{ver}" if /[\r\n]/ =~ reqline raise ArgumentError, "A Request-Line must not contain CR or LF" end buf = +'' buf << reqline << "\r\n" each_capitalized do |k,v| buf << "#{k}: #{v}\r\n" end buf << "\r\n" sock.write buf end end PK!eb o7o71rubygems/vendor/net-http/lib/net/http/requests.rbnu„[µü¤# frozen_string_literal: true # HTTP/1.1 methods --- RFC2616 # \Class for representing # {HTTP method GET}[https://en.wikipedia.org/w/index.php?title=Hypertext_Transfer_Protocol#GET_method]: # # require 'rubygems/vendor/net-http/lib/net/http' # uri = Gem::URI('http://example.com') # hostname = uri.hostname # => "example.com" # req = Gem::Net::HTTP::Get.new(uri) # => # # res = Gem::Net::HTTP.start(hostname) do |http| # http.request(req) # end # # See {Request Headers}[rdoc-ref:Gem::Net::HTTPRequest@Request+Headers]. # # Properties: # # - Request body: optional. # - Response body: yes. # - {Safe}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_methods]: yes. # - {Idempotent}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Idempotent_methods]: yes. # - {Cacheable}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cacheable_methods]: yes. # # Related: # # - Gem::Net::HTTP.get: sends +GET+ request, returns response body. # - Gem::Net::HTTP#get: sends +GET+ request, returns response object. # class Gem::Net::HTTP::Get < Gem::Net::HTTPRequest METHOD = 'GET' REQUEST_HAS_BODY = false RESPONSE_HAS_BODY = true end # \Class for representing # {HTTP method HEAD}[https://en.wikipedia.org/w/index.php?title=Hypertext_Transfer_Protocol#HEAD_method]: # # require 'rubygems/vendor/net-http/lib/net/http' # uri = Gem::URI('http://example.com') # hostname = uri.hostname # => "example.com" # req = Gem::Net::HTTP::Head.new(uri) # => # # res = Gem::Net::HTTP.start(hostname) do |http| # http.request(req) # end # # See {Request Headers}[rdoc-ref:Gem::Net::HTTPRequest@Request+Headers]. # # Properties: # # - Request body: optional. # - Response body: no. # - {Safe}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_methods]: yes. # - {Idempotent}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Idempotent_methods]: yes. # - {Cacheable}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cacheable_methods]: yes. # # Related: # # - Gem::Net::HTTP#head: sends +HEAD+ request, returns response object. # class Gem::Net::HTTP::Head < Gem::Net::HTTPRequest METHOD = 'HEAD' REQUEST_HAS_BODY = false RESPONSE_HAS_BODY = false end # \Class for representing # {HTTP method POST}[https://en.wikipedia.org/w/index.php?title=Hypertext_Transfer_Protocol#POST_method]: # # require 'rubygems/vendor/net-http/lib/net/http' # uri = Gem::URI('http://example.com') # hostname = uri.hostname # => "example.com" # uri.path = '/posts' # req = Gem::Net::HTTP::Post.new(uri) # => # # req.body = '{"title": "foo","body": "bar","userId": 1}' # req.content_type = 'application/json' # res = Gem::Net::HTTP.start(hostname) do |http| # http.request(req) # end # # See {Request Headers}[rdoc-ref:Gem::Net::HTTPRequest@Request+Headers]. # # Properties: # # - Request body: yes. # - Response body: yes. # - {Safe}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_methods]: no. # - {Idempotent}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Idempotent_methods]: no. # - {Cacheable}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cacheable_methods]: yes. # # Related: # # - Gem::Net::HTTP.post: sends +POST+ request, returns response object. # - Gem::Net::HTTP#post: sends +POST+ request, returns response object. # class Gem::Net::HTTP::Post < Gem::Net::HTTPRequest METHOD = 'POST' REQUEST_HAS_BODY = true RESPONSE_HAS_BODY = true end # \Class for representing # {HTTP method PUT}[https://en.wikipedia.org/w/index.php?title=Hypertext_Transfer_Protocol#PUT_method]: # # require 'rubygems/vendor/net-http/lib/net/http' # uri = Gem::URI('http://example.com') # hostname = uri.hostname # => "example.com" # uri.path = '/posts' # req = Gem::Net::HTTP::Put.new(uri) # => # # req.body = '{"title": "foo","body": "bar","userId": 1}' # req.content_type = 'application/json' # res = Gem::Net::HTTP.start(hostname) do |http| # http.request(req) # end # # See {Request Headers}[rdoc-ref:Gem::Net::HTTPRequest@Request+Headers]. # # Properties: # # - Request body: yes. # - Response body: yes. # - {Safe}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_methods]: no. # - {Idempotent}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Idempotent_methods]: yes. # - {Cacheable}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cacheable_methods]: no. # class Gem::Net::HTTP::Put < Gem::Net::HTTPRequest METHOD = 'PUT' REQUEST_HAS_BODY = true RESPONSE_HAS_BODY = true end # \Class for representing # {HTTP method DELETE}[https://en.wikipedia.org/w/index.php?title=Hypertext_Transfer_Protocol#DELETE_method]: # # require 'rubygems/vendor/net-http/lib/net/http' # uri = Gem::URI('http://example.com') # hostname = uri.hostname # => "example.com" # uri.path = '/posts/1' # req = Gem::Net::HTTP::Delete.new(uri) # => # # res = Gem::Net::HTTP.start(hostname) do |http| # http.request(req) # end # # See {Request Headers}[rdoc-ref:Gem::Net::HTTPRequest@Request+Headers]. # # Properties: # # - Request body: optional. # - Response body: yes. # - {Safe}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_methods]: no. # - {Idempotent}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Idempotent_methods]: yes. # - {Cacheable}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cacheable_methods]: no. # # Related: # # - Gem::Net::HTTP#delete: sends +DELETE+ request, returns response object. # class Gem::Net::HTTP::Delete < Gem::Net::HTTPRequest METHOD = 'DELETE' REQUEST_HAS_BODY = false RESPONSE_HAS_BODY = true end # \Class for representing # {HTTP method OPTIONS}[https://en.wikipedia.org/w/index.php?title=Hypertext_Transfer_Protocol#OPTIONS_method]: # # require 'rubygems/vendor/net-http/lib/net/http' # uri = Gem::URI('http://example.com') # hostname = uri.hostname # => "example.com" # req = Gem::Net::HTTP::Options.new(uri) # => # # res = Gem::Net::HTTP.start(hostname) do |http| # http.request(req) # end # # See {Request Headers}[rdoc-ref:Gem::Net::HTTPRequest@Request+Headers]. # # Properties: # # - Request body: optional. # - Response body: yes. # - {Safe}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_methods]: yes. # - {Idempotent}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Idempotent_methods]: yes. # - {Cacheable}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cacheable_methods]: no. # # Related: # # - Gem::Net::HTTP#options: sends +OPTIONS+ request, returns response object. # class Gem::Net::HTTP::Options < Gem::Net::HTTPRequest METHOD = 'OPTIONS' REQUEST_HAS_BODY = false RESPONSE_HAS_BODY = true end # \Class for representing # {HTTP method TRACE}[https://en.wikipedia.org/w/index.php?title=Hypertext_Transfer_Protocol#TRACE_method]: # # require 'rubygems/vendor/net-http/lib/net/http' # uri = Gem::URI('http://example.com') # hostname = uri.hostname # => "example.com" # req = Gem::Net::HTTP::Trace.new(uri) # => # # res = Gem::Net::HTTP.start(hostname) do |http| # http.request(req) # end # # See {Request Headers}[rdoc-ref:Gem::Net::HTTPRequest@Request+Headers]. # # Properties: # # - Request body: no. # - Response body: yes. # - {Safe}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_methods]: yes. # - {Idempotent}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Idempotent_methods]: yes. # - {Cacheable}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cacheable_methods]: no. # # Related: # # - Gem::Net::HTTP#trace: sends +TRACE+ request, returns response object. # class Gem::Net::HTTP::Trace < Gem::Net::HTTPRequest METHOD = 'TRACE' REQUEST_HAS_BODY = false RESPONSE_HAS_BODY = true end # \Class for representing # {HTTP method PATCH}[https://en.wikipedia.org/w/index.php?title=Hypertext_Transfer_Protocol#PATCH_method]: # # require 'rubygems/vendor/net-http/lib/net/http' # uri = Gem::URI('http://example.com') # hostname = uri.hostname # => "example.com" # uri.path = '/posts' # req = Gem::Net::HTTP::Patch.new(uri) # => # # req.body = '{"title": "foo","body": "bar","userId": 1}' # req.content_type = 'application/json' # res = Gem::Net::HTTP.start(hostname) do |http| # http.request(req) # end # # See {Request Headers}[rdoc-ref:Gem::Net::HTTPRequest@Request+Headers]. # # Properties: # # - Request body: yes. # - Response body: yes. # - {Safe}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_methods]: no. # - {Idempotent}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Idempotent_methods]: no. # - {Cacheable}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cacheable_methods]: no. # # Related: # # - Gem::Net::HTTP#patch: sends +PATCH+ request, returns response object. # class Gem::Net::HTTP::Patch < Gem::Net::HTTPRequest METHOD = 'PATCH' REQUEST_HAS_BODY = true RESPONSE_HAS_BODY = true end # # WebDAV methods --- RFC2518 # # \Class for representing # {WebDAV method PROPFIND}[http://www.webdav.org/specs/rfc4918.html#METHOD_PROPFIND]: # # require 'rubygems/vendor/net-http/lib/net/http' # uri = Gem::URI('http://example.com') # hostname = uri.hostname # => "example.com" # req = Gem::Net::HTTP::Propfind.new(uri) # => # # res = Gem::Net::HTTP.start(hostname) do |http| # http.request(req) # end # # See {Request Headers}[rdoc-ref:Gem::Net::HTTPRequest@Request+Headers]. # # Related: # # - Gem::Net::HTTP#propfind: sends +PROPFIND+ request, returns response object. # class Gem::Net::HTTP::Propfind < Gem::Net::HTTPRequest METHOD = 'PROPFIND' REQUEST_HAS_BODY = true RESPONSE_HAS_BODY = true end # \Class for representing # {WebDAV method PROPPATCH}[http://www.webdav.org/specs/rfc4918.html#METHOD_PROPPATCH]: # # require 'rubygems/vendor/net-http/lib/net/http' # uri = Gem::URI('http://example.com') # hostname = uri.hostname # => "example.com" # req = Gem::Net::HTTP::Proppatch.new(uri) # => # # res = Gem::Net::HTTP.start(hostname) do |http| # http.request(req) # end # # See {Request Headers}[rdoc-ref:Gem::Net::HTTPRequest@Request+Headers]. # # Related: # # - Gem::Net::HTTP#proppatch: sends +PROPPATCH+ request, returns response object. # class Gem::Net::HTTP::Proppatch < Gem::Net::HTTPRequest METHOD = 'PROPPATCH' REQUEST_HAS_BODY = true RESPONSE_HAS_BODY = true end # \Class for representing # {WebDAV method MKCOL}[http://www.webdav.org/specs/rfc4918.html#METHOD_MKCOL]: # # require 'rubygems/vendor/net-http/lib/net/http' # uri = Gem::URI('http://example.com') # hostname = uri.hostname # => "example.com" # req = Gem::Net::HTTP::Mkcol.new(uri) # => # # res = Gem::Net::HTTP.start(hostname) do |http| # http.request(req) # end # # See {Request Headers}[rdoc-ref:Gem::Net::HTTPRequest@Request+Headers]. # # Related: # # - Gem::Net::HTTP#mkcol: sends +MKCOL+ request, returns response object. # class Gem::Net::HTTP::Mkcol < Gem::Net::HTTPRequest METHOD = 'MKCOL' REQUEST_HAS_BODY = true RESPONSE_HAS_BODY = true end # \Class for representing # {WebDAV method COPY}[http://www.webdav.org/specs/rfc4918.html#METHOD_COPY]: # # require 'rubygems/vendor/net-http/lib/net/http' # uri = Gem::URI('http://example.com') # hostname = uri.hostname # => "example.com" # req = Gem::Net::HTTP::Copy.new(uri) # => # # res = Gem::Net::HTTP.start(hostname) do |http| # http.request(req) # end # # See {Request Headers}[rdoc-ref:Gem::Net::HTTPRequest@Request+Headers]. # # Related: # # - Gem::Net::HTTP#copy: sends +COPY+ request, returns response object. # class Gem::Net::HTTP::Copy < Gem::Net::HTTPRequest METHOD = 'COPY' REQUEST_HAS_BODY = false RESPONSE_HAS_BODY = true end # \Class for representing # {WebDAV method MOVE}[http://www.webdav.org/specs/rfc4918.html#METHOD_MOVE]: # # require 'rubygems/vendor/net-http/lib/net/http' # uri = Gem::URI('http://example.com') # hostname = uri.hostname # => "example.com" # req = Gem::Net::HTTP::Move.new(uri) # => # # res = Gem::Net::HTTP.start(hostname) do |http| # http.request(req) # end # # See {Request Headers}[rdoc-ref:Gem::Net::HTTPRequest@Request+Headers]. # # Related: # # - Gem::Net::HTTP#move: sends +MOVE+ request, returns response object. # class Gem::Net::HTTP::Move < Gem::Net::HTTPRequest METHOD = 'MOVE' REQUEST_HAS_BODY = false RESPONSE_HAS_BODY = true end # \Class for representing # {WebDAV method LOCK}[http://www.webdav.org/specs/rfc4918.html#METHOD_LOCK]: # # require 'rubygems/vendor/net-http/lib/net/http' # uri = Gem::URI('http://example.com') # hostname = uri.hostname # => "example.com" # req = Gem::Net::HTTP::Lock.new(uri) # => # # res = Gem::Net::HTTP.start(hostname) do |http| # http.request(req) # end # # See {Request Headers}[rdoc-ref:Gem::Net::HTTPRequest@Request+Headers]. # # Related: # # - Gem::Net::HTTP#lock: sends +LOCK+ request, returns response object. # class Gem::Net::HTTP::Lock < Gem::Net::HTTPRequest METHOD = 'LOCK' REQUEST_HAS_BODY = true RESPONSE_HAS_BODY = true end # \Class for representing # {WebDAV method UNLOCK}[http://www.webdav.org/specs/rfc4918.html#METHOD_UNLOCK]: # # require 'rubygems/vendor/net-http/lib/net/http' # uri = Gem::URI('http://example.com') # hostname = uri.hostname # => "example.com" # req = Gem::Net::HTTP::Unlock.new(uri) # => # # res = Gem::Net::HTTP.start(hostname) do |http| # http.request(req) # end # # See {Request Headers}[rdoc-ref:Gem::Net::HTTPRequest@Request+Headers]. # # Related: # # - Gem::Net::HTTP#unlock: sends +UNLOCK+ request, returns response object. # class Gem::Net::HTTP::Unlock < Gem::Net::HTTPRequest METHOD = 'UNLOCK' REQUEST_HAS_BODY = true RESPONSE_HAS_BODY = true end PK!`9d÷ /rubygems/vendor/net-http/lib/net/http/status.rbnu„[µü¤# frozen_string_literal: true require_relative '../http' if $0 == __FILE__ require 'open-uri' File.foreach(__FILE__) do |line| puts line break if line.start_with?('end') end puts puts "Gem::Net::HTTP::STATUS_CODES = {" url = "https://www.iana.org/assignments/http-status-codes/http-status-codes-1.csv" Gem::URI(url).read.each_line do |line| code, mes, = line.split(',') next if ['(Unused)', 'Unassigned', 'Description'].include?(mes) puts " #{code} => '#{mes}'," end puts "} # :nodoc:" end Gem::Net::HTTP::STATUS_CODES = { 100 => 'Continue', 101 => 'Switching Protocols', 102 => 'Processing', 103 => 'Early Hints', 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 207 => 'Multi-Status', 208 => 'Already Reported', 226 => 'IM Used', 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 307 => 'Temporary Redirect', 308 => 'Permanent Redirect', 400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Timeout', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Content Too Large', 414 => 'URI Too Long', 415 => 'Unsupported Media Type', 416 => 'Range Not Satisfiable', 417 => 'Expectation Failed', 421 => 'Misdirected Request', 422 => 'Unprocessable Content', 423 => 'Locked', 424 => 'Failed Dependency', 425 => 'Too Early', 426 => 'Upgrade Required', 428 => 'Precondition Required', 429 => 'Too Many Requests', 431 => 'Request Header Fields Too Large', 451 => 'Unavailable For Legal Reasons', 500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Timeout', 505 => 'HTTP Version Not Supported', 506 => 'Variant Also Negotiates', 507 => 'Insufficient Storage', 508 => 'Loop Detected', 510 => 'Not Extended (OBSOLETED)', 511 => 'Network Authentication Required', } # :nodoc: PK!àËëTT3rubygems/vendor/net-http/lib/net/http/exceptions.rbnu„[µü¤# frozen_string_literal: true module Gem::Net # Gem::Net::HTTP exception class. # You cannot use Gem::Net::HTTPExceptions directly; instead, you must use # its subclasses. module HTTPExceptions def initialize(msg, res) #:nodoc: super msg @response = res end attr_reader :response alias data response #:nodoc: obsolete end class HTTPError < ProtocolError include HTTPExceptions end class HTTPRetriableError < ProtoRetriableError include HTTPExceptions end class HTTPClientException < ProtoServerError include HTTPExceptions end class HTTPFatalError < ProtoFatalError include HTTPExceptions end # We cannot use the name "HTTPServerError", it is the name of the response. HTTPServerException = HTTPClientException # :nodoc: deprecate_constant(:HTTPServerException) end PK!qt!aóó/rubygems/vendor/net-http/lib/net/http/header.rbnu„[µü¤# frozen_string_literal: true # # The \HTTPHeader module provides access to \HTTP headers. # # The module is included in: # # - Gem::Net::HTTPGenericRequest (and therefore Gem::Net::HTTPRequest). # - Gem::Net::HTTPResponse. # # The headers are a hash-like collection of key/value pairs called _fields_. # # == Request and Response Fields # # Headers may be included in: # # - A Gem::Net::HTTPRequest object: # the object's headers will be sent with the request. # Any fields may be defined in the request; # see {Setters}[rdoc-ref:Gem::Net::HTTPHeader@Setters]. # - A Gem::Net::HTTPResponse object: # the objects headers are usually those returned from the host. # Fields may be retrieved from the object; # see {Getters}[rdoc-ref:Gem::Net::HTTPHeader@Getters] # and {Iterators}[rdoc-ref:Gem::Net::HTTPHeader@Iterators]. # # Exactly which fields should be sent or expected depends on the host; # see: # # - {Request fields}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Request_fields]. # - {Response fields}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Response_fields]. # # == About the Examples # # :include: doc/net-http/examples.rdoc # # == Fields # # A header field is a key/value pair. # # === Field Keys # # A field key may be: # # - A string: Key 'Accept' is treated as if it were # 'Accept'.downcase; i.e., 'accept'. # - A symbol: Key :Accept is treated as if it were # :Accept.to_s.downcase; i.e., 'accept'. # # Examples: # # req = Gem::Net::HTTP::Get.new(uri) # req[:accept] # => "*/*" # req['Accept'] # => "*/*" # req['ACCEPT'] # => "*/*" # # req['accept'] = 'text/html' # req[:accept] = 'text/html' # req['ACCEPT'] = 'text/html' # # === Field Values # # A field value may be returned as an array of strings or as a string: # # - These methods return field values as arrays: # # - #get_fields: Returns the array value for the given key, # or +nil+ if it does not exist. # - #to_hash: Returns a hash of all header fields: # each key is a field name; its value is the array value for the field. # # - These methods return field values as string; # the string value for a field is equivalent to # self[key.downcase.to_s].join(', ')): # # - #[]: Returns the string value for the given key, # or +nil+ if it does not exist. # - #fetch: Like #[], but accepts a default value # to be returned if the key does not exist. # # The field value may be set: # # - #[]=: Sets the value for the given key; # the given value may be a string, a symbol, an array, or a hash. # - #add_field: Adds a given value to a value for the given key # (not overwriting the existing value). # - #delete: Deletes the field for the given key. # # Example field values: # # - \String: # # req['Accept'] = 'text/html' # => "text/html" # req['Accept'] # => "text/html" # req.get_fields('Accept') # => ["text/html"] # # - \Symbol: # # req['Accept'] = :text # => :text # req['Accept'] # => "text" # req.get_fields('Accept') # => ["text"] # # - Simple array: # # req[:foo] = %w[bar baz bat] # req[:foo] # => "bar, baz, bat" # req.get_fields(:foo) # => ["bar", "baz", "bat"] # # - Simple hash: # # req[:foo] = {bar: 0, baz: 1, bat: 2} # req[:foo] # => "bar, 0, baz, 1, bat, 2" # req.get_fields(:foo) # => ["bar", "0", "baz", "1", "bat", "2"] # # - Nested: # # req[:foo] = [%w[bar baz], {bat: 0, bam: 1}] # req[:foo] # => "bar, baz, bat, 0, bam, 1" # req.get_fields(:foo) # => ["bar", "baz", "bat", "0", "bam", "1"] # # req[:foo] = {bar: %w[baz bat], bam: {bah: 0, bad: 1}} # req[:foo] # => "bar, baz, bat, bam, bah, 0, bad, 1" # req.get_fields(:foo) # => ["bar", "baz", "bat", "bam", "bah", "0", "bad", "1"] # # == Convenience Methods # # Various convenience methods retrieve values, set values, query values, # set form values, or iterate over fields. # # === Setters # # \Method #[]= can set any field, but does little to validate the new value; # some of the other setter methods provide some validation: # # - #[]=: Sets the string or array value for the given key. # - #add_field: Creates or adds to the array value for the given key. # - #basic_auth: Sets the string authorization header for 'Authorization'. # - #content_length=: Sets the integer length for field 'Content-Length. # - #content_type=: Sets the string value for field 'Content-Type'. # - #proxy_basic_auth: Sets the string authorization header for 'Proxy-Authorization'. # - #set_range: Sets the value for field 'Range'. # # === Form Setters # # - #set_form: Sets an HTML form data set. # - #set_form_data: Sets header fields and a body from HTML form data. # # === Getters # # \Method #[] can retrieve the value of any field that exists, # but always as a string; # some of the other getter methods return something different # from the simple string value: # # - #[]: Returns the string field value for the given key. # - #content_length: Returns the integer value of field 'Content-Length'. # - #content_range: Returns the Range value of field 'Content-Range'. # - #content_type: Returns the string value of field 'Content-Type'. # - #fetch: Returns the string field value for the given key. # - #get_fields: Returns the array field value for the given +key+. # - #main_type: Returns first part of the string value of field 'Content-Type'. # - #sub_type: Returns second part of the string value of field 'Content-Type'. # - #range: Returns an array of Range objects of field 'Range', or +nil+. # - #range_length: Returns the integer length of the range given in field 'Content-Range'. # - #type_params: Returns the string parameters for 'Content-Type'. # # === Queries # # - #chunked?: Returns whether field 'Transfer-Encoding' is set to 'chunked'. # - #connection_close?: Returns whether field 'Connection' is set to 'close'. # - #connection_keep_alive?: Returns whether field 'Connection' is set to 'keep-alive'. # - #key?: Returns whether a given key exists. # # === Iterators # # - #each_capitalized: Passes each field capitalized-name/value pair to the block. # - #each_capitalized_name: Passes each capitalized field name to the block. # - #each_header: Passes each field name/value pair to the block. # - #each_name: Passes each field name to the block. # - #each_value: Passes each string field value to the block. # module Gem::Net::HTTPHeader MAX_KEY_LENGTH = 1024 MAX_FIELD_LENGTH = 65536 def initialize_http_header(initheader) #:nodoc: @header = {} return unless initheader initheader.each do |key, value| warn "net/http: duplicated HTTP header: #{key}", uplevel: 3 if key?(key) and $VERBOSE if value.nil? warn "net/http: nil HTTP header: #{key}", uplevel: 3 if $VERBOSE else value = value.strip # raise error for invalid byte sequences if key.to_s.bytesize > MAX_KEY_LENGTH raise ArgumentError, "too long (#{key.bytesize} bytes) header: #{key[0, 30].inspect}..." end if value.to_s.bytesize > MAX_FIELD_LENGTH raise ArgumentError, "header #{key} has too long field value: #{value.bytesize}" end if value.count("\r\n") > 0 raise ArgumentError, "header #{key} has field value #{value.inspect}, this cannot include CR/LF" end @header[key.downcase.to_s] = [value] end end end def size #:nodoc: obsolete @header.size end alias length size #:nodoc: obsolete # Returns the string field value for the case-insensitive field +key+, # or +nil+ if there is no such key; # see {Fields}[rdoc-ref:Gem::Net::HTTPHeader@Fields]: # # res = Gem::Net::HTTP.get_response(hostname, '/todos/1') # res['Connection'] # => "keep-alive" # res['Nosuch'] # => nil # # Note that some field values may be retrieved via convenience methods; # see {Getters}[rdoc-ref:Gem::Net::HTTPHeader@Getters]. def [](key) a = @header[key.downcase.to_s] or return nil a.join(', ') end # Sets the value for the case-insensitive +key+ to +val+, # overwriting the previous value if the field exists; # see {Fields}[rdoc-ref:Gem::Net::HTTPHeader@Fields]: # # req = Gem::Net::HTTP::Get.new(uri) # req['Accept'] # => "*/*" # req['Accept'] = 'text/html' # req['Accept'] # => "text/html" # # Note that some field values may be set via convenience methods; # see {Setters}[rdoc-ref:Gem::Net::HTTPHeader@Setters]. def []=(key, val) unless val @header.delete key.downcase.to_s return val end set_field(key, val) end # Adds value +val+ to the value array for field +key+ if the field exists; # creates the field with the given +key+ and +val+ if it does not exist. # see {Fields}[rdoc-ref:Gem::Net::HTTPHeader@Fields]: # # req = Gem::Net::HTTP::Get.new(uri) # req.add_field('Foo', 'bar') # req['Foo'] # => "bar" # req.add_field('Foo', 'baz') # req['Foo'] # => "bar, baz" # req.add_field('Foo', %w[baz bam]) # req['Foo'] # => "bar, baz, baz, bam" # req.get_fields('Foo') # => ["bar", "baz", "baz", "bam"] # def add_field(key, val) stringified_downcased_key = key.downcase.to_s if @header.key?(stringified_downcased_key) append_field_value(@header[stringified_downcased_key], val) else set_field(key, val) end end private def set_field(key, val) case val when Enumerable ary = [] append_field_value(ary, val) @header[key.downcase.to_s] = ary else val = val.to_s # for compatibility use to_s instead of to_str if val.b.count("\r\n") > 0 raise ArgumentError, 'header field value cannot include CR/LF' end @header[key.downcase.to_s] = [val] end end private def append_field_value(ary, val) case val when Enumerable val.each{|x| append_field_value(ary, x)} else val = val.to_s if /[\r\n]/n.match?(val.b) raise ArgumentError, 'header field value cannot include CR/LF' end ary.push val end end # Returns the array field value for the given +key+, # or +nil+ if there is no such field; # see {Fields}[rdoc-ref:Gem::Net::HTTPHeader@Fields]: # # res = Gem::Net::HTTP.get_response(hostname, '/todos/1') # res.get_fields('Connection') # => ["keep-alive"] # res.get_fields('Nosuch') # => nil # def get_fields(key) stringified_downcased_key = key.downcase.to_s return nil unless @header[stringified_downcased_key] @header[stringified_downcased_key].dup end # call-seq: # fetch(key, default_val = nil) {|key| ... } -> object # fetch(key, default_val = nil) -> value or default_val # # With a block, returns the string value for +key+ if it exists; # otherwise returns the value of the block; # ignores the +default_val+; # see {Fields}[rdoc-ref:Gem::Net::HTTPHeader@Fields]: # # res = Gem::Net::HTTP.get_response(hostname, '/todos/1') # # # Field exists; block not called. # res.fetch('Connection') do |value| # fail 'Cannot happen' # end # => "keep-alive" # # # Field does not exist; block called. # res.fetch('Nosuch') do |value| # value.downcase # end # => "nosuch" # # With no block, returns the string value for +key+ if it exists; # otherwise, returns +default_val+ if it was given; # otherwise raises an exception: # # res.fetch('Connection', 'Foo') # => "keep-alive" # res.fetch('Nosuch', 'Foo') # => "Foo" # res.fetch('Nosuch') # Raises KeyError. # def fetch(key, *args, &block) #:yield: +key+ a = @header.fetch(key.downcase.to_s, *args, &block) a.kind_of?(Array) ? a.join(', ') : a end # Calls the block with each key/value pair: # # res = Gem::Net::HTTP.get_response(hostname, '/todos/1') # res.each_header do |key, value| # p [key, value] if key.start_with?('c') # end # # Output: # # ["content-type", "application/json; charset=utf-8"] # ["connection", "keep-alive"] # ["cache-control", "max-age=43200"] # ["cf-cache-status", "HIT"] # ["cf-ray", "771d17e9bc542cf5-ORD"] # # Returns an enumerator if no block is given. # # Gem::Net::HTTPHeader#each is an alias for Gem::Net::HTTPHeader#each_header. def each_header #:yield: +key+, +value+ block_given? or return enum_for(__method__) { @header.size } @header.each do |k,va| yield k, va.join(', ') end end alias each each_header # Calls the block with each field key: # # res = Gem::Net::HTTP.get_response(hostname, '/todos/1') # res.each_key do |key| # p key if key.start_with?('c') # end # # Output: # # "content-type" # "connection" # "cache-control" # "cf-cache-status" # "cf-ray" # # Returns an enumerator if no block is given. # # Gem::Net::HTTPHeader#each_name is an alias for Gem::Net::HTTPHeader#each_key. def each_name(&block) #:yield: +key+ block_given? or return enum_for(__method__) { @header.size } @header.each_key(&block) end alias each_key each_name # Calls the block with each capitalized field name: # # res = Gem::Net::HTTP.get_response(hostname, '/todos/1') # res.each_capitalized_name do |key| # p key if key.start_with?('C') # end # # Output: # # "Content-Type" # "Connection" # "Cache-Control" # "Cf-Cache-Status" # "Cf-Ray" # # The capitalization is system-dependent; # see {Case Mapping}[https://docs.ruby-lang.org/en/master/case_mapping_rdoc.html]. # # Returns an enumerator if no block is given. def each_capitalized_name #:yield: +key+ block_given? or return enum_for(__method__) { @header.size } @header.each_key do |k| yield capitalize(k) end end # Calls the block with each string field value: # # res = Gem::Net::HTTP.get_response(hostname, '/todos/1') # res.each_value do |value| # p value if value.start_with?('c') # end # # Output: # # "chunked" # "cf-q-config;dur=6.0000002122251e-06" # "cloudflare" # # Returns an enumerator if no block is given. def each_value #:yield: +value+ block_given? or return enum_for(__method__) { @header.size } @header.each_value do |va| yield va.join(', ') end end # Removes the header for the given case-insensitive +key+ # (see {Fields}[rdoc-ref:Gem::Net::HTTPHeader@Fields]); # returns the deleted value, or +nil+ if no such field exists: # # req = Gem::Net::HTTP::Get.new(uri) # req.delete('Accept') # => ["*/*"] # req.delete('Nosuch') # => nil # def delete(key) @header.delete(key.downcase.to_s) end # Returns +true+ if the field for the case-insensitive +key+ exists, +false+ otherwise: # # req = Gem::Net::HTTP::Get.new(uri) # req.key?('Accept') # => true # req.key?('Nosuch') # => false # def key?(key) @header.key?(key.downcase.to_s) end # Returns a hash of the key/value pairs: # # req = Gem::Net::HTTP::Get.new(uri) # req.to_hash # # => # {"accept-encoding"=>["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"], # "accept"=>["*/*"], # "user-agent"=>["Ruby"], # "host"=>["jsonplaceholder.typicode.com"]} # def to_hash @header.dup end # Like #each_header, but the keys are returned in capitalized form. # # Gem::Net::HTTPHeader#canonical_each is an alias for Gem::Net::HTTPHeader#each_capitalized. def each_capitalized block_given? or return enum_for(__method__) { @header.size } @header.each do |k,v| yield capitalize(k), v.join(', ') end end alias canonical_each each_capitalized def capitalize(name) name.to_s.split(/-/).map {|s| s.capitalize }.join('-') end private :capitalize # Returns an array of Range objects that represent # the value of field 'Range', # or +nil+ if there is no such field; # see {Range request header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#range-request-header]: # # req = Gem::Net::HTTP::Get.new(uri) # req['Range'] = 'bytes=0-99,200-299,400-499' # req.range # => [0..99, 200..299, 400..499] # req.delete('Range') # req.range # # => nil # def range return nil unless @header['range'] value = self['Range'] # byte-range-set = *( "," OWS ) ( byte-range-spec / suffix-byte-range-spec ) # *( OWS "," [ OWS ( byte-range-spec / suffix-byte-range-spec ) ] ) # corrected collected ABNF # http://tools.ietf.org/html/draft-ietf-httpbis-p5-range-19#section-5.4.1 # http://tools.ietf.org/html/draft-ietf-httpbis-p5-range-19#appendix-C # http://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-19#section-3.2.5 unless /\Abytes=((?:,[ \t]*)*(?:\d+-\d*|-\d+)(?:[ \t]*,(?:[ \t]*\d+-\d*|-\d+)?)*)\z/ =~ value raise Gem::Net::HTTPHeaderSyntaxError, "invalid syntax for byte-ranges-specifier: '#{value}'" end byte_range_set = $1 result = byte_range_set.split(/,/).map {|spec| m = /(\d+)?\s*-\s*(\d+)?/i.match(spec) or raise Gem::Net::HTTPHeaderSyntaxError, "invalid byte-range-spec: '#{spec}'" d1 = m[1].to_i d2 = m[2].to_i if m[1] and m[2] if d1 > d2 raise Gem::Net::HTTPHeaderSyntaxError, "last-byte-pos MUST greater than or equal to first-byte-pos but '#{spec}'" end d1..d2 elsif m[1] d1..-1 elsif m[2] -d2..-1 else raise Gem::Net::HTTPHeaderSyntaxError, 'range is not specified' end } # if result.empty? # byte-range-set must include at least one byte-range-spec or suffix-byte-range-spec # but above regexp already denies it. if result.size == 1 && result[0].begin == 0 && result[0].end == -1 raise Gem::Net::HTTPHeaderSyntaxError, 'only one suffix-byte-range-spec with zero suffix-length' end result end # call-seq: # set_range(length) -> length # set_range(offset, length) -> range # set_range(begin..length) -> range # # Sets the value for field 'Range'; # see {Range request header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#range-request-header]: # # With argument +length+: # # req = Gem::Net::HTTP::Get.new(uri) # req.set_range(100) # => 100 # req['Range'] # => "bytes=0-99" # # With arguments +offset+ and +length+: # # req.set_range(100, 100) # => 100...200 # req['Range'] # => "bytes=100-199" # # With argument +range+: # # req.set_range(100..199) # => 100..199 # req['Range'] # => "bytes=100-199" # # Gem::Net::HTTPHeader#range= is an alias for Gem::Net::HTTPHeader#set_range. def set_range(r, e = nil) unless r @header.delete 'range' return r end r = (r...r+e) if e case r when Numeric n = r.to_i rangestr = (n > 0 ? "0-#{n-1}" : "-#{-n}") when Range first = r.first last = r.end last -= 1 if r.exclude_end? if last == -1 rangestr = (first > 0 ? "#{first}-" : "-#{-first}") else raise Gem::Net::HTTPHeaderSyntaxError, 'range.first is negative' if first < 0 raise Gem::Net::HTTPHeaderSyntaxError, 'range.last is negative' if last < 0 raise Gem::Net::HTTPHeaderSyntaxError, 'must be .first < .last' if first > last rangestr = "#{first}-#{last}" end else raise TypeError, 'Range/Integer is required' end @header['range'] = ["bytes=#{rangestr}"] r end alias range= set_range # Returns the value of field 'Content-Length' as an integer, # or +nil+ if there is no such field; # see {Content-Length request header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-length-request-header]: # # res = Gem::Net::HTTP.get_response(hostname, '/nosuch/1') # res.content_length # => 2 # res = Gem::Net::HTTP.get_response(hostname, '/todos/1') # res.content_length # => nil # def content_length return nil unless key?('Content-Length') len = self['Content-Length'].slice(/\d+/) or raise Gem::Net::HTTPHeaderSyntaxError, 'wrong Content-Length format' len.to_i end # Sets the value of field 'Content-Length' to the given numeric; # see {Content-Length response header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-length-response-header]: # # _uri = uri.dup # hostname = _uri.hostname # => "jsonplaceholder.typicode.com" # _uri.path = '/posts' # => "/posts" # req = Gem::Net::HTTP::Post.new(_uri) # => # # req.body = '{"title": "foo","body": "bar","userId": 1}' # req.content_length = req.body.size # => 42 # req.content_type = 'application/json' # res = Gem::Net::HTTP.start(hostname) do |http| # http.request(req) # end # => # # def content_length=(len) unless len @header.delete 'content-length' return nil end @header['content-length'] = [len.to_i.to_s] end # Returns +true+ if field 'Transfer-Encoding' # exists and has value 'chunked', # +false+ otherwise; # see {Transfer-Encoding response header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#transfer-encoding-response-header]: # # res = Gem::Net::HTTP.get_response(hostname, '/todos/1') # res['Transfer-Encoding'] # => "chunked" # res.chunked? # => true # def chunked? return false unless @header['transfer-encoding'] field = self['Transfer-Encoding'] (/(?:\A|[^\-\w])chunked(?![\-\w])/i =~ field) ? true : false end # Returns a Range object representing the value of field # 'Content-Range', or +nil+ if no such field exists; # see {Content-Range response header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-range-response-header]: # # res = Gem::Net::HTTP.get_response(hostname, '/todos/1') # res['Content-Range'] # => nil # res['Content-Range'] = 'bytes 0-499/1000' # res['Content-Range'] # => "bytes 0-499/1000" # res.content_range # => 0..499 # def content_range return nil unless @header['content-range'] m = %r<\A\s*(\w+)\s+(\d+)-(\d+)/(\d+|\*)>.match(self['Content-Range']) or raise Gem::Net::HTTPHeaderSyntaxError, 'wrong Content-Range format' return unless m[1] == 'bytes' m[2].to_i .. m[3].to_i end # Returns the integer representing length of the value of field # 'Content-Range', or +nil+ if no such field exists; # see {Content-Range response header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-range-response-header]: # # res = Gem::Net::HTTP.get_response(hostname, '/todos/1') # res['Content-Range'] # => nil # res['Content-Range'] = 'bytes 0-499/1000' # res.range_length # => 500 # def range_length r = content_range() or return nil r.end - r.begin + 1 end # Returns the {media type}[https://en.wikipedia.org/wiki/Media_type] # from the value of field 'Content-Type', # or +nil+ if no such field exists; # see {Content-Type response header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-type-response-header]: # # res = Gem::Net::HTTP.get_response(hostname, '/todos/1') # res['content-type'] # => "application/json; charset=utf-8" # res.content_type # => "application/json" # def content_type main = main_type() return nil unless main sub = sub_type() if sub "#{main}/#{sub}" else main end end # Returns the leading ('type') part of the # {media type}[https://en.wikipedia.org/wiki/Media_type] # from the value of field 'Content-Type', # or +nil+ if no such field exists; # see {Content-Type response header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-type-response-header]: # # res = Gem::Net::HTTP.get_response(hostname, '/todos/1') # res['content-type'] # => "application/json; charset=utf-8" # res.main_type # => "application" # def main_type return nil unless @header['content-type'] self['Content-Type'].split(';').first.to_s.split('/')[0].to_s.strip end # Returns the trailing ('subtype') part of the # {media type}[https://en.wikipedia.org/wiki/Media_type] # from the value of field 'Content-Type', # or +nil+ if no such field exists; # see {Content-Type response header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-type-response-header]: # # res = Gem::Net::HTTP.get_response(hostname, '/todos/1') # res['content-type'] # => "application/json; charset=utf-8" # res.sub_type # => "json" # def sub_type return nil unless @header['content-type'] _, sub = *self['Content-Type'].split(';').first.to_s.split('/') return nil unless sub sub.strip end # Returns the trailing ('parameters') part of the value of field 'Content-Type', # or +nil+ if no such field exists; # see {Content-Type response header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-type-response-header]: # # res = Gem::Net::HTTP.get_response(hostname, '/todos/1') # res['content-type'] # => "application/json; charset=utf-8" # res.type_params # => {"charset"=>"utf-8"} # def type_params result = {} list = self['Content-Type'].to_s.split(';') list.shift list.each do |param| k, v = *param.split('=', 2) result[k.strip] = v.strip end result end # Sets the value of field 'Content-Type'; # returns the new value; # see {Content-Type request header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-type-request-header]: # # req = Gem::Net::HTTP::Get.new(uri) # req.set_content_type('application/json') # => ["application/json"] # # Gem::Net::HTTPHeader#content_type= is an alias for Gem::Net::HTTPHeader#set_content_type. def set_content_type(type, params = {}) @header['content-type'] = [type + params.map{|k,v|"; #{k}=#{v}"}.join('')] end alias content_type= set_content_type # Sets the request body to a URL-encoded string derived from argument +params+, # and sets request header field 'Content-Type' # to 'application/x-www-form-urlencoded'. # # The resulting request is suitable for HTTP request +POST+ or +PUT+. # # Argument +params+ must be suitable for use as argument +enum+ to # {Gem::URI.encode_www_form}[https://docs.ruby-lang.org/en/master/Gem::URI.html#method-c-encode_www_form]. # # With only argument +params+ given, # sets the body to a URL-encoded string with the default separator '&': # # req = Gem::Net::HTTP::Post.new('example.com') # # req.set_form_data(q: 'ruby', lang: 'en') # req.body # => "q=ruby&lang=en" # req['Content-Type'] # => "application/x-www-form-urlencoded" # # req.set_form_data([['q', 'ruby'], ['lang', 'en']]) # req.body # => "q=ruby&lang=en" # # req.set_form_data(q: ['ruby', 'perl'], lang: 'en') # req.body # => "q=ruby&q=perl&lang=en" # # req.set_form_data([['q', 'ruby'], ['q', 'perl'], ['lang', 'en']]) # req.body # => "q=ruby&q=perl&lang=en" # # With string argument +sep+ also given, # uses that string as the separator: # # req.set_form_data({q: 'ruby', lang: 'en'}, '|') # req.body # => "q=ruby|lang=en" # # Gem::Net::HTTPHeader#form_data= is an alias for Gem::Net::HTTPHeader#set_form_data. def set_form_data(params, sep = '&') query = Gem::URI.encode_www_form(params) query.gsub!(/&/, sep) if sep != '&' self.body = query self.content_type = 'application/x-www-form-urlencoded' end alias form_data= set_form_data # Stores form data to be used in a +POST+ or +PUT+ request. # # The form data given in +params+ consists of zero or more fields; # each field is: # # - A scalar value. # - A name/value pair. # - An IO stream opened for reading. # # Argument +params+ should be an # {Enumerable}[https://docs.ruby-lang.org/en/master/Enumerable.html#module-Enumerable-label-Enumerable+in+Ruby+Classes] # (method params.map will be called), # and is often an array or hash. # # First, we set up a request: # # _uri = uri.dup # _uri.path ='/posts' # req = Gem::Net::HTTP::Post.new(_uri) # # Argument +params+ As an Array # # When +params+ is an array, # each of its elements is a subarray that defines a field; # the subarray may contain: # # - One string: # # req.set_form([['foo'], ['bar'], ['baz']]) # # - Two strings: # # req.set_form([%w[foo 0], %w[bar 1], %w[baz 2]]) # # - When argument +enctype+ (see below) is given as # 'multipart/form-data': # # - A string name and an IO stream opened for reading: # # require 'stringio' # req.set_form([['file', StringIO.new('Ruby is cool.')]]) # # - A string name, an IO stream opened for reading, # and an options hash, which may contain these entries: # # - +:filename+: The name of the file to use. # - +:content_type+: The content type of the uploaded file. # # Example: # # req.set_form([['file', file, {filename: "other-filename.foo"}]] # # The various forms may be mixed: # # req.set_form(['foo', %w[bar 1], ['file', file]]) # # Argument +params+ As a Hash # # When +params+ is a hash, # each of its entries is a name/value pair that defines a field: # # - The name is a string. # - The value may be: # # - +nil+. # - Another string. # - An IO stream opened for reading # (only when argument +enctype+ -- see below -- is given as # 'multipart/form-data'). # # Examples: # # # Nil-valued fields. # req.set_form({'foo' => nil, 'bar' => nil, 'baz' => nil}) # # # String-valued fields. # req.set_form({'foo' => 0, 'bar' => 1, 'baz' => 2}) # # # IO-valued field. # require 'stringio' # req.set_form({'file' => StringIO.new('Ruby is cool.')}) # # # Mixture of fields. # req.set_form({'foo' => nil, 'bar' => 1, 'file' => file}) # # Optional argument +enctype+ specifies the value to be given # to field 'Content-Type', and must be one of: # # - 'application/x-www-form-urlencoded' (the default). # - 'multipart/form-data'; # see {RFC 7578}[https://www.rfc-editor.org/rfc/rfc7578]. # # Optional argument +formopt+ is a hash of options # (applicable only when argument +enctype+ # is 'multipart/form-data') # that may include the following entries: # # - +:boundary+: The value is the boundary string for the multipart message. # If not given, the boundary is a random string. # See {Boundary}[https://www.rfc-editor.org/rfc/rfc7578#section-4.1]. # - +:charset+: Value is the character set for the form submission. # Field names and values of non-file fields should be encoded with this charset. # def set_form(params, enctype='application/x-www-form-urlencoded', formopt={}) @body_data = params @body = nil @body_stream = nil @form_option = formopt case enctype when /\Aapplication\/x-www-form-urlencoded\z/i, /\Amultipart\/form-data\z/i self.content_type = enctype else raise ArgumentError, "invalid enctype: #{enctype}" end end # Sets header 'Authorization' using the given # +account+ and +password+ strings: # # req.basic_auth('my_account', 'my_password') # req['Authorization'] # # => "Basic bXlfYWNjb3VudDpteV9wYXNzd29yZA==" # def basic_auth(account, password) @header['authorization'] = [basic_encode(account, password)] end # Sets header 'Proxy-Authorization' using the given # +account+ and +password+ strings: # # req.proxy_basic_auth('my_account', 'my_password') # req['Proxy-Authorization'] # # => "Basic bXlfYWNjb3VudDpteV9wYXNzd29yZA==" # def proxy_basic_auth(account, password) @header['proxy-authorization'] = [basic_encode(account, password)] end def basic_encode(account, password) 'Basic ' + ["#{account}:#{password}"].pack('m0') end private :basic_encode # Returns whether the HTTP session is to be closed. def connection_close? token = /(?:\A|,)\s*close\s*(?:\z|,)/i @header['connection']&.grep(token) {return true} @header['proxy-connection']&.grep(token) {return true} false end # Returns whether the HTTP session is to be kept alive. def connection_keep_alive? token = /(?:\A|,)\s*keep-alive\s*(?:\z|,)/i @header['connection']&.grep(token) {return true} @header['proxy-connection']&.grep(token) {return true} false end end PK!‡sN€tŸtŸ2rubygems/vendor/net-http/lib/net/http/responses.rbnu„[µü¤# frozen_string_literal: true #-- # https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml module Gem::Net class HTTPUnknownResponse < HTTPResponse HAS_BODY = true EXCEPTION_TYPE = HTTPError # end # Parent class for informational (1xx) HTTP response classes. # # An informational response indicates that the request was received and understood. # # References: # # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#status.1xx]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#1xx_informational_response]. # class HTTPInformation < HTTPResponse HAS_BODY = false EXCEPTION_TYPE = HTTPError # end # Parent class for success (2xx) HTTP response classes. # # A success response indicates the action requested by the client # was received, understood, and accepted. # # References: # # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#status.2xx]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#2xx_success]. # class HTTPSuccess < HTTPResponse HAS_BODY = true EXCEPTION_TYPE = HTTPError # end # Parent class for redirection (3xx) HTTP response classes. # # A redirection response indicates the client must take additional action # to complete the request. # # References: # # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#status.3xx]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#3xx_redirection]. # class HTTPRedirection < HTTPResponse HAS_BODY = true EXCEPTION_TYPE = HTTPRetriableError # end # Parent class for client error (4xx) HTTP response classes. # # A client error response indicates that the client may have caused an error. # # References: # # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#status.4xx]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#4xx_client_errors]. # class HTTPClientError < HTTPResponse HAS_BODY = true EXCEPTION_TYPE = HTTPClientException # end # Parent class for server error (5xx) HTTP response classes. # # A server error response indicates that the server failed to fulfill a request. # # References: # # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#status.5xx]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#5xx_server_errors]. # class HTTPServerError < HTTPResponse HAS_BODY = true EXCEPTION_TYPE = HTTPFatalError # end # Response class for +Continue+ responses (status code 100). # # A +Continue+ response indicates that the server has received the request headers. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/100]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-100-continue]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#100]. # class HTTPContinue < HTTPInformation HAS_BODY = false end # Response class for Switching Protocol responses (status code 101). # # The Switching Protocol response indicates that the server has received # a request to switch protocols, and has agreed to do so. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/101]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-101-switching-protocols]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#101]. # class HTTPSwitchProtocol < HTTPInformation HAS_BODY = false end # Response class for +Processing+ responses (status code 102). # # The +Processing+ response indicates that the server has received # and is processing the request, but no response is available yet. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {RFC 2518}[https://www.rfc-editor.org/rfc/rfc2518#section-10.1]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#102]. # class HTTPProcessing < HTTPInformation HAS_BODY = false end # Response class for Early Hints responses (status code 103). # # The Early Hints indicates that the server has received # and is processing the request, and contains certain headers; # the final response is not available yet. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/103]. # - {RFC 8297}[https://www.rfc-editor.org/rfc/rfc8297.html#section-2]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#103]. # class HTTPEarlyHints < HTTPInformation HAS_BODY = false end # Response class for +OK+ responses (status code 200). # # The +OK+ response indicates that the server has received # a request and has responded successfully. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#200]. # class HTTPOK < HTTPSuccess HAS_BODY = true end # Response class for +Created+ responses (status code 201). # # The +Created+ response indicates that the server has received # and has fulfilled a request to create a new resource. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-201-created]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#201]. # class HTTPCreated < HTTPSuccess HAS_BODY = true end # Response class for +Accepted+ responses (status code 202). # # The +Accepted+ response indicates that the server has received # and is processing a request, but the processing has not yet been completed. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-202-accepted]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#202]. # class HTTPAccepted < HTTPSuccess HAS_BODY = true end # Response class for Non-Authoritative Information responses (status code 203). # # The Non-Authoritative Information response indicates that the server # is a transforming proxy (such as a Web accelerator) # that received a 200 OK response from its origin, # and is returning a modified version of the origin's response. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/203]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-203-non-authoritative-infor]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#203]. # class HTTPNonAuthoritativeInformation < HTTPSuccess HAS_BODY = true end # Response class for No Content responses (status code 204). # # The No Content response indicates that the server # successfully processed the request, and is not returning any content. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-204-no-content]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#204]. # class HTTPNoContent < HTTPSuccess HAS_BODY = false end # Response class for Reset Content responses (status code 205). # # The Reset Content response indicates that the server # successfully processed the request, # asks that the client reset its document view, and is not returning any content. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/205]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-205-reset-content]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#205]. # class HTTPResetContent < HTTPSuccess HAS_BODY = false end # Response class for Partial Content responses (status code 206). # # The Partial Content response indicates that the server is delivering # only part of the resource (byte serving) # due to a Range header in the request. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/206]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-206-partial-content]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#206]. # class HTTPPartialContent < HTTPSuccess HAS_BODY = true end # Response class for Multi-Status (WebDAV) responses (status code 207). # # The Multi-Status (WebDAV) response indicates that the server # has received the request, # and that the message body can contain a number of separate response codes. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {RFC 4818}[https://www.rfc-editor.org/rfc/rfc4918#section-11.1]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#207]. # class HTTPMultiStatus < HTTPSuccess HAS_BODY = true end # Response class for Already Reported (WebDAV) responses (status code 208). # # The Already Reported (WebDAV) response indicates that the server # has received the request, # and that the members of a DAV binding have already been enumerated # in a preceding part of the (multi-status) response, # and are not being included again. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {RFC 5842}[https://www.rfc-editor.org/rfc/rfc5842.html#section-7.1]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#208]. # class HTTPAlreadyReported < HTTPSuccess HAS_BODY = true end # Response class for IM Used responses (status code 226). # # The IM Used response indicates that the server has fulfilled a request # for the resource, and the response is a representation of the result # of one or more instance-manipulations applied to the current instance. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {RFC 3229}[https://www.rfc-editor.org/rfc/rfc3229.html#section-10.4.1]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#226]. # class HTTPIMUsed < HTTPSuccess HAS_BODY = true end # Response class for Multiple Choices responses (status code 300). # # The Multiple Choices response indicates that the server # offers multiple options for the resource from which the client may choose. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/300]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-300-multiple-choices]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#300]. # class HTTPMultipleChoices < HTTPRedirection HAS_BODY = true end HTTPMultipleChoice = HTTPMultipleChoices # Response class for Moved Permanently responses (status code 301). # # The Moved Permanently response indicates that links or records # returning this response should be updated to use the given URL. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-301-moved-permanently]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#301]. # class HTTPMovedPermanently < HTTPRedirection HAS_BODY = true end # Response class for Found responses (status code 302). # # The Found response indicates that the client # should look at (browse to) another URL. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-302-found]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#302]. # class HTTPFound < HTTPRedirection HAS_BODY = true end HTTPMovedTemporarily = HTTPFound # Response class for See Other responses (status code 303). # # The response to the request can be found under another Gem::URI using the GET method. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/303]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-303-see-other]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#303]. # class HTTPSeeOther < HTTPRedirection HAS_BODY = true end # Response class for Not Modified responses (status code 304). # # Indicates that the resource has not been modified since the version # specified by the request headers. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/304]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-304-not-modified]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#304]. # class HTTPNotModified < HTTPRedirection HAS_BODY = false end # Response class for Use Proxy responses (status code 305). # # The requested resource is available only through a proxy, # whose address is provided in the response. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-305-use-proxy]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#305]. # class HTTPUseProxy < HTTPRedirection HAS_BODY = false end # Response class for Temporary Redirect responses (status code 307). # # The request should be repeated with another Gem::URI; # however, future requests should still use the original Gem::URI. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/307]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-307-temporary-redirect]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#307]. # class HTTPTemporaryRedirect < HTTPRedirection HAS_BODY = true end # Response class for Permanent Redirect responses (status code 308). # # This and all future requests should be directed to the given Gem::URI. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/308]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-308-permanent-redirect]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#308]. # class HTTPPermanentRedirect < HTTPRedirection HAS_BODY = true end # Response class for Bad Request responses (status code 400). # # The server cannot or will not process the request due to an apparent client error. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#400]. # class HTTPBadRequest < HTTPClientError HAS_BODY = true end # Response class for Unauthorized responses (status code 401). # # Authentication is required, but either was not provided or failed. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-401-unauthorized]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#401]. # class HTTPUnauthorized < HTTPClientError HAS_BODY = true end # Response class for Payment Required responses (status code 402). # # Reserved for future use. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-402-payment-required]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#402]. # class HTTPPaymentRequired < HTTPClientError HAS_BODY = true end # Response class for Forbidden responses (status code 403). # # The request contained valid data and was understood by the server, # but the server is refusing action. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/403]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#403]. # class HTTPForbidden < HTTPClientError HAS_BODY = true end # Response class for Not Found responses (status code 404). # # The requested resource could not be found but may be available in the future. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#404]. # class HTTPNotFound < HTTPClientError HAS_BODY = true end # Response class for Method Not Allowed responses (status code 405). # # The request method is not supported for the requested resource. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/405]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-405-method-not-allowed]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#405]. # class HTTPMethodNotAllowed < HTTPClientError HAS_BODY = true end # Response class for Not Acceptable responses (status code 406). # # The requested resource is capable of generating only content # that not acceptable according to the Accept headers sent in the request. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/406]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#406]. # class HTTPNotAcceptable < HTTPClientError HAS_BODY = true end # Response class for Proxy Authentication Required responses (status code 407). # # The client must first authenticate itself with the proxy. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/407]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-407-proxy-authentication-re]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#407]. # class HTTPProxyAuthenticationRequired < HTTPClientError HAS_BODY = true end # Response class for Request Gem::Timeout responses (status code 408). # # The server timed out waiting for the request. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-408-request-timeout]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#408]. # class HTTPRequestTimeout < HTTPClientError HAS_BODY = true end HTTPRequestTimeOut = HTTPRequestTimeout # Response class for Conflict responses (status code 409). # # The request could not be processed because of conflict in the current state of the resource. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-409-conflict]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#409]. # class HTTPConflict < HTTPClientError HAS_BODY = true end # Response class for Gone responses (status code 410). # # The resource requested was previously in use but is no longer available # and will not be available again. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/410]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-410-gone]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#410]. # class HTTPGone < HTTPClientError HAS_BODY = true end # Response class for Length Required responses (status code 411). # # The request did not specify the length of its content, # which is required by the requested resource. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/411]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-411-length-required]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#411]. # class HTTPLengthRequired < HTTPClientError HAS_BODY = true end # Response class for Precondition Failed responses (status code 412). # # The server does not meet one of the preconditions # specified in the request headers. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/412]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-412-precondition-failed]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#412]. # class HTTPPreconditionFailed < HTTPClientError HAS_BODY = true end # Response class for Payload Too Large responses (status code 413). # # The request is larger than the server is willing or able to process. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/413]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-413-content-too-large]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#413]. # class HTTPPayloadTooLarge < HTTPClientError HAS_BODY = true end HTTPRequestEntityTooLarge = HTTPPayloadTooLarge # Response class for Gem::URI Too Long responses (status code 414). # # The Gem::URI provided was too long for the server to process. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/414]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-414-uri-too-long]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#414]. # class HTTPURITooLong < HTTPClientError HAS_BODY = true end HTTPRequestURITooLong = HTTPURITooLong HTTPRequestURITooLarge = HTTPRequestURITooLong # Response class for Unsupported Media Type responses (status code 415). # # The request entity has a media type which the server or resource does not support. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/415]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-415-unsupported-media-type]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#415]. # class HTTPUnsupportedMediaType < HTTPClientError HAS_BODY = true end # Response class for Range Not Satisfiable responses (status code 416). # # The request entity has a media type which the server or resource does not support. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/416]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-416-range-not-satisfiable]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#416]. # class HTTPRangeNotSatisfiable < HTTPClientError HAS_BODY = true end HTTPRequestedRangeNotSatisfiable = HTTPRangeNotSatisfiable # Response class for Expectation Failed responses (status code 417). # # The server cannot meet the requirements of the Expect request-header field. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/417]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-417-expectation-failed]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#417]. # class HTTPExpectationFailed < HTTPClientError HAS_BODY = true end # 418 I'm a teapot - RFC 2324; a joke RFC # See https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#418. # 420 Enhance Your Calm - Twitter # Response class for Misdirected Request responses (status code 421). # # The request was directed at a server that is not able to produce a response. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-421-misdirected-request]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#421]. # class HTTPMisdirectedRequest < HTTPClientError HAS_BODY = true end # Response class for Unprocessable Entity responses (status code 422). # # The request was well-formed but had semantic errors. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-422-unprocessable-content]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#422]. # class HTTPUnprocessableEntity < HTTPClientError HAS_BODY = true end # Response class for Locked (WebDAV) responses (status code 423). # # The requested resource is locked. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {RFC 4918}[https://www.rfc-editor.org/rfc/rfc4918#section-11.3]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#423]. # class HTTPLocked < HTTPClientError HAS_BODY = true end # Response class for Failed Dependency (WebDAV) responses (status code 424). # # The request failed because it depended on another request and that request failed. # See {424 Failed Dependency (WebDAV)}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#424]. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {RFC 4918}[https://www.rfc-editor.org/rfc/rfc4918#section-11.4]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#424]. # class HTTPFailedDependency < HTTPClientError HAS_BODY = true end # 425 Too Early # https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#425. # Response class for Upgrade Required responses (status code 426). # # The client should switch to the protocol given in the Upgrade header field. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/426]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-426-upgrade-required]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#426]. # class HTTPUpgradeRequired < HTTPClientError HAS_BODY = true end # Response class for Precondition Required responses (status code 428). # # The origin server requires the request to be conditional. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/428]. # - {RFC 6585}[https://www.rfc-editor.org/rfc/rfc6585#section-3]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#428]. # class HTTPPreconditionRequired < HTTPClientError HAS_BODY = true end # Response class for Too Many Requests responses (status code 429). # # The user has sent too many requests in a given amount of time. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429]. # - {RFC 6585}[https://www.rfc-editor.org/rfc/rfc6585#section-4]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429]. # class HTTPTooManyRequests < HTTPClientError HAS_BODY = true end # Response class for Request Header Fields Too Large responses (status code 431). # # An individual header field is too large, # or all the header fields collectively, are too large. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/431]. # - {RFC 6585}[https://www.rfc-editor.org/rfc/rfc6585#section-5]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#431]. # class HTTPRequestHeaderFieldsTooLarge < HTTPClientError HAS_BODY = true end # Response class for Unavailable For Legal Reasons responses (status code 451). # # A server operator has received a legal demand to deny access to a resource or to a set of resources # that includes the requested resource. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/451]. # - {RFC 7725}[https://www.rfc-editor.org/rfc/rfc7725.html#section-3]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#451]. # class HTTPUnavailableForLegalReasons < HTTPClientError HAS_BODY = true end # 444 No Response - Nginx # 449 Retry With - Microsoft # 450 Blocked by Windows Parental Controls - Microsoft # 499 Client Closed Request - Nginx # Response class for Internal Server Error responses (status code 500). # # An unexpected condition was encountered and no more specific message is suitable. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-500-internal-server-error]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#500]. # class HTTPInternalServerError < HTTPServerError HAS_BODY = true end # Response class for Not Implemented responses (status code 501). # # The server either does not recognize the request method, # or it lacks the ability to fulfil the request. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/501]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-501-not-implemented]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#501]. # class HTTPNotImplemented < HTTPServerError HAS_BODY = true end # Response class for Bad Gateway responses (status code 502). # # The server was acting as a gateway or proxy # and received an invalid response from the upstream server. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-502-bad-gateway]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#502]. # class HTTPBadGateway < HTTPServerError HAS_BODY = true end # Response class for Service Unavailable responses (status code 503). # # The server cannot handle the request # (because it is overloaded or down for maintenance). # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-503-service-unavailable]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#503]. # class HTTPServiceUnavailable < HTTPServerError HAS_BODY = true end # Response class for Gateway Gem::Timeout responses (status code 504). # # The server was acting as a gateway or proxy # and did not receive a timely response from the upstream server. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-504-gateway-timeout]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#504]. # class HTTPGatewayTimeout < HTTPServerError HAS_BODY = true end HTTPGatewayTimeOut = HTTPGatewayTimeout # Response class for HTTP Version Not Supported responses (status code 505). # # The server does not support the HTTP version used in the request. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/505]. # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-505-http-version-not-suppor]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#505]. # class HTTPVersionNotSupported < HTTPServerError HAS_BODY = true end # Response class for Variant Also Negotiates responses (status code 506). # # Transparent content negotiation for the request results in a circular reference. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/506]. # - {RFC 2295}[https://www.rfc-editor.org/rfc/rfc2295#section-8.1]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#506]. # class HTTPVariantAlsoNegotiates < HTTPServerError HAS_BODY = true end # Response class for Insufficient Storage (WebDAV) responses (status code 507). # # The server is unable to store the representation needed to complete the request. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/507]. # - {RFC 4918}[https://www.rfc-editor.org/rfc/rfc4918#section-11.5]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#507]. # class HTTPInsufficientStorage < HTTPServerError HAS_BODY = true end # Response class for Loop Detected (WebDAV) responses (status code 508). # # The server detected an infinite loop while processing the request. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/508]. # - {RFC 5942}[https://www.rfc-editor.org/rfc/rfc5842.html#section-7.2]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#508]. # class HTTPLoopDetected < HTTPServerError HAS_BODY = true end # 509 Bandwidth Limit Exceeded - Apache bw/limited extension # Response class for Not Extended responses (status code 510). # # Further extensions to the request are required for the server to fulfill it. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/510]. # - {RFC 2774}[https://www.rfc-editor.org/rfc/rfc2774.html#section-7]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#510]. # class HTTPNotExtended < HTTPServerError HAS_BODY = true end # Response class for Network Authentication Required responses (status code 511). # # The client needs to authenticate to gain network access. # # :include: doc/net-http/included_getters.rdoc # # References: # # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/511]. # - {RFC 6585}[https://www.rfc-editor.org/rfc/rfc6585#section-6]. # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#511]. # class HTTPNetworkAuthenticationRequired < HTTPServerError HAS_BODY = true end end class Gem::Net::HTTPResponse CODE_CLASS_TO_OBJ = { '1' => Gem::Net::HTTPInformation, '2' => Gem::Net::HTTPSuccess, '3' => Gem::Net::HTTPRedirection, '4' => Gem::Net::HTTPClientError, '5' => Gem::Net::HTTPServerError } CODE_TO_OBJ = { '100' => Gem::Net::HTTPContinue, '101' => Gem::Net::HTTPSwitchProtocol, '102' => Gem::Net::HTTPProcessing, '103' => Gem::Net::HTTPEarlyHints, '200' => Gem::Net::HTTPOK, '201' => Gem::Net::HTTPCreated, '202' => Gem::Net::HTTPAccepted, '203' => Gem::Net::HTTPNonAuthoritativeInformation, '204' => Gem::Net::HTTPNoContent, '205' => Gem::Net::HTTPResetContent, '206' => Gem::Net::HTTPPartialContent, '207' => Gem::Net::HTTPMultiStatus, '208' => Gem::Net::HTTPAlreadyReported, '226' => Gem::Net::HTTPIMUsed, '300' => Gem::Net::HTTPMultipleChoices, '301' => Gem::Net::HTTPMovedPermanently, '302' => Gem::Net::HTTPFound, '303' => Gem::Net::HTTPSeeOther, '304' => Gem::Net::HTTPNotModified, '305' => Gem::Net::HTTPUseProxy, '307' => Gem::Net::HTTPTemporaryRedirect, '308' => Gem::Net::HTTPPermanentRedirect, '400' => Gem::Net::HTTPBadRequest, '401' => Gem::Net::HTTPUnauthorized, '402' => Gem::Net::HTTPPaymentRequired, '403' => Gem::Net::HTTPForbidden, '404' => Gem::Net::HTTPNotFound, '405' => Gem::Net::HTTPMethodNotAllowed, '406' => Gem::Net::HTTPNotAcceptable, '407' => Gem::Net::HTTPProxyAuthenticationRequired, '408' => Gem::Net::HTTPRequestTimeout, '409' => Gem::Net::HTTPConflict, '410' => Gem::Net::HTTPGone, '411' => Gem::Net::HTTPLengthRequired, '412' => Gem::Net::HTTPPreconditionFailed, '413' => Gem::Net::HTTPPayloadTooLarge, '414' => Gem::Net::HTTPURITooLong, '415' => Gem::Net::HTTPUnsupportedMediaType, '416' => Gem::Net::HTTPRangeNotSatisfiable, '417' => Gem::Net::HTTPExpectationFailed, '421' => Gem::Net::HTTPMisdirectedRequest, '422' => Gem::Net::HTTPUnprocessableEntity, '423' => Gem::Net::HTTPLocked, '424' => Gem::Net::HTTPFailedDependency, '426' => Gem::Net::HTTPUpgradeRequired, '428' => Gem::Net::HTTPPreconditionRequired, '429' => Gem::Net::HTTPTooManyRequests, '431' => Gem::Net::HTTPRequestHeaderFieldsTooLarge, '451' => Gem::Net::HTTPUnavailableForLegalReasons, '500' => Gem::Net::HTTPInternalServerError, '501' => Gem::Net::HTTPNotImplemented, '502' => Gem::Net::HTTPBadGateway, '503' => Gem::Net::HTTPServiceUnavailable, '504' => Gem::Net::HTTPGatewayTimeout, '505' => Gem::Net::HTTPVersionNotSupported, '506' => Gem::Net::HTTPVariantAlsoNegotiates, '507' => Gem::Net::HTTPInsufficientStorage, '508' => Gem::Net::HTTPLoopDetected, '510' => Gem::Net::HTTPNotExtended, '511' => Gem::Net::HTTPNetworkAuthenticationRequired, } end PK!T,u`äNäN1rubygems/vendor/net-http/lib/net/http/response.rbnu„[µü¤# frozen_string_literal: true # This class is the base class for \Gem::Net::HTTP response classes. # # == About the Examples # # :include: doc/net-http/examples.rdoc # # == Returned Responses # # \Method Gem::Net::HTTP.get_response returns # an instance of one of the subclasses of \Gem::Net::HTTPResponse: # # Gem::Net::HTTP.get_response(uri) # # => # # Gem::Net::HTTP.get_response(hostname, '/nosuch') # # => # # # As does method Gem::Net::HTTP#request: # # req = Gem::Net::HTTP::Get.new(uri) # Gem::Net::HTTP.start(hostname) do |http| # http.request(req) # end # => # # # \Class \Gem::Net::HTTPResponse includes module Gem::Net::HTTPHeader, # which provides access to response header values via (among others): # # - \Hash-like method []. # - Specific reader methods, such as +content_type+. # # Examples: # # res = Gem::Net::HTTP.get_response(uri) # => # # res['Content-Type'] # => "text/html; charset=UTF-8" # res.content_type # => "text/html" # # == Response Subclasses # # \Class \Gem::Net::HTTPResponse has a subclass for each # {HTTP status code}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes]. # You can look up the response class for a given code: # # Gem::Net::HTTPResponse::CODE_TO_OBJ['200'] # => Gem::Net::HTTPOK # Gem::Net::HTTPResponse::CODE_TO_OBJ['400'] # => Gem::Net::HTTPBadRequest # Gem::Net::HTTPResponse::CODE_TO_OBJ['404'] # => Gem::Net::HTTPNotFound # # And you can retrieve the status code for a response object: # # Gem::Net::HTTP.get_response(uri).code # => "200" # Gem::Net::HTTP.get_response(hostname, '/nosuch').code # => "404" # # The response subclasses (indentation shows class hierarchy): # # - Gem::Net::HTTPUnknownResponse (for unhandled \HTTP extensions). # # - Gem::Net::HTTPInformation: # # - Gem::Net::HTTPContinue (100) # - Gem::Net::HTTPSwitchProtocol (101) # - Gem::Net::HTTPProcessing (102) # - Gem::Net::HTTPEarlyHints (103) # # - Gem::Net::HTTPSuccess: # # - Gem::Net::HTTPOK (200) # - Gem::Net::HTTPCreated (201) # - Gem::Net::HTTPAccepted (202) # - Gem::Net::HTTPNonAuthoritativeInformation (203) # - Gem::Net::HTTPNoContent (204) # - Gem::Net::HTTPResetContent (205) # - Gem::Net::HTTPPartialContent (206) # - Gem::Net::HTTPMultiStatus (207) # - Gem::Net::HTTPAlreadyReported (208) # - Gem::Net::HTTPIMUsed (226) # # - Gem::Net::HTTPRedirection: # # - Gem::Net::HTTPMultipleChoices (300) # - Gem::Net::HTTPMovedPermanently (301) # - Gem::Net::HTTPFound (302) # - Gem::Net::HTTPSeeOther (303) # - Gem::Net::HTTPNotModified (304) # - Gem::Net::HTTPUseProxy (305) # - Gem::Net::HTTPTemporaryRedirect (307) # - Gem::Net::HTTPPermanentRedirect (308) # # - Gem::Net::HTTPClientError: # # - Gem::Net::HTTPBadRequest (400) # - Gem::Net::HTTPUnauthorized (401) # - Gem::Net::HTTPPaymentRequired (402) # - Gem::Net::HTTPForbidden (403) # - Gem::Net::HTTPNotFound (404) # - Gem::Net::HTTPMethodNotAllowed (405) # - Gem::Net::HTTPNotAcceptable (406) # - Gem::Net::HTTPProxyAuthenticationRequired (407) # - Gem::Net::HTTPRequestTimeOut (408) # - Gem::Net::HTTPConflict (409) # - Gem::Net::HTTPGone (410) # - Gem::Net::HTTPLengthRequired (411) # - Gem::Net::HTTPPreconditionFailed (412) # - Gem::Net::HTTPRequestEntityTooLarge (413) # - Gem::Net::HTTPRequestURITooLong (414) # - Gem::Net::HTTPUnsupportedMediaType (415) # - Gem::Net::HTTPRequestedRangeNotSatisfiable (416) # - Gem::Net::HTTPExpectationFailed (417) # - Gem::Net::HTTPMisdirectedRequest (421) # - Gem::Net::HTTPUnprocessableEntity (422) # - Gem::Net::HTTPLocked (423) # - Gem::Net::HTTPFailedDependency (424) # - Gem::Net::HTTPUpgradeRequired (426) # - Gem::Net::HTTPPreconditionRequired (428) # - Gem::Net::HTTPTooManyRequests (429) # - Gem::Net::HTTPRequestHeaderFieldsTooLarge (431) # - Gem::Net::HTTPUnavailableForLegalReasons (451) # # - Gem::Net::HTTPServerError: # # - Gem::Net::HTTPInternalServerError (500) # - Gem::Net::HTTPNotImplemented (501) # - Gem::Net::HTTPBadGateway (502) # - Gem::Net::HTTPServiceUnavailable (503) # - Gem::Net::HTTPGatewayTimeOut (504) # - Gem::Net::HTTPVersionNotSupported (505) # - Gem::Net::HTTPVariantAlsoNegotiates (506) # - Gem::Net::HTTPInsufficientStorage (507) # - Gem::Net::HTTPLoopDetected (508) # - Gem::Net::HTTPNotExtended (510) # - Gem::Net::HTTPNetworkAuthenticationRequired (511) # # There is also the Gem::Net::HTTPBadResponse exception which is raised when # there is a protocol error. # class Gem::Net::HTTPResponse class << self # true if the response has a body. def body_permitted? self::HAS_BODY end def exception_type # :nodoc: internal use only self::EXCEPTION_TYPE end def read_new(sock) #:nodoc: internal use only httpv, code, msg = read_status_line(sock) res = response_class(code).new(httpv, code, msg) each_response_header(sock) do |k,v| res.add_field k, v end res end private def read_status_line(sock) str = sock.readline m = /\AHTTP(?:\/(\d+\.\d+))?\s+(\d\d\d)(?:\s+(.*))?\z/in.match(str) or raise Gem::Net::HTTPBadResponse, "wrong status line: #{str.dump}" m.captures end def response_class(code) CODE_TO_OBJ[code] or CODE_CLASS_TO_OBJ[code[0,1]] or Gem::Net::HTTPUnknownResponse end def each_response_header(sock) key = value = nil while true line = sock.readuntil("\n", true).sub(/\s+\z/, '') break if line.empty? if line[0] == ?\s or line[0] == ?\t and value value << ' ' unless value.empty? value << line.strip else yield key, value if key key, value = line.strip.split(/\s*:\s*/, 2) raise Gem::Net::HTTPBadResponse, 'wrong header line format' if value.nil? end end yield key, value if key end end # next is to fix bug in RDoc, where the private inside class << self # spills out. public include Gem::Net::HTTPHeader def initialize(httpv, code, msg) #:nodoc: internal use only @http_version = httpv @code = code @message = msg initialize_http_header nil @body = nil @read = false @uri = nil @decode_content = false @body_encoding = false @ignore_eof = true end # The HTTP version supported by the server. attr_reader :http_version # The HTTP result code string. For example, '302'. You can also # determine the response type by examining which response subclass # the response object is an instance of. attr_reader :code # The HTTP result message sent by the server. For example, 'Not Found'. attr_reader :message alias msg message # :nodoc: obsolete # The Gem::URI used to fetch this response. The response Gem::URI is only available # if a Gem::URI was used to create the request. attr_reader :uri # Set to true automatically when the request did not contain an # Accept-Encoding header from the user. attr_accessor :decode_content # Returns the value set by body_encoding=, or +false+ if none; # see #body_encoding=. attr_reader :body_encoding # Sets the encoding that should be used when reading the body: # # - If the given value is an Encoding object, that encoding will be used. # - Otherwise if the value is a string, the value of # {Encoding#find(value)}[https://docs.ruby-lang.org/en/master/Encoding.html#method-c-find] # will be used. # - Otherwise an encoding will be deduced from the body itself. # # Examples: # # http = Gem::Net::HTTP.new(hostname) # req = Gem::Net::HTTP::Get.new('/') # # http.request(req) do |res| # p res.body.encoding # => # # end # # http.request(req) do |res| # res.body_encoding = "UTF-8" # p res.body.encoding # => # # end # def body_encoding=(value) value = Encoding.find(value) if value.is_a?(String) @body_encoding = value end # Whether to ignore EOF when reading bodies with a specified Content-Length # header. attr_accessor :ignore_eof def inspect "#<#{self.class} #{@code} #{@message} readbody=#{@read}>" end # # response <-> exception relationship # def code_type #:nodoc: self.class end def error! #:nodoc: message = @code message = "#{message} #{@message.dump}" if @message raise error_type().new(message, self) end def error_type #:nodoc: self.class::EXCEPTION_TYPE end # Raises an HTTP error if the response is not 2xx (success). def value error! unless self.kind_of?(Gem::Net::HTTPSuccess) end def uri= uri # :nodoc: @uri = uri.dup if uri end # # header (for backward compatibility only; DO NOT USE) # def response #:nodoc: warn "Gem::Net::HTTPResponse#response is obsolete", uplevel: 1 if $VERBOSE self end def header #:nodoc: warn "Gem::Net::HTTPResponse#header is obsolete", uplevel: 1 if $VERBOSE self end def read_header #:nodoc: warn "Gem::Net::HTTPResponse#read_header is obsolete", uplevel: 1 if $VERBOSE self end # # body # def reading_body(sock, reqmethodallowbody) #:nodoc: internal use only @socket = sock @body_exist = reqmethodallowbody && self.class.body_permitted? begin yield self.body # ensure to read body ensure @socket = nil end end # Gets the entity body returned by the remote HTTP server. # # If a block is given, the body is passed to the block, and # the body is provided in fragments, as it is read in from the socket. # # If +dest+ argument is given, response is read into that variable, # with dest#<< method (it could be String or IO, or any # other object responding to <<). # # Calling this method a second or subsequent time for the same # HTTPResponse object will return the value already read. # # http.request_get('/index.html') {|res| # puts res.read_body # } # # http.request_get('/index.html') {|res| # p res.read_body.object_id # 538149362 # p res.read_body.object_id # 538149362 # } # # # using iterator # http.request_get('/index.html') {|res| # res.read_body do |segment| # print segment # end # } # def read_body(dest = nil, &block) if @read raise IOError, "#{self.class}\#read_body called twice" if dest or block return @body end to = procdest(dest, block) stream_check if @body_exist read_body_0 to @body = to else @body = nil end @read = true return if @body.nil? case enc = @body_encoding when Encoding, false, nil # Encoding: force given encoding # false/nil: do not force encoding else # other value: detect encoding from body enc = detect_encoding(@body) end @body.force_encoding(enc) if enc @body end # Returns the string response body; # note that repeated calls for the unmodified body return a cached string: # # path = '/todos/1' # Gem::Net::HTTP.start(hostname) do |http| # res = http.get(path) # p res.body # p http.head(path).body # No body. # end # # Output: # # "{\n \"userId\": 1,\n \"id\": 1,\n \"title\": \"delectus aut autem\",\n \"completed\": false\n}" # nil # def body read_body() end # Sets the body of the response to the given value. def body=(value) @body = value end alias entity body #:nodoc: obsolete private # :nodoc: def detect_encoding(str, encoding=nil) if encoding elsif encoding = type_params['charset'] elsif encoding = check_bom(str) else encoding = case content_type&.downcase when %r{text/x(?:ht)?ml|application/(?:[^+]+\+)?xml} /\A' ss.getch return nil end name = ss.scan(/[^=\t\n\f\r \/>]*/) name.downcase! raise if name.empty? ss.skip(/[\t\n\f\r ]*/) if ss.getch != '=' value = '' return [name, value] end ss.skip(/[\t\n\f\r ]*/) case ss.peek(1) when '"' ss.getch value = ss.scan(/[^"]+/) value.downcase! ss.getch when "'" ss.getch value = ss.scan(/[^']+/) value.downcase! ss.getch when '>' value = '' else value = ss.scan(/[^\t\n\f\r >]+/) value.downcase! end [name, value] end def extracting_encodings_from_meta_elements(value) # http://dev.w3.org/html5/spec/fetching-resources.html#algorithm-for-extracting-an-encoding-from-a-meta-element if /charset[\t\n\f\r ]*=(?:"([^"]*)"|'([^']*)'|["']|\z|([^\t\n\f\r ;]+))/i =~ value return $1 || $2 || $3 end return nil end ## # Checks for a supported Content-Encoding header and yields an Inflate # wrapper for this response's socket when zlib is present. If the # Content-Encoding is not supported or zlib is missing, the plain socket is # yielded. # # If a Content-Range header is present, a plain socket is yielded as the # bytes in the range may not be a complete deflate block. def inflater # :nodoc: return yield @socket unless Gem::Net::HTTP::HAVE_ZLIB return yield @socket unless @decode_content return yield @socket if self['content-range'] v = self['content-encoding'] case v&.downcase when 'deflate', 'gzip', 'x-gzip' then self.delete 'content-encoding' inflate_body_io = Inflater.new(@socket) begin yield inflate_body_io success = true ensure begin inflate_body_io.finish if self['content-length'] self['content-length'] = inflate_body_io.bytes_inflated.to_s end rescue => err # Ignore #finish's error if there is an exception from yield raise err if success end end when 'none', 'identity' then self.delete 'content-encoding' yield @socket else yield @socket end end def read_body_0(dest) inflater do |inflate_body_io| if chunked? read_chunked dest, inflate_body_io return end @socket = inflate_body_io clen = content_length() if clen @socket.read clen, dest, @ignore_eof return end clen = range_length() if clen @socket.read clen, dest return end @socket.read_all dest end end ## # read_chunked reads from +@socket+ for chunk-size, chunk-extension, CRLF, # etc. and +chunk_data_io+ for chunk-data which may be deflate or gzip # encoded. # # See RFC 2616 section 3.6.1 for definitions def read_chunked(dest, chunk_data_io) # :nodoc: total = 0 while true line = @socket.readline hexlen = line.slice(/[0-9a-fA-F]+/) or raise Gem::Net::HTTPBadResponse, "wrong chunk size line: #{line}" len = hexlen.hex break if len == 0 begin chunk_data_io.read len, dest ensure total += len @socket.read 2 # \r\n end end until @socket.readline.empty? # none end end def stream_check raise IOError, 'attempt to read body out of block' if @socket.nil? || @socket.closed? end def procdest(dest, block) raise ArgumentError, 'both arg and block given for HTTP method' if dest and block if block Gem::Net::ReadAdapter.new(block) else dest || +'' end end ## # Inflater is a wrapper around Gem::Net::BufferedIO that transparently inflates # zlib and gzip streams. class Inflater # :nodoc: ## # Creates a new Inflater wrapping +socket+ def initialize socket @socket = socket # zlib with automatic gzip detection @inflate = Zlib::Inflate.new(32 + Zlib::MAX_WBITS) end ## # Finishes the inflate stream. def finish return if @inflate.total_in == 0 @inflate.finish end ## # The number of bytes inflated, used to update the Content-Length of # the response. def bytes_inflated @inflate.total_out end ## # Returns a Gem::Net::ReadAdapter that inflates each read chunk into +dest+. # # This allows a large response body to be inflated without storing the # entire body in memory. def inflate_adapter(dest) if dest.respond_to?(:set_encoding) dest.set_encoding(Encoding::ASCII_8BIT) elsif dest.respond_to?(:force_encoding) dest.force_encoding(Encoding::ASCII_8BIT) end block = proc do |compressed_chunk| @inflate.inflate(compressed_chunk) do |chunk| compressed_chunk.clear dest << chunk end end Gem::Net::ReadAdapter.new(block) end ## # Reads +clen+ bytes from the socket, inflates them, then writes them to # +dest+. +ignore_eof+ is passed down to Gem::Net::BufferedIO#read # # Unlike Gem::Net::BufferedIO#read, this method returns more than +clen+ bytes. # At this time there is no way for a user of Gem::Net::HTTPResponse to read a # specific number of bytes from the HTTP response body, so this internal # API does not return the same number of bytes as were requested. # # See https://bugs.ruby-lang.org/issues/6492 for further discussion. def read clen, dest, ignore_eof = false temp_dest = inflate_adapter(dest) @socket.read clen, temp_dest, ignore_eof end ## # Reads the rest of the socket, inflates it, then writes it to +dest+. def read_all dest temp_dest = inflate_adapter(dest) @socket.read_all temp_dest end end end PK!Ë,àÅQQ*rubygems/vendor/molinillo/lib/molinillo.rbnu„[µü¤# frozen_string_literal: true require_relative 'molinillo/gem_metadata' require_relative 'molinillo/errors' require_relative 'molinillo/resolver' require_relative 'molinillo/modules/ui' require_relative 'molinillo/modules/specification_provider' # Gem::Molinillo is a generic dependency resolution algorithm. module Gem::Molinillo end PK!—®÷ww7rubygems/vendor/molinillo/lib/molinillo/gem_metadata.rbnu„[µü¤# frozen_string_literal: true module Gem::Molinillo # The version of Gem::Molinillo. VERSION = '0.8.0'.freeze end PK!Ë?ýÀpp1rubygems/vendor/molinillo/lib/molinillo/errors.rbnu„[µü¤# frozen_string_literal: true module Gem::Molinillo # An error that occurred during the resolution process class ResolverError < StandardError; end # An error caused by searching for a dependency that is completely unknown, # i.e. has no versions available whatsoever. class NoSuchDependencyError < ResolverError # @return [Object] the dependency that could not be found attr_accessor :dependency # @return [Array

RubyGems Documentation Index

Summary

Gems

No documentation found

Found documentation

Summary

Topics