Skip to content

Commit 4b8b69a

Browse files
authored
Adds prelude mods for wp_api & wp_api_integration_tests (#751)
* Make the following mods public: `api_client`, `api_error`, `parsed_url`, `ssl` & `uuid` * Adds `prelude` mods for `wp_api` & `wp_api_integration_tests`
1 parent b1a6e1d commit 4b8b69a

File tree

69 files changed

+236
-448
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+236
-448
lines changed

wp_api/src/jetpack/client.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
use super::endpoint::connection_endpoint::{ConnectionRequestBuilder, ConnectionRequestExecutor};
22
use crate::{
3-
ParsedUrl, WpApiClientDelegate, api_client_generate_api_client,
4-
api_client_generate_endpoint_impl,
3+
api_client::WpApiClientDelegate,
4+
api_client_generate_api_client, api_client_generate_endpoint_impl,
55
auth::WpAuthenticationProvider,
6+
parsed_url::ParsedUrl,
67
request::endpoint::{ApiUrlResolver, WpOrgSiteApiUrlResolver},
78
};
89
use std::sync::Arc;

wp_api/src/jetpack/connection.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
use crate::{
2-
ParsedUrl, WpApiClientDelegate, WpApiError, WpErrorCode,
2+
api_client::WpApiClientDelegate,
3+
api_error::{WpApiError, WpErrorCode},
34
auth::{WpAuthentication, WpAuthenticationProvider},
45
jetpack::client::JetpackApiClient,
6+
parsed_url::ParsedUrl,
57
users::UserId,
68
wp_com::{
79
WpComSiteId, client::WpComApiClient, jetpack_connection::JetpackRemoteConnectionParams,

wp_api/src/lib.rs

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,15 @@
1-
pub use api_client::{
2-
IsWpApiClientDelegate, WpApiClient, WpApiClientDelegate, WpApiRequestBuilder,
3-
};
4-
pub use api_error::{
5-
InvalidSslErrorReason, MaybeWpError, MediaUploadRequestExecutionError, ParsedRequestError,
6-
RequestExecutionError, RequestExecutionErrorReason, WpApiError, WpError, WpErrorCode,
7-
};
8-
pub use parsed_url::{ParseUrlError, ParsedUrl};
91
use plugins::*;
102
use serde::{Deserialize, Serialize};
113
use std::collections::HashMap;
124
use users::*;
13-
pub use uuid::{WpUuid, WpUuidParseError};
145
use wp_localization::{MessageBundle, WpMessages, WpSupportsLocalization};
156
use wp_localization_macro::WpDeriveLocalizable;
167

17-
mod api_client; // re-exported relevant types
18-
mod api_error; // re-exported relevant types
19-
mod parsed_url; // re-exported relevant types
20-
mod ssl; // re-exported relevant types
21-
mod uniffi_serde;
22-
mod uuid; // re-exported relevant types
23-
248
pub mod jetpack;
259
pub mod wp_com;
2610

11+
pub mod api_client;
12+
pub mod api_error;
2713
pub mod application_passwords;
2814
pub mod auth;
2915
pub mod categories;
@@ -32,21 +18,27 @@ pub mod date;
3218
pub mod login;
3319
pub mod media;
3420
pub mod middleware;
21+
pub mod parsed_url;
3522
pub mod plugins;
3623
pub mod post_types;
3724
pub mod posts;
25+
pub mod prelude;
3826
pub mod request;
3927
pub mod search_results;
4028
pub mod site_settings;
29+
pub mod ssl;
4130
pub mod tags;
4231
pub mod taxonomies;
4332
pub mod templates;
4433
pub mod themes;
4534
pub mod url_query;
4635
pub mod users;
36+
pub mod uuid;
4737
pub mod wordpress_org;
4838
pub mod wp_site_health_tests;
4939

40+
mod uniffi_serde;
41+
5042
#[cfg(feature = "reqwest-request-executor")]
5143
pub mod reqwest_request_executor;
5244

wp_api/src/login.rs

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
1+
use crate::{
2+
login::url_discovery::is_local_dev_environment_url, parsed_url::ParsedUrl, uuid::WpUuid,
3+
};
14
use serde::{Deserialize, Serialize};
2-
use std::collections::HashMap;
3-
use std::str;
4-
use std::sync::Arc;
5-
use wp_localization::MessageBundle;
6-
use wp_localization::{WpMessages, WpSupportsLocalization};
5+
use std::{collections::HashMap, str, sync::Arc};
6+
use wp_localization::{MessageBundle, WpMessages, WpSupportsLocalization};
77
use wp_localization_macro::WpDeriveLocalizable;
8-
use wp_serde_helper::deserialize_false_or_string;
9-
use wp_serde_helper::deserialize_offset;
10-
11-
use crate::ParsedUrl;
12-
use crate::WpUuid;
13-
use crate::login::url_discovery::is_local_dev_environment_url;
8+
use wp_serde_helper::{deserialize_false_or_string, deserialize_offset};
149

1510
const KEY_APPLICATION_PASSWORDS: &str = "application-passwords";
1611

wp_api/src/login/login_client.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ use super::{
99
},
1010
};
1111
use crate::{
12-
ParsedUrl, RequestExecutionError, WpError,
12+
api_error::{RequestExecutionError, WpError},
1313
middleware::{PerformsRequests, WpApiMiddlewarePipeline},
14+
parsed_url::ParsedUrl,
1415
request::{
1516
RequestExecutor, RequestMethod, ResponseBodyType, WpNetworkHeaderMap, WpNetworkRequest,
1617
WpNetworkRequestBody, WpNetworkResponse,
@@ -490,7 +491,7 @@ impl PerformsRequests for WpLoginClient {
490491
#[cfg(test)]
491492
mod tests {
492493
use super::*;
493-
use crate::{WpErrorCode, unit_test_common::wp_network_response_from_json};
494+
use crate::{api_error::WpErrorCode, unit_test_common::wp_network_response_from_json};
494495

495496
#[test]
496497
fn test_parse_api_details_wp_error_rest_forbidden() {

wp_api/src/login/url_discovery.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
use super::WpApiDetails;
22
use crate::{
3-
ParseUrlError, ParsedUrl, RequestExecutionError, RequestExecutionErrorReason, WpErrorCode,
3+
api_error::{RequestExecutionError, RequestExecutionErrorReason, WpErrorCode},
44
login::KnownAuthenticationBlockingPlugin,
5+
parsed_url::{ParseUrlError, ParsedUrl},
56
request::{ResponseBodyType, WpRedirect},
67
};
78
use itertools::Itertools;

wp_api/src/middleware.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
use crate::{
2-
IsWpApiClientDelegate, RequestExecutionError, RequestExecutionErrorReason,
2+
api_client::IsWpApiClientDelegate,
3+
api_error::{RequestExecutionError, RequestExecutionErrorReason},
34
request::{RequestExecutor, WpNetworkRequest, WpNetworkResponse},
45
};
56
use std::{fmt::Debug, sync::Arc, time::Duration};
@@ -235,7 +236,7 @@ mod tests {
235236

236237
mod api_discovery_authentication_middleware {
237238
use crate::{
238-
MediaUploadRequestExecutionError,
239+
api_error::MediaUploadRequestExecutionError,
239240
request::{
240241
WpNetworkHeaderMap,
241242
endpoint::{WpEndpointUrl, media_endpoint::MediaUploadRequest},
@@ -371,7 +372,7 @@ mod tests {
371372
mod retry_after_middleware {
372373
use super::*;
373374
use crate::{
374-
MediaUploadRequestExecutionError,
375+
api_error::MediaUploadRequestExecutionError,
375376
request::{
376377
WpNetworkHeaderMap,
377378
endpoint::{WpEndpointUrl, media_endpoint::MediaUploadRequest},

wp_api/src/prelude.rs

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
pub use crate::{
2+
WpApiParamOrder, WpAppNotifier, WpContext,
3+
api_client::{IsWpApiClientDelegate, WpApiClient, WpApiClientDelegate, WpApiRequestBuilder},
4+
api_error::{
5+
InvalidSslErrorReason, MaybeWpError, MediaUploadRequestExecutionError, ParsedRequestError,
6+
RequestExecutionError, RequestExecutionErrorReason, WpApiError, WpError, WpErrorCode,
7+
},
8+
auth::{WpAuthentication, WpAuthenticationProvider},
9+
date::WpGmtDateTime,
10+
generate,
11+
login::login_client::WpLoginClient,
12+
middleware::WpApiMiddlewarePipeline,
13+
parsed_url::{ParseUrlError, ParsedUrl},
14+
request::{
15+
NetworkRequestAccessor, RequestExecutor, WpNetworkHeaderMap, WpNetworkRequest,
16+
WpNetworkResponse,
17+
endpoint::{ApiUrlResolver, WpOrgSiteApiUrlResolver, media_endpoint::MediaUploadRequest},
18+
},
19+
uuid::{WpUuid, WpUuidParseError},
20+
};
21+
22+
#[cfg(feature = "reqwest-request-executor")]
23+
pub use crate::reqwest_request_executor::ReqwestRequestExecutor;

wp_api/src/request.rs

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,31 @@
11
use self::endpoint::WpEndpointUrl;
22
use crate::{
3-
RequestExecutionErrorReason, WpApiError, WpErrorCode,
4-
api_error::{MediaUploadRequestExecutionError, ParsedRequestError, RequestExecutionError},
3+
api_error::{
4+
MediaUploadRequestExecutionError, ParsedRequestError, RequestExecutionError,
5+
RequestExecutionErrorReason, WpApiError, WpErrorCode,
6+
},
57
auth::WpAuthenticationProvider,
68
url_query::{FromUrlQueryPairs, UrlQueryPairsMap},
79
};
810
use base64::Engine;
911
use chrono::{DateTime, Utc};
10-
use endpoint::{ApiEndpointUrl, media_endpoint::MediaUploadRequest};
1112
use endpoint::{
12-
ApiUrlResolver,
13+
ApiEndpointUrl, ApiUrlResolver,
1314
application_passwords_endpoint::{
1415
ApplicationPasswordsRequestBuilder,
1516
ApplicationPasswordsRequestRetrieveCurrentWithEditContextResponse,
1617
},
18+
media_endpoint::MediaUploadRequest,
1719
};
1820
use http::{HeaderMap, HeaderName, HeaderValue};
1921
use regex::Regex;
2022
use serde::{Deserialize, Serialize, de::DeserializeOwned};
21-
use std::str::{FromStr, Utf8Error};
22-
use std::{collections::HashMap, fmt::Debug, sync::Arc};
23+
use std::{
24+
collections::HashMap,
25+
fmt::Debug,
26+
str::{FromStr, Utf8Error},
27+
sync::Arc,
28+
};
2329
use url::Url;
2430
use uuid::Uuid;
2531
use wp_localization::{MessageBundle, WpMessages, WpSupportsLocalization};

wp_api/src/request/endpoint.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use crate::ParsedUrl;
1+
use crate::parsed_url::ParsedUrl;
22
use std::sync::Arc;
33
use strum_macros::EnumIter;
44
use url::Url;
@@ -149,7 +149,7 @@ mod macros {
149149
#[cfg(test)]
150150
mod tests {
151151
use super::*;
152-
use crate::ParsedUrl;
152+
use crate::parsed_url::ParsedUrl;
153153
use rstest::*;
154154
use std::sync::Arc;
155155

0 commit comments

Comments
 (0)