Document everything with YARD and fix some bugs along the way.
[mailshears.git] / lib / rm / plugins / davical.rb
index 3526dcff2fa4f9fc57950c32ac50e34c44d6872c..852d9c4c66b1fa97467de79c2628a34fd6320338 100644 (file)
@@ -3,43 +3,36 @@ require 'pg'
 require 'common/davical_plugin'
 require 'rm/rm_plugin'
 
+# Handle the removal of DAViCal users from its database. DAViCal has
+# no concept of domains.
+#
 class DavicalRm
-  #
-  # DAViCal only supports Postgres, so even if we ever are
-  # database-agnostic, this plugin can't be.
-  #
+
   include DavicalPlugin
   include RmPlugin
 
 
-  def delete_user(user)
-    # Delete the given username. DAViCal uses foreign keys properly
-    # and only supports postgres, so we let the ON DELETE CASCADE
-    # trigger handle most of the work.
+  # Remove *user* from the DAViCal database. This should remove him
+  # from _every_ table in which he is referenced. Fortunately, DAViCal
+  # uses foreign keys properly (and only supports postgres, where they
+  # work!), so we can let the ON DELETE CASCADE trigger handle most of
+  # the work.
+  #
+  # @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 usr WHERE username = $1']
 
-    begin
-      connection = PGconn.connect(@db_host,
-                                  @db_port,
-                                  @db_opts,
-                                  @db_tty,
-                                  @db_name,
-                                  @db_user,
-                                  @db_pass)
-
-      sql_queries.each do |sql_query|
-        connection.query(sql_query, [user.to_s()])
-      end
-
-      connection.close()
+    connection = PGconn.connect(@db_host, @db_port, @db_opts, @db_tty,
+                                @db_name, @db_user, @db_pass)
 
-    rescue PGError => e
-      # Pretend like we're database-agnostic in case we ever are.
-      raise DatabaseError.new(e)
+    sql_queries.each do |sql_query|
+      connection.query(sql_query, [user.to_s()])
     end
 
+    connection.close()
   end