Allow bookmarks to be removed from rooms

Refactored the code a bit in the process.

spec/bookmarks.js

@@ -27,7 +27,6 @@
             var view = converse.chatboxviews.get(jid);
             spyOn(view, 'renderBookmarkForm').andCallThrough();
             spyOn(view, 'cancelConfiguration').andCallThrough();
-            spyOn(view, 'onBookmarkError').andCallThrough();
 
             var $bookmark = view.$el.find('.icon-pushpin');
             $bookmark.click();
@@ -124,6 +123,11 @@
         });
 
         describe("when bookmarked", function () {
+            beforeEach(function () {
+                test_utils.closeAllChatBoxes();
+                converse.bookmarks.reset();
+            });
+
             it("displays that it's bookmarked through its bookmark icon", function () {
                 runs(function () {
                     test_utils.openChatRoom('lounge', 'localhost', 'dummy');
@@ -141,10 +145,68 @@
             });
 
             it("can be unbookmarked", function () {
-                // TODO
+                var sent_stanza, IQ_id;
-                // Mock bookmark data received from the server.
+                var sendIQ = converse.connection.sendIQ;
-                // Open the room
+                spyOn(converse.connection, 'sendIQ').andCallFake(function (iq, callback, errback) {
-                // Click the bookmark icon to unbookmark
+                    sent_stanza = iq;
+                    IQ_id = sendIQ.bind(this)(iq, callback, errback);
+                });
+                spyOn(converse.connection, 'getUniqueId').andCallThrough();
+
+                runs(function () {
+                    test_utils.openChatRoom('theplay', 'conference.shakespeare.lit', 'JC');
+                });
+                waits(100);
+                runs(function () {
+                    var jid = 'theplay@conference.shakespeare.lit';
+                    var view = converse.chatboxviews.get(jid);
+                    spyOn(view, 'toggleBookmark').andCallThrough();
+                    spyOn(converse.bookmarks, 'sendBookmarkStanza').andCallThrough();
+                    view.delegateEvents();
+                    converse.bookmarks.create({
+                        'jid': view.model.get('jid'),
+                        'autojoin': false,
+                        'name':  'The Play',
+                        'nick': ' Othello'
+                    });
+                    expect(converse.bookmarks.length).toBe(1);
+                    view.model.save('bookmarked', true);
+                    var $bookmark_icon = view.$('.icon-pushpin');
+                    expect($bookmark_icon.hasClass('button-on')).toBeTruthy();
+                    $bookmark_icon.click();
+                    expect(converse.bookmarks.sendBookmarkStanza).toHaveBeenCalled();
+                    expect($bookmark_icon.hasClass('button-on')).toBeFalsy();
+                    expect(view.toggleBookmark).toHaveBeenCalled();
+                    expect(converse.bookmarks.length).toBe(0);
+
+                    // Check that an IQ stanza is sent out, containing no
+                    // conferences to bookmark (since we removed the one and
+                    // only bookmark).
+                    expect(sent_stanza.toLocaleString()).toBe(
+                        "<iq type='set' from='dummy@localhost/resource' xmlns='jabber:client' id='"+IQ_id+"'>"+
+                            "<pubsub xmlns='http://jabber.org/protocol/pubsub'>"+
+                                "<publish node='storage:bookmarks'>"+
+                                    "<item id='current'>"+
+                                        "<storage xmlns='storage:bookmarks'/>"+
+                                    "</item>"+
+                                "</publish>"+
+                                "<publish-options>"+
+                                    "<x xmlns='jabber:x:data' type='submit'>"+
+                                        "<field var='FORM_TYPE' type='hidden'>"+
+                                            "<value>http://jabber.org/protocol/pubsub#publish-options</value>"+
+                                        "</field>"+
+                                        "<field var='pubsub#persist_items'>"+
+                                            "<value>true</value>"+
+                                        "</field>"+
+                                        "<field var='pubsub#access_model'>"+
+                                            "<value>whitelist</value>"+
+                                        "</field>"+
+                                    "</x>"+
+                                "</publish-options>"+
+                            "</pubsub>"+
+                        "</iq>"
+                    );
+                });
             });
         });
     });

src/converse-bookmarks.js

@@ -39,7 +39,7 @@
             // relevant objects or classes.
             //
             // New functions which don't exist yet can also be added.
-            
+
             RoomsPanel: {
                 /* TODO: show bookmarked rooms in the rooms panel */
             },
@@ -87,21 +87,16 @@
 
                 addBookmark: function (ev) {
                     ev.preventDefault();
+                    var $form = $(ev.target),
+                        that = this;
                     converse.bookmarks.create({
                         'jid': this.model.get('jid'),
-                        'autojoin': this.$el.find('.chatroom-form').find('input[name=autojoin]').val(),
+                        'autojoin': $form.find('input[name="autojoin"]').prop('checked'),
-                        'name':  this.$el.find('.chatroom-form').find('input[name=name]').val(),
+                        'name':  $form.find('input[name=name]').val(),
-                        'nick':  this.$el.find('.chatroom-form').find('input[name=nick]').val()
+                        'nick':  $form.find('input[name=nick]').val()
                     });
                     this.model.save('bookmarked', true);
-
+                    converse.bookmarks.sendBookmarkStanza();
-                    var that = this,
-                        $form = $(ev.target);
-                    this.sendBookmarkStanza(
-                        $form.find('input[name="name"]').val(),
-                        $form.find('input[name="autojoin"]').prop('checked'),
-                        $form.find('input[name="nick"]').val()
-                    );
                     this.$el.find('div.chatroom-form-container').hide(
                         function () {
                             $(this).remove();
@@ -109,54 +104,19 @@
                         });
                 },
 
-                sendBookmarkStanza: function (name, autojoin, nick) {
-                    name = name || converse.connection.jid;
-                    var stanza = $iq({
-                            'type': 'set',
-                            'from': converse.connection.jid,
-                        })
-                        .c('pubsub', {'xmlns': Strophe.NS.PUBSUB})
-                            .c('publish', {'node': 'storage:bookmarks'})
-                                .c('item', {'id': 'current'})
-                                    .c('storage', {'xmlns':'storage:bookmarks'})
-                                        .c('conference', {
-                                            'name': name,
-                                            'autojoin': autojoin,
-                                            'jid': this.model.get('jid'), 
-                                        }).c('nick').t(nick).up()
-                                        .up()
-                                    .up()
-                                .up()
-                            .up()
-                            .c('publish-options')
-                                .c('x', {'xmlns': Strophe.NS.XFORM, 'type':'submit'})
-                                    .c('field', {'var':'FORM_TYPE', 'type':'hidden'})
-                                        .c('value').t('http://jabber.org/protocol/pubsub#publish-options').up().up()
-                                    .c('field', {'var':'pubsub#persist_items'})
-                                        .c('value').t('true').up().up()
-                                    .c('field', {'var':'pubsub#access_model'})
-                                        .c('value').t('whitelist');
-                    converse.connection.sendIQ(stanza, null, this.onBookmarkError.bind(this));
-                },
-
-                onBookmarkError: function (iq) {
-                    converse.log("Error while trying to add bookmark", "error");
-                    converse.log(iq);
-                    this.model.save('bookmarked', false);
-                    window.alert(__("Sorry, something went wrong while trying to save your bookmark."));
-                },
-
                 toggleBookmark: function (ev) {
                     if (ev) {
                         ev.preventDefault();
                         ev.stopPropagation();
                     }
-                    if (!converse.bookmarks.get(this.model.get('id'))) {
+                    var models = converse.bookmarks.where({'jid': this.model.get('jid')});
+                    if (!models.length) {
                         this.renderBookmarkForm();
                     } else {
-                        converse.bookmarks.remove({
+                        converse.bookmarks.remove(models);
-                            'id': this.model.get('id')
+                        converse.bookmarks.sendBookmarkStanza().fail(
-                        });
+                            _.partial(this.model.save, 'bookmarked', false)
+                        );
                         this.$('.icon-pushpin').removeClass('button-on');
                     }
                 }
@@ -170,26 +130,87 @@
             var converse = this.converse;
 
             converse.Bookmarks = Backbone.Collection.extend({
-                
+
+                initialize: function () {
+                    this.on('add', this.markRoomAsBookmarked, this);
+                    this.on('remove', this.markRoomAsUnbookmarked, this);
+                },
+
+                fetchBookmarks: function () {
+                    converse.bookmarks.fetch({
+                        'add': true,
+                        'success': this.onCachedBookmarksFetched.bind(this),
+                        'error':  this.onCachedBookmarksFetched.bind(this)
+                    });
+                },
+
+                sendBookmarkStanza: function () {
+                    var deferred = new $.Deferred();
+                    var stanza = $iq({
+                            'type': 'set',
+                            'from': converse.connection.jid,
+                        })
+                        .c('pubsub', {'xmlns': Strophe.NS.PUBSUB})
+                            .c('publish', {'node': 'storage:bookmarks'})
+                                .c('item', {'id': 'current'})
+                                    .c('storage', {'xmlns':'storage:bookmarks'});
+
+                    this.each(function (model) {
+                        stanza = stanza.c('conference', {
+                            'name': model.get('name'),
+                            'autojoin': model.get('autojoin'),
+                            'jid': model.get('jid'),
+                        }).c('nick').t(model.get('nick')).up().up();
+                    });
+                    stanza.up().up().up();
+                    stanza.c('publish-options')
+                        .c('x', {'xmlns': Strophe.NS.XFORM, 'type':'submit'})
+                            .c('field', {'var':'FORM_TYPE', 'type':'hidden'})
+                                .c('value').t('http://jabber.org/protocol/pubsub#publish-options').up().up()
+                            .c('field', {'var':'pubsub#persist_items'})
+                                .c('value').t('true').up().up()
+                            .c('field', {'var':'pubsub#access_model'})
+                                .c('value').t('whitelist');
+                    converse.connection.sendIQ(
+                        stanza,
+                        deferred.resolve,
+                        _.bind(this.onBookmarkError, this, deferred)
+                    );
+                    return deferred.promise();
+                },
+
+                onBookmarkError: function (deferred, iq) {
+                    converse.log("Error while trying to add bookmark", "error");
+                    converse.log(iq);
+                    // We remove all locally cached bookmarks and fetch them
+                    // again from the server.
+                    this.reset();
+                    this.fetchBookmarksFromServer();
+                    window.alert(__("Sorry, something went wrong while trying to save your bookmark."));
+                    return deferred.reject();
+                },
+
                 onCachedBookmarksFetched: function () {
                     if (!window.sessionStorage.getItem(this.browserStorage.name)) {
                         // There aren't any cached bookmarks, so we query the
                         // XMPP server.
-                        var stanza = $iq({
+                        this.fetchBookmarksFromServer();
-                            'from': converse.connection.jid,
-                            'type': 'get',
-                        }).c('pubsub', {'xmlns': Strophe.NS.PUBSUB})
-                            .c('items', {'node': 'storage:bookmarks'});
-                        converse.connection.sendIQ(
-                            stanza,
-                            this.onBookmarksReceived.bind(this),
-                            this.onBookmarksReceivedError
-                        );
-                    } else {
-                        this.models.each(this.markRoomAsBookmarked);
                     }
                 },
 
+                fetchBookmarksFromServer: function () {
+                    var stanza = $iq({
+                        'from': converse.connection.jid,
+                        'type': 'get',
+                    }).c('pubsub', {'xmlns': Strophe.NS.PUBSUB})
+                        .c('items', {'node': 'storage:bookmarks'});
+                    converse.connection.sendIQ(
+                        stanza,
+                        this.onBookmarksReceived.bind(this),
+                        this.onBookmarksReceivedError
+                    );
+                },
+
                 markRoomAsBookmarked: function (bookmark) {
                     var room = converse.chatboxes.get(bookmark.get('jid'));
                     if (!_.isUndefined(room)) {
@@ -197,17 +218,24 @@
                     }
                 },
 
+                markRoomAsUnbookmarked: function (bookmark) {
+                    var room = converse.chatboxes.get(bookmark.get('jid'));
+                    if (!_.isUndefined(room)) {
+                        room.save('bookmarked', false);
+                    }
+                },
+
                 onBookmarksReceived: function (iq) {
                     var bookmarks = $(iq).find(
                         'items[node="storage:bookmarks"] item[id="current"] storage conference'
                     );
                     _.each(bookmarks, function (bookmark) {
-                        this.markRoomAsBookmarked(this.create({
+                        this.create({
                             'jid': bookmark.getAttribute('jid'),
                             'name': bookmark.getAttribute('name'),
                             'autojoin': bookmark.getAttribute('autojoin'),
                             'nick': bookmark.querySelector('nick').textContent
-                        }));
+                        });
                     }.bind(this));
                 },
 
@@ -222,12 +250,7 @@
                 var id = b64_sha1('converse.room-bookmarks');
                 converse.bookmarks.id = id;
                 converse.bookmarks.browserStorage = new Backbone.BrowserStorage[converse.storage](id);
-                converse.bookmarks.fetch({
+                converse.bookmarks.fetchBookmarks();
-                    'add': true,
-                    'success': converse.bookmarks.onCachedBookmarksFetched.bind(converse.bookmarks),
-                    'error':  converse.bookmarks.onCachedBookmarksFetched.bind(converse.bookmarks)
-
-                });
             };
             converse.on('connected', converse.initBookmarks);
             converse.on('reconnected', converse.initBookmarks);