Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set default user agent, send along custom SDK version header #78

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Set default user agent, send along custom SDK version header #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/api.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ use crate::{
fn make_reqwest_client() -> Client {
Client::builder()
.timeout(Duration::from_secs(10))
.user_agent(crate::SDK_USER_AGENT)
.build()
.expect("Could not build client")
}
Expand Down
15 changes: 11 additions & 4 deletions src/connection.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use std::{borrow::Cow, collections::HashMap, str::FromStr};
use data_encoding::HEXLOWER;
use reqwest::{multipart, Client, StatusCode};

use crate::{errors::ApiError, types::BlobId};
use crate::{errors::ApiError, types::BlobId, SDK_HEADER, SDK_USER_AGENT};

/// Map HTTP response status code to an ApiError if it isn't "200".
///
Expand Down Expand Up @@ -99,9 +99,10 @@ pub(crate) async fn send_simple(
// Send request
log::trace!("Sending HTTP request");
let res = client
.post(&format!("{}/send_simple", endpoint))
.post(format!("{}/send_simple", endpoint))
.form(&params)
.header("accept", "application/json")
.header(SDK_HEADER, SDK_USER_AGENT)
.send()
.await?;
log::trace!("Received HTTP response");
Expand Down Expand Up @@ -139,9 +140,10 @@ pub(crate) async fn send_e2e(
// Send request
log::trace!("Sending HTTP request");
let res = client
.post(&format!("{}/send_e2e", endpoint))
.post(format!("{}/send_e2e", endpoint))
.form(&params)
.header("accept", "application/json")
.header(SDK_HEADER, SDK_USER_AGENT)
.send()
.await?;
log::trace!("Received HTTP response");
Expand Down Expand Up @@ -186,6 +188,7 @@ pub(crate) async fn blob_upload(
.post(&url)
.multipart(form)
.header("accept", "text/plain")
.header(SDK_HEADER, SDK_USER_AGENT)
.send()
.await?;
map_response_code(res.status(), Some(ApiError::BadBlob))?;
Expand All @@ -209,7 +212,11 @@ pub(crate) async fn blob_download(
);

// Send request
let res = client.get(&url).send().await?;
let res = client
.get(&url)
.header(SDK_HEADER, SDK_USER_AGENT)
.send()
.await?;
map_response_code(res.status(), Some(ApiError::BadBlob))?;

// Read response bytes
Expand Down
4 changes: 4 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,10 @@ pub use crate::receive::IncomingMessage;

const MSGAPI_URL: &str = "https://msgapi.threema.ch";

// Custom header for identifying the type of SDK used
pub(crate) const SDK_HEADER: &str = "x-threema-gateway-sdk";
pub(crate) const SDK_USER_AGENT: &str = concat!("threema-gateway-rs/", env!("CARGO_PKG_VERSION"));

#[cfg(test)]
mod tests {
#[test]
Expand Down
28 changes: 23 additions & 5 deletions src/lookup.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ use crypto_box::KEY_SIZE;
use data_encoding::HEXLOWER_PERMISSIVE;
use reqwest::Client;

use crate::{connection::map_response_code, errors::ApiError, RecipientKey};
use crate::{
connection::map_response_code, errors::ApiError, RecipientKey, SDK_HEADER, SDK_USER_AGENT,
};

/// Different ways to look up a Threema ID in the directory.
#[derive(Debug, PartialEq)]
Expand Down Expand Up @@ -134,7 +136,11 @@ pub(crate) async fn lookup_pubkey(
debug!("Looking up public key for {}", their_id);

// Send request
let res = client.get(&url).send().await?;
let res = client
.get(&url)
.header(SDK_HEADER, SDK_USER_AGENT)
.send()
.await?;
map_response_code(res.status(), None)?;

// Read response body
Expand Down Expand Up @@ -177,7 +183,11 @@ pub(crate) async fn lookup_id(
debug!("Looking up id key for {}", criterion);

// Send request
let res = client.get(&url).send().await?;
let res = client
.get(&url)
.header(SDK_HEADER, SDK_USER_AGENT)
.send()
.await?;
map_response_code(res.status(), Some(ApiError::BadHashLength))?;

// Read and return response body
Expand All @@ -196,7 +206,11 @@ pub(crate) async fn lookup_credits(
debug!("Looking up remaining credits");

// Send request
let res = client.get(&url).send().await?;
let res = client
.get(&url)
.header(SDK_HEADER, SDK_USER_AGENT)
.send()
.await?;
map_response_code(res.status(), None)?;

// Read, parse and return response body
Expand Down Expand Up @@ -226,7 +240,11 @@ pub(crate) async fn lookup_capabilities(
debug!("Looking up capabilities for {}", their_id);

// Send request
let res = client.get(&url).send().await?;
let res = client
.get(&url)
.header(SDK_HEADER, SDK_USER_AGENT)
.send()
.await?;
map_response_code(res.status(), Some(ApiError::BadHashLength))?;

// Read response body
Expand Down