ezcapsolver-rs 0.1.0

Rust SDK for EzCaptchaSolver.
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
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

use serde::Serialize;

use super::ExtraFields;

/// Invisible mode the service assumes for V3 when the parameter is omitted.
///
/// V2 defaults to `false`, which is the Rust default for `bool`; V3 does not,
/// so this value has to be stated in both the builder and `Default`.
const V3_DEFAULT_IS_INVISIBLE: bool = true;

/// Grid size the service assumes when the parameter is omitted.
const DEFAULT_CLASSIFICATION_SIZE: i32 = 4;

/// Request parameters shared by ReCaptcha V2 task variants.
///
/// Build with string literals or owned strings; optional setters wrap values
/// in `Some`, while `maybe_*` setters accept an `Option` directly.
///
/// ```
/// use ezcapsolver::RecaptchaV2Task;
///
/// let task = RecaptchaV2Task::builder()
///     .website_url("https://example.com")
///     .website_key("site-key")
///     .s("challenge-data")
///     .build();
/// assert_eq!(task.s.as_deref(), Some("challenge-data"));
/// assert!(!task.is_invisible);
/// ```
///
/// Required fields must be set before calling `build()`.
///
/// ```compile_fail
/// use ezcapsolver::RecaptchaV2Task;
///
/// let task = RecaptchaV2Task::builder()
///     .website_url("https://example.com")
///     .build();
/// ```
#[derive(Debug, Clone, Serialize, Default, bon::Builder)]
#[builder(on(String, into))]
#[serde(remote = "Self", rename_all = "camelCase")]
pub struct RecaptchaV2Task {
    /// URL of the page containing the challenge.
    #[serde(rename = "websiteURL")]
    pub website_url: String,
    /// ReCaptcha site key.
    pub website_key: String,
    /// Whether the challenge uses invisible mode.
    #[serde(rename = "isInvisible")]
    #[builder(default)]
    pub is_invisible: bool,
    /// Optional security anchor parameter.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sa: Option<String>,
    /// Optional challenge-bound `s` parameter.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub s: Option<String>,
    /// Optional page title.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub website_title: Option<String>,
    /// Optional proxy forwarded to the worker.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub proxy: Option<String>,
    /// Additional worker parameters.
    #[serde(skip)]
    #[builder(default)]
    pub extra: ExtraFields,
}

/// Request parameters shared by ReCaptcha V3 task variants.
#[derive(Debug, Clone, Serialize, bon::Builder)]
#[builder(on(String, into))]
#[serde(remote = "Self", rename_all = "camelCase")]
pub struct RecaptchaV3Task {
    /// URL of the page containing the challenge.
    #[serde(rename = "websiteURL")]
    pub website_url: String,
    /// ReCaptcha site key.
    pub website_key: String,
    /// Whether the challenge uses invisible mode.
    #[serde(rename = "isInvisible")]
    #[builder(default = V3_DEFAULT_IS_INVISIBLE)]
    pub is_invisible: bool,
    /// Optional action configured by the protected page.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_action: Option<String>,
    /// Optional page title.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub website_title: Option<String>,
    /// Optional website-specific check field.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub check_field: Option<String>,
    /// Optional proxy forwarded to the worker.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub proxy: Option<String>,
    /// Additional worker parameters.
    #[serde(skip)]
    #[builder(default)]
    pub extra: ExtraFields,
}

impl Default for RecaptchaV3Task {
    fn default() -> Self {
        Self {
            website_url: String::new(),
            website_key: String::new(),
            is_invisible: V3_DEFAULT_IS_INVISIBLE,
            page_action: None,
            website_title: None,
            check_field: None,
            proxy: None,
            extra: ExtraFields::new(),
        }
    }
}

/// ReCaptcha V2 image classification request.
#[derive(Debug, Clone, Serialize, bon::Builder)]
#[builder(on(String, into))]
#[serde(remote = "Self", rename_all = "camelCase")]
pub struct RecaptchaV2ClassificationTask {
    /// Base64-encoded challenge image.
    pub image: String,
    /// Object identifier or classification question.
    pub question: String,
    /// Grid size documented by the service.
    #[builder(default = DEFAULT_CLASSIFICATION_SIZE)]
    pub size: i32,
    /// Additional worker parameters.
    #[serde(skip)]
    #[builder(default)]
    pub extra: ExtraFields,
}

impl Default for RecaptchaV2ClassificationTask {
    fn default() -> Self {
        Self {
            image: String::new(),
            question: String::new(),
            size: DEFAULT_CLASSIFICATION_SIZE,
            extra: ExtraFields::new(),
        }
    }
}