Protocol::HTTPSourceProtocolHTTPMethods

class Methods

Provides a convenient interface for commonly supported HTTP methods.

Method Name Request Body Response Body Safe Idempotent Cacheable
GET Optional Yes Yes Yes Yes
HEAD Optional No Yes Yes Yes
POST Yes Yes No No Yes
PUT Yes Yes No Yes No
DELETE Optional Yes No Yes No
CONNECT Optional Yes No No No
OPTIONS Optional Yes Yes Yes No
TRACE No Yes Yes Yes No
PATCH Yes Yes No No No

These methods are defined in this module using lower case names. They are for convenience only and you should not overload those methods.

See https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods for more details.

Definitions

GET = "GET"

The GET method requests a representation of the specified resource. Requests using GET should only retrieve data.

HEAD = "HEAD"

The HEAD method asks for a response identical to a GET request, but without the response body.

POST = "POST"

The POST method submits an entity to the specified resource, often causing a change in state or side effects on the server.

PUT = "PUT"

The PUT method replaces all current representations of the target resource with the request payload.

DELETE = "DELETE"

The DELETE method deletes the specified resource.

CONNECT = "CONNECT"

The CONNECT method establishes a tunnel to the server identified by the target resource.

OPTIONS = "OPTIONS"

The OPTIONS method describes the communication options for the target resource.

TRACE = "TRACE"

The TRACE method performs a message loop-back test along the path to the target resource.

PATCH = "PATCH"

The PATCH method applies partial modifications to a resource.

def self.valid?(name)

Check if the given name is a valid HTTP method, according to this module.

Note that this method only knows about the methods defined in this module, however there are many other methods defined in different specifications.

Signature

returns Boolean

True if the name is a valid HTTP method.

Implementation

def self.valid?(name)
	const_defined?(name)
rescue NameError
	# Ruby will raise an exception if the name is not valid for a constant.
	return false
end

def self.each

Enumerate all HTTP methods.

Signature

yields {|name, value| ...}
parameter name Symbol

The name of the method, e.g. :GET.

parameter value String

The value of the method, e.g. "GET".

Implementation

def self.each
	return to_enum(:each) unless block_given?
	
	constants.each do |name|
		yield name.downcase, const_get(name)
	end
end