1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
//! The native `http` module for the [Rune Language].
//!
//! [Rune Language]: https://rune-rs.github.io
//!
//! ## Usage
//!
//! Add the following to your `Cargo.toml`:
//!
//! ```toml
//! rune-modules = { version = "0.13.2", features = ["http", "json"] }
//! ```
//!
//! Install it into your context:
//!
//! ```rust
//! let mut context = rune::Context::with_default_modules()?;
//! context.install(rune_modules::http::module(true)?)?;
//! context.install(rune_modules::json::module(true)?)?;
//! # Ok::<_, rune::support::Error>(())
//! ```
//!
//! Use it in Rune:
//!
//! ```rust,ignore
//! use http;
//! use json;
//!
//! fn main() {
//! let client = http::Client::new();
//! let response = client.get("http://worldtimeapi.org/api/ip");
//! let text = response.text();
//! let json = json::from_string(text);
//!
//! let timezone = json["timezone"];
//!
//! if timezone is String {
//! dbg(timezone);
//! }
//!
//! let body = json::to_bytes(#{"hello": "world"});
//!
//! let response = client.post("https://postman-echo.com/post")
//! .body_bytes(body)
//! .send();
//!
//! let response = json::from_string(response.text());
//! dbg(response);
//! }
//! ```
use rune::{Any, Module, Value, ContextError};
use rune::runtime::{Bytes, Ref, Formatter, VmResult};
use rune::alloc::fmt::TryWrite;
/// Construct the `http` module.
pub fn module(_stdio: bool) -> Result<Module, ContextError> {
let mut module = Module::with_crate("http")?;
module.ty::<Client>()?;
module.ty::<Response>()?;
module.ty::<RequestBuilder>()?;
module.ty::<StatusCode>()?;
module.ty::<Error>()?;
module.function_meta(Client::new)?;
module.function_meta(get)?;
module.function_meta(Client::get)?;
module.function_meta(Client::post)?;
module.function_meta(Response::text)?;
module.function_meta(Response::json)?;
module.function_meta(Response::status)?;
module.function_meta(RequestBuilder::send)?;
module.function_meta(RequestBuilder::header)?;
module.function_meta(RequestBuilder::body_bytes)?;
module.function_meta(Error::string_display)?;
module.function_meta(StatusCode::string_display)?;
Ok(module)
}
#[derive(Debug, Any)]
#[rune(item = ::http)]
pub struct Error {
inner: reqwest::Error,
}
impl From<reqwest::Error> for Error {
fn from(inner: reqwest::Error) -> Self {
Self { inner }
}
}
impl Error {
#[rune::function(instance, protocol = STRING_DISPLAY)]
fn string_display(&self, f: &mut Formatter) -> VmResult<()> {
rune::vm_write!(f, "{}", self.inner);
VmResult::Ok(())
}
}
/// An asynchronous Client to make Requests with.
#[derive(Debug, Any)]
#[rune(item = ::http)]
struct Client {
client: reqwest::Client,
}
/// A Response to a submitted [`Request`].
#[derive(Debug, Any)]
#[rune(item = ::http)]
pub struct Response {
response: reqwest::Response,
}
impl Response {
/// Get the response as text.
#[rune::function]
async fn text(self) -> Result<String, Error> {
let text = self.response.text().await?;
Ok(text)
}
/// Get the response as a Rune value decoded from JSON.
#[rune::function]
async fn json(self) -> Result<Value, Error> {
let text = self.response.json().await?;
Ok(text)
}
/// Get the status code of the response.
#[rune::function]
fn status(&self) -> StatusCode {
let inner = self.response.status();
StatusCode { inner }
}
}
#[derive(Debug, Any)]
#[rune(item = ::http)]
pub struct StatusCode {
inner: reqwest::StatusCode,
}
impl StatusCode {
#[rune::function(instance, protocol = STRING_DISPLAY)]
fn string_display(&self, f: &mut Formatter) -> VmResult<()> {
rune::vm_write!(f, "{}", self.inner);
VmResult::Ok(())
}
}
/// A builder to construct the properties of a Request.
///
/// To construct a RequestBuilder, refer to the [`Client`] documentation.
#[derive(Debug, Any)]
#[rune(item = ::http)]
pub struct RequestBuilder {
request: reqwest::RequestBuilder,
}
impl RequestBuilder {
/// Send the request being built.
#[rune::function]
async fn send(self) -> Result<Response, Error> {
let response = self.request.send().await?;
Ok(Response { response })
}
/// Modify a header in the request.
#[rune::function]
fn header(self, key: &str, value: &str) -> Self {
Self {
request: self.request.header(key, value),
}
}
/// Set the request body from bytes.
///
/// ```rune,no_run
/// let client = http::Client::new();
///
/// let response = client.get("http://example.com")
/// .body_bytes(b"Hello World")
/// .send()
/// .await?;
///
/// let response = response.text().await?;
/// ```
#[rune::function]
fn body_bytes(self, bytes: Bytes) -> Self {
let bytes = bytes.into_vec();
Self {
request: self.request.body(bytes.into_std()),
}
}
}
impl Client {
/// Construct a new http client.
///
/// # Examples
///
/// ```rune
/// let client = http::Client::new();
/// ```
#[rune::function(path = Self::new)]
fn new() -> Self {
Self {
client: reqwest::Client::new(),
}
}
/// Construct a builder to GET the given `url`.
///
/// # Examples
///
/// ```rune,no_run
/// let client = http::Client::new();
///
/// let response = client.get("http://example.com")
/// .send()
/// .await?;
///
/// let response = response.text().await?;
/// ```
#[rune::function]
fn get(&self, url: &str) -> RequestBuilder {
RequestBuilder { request: self.client.get(url) }
}
/// Construct a builder to POST to the given `url`.
///
/// # Examples
///
/// ```rune,no_run
/// let client = http::Client::new();
///
/// let response = client.post("https://postman-echo.com/post")
/// .body_bytes(b"Hello World")
/// .send()
/// .await?;
///
/// let response = response.json().await?;
/// ```
#[rune::function]
fn post(&self, url: &str) -> RequestBuilder {
let request = self.client.post(url);
RequestBuilder { request }
}
}
/// Shorthand for generating a get request.
///
/// # Examples
///
/// ```rune,no_run
/// let response = http::get("http://worldtimeapi.org/api/ip").await?;
/// let json = response.json().await?;
///
/// let timezone = json["timezone"];
/// ```
#[rune::function]
async fn get(url: Ref<str>) -> Result<Response, Error> {
Ok(Response {
response: reqwest::get(url.as_ref()).await?,
})
}