Module: HTTP::Chainable::Verbs

Included in:

HTTP::Chainable

Defined in:

lib/http/chainable/verbs.rb,
sig/http.rbs

Overview

HTTP verb shortcut methods

Each method delegates to #request with the appropriate verb.

Defined Under Namespace

Modules: _VerbsHost

Instance Method Summary

• #connect(uri) {|response| ... } ⇒ HTTP::Response, Object

  Convert to a transparent TCP/IP tunnel.

• #delete(uri) {|response| ... } ⇒ HTTP::Response, Object

  Delete a resource.

• #get(uri) {|response| ... } ⇒ HTTP::Response, Object

  Get a resource.

• #head(uri) {|response| ... } ⇒ HTTP::Response, Object

  Request a get sans response body.

• #options(uri) {|response| ... } ⇒ HTTP::Response, Object

  Return the methods supported on the given URI.

• #patch(uri) {|response| ... } ⇒ HTTP::Response, Object

  Apply partial modifications to a resource.

• #post(uri) {|response| ... } ⇒ HTTP::Response, Object

  Post to a resource.

• #put(uri) {|response| ... } ⇒ HTTP::Response, Object

  Put to a resource.

• #trace(uri) {|response| ... } ⇒ HTTP::Response, Object

  Echo the request back to the client.

Instance Method Details

#connect(uri, opts) ⇒ Response #connect ⇒ void

Convert to a transparent TCP/IP tunnel

Examples:

HTTP.connect("http://example.com")

Overloads:

• #connect(uri, opts) ⇒ Response

  Parameters:

  • uri (String, URI)
  • opts (Object)

  Returns:

  • (Response)
• #connect ⇒ void

  This method returns an undefined value.

Parameters:

• uri (String, URI) —

  URI to request

• options (Hash) —

  request options

Yield Parameters:

• response (HTTP::Response) —

  the response

Returns:

• (HTTP::Response, Object) —

  the response, or block return value

# File 'lib/http/chainable/verbs.rb', line 117

def connect(uri, **, &)
  request(:connect, uri, **, &) # steep:ignore
end

#delete(uri, opts) ⇒ Response #delete ⇒ void

Delete a resource

Examples:

HTTP.delete("http://example.com/resource")

Overloads:

• #delete(uri, opts) ⇒ Response

  Parameters:

  • uri (String, URI)
  • opts (Object)

  Returns:

  • (Response)
• #delete ⇒ void

  This method returns an undefined value.

Parameters:

• uri (String, URI) —

  URI to request

• options (Hash) —

  request options

Yield Parameters:

• response (HTTP::Response) —

  the response

Returns:

• (HTTP::Response, Object) —

  the response, or block return value

# File 'lib/http/chainable/verbs.rb', line 75

def delete(uri, **, &)
  request(:delete, uri, **, &) # steep:ignore
end

#get(uri, opts) ⇒ Response #get ⇒ void

Get a resource

Examples:

HTTP.get("http://example.com")

Overloads:

• #get(uri, opts) ⇒ Response

  Parameters:

  • uri (String, URI)
  • opts (Object)

  Returns:

  • (Response)
• #get ⇒ void

  This method returns an undefined value.

Parameters:

• uri (String, URI) —

  URI to request

• options (Hash) —

  request options

Yield Parameters:

• response (HTTP::Response) —

  the response

Returns:

• (HTTP::Response, Object) —

  the response, or block return value

# File 'lib/http/chainable/verbs.rb', line 33

def get(uri, **, &)
  request(:get, uri, **, &) # steep:ignore
end

#head(uri, opts) ⇒ Response #head ⇒ void

Request a get sans response body

Examples:

HTTP.head("http://example.com")

Overloads:

• #head(uri, opts) ⇒ Response

  Parameters:

  • uri (String, URI)
  • opts (Object)

  Returns:

  • (Response)
• #head ⇒ void

  This method returns an undefined value.

Parameters:

• uri (String, URI) —

  URI to request

• options (Hash) —

  request options

Yield Parameters:

• response (HTTP::Response) —

  the response

Returns:

• (HTTP::Response, Object) —

  the response, or block return value

# File 'lib/http/chainable/verbs.rb', line 19

def head(uri, **, &)
  request(:head, uri, **, &) # steep:ignore
end

#options(uri, opts) ⇒ Response #options ⇒ void

Return the methods supported on the given URI

Examples:

HTTP.options("http://example.com")

Overloads:

• #options(uri, opts) ⇒ Response

  Parameters:

  • uri (String, URI)
  • opts (Object)

  Returns:

  • (Response)
• #options ⇒ void

  This method returns an undefined value.

Parameters:

• uri (String, URI) —

  URI to request

• options (Hash) —

  request options

Yield Parameters:

• response (HTTP::Response) —

  the response

Returns:

• (HTTP::Response, Object) —

  the response, or block return value

# File 'lib/http/chainable/verbs.rb', line 103

def options(uri, **, &)
  request(:options, uri, **, &) # steep:ignore
end

#patch(uri, opts) ⇒ Response #patch ⇒ void

Apply partial modifications to a resource

Examples:

HTTP.patch("http://example.com/resource", body: "data")

Overloads:

• #patch(uri, opts) ⇒ Response

  Parameters:

  • uri (String, URI)
  • opts (Object)

  Returns:

  • (Response)
• #patch ⇒ void

  This method returns an undefined value.

Parameters:

• uri (String, URI) —

  URI to request

• options (Hash) —

  request options

Yield Parameters:

• response (HTTP::Response) —

  the response

Returns:

• (HTTP::Response, Object) —

  the response, or block return value

# File 'lib/http/chainable/verbs.rb', line 131

def patch(uri, **, &)
  request(:patch, uri, **, &) # steep:ignore
end

#post(uri, opts) ⇒ Response #post ⇒ void

Post to a resource

Examples:

HTTP.post("http://example.com", body: "data")

Overloads:

• #post(uri, opts) ⇒ Response

  Parameters:

  • uri (String, URI)
  • opts (Object)

  Returns:

  • (Response)
• #post ⇒ void

  This method returns an undefined value.

Parameters:

• uri (String, URI) —

  URI to request

• options (Hash) —

  request options

Yield Parameters:

• response (HTTP::Response) —

  the response

Returns:

• (HTTP::Response, Object) —

  the response, or block return value

# File 'lib/http/chainable/verbs.rb', line 47

def post(uri, **, &)
  request(:post, uri, **, &) # steep:ignore
end

#put(uri, opts) ⇒ Response #put ⇒ void

Put to a resource

Examples:

HTTP.put("http://example.com", body: "data")

Overloads:

• #put(uri, opts) ⇒ Response

  Parameters:

  • uri (String, URI)
  • opts (Object)

  Returns:

  • (Response)
• #put ⇒ void

  This method returns an undefined value.

Parameters:

• uri (String, URI) —

  URI to request

• options (Hash) —

  request options

Yield Parameters:

• response (HTTP::Response) —

  the response

Returns:

• (HTTP::Response, Object) —

  the response, or block return value

# File 'lib/http/chainable/verbs.rb', line 61

def put(uri, **, &)
  request(:put, uri, **, &) # steep:ignore
end

#trace(uri, opts) ⇒ Response #trace ⇒ void

Echo the request back to the client

Examples:

HTTP.trace("http://example.com")

Overloads:

• #trace(uri, opts) ⇒ Response

  Parameters:

  • uri (String, URI)
  • opts (Object)

  Returns:

  • (Response)
• #trace ⇒ void

  This method returns an undefined value.

Parameters:

• uri (String, URI) —

  URI to request

• options (Hash) —

  request options

Yield Parameters:

• response (HTTP::Response) —

  the response

Returns:

• (HTTP::Response, Object) —

  the response, or block return value

# File 'lib/http/chainable/verbs.rb', line 89

def trace(uri, **, &)
  request(:trace, uri, **, &) # steep:ignore
end