unit.rb in runcible-0.2

- old
+ new
@@ -1,12 +1,47 @@
+# Copyright (c) 2012 Red Hat
+#
+# MIT License
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
 module Runcible
   module Resources
+    # @see https://pulp-dev-guide.readthedocs.org/en/latest/rest-api/content/index.html
     class Unit < Runcible::Base
 
+      # Generates the API path for Units
+      #
+      # @param  [String]  type  the unit type
+      # @return [String]        the unit search path
       def self.path(type)
         "content/units/#{type}/search/"
       end
 
+      # Searches a given unit type based on criteria
+      #
+      # @param  [String]                type      the unit type
+      # @param  [Hash]                  criteria  criteria object containing Mongo syntax
+      # @param  [Hash]                  optional  container for all optional parameters
+      # @return [RestClient::Response]            
       def self.search(type, criteria, optional={})
         call(:post, path(type), :payload=>{:required=>{:criteria=>criteria}, :optional=>optional})
       end
     end
 