class

Crest::Request

A class that used to make the requests The result of a Crest::Request is a Crest::Response object.

Simple example:

request = Crest::Request.new(:post, "http://httpbin.org/post", {"age" => 27}, params: {:name => "Kurt"})
request.execute

Crest::Request.execute(:post, "http://httpbin.org/post", {"age" => 27}, json: true)

Crest::Request.post("http://httpbin.org/post", {"age" => 27}, json: true)

Block style:

request = Crest::Request.new(:get, "http://httpbin.org/get") do |request|
  request.headers.add("foo", "bar")
  request.user = "username"
  request.password = "password"
end

response = request.execute

Mandatory parameters:

method
url

Optional parameters:

headers a hash containing the request headers
cookies a hash containing the request cookies
form a hash containing form data (or a raw string)
params a hash that represent query params (or a raw string) - a string separated from the preceding part by a question mark (?) and a sequence of attribute–value pairs separated by a delimiter (&).
params_encoder params encoder (default to Crest::FlatParamsEncoder)
auth access authentication method basic or digest (default to basic)
user and password for authentication
tls configuring TLS settings
p_addr, p_port, p_user, p_pass for proxy
json make a JSON request with the appropriate HTTP headers (default to false)
multipart make a multipart request with the appropriate HTTP headers even if not sending a file (default to false)
stream_multipart stream multipart request body to reduce memory usage (default to false)
user_agent set "User-Agent" HTTP header (default to Crest::USER_AGENT)
max_redirects maximum number of redirects (default to 10)
logging enable logging (default to false)
logger set logger (default to Crest::CommonLogger)
handle_errors error handling (default to true)
close_connection close the connection after request is completed (default to true)
http_client instance of HTTP::Client
read_timeout read timeout (default to nil)
write_timeout write timeout (default to nil)
connect_timeout connect timeout (default to nil)

Constructors

new(method : Symbol, url : String, form = {} of String => String, *, headers = {} of String => String, cookies = {} of String => String, cookie_jar : HTTP::CookieJar | Nil = nil, params = {} of String => String, max_redirects : Int32 = 10, params_encoder : Crest::ParamsEncoder.class = Crest::FlatParamsEncoder, user_agent : String | Nil = nil, json : Bool = false, multipart : Bool = false, stream_multipart : Bool = false, tls : OpenSSL::SSL::Context::Client | Nil = nil, http_client : HTTP::Client | Nil = nil, auth : String = "basic", user : String | Nil = nil, password : String | Nil = nil, p_addr : String | Nil = nil, p_port : Int32 | Nil = nil, p_user : String | Nil = nil, p_pass : String | Nil = nil, logger : Crest::Logger = Crest::CommonLogger.new, logging : Bool = false, handle_errors : Bool = true, close_connection : Bool = true, read_timeout : Time::Span | Nil = nil, write_timeout : Time::Span | Nil = nil, connect_timeout : Time::Span | Nil = nil, &)

Source

new(method : Symbol, url : String, form = {} of String => String, **args)

When block is not given.

Source

Class methods

delete(url : String, form = {} of String => String, **args, &block : Crest::Response -> ) : Nil

Execute a DELETE request and and yields the Crest::Response to the block.

Crest::Request.delete("http://httpbin.org/delete") do |resp|
  while line = resp.body_io.gets
    puts line
  end
end

Source

delete(url : String, form = {} of String => String, **args) : Crest::Response

Execute a DELETE request and returns a Crest::Response.

Crest::Request.delete("http://httpbin.org/delete")

Source

execute(method, url, form = {} of String => String, **args) : Crest::Response

Source

execute(method, url, form = {} of String => String, **args, &block : Crest::Response -> ) : Nil

Source

get(url : String, form = {} of String => String, **args, &block : Crest::Response -> ) : Nil

Execute a GET request and and yields the Crest::Response to the block.

Crest::Request.get("http://httpbin.org/get") do |resp|
  while line = resp.body_io.gets
    puts line
  end
end

Source

get(url : String, form = {} of String => String, **args) : Crest::Response

Execute a GET request and returns a Crest::Response.

Crest::Request.get("http://httpbin.org/get")

Source

head(url : String, form = {} of String => String, **args, &block : Crest::Response -> ) : Nil

Execute a HEAD request and and yields the Crest::Response to the block.

Crest::Request.head("http://httpbin.org/head") do |resp|
  while line = resp.body_io.gets
    puts line
  end
end

Source

head(url : String, form = {} of String => String, **args) : Crest::Response

Execute a HEAD request and returns a Crest::Response.

Crest::Request.head("http://httpbin.org/head")

Source

options(url : String, form = {} of String => String, **args, &block : Crest::Response -> ) : Nil

Execute a OPTIONS request and and yields the Crest::Response to the block.

Crest::Request.options("http://httpbin.org/options") do |resp|
  while line = resp.body_io.gets
    puts line
  end
end

Source

options(url : String, form = {} of String => String, **args) : Crest::Response

Execute a OPTIONS request and returns a Crest::Response.

Crest::Request.options("http://httpbin.org/options")

Source

patch(url : String, form = {} of String => String, **args, &block : Crest::Response -> ) : Nil

Execute a PATCH request and and yields the Crest::Response to the block.

Crest::Request.patch("http://httpbin.org/patch") do |resp|
  while line = resp.body_io.gets
    puts line
  end
end

Source

patch(url : String, form = {} of String => String, **args) : Crest::Response

Execute a PATCH request and returns a Crest::Response.

Crest::Request.patch("http://httpbin.org/patch")

Source

post(url : String, form = {} of String => String, **args, &block : Crest::Response -> ) : Nil

Execute a POST request and and yields the Crest::Response to the block.

Crest::Request.post("http://httpbin.org/post") do |resp|
  while line = resp.body_io.gets
    puts line
  end
end

Source

post(url : String, form = {} of String => String, **args) : Crest::Response

Execute a POST request and returns a Crest::Response.

Crest::Request.post("http://httpbin.org/post")

Source

put(url : String, form = {} of String => String, **args, &block : Crest::Response -> ) : Nil

Execute a PUT request and and yields the Crest::Response to the block.

Crest::Request.put("http://httpbin.org/put") do |resp|
  while line = resp.body_io.gets
    puts line
  end
end

Source

put(url : String, form = {} of String => String, **args) : Crest::Response

Execute a PUT request and returns a Crest::Response.

Crest::Request.put("http://httpbin.org/put")

Source

Instance methods

auth

Source

close(*args, **options)

Source

close(*args, **options, &)

close_connection

closed?

connect_timeout

cookie_jar

execute

Execute HTTP request

Source

execute

Execute streaming HTTP request

form_data

handle_errors

headers

host(*args, **options)

Source

host(*args, **options, &)

http_client

http_request

json

logger

logging

max_redirects

method

multipart

p_addr

p_pass

p_port

p_user

params_encoder

password

password=(password : Nil | String)

Source

port(*args, **options)

Source

port(*args, **options, &)

proxy

read_timeout

redirection_history

redirection_history=(redirection_history : Array(Crest::Response))

Source

stream_multipart

Source

tls

Source

tls?(*args, **options)

Source

tls?(*args, **options, &)

Source

to_curl

Convert Request object to cURL command

Source

url

Source

user

Source

user=(user : Nil | String)

Source

user_agent

Source

write_timeout

Source