Represents the information necessary for an HTTP request. This is basically a data object with validation. Not all fields will be used in every request.
# File lib/patron/request.rb, line 37 def initialize @action = :get @headers = {} @timeout = 0 @connect_timeout = 0 @max_redirects = -1 end
# File lib/patron/request.rb, line 84 def action=(new_action) if !VALID_ACTIONS.include?(new_action) raise ArgumentError, "Action must be one of #{VALID_ACTIONS.join(', ')}" end @action = new_action end
# File lib/patron/request.rb, line 132 def action_name @action.to_s.upcase end
Set the type of authentication to use for this request.
@param [String, Symbol] type - The type of authentication to use for this request, can be one of
:basic, :digest, or :any
@example
sess.username = "foo" sess.password = "sekrit" sess.auth_type = :digest
# File lib/patron/request.rb, line 58 def auth_type=(type=:basic) @auth_type = case type when :basic, "basic" Request::AuthBasic when :digest, "digest" Request::AuthDigest when :any, "any" Request::AuthAny else raise "#{type.inspect} is an unknown authentication type" end end
# File lib/patron/request.rb, line 124 def buffer_size=(buffer_size) if buffer_size != nil && buffer_size.to_i < 1 raise ArgumentError, "Buffer size must be a positive integer greater than 0 or nil" end @buffer_size = buffer_size != nil ? buffer_size.to_i : nil end
# File lib/patron/request.rb, line 100 def connect_timeout=(new_timeout) if new_timeout && new_timeout.to_i < 1 raise ArgumentError, "Timeout must be a positive integer greater than 0" end @connect_timeout = new_timeout.to_i end
# File lib/patron/request.rb, line 136 def credentials return nil if username.nil? || password.nil? "#{username}:#{password}" end
# File lib/patron/request.rb, line 116 def headers=(new_headers) if !new_headers.kind_of?(Hash) raise ArgumentError, "Headers must be a hash" end @headers = new_headers end
# File lib/patron/request.rb, line 108 def max_redirects=(new_max_redirects) if new_max_redirects.to_i < -1 raise ArgumentError, "Max redirects must be a positive integer, 0 or -1" end @max_redirects = new_max_redirects.to_i end
# File lib/patron/request.rb, line 92 def timeout=(new_timeout) if new_timeout && new_timeout.to_i < 1 raise ArgumentError, "Timeout must be a positive integer greater than 0" end @timeout = new_timeout.to_i end
# File lib/patron/request.rb, line 80 def upload_data @upload_data end
# File lib/patron/request.rb, line 71 def upload_data=(data) @upload_data = case data when Hash self.multipart ? data : Util.build_query_string_from_hash(data, @action == :post) else data end end