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

use rocket::get;
use rocket::response::status;
use rocket_contrib::json::{Json, JsonValue};
use serde_json::json;

use super::VideoBody;
use crate::persistance::db;
use crate::services::videos;
use crate::services::VideoServiceError::{
    NoSuchDisplay, NoSuchDisplayLocation, NoSuchOrder, NoSuchVideo, Other,
};

/**
* Registers a video view, granted the display_id, video_id, order_id, all exist.
* If all arguments are valid, a new played_advertisement row will be created in the database, and credits removed from the order_id.
* 1 credit will be withdrawn for each 8 seconds played.
* 
* Responds with:
* - 200: if the tracker and receiver exist.
* - 404: if either the receiver or tracker does not exist
*
* This is an API endpoint mapped to
* - /views/<display_id>/<video_id>/<order_id> [POST]
* 
* # Arguments
* ## url parameters:
* - `display_id` - the id of the display that played the video
* - `video_id` - the id of the played video 
* - `order_id` - the id of the order that ordered the video
* ## Post body (json):
*
* `{ length_sec: <integer_length_of_played_video>  }`
*  */
#[post("/views/<display_id>/<video_id>/<order_id>", data = "<body>")]
pub fn register_view( display_id: i32, video_id: i32, order_id: String, body: Json<VideoBody>) -> Result<JsonValue, status::BadRequest<JsonValue>> {
    //TODO: The number of registered people in at the location should affect number of credits
    match videos::register_video_view(display_id, video_id, &order_id, body.length_sec) {
        Err(NoSuchVideo) => Err(bad_request_builder(format!(
            "no video with id {} found",
            video_id
        ))),
        Err(NoSuchDisplay) => Err(bad_request_builder(format!(
            "no display with id {} found",
            display_id
        ))),
        Err(NoSuchOrder) => Err(bad_request_builder(format!(
            "no order with id {} found",
            order_id
        ))),
        Ok(_) => Ok(JsonValue(
            json!({"status": "success", "message": "video play logged"}),
        )),
        _ => Err(bad_request_builder(format!(
            "An unknown issue with the request"
        ))),
    }
}

/**
 * Utility function
 */
fn bad_request_builder(message: String) -> status::BadRequest<JsonValue> {
    status::BadRequest(Some(JsonValue(
        json!({"status":"error", "message": format!("{}", message)}),
    )))
}


/**
* Get the most appropriate video to play on the screen of specified id
* Appropriateness depends on the trackers currently registered to the reciver, and their interests
* 
* Appropriateness is calculated as follows:
*
* 1: Get all the videos that match the interest(s) present at the display location.
*
* 2: Filter the results based on which videos have credits left to use
*
* 3: Find the highest weighted interest in the filtered results
*
* 4: Filter away the videos which have other interest
*
* 5: Shuffle the results and return the first video in the shuffled list 
* 
* Responds with:
* ### 200: if the tracker and receiver exist.
* Response body:
*
* `{message: "video found", video :{"length": <video_length_seconds>, order: <associated_order>, url :<video_url>, <videoId>: <video_identifier>}}`
* 
* ### 404: if the display does not exist
*
*
* This is an API endpoint mapped to
* - /video/<display_id> [GET]
* 
* # Arguments
* ## url parameters:
* - `display_id` - the id of the display to get video for.
*  */
#[get("/video/<display_id>")]
pub fn get_video(display_id: i32) -> Result<JsonValue, Option<status::BadRequest<JsonValue>>> {
    match db::get_display_by_id(display_id) {
        Ok(None) => return Err(None),
        _ => (),
    };
    match videos::find_relevant_video(display_id) {
        Err(NoSuchDisplayLocation) => Err(Some(bad_request_builder(format!(
            "The display {} did not exist, or does not have a location set",
            display_id
        )))),
        Ok(Some(v)) => Ok(JsonValue(
            json!({"video": {"url": v.url, "length": v.length_sec, "order": v.order, "videoId": v.video_id}, "message": "video found"}),
        )),
        Ok(None) => Ok(JsonValue(
            json!({"video": null, "message": "no trackers registered to location" }),
        )),
        Err(Other) => Err(Some(bad_request_builder(format!(
            "un unknown issue with the request"
        )))),
        Err(e) => panic!("{:?} shouldn't happen here", e),
    }
}




/**************
 * Unit tests *
 **************/
#[cfg(test)]
mod tests {
    use mocktopus::mocking::*;
    use super::*;
    use crate::model::{ Display, AdvertVideoOrder };

    #[test]
    fn get_video_for_nonexistent_display_gives_404_unittest() {
        db::Dbconn::new.mock_safe(|| panic!(""));

        db::get_display_by_id.mock_safe(|param| {
            MockResult::Return(match param {
                1 => Ok(None),
                _ => panic!("wrong argument sent to get_display_by_id when asking for display 1"),
            })
        });
        assert_eq!(get_video(1), Err(None), "Getting video should give none when should get nonexistent")
    }
    
    #[test]
    fn get_video_for_display_no_tracker_at_tisplay_unittest() {
        db::Dbconn::new.mock_safe(|| panic!("TRIED TO CONNECT TO DB"));

        db::get_display_by_id.mock_safe(|param| {
            MockResult::Return(match param {
                1 => Ok(Some(Display {id: 1, location: 1})),
                _ => panic!("wrong argument sent to get_display_by_id when asking for display 1"),
            })
        });

        videos::find_relevant_video.mock_safe(|param| 
            MockResult::Return(match param {
                1 => Ok(None),
                _ => panic!("wrong argument sent to get_display_by_id when asking for display 1"),
            })
        );
        assert_eq!(
            get_video(1),
            Ok(JsonValue(json!({"video": null, "message": "no trackers registered to location" })))
            ,"Getting video should give none when should get nonexistent"
        )
    }
    
    #[test]
    fn get_video_for_display_that_has_trackers_unittest() {
        db::Dbconn::new.mock_safe(|| panic!(""));

        db::get_display_by_id.mock_safe(|param| {
            MockResult::Return(match param {
                1 => Ok(Some(Display {id: 1, location: 1})),
                _ => panic!("wrong argument sent to get_display_by_id when asking for display 1"),
            })
        });

        videos::find_relevant_video.mock_safe(|param| {
            MockResult::Return(match param {
                1 => Ok(Some(AdvertVideoOrder {
                    video_id: 1,
                    interest: 1,
                    url: "example.com/video".to_owned(), 
                    length_sec: 1,
                    order: "order_1".to_owned()
                })),
                _ => panic!("wrong argument sent to get_display_by_id when asking for display 1"),
            })
        });
        assert_eq!(
            get_video(1),
            Ok(JsonValue(
                json!(
                    {"video": 
                    {"url": "example.com/video", "length": 1, "order": "order_1", "videoId": 1}, "message": "video found"})))
            ,"Getting video should give none when should get nonexistent"
        )
    }

    #[test]
    pub fn register_view_when_nonexistent_video_unittest() {
        db::Dbconn::new.mock_safe(|| panic!("TRIED TO CONNECT TO DB"));
        videos::register_video_view.mock_safe(|_, _, _, _| {MockResult::Return(Err(NoSuchVideo))});

        let json_body: Json<VideoBody> = Json(VideoBody { length_sec: 1} );
        assert_eq!(register_view(1, 1,"order_id".to_owned(), json_body), Err(bad_request_builder("no video with id 1 found".to_owned())));
    }

    #[test]
    pub fn register_view_when_nonexistent_display_unittest() {
        db::Dbconn::new.mock_safe(|| panic!("TRIED TO CONNECT TO DB"));
        videos::register_video_view.mock_safe(|_, _, _, _| {MockResult::Return(Err(NoSuchDisplay))});

        let json_body: Json<VideoBody> = Json(VideoBody { length_sec: 1} );
        assert_eq!(register_view(1, 1,"order_id".to_owned(), json_body), Err(bad_request_builder("no display with id 1 found".to_owned())));
    }

    #[test]
    pub fn register_view_when_nonexistent_order_unittest() {
        db::Dbconn::new.mock_safe(|| panic!("TRIED TO CONNECT TO DB"));
        videos::register_video_view.mock_safe(|_, _, _, _| {MockResult::Return(Err(NoSuchOrder))});

        let json_body: Json<VideoBody> = Json(VideoBody { length_sec: 1} );
        assert_eq!(register_view(1, 1,"order_id".to_owned(), json_body), Err(bad_request_builder("no order with id order_id found".to_owned())));
    }
}