Document everything with YARD and fix some bugs along the way.
[mailshears.git] / lib / rm / plugins / agendav.rb
index 6d92c26d6fb054d9de44ba5d30b60abec76c2f8d..28f1eb4167a4a63bec61889ea47b97492d87f80f 100644 (file)
@@ -3,15 +3,22 @@ require 'pg'
 require 'common/agendav_plugin'
 require 'rm/rm_plugin'
 
+
+# Handle the removal of Agendav users from its database. Agendav has
+# no concept of domains.
+#
 class AgendavRm
 
   include AgendavPlugin
   include RmPlugin
 
 
-  def delete_user(user)
-    # Delete the given username and any records in other tables
-    # belonging to it.
+  # Remove *user* from the Agendav database. This should remove him
+  # from _every_ table in which he is referenced.
+  #
+  # @param user [User] the user to remove.
+  #
+  def remove_user(user)
     raise NonexistentUserError.new(user.to_s()) if not user_exists(user)
 
     sql_queries = ['DELETE FROM prefs WHERE username = $1;']