Requirements: Ruby >= 2.0
To utilize unirest, install the unirest gem:
gem install unirestAfter installing the gem package you can now begin to simplifying requests by requiring unirest:
require 'unirest'
response = Unirest.post API_URL,
headers:{
"X-RapidAPI-Key" => API_KEY,
"Content-Type" => "application/x-www-form-urlencoded"
},
parameters:{
"parameter" => "value"
}
response.code # Status code
response.headers # Response headers
response.body # Parsed body
response.raw_body # Unparsed bodyAsynchronous Requests
Unirest-Ruby also supports asynchronous requests with a callback function specified inside a block, like:
require 'unirest'
response = Unirest.post API_URL,
headers:{
"X-RapidAPI-Key" => API_KEY,
"Content-Type" => "application/x-www-form-urlencoded"
},
parameters:{
"parameter" => "value"
} {|response|
response.code # Status code
response.headers # Response headers
response.body # Parsed body
response.raw_body # Unparsed body
}require 'unirest'
response = Unirest.post API_URL,
headers:{
"X-RapidAPI-Key" => API_KEY
},
parameters:{
"content" => File.new("/path/to/file", "rb")
}You can set some advanced configuration to tune Unirest-Ruby:
Timeout
You can set a custom timeout value (in seconds):
Unirest.timeout(5) # 5s timeoutUnirest.default_header('Header1','Value1')
Unirest.default_header('Header2','Value2')You can clear the default headers anytime with:
Unirest.clear_default_headers()Unirest.user_agent("custom_user_agent")