1
=== modified file 'src/Makefile.am'
2
--- src/Makefile.am	2013-12-18 19:19:12 +0000
3
+++ src/Makefile.am	2014-01-09 13:55:57 +0000
4
@@ -44,7 +44,8 @@
5
44
	click-interface.vala \
44
	click-interface.vala \
6
45
	ubuntuone-credentials.vala \
45
	ubuntuone-credentials.vala \
7
46
	non-click-scope.vala \
46
	non-click-scope.vala \
9
47
	utils.vala
47
	utils.vala \
10
48
	rnrclient.vala
11
48
49
12
49
config.vala: config.vala.in
50
config.vala: config.vala.in
13
50
	sed -e "s|\@DATADIR\@|${datadir}|g" \
51
	sed -e "s|\@DATADIR\@|${datadir}|g" \
14
51
52
15
=== modified file 'src/click-scope.vala'
16
--- src/click-scope.vala	2013-12-24 00:33:07 +0000
17
+++ src/click-scope.vala	2014-01-09 13:55:57 +0000
18
@@ -82,6 +82,7 @@
19
82
  public ClickInterface click_if = new ClickInterface ();
82
  public ClickInterface click_if = new ClickInterface ();
20
83
  public UbuntuoneCredentials u1creds = new UbuntuoneCredentials ();
83
  public UbuntuoneCredentials u1creds = new UbuntuoneCredentials ();
21
84
  public ClickWebservice webservice = new ClickWebservice ();
84
  public ClickWebservice webservice = new ClickWebservice ();
22
85
  RNRClient rnrClient = new RNRClient();
23
85
86
24
86
  public ClickScope ()
87
  public ClickScope ()
25
87
  {
88
  {
26
@@ -123,7 +124,12 @@
27
123
        preview.add_info(new Unity.InfoHint.with_variant(HINT_PUBLISHER, "Publisher", null, new Variant.string(details.publisher)));
124
        preview.add_info(new Unity.InfoHint.with_variant(HINT_PUBLISHER, "Publisher", null, new Variant.string(details.publisher)));
28
124
        preview.add_info(new Unity.InfoHint.with_variant(HINT_SCREENSHOTS, LABEL_SCREENSHOTS, null, new Variant.strv(details.more_screenshot_urls)));
125
        preview.add_info(new Unity.InfoHint.with_variant(HINT_SCREENSHOTS, LABEL_SCREENSHOTS, null, new Variant.strv(details.more_screenshot_urls)));
29
125
        preview.add_info(new Unity.InfoHint.with_variant(HINT_KEYWORDS, LABEL_KEYWORDS, null, new Variant.strv(details.keywords)));
126
        preview.add_info(new Unity.InfoHint.with_variant(HINT_KEYWORDS, LABEL_KEYWORDS, null, new Variant.strv(details.keywords)));
31
126
        // TODO: get the proper ratings and reviews from the rnr web service
127
        // get the proper ratings and reviews from the rnr web service
32
128
        var reviews = yield rnrClient.get_reviews(details);
33
129
        if (reviews != null) {
34
130
            preview.add_info(new Unity.InfoHint.with_variant(HINT_REVIEWS, LABEL_REVIEWS, null, reviews));
35
131
            debug("Got %d reviews for %s", (int)reviews.n_children(), details.package_name);
36
132
        }
37
127
        return preview;
133
        return preview;
38
128
    } catch (WebserviceError e) {
134
    } catch (WebserviceError e) {
39
129
        debug ("Error calling webservice: %s", e.message);
135
        debug ("Error calling webservice: %s", e.message);
40
130
136
41
=== modified file 'src/click-webservice.vala'
42
--- src/click-webservice.vala	2013-12-19 18:19:27 +0000
43
+++ src/click-webservice.vala	2014-01-09 13:55:57 +0000
44
@@ -32,6 +32,8 @@
45
32
const string JSON_FIELD_SCREENSHOT_URLS = "screenshot_urls";
32
const string JSON_FIELD_SCREENSHOT_URLS = "screenshot_urls";
46
33
const string JSON_FIELD_DESCRIPTION = "description";
33
const string JSON_FIELD_DESCRIPTION = "description";
47
34
const string JSON_FIELD_KEYWORDS = "keywords";
34
const string JSON_FIELD_KEYWORDS = "keywords";
48
35
const string JSON_FIELD_VERSION = "version";
49
36
const string JSON_FIELD_FRAMEWORK = "framework";
50
35
37
51
36
// The size of the cache for click app data
38
// The size of the cache for click app data
52
37
// == SIZE_IN_MB * 1024 * 1024
39
// == SIZE_IN_MB * 1024 * 1024
53
@@ -117,6 +119,8 @@
54
117
    public string main_screenshot_url { get; construct; }
119
    public string main_screenshot_url { get; construct; }
55
118
    public string[] more_screenshot_urls { get; construct; }
120
    public string[] more_screenshot_urls { get; construct; }
56
119
    public uint64 binary_filesize { get; construct; }
121
    public uint64 binary_filesize { get; construct; }
57
122
    public string version { get; construct; }
58
123
    public string[] framework { get; construct; }
59
120
124
60
121
125
61
122
    /* TODO: use RnR webservice
126
    /* TODO: use RnR webservice
62
@@ -164,7 +168,9 @@
63
164
168
64
165
            title: details.get_string_member(JSON_FIELD_TITLE),
169
            title: details.get_string_member(JSON_FIELD_TITLE),
65
166
            description: details.get_string_member(JSON_FIELD_DESCRIPTION),
170
            description: details.get_string_member(JSON_FIELD_DESCRIPTION),
67
167
            keywords: parse_string_list (details, JSON_FIELD_KEYWORDS)
171
            keywords: parse_string_list (details, JSON_FIELD_KEYWORDS),
68
172
            version: details.get_string_member(JSON_FIELD_VERSION),
69
173
            framework: parse_string_list (details, JSON_FIELD_FRAMEWORK)
70
168
        );
174
        );
71
169
    }
175
    }
72
170
}
176
}
73
171
177
74
=== modified file 'src/fake-data.vala'
75
--- src/fake-data.vala	2013-08-08 19:25:09 +0000
76
+++ src/fake-data.vala	2014-01-09 13:55:57 +0000
77
@@ -88,3 +88,46 @@
78
88
    }
88
    }
79
89
]
89
]
80
90
""";
90
""";
81
91
82
92
const string FAKE_RNR_REVIEW_RESULTS = """
83
93
[
84
94
    {
85
95
         "origin": "canonical",
86
96
         "rating": 1,
87
97
         "hide": false,
88
98
         "app_name": "",
89
99
         "language": "en",
90
100
         "reviewer_username": "gbtest",
91
101
         "usefulness_total": 31,
92
102
         "usefulness_favorable": 30,
93
103
         "review_text": "Cause system hangs a lot",
94
104
         "date_deleted": null,
95
105
         "summary": "poor linux version",
96
106
         "version": "4.2.0.11-0ubuntu0.12.04.2",
97
107
         "id": 7678621,
98
108
         "date_created": "2013-08-11 13:23:13",
99
109
         "reviewer_displayname": "Brian Test",
100
110
         "package_name": "skyter",
101
111
         "distroseries": "precise"
102
112
    },
103
113
    {
104
114
         "origin": "canonical",
105
115
         "rating": 4,
106
116
         "hide": false,
107
117
         "app_name": "",
108
118
         "language": "en",
109
119
         "reviewer_username": "user3844",
110
120
         "usefulness_total": 6,
111
121
         "usefulness_favorable": 6,
112
122
         "review_text": "Great app versions",
113
123
         "date_deleted": null,
114
124
         "summary": "works stable, but has a bad interface",
115
125
         "version": "4.2.0.11-0ubuntu0.12.04.2",
116
126
         "id": 78054,
117
127
         "date_created": "2013-09-09 18:59:20",
118
128
         "reviewer_displayname": "Oron Pista",
119
129
         "package_name": "skyter",
120
130
         "distroseries": "raring"
121
131
    }
122
132
]
123
133
""";
124
91
134
125
=== added file 'src/rnrclient.vala'
126
--- src/rnrclient.vala	1970-01-01 00:00:00 +0000
127
+++ src/rnrclient.vala	2014-01-09 13:55:57 +0000
128
@@ -0,0 +1,201 @@
129
1
/* -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
130
2
/*
131
3
 * Copyright (C) 2013-2014 Canonical, Ltd.
132
4
 *
133
5
 * This program is free software; you can redistribute it and/or modify
134
6
 * it under the terms of the GNU General Public License as published by
135
7
 * the Free Software Foundation; version 3.
136
8
 *
137
9
 * This program is distributed in the hope that it will be useful,
138
10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
139
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
140
12
 * GNU General Public License for more details.
141
13
 *
142
14
 * You should have received a copy of the GNU General Public License
143
15
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
144
16
 */
145
17
146
18
using Json;
147
19
148
20
/**
149
21
 * RNRClient:
150
22
 *
151
23
 * Client for the ratings and reviews server.
152
24
 * It is able to change the server address by setting the environment
153
25
 * variable "U1_REVIEWS_BASE_URL".
154
26
 * 
155
27
 */ 
156
28
public class RNRClient : GLib.Object
157
29
{
158
30
    UbuntuoneCredentials u1creds;
159
31
    const string CONSUMER_KEY = "consumer_key";
160
32
    const string CONSUMER_SECRET = "consumer_secret";
161
33
    const string TOKEN = "token";
162
34
    const string TOKEN_SECRET = "token_secret";
163
35
    const string REVIEWS_BASE_URL = "https://reviews.ubuntu.com/reviews";
164
36
165
37
    internal Soup.SessionAsync http_session;
166
38
167
39
    construct {
168
40
        http_session = WebClient.get_webclient();
169
41
        u1creds = new UbuntuoneCredentials ();
170
42
    }
171
43
172
44
    public string from_environ (string env_name, string default_value) {
173
45
        string env_value = Environment.get_variable (env_name);
174
46
        return env_value != null ? env_value : default_value;
175
47
    }
176
48
177
49
    public string get_base_url () {
178
50
        return from_environ ("U1_REVIEWS_BASE_URL", REVIEWS_BASE_URL);
179
51
    }
180
52
181
53
    public string get_review_url() {
182
54
        /* /api/1.0/reviews/filter/{LANGUAGE}/{ORIGIN}/{DISTROSERIES}/{VERSION}/{PACKAGENAME}/ */
183
55
        return get_base_url() + "/api/1.0/reviews/filter/%s/%s/%s/%s/%s/";
184
56
    }
185
57
186
58
    /**
187
59
     * get_reviews:
188
60
     * @details: the AppDetails describe the details.
189
61
     *
190
62
     * The function returns all the reviews based on the application
191
63
     * details. It only returns the reviews that matches the system
192
64
     * language.
193
65
     *
194
66
     * Returns: A Variant (list of dictionary) that containts the reviews.
195
67
     *
196
68
     */
197
69
    public async Variant? get_reviews(AppDetails details) {
198
70
        string[] languages = GLib.Intl.get_language_names();
199
71
        string? language = null;
200
72
        if (languages.length > 0) {
201
73
            language = languages[0];
202
74
        }
203
75
        var filter = new ReviewFilter();
204
76
        filter.language = language;
205
77
        filter.packagename = details.package_name;
206
78
        filter.origin = filter.packagename;
207
79
        filter.version = details.version;
208
80
        filter.distroseries = "click";
209
81
        return yield get_reviews_by_filter(filter);
210
82
    }
211
83
212
84
    /**
213
85
     * get_reviews_by_filter:
214
86
     * @filter: the filter for reviews.
215
87
     *
216
88
     * The function returns all the reviews based on the filter.
217
89
     *
218
90
     * Returns: A Variant (list of dictionary) that containts the reviews.
219
91
     *
220
92
     */
221
93
    public async Variant? get_reviews_by_filter(ReviewFilter filter) {
222
94
        Variant? ret = null;
223
95
        WebserviceError failure = null;
224
96
225
97
        if (filter.language == "" || filter.language == "any"
226
98
            || filter.origin == "" || filter.origin == "any"
227
99
            || filter.distroseries == "" || filter.distroseries == "any"
228
100
            || filter.version == "" || filter.version == "any"
229
101
            || filter.packagename == "") {
230
102
            debug("filter is not filled");
231
103
            return ret;
232
104
        }
233
105
234
106
        string url = get_review_url().printf(filter.language,
235
107
                                             filter.origin,
236
108
                                             filter.distroseries,
237
109
                                             filter.version,
238
110
                                             filter.packagename);
239
111
        string response="";
240
112
241
113
        var message = new Soup.Message ("GET", url);
242
114
        http_session.queue_message(message, (http_session, message) => {
243
115
            if (message.status_code != Soup.KnownStatusCode.OK) {
244
116
                var msg = "Web request failed: HTTP %u %s".printf(
245
117
                       message.status_code, message.reason_phrase);
246
118
                failure = new WebserviceError.HTTP_ERROR(msg);
247
119
            } else {
248
120
                message.response_body.flatten ();
249
121
                response = (string) message.response_body.data;
250
122
                debug ("response is %s", response);
251
123
            }
252
124
            get_reviews_by_filter.callback();
253
125
        });
254
126
        yield;
255
127
        if (failure != null) {
256
128
            debug("cannot get reviews error %s", failure.message);
257
129
            return ret;
258
130
        }
259
131
        var parser = new Json.Parser();
260
132
        try {
261
133
            parser.load_from_data(response);
262
134
        } catch (GLib.Error e) {
263
135
            debug ("parse reviews response error %s", e.message);
264
136
            return ret;
265
137
        }
266
138
267
139
        ret = convertJSONtoVariant(parser);
268
140
        return ret;
269
141
    }
270
142
271
143
    public Variant? convertJSONtoVariant(Json.Parser parser) {
272
144
        Variant? ret = null;
273
145
        var root_object = parser.get_root();
274
146
        var builder = new VariantBuilder(new VariantType("av"));
275
147
276
148
        foreach (var node in root_object.get_array().get_elements()) {
277
149
            var ht = new VariantBuilder(new VariantType("a{sv}"));
278
150
            var node_object = node.get_object();
279
151
            foreach (var node_member in node_object.get_members()) {
280
152
                Variant? gvar_member = null;
281
153
                try {
282
154
                    gvar_member = Json.gvariant_deserialize(node_object.get_member(node_member), null);
283
155
                } catch (GLib.Error e) {
284
156
                    debug ("gvariant deserialize error: %s",e.message);
285
157
                    continue;
286
158
                }
287
159
                if (gvar_member == null) {
288
160
                    continue;
289
161
                }
290
162
                if (gvar_member.is_of_type(VariantType.MAYBE) && gvar_member.get_maybe() == null) {
291
163
                    continue;
292
164
                }
293
165
                ht.add("{sv}", node_member, gvar_member);
294
166
            }
295
167
            Variant dict = ht.end();
296
168
            builder.add("v", dict);
297
169
        }
298
170
299
171
        ret = builder.end();
300
172
        return ret;
301
173
    }
302
174
}
303
175
304
176
/**
305
177
 * ReviewFilter:
306
178
 * @packagename: the name of package. Required.
307
179
 * @language: the language string. Eg: en zh ... The default value "any" to
308
180
 *            get reviews for any languages
309
181
 * @origin: Normally comes from "ubuntu". For click packages it should be
310
182
 *          as same as packagename.
311
183
 *          The default value "any" to get reviews for any origin.
312
184
 * @distroseries: For example, "natty", "saucy". The default value "any" to 
313
185
 *                get any distroseries.
314
186
 * @version: The version of the software. Default value "any" means to get
315
187
 *           all versions from the server.
316
188
 *
317
189
 * ReviewFilter is the class used to pass the reviews filter to the server
318
190
 * API to get the reviews. The server contains many reviews with different 
319
191
 * languages, different versions, etc. We should use the filter to get the
320
192
 * reviews we want.
321
193
 * 
322
194
 */ 
323
195
public class ReviewFilter : GLib.Object {
324
196
    public string packagename = "";
325
197
    public string language = "any";
326
198
    public string origin = "any";
327
199
    public string distroseries = "any";
328
200
    public string version = "any";
329
201
}
330
0
202
331
=== modified file 'src/test-click-webservice.vala'
332
--- src/test-click-webservice.vala	2013-12-24 00:33:07 +0000
333
+++ src/test-click-webservice.vala	2014-01-09 13:55:57 +0000
334
@@ -601,6 +601,50 @@
335
601
        assert (scope.build_installed_called == (!is_installable && !finds_progress));
601
        assert (scope.build_installed_called == (!is_installable && !finds_progress));
336
602
    }
602
    }
337
603
603
338
604
    public static void test_rnrclient_json_to_variant() {
339
605
        RNRClient rnrClient = new RNRClient();
340
606
        var testData1 = FAKE_RNR_REVIEW_RESULTS;
341
607
        Json.Parser parser = new Json.Parser();
342
608
        try {
343
609
            parser.load_from_data(testData1);
344
610
        } catch (GLib.Error e) {
345
611
        }
346
612
        Variant testVariant = rnrClient.convertJSONtoVariant(parser);
347
613
348
614
        assert_cmpint ((int)testVariant.n_children(), OperatorType.EQUAL, 2);
349
615
    }
350
616
351
617
    public static void test_rnrclient_bad_filter() {
352
618
        MainLoop mainloop = new MainLoop ();
353
619
        RNRClient rnrClient = new RNRClient();
354
620
355
621
        ReviewFilter filter = new ReviewFilter();
356
622
        filter.version = "any";
357
623
        Variant? testData1 = null;
358
624
        rnrClient.get_reviews_by_filter.begin(filter, (obj, res) => {
359
625
            mainloop.quit();
360
626
            testData1 = rnrClient.get_reviews_by_filter.end (res);
361
627
        });
362
628
        assert (run_with_timeout (mainloop, 10000));
363
629
        assert (testData1 == null);
364
630
    }
365
631
366
632
    public static void test_rnrclient_from_environ() {
367
633
        RNRClient rnrClient = new RNRClient();
368
634
369
635
        string testEnv = "TEST_RNRCLIENT_FROM_ENVIRON_S";
370
636
        string defaultValue = "default";
371
637
        string nonDefaultValue = "nondefault";
372
638
373
639
        Environment.set_variable(testEnv, nonDefaultValue, true);
374
640
        string test1 = rnrClient.from_environ(testEnv, defaultValue);
375
641
        Environment.unset_variable(testEnv);
376
642
        string test2 = rnrClient.from_environ(testEnv, defaultValue);
377
643
378
644
        assert_cmpstr (test1, OperatorType.EQUAL, nonDefaultValue);
379
645
        assert_cmpstr (test2, OperatorType.EQUAL, defaultValue);
380
646
    }
381
647
382
604
    public static int main (string[] args)
648
    public static int main (string[] args)
383
605
    {
649
    {
384
606
        Test.init (ref args);
650
        Test.init (ref args);
385
@@ -631,6 +675,9 @@
386
631
                            test_scope_build_default_preview_finds_progress_is_installable);
675
                            test_scope_build_default_preview_finds_progress_is_installable);
387
632
        Test.add_data_func ("/Unit/ClickChecker/Test_Scope_Build_Default_Preview_Finds_Progress_Not_Installable",
676
        Test.add_data_func ("/Unit/ClickChecker/Test_Scope_Build_Default_Preview_Finds_Progress_Not_Installable",
388
633
                            test_scope_build_default_preview_finds_progress_not_installable);
677
                            test_scope_build_default_preview_finds_progress_not_installable);
389
678
        Test.add_data_func ("/Unit/ClickChecker/Test_RNRClient_JSON_to_Variant", test_rnrclient_json_to_variant);
390
679
        Test.add_data_func ("/Unit/ClickChecker/Test_RNRClient_Bad_Filter", test_rnrclient_bad_filter);
391
680
        Test.add_data_func ("/Unit/ClickChecker/Test_RNRClient_From_Environ", test_rnrclient_from_environ);
392
634
        return Test.run ();
681
        return Test.run ();
393
635
    }
682
    }
394
636
}
683
}
Status:	Merged
Approved by:	dobey on 2014-01-13
Approved revision:	105
Merged at revision:	104
Proposed branch:	lp:~paulliu/unity-scope-click/showratings
Merge into:	lp:unity-scope-click
Diff against target:	394 lines (+307/-3) 6 files modified src/Makefile.am (+2/-1) src/click-scope.vala (+7/-1) src/click-webservice.vala (+7/-1) src/fake-data.vala (+43/-0) src/rnrclient.vala (+201/-0) src/test-click-webservice.vala (+47/-0)
To merge this branch:	bzr merge lp:~paulliu/unity-scope-click/showratings
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
PS Jenkins bot	continuous-integration	2013-12-12	Approve on 2014-01-13
dobey (community)			Approve on 2014-01-13
Manuel de la Peña (community)		2013-12-12	Approve on 2013-12-19
Review via email: mp+198762@code.launchpad.net