# HG changeset patch
# User Sverre Rabbelier <srabbelier@gmail.com>
# Date 1240058215 0
# Node ID e2c6e6722d691fe47bdbd0bd0011cc723bac9ee3
# Parent  f6a1c141f51ef5fb7b7c74dfbb40d9d0cdc787cc
Add support for ID based entities

This allows entities that do not have a key name to be created and
edited without requiring the presence of a key_name.

Patch by: Sverre Rabbelier

diff -r f6a1c141f51e -r e2c6e6722d69 app/soc/logic/models/base.py
--- a/app/soc/logic/models/base.py	Sat Apr 18 12:07:02 2009 +0000
+++ b/app/soc/logic/models/base.py	Sat Apr 18 12:36:55 2009 +0000
@@ -65,13 +65,14 @@
   """
 
   def __init__(self, model, base_model=None, scope_logic=None,
-               name=None, skip_properties=None):
+               name=None, skip_properties=None, id_based=False):
     """Defines the name, key_name and model for this entity.
     """
 
     self._model = model
     self._base_model = base_model
     self._scope_logic = scope_logic
+    self._id_based = id_based
 
     if name:
       self._name = name
@@ -202,11 +203,29 @@
       key_name: key name of entity
     """
 
+    if self._id_based:
+      raise Error("getFromKeyName called on an id based logic")
+
     if not key_name:
       raise InvalidArgumentError
 
     return self._model.get_by_key_name(key_name)
 
+  def getFromID(self, id):
+    """Returns entity for id or None if not found.
+
+    Args:
+      id: id of entity
+    """
+
+    if not self._id_based:
+      raise Error("getFromID called on a not id based logic")
+
+    if not id:
+      raise InvalidArgumentError
+
+    return self._model.get_by_id(id)
+
   def getFromKeyNameOr404(self, key_name):
     """Like getFromKeyName but expects to find an entity.
 
@@ -224,6 +243,23 @@
 
     raise out_of_band.Error(msg, status=404)
 
+  def getFromIDOr404(self, id):
+    """Like getFromID but expects to find an entity.
+
+    Raises:
+      out_of_band.Error if no entity is found
+    """
+
+    entity = self.getFromID(id)
+
+    if entity:
+      return entity
+
+    msg = ugettext('There is no "%(name)s" with id %(id)s.') % {
+        'name': self._name, 'id': id}
+
+    raise out_of_band.Error(msg, status=404)
+
   def getFromKeyFields(self, fields):
     """Returns the entity for the specified key names, or None if not found.
 
@@ -407,6 +443,26 @@
 
     return entity
 
+  def updateOrCreateFromFields(self, properties):
+    """Creates a new entity with the supplied properties.
+
+    Args:
+      properties: dict with entity properties and their values
+    """
+
+    for property_name in properties:
+      self._createField(properties, property_name)
+
+    if self._id_based:
+      entity = self._model(**properties)
+      entity.put()
+    else:
+      key_name = self.getKeyNameFromFields(properties)
+      entity = self._model.get_or_insert(key_name, **properties)
+
+    self._onCreate(entity)
+    return entity
+
   def isDeletable(self, entity):
     """Returns whether the specified entity can be deleted.