commit 9bfdcec052631301b90998267a4dd0931160c146 Author: Sean McArthur Date: Thu Jun 30 17:23:51 2016 -0700 init diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a9d37c5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +target +Cargo.lock diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..a7bff3e --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,12 @@ +[package] +name = "request" +version = "0.1.0" +authors = ["Sean McArthur "] +license = "MIT/Apache-2.0" + +[dependencies] +hyper = {git = "https://github.com/hyperium/hyper"} +log = "0.3" + +[dev-dependencies] +env_logger = "0.3" diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..16fe87b --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..8e91dc9 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,20 @@ +Copyright (c) 2015 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..8967ca4 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# request + +An ergonomic HTTP Client for Rust + + diff --git a/examples/simple.rs b/examples/simple.rs new file mode 100644 index 0000000..0bde65e --- /dev/null +++ b/examples/simple.rs @@ -0,0 +1,15 @@ +extern crate request; +extern crate env_logger; + +fn main() { + env_logger::init().unwrap(); + + let mut res = request::get("https://rust-lang.org").unwrap(); + + println!("Status: {}", res.status()); + println!("Headers:\n{}", res.headers()); + + ::std::io::copy(&mut res, &mut ::std::io::stdout()).unwrap(); + + println!("\n\nDone."); +} diff --git a/src/client.rs b/src/client.rs new file mode 100644 index 0000000..7447a4e --- /dev/null +++ b/src/client.rs @@ -0,0 +1,87 @@ +use std::io::{self, Read}; + +use hyper::{Method, StatusCode, HttpVersion, Url}; +use hyper::header::Headers; + +use super::sync; + +pub struct Client { + inner: sync::Client, +} + +impl Client { + pub fn new() -> Client { + Client { + inner: sync::Client::new(), + } + } + + pub fn get(&self, url: &str) -> RequestBuilder { + self.request(Method::Get, Url::parse(url).unwrap()) + } + + pub fn request(&self, method: Method, url: Url) -> RequestBuilder { + debug!("request {:?} \"{}\"", method, url); + RequestBuilder { + client: self, + method: method, + url: url, + version: HttpVersion::Http11, + headers: Headers::new(), + + body: None, + } + } +} + +pub struct RequestBuilder<'a> { + client: &'a Client, + + method: Method, + url: Url, + version: HttpVersion, + headers: Headers, + + body: Option<()>, +} + +impl<'a> RequestBuilder<'a> { + pub fn body(mut self, body: ()) -> RequestBuilder<'a> { + self.body = Some(body); + self + } + + pub fn send(mut self) -> Result { + self.headers.set(::hyper::header::ContentLength(0)); + let req = try!(self.client.inner.request(self.method, self.url, self.version, self.headers)); + + let res = try!(req.end().map_err(|e| format!("RequestError: end: {}", e))); + Ok(Response { + inner: res + }) + } +} + +pub struct Response { + inner: sync::Response, +} + +impl Response { + pub fn status(&self) -> &StatusCode { + &self.inner.status + } + + pub fn headers(&self) -> &Headers { + &self.inner.headers + } + + pub fn version(&self) -> &HttpVersion { + &self.inner.version + } +} + +impl Read for Response { + fn read(&mut self, buf: &mut [u8]) -> io::Result { + self.inner.read(buf) + } +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..d426897 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,14 @@ +extern crate hyper; + +#[macro_use] extern crate log; + +pub use hyper::{Method, StatusCode, header, Url}; +pub use self::client::{Client, Response}; + +mod client; +mod sync; + +pub fn get(url: &str) -> Result { + let client = Client::new(); + client.get(url).send() +} diff --git a/src/sync.rs b/src/sync.rs new file mode 100644 index 0000000..8188efa --- /dev/null +++ b/src/sync.rs @@ -0,0 +1,245 @@ +use std::io::{self, Read, Write}; +use std::sync::mpsc; +use std::time::Duration; + +use hyper::{self, Control, Next, Method, StatusCode, HttpVersion, RequestUri, Url}; +use hyper::header::Headers; + +pub struct Client { + inner: hyper::Client, +} + +impl Client { + pub fn new() -> Client { + Client { + inner: hyper::Client::::configure() + .connect_timeout(Duration::from_secs(10)) + .build().unwrap(), + } + } + + pub fn request(&self, method: Method, url: Url, version: HttpVersion, headers: Headers) -> Result { + let (ctrl_tx, ctrl_rx) = mpsc::channel(); + let (res_tx, res_rx) = mpsc::channel(); + let (action_tx, rx) = mpsc::channel(); + let (tx, action_rx) = mpsc::channel(); + + let timeout = Duration::from_secs(10); + + try!(self.inner.request(url, SynchronousHandler { + read_timeout: timeout, + write_timeout: timeout, + + ctrl_tx: ctrl_tx, + res_tx: res_tx, + tx: tx, + rx: rx, + reading: None, + writing: None, + request: Some((method, version, headers)), + }).map_err(|e| format!("RequestError: {}", e))); + + Ok(Request { + res_rx: res_rx, + tx: action_tx, + rx: action_rx, + ctrl: try!(ctrl_rx.recv().map_err(|e| format!("RequestError: waiting for Control: {}", e))), + }) + } +} + +pub struct Request { + res_rx: mpsc::Receiver, + tx: mpsc::Sender, + rx: mpsc::Receiver>, + ctrl: hyper::Control, +} + +impl Request { + pub fn end(self) -> Result { + trace!("Request.end"); + self.ctrl.ready(Next::read()).unwrap(); + let res = try!(self.res_rx.recv().map_err(|e| format!("RequestError: end = {}", e))); + Ok(Response { + status: res.status().clone(), + headers: res.headers().clone(), + version: res.version().clone(), + + tx: self.tx, + rx: self.rx, + ctrl: self.ctrl, + }) + } +} + +impl Write for Request { + fn write(&mut self, msg: &[u8]) -> io::Result { + self.tx.send(Action::Write(msg.as_ptr(), msg.len())).unwrap(); + self.ctrl.ready(Next::write()).unwrap(); + let res = self.rx.recv().unwrap(); + res + } + + fn flush(&mut self) -> io::Result<()> { + panic!("Request.flush() not implemented") + } +} + +pub struct Response { + pub headers: Headers, + pub status: StatusCode, + pub version: HttpVersion, + + tx: mpsc::Sender, + rx: mpsc::Receiver>, + ctrl: hyper::Control, + +} + +impl Read for Response { + fn read(&mut self, buf: &mut [u8]) -> io::Result { + self.tx.send(Action::Read(buf.as_mut_ptr(), buf.len())).unwrap(); + self.ctrl.ready(Next::read()).unwrap(); + self.rx.recv().unwrap() + } +} + +struct SynchronousHandler { + read_timeout: Duration, + write_timeout: Duration, + + ctrl_tx: mpsc::Sender, + res_tx: mpsc::Sender, + tx: mpsc::Sender>, + rx: mpsc::Receiver, + reading: Option<(*mut u8, usize)>, + writing: Option<(*const u8, usize)>, + request: Option<(hyper::Method, hyper::HttpVersion, hyper::Headers)> +} + +unsafe impl Send for SynchronousHandler {} + +impl SynchronousHandler { + fn next(&mut self) -> Next { + match self.rx.try_recv() { + Ok(Action::Read(ptr, len)) => { + self.reading = Some((ptr, len)); + Next::read().timeout(self.read_timeout) + }, + Ok(Action::Write(ptr, len)) => { + self.writing = Some((ptr, len)); + Next::write().timeout(self.write_timeout) + } + Err(mpsc::TryRecvError::Empty) => { + // we're too fast, the other thread hasn't had a chance to respond + Next::wait() + } + Err(mpsc::TryRecvError::Disconnected) => { + // they dropped it + Next::end() + } + } + } + + fn reading(&mut self) -> Option<(*mut u8, usize)> { + self.reading.take().or_else(|| { + match self.rx.try_recv() { + Ok(Action::Read(ptr, len)) => { + Some((ptr, len)) + }, + _ => None + } + }) + } + + fn writing(&mut self) -> Option<(*const u8, usize)> { + self.writing.take().or_else(|| { + match self.rx.try_recv() { + Ok(Action::Write(ptr, len)) => { + Some((ptr, len)) + }, + _ => None + } + }) + } +} + +impl hyper::client::Handler for SynchronousHandler { + fn on_request(&mut self, req: &mut hyper::client::Request) -> Next { + use std::iter::Extend; + let head = self.request.take().unwrap(); + trace!("on_request {:?}", head); + req.set_method(head.0); + //req.set_uri(head.1); + req.headers_mut().extend(head.2.iter()); + self.next() + + } + + fn on_request_writable(&mut self, encoder: &mut hyper::Encoder) -> Next { + trace!("on_request_writable"); + if let Some(raw) = self.writing() { + let slice = unsafe { ::std::slice::from_raw_parts(raw.0, raw.1) }; + if self.tx.send(encoder.write(slice)).is_err() { + return Next::end(); + } + } + self.next() + } + + fn on_response(&mut self, res: hyper::client::Response) -> Next { + trace!("on_response {:?}", res); + if let Err(_) = self.res_tx.send(res) { + return Next::end(); + } + self.next() + } + + fn on_response_readable(&mut self, decoder: &mut hyper::Decoder) -> Next { + trace!("on_response_readable"); + if let Some(raw) = self.reading() { + let slice = unsafe { ::std::slice::from_raw_parts_mut(raw.0, raw.1) }; + if self.tx.send(decoder.read(slice)).is_err() { + return Next::end(); + } + } + self.next() + } + + fn on_control(&mut self, ctrl: Control) { + self.ctrl_tx.send(ctrl).unwrap(); + } +} + +enum Action { + Read(*mut u8, usize), + Write(*const u8, usize), + //Request(Method, RequestUri, HttpVersion, Headers), +} + +unsafe impl Send for Action {} + + +#[cfg(test)] +mod tests { + use std::io::{Read, Write}; + use std::net::TcpListener; + use std::thread; + + #[test] + fn test_get() { + let server = TcpListener::bind("127.0.0.1:0").unwrap(); + let addr = server.local_addr().unwrap(); + thread::spawn(move || { + let mut inc = server.accept().unwrap().0; + let mut buf = [0; 4096]; + inc.read(&mut buf).unwrap(); + }); + + let mut res = super::super::get(&format!("http://{}", addr)).unwrap(); + assert_eq!(res.status(), &::hyper::Ok); + + let mut buf = Vec::new(); + res.read_to_end(&mut buf).unwrap(); + } +}