Merge lp:~mikemc/unity-scope-click/handle_ACTION_BUY into lp:unity-scope-click

[Mike McCracken]

- Generate app preview for purchasing in response to a buy action. Handle purchase succeeded/failed.

- Generate app preview for purchasing in response to a buy action. Handle purchase succeeded/failed.

Uses two new info hints for the app preview, 'show_purchase_overlay' and 'package_name'.

Handles purchase success action by returning the installing preview, just as in ACTION_INSTALL_CLICK in the free case.

Handles failure by returning the uninstalled preview again.

Many changes in this branch are to allow us to write tests for click-scope.vala, including the Makefile.am changes and moving 'main' code out of click-scope.vala and into click-scope-main.vala.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:88
http://jenkins.qa.ubuntu.com/job/unity-scope-click-ci/114/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-click-trusty-amd64-ci/12
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-click-trusty-armhf-ci/12

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scope-click-ci/114/rebuild

review: Approve (continuous-integration)

[dobey (dobey)]

+ error ("Can't build purchasing preview: %s", e.message);

Though this is only in the tests, the language of using "can't" in a program just seems weird to me. Perhapps it should be "Unable to" instead.

[dobey (dobey)]

353 + Test.add_data_func ("/Unit/ClickChecker/Test_Scope_Build_Purchasing_Preview",
354 + test_scope_build_purchasing_preview);

Alignment of the second argument here is a bit off.

[dobey (dobey)]

review: Needs Fixing

[lp:~mikemc/unity-scope-click/handle_ACTION_BUY]

89. By Mike McCracken on 2013-12-06

Wording and tab/space alignment change.

[dobey (dobey)]

review: Approve

[Alejandro J. Cura (alecu)]

Looks very good

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:89
http://jenkins.qa.ubuntu.com/job/unity-scope-click-ci/115/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-click-trusty-amd64-ci/13
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-click-trusty-armhf-ci/13

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scope-click-ci/115/rebuild

review: Approve (continuous-integration)

=== modified file 'src/Makefile.am'
--- src/Makefile.am	2013-12-04 13:02:49 +0000
+++ src/Makefile.am	2013-12-06 15:26:20 +0000
@@ -50,6 +50,7 @@
 click_scope_VALASOURCES = \
   config.vala \
   click-scope.vala \
+  click-scope-main.vala \
   click-webservice.vala \
   fake-data.vala \
   download-manager.vala \
@@ -66,6 +67,7 @@
 test_click_scope_CPPFLAGS = \
   -DDATADIR=\"$(DATADIR)\" \
   -DPKGDATADIR=\"$(PKGDATADIR)\" \
+  -DGETTEXT_PACKAGE=\"$(GETTEXT_PACKAGE)\" \
   -DG_LOG_DOMAIN=\"unity-scope-click\" \
   $(SCOPE_DAEMON_CFLAGS) \
   $(MAINTAINER_CFLAGS) \
@@ -76,6 +78,7 @@
   -C \
   --save-temps \
   --pkg unity \
+  --pkg unity-protocol \
   --pkg gee-1.0 \
   --pkg gio-unix-2.0 \
   --pkg json-glib-1.0 \
@@ -93,12 +96,16 @@
   $(NULL)
 
 test_click_scope_VALASOURCES = \
+  config.vala \
   test-click-webservice.vala \
   click-webservice.vala \
   fake-data.vala \
   download-manager.vala \
   click-interface.vala \
   ubuntuone-credentials.vala \
+  click-scope.vala \
+  non-click-scope.vala \
+  utils.vala \
   $(NULL)
 
 test_click_scope_SOURCES = \

=== added file 'src/click-scope-main.vala'
--- src/click-scope-main.vala	1970-01-01 00:00:00 +0000
+++ src/click-scope-main.vala	2013-12-06 15:26:20 +0000
@@ -0,0 +1,85 @@
+/*
+ * Copyright (C) 2013 Canonical, Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+
+/* The GIO File for logging to. */
+static File log_file = null;
+
+/* Method to convert the log level name to a string */
+static string _level_string (LogLevelFlags level)
+{
+	switch (level & LogLevelFlags.LEVEL_MASK) {
+	case LogLevelFlags.LEVEL_ERROR:
+		return "ERROR";
+	case LogLevelFlags.LEVEL_CRITICAL:
+		return "CRITICAL";
+	case LogLevelFlags.LEVEL_WARNING:
+		return "WARNING";
+	case LogLevelFlags.LEVEL_MESSAGE:
+		return "MESSAGE";
+	case LogLevelFlags.LEVEL_INFO:
+		return "INFO";
+	case LogLevelFlags.LEVEL_DEBUG:
+		return "DEBUG";
+	}
+	return "UNKNOWN";
+}
+
+static void ClickScopeLogHandler (string ? domain,
+								  LogLevelFlags level,
+								  string message)
+{
+	Log.default_handler (domain, level, message);
+
+    try {
+        var log_stream = log_file.append_to (FileCreateFlags.NONE);
+
+        if (log_stream != null) {
+            string log_message = "[%s] - %s: %s\n".printf(
+                domain, _level_string (level), message);
+            log_stream.write (log_message.data);
+            log_stream.flush ();
+            log_stream.close ();
+        }
+    } catch (GLib.Error e) {
+        // ignore all errors when trying to log to disk
+    }
+}
+
+int main ()
+{
+    var scope = new ClickScope();
+    var exporter = new Unity.ScopeDBusConnector (scope);
+    var exporter2 = new Unity.ScopeDBusConnector (new NonClickScope ());
+	var cache_dir = Environment.get_user_cache_dir ();
+	if (FileUtils.test (cache_dir, FileTest.EXISTS | FileTest.IS_DIR)) {
+			var log_path = Path.build_filename (cache_dir,
+												"unity-scope-click.log");
+			log_file = File.new_for_path (log_path);
+			Log.set_handler ("unity-scope-click", LogLevelFlags.LEVEL_MASK,
+							 ClickScopeLogHandler);
+	}
+
+    try {
+        exporter.export ();
+        exporter2.export ();
+    } catch (GLib.Error e) {
+        error ("Cannot export scope to DBus: %s", e.message);
+    }
+    Unity.ScopeDBusConnector.run ();
+
+    return 0;
+}

=== modified file 'src/click-scope.vala'
--- src/click-scope.vala	2013-12-06 13:20:17 +0000
+++ src/click-scope.vala	2013-12-06 15:26:20 +0000
@@ -18,6 +18,8 @@
 private const string ACTION_BUY_CLICK = "buy_click";
 private const string ACTION_DOWNLOAD_COMPLETED = "download_completed";
 private const string ACTION_DOWNLOAD_FAILED = "download_failed";
+private const string ACTION_PURCHASE_SUCCEEDED = "purchase_succeeded";
+private const string ACTION_PURCHASE_FAILED = "purchase_failed";
 private const string ACTION_OPEN_CLICK = "open_click";
 private const string ACTION_PIN_TO_LAUNCHER = "pin_to_launcher";
 private const string ACTION_UNINSTALL_CLICK = "uninstall_click";
@@ -166,6 +168,21 @@
         return preview;
     }
 
+    internal async Unity.Preview build_purchasing_preview (Unity.ScopeResult result) {
+        Unity.Preview preview = yield build_app_preview (result);
+        var app_id = result.metadata.get(METADATA_APP_ID).get_string();
+
+        // When the purchase overlay is shown by the preview in the dash no buttons should be shown.
+        // The two following actions (marked with ***) are not shown as buttons, but instead are triggered by the dash
+        // when the purchase service succeeds or fails.
+        preview.add_action (new Unity.PreviewAction (ACTION_PURCHASE_SUCCEEDED, ("*** purchase_succeeded"), null));
+        preview.add_action (new Unity.PreviewAction (ACTION_PURCHASE_FAILED, ("*** purchase_failed"), null));
+
+        preview.add_info(new Unity.InfoHint.with_variant("show_purchase_overlay", "Show Purchase Overlay", null, new Variant.boolean(true)));
+        preview.add_info(new Unity.InfoHint.with_variant("package_name", "Package Name", null, new Variant.string(app_id)));
+        return preview;
+    }
+
     internal async Unity.Preview build_default_preview (Unity.ScopeResult result) {
         if (uri_is_click_install(result.uri)) {
             return yield build_uninstalled_preview (result);
@@ -188,9 +205,11 @@
                     debug ("Let the dash launch the app: %s", result.uri);
                     return new Unity.ActivationResponse(Unity.HandledType.NOT_HANDLED);
                 }
+            } else if (action_id == ACTION_PURCHASE_FAILED){
+                preview = yield build_uninstalled_preview (result);
             } else if (action_id == ACTION_BUY_CLICK) {
-                // TODO: Need to add use of purchase service when ready.
-            } else if (action_id == ACTION_INSTALL_CLICK) {
+                preview = yield build_purchasing_preview (result);
+            } else if (action_id == ACTION_INSTALL_CLICK || action_id == ACTION_PURCHASE_SUCCEEDED) {
                 var progress_source = yield install_app(app_id);
                 preview = yield build_installing_preview (result, progress_source);
             } else if (action_id.has_prefix(ACTION_DOWNLOAD_FAILED)) {
@@ -466,74 +485,3 @@
     });
   }
 }
-
-
-/* The GIO File for logging to. */
-static File log_file = null;
-
-/* Method to convert the log level name to a string */
-static string _level_string (LogLevelFlags level)
-{
-	switch (level & LogLevelFlags.LEVEL_MASK) {
-	case LogLevelFlags.LEVEL_ERROR:
-		return "ERROR";
-	case LogLevelFlags.LEVEL_CRITICAL:
-		return "CRITICAL";
-	case LogLevelFlags.LEVEL_WARNING:
-		return "WARNING";
-	case LogLevelFlags.LEVEL_MESSAGE:
-		return "MESSAGE";
-	case LogLevelFlags.LEVEL_INFO:
-		return "INFO";
-	case LogLevelFlags.LEVEL_DEBUG:
-		return "DEBUG";
-	}
-	return "UNKNOWN";
-}
-
-static void ClickScopeLogHandler (string ? domain,
-								  LogLevelFlags level,
-								  string message)
-{
-	Log.default_handler (domain, level, message);
-
-    try {
-        var log_stream = log_file.append_to (FileCreateFlags.NONE);
-
-        if (log_stream != null) {
-            string log_message = "[%s] - %s: %s\n".printf(
-                domain, _level_string (level), message);
-            log_stream.write (log_message.data);
-            log_stream.flush ();
-            log_stream.close ();
-        }
-    } catch (GLib.Error e) {
-        // ignore all errors when trying to log to disk
-    }
-}
-
-
-int main ()
-{
-    var scope = new ClickScope();
-    var exporter = new Unity.ScopeDBusConnector (scope);
-    var exporter2 = new Unity.ScopeDBusConnector (new NonClickScope ());
-	var cache_dir = Environment.get_user_cache_dir ();
-	if (FileUtils.test (cache_dir, FileTest.EXISTS | FileTest.IS_DIR)) {
-			var log_path = Path.build_filename (cache_dir,
-												"unity-scope-click.log");
-			log_file = File.new_for_path (log_path);
-			Log.set_handler ("unity-scope-click", LogLevelFlags.LEVEL_MASK,
-							 ClickScopeLogHandler);
-	}
-
-    try {
-        exporter.export ();
-        exporter2.export ();
-    } catch (GLib.Error e) {
-        error ("Cannot export scope to DBus: %s", e.message);
-    }
-    Unity.ScopeDBusConnector.run ();
-
-    return 0;
-}

=== modified file 'src/test-click-webservice.vala'
--- src/test-click-webservice.vala	2013-12-06 13:20:17 +0000
+++ src/test-click-webservice.vala	2013-12-06 15:26:20 +0000
@@ -16,6 +16,8 @@
 
 using Assertions;
 
+private const string FAKE_APP_ID = "FAKE_APP_ID";
+
 public class ClickTestCase
 {
     public static bool run_with_timeout (MainLoop ml, uint timeout_ms)
@@ -209,6 +211,76 @@
         GLib.Environment.set_variable("PATH", real_path, true);
     }
 
+	private static bool preview_has_info_hint(Unity.Preview preview, string id, Variant val)
+	{
+		var serialized = preview.serialize();
+		// NOTE: the signature for serialize is (ssssssa(sssua{sv})a(sssv)a{sv})
+		GLib.Variant hints;
+		hints = serialized.get_child_value(7); // the a(sssv) part
+
+		foreach (var hint in hints) {
+			string hint_id;
+			GLib.Variant hint_val;
+			hint.get_child(0, "s", out hint_id);
+			hint.get_child(3, "v", out hint_val);
+
+			if (hint_id == id && hint_val.equal(val)){
+				return true;
+			}
+		}
+		return false;
+	}
+
+	private static bool preview_has_action(Unity.Preview preview, string action_name, string action_title)
+	{
+		var serialized = preview.serialize();
+		// NOTE: the signature for serialize is (ssssssa(sssua{sv})a(sssv)a{sv})
+		GLib.Variant actions;
+		actions = serialized.get_child_value(6); // the a(sssua{sv}) part
+
+		foreach (var action in actions) {
+			string name;
+			string title;
+			action.get_child(0, "s", out name);
+			action.get_child(1, "s", out title);
+
+			if (name == action_name && title == action_title) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+    public static void test_scope_build_purchasing_preview ()
+    {
+        MainLoop mainloop = new MainLoop ();
+        ClickScope scope = new ClickScope ();
+        var metadata = new HashTable<string, Variant> (str_hash, str_equal);
+        metadata.insert(METADATA_APP_ID, new GLib.Variant.string(FAKE_APP_ID));
+        var fake_result = Unity.ScopeResult.create("", "", 0,
+                                                   Unity.ResultType.DEFAULT,
+                                                   "application/x-desktop",
+                                                   "", "", "", metadata);
+        
+        scope.build_purchasing_preview.begin(fake_result, (obj, res) => {
+                mainloop.quit ();
+                try {
+                    var preview = scope.build_purchasing_preview.end(res);
+                    assert(preview_has_info_hint(preview, "show_purchase_overlay",
+                                                 new Variant.boolean(true)));
+                    assert(preview_has_info_hint(preview, "package_name",
+                                                 new Variant.string("FAKE_APP_ID")));
+                    assert(preview_has_action(preview, "purchase_succeeded", "*** purchase_succeeded"));
+                    assert(preview_has_action(preview, "purchase_failed", "*** purchase_failed"));
+                    
+                } catch (GLib.Error e) {
+                    error ("Exception caught building purchasing preview: %s", e.message);
+                }
+            });
+        
+        assert (run_with_timeout (mainloop, 10000));
+    }
+
     public static int main (string[] args)
     {
         Test.init (ref args);
@@ -222,6 +294,8 @@
         Test.add_data_func ("/Unit/ClickChecker/Test_Available_Apps", test_available_apps);
         Test.add_data_func ("/Unit/ClickChecker/Test_Fetch_Credentials", test_fetch_credentials);
         Test.add_data_func ("/Unit/ClickChecker/Test_Click_GetDotDesktop", test_click_get_dotdesktop);
+        Test.add_data_func ("/Unit/ClickChecker/Test_Scope_Build_Purchasing_Preview", 
+                            test_scope_build_purchasing_preview);
         return Test.run ();
     }
 }