diff --git a/Cargo.lock b/Cargo.lock index 3f8609abe..1660ab633 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -246,6 +246,7 @@ dependencies = [ "binstalk-bins", "binstalk-downloader", "binstalk-fetchers", + "binstalk-git-repo-api", "binstalk-registry", "binstalk-types", "cargo-toml-workspace", @@ -303,10 +304,8 @@ dependencies = [ "httpdate", "ipconfig", "once_cell", - "percent-encoding", "reqwest", "serde", - "serde-tuple-vec-map", "serde_json", "tempfile", "thiserror", @@ -325,6 +324,7 @@ version = "0.4.0" dependencies = [ "async-trait", "binstalk-downloader", + "binstalk-git-repo-api", "binstalk-types", "bytes", "compact_str", @@ -342,6 +342,22 @@ dependencies = [ "url", ] +[[package]] +name = "binstalk-git-repo-api" +version = "0.1.0" +dependencies = [ + "binstalk-downloader", + "compact_str", + "percent-encoding", + "serde", + "serde-tuple-vec-map", + "serde_json", + "thiserror", + "tokio", + "tracing", + "url", +] + [[package]] name = "binstalk-manifests" version = "0.13.0" diff --git a/Cargo.toml b/Cargo.toml index 8fda04afa..3ed0edbb7 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -15,6 +15,7 @@ members = [ "crates/fs-lock", "crates/normalize-path", "crates/detect-targets", + "crates/binstalk-git-repo-api", ] [profile.release] diff --git a/crates/binstalk-downloader/Cargo.toml b/crates/binstalk-downloader/Cargo.toml index c72aced93..8374c0c93 100644 --- a/crates/binstalk-downloader/Cargo.toml +++ b/crates/binstalk-downloader/Cargo.toml @@ -43,9 +43,7 @@ reqwest = { version = "0.12.4", features = [ "brotli", "deflate", ], default-features = false } -percent-encoding = "2.2.0" serde = { version = "1.0.163", features = ["derive"], optional = true } -serde-tuple-vec-map = "1.0.1" serde_json = { version = "1.0.107", optional = true } # Use a fork here since we need PAX support, but the upstream # does not hav the PR merged yet. @@ -127,7 +125,6 @@ zstd-thin = ["zstd/thin"] cross-lang-fat-lto = ["zstd/fat-lto"] -gh-api-client = ["json"] json = ["serde", "serde_json"] [target."cfg(windows)".dependencies] diff --git a/crates/binstalk-downloader/src/lib.rs b/crates/binstalk-downloader/src/lib.rs index c4a23c844..1e4cfad76 100644 --- a/crates/binstalk-downloader/src/lib.rs +++ b/crates/binstalk-downloader/src/lib.rs @@ -1,15 +1,6 @@ #![cfg_attr(docsrs, feature(doc_auto_cfg))] pub use bytes; - pub mod download; - -/// Github API client. -/// Currently only support github.com and does not support other enterprise -/// github. -#[cfg(feature = "gh-api-client")] -pub mod gh_api_client; - pub mod remote; - mod utils; diff --git a/crates/binstalk-fetchers/Cargo.toml b/crates/binstalk-fetchers/Cargo.toml index 3b5d77ff6..74c2e0658 100644 --- a/crates/binstalk-fetchers/Cargo.toml +++ b/crates/binstalk-fetchers/Cargo.toml @@ -12,7 +12,8 @@ license = "GPL-3.0-only" [dependencies] async-trait = "0.1.68" -binstalk-downloader = { version = "0.10.3", path = "../binstalk-downloader", default-features = false, features = ["gh-api-client"] } +binstalk-downloader = { version = "0.10.3", path = "../binstalk-downloader", default-features = false } +binstalk-git-repo-api = { version = "0.1.0", path = "../binstalk-git-repo-api" } binstalk-types = { version = "0.7.0", path = "../binstalk-types" } bytes = "1.4.0" compact_str = { version = "0.7.0" } @@ -25,7 +26,10 @@ minisign-verify = "0.2.1" once_cell = "1.18.0" strum = "0.26.1" thiserror = "1.0.52" -tokio = { version = "1.35.0", features = ["rt", "sync"], default-features = false } +tokio = { version = "1.35.0", features = [ + "rt", + "sync", +], default-features = false } tracing = "0.1.39" url = "2.3.1" diff --git a/crates/binstalk-fetchers/src/common.rs b/crates/binstalk-fetchers/src/common.rs index ae789929c..921fe8d74 100644 --- a/crates/binstalk-fetchers/src/common.rs +++ b/crates/binstalk-fetchers/src/common.rs @@ -3,12 +3,12 @@ use std::sync::{ Once, }; -use binstalk_downloader::gh_api_client::{GhReleaseArtifact, HasReleaseArtifact}; pub(super) use binstalk_downloader::{ download::{Download, ExtractedFiles}, - gh_api_client::GhApiClient, remote::{Client, Url}, }; +pub(super) use binstalk_git_repo_api::gh_api_client::GhApiClient; +use binstalk_git_repo_api::gh_api_client::{GhReleaseArtifact, HasReleaseArtifact}; pub(super) use binstalk_types::cargo_toml_binstall::{PkgFmt, PkgMeta}; pub(super) use compact_str::CompactString; pub(super) use tokio::task::JoinHandle; diff --git a/crates/binstalk-fetchers/src/lib.rs b/crates/binstalk-fetchers/src/lib.rs index a742e87e7..1ed1ad8e8 100644 --- a/crates/binstalk-fetchers/src/lib.rs +++ b/crates/binstalk-fetchers/src/lib.rs @@ -2,9 +2,8 @@ use std::{path::Path, sync::Arc}; -use binstalk_downloader::{ - download::DownloadError, gh_api_client::GhApiError, remote::Error as RemoteError, -}; +use binstalk_downloader::{download::DownloadError, remote::Error as RemoteError}; +use binstalk_git_repo_api::gh_api_client::GhApiError; use binstalk_types::cargo_toml_binstall::SigningAlgorithm; use thiserror::Error as ThisError; use tokio::sync::OnceCell; diff --git a/crates/binstalk-git-repo-api/Cargo.toml b/crates/binstalk-git-repo-api/Cargo.toml new file mode 100644 index 000000000..9abc83b24 --- /dev/null +++ b/crates/binstalk-git-repo-api/Cargo.toml @@ -0,0 +1,24 @@ +[package] +name = "binstalk-git-repo-api" +description = "The binstall toolkit for accessing API for git repository" +repository = "https://github.com/cargo-bins/cargo-binstall" +documentation = "https://docs.rs/binstalk-git-repo-api" +version = "0.1.0" +rust-version = "1.70.0" +authors = ["Jiahao XU "] +edition = "2021" +license = "Apache-2.0 OR MIT" + +[dependencies] +binstalk-downloader = { version = "0.10.3", path = "../binstalk-downloader", default-features = false, features = [ + "json", +] } +compact_str = "0.7.0" +percent-encoding = "2.2.0" +serde = { version = "1.0.163", features = ["derive"] } +serde-tuple-vec-map = "1.0.1" +serde_json = { version = "1.0.107" } +thiserror = "1.0.52" +tokio = { version = "1.35.0", features = ["sync"], default-features = false } +tracing = "0.1.39" +url = "2.3.1" diff --git a/crates/binstalk-git-repo-api/LICENSE-APACHE b/crates/binstalk-git-repo-api/LICENSE-APACHE new file mode 100644 index 000000000..1b5ec8b78 --- /dev/null +++ b/crates/binstalk-git-repo-api/LICENSE-APACHE @@ -0,0 +1,176 @@ + 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 diff --git a/crates/binstalk-git-repo-api/LICENSE-MIT b/crates/binstalk-git-repo-api/LICENSE-MIT new file mode 100644 index 000000000..31aa79387 --- /dev/null +++ b/crates/binstalk-git-repo-api/LICENSE-MIT @@ -0,0 +1,23 @@ +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/crates/binstalk-downloader/src/gh_api_client.rs b/crates/binstalk-git-repo-api/src/gh_api_client.rs similarity index 99% rename from crates/binstalk-downloader/src/gh_api_client.rs rename to crates/binstalk-git-repo-api/src/gh_api_client.rs index 92dac5f84..d6655c4ce 100644 --- a/crates/binstalk-downloader/src/gh_api_client.rs +++ b/crates/binstalk-git-repo-api/src/gh_api_client.rs @@ -8,14 +8,13 @@ use std::{ time::{Duration, Instant}, }; +use binstalk_downloader::remote; use compact_str::CompactString; use percent_encoding::{ percent_decode_str, utf8_percent_encode, AsciiSet, PercentEncode, CONTROLS, }; use tokio::sync::OnceCell; -use crate::remote; - mod request; pub use request::{GhApiContextError, GhApiError, GhGraphQLErrors}; diff --git a/crates/binstalk-downloader/src/gh_api_client/request.rs b/crates/binstalk-git-repo-api/src/gh_api_client/request.rs similarity index 99% rename from crates/binstalk-downloader/src/gh_api_client/request.rs rename to crates/binstalk-git-repo-api/src/gh_api_client/request.rs index 59e0d1408..d226d819f 100644 --- a/crates/binstalk-downloader/src/gh_api_client/request.rs +++ b/crates/binstalk-git-repo-api/src/gh_api_client/request.rs @@ -8,13 +8,12 @@ use std::{ time::Duration, }; +use binstalk_downloader::remote::{header::HeaderMap, StatusCode, Url}; use compact_str::{CompactString, ToCompactString}; -use reqwest::{header::HeaderMap, StatusCode}; use serde::{de::Deserializer, Deserialize, Serialize}; use serde_json::to_string as to_json_string; use thiserror::Error as ThisError; use tracing::debug; -use url::Url; use super::{percent_encode_http_url_path, remote, GhRelease}; diff --git a/crates/binstalk-git-repo-api/src/lib.rs b/crates/binstalk-git-repo-api/src/lib.rs new file mode 100644 index 000000000..7d7dd52cc --- /dev/null +++ b/crates/binstalk-git-repo-api/src/lib.rs @@ -0,0 +1 @@ +pub mod gh_api_client; diff --git a/crates/binstalk/Cargo.toml b/crates/binstalk/Cargo.toml index 74fe2dd1a..8983efcb6 100644 --- a/crates/binstalk/Cargo.toml +++ b/crates/binstalk/Cargo.toml @@ -11,9 +11,8 @@ license = "GPL-3.0-only" [dependencies] binstalk-bins = { version = "0.4.0", path = "../binstalk-bins" } -binstalk-downloader = { version = "0.10.3", path = "../binstalk-downloader", default-features = false, features = [ - "gh-api-client", -] } +binstalk-downloader = { version = "0.10.3", path = "../binstalk-downloader", default-features = false } +binstalk-git-repo-api = { version = "0.1.0", path = "../binstalk-git-repo-api" } binstalk-fetchers = { version = "0.4.0", path = "../binstalk-fetchers", features = [ "quickinstall", ] } diff --git a/crates/binstalk/src/errors.rs b/crates/binstalk/src/errors.rs index c5afd7a6e..f367299dd 100644 --- a/crates/binstalk/src/errors.rs +++ b/crates/binstalk/src/errors.rs @@ -4,9 +4,7 @@ use std::{ process::{ExitCode, ExitStatus, Termination}, }; -use binstalk_downloader::{ - download::DownloadError, gh_api_client::GhApiError, remote::Error as RemoteError, -}; +use binstalk_downloader::{download::DownloadError, remote::Error as RemoteError}; use binstalk_fetchers::FetchError; use compact_str::CompactString; use itertools::Itertools; @@ -19,7 +17,8 @@ use tracing::{error, warn}; use crate::{ bins, helpers::{ - cargo_toml::Error as CargoTomlError, cargo_toml_workspace::Error as LoadManifestFromWSError, + cargo_toml::Error as CargoTomlError, + cargo_toml_workspace::Error as LoadManifestFromWSError, gh_api_client::GhApiError, }, registry::{InvalidRegistryError, RegistryError}, }; diff --git a/crates/binstalk/src/helpers.rs b/crates/binstalk/src/helpers.rs index 058813de7..560fc3f30 100644 --- a/crates/binstalk/src/helpers.rs +++ b/crates/binstalk/src/helpers.rs @@ -4,7 +4,7 @@ pub(crate) mod target_triple; pub mod tasks; pub(crate) use binstalk_downloader::download; -pub use binstalk_downloader::gh_api_client; +pub use binstalk_git_repo_api::gh_api_client; pub(crate) use cargo_toml_workspace::{self, cargo_toml}; #[cfg(feature = "git")] diff --git a/crates/binstalk/src/helpers/remote.rs b/crates/binstalk/src/helpers/remote.rs index 24635b89c..af734f8d0 100644 --- a/crates/binstalk/src/helpers/remote.rs +++ b/crates/binstalk/src/helpers/remote.rs @@ -1,13 +1,13 @@ pub use binstalk_downloader::remote::*; pub use url::ParseError as UrlParseError; -use binstalk_downloader::gh_api_client::{GhApiClient, GhReleaseArtifact, HasReleaseArtifact}; use std::sync::{ atomic::{AtomicBool, Ordering::Relaxed}, Once, }; use tracing::{debug, warn}; +use super::gh_api_client::{GhApiClient, GhReleaseArtifact, HasReleaseArtifact}; use crate::errors::BinstallError; /// This function returns a future where its size should be at most size of diff --git a/crates/git-repo-api/Cargo.toml b/crates/git-repo-api/Cargo.toml new file mode 100644 index 000000000..7af038657 --- /dev/null +++ b/crates/git-repo-api/Cargo.toml @@ -0,0 +1,6 @@ +[package] +name = "git-repo-api" +version = "0.1.0" +edition = "2021" + +[dependencies] diff --git a/crates/git-repo-api/src/lib.rs b/crates/git-repo-api/src/lib.rs new file mode 100644 index 000000000..7d12d9af8 --- /dev/null +++ b/crates/git-repo-api/src/lib.rs @@ -0,0 +1,14 @@ +pub fn add(left: usize, right: usize) -> usize { + left + right +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn it_works() { + let result = add(2, 2); + assert_eq!(result, 4); + } +}