commit 7531bb475c609631fec3bddab8083003a7545f48 Author: trivernis Date: Sun Jul 25 15:35:19 2021 +0200 Add client and function to get illustration data Signed-off-by: trivernis diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..408b8a5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/target +Cargo.lock +.idea \ No newline at end of file diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..21bce81 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,29 @@ +[package] +name = "pixiv-rs" +version = "0.1.0" +edition = "2018" +authors = ["trivernis "] +description = "Wrapper for the inofficial pixiv ajax api" +repository = "https://github.com/Trivernis/pixiv-rs" +readme = "README.md" +license = "Apache-2.0" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + + +[dependencies] +serde = {version = "^1.0", features = ["derive"]} +reqwest = {version = "0.11.4", features = ["json"]} +serde_json = "1.0.64" + +[dev-dependencies] +env_logger = "0.8.4" +lazy_static = "1.4.0" +log = "0.4.14" + +[dev-dependencies.tokio] +version = "1.8.0" +features = ["macros", "rt-multi-thread"] + +[features] +rustls = ["reqwest/rustls"] \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -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/README.md b/README.md new file mode 100644 index 0000000..bc7473a --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Pixiv for Rust + +This crate allows calls to the pixiv internal ajax api to retrieve information about posts. + +## Example + +```rust +use pixiv_rs::client::PixivClient; + +async fn main() { + let illustration = client.illustration("43663273").await.unwrap(); + for tag in illustration.tags.tags { + println!("{}", tag.tag); + } +} +``` + +## License + +Apache-2.0 \ No newline at end of file diff --git a/src/client.rs b/src/client.rs new file mode 100644 index 0000000..b45699d --- /dev/null +++ b/src/client.rs @@ -0,0 +1,35 @@ +use reqwest::Client; +use crate::error::{Result, Error}; +use crate::responses::{Response, Illustration}; +use serde::de::DeserializeOwned; +use serde::Serialize; + +static BASE_URL: &str = "https://www.pixiv.net/ajax"; +static LANG_PARAM: (&str, &str) = ("lang", "en"); + +#[derive(Clone, Debug)] +pub struct PixivClient { + client: Client +} + +impl PixivClient { + pub fn new() -> Self { + Self {client: Client::new()} + } + + /// Returns data for the given illustration + pub async fn illustration>(&self, id: S) -> Result { + self.get(format!("illust/{}", id.as_ref()), &[("full", "1"), LANG_PARAM]).await + } + + async fn get, Q: Serialize + ?Sized>(&self, path: S, query: &Q) -> Result { + let response = self.client.get(format!("{}/{}", BASE_URL, path.as_ref())).query(query).send().await?; + + let json_response = response.json::>().await?; + if json_response.error { + Err(Error::Pixiv(json_response.message)) + } else { + Ok(json_response.body.get().unwrap()) + } + } +} \ No newline at end of file diff --git a/src/error.rs b/src/error.rs new file mode 100644 index 0000000..7be896b --- /dev/null +++ b/src/error.rs @@ -0,0 +1,27 @@ +use std::fmt; +use std::error::Error as StdError; + +pub type Result = std::result::Result; + +#[derive(Debug)] +pub enum Error { + Reqwest(reqwest::Error), + Pixiv(String), +} + +impl fmt::Display for Error { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + match self { + Error::Reqwest(e) => {e.fmt(f)} + Error::Pixiv(s) => {write!(f, "Pixiv error: {}", s)} + } + } +} + +impl StdError for Error {} + +impl From for Error { + fn from(e: reqwest::Error) -> Self { + Self::Reqwest(e) + } +} \ No newline at end of file diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..3ad4a39 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,6 @@ + +pub mod client; +pub mod responses; +pub mod error; + +pub use client::PixivClient; \ No newline at end of file diff --git a/src/responses.rs b/src/responses.rs new file mode 100644 index 0000000..230b7be --- /dev/null +++ b/src/responses.rs @@ -0,0 +1,82 @@ +use serde::Deserialize; +use std::fmt::Debug; +use std::collections::HashMap; +use serde_json::Value; + +#[derive(Clone, Debug, Deserialize)] +pub struct Response { + pub error: bool, + pub message: String, + pub body: ResponseBody, +} + +#[derive(Clone, Debug, Deserialize)] +#[serde(untagged)] +pub enum ResponseBody { + WithValue(T), + NoValue(Vec<()>) +} + +impl ResponseBody { + pub fn get(self) -> Option { + match self { + ResponseBody::WithValue(b) => {Some(b)} + ResponseBody::NoValue(_) => {None} + } + } +} + +#[derive(Clone, Debug, Deserialize)] +#[serde(rename_all(deserialize = "camelCase", serialize = "snake_case"))] +pub struct Illustration { + pub id: String, + pub title: String, + pub description: String, + pub illust_type: u32, + pub create_date: String, + pub upload_date: String, + #[serde(alias="xRestrict")] + pub age_restrict: u32, + pub urls: IllustrationUrl, + pub tags: IllustrationTags, + pub alt: String, + pub user_id: String, + pub user_name: String, + pub user_account: String, + pub width: u32, + pub height: u32, + pub page_count: u32, + pub bookmark_count: u64, + pub like_count: u64, + pub comment_count: u64, + pub response_count: u64, + pub view_count: u64, + #[serde(flatten)] + pub additional_fields: HashMap, +} + +#[derive(Clone, Debug, Deserialize)] +pub struct IllustrationUrl { + pub mini: String, + pub thumb: String, + pub small: String, + pub regular: String, + pub original: String, +} + +#[derive(Clone, Debug, Deserialize)] +#[serde(rename_all(deserialize = "camelCase", serialize = "snake_case"))] +pub struct IllustrationTags { + pub author_id: String, + pub tags: Vec +} + +#[derive(Clone, Debug, Deserialize)] +#[serde(rename_all(deserialize = "camelCase", serialize = "snake_case"))] +pub struct Tag { + pub tag: String, + pub user_id: Option, + pub romaji: Option, + #[serde(default)] + pub translation: HashMap, +} \ No newline at end of file diff --git a/tests/common.rs b/tests/common.rs new file mode 100644 index 0000000..b3c39b7 --- /dev/null +++ b/tests/common.rs @@ -0,0 +1,12 @@ +use log::LevelFilter; +use std::sync::atomic::{AtomicBool, Ordering}; +use std::sync::Arc; + +pub fn setup() { + lazy_static::lazy_static! { static ref SETUP_DONE: Arc = Arc::new(AtomicBool::new(false)); } + if !SETUP_DONE.swap(true, Ordering::SeqCst) { + env_logger::builder() + .filter_level(LevelFilter::Trace) + .init(); + } +} \ No newline at end of file diff --git a/tests/test_illustrations.rs b/tests/test_illustrations.rs new file mode 100644 index 0000000..81c6311 --- /dev/null +++ b/tests/test_illustrations.rs @@ -0,0 +1,55 @@ +use pixiv_rs::client::PixivClient; + +mod common; + +static SAFE_ILLUSTRATION_IDS: &[&str] = &[ + "15909278", + "43663273", + "42648936", + "7758820" +]; +static R18_ILLUSTRATION_IDS: &[&str] = &[ + "1878082", + "78654878" +]; +static INVALID_ILLUSTRATION_IDS: &[&str] = &[ + "56006815", + "" +]; + +#[tokio::test] +async fn it_returns_safe_illustrations() { + common::setup(); + let client = PixivClient::new(); + + for id in SAFE_ILLUSTRATION_IDS { + let illustration = client.illustration(id).await.unwrap(); + assert_eq!(illustration.id, *id); + assert!(illustration.title.len() > 0); + assert!(illustration.tags.tags.len() > 0); + assert_eq!(illustration.age_restrict, 0); + } +} + +#[tokio::test] +async fn it_returns_r18_illustrations() { + common::setup(); + let client = PixivClient::new(); + for id in R18_ILLUSTRATION_IDS { + let illustration = client.illustration(id).await.unwrap(); + assert_eq!(illustration.id, *id); + assert!(illustration.title.len() > 0); + assert!(illustration.tags.tags.len() > 0); + assert_eq!(illustration.age_restrict, 1); + } +} + +#[tokio::test] +async fn it_returns_errors_on_invalid_illustrations() { + common::setup(); + let client = PixivClient::new(); + for id in INVALID_ILLUSTRATION_IDS { + let result = client.illustration(id).await; + assert!(result.is_err()) + } +} \ No newline at end of file