marketsurge-client 0.2.1

Unofficial HTTP client library for the MarketSurge platform
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

//! Navigation tree endpoints.

use serde::{Deserialize, Serialize};

use crate::client::Client;

// ---------------------------------------------------------------------------
// GraphQL query
// ---------------------------------------------------------------------------

const QUERY_NAV_TREE: &str = include_str!("graphql/nav_tree.graphql");

// ---------------------------------------------------------------------------
// Wire variable types (serialization only)
// ---------------------------------------------------------------------------

#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
struct NavTreeVariables {
    site: String,
    tree_type: String,
}

// ---------------------------------------------------------------------------
// Response types
// ---------------------------------------------------------------------------

/// Top-level response from the `NavTree` query.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct NavTreeResponse {
    /// User-scoped navigation tree data.
    pub user: Option<NavTreeUser>,
}

/// User-scoped navigation tree.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct NavTreeUser {
    /// Navigation tree nodes.
    #[serde(default)]
    pub nav_tree: Vec<NavTreeNode>,
}

/// A node in the navigation tree.
pub type NavTreeNode = crate::types::TreeNode;

/// A child node summary within a navigation tree folder.
pub type NavTreeChildNode = crate::types::TreeChildNode;

// ---------------------------------------------------------------------------
// Client methods
// ---------------------------------------------------------------------------

impl Client {
    /// Fetches the full navigation tree for the authenticated user.
    ///
    /// # Errors
    ///
    /// Returns an error if the GraphQL request fails or the response
    /// cannot be deserialized.
    pub async fn nav_tree(
        &self,
        site: &str,
        tree_type: &str,
    ) -> crate::error::Result<NavTreeResponse> {
        let variables = NavTreeVariables {
            site: site.to_string(),
            tree_type: tree_type.to_string(),
        };

        self.graphql_operation("NavTree", variables, QUERY_NAV_TREE)
            .await
    }
}

#[cfg(test)]
mod tests {
    use crate::test_support::mock_test;

    #[tokio::test]
    async fn nav_tree_parses_response() {
        let (_server, client, mock) = mock_test("NavTree").await;

        let resp = client
            .nav_tree("marketsurge", "MSR_NAV")
            .await
            .expect("nav_tree should succeed");

        let user = resp.user.as_ref().expect("user");
        assert_eq!(user.nav_tree.len(), 3);

        // Folder node
        let folder = &user.nav_tree[0];
        assert_eq!(folder.id.as_deref(), Some("folder-reports"));
        assert_eq!(folder.name.as_deref(), Some("My Reports"));
        assert_eq!(folder.node_type.as_deref(), Some("SYSTEM_FOLDER"));
        assert_eq!(folder.content_type.as_deref(), Some("REPORTS"));
        assert_eq!(folder.children.len(), 2);
        assert_eq!(folder.children[0].id.as_deref(), Some("report-120"));
        assert_eq!(
            folder.children[0].name.as_deref(),
            Some("Minervini Trend - 5 Months")
        );

        // Leaf node with JSON reference_id
        let report = &user.nav_tree[1];
        assert_eq!(report.id.as_deref(), Some("report-120"));
        assert_eq!(report.node_type.as_deref(), Some("REPORTS_SCREEN"));
        assert_eq!(report.url.as_deref(), Some("/report/minervini-5m"));
        assert_eq!(
            report.reference_id.as_deref(),
            Some(r#"{"originalId":120,"isCoachAccount":false}"#)
        );

        // Screen leaf
        let screen = &user.nav_tree[2];
        assert_eq!(screen.id.as_deref(), Some("leaf-screen-1"));
        assert_eq!(screen.name.as_deref(), Some("My Growth Screen"));
        assert_eq!(screen.node_type.as_deref(), Some("STOCK_SCREEN"));

        mock.assert();
    }

    #[cfg(not(coverage))]
    #[tokio::test]
    #[ignore]
    async fn integration_nav_tree() {
        let client = crate::test_support::live_client().await;
        let resp = client
            .nav_tree("marketsurge", "MSR_NAV")
            .await
            .expect("live nav_tree should succeed");

        assert!(resp.user.is_some());
    }
}