urlscan 0.3.0

URLScan.io API
Documentation 
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

//! # URLScan.io REST API Wrapper.
//!
//! Provides an abstraction over the URLScan.io API. 
//! This library supports the following tasks[^note]:
//! - [x] Get Quota
//! - [x] Submit URL to be scanned
//! - [x] Get JSON Result of scan as String
//! - [x] Get DOM of previously scanner URL by UUID
//! - [x] Get Screenshot of page
//! - [x] Search functionality
//!
//! [^note]: Tasks that are not marked as complete are currently being worked on and will be part of a future release.
//! 
//! ## API Key
//! In order to use this library, you need an URLScan.io API key.
//! To get an API key, create an URLScan.io account and then go to [Settings & API](https://urlscan.io/user/profile/) to get your API key.
//! 
//! ## Examples
//! Get your current quota with limits:
//! ```rust
//! // Imports
//! use urlscan::UrlScanClient;
//! 
//! // Create a URlScan Client with you API key
//! let client = UrlScanClient::new("YOUR-API-KEY-HERE");
//! 
//! // Get the current quota for your API key
//! let response = client.get_quota();
//! match response {
//!     Ok(quota) => println!("{}", quota),
//!     _ => println!("We got an error..."),
//! }
//! ```
//! 
//! ## URLScan.io Documentation
//! [URLScan.io API Documentation](https://urlscan.io/docs/api/)
//! 
#![warn(missing_docs)]

/// Public Module 'API' with submodules for 'quota', 'submission', and 'result'
pub mod api;
mod http;
mod error;

/// URLScanClient struct to hold information like API key, domain, and endpoint
#[derive(Clone)]
pub struct UrlScanClient {
    api_key: String,
    domain: String,
    endpoint: String,
}

impl UrlScanClient {
    pub fn new(api_key: &str) -> Self {
        //! Creates a new URLScan.io API client 
        //! 
        //! ## Example usage
        //! ```rust
        //! use urlscan::UrlScanClient;
        //! let urlscan_client = UrlScanClient::new("API_KEY");
        //! ```
        UrlScanClient {
            api_key: api_key.into(),
            domain: "https://urlscan.io/".into(),
            endpoint: "api/v1/".into()
        }
    }
}

#[cfg(test)]
mod tests {
    // use std::path::Path;
    use crate::UrlScanClient;

    static API_KEY: &str = "TODO";
    static UUID: &str = "20d16cb9-72f1-4139-bd67-130e0bc02da8"; // crates.io scan


    #[test]
    fn test_client() {
        let client = UrlScanClient::new(API_KEY);
        assert_eq!(client.domain, "https://urlscan.io/");
        assert_eq!(client.endpoint, "api/v1/");
    }

    #[test]
    fn test_dom() {
        let client = UrlScanClient::new(API_KEY);
        let response = client.get_dom(UUID);
        match response {
            Ok(dom) => println!("{}", dom),
            _ => println!("We got an error..."),
        }
    }

    #[test]
    fn test_result() {
        let client = UrlScanClient::new(API_KEY);
        let response = client.get_result(UUID);
        match response {
            Ok(result) => println!("{}", result),
            _ => println!("Something went wrong :("),
        }
    }

    #[test]
    fn test_screenshot() {
        let client: UrlScanClient = UrlScanClient::new(API_KEY);
        let response = client.get_screenshot(UUID);
        match response {
            Ok(result) => {
                println!("All good?");
                _ = client.save_screenshot(result, "../urlscan.png");
            },
            _ => println!("Didn't get the screenshot :("),
        }
    }
}