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

@@ -1,15 +1,24 @@
 # encoding: utf-8
 require 'jiralicious/configuration'
 
 module Jiralicious
+  ##
+  # The Session class handles the interactions with the Jira Rest API
+  # Through the HTTParty gem.
+  #
   class Session
     include HTTParty
 
+    # Sets the default format to JSON for send and return
     format        :json
+    # Sets the default headers to application/json for send and return
     headers       'Content-Type' => 'application/json'
 
+    ##
+    # Main access method to request data from the Jira API
+    #
     def request(method, *options)
       if options.last.is_a?(Hash) && options.last[:handler]
         response_handler = options.last.delete(:handler)
       else
         response_handler = handler
@@ -23,9 +32,13 @@
       response_handler.call(response)
     end
 
     private
 
+    ##
+    # Configures the default handler. This can be overridden in
+    # the child class to provide additional error handling.
+    #
     def handler
       Proc.new do |response|
         case response
         when 200..204
           response.body