Merge lp:~jplacerda/zeitgeist/691690 into lp:zeitgeist/0.1

[J.P. Lacerda]

[Siegfried Gevatter (rainct)]

Looks good!

Can you please document GetDataSourceFromId like the other methods, though? (Ie. with description, :param, :type, :returns, :rtype; the documentation is automatically generated from that).

[lp:~jplacerda/zeitgeist/691690]

1759. By J.P. Lacerda <email address hidden> on 2011-05-11

Add a method to the data-source registry to retrieve
the information for a particular data-source from its ID.

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

This will break the API again in 0.8.1 ?

Should I wait for 0.8.1 and release zeitgeist-sharp or go ahead?

review: Needs Information

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

Sorry I meant ABI

[Seif Lotfy (seif)]

release 0.8 then we release 0.8.1

2011/5/11 Manish Sinha (मनीष सिन्हा <email address hidden>

> Sorry I meant ABI
> --
> https://code.launchpad.net/~jplacerda/zeitgeist/691690/+merge/60502
> You are requested to review the proposed merge of
> lp:~jplacerda/zeitgeist/691690 into lp:zeitgeist.
>

=== modified file '_zeitgeist/engine/extensions/datasource_registry.py'
--- _zeitgeist/engine/extensions/datasource_registry.py	2011-04-27 18:55:33 +0000
+++ _zeitgeist/engine/extensions/datasource_registry.py	2011-05-11 08:53:32 +0000
@@ -66,7 +66,7 @@
 	:const:`org.gnome.zeitgeist.DataSourceRegistry`.
 	"""
 	PUBLIC_METHODS = ["register_data_source", "get_data_sources",
-		"set_data_source_enabled"]
+		"set_data_source_enabled", "get_data_source_from_id"]
 	
 	def __init__ (self, engine):
 	
@@ -125,7 +125,7 @@
 	
 	def unload(self):
 		self._write_to_disk()
-	
+
 	# PUBLIC
 	def register_data_source(self, unique_id, name, description, templates):
 		source = DataSource(str(unique_id), unicode(name), unicode(description),
@@ -152,7 +152,14 @@
 			datasource.enabled = enabled
 			self.DataSourceEnabled(datasource.unique_id, enabled)
 		return True
-	
+
+	# PUBLIC
+	def get_data_source_from_id(self, unique_id):
+		if unique_id in self._registry:
+			return self._registry[unique_id]
+		else:
+			raise KeyError("DataSource not found: %s" % unique_id)
+
 	@dbus.service.method(REGISTRY_DBUS_INTERFACE,
 						 in_signature="sssa("+constants.SIG_EVENT+")",
 						 out_signature="b",
@@ -211,6 +218,22 @@
 		"""
 		self.set_data_source_enabled(unique_id, enabled)
 
+	@dbus.service.method(REGISTRY_DBUS_INTERFACE,
+						 in_signature="s",
+						 out_signature=SIG_FULL_DATASOURCE,
+						 sender_keyword="sender")
+	def GetDataSourceFromId(self, unique_id, sender):
+		"""
+		Get a specific data-source from its unique id.
+		If no data-source has been registered to the specified unique
+		id, a KeyError is raised.
+
+		:param unique_id: unique string identifying a data-source
+		:type unique_id: string
+		:returns: class:`DataSource <zeitgeist.datamodel.DataSource>` object 
+		"""
+		return self.get_data_source_from_id(unique_id)
+
 	@dbus.service.signal(REGISTRY_DBUS_INTERFACE,
 						signature="sb")
 	def DataSourceEnabled(self, value, enabled):

=== modified file 'test/remote-test.py'
--- test/remote-test.py	2011-05-07 12:48:06 +0000
+++ test/remote-test.py	2011-05-11 08:53:32 +0000
@@ -16,6 +16,7 @@
 import gobject
 from dbus.mainloop.glib import DBusGMainLoop
 DBusGMainLoop(set_as_default=True)
+from dbus.exceptions import DBusException
 
 # Import local Zeitgeist modules
 sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
@@ -481,7 +482,18 @@
 		self.client._registry.SetDataSourceEnabled(self._ds1[0], True)
 		ds = list(self.client._registry.GetDataSources())[0]
 		self.assertEquals(ds[DataSource.Enabled], True)
-	
+
+	def testGetDataSourceFromId(self):
+		# Insert a data-source -- and then retrieve it by id
+		self.client._registry.RegisterDataSource(*self._ds1)
+		ds = self.client._registry.GetDataSourceFromId(self._ds1[0])
+		self._assertDataSourceEquals(ds, self._ds1)
+		
+		# Retrieve a data-source from an id that has not been registered
+		self.assertRaises(DBusException,
+				  self.client._registry.GetDataSourceFromId,
+				  self._ds2[0])
+
 	def testDataSourceSignals(self):
 		mainloop = self.create_mainloop()
 		
@@ -552,7 +564,7 @@
 		
 		# Disable the data-source
 		self.client._registry.SetDataSourceEnabled(self._ds1[0], False)
-		
+
 		mainloop.run()
 
 class ZeitgeistRemotePropertiesTest(testutils.RemoteTestCase):