lib/moiper/request.rb in moiper-0.1.1 vs lib/moiper/request.rb in moiper-0.1.2

@@ -3,33 +3,42 @@
 
 module Moiper
   class Request
     CA_FILE = File.expand_path(File.dirname(__FILE__)) + "/cacert.pem"
 
-    attr_reader :response
-
+    # Process a given payload
+    # @param payload [String]
+    # @return [Response] the response from Moip
     def process(payload)
-      @response = post(payload)
-      Response.new(@response.body)
+      response = post(payload)
+      Response.new(response.body)
     end
 
+    # @!group HTTP handling
+
+    # @return [Net::HTTP::Session] the http session client
     def client
       @client ||= Net::HTTP.new(uri.host, uri.port).tap do |http|
         http.use_ssl = true
         http.ca_file = CA_FILE
         http.verify_mode = OpenSSL::SSL::VERIFY_PEER
       end
     end
 
+    # @return [Net::HTTP::Post] the http POST request already
+    #   configured with the right agent, content type and
+    #   basic authentication headers
     def request
       @request ||= Net::HTTP::Post.new(uri.path).tap do |request|
         request.basic_auth Moiper.token, Moiper.key
         request.content_type = "text/xml"
         request["User-Agent"] = "Moiper/#{Moiper::VERSION}"
       end
     end
 
+    # @!endgroup
+
     private
 
     def post(payload)
       request.body = payload
       client.request(request)
@@ -37,9 +46,11 @@
 
     def uri
       @uri ||= URI(Moiper.api_entrypoint + path)
     end
 
+    # @api private
+    # @return [String] path where the request should be made
     def path
       "ws/alpha/EnviarInstrucao/Unica"
     end
   end
 end