Merge lp:~manishsinha/cheers/fixed-award-unaward-trophy into lp:cheers

[Manish Sinha (मनीष सिन्हा)]

Fixed the UnawardTrophy and AwardTrophy functionality

* Implemented the AwardTrophy method
* Implement the UnawardTrophy method
* Updated the Copyright headers

Test out this branch
=====================
Start the daemon using
./cheers-daemon

Throw the file samples/valid.trophy under ~/.local/share/cheers/trophies

It should get picked up.

Open D-feet and search for com.cheersproject.cheers

Call GetTrophies() -- that trophy shpold show up. get it's id should be u'some-id-for-trophy'
call the method GetAwardedTrophies() - nothing should come

Try the method AwardTrophy() and pass this - u'some-id-for-trophy'
It should work without any issues

Now call the method GetAwardedTrophies() -- that trophy should show up

Now call UnawardTerophy() with u'some-id-for-trophy' -- it should work without any errors

now call GetAwardedTrophies() - nothing should show up

=== modified file 'LICENSE'
--- LICENSE	2010-11-04 20:47:04 +0000
+++ LICENSE	2011-03-21 21:25:51 +0000
@@ -1,6 +1,7 @@
 # The MIT/X11/Expat License
 
-# Copyright (c) 2010 Manish Sinha<[e-mail]>
+# Copyright (c) 2010 Manish Sinha <[e-mail]>
+# Copyright (c) 2010 Seif Lotfy <[e-mail]>
 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
 
=== modified file 'MAINTAINERS'
--- MAINTAINERS	2010-11-04 20:47:04 +0000
+++ MAINTAINERS	2011-03-21 21:25:51 +0000
@@ -1,1 +1,1 @@
-Manish Sinha <[e-mail]>
+Manish Sinha <[e-mail]>
 
=== modified file 'README'
--- README	2010-11-04 20:47:04 +0000
+++ README	2011-03-21 21:25:51 +0000
@@ -1,11 +1,16 @@
-Cheers is a trophy awarding framework. It runs as a daemon activating a DBus Session bus over which applications can talk to it.
-The aim of cheers is to have a centralized system where all the trophies can be stored. This removes the reduendency of every application with requirements which sounds like trophjy/medal/badges to have their own implementation.
+Cheers is a trophy awarding framework. It runs as a daemon activating a 
+DBus Session bus over which applications can talk to it.
+The aim of cheers is to have a centralized system where all the trophies 
+can be stored. This removes the reduendency of every application with 
+requirements which sounds like trophjy/medal/badges to have their own 
+implementation.
 
 It is written using python, desktopcouch, dbus
 
 Prerequisties
 ---------------
-To get cheers up and running, you need the following packages. Please check your distribution for the exact name of the packages
+To get cheers up and running, you need the following packages. Please 
+check your distribution for the exact name of the packages
 * python
 * python-dbus
 * python-gio
@@ -23,12 +28,14 @@
 Registering a trophy
 ---------------------
 
-Cheers keeps a watch on three folders for new trophies when the server is running. These two folders are
+Cheers keeps a watch on three folders for new trophies when the server 
+is running. These two folders are
 * /usr/share/cheers/trophies
 * /usr/local/share/cheers/trophies
 * ~/.local/share/cheers/trophies
 
-A sample trophy aa.trophy is provided. Put it  under the folder ~/.local/share/cheers/trophies to register the trophy
+A sample trophy aa.trophy is provided. Put it  under the folder 
+~/.local/share/cheers/trophies to register the trophy
 
 
 Debugging
 
=== modified file 'cheers/config.py'
--- cheers/config.py	2010-11-06 19:29:15 +0000
+++ cheers/config.py	2011-03-21 21:25:51 +0000
@@ -35,4 +35,13 @@
 
 desktopcouch_db = "cheers"
 
+# s - Id
+# a(as) - Array of [lang, Title]
+# a(as) - Array of [lang, Description]
+# s - The set to which the trophy beldongs
+# s - The icon for the trophy
+# s - The stockicon for the Trophy
+# s - The name of the application
+# b - Has the trophy been awarded
+TROPHY_SIG = "saasaasssssb"
 
 
=== modified file 'cheers/datastore.py'
--- cheers/datastore.py	2010-11-30 21:22:25 +0000
+++ cheers/datastore.py	2011-03-21 21:25:51 +0000
@@ -79,8 +79,8 @@
         #FIXME: There must be a more elegant way of doing this
         results = self._get_records("trophies", )
         for rec in results:
-            if rec["value"].has_key("private_application_annotations") and \
-             rec["value"]["private_application_annotations"]["cheers"]["awarded"]:
+            annot = CouchRecord(rec.value).application_annotations.get("cheers")
+            if annot is not None and annot.has_key("awarded") and annot["awarded"]:
                 yield rec["value"]
 
     def get_sets(self, ids=None):
@@ -92,23 +92,48 @@
 
     def delete_trophy(self, id):
         """ Delete the trophy for the provided id """
+        records = [rec for rec in self._get_records("trophies", [id])]
+        if len(records) != 1:
+            raise KeyError, 'No such trophy registered'
         for rec in self._get_records("trophies", ids):
             self.database.delete_record(rec["id"])  
 
     def award_trophies(self, ids):
         """ Award the trophy with the provided trophy id """
         #self.database.update_fields(record_id, fields, cached_record)
-        for rec in self._get_records("trophies", ids):
-            if rec["value"].has_key("private_application_annotations"):
-                rec["value"]["private_application_annotations"]["cheers"]["awarded"] = True  
+        records = [rec for rec in self._get_records("trophies", ids)]
+        if len(records) != len(ids):
+            raise KeyError, 'No such trophy registered'
+        awarded = []
+        for rec in records:
+            record = CouchRecord(rec.value).application_annotations 
+            annot = record.get("cheers")
+            if annot is not None and annot.has_key("awarded"):
+                annot["awarded"] = True
+                awarded.append(rec)
+            elif annot is None:
+                record.setdefault("cheers", {})["awarded"] = True
+                awarded.append(rec)
+            
             self.database.update_fields(rec["id"], rec["value"])     
+        
+        return awarded
     
     def unaward_trophies(self, ids):
         """ Unaward the trophy with the provided trophy id """
-        for rec in self._get_records("trophies", ids):
-            if rec["value"].has_key("private_application_annotations"):
-                rec["value"]["private_application_annotations"]["cheers"]["awarded"] = False
-            self.database.update_fields(rec["id"], rec["value"])  
+        print "unawarding", ids
+        records = [rec for rec in self._get_records("trophies", ids)]
+        if len(records) != len(ids):
+        	raise KeyError, 'No such trophy registered'
+        unawarded = []
+        for rec in records:
+            annot = CouchRecord(rec.value).application_annotations.get("cheers")
+            if annot is not None and annot.has_key("awarded"):
+                annot["awarded"] = False
+                unawarded.append(rec)
+                self.database.update_fields(rec["id"], rec["value"])
+
+        return unawarded
 
     def get_trophies_by_app(self, appname):
         """ Get all the trophies associated with a particular application """
@@ -122,3 +147,4 @@
             if trophy.has_key("trophyset") and trophy["trophyset"] == setname:
                 yield trophy
 
+
 
=== modified file 'cheers/logic.py'
--- cheers/logic.py	2010-11-30 21:22:25 +0000
+++ cheers/logic.py	2011-03-21 21:25:51 +0000
@@ -135,18 +135,17 @@
         """ Get all the trophy sets in cheers """
         return [i for i in self.__store.get_sets()]
 
-
     def delete_trophy(self, id):
         """ Delete the trophy for the provided id """
-        pass
+        self.__store.delete_trophy([id]);
 
     def award_trophy(self, id):
         """ Award the trophy with the provided trophy id """
-        pass
+        return self.__store.award_trophies([id]);
 
     def unaward_trophy(self, id):
         """ Unaward the trophy with the provided trophy id """
-        pass
+        return self.__store.unaward_trophies([id]);
 
     def get_trophies_by_app(self, appname):
         """ Get all the trophies associated with a particular application """
 
=== modified file 'cheers/server.py'
--- cheers/server.py	2010-11-30 21:22:25 +0000
+++ cheers/server.py	2011-03-21 21:25:51 +0000
@@ -51,10 +51,9 @@
         and the connection to the datstore is closed """
         
         print("Requested to stop the bus")
-        #self.__store.Quit()
         os._exit(0)
         
-    @dbus.service.method(config.CHEERS_BUS_NAME, out_signature='a(saasaasssssb)')    
+    @dbus.service.method(config.CHEERS_BUS_NAME, out_signature='a('+config.TROPHY_SIG+')')    
     def GetTrophies(self):
         """ Get the list of all the trophies registered in cheers """
 
@@ -65,13 +64,13 @@
         """ Get the list of all the trophy sets available in cheers """
         return self.logic.get_sets()
         
-    @dbus.service.method(config.CHEERS_BUS_NAME, out_signature='a(saasaasssssb)')
+    @dbus.service.method(config.CHEERS_BUS_NAME, out_signature='a('+config.TROPHY_SIG+')')
     def GetAwardedTrophies(self):
         """ Get the list of all the awarded trophies in cheers """
 
         return self.logic.get_awarded_trophies()
 
-    @dbus.service.method(config.CHEERS_BUS_NAME, out_signature='saasaasssssb')
+    @dbus.service.method(config.CHEERS_BUS_NAME, out_signature=config.TROPHY_SIG)
     def GetTrophy(self, id):
         """ Get the trophy instance when the id is provided """
 
@@ -83,26 +82,56 @@
 
         res = self.logic.delete_trophy(id)
 
+        for trophy in res:
+            self.TrophyDeleted(trophy)
+
     @dbus.service.method(config.CHEERS_BUS_NAME)
     def AwardTrophy(self, id):
         """ Award the trophy for the provided trophy id """
 
         res = self.logic.award_trophy(id)
 
+        for trophy in res:
+            self.TrophyAwarded(trophy)
+
     @dbus.service.method(config.CHEERS_BUS_NAME)
     def UnawardTrophy(self, id):
         """ Unaward the trophy for the provided id """
 
         res = self.logic.unaward_trophy(id)
 
-    @dbus.service.method(config.CHEERS_BUS_NAME, out_signature='a(saasaasssssb)')
+        for trophy in res:
+            self.TrophyUnawarded(trophy)
+
+    @dbus.service.method(config.CHEERS_BUS_NAME, out_signature='a('+config.TROPHY_SIG+')')
     def GetTrophiesByApp(self, appname):
         """ Get all the trophies registered for a specific application """
 
         return self.logic.get_trophies_by_app(appname)
 
-    @dbus.service.method(config.CHEERS_BUS_NAME, out_signature='a(saasaasssssb)')
+    @dbus.service.method(config.CHEERS_BUS_NAME, out_signature='a('+config.TROPHY_SIG+')')
     def GetTrophyBySet(self, setname):
         """ Get all the trophies registsred for a specific set """
 
         return self.logic.get_trophies_by_set(setname)
+
+   # @dbus.service.signal(config.CHEERS_BUS_NAME, signature=config.TROPHY_SIG)
+    def TrophyAwarded(self, trophy):
+        """ An event notifying that the trophy has been awarded """
+        
+        print("Trophy %s awarded" %(trophy))
+        return trophy
+
+    #@dbus.service.signal(config.CHEERS_BUS_NAME, ignature=config.TROPHY_SIG)
+    def TrophyUnawarded(self, trophy):
+        """ An event notifying that the trophy has been unawarded """
+        
+        print("Trophy %s unawarded" %(trophy))
+        return trophy
+
+    #@dbus.service.signal(config.CHEERS_BUS_NAME, signature=config.TROPHY_SIG)
+    def TrophyDeleted(self, trophy):
+        """ An event notifying that the trophy has been deleted """
+
+        print("Trophy %s deleted" %(trophy))
+        return trophy