lib/jiralicious/basic_session.rb in jiralicious-0.2.0 vs lib/jiralicious/basic_session.rb in jiralicious-0.2.1

@@ -1,6 +1,13 @@
 module Jiralicious
+  ##
+  # The BasicSesion class extends the default Session class by forcing
+  # basic_auth to be fired prior to any other action.
+  #
   class BasicSession < Session
+    ##
+    # Fires off the basic_auth with the local username and password.
+    #
     def before_request
       self.class.basic_auth(Jiralicious.username, Jiralicious.password)
     end
   end
 end