1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264
//! The `spider-client` module provides the primary interface and
//! functionalities for the Spider web crawler library, which is
//! designed for rapid and efficient crawling of web pages to gather
//! links using isolated contexts.
//!
//! ### Features
//!
//! - **Multi-threaded Crawling:** Spider can utilize multiple
//! threads to parallelize the crawling process, drastically
//! improving performance and allowing the ability to gather
//! millions of pages in a short time.
//!
//! - **Configurable:** The library provides various options to
//! configure the crawling behavior, such as setting the depth
//! of crawling, user-agent strings, delays between requests,
//! and more.
//!
//! - **Link Gathering:** One of the primary objectives of Spider is to
//! gather and manage links from the web pages it crawls,
//! compiling them into a structured format for further use.
//!
//! ### Examples
//!
//! Basic usage of the Spider client might look like this:
//!
//! ```rust
//! use spider_client::{Spider, RequestType, RequestParams};
//! use tokio;
//!
//! # #[ignore]
//! #[tokio::main]
//! async fn main() {
//! let spider = Spider::new(Some("myspiderapikey".into())).expect("API key must be provided");
//!
//! let url = "https://spider.cloud";
//!
//! // Scrape a single URL
//! let scraped_data = spider.scrape_url(url, None, "application/json").await.expect("Failed to scrape the URL");
//!
//! println!("Scraped Data: {:?}", scraped_data);
//!
//! // Crawl a website
//! let crawler_params = RequestParams {
//! limit: Some(1),
//! proxy_enabled: Some(true),
//! store_data: Some(false),
//! metadata: Some(false),
//! request: Some(RequestType::Http),
//! ..Default::default()
//! };
//!
//! let crawl_result = spider.crawl_url(url, Some(crawler_params), false, "application/json", None::<fn(serde_json::Value)>).await.expect("Failed to crawl the URL");
//!
//! println!("Crawl Result: {:?}", crawl_result);
//! }
//! ```
//!
//! ### Modules
//!
//! - `config`: Contains the configuration options for the Spider client.
//! - `utils`: Utility functions used by the Spider client.
//!
use reqwest::Client;
use reqwest::{Error, Response};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use tokio_stream::StreamExt;
/// Structure representing the Chunking algorithm dictionary.
#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct ChunkingAlgDict {
/// The chunking algorithm to use, defined as a specific type.
r#type: ChunkingType,
/// The amount to chunk by.
value: i32,
}
// The nested structures
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct Timeout {
/// The seconds up to 60.
pub secs: u64,
/// The nanoseconds.
pub nanos: u32,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct IdleNetwork {
/// The timeout to wait until.
pub timeout: Timeout,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(tag = "type", rename_all = "PascalCase")]
pub enum WebAutomation {
Evaluate { code: String },
Click { selector: String },
Wait { duration: u64 },
WaitForNavigation,
WaitFor { selector: String },
WaitForAndClick { selector: String },
ScrollX { pixels: i32 },
ScrollY { pixels: i32 },
Fill { selector: String, value: String },
InfiniteScroll { times: u32 }
}
#[derive(Default, Serialize, Deserialize, Debug, Clone)]
#[serde(tag = "type", rename_all = "PascalCase")]
pub enum RedirectPolicy {
Loose,
#[default]
Strict
}
pub type WebAutomationMap = std::collections::HashMap<String, Vec<WebAutomation>>;
pub type ExecutionScriptsMap = std::collections::HashMap<String, String>;
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct Selector {
/// The timeout to wait until.
pub timeout: Timeout,
/// The selector to wait for.
pub selector: String,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct Delay {
/// The timeout to wait until.
pub timeout: Timeout,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct WaitFor {
/// Wait until idle networks with a timeout of idleness.
pub idle_network: Option<IdleNetwork>,
/// Wait until a selector exist. Can determine if a selector exist after executing all js and network events.
pub selector: Option<Selector>,
/// Wait until a hard delay.
pub delay: Option<Delay>,
/// Wait until page navigation happen. Default is true.
pub page_navigations: Option<bool>,
}
/// Query request to get a document.
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
pub struct QueryRequest {
/// The exact website url.
pub url: Option<String>,
/// The website domain.
pub domain: Option<String>,
/// The path of the resource.
pub pathname: Option<String>,
}
/// Enum representing different types of Chunking.
#[derive(Default, Debug, Deserialize, Serialize, Clone)]
#[serde(rename_all = "lowercase")]
pub enum ChunkingType {
#[default]
/// By the word count.
ByWords,
/// By the line count.
ByLines,
/// By the char length.
ByCharacterLength,
/// By sentence.
BySentence,
}
#[derive(Default, Debug, Deserialize, Serialize, Clone)]
/// View port handling for chrome.
pub struct Viewport {
/// Device screen Width
pub width: u32,
/// Device screen size
pub height: u32,
/// Device scale factor
pub device_scale_factor: Option<f64>,
/// Emulating Mobile?
pub emulating_mobile: bool,
/// Use landscape mode instead of portrait.
pub is_landscape: bool,
/// Touch screen device?
pub has_touch: bool,
}
/// The API url.
const API_URL: &'static str = "https://api.spider.cloud";
// Define the CSSSelector struct
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct CSSSelector {
/// The name of the selector group
pub name: String,
/// A vector of CSS selectors
pub selectors: Vec<String>,
}
// Define the CSSExtractionMap type
pub type CSSExtractionMap = HashMap<String, Vec<CSSSelector>>;
/// Structure representing request parameters.
#[derive(Debug, Default, Deserialize, Serialize, Clone)]
pub struct RequestParams {
#[serde(default)]
/// The URL to be crawled.
pub url: Option<String>,
#[serde(default)]
/// The type of request to be made.
pub request: Option<RequestType>,
#[serde(default)]
/// The maximum number of pages the crawler should visit.
pub limit: Option<u32>,
#[serde(default)]
/// The format in which the result should be returned.
pub return_format: Option<ReturnFormat>,
#[serde(default)]
/// Specifies whether to only visit the top-level domain.
pub tld: Option<bool>,
#[serde(default)]
/// The depth of the crawl.
pub depth: Option<u32>,
#[serde(default)]
/// Specifies whether the request should be cached.
pub cache: Option<bool>,
#[serde(default)]
/// Perform an infinite scroll on the page as new content arises. The request param also needs to be set to 'chrome' or 'smart'.
pub scroll: Option<u32>,
#[serde(default)]
/// The budget for various resources.
pub budget: Option<HashMap<String, u32>>,
#[serde(default)]
/// The blacklist routes to ignore. This can be a Regex string pattern.
pub blacklist: Option<Vec<String>>,
#[serde(default)]
/// The whitelist routes to only crawl. This can be a Regex string pattern and used with black_listing.
pub whitelist: Option<Vec<String>>,
#[serde(default)]
/// The locale to be used during the crawl.
pub locale: Option<String>,
#[serde(default)]
/// The cookies to be set for the request, formatted as a single string.
pub cookies: Option<String>,
#[serde(default)]
/// Specifies whether to use stealth techniques to avoid detection.
pub stealth: Option<bool>,
#[serde(default)]
/// The headers to be used for the request.
pub headers: Option<HashMap<String, String>>,
#[serde(default)]
/// Specifies whether anti-bot measures should be used.
pub anti_bot: Option<bool>,
#[serde(default)]
/// Specifies whether to include metadata in the response.
pub metadata: Option<bool>,
#[serde(default)]
/// The dimensions of the viewport.
pub viewport: Option<Viewport>,
#[serde(default)]
/// The encoding to be used for the request.
pub encoding: Option<String>,
#[serde(default)]
/// Specifies whether to include subdomains in the crawl.
pub subdomains: Option<bool>,
#[serde(default)]
/// The user agent string to be used for the request.
pub user_agent: Option<String>,
#[serde(default)]
/// Specifies whether the response data should be stored.
pub store_data: Option<bool>,
#[serde(default)]
/// Configuration settings for GPT (general purpose texture mappings).
pub gpt_config: Option<HashMap<String, String>>,
#[serde(default)]
/// Specifies whether to use fingerprinting protection.
pub fingerprint: Option<bool>,
#[serde(default)]
/// Specifies whether to perform the request without using storage.
pub storageless: Option<bool>,
#[serde(default)]
/// Specifies whether readability optimizations should be applied.
pub readability: Option<bool>,
#[serde(default)]
/// Specifies whether to use a proxy for the request.
pub proxy_enabled: Option<bool>,
#[serde(default)]
/// Specifies whether to respect the site's robots.txt file.
pub respect_robots: Option<bool>,
#[serde(default)]
/// CSS selector to be used to filter the content.
pub root_selector: Option<String>,
#[serde(default)]
/// Specifies whether to load all resources of the crawl target.
pub full_resources: Option<bool>,
#[serde(default)]
/// The text string to extract data from.
pub text: Option<String>,
#[serde(default)]
/// Specifies whether to use the sitemap links.
pub sitemap: Option<bool>,
#[serde(default)]
/// Get page insights to determine information like request duration, accessibility, and other web vitals. Requires the `metadata` parameter to be set to `true`.
pub page_insights: Option<bool>,
#[serde(default)]
/// External domains to include the crawl.
pub external_domains: Option<Vec<String>>,
#[serde(default)]
/// Returns the OpenAI embeddings for the title and description. Other values, such as keywords, may also be included. Requires the `metadata` parameter to be set to `true`.
pub return_embeddings: Option<bool>,
#[serde(default)]
/// Returns the HTTP response headers.
pub return_headers: Option<bool>,
#[serde(default)]
/// Returns the link(s) found on the page that match the crawler query.
pub return_page_links: Option<bool>,
#[serde(default)]
/// Returns the HTTP response cookies.
pub return_cookies: Option<bool>,
#[serde(default)]
/// The timeout for the request, in milliseconds.
pub request_timeout: Option<u8>,
#[serde(default)]
/// Specifies whether to run the request in the background.
pub run_in_background: Option<bool>,
#[serde(default)]
/// Specifies whether to skip configuration checks.
pub skip_config_checks: Option<bool>,
#[serde(default)]
/// Use CSS query selectors to scrape contents from the web page. Set the paths and the CSS extraction object map to perform extractions per path or page.
pub css_extraction_map: Option<CSSExtractionMap>,
#[serde(default)]
/// The chunking algorithm to use.
pub chunking_alg: Option<ChunkingAlgDict>,
/// Disable request interception when running 'request' as 'chrome' or 'smart'. This can help when the page uses 3rd party or external scripts to load content.
pub disable_intercept: Option<bool>,
/// The wait for events on the page. You need to make your `request` `chrome` or `smart`.
pub wait_for: Option<WaitFor>,
/// Perform custom Javascript tasks on a url or url path. You need to make your `request` `chrome` or `smart`
pub execution_scripts: Option<ExecutionScriptsMap>,
/// Perform web automated tasks on a url or url path. You need to make your `request` `chrome` or `smart`
pub automation_scripts: Option<WebAutomationMap>,
/// The redirect policy for HTTP request. Set the value to Loose to allow all.
pub redirect_policy: Option<RedirectPolicy>
}
/// The structure representing request parameters for a search request.
#[derive(Debug, Default, Deserialize, Serialize, Clone)]
pub struct SearchRequestParams {
/// The base request parameters.
#[serde(default, flatten)]
pub base: RequestParams,
// The search request.
pub search: String,
/// The search limit.
pub search_limit: Option<u32>,
// Fetch the page content. Defaults to true.
pub fetch_page_content: Option<bool>,
/// The search location of the request
pub location: Option<String>,
/// The country code of the request
pub country: Option<String>,
/// The language code of the request.
pub language: Option<String>,
/// The number of search results
pub num: Option<u32>,
/// The page of the search results.
pub page: Option<u32>,
#[serde(default)]
/// The websites limit if a list is sent from text or urls comma split. This helps automatic configuration of the system.
pub website_limit: Option<u32>,
}
/// Structure representing request parameters for transforming files.
#[derive(Debug, Default, Deserialize, Serialize, Clone)]
pub struct TransformParams {
#[serde(default)]
/// The format in which the result should be returned.
pub return_format: Option<ReturnFormat>,
#[serde(default)]
/// Specifies whether readability optimizations should be applied.
pub readability: Option<bool>,
#[serde(default)]
/// Clean the markdown or text for AI.
pub clean: Option<bool>,
#[serde(default)]
/// Clean the markdown or text for AI removing footers, navigation, and more.
pub clean_full: Option<bool>,
/// The data being transformed.
pub data: Vec<DataParam>,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct DataParam {
pub html: String,
pub url: Option<String>,
}
/// the request type to perform
#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "lowercase")]
pub enum RequestType {
#[default]
Http,
Chrome,
SmartMode,
}
/// Enum representing different return formats.
#[derive(Default, Debug, Deserialize, Serialize, Clone)]
#[serde(rename_all = "lowercase")]
pub enum ReturnFormat {
#[default]
/// The default return format of the resource.
Raw,
/// Return the response as Markdown.
Markdown,
/// Return the response as Commonmark.
Commonmark,
/// Return the response as Html2text.
Html2text,
/// Return the response as Text.
Text,
/// Return the response as Bytes.
Bytes,
}
/// Represents a Spider with API key and HTTP client.
#[derive(Debug, Default)]
pub struct Spider {
/// The Spider API key.
pub api_key: String,
/// The Spider Client to re-use.
pub client: Client,
}
impl Spider {
/// Creates a new instance of Spider.
///
/// # Arguments
///
/// * `api_key` - An optional API key. Defaults to using the 'SPIDER_API_KEY' env variable.
///
/// # Returns
///
/// A new instance of Spider or an error string if no API key is provided.
pub fn new(api_key: Option<String>) -> Result<Self, &'static str> {
let api_key = api_key.or_else(|| std::env::var("SPIDER_API_KEY").ok());
match api_key {
Some(key) => Ok(Self {
api_key: key,
client: Client::new(),
}),
None => Err("No API key provided"),
}
}
/// Creates a new instance of Spider.
///
/// # Arguments
///
/// * `api_key` - An optional API key. Defaults to using the 'SPIDER_API_KEY' env variable.
/// * `client` - A custom client to pass in.
///
/// # Returns
///
/// A new instance of Spider or an error string if no API key is provided.
pub fn new_with_client(api_key: Option<String>, client: Client) -> Result<Self, &'static str> {
let api_key = api_key.or_else(|| std::env::var("SPIDER_API_KEY").ok());
match api_key {
Some(key) => Ok(Self {
api_key: key,
client,
}),
None => Err("No API key provided"),
}
}
/// Sends a POST request to the API.
///
/// # Arguments
///
/// * `endpoint` - The API endpoint.
/// * `data` - The request data as a HashMap.
/// * `stream` - Whether streaming is enabled.
/// * `content_type` - The content type of the request.
///
/// # Returns
///
/// The response from the API.
async fn api_post(
&self,
endpoint: &str,
data: impl Serialize + std::fmt::Debug,
content_type: &str,
) -> Result<Response, Error> {
let url: String = format!("{API_URL}/{}", endpoint);
self.client
.post(&url)
.header(
"User-Agent",
format!("Spider-Client/{}", env!("CARGO_PKG_VERSION")),
)
.header("Content-Type", content_type)
.header("Authorization", format!("Bearer {}", self.api_key))
.json(&data)
.send()
.await
}
/// Sends a GET request to the API.
///
/// # Arguments
///
/// * `endpoint` - The API endpoint.
///
/// # Returns
///
/// The response from the API as a JSON value.
async fn api_get<T: Serialize>(
&self,
endpoint: &str,
query_params: Option<&T>,
) -> Result<serde_json::Value, reqwest::Error> {
let url = format!("{API_URL}/{}", endpoint);
let res = self
.client
.get(&url)
.query(&query_params)
.header(
"User-Agent",
format!("Spider-Client/{}", env!("CARGO_PKG_VERSION")),
)
.header("Content-Type", "application/json")
.header("Authorization", format!("Bearer {}", self.api_key))
.send()
.await?;
res.json().await
}
/// Scrapes a URL.
///
/// # Arguments
///
/// * `url` - The URL to scrape.
/// * `params` - Optional request parameters.
/// * `stream` - Whether streaming is enabled.
/// * `content_type` - The content type of the request.
///
/// # Returns
///
/// The response from the API as a JSON value.
pub async fn scrape_url(
&self,
url: &str,
params: Option<RequestParams>,
content_type: &str,
) -> Result<serde_json::Value, reqwest::Error> {
let mut data = HashMap::new();
data.insert(
"url".to_string(),
serde_json::Value::String(url.to_string()),
);
data.insert("limit".to_string(), serde_json::Value::Number(1.into()));
if let Ok(params) = serde_json::to_value(params) {
match params.as_object() {
Some(ref p) => {
let params_collect = p.iter().map(|(k, v)| (k.to_string(), v.clone()));
data.extend(params_collect);
}
_ => (),
}
}
let res = self.api_post("crawl", data, content_type).await?;
res.json().await
}
/// Sends a DELETE request to the API.
///
/// # Arguments
///
/// * `endpoint` - The API endpoint.
/// * `params` - Optional request parameters.
/// * `stream` - Whether streaming is enabled.
/// * `content_type` - The content type of the request.
///
/// # Returns
///
/// The response from the API.
async fn api_delete(
&self,
endpoint: &str,
params: Option<HashMap<String, serde_json::Value>>,
) -> Result<Response, Error> {
let url = format!("{API_URL}/v1/{}", endpoint);
let request_builder = self
.client
.delete(&url)
.header(
"User-Agent",
format!("Spider-Client/{}", env!("CARGO_PKG_VERSION")),
)
.header("Content-Type", "application/json")
.header("Authorization", format!("Bearer {}", self.api_key));
let request_builder = if let Some(params) = params {
request_builder.json(¶ms)
} else {
request_builder
};
request_builder.send().await
}
/// Crawls a URL.
///
/// # Arguments
///
/// * `url` - The URL to crawl.
/// * `params` - Optional request parameters.
/// * `stream` - Whether streaming is enabled.
/// * `content_type` - The content type of the request.
/// * `callback` - Optional callback function to handle each streamed chunk.
///
/// # Returns
///
/// The response from the API as a JSON value.
pub async fn crawl_url(
&self,
url: &str,
params: Option<RequestParams>,
stream: bool,
content_type: &str,
callback: Option<impl Fn(serde_json::Value) + Send>,
) -> Result<serde_json::Value, reqwest::Error> {
let mut data = HashMap::new();
if let Ok(params) = serde_json::to_value(params) {
match params.as_object() {
Some(ref p) => {
data.extend(p.iter().map(|(k, v)| (k.to_string(), v.clone())));
}
_ => (),
}
}
data.insert("url".into(), serde_json::Value::String(url.to_string()));
let res = self.api_post("crawl", data, content_type).await?;
if stream {
if let Some(callback) = callback {
let stream = res.bytes_stream();
tokio::pin!(stream);
while let Some(item) = stream.next().await {
match item {
Ok(chunk) => match serde_json::from_slice(&chunk) {
Ok(json_obj) => {
callback(json_obj);
}
_ => (),
},
Err(e) => {
eprintln!("Error in streaming response: {}", e);
}
}
}
Ok(serde_json::Value::Null)
} else {
Ok(serde_json::Value::Null)
}
} else {
res.json().await
}
}
/// Fetches links from a URL.
///
/// # Arguments
///
/// * `url` - The URL to fetch links from.
/// * `params` - Optional request parameters.
/// * `stream` - Whether streaming is enabled.
/// * `content_type` - The content type of the request.
///
/// # Returns
///
/// The response from the API as a JSON value.
pub async fn links(
&self,
url: &str,
params: Option<RequestParams>,
_stream: bool,
content_type: &str,
) -> Result<serde_json::Value, reqwest::Error> {
let mut data = HashMap::new();
if let Ok(params) = serde_json::to_value(params) {
match params.as_object() {
Some(ref p) => {
data.extend(p.iter().map(|(k, v)| (k.to_string(), v.clone())));
}
_ => (),
}
}
data.insert("url".into(), serde_json::Value::String(url.to_string()));
let res = self.api_post("links", data, content_type).await?;
res.json().await
}
/// Takes a screenshot of a URL.
///
/// # Arguments
///
/// * `url` - The URL to take a screenshot of.
/// * `params` - Optional request parameters.
/// * `stream` - Whether streaming is enabled.
/// * `content_type` - The content type of the request.
///
/// # Returns
///
/// The response from the API as a JSON value.
pub async fn screenshot(
&self,
url: &str,
params: Option<RequestParams>,
_stream: bool,
content_type: &str,
) -> Result<serde_json::Value, reqwest::Error> {
let mut data = HashMap::new();
if let Ok(params) = serde_json::to_value(params) {
match params.as_object() {
Some(ref p) => {
data.extend(p.iter().map(|(k, v)| (k.to_string(), v.clone())));
}
_ => (),
}
}
data.insert("url".into(), serde_json::Value::String(url.to_string()));
let res = self.api_post("screenshot", data, content_type).await?;
res.json().await
}
/// Searches for a query.
///
/// # Arguments
///
/// * `q` - The query to search for.
/// * `params` - Optional request parameters.
/// * `stream` - Whether streaming is enabled.
/// * `content_type` - The content type of the request.
///
/// # Returns
///
/// The response from the API as a JSON value.
pub async fn search(
&self,
q: &str,
params: Option<SearchRequestParams>,
_stream: bool,
content_type: &str,
) -> Result<serde_json::Value, reqwest::Error> {
let body = match params {
Some(mut params) => {
params.search = q.to_string();
params
}
_ => {
let mut params = SearchRequestParams::default();
params.search = q.to_string();
params
}
};
let res = self.api_post("search", body, content_type).await?;
res.json().await
}
/// Transforms data.
///
/// # Arguments
///
/// * `data` - The data to transform.
/// * `params` - Optional request parameters.
/// * `stream` - Whether streaming is enabled.
/// * `content_type` - The content type of the request.
///
/// # Returns
///
/// The response from the API as a JSON value.
pub async fn transform(
&self,
data: Vec<HashMap<&str, &str>>,
params: Option<TransformParams>,
_stream: bool,
content_type: &str,
) -> Result<serde_json::Value, reqwest::Error> {
let mut payload = HashMap::new();
if let Ok(params) = serde_json::to_value(params) {
match params.as_object() {
Some(ref p) => {
payload.extend(p.iter().map(|(k, v)| (k.to_string(), v.clone())));
}
_ => (),
}
}
match serde_json::to_value(data) {
Ok(d) => {
payload.insert("data".into(), d);
}
_ => (),
}
let res = self.api_post("transform", payload, content_type).await?;
res.json().await
}
/// Extracts contacts from a URL.
///
/// # Arguments
///
/// * `url` - The URL to extract contacts from.
/// * `params` - Optional request parameters.
/// * `stream` - Whether streaming is enabled.
/// * `content_type` - The content type of the request.
///
/// # Returns
///
/// The response from the API as a JSON value.
pub async fn extract_contacts(
&self,
url: &str,
params: Option<RequestParams>,
_stream: bool,
content_type: &str,
) -> Result<serde_json::Value, reqwest::Error> {
let mut data = HashMap::new();
if let Ok(params) = serde_json::to_value(params) {
match params.as_object() {
Some(ref p) => {
data.extend(p.iter().map(|(k, v)| (k.to_string(), v.clone())));
}
_ => (),
}
}
match serde_json::to_value(url) {
Ok(u) => {
data.insert("url".into(), u);
}
_ => (),
}
let res = self
.api_post("pipeline/extract-contacts", data, content_type)
.await?;
res.json().await
}
/// Labels data from a URL.
///
/// # Arguments
///
/// * `url` - The URL to label data from.
/// * `params` - Optional request parameters.
/// * `stream` - Whether streaming is enabled.
/// * `content_type` - The content type of the request.
///
/// # Returns
///
/// The response from the API as a JSON value.
pub async fn label(
&self,
url: &str,
params: Option<RequestParams>,
_stream: bool,
content_type: &str,
) -> Result<serde_json::Value, reqwest::Error> {
let mut data = HashMap::new();
if let Ok(params) = serde_json::to_value(params) {
match params.as_object() {
Some(ref p) => {
data.extend(p.iter().map(|(k, v)| (k.to_string(), v.clone())));
}
_ => (),
}
}
data.insert("url".into(), serde_json::Value::String(url.to_string()));
let res = self.api_post("pipeline/label", data, content_type).await?;
res.json().await
}
/// Download a record from storage.
///
/// # Arguments
///
/// * `url` - Optional exact url of the file in storage.
/// * `options` - Optional options.
/// * `stream` - Whether streaming is enabled.
///
/// # Returns
///
/// The response from the API.
pub async fn download(
&self,
url: Option<&str>,
options: Option<HashMap<&str, i32>>,
) -> Result<reqwest::Response, reqwest::Error> {
let mut params = HashMap::new();
if let Some(url) = url {
params.insert("url".to_string(), url.to_string());
}
if let Some(options) = options {
for (key, value) in options {
params.insert(key.to_string(), value.to_string());
}
}
let url = format!("{API_URL}/v1/data/download");
let request = self
.client
.get(&url)
.header(
"User-Agent",
format!("Spider-Client/{}", env!("CARGO_PKG_VERSION")),
)
.header("Content-Type", "application/octet-stream")
.header("Authorization", format!("Bearer {}", self.api_key))
.query(¶ms);
let res = request.send().await?;
Ok(res)
}
/// Creates a signed URL of a file from storage.
///
/// # Arguments
///
/// * `url` - Optional exact url of the file in storage.
/// * `options` - Optional options.
/// * `stream` - Whether streaming is enabled.
///
/// # Returns
///
/// The response from the API.
pub async fn create_signed_url(
&self,
url: Option<&str>,
options: Option<HashMap<&str, i32>>,
) -> Result<serde_json::Value, reqwest::Error> {
let mut params = HashMap::new();
if let Some(options) = options {
for (key, value) in options {
params.insert(key.to_string(), value.to_string());
}
}
if let Some(url) = url {
params.insert("url".to_string(), url.to_string());
}
let url = format!("{API_URL}/v1/data/sign-url");
let request = self
.client
.get(&url)
.header(
"User-Agent",
format!("Spider-Client/{}", env!("CARGO_PKG_VERSION")),
)
.header("Authorization", format!("Bearer {}", self.api_key))
.query(¶ms);
let res = request.send().await?;
res.json().await
}
/// Gets the crawl state of a URL.
///
/// # Arguments
///
/// * `url` - The URL to get the crawl state of.
/// * `params` - Optional request parameters.
/// * `stream` - Whether streaming is enabled.
/// * `content_type` - The content type of the request.
///
/// # Returns
///
pub async fn get_crawl_state(
&self,
url: &str,
params: Option<RequestParams>,
content_type: &str,
) -> Result<serde_json::Value, reqwest::Error> {
let mut payload = HashMap::new();
payload.insert("url".into(), serde_json::Value::String(url.to_string()));
payload.insert(
"contentType".into(),
serde_json::Value::String(content_type.to_string()),
);
if let Ok(params) = serde_json::to_value(params) {
match params.as_object() {
Some(ref p) => {
payload.extend(p.iter().map(|(k, v)| (k.to_string(), v.clone())));
}
_ => (),
}
}
let res = self
.api_post("data/crawl_state", payload, content_type)
.await?;
res.json().await
}
/// Get the account credits left.
pub async fn get_credits(&self) -> Result<serde_json::Value, reqwest::Error> {
self.api_get::<serde_json::Value>("data/credits", None)
.await
}
/// Send a request for a data record.
pub async fn data_post(
&self,
table: &str,
data: Option<RequestParams>,
) -> Result<serde_json::Value, reqwest::Error> {
let res = self
.api_post(&format!("data/{}", table), data, "application/json")
.await?;
res.json().await
}
/// Query a record from the global DB.
pub async fn query(&self, params: &QueryRequest) -> Result<serde_json::Value, reqwest::Error> {
let res = self
.api_get::<QueryRequest>(&"data/query", Some(params))
.await?;
Ok(res)
}
/// Get a table record.
pub async fn data_get(
&self,
table: &str,
params: Option<RequestParams>,
) -> Result<serde_json::Value, reqwest::Error> {
let mut payload = HashMap::new();
if let Some(params) = params {
match serde_json::to_value(params) {
Ok(p) => match p.as_object() {
Some(o) => {
payload.extend(o.iter().map(|(k, v)| (k.as_str(), v.clone())));
}
_ => (),
},
_ => (),
}
}
let res = self
.api_get::<serde_json::Value>(&format!("data/{}", table), None)
.await?;
Ok(res)
}
/// Delete a record.
pub async fn data_delete(
&self,
table: &str,
params: Option<RequestParams>,
) -> Result<serde_json::Value, reqwest::Error> {
let mut payload = HashMap::new();
if let Ok(params) = serde_json::to_value(params) {
match params.as_object() {
Some(ref p) => {
let params_collect = p.iter().map(|(k, v)| (k.to_string(), v.clone()));
payload.extend(params_collect);
}
_ => (),
}
}
let res = self
.api_delete(&format!("data/{}", table), Some(payload))
.await?;
res.json().await
}
}
#[cfg(test)]
mod tests {
use std::time::Duration;
use super::*;
use dotenv::dotenv;
use lazy_static::lazy_static;
use reqwest::ClientBuilder;
lazy_static! {
static ref SPIDER_CLIENT: Spider = {
dotenv().ok();
let client = ClientBuilder::new();
let client = client
.tcp_keepalive(Some(Duration::from_secs(5)))
.build()
.unwrap();
Spider::new_with_client(None, client).expect("client to build")
};
}
#[tokio::test(flavor = "multi_thread")]
async fn test_scrape_url() {
let response = SPIDER_CLIENT
.scrape_url("https://example.com", None, "application/json")
.await;
assert!(response.is_ok());
}
#[tokio::test(flavor = "multi_thread")]
async fn test_crawl_url() {
let response = SPIDER_CLIENT
.crawl_url(
"https://example.com",
None,
false,
"application/json",
None::<fn(serde_json::Value)>,
)
.await;
assert!(response.is_ok());
}
#[tokio::test(flavor = "multi_thread")]
async fn test_links() {
let response: Result<serde_json::Value, Error> = SPIDER_CLIENT
.links("https://example.com", None, false, "application/json")
.await;
assert!(response.is_ok());
}
#[tokio::test(flavor = "multi_thread")]
async fn test_screenshot() {
let mut params = RequestParams::default();
params.limit = Some(1);
let response = SPIDER_CLIENT
.screenshot(
"https://example.com",
Some(params),
false,
"application/json",
)
.await;
assert!(response.is_ok());
}
// #[tokio::test(flavor = "multi_thread")]
// async fn test_search() {
// let mut params = SearchRequestParams::default();
// params.search_limit = Some(1);
// params.num = Some(1);
// params.fetch_page_content = Some(false);
// let response = SPIDER_CLIENT
// .search("a sports website", Some(params), false, "application/json")
// .await;
// assert!(response.is_ok());
// }
#[tokio::test(flavor = "multi_thread")]
async fn test_transform() {
let data = vec![HashMap::from([(
"<html><body><h1>Transformation</h1></body></html>".into(),
"".into(),
)])];
let response = SPIDER_CLIENT
.transform(data, None, false, "application/json")
.await;
assert!(response.is_ok());
}
#[tokio::test(flavor = "multi_thread")]
async fn test_extract_contacts() {
let response = SPIDER_CLIENT
.extract_contacts("https://example.com", None, false, "application/json")
.await;
assert!(response.is_ok());
}
#[tokio::test(flavor = "multi_thread")]
async fn test_label() {
let response = SPIDER_CLIENT
.label("https://example.com", None, false, "application/json")
.await;
assert!(response.is_ok());
}
#[tokio::test(flavor = "multi_thread")]
async fn test_create_signed_url() {
let response = SPIDER_CLIENT
.create_signed_url(Some("example.com"), None)
.await;
assert!(response.is_ok());
}
#[tokio::test(flavor = "multi_thread")]
async fn test_get_crawl_state() {
let response = SPIDER_CLIENT
.get_crawl_state("https://example.com", None, "application/json")
.await;
assert!(response.is_ok());
}
#[tokio::test(flavor = "multi_thread")]
async fn test_query() {
let mut query = QueryRequest::default();
query.domain = Some("spider.cloud".into());
let response = SPIDER_CLIENT.query(&query).await;
assert!(response.is_ok());
}
#[tokio::test(flavor = "multi_thread")]
async fn test_get_credits() {
let response = SPIDER_CLIENT.get_credits().await;
assert!(response.is_ok());
}
}