Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
67 changes: 67 additions & 0 deletions wp_api/src/application_passwords.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
use serde::{Deserialize, Serialize};
use wp_contextual::WpContextual;

#[derive(Debug, Serialize, Deserialize, uniffi::Record, WpContextual)]
pub struct SparseApplicationPassword {
#[WpContext(edit, embed, view)]
pub uuid: Option<ApplicationPasswordUuid>,
#[WpContext(edit, embed, view)]
pub app_id: Option<ApplicationPasswordAppId>,
#[WpContext(edit, embed, view)]
pub name: Option<String>,
#[WpContext(edit, view)]
pub created: Option<String>,
#[WpContextualOption]
#[WpContext(edit, view)]
pub last_used: Option<String>,
#[WpContextualOption]
#[WpContext(edit, view)]
pub last_ip: Option<IpAddress>,
#[WpContextualOption]
#[WpContext(edit)]
pub password: Option<String>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, uniffi::Enum)]
pub enum SparseApplicationPasswordField {
Uuid,
AppId,
Name,
Created,
LastUsed,
LastIp,
Password,
}

impl crate::SparseField for SparseApplicationPasswordField {
fn as_str(&self) -> &str {
match self {
Self::Uuid => "uuid",
Self::AppId => "app_id",
Self::Name => "name",
Self::Created => "created",
Self::LastUsed => "last_used",
Self::LastIp => "last_ip",
Self::Password => "password",
}
}
}

#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize, uniffi::Record)]
#[serde(transparent)]
pub struct ApplicationPasswordUuid {
pub uuid: String,
}

#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize, uniffi::Record)]
#[serde(transparent)]
pub struct ApplicationPasswordAppId {
pub app_id: String,
}

#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize, uniffi::Record)]
#[serde(transparent)]
pub struct IpAddress {
#[serde(alias = "last_ip")]
pub value: String,
}
28 changes: 24 additions & 4 deletions wp_api/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
#![allow(dead_code, unused_variables)]

use request::{
endpoint::ApiBaseUrl, plugins_request_builder::PluginsRequestBuilder,
users_request_builder::UsersRequestBuilder, RequestExecutor, UsersRequestBuilder2,
WpNetworkResponse,
endpoint::{
application_passwords_endpoint::{
ApplicationPasswordsRequestBuilder2, ApplicationPasswordsRequestExecutor,
},
ApiBaseUrl,
},
plugins_request_builder::PluginsRequestBuilder,
users_request_builder::UsersRequestBuilder,
RequestExecutor, UsersRequestBuilder2, WpNetworkResponse,
};
use std::sync::Arc;

Expand All @@ -15,6 +21,7 @@ use plugins::*;
use users::*;

mod api_error; // re-exported relevant types
pub mod application_passwords;
pub mod login;
pub mod plugins;
pub mod request;
Expand Down Expand Up @@ -62,6 +69,7 @@ impl WpApiRequestBuilder {

#[derive(Debug, uniffi::Object)]
pub struct WpRequestBuilder {
application_passwords: Arc<ApplicationPasswordsRequestExecutor>,
users: Arc<UsersRequestBuilder>,
plugins: Arc<PluginsRequestBuilder>,
}
Expand All @@ -80,17 +88,29 @@ impl WpRequestBuilder {
})?
.into();
let request_builder = Arc::new(request::RequestBuilder::new(
request_executor,
request_executor.clone(),
authentication.clone(),
));

Ok(Self {
application_passwords: ApplicationPasswordsRequestExecutor::new(
ApplicationPasswordsRequestBuilder2::new(
api_base_url.clone(),
request_builder.clone(),
),
request_executor.clone(),
)
.into(),
users: UsersRequestBuilder::new(api_base_url.clone(), request_builder.clone()).into(),
plugins: PluginsRequestBuilder::new(api_base_url.clone(), request_builder.clone())
.into(),
})
}

pub fn application_passwords(&self) -> Arc<ApplicationPasswordsRequestExecutor> {
self.application_passwords.clone()
}

pub fn users(&self) -> Arc<UsersRequestBuilder> {
self.users.clone()
}
Expand Down
1 change: 1 addition & 0 deletions wp_api/src/request/endpoint.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ use url::Url;

use crate::SparseField;

pub(crate) mod application_passwords_endpoint;
pub(crate) mod plugins_endpoint;
pub(crate) mod users_endpoint;

Expand Down
71 changes: 71 additions & 0 deletions wp_api/src/request/endpoint/application_passwords_endpoint.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
use wp_derive_request_builder::WpDerivedRequest;

use crate::application_passwords::SparseApplicationPasswordField;
use crate::users::UserId;

#[derive(WpDerivedRequest)]
#[SparseField(SparseApplicationPasswordField)]
enum ApplicationPasswordsRequest {
#[contextual_get(url = "/users/<user_id>/application-passwords", output = Vec<crate::application_passwords::SparseApplicationPassword>)]
List,
}

#[cfg(test)]
mod tests {
use super::*;
use crate::{
request::endpoint::{
tests::{fixture_api_base_url, validate_endpoint},
ApiBaseUrl,
},
WpContext,
};
use rstest::*;
use std::sync::Arc;

#[rstest]
fn list_application_passwords_with_edit_context(endpoint: ApplicationPasswordsRequestEndpoint) {
validate_endpoint(
endpoint.list_with_edit_context(UserId(2)),
"/users/2/application-passwords?context=edit",
);
}

#[rstest]
fn list_application_passwords_with_embed_context(
endpoint: ApplicationPasswordsRequestEndpoint,
) {
validate_endpoint(
endpoint.list_with_embed_context(UserId(71)),
"/users/71/application-passwords?context=embed",
);
}

#[rstest]
fn list_application_passwords_with_view_context(endpoint: ApplicationPasswordsRequestEndpoint) {
validate_endpoint(
endpoint.list_with_view_context(UserId(9999)),
"/users/9999/application-passwords?context=view",
);
}

#[rstest]
#[case(WpContext::Edit, &[SparseApplicationPasswordField::Uuid], "/users/2/application-passwords?context=edit&_fields=uuid")]
#[case(WpContext::View, &[SparseApplicationPasswordField::Uuid, SparseApplicationPasswordField::Name], "/users/2/application-passwords?context=view&_fields=uuid%2Cname")]
fn filter_list_application_passwords(
endpoint: ApplicationPasswordsRequestEndpoint,
#[case] context: WpContext,
#[case] fields: &[SparseApplicationPasswordField],
#[case] expected_path: &str,
) {
validate_endpoint(
endpoint.filter_list(UserId(2), context, fields),
expected_path,
);
}

#[fixture]
fn endpoint(fixture_api_base_url: Arc<ApiBaseUrl>) -> ApplicationPasswordsRequestEndpoint {
ApplicationPasswordsRequestEndpoint::new(fixture_api_base_url)
}
}
124 changes: 124 additions & 0 deletions wp_api/tests/test_application_passwords_immut.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
use rstest::*;
use rstest_reuse::{self, apply, template};
use wp_api::application_passwords::{SparseApplicationPassword, SparseApplicationPasswordField};
use wp_api::users::UserId;
use wp_api::WpContext;

use crate::integration_test_common::{
request_builder, AssertResponse, FIRST_USER_ID, SECOND_USER_ID,
};

pub mod integration_test_common;
pub mod reusable_test_cases;

#[apply(filter_fields_cases)]
#[tokio::test]
async fn filter_application_passwords(
#[values(FIRST_USER_ID, SECOND_USER_ID)] user_id: UserId,
#[case] fields: &[SparseApplicationPasswordField],
) {
request_builder()
.application_passwords()
.filter_list(user_id, WpContext::Edit, fields)
.await
.assert_response()
.iter()
.for_each(|p| validate_sparse_application_password_fields(p, fields));
}

#[rstest]
#[tokio::test]
async fn list_application_passwords_with_edit_context(
#[values(FIRST_USER_ID, SECOND_USER_ID)] user_id: UserId,
) {
request_builder()
.application_passwords()
.list_with_edit_context(user_id)
.await
.assert_response();
}

#[rstest]
#[tokio::test]
async fn list_application_passwords_with_embed_context(
#[values(FIRST_USER_ID, SECOND_USER_ID)] user_id: UserId,
) {
request_builder()
.application_passwords()
.list_with_embed_context(user_id)
.await
.assert_response();
}

#[rstest]
#[tokio::test]
async fn list_application_passwords_with_view_context(
#[values(FIRST_USER_ID, SECOND_USER_ID)] user_id: UserId,
) {
request_builder()
.application_passwords()
.list_with_view_context(user_id)
.await
.assert_response();
}

// TODO: This might not be a good test case to keep, but it's helpful during initial implementation
// to ensure that the ip address is properly parsed
#[tokio::test]
async fn list_application_passwords_ensure_last_ip() {
let list = request_builder()
.application_passwords()
.list_with_edit_context(FIRST_USER_ID)
.await
.assert_response();
assert!(list.first().unwrap().last_ip.is_some());
}

fn validate_sparse_application_password_fields(
app_password: &SparseApplicationPassword,
fields: &[SparseApplicationPasswordField],
) {
let field_included = |field| {
// If "fields" is empty the server will return all fields
fields.is_empty() || fields.contains(&field)
};
assert_eq!(
app_password.uuid.is_some(),
field_included(SparseApplicationPasswordField::Uuid)
);
assert_eq!(
app_password.app_id.is_some(),
field_included(SparseApplicationPasswordField::AppId)
);
assert_eq!(
app_password.name.is_some(),
field_included(SparseApplicationPasswordField::Name)
);
assert_eq!(
app_password.created.is_some(),
field_included(SparseApplicationPasswordField::Created)
);
// Do not test existence of `last_used`, `last_ip` or `password` as there is
// no guarantee that they'll be included even if it's in the requested field list
if !field_included(SparseApplicationPasswordField::LastUsed) {
assert!(app_password.last_used.is_none());
}
if !field_included(SparseApplicationPasswordField::LastIp) {
assert!(app_password.last_ip.is_none());
}
if !field_included(SparseApplicationPasswordField::Password) {
assert!(app_password.password.is_none());
}
}

#[template]
#[rstest]
#[case(&[])]
#[case(&[SparseApplicationPasswordField::Uuid])]
#[case(&[SparseApplicationPasswordField::AppId])]
#[case(&[SparseApplicationPasswordField::Name])]
#[case(&[SparseApplicationPasswordField::Created])]
#[case(&[SparseApplicationPasswordField::LastUsed])]
#[case(&[SparseApplicationPasswordField::LastIp])]
#[case(&[SparseApplicationPasswordField::Uuid, SparseApplicationPasswordField::Name])]
fn filter_fields_cases(#[case] fields: &[SparseApplicationPasswordField]) {}
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,9 @@ pub fn fn_context_param(context_and_filter_handler: ContextAndFilterHandler) ->
| ContextAndFilterHandler::NoFilterTakeContextAsFunctionName(_)
| ContextAndFilterHandler::FilterNoContext => TokenStream::new(),
ContextAndFilterHandler::NoFilterTakeContextAsArgument
| ContextAndFilterHandler::FilterTakeContextAsArgument => quote! { context: WpContext, },
| ContextAndFilterHandler::FilterTakeContextAsArgument => {
quote! { context: crate::WpContext, }
}
}
}

Expand Down Expand Up @@ -445,15 +447,15 @@ mod tests {
)]
#[case(
ContextAndFilterHandler::NoFilterTakeContextAsArgument,
"context : WpContext ,"
"context : crate :: WpContext ,"
)]
#[case(
ContextAndFilterHandler::NoFilterTakeContextAsFunctionName(WpContext::Embed),
""
)]
#[case(
ContextAndFilterHandler::FilterTakeContextAsArgument,
"context : WpContext ,"
"context : crate :: WpContext ,"
)]
fn test_fn_context_param(
#[case] context_and_filter_handler: ContextAndFilterHandler,
Expand Down Expand Up @@ -692,15 +694,15 @@ mod tests {
&referenced_params_type("UserListParams"),
RequestType::ContextualGet,
ContextAndFilterHandler::NoFilterTakeContextAsArgument,
"fn list (& self , context : WpContext , params : &UserListParams ,)")]
"fn list (& self , context : crate :: WpContext , params : &UserListParams ,)")]
#[case(
PartOf::Endpoint,
format_ident!("List"),
url_static_users(),
&referenced_params_type("UserListParams"),
RequestType::ContextualGet,
ContextAndFilterHandler::FilterTakeContextAsArgument,
"fn filter_list (& self , context : WpContext , params : &UserListParams , fields : & [SparseUserField])")]
"fn filter_list (& self , context : crate :: WpContext , params : &UserListParams , fields : & [SparseUserField])")]
#[case(
PartOf::Endpoint,
format_ident!("Retrieve"),
Expand All @@ -716,7 +718,7 @@ mod tests {
&ParamsType::new(None),
RequestType::ContextualGet,
ContextAndFilterHandler::FilterTakeContextAsArgument,
"fn filter_retrieve (& self , user_id : UserId , context : WpContext , fields : & [SparseUserField])")]
"fn filter_retrieve (& self , user_id : UserId , context : crate :: WpContext , fields : & [SparseUserField])")]
#[case(
PartOf::Endpoint,
format_ident!("Update"),
Expand Down