runcible 0.1.4 → 0.2

data/lib/runcible/extensions/consumer.rb

@@ -28,16 +28,16 @@ module Runcible
 
       def self.bind_all(id, repo_id)
         # bind the consumer to all repositories with the given repo_id
-        Runcible::Extensions::Repository.retrieve_with_details(repo_id)['distributors'].each do |d|
+        Runcible::Extensions::Repository.retrieve_with_details(repo_id)['distributors'].collect do |d|
           self.bind(id, repo_id, d['id'])
-        end
+        end.flatten
       end
 
       def self.unbind_all(id, repo_id)
         # unbind the consumer from all repositories with the given repo_id
-        Runcible::Extensions::Repository.retrieve_with_details(repo_id)['distributors'].each do |d|
+        Runcible::Extensions::Repository.retrieve_with_details(repo_id)['distributors'].collect do |d|
           self.unbind(id, repo_id, d['id'])
-        end
+        end.flatten
       end
 
       def self.install_content(id, type_id, units)

data/lib/runcible/extensions/distribution.rb

@@ -1,10 +1,34 @@
+# 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 Extensions
-    class Distribution < Runcible::Base
+    class Distribution < Runcible::Resources::Unit
       TYPE = 'distribution'
 
       def self.all()
-        Runcible::Resources::Unit.search(TYPE, {})
+        search(TYPE, {})
       end
 
       def self.find(id)
@@ -12,11 +36,11 @@ module Runcible
        end
 
       def self.find_all(ids)
-        Runcible::Resources::Unit.search(TYPE, :filters=> {:id=> {'$in'=> ids}})
+        search(TYPE, :filters=> {:id=> {'$in'=> ids}})
       end
 
       def self.find_all_by_unit_ids(ids)
-        Runcible::Resources::Unit.search(TYPE, :filters=> {:_id=> {'$in'=> ids}})
+        search(TYPE, :filters=> {:_id=> {'$in'=> ids}})
       end
 
     end

data/lib/runcible/extensions/errata.rb

@@ -24,11 +24,11 @@
 
 module Runcible
   module Extensions
-    class Errata < Runcible::Base
+    class Errata < Runcible::Resources::Unit
       TYPE = 'erratum'
 
       def self.all()
-        Runcible::Resources::Unit.search(TYPE, {})
+        search(TYPE, {})
       end
 
       def self.find(id)
@@ -36,13 +36,11 @@ module Runcible
        end
 
       def self.find_all(ids)
-        Runcible::Resources::Unit.search(TYPE, {:filters=>{:id=> {'$in'=> ids}}},
-                                         {:include_repos => true})
+        search(TYPE, {:filters=> {:_id=> {'$in'=> ids}}}, {:include_repos=>true})
       end
 
-      def self.find_all_by_unit_ids(ids)
-        Runcible::Resources::Unit.search(TYPE, {:filters=> {:_id=> {'$in'=> ids}}},
-                                         {:include_repos=>true})
+      def self.find_all_by_errata_ids(ids)
+        search(TYPE, {:filters=>{:id=> {'$in'=> ids}}}, {:include_repos => true})
       end
 
     end

data/lib/runcible/extensions/repository.rb

@@ -97,14 +97,14 @@ module Runcible
       #  errata_ids
       def self.errata_copy(source_repo_id, destination_repo_id, optional={})
         criteria = {:type_ids => ['erratum'], :filters => {}}
-        criteria[:filters][:unit] = { :id=>{ '$in' => optional[:errata_ids] } } if optional[:errata_ids]
+        criteria[:filters]['association'] = {'unit_id' => {'$in' => optional[:errata_ids]}} if optional[:errata_ids]
         payload = {:criteria => criteria}
         unit_copy(destination_repo_id, source_repo_id, payload)
       end
 
       def self.errata_remove(repo_id, errata_ids)
         criteria = {:type_ids => ['erratum'], :filters => {}}
-        criteria[:filters][:unit] = { :id=>{ '$in' => errata_ids } }
+        criteria[:filters]['association'] = {'unit_id' => {'$in' => errata_ids}}
         self.unassociate_units(repo_id, criteria)
       end
 
@@ -158,6 +158,11 @@ module Runcible
          self.unit_search(id, criteria).collect{|i| i['unit_id']}
       end
 
+      def self.errata(id, filter = {})
+         criteria = {:type_ids=>['erratum']}
+         self.unit_search(id, criteria).collect{|i| i['metadata'].with_indifferent_access}
+      end
+
       def self.distributions(id)
         criteria = {:type_ids=>['distribution']}
 

data/lib/runcible/extensions/rpm.rb

@@ -24,11 +24,11 @@
 
 module Runcible
   module Extensions
-    class Rpm < Runcible::Base
+    class Rpm < Runcible::Resources::Unit
       TYPE = 'rpm'
 
       def self.all
-        Runcible::Resources::Unit.search(TYPE, {})
+        search(TYPE, {})
       end
 
       def self.find(id)
@@ -36,7 +36,7 @@ module Runcible
       end
 
       def self.find_all(ids)
-        Runcible::Resources::Unit.search(TYPE, {:filters => {'_id'=> {'$in'=> ids}}}, {:include_repos=>true})
+        search(TYPE, {:filters => {'_id'=> {'$in'=> ids}}}, {:include_repos=>true})
       end
     end
   end

data/lib/runcible/resources/consumer.rb

@@ -24,65 +24,139 @@
 
 module Runcible
   module Resources
+    # @see https://pulp-dev-guide.readthedocs.org/en/latest/rest-api/consumer/index.html
     class Consumer < Runcible::Base
 
+      # Generates the API path for Consumers
+      #
+      # @param  [String]  id  the ID of the consumer
+      # @return [String]      the consumer path, may contain the id if passed      
       def self.path(id=nil)
         (id == nil) ? "consumers/" : "consumers/#{id}/"
       end
 
+      # Creates a consumer
+      #
+      # @param  [String]                id        the ID of the consumer
+      # @param  [Hash]                  optional  container for all optional parameters
+      # @return [RestClient::Response]
       def self.create(id, optional={})
         required = required_params(binding.send(:local_variables), binding)
         call(:post, path, :payload => { :required => required, :optional => optional })
       end
 
+      # Retrieves a consumer
+      #
+      # @param  [String]                id  the ID of the consumer
+      # @return [RestClient::Response]
       def self.retrieve(id)
         call(:get, path(id))
       end
 
+      # Updates a consumer
+      #
+      # @param  [String]                id        the ID of the consumer
+      # @param  [Hash]                  optional  container for all optional parameters
+      # @return [RestClient::Response]
       def self.update(id, optional={})
         call(:put, path(id), :payload => { :delta => optional })
       end
 
+      # Deletes a consumer
+      #
+      # @param  [String]                id  the id of the consumer
+      # @return [RestClient::Response]
+      def self.delete(id)
+        call(:delete, path(id))
+      end
+
+      # Create consumer profile
+      #
+      # @param  [String]                id            the ID of the consumer
+      # @param  [String]                content_type  the content type
+      # @param  [Hash]                  profile       hash representing the consumer profile
+      # @return [RestClient::Response]
       def self.upload_profile(id, content_type, profile)
         required = required_params(binding.send(:local_variables), binding, ["id"])
         call(:post, path("#{id}/profiles/"), :payload => { :required => required })
       end
 
-      def self.profile(id, content_type)
+      # Retrieve a consumer profile
+      #
+      # @param  [String]                id            the ID of the consumer
+      # @param  [String]                content_type  the content type
+      # @return [RestClient::Response]
+      def self.retrieve_profile(id, content_type)
         call(:get, path("#{id}/profiles/#{content_type}/"))
       end
 
-      def self.delete(id)
-        call(:delete, path(id))
-      end
-
+      # Retrieve a consumer binding
+      #
+      # @param  [String]                id              the ID of the consumer
+      # @param  [String]                repo_id         the ID of the repository
+      # @param  [String]                distributor_id  the ID of the distributor
+      # @return [RestClient::Response]
       def self.retrieve_binding(id, repo_id, distributor_id)
         call(:get, path("#{id}/bindings/#{repo_id}/#{distributor_id}"))
       end
 
+      # Retrieve all consumer bindings
+      #
+      # @param  [String]                id  the ID of the consumer
+      # @return [RestClient::Response]
       def self.retrieve_bindings(id)
         call(:get, path("#{id}/bindings/"))
       end
 
+      # Bind a consumer to a repository for a given distributor
+      #
+      # @param  [String]                id              the ID of the consumer
+      # @param  [String]                repo_id         the ID of the repository
+      # @param  [String]                distributor_id  the ID of the distributor
+      # @return [RestClient::Response]
       def self.bind(id, repo_id, distributor_id)
         required = required_params(binding.send(:local_variables), binding, ["id"])
-        call(:post, path("#{id}/bindings"), :payload => { :required => required })
+        call(:post, path("#{id}/bindings/"), :payload => { :required => required })
       end
 
+      # Unbind a consumer to a repository for a given distributor
+      #
+      # @param  [String]                id              the ID of the consumer
+      # @param  [String]                repo_id         the ID of the repository
+      # @param  [String]                distributor_id  the ID of the distributor
+      # @return [RestClient::Response]
       def self.unbind(id, repo_id, distributor_id)
         call(:delete, path("#{id}/bindings/#{repo_id}/#{distributor_id}"))
       end
 
+      # Install a set of units onto a consumer
+      #
+      # @param  [String]                id      the ID of the consumer
+      # @param  [Array]                 units   array of units to install
+      # @param  [Hash]                  options hash of install options
+      # @return [RestClient::Response]
       def self.install_units(id, units, options={})
         required = required_params(binding.send(:local_variables), binding, ["id"])
         call(:post, path("#{id}/actions/content/install/"), :payload => { :required => required })
       end
 
+      # Update a set of units on a consumer
+      #
+      # @param  [String]                id      the ID of the consumer
+      # @param  [Array]                 units   array of units to update
+      # @param  [Hash]                  options hash of update options
+      # @return [RestClient::Response]
       def self.update_units(id, units, options={})
         required = required_params(binding.send(:local_variables), binding, ["id"])
         call(:post, path("#{id}/actions/content/update/"), :payload => { :required => required })
       end
 
+      # Uninstall a set of units from a consumer
+      #
+      # @param  [String]                id      the ID of the consumer
+      # @param  [Array]                 units   array of units to uninstall
+      # @param  [Hash]                  options hash of uninstall options
+      # @return [RestClient::Response]
       def self.uninstall_units(id, units, options={})
         required = required_params(binding.send(:local_variables), binding, ["id"])
         call(:post, path("#{id}/actions/content/uninstall/"), :payload => { :required => required })

data/lib/runcible/resources/consumer_group.rb

@@ -25,62 +25,90 @@ require 'active_support/core_ext/hash'
 
 module Runcible
   module Resources
+    # @see https://pulp-dev-guide.readthedocs.org/en/latest/rest-api/consumer/group/index.html
     class ConsumerGroup < Runcible::Base
 
+      # Generates the API path for Consumer Groups
+      #
+      # @param  [String]  id  the ID of the consumer group
+      # @return [String]      the consumer group path, may contain the id if passed      
       def self.path(id=nil)
         groups = "consumer_groups/"
         id.nil? ? groups : groups + "#{id}/"
       end
       
+      # Creates a Consumer Group
+      #
+      # @param  [String]                id        the ID of the consumer
+      # @param  [Hash]                  optional  container for all optional parameters
+      # @return [RestClient::Response]
       def self.create(id, optional={})
         required = required_params(binding.send(:local_variables), binding)
         call(:post, path, :payload => { :required => required, :optional => optional })
       end
 
-      def self.delete(id)
-        call(:delete, path(id))
-      end
-
+      # Retrieves a Consumer Group
+      #
+      # @param  [String]                id  the ID of the consumer group
+      # @return [RestClient::Response]
       def self.retrieve(id)
         call(:get, path(id))
       end
 
+      # Deletes a Consumer Group
+      #
+      # @param  [String]                id  the ID of the consumer group
+      # @return [RestClient::Response]
+      def self.delete(id)
+        call(:delete, path(id))
+      end
 
+      # Associates Consumers with a Consumer Group
+      #
+      # @param  [String]                id        the ID of the consumer group
+      # @param  [Hash]                  criteria  criteria based on Mongo syntax representing consumers to associate
+      # @return [RestClient::Response]
       def self.associate(id, criteria)
         call(:post, path(id) + "actions/associate/", :payload => {:required => criteria})
       end
 
+      # Unassociates Consumers with a Consumer Group
+      #
+      # @param  [String]                id        the ID of the consumer group
+      # @param  [Hash]                  criteria  criteria based on Mongo syntax representing consumers ta unassociate
+      # @return [RestClient::Response]
       def self.unassociate(id, criteria)
         call(:post, path(id) + "actions/unassociate/", :payload => {:required => criteria})
       end
 
-      #def self.retrieve_binding(id, repo_id, distributor_id)
-      #  call(:get, path("#{id}/bindings/#{repo_id}/#{distributor_id}"))
-      #end
-      #
-      #def self.retrieve_bindings(id)
-      #  call(:get, path("#{id}/bindings/"))
-      #end
+      # Install a set of units to a Consumer Group
       #
-      #def self.bind(id, repo_id, distributor_id)
-      #  required = required_params(binding.send(:local_variables), binding, ["id"])
-      #  call(:post, path("#{id}/bindings"), :payload => { :required => required })
-      #end
-      #
-      #def self.unbind(id, repo_id, distributor_id)
-      #  call(:delete, path("#{id}/bindings/#{repo_id}/#{distributor_id}"))
-      #end
-
+      # @param  [String]                id      the ID of the consumer group
+      # @param  [Array]                 units   array of units to install
+      # @param  [Hash]                  options hash of install options
+      # @return [RestClient::Response]
       def self.install_units(id, units, options={})
         required = required_params(binding.send(:local_variables), binding, ["id"])
         call(:post, path("#{id}/actions/content/install/"), :payload => { :required => required })
       end
 
+      # Update a set of units on a Consumer Group
+      #
+      # @param  [String]                id      the ID of the consumer group
+      # @param  [Array]                 units   array of units to update
+      # @param  [Hash]                  options hash of update options
+      # @return [RestClient::Response]
       def self.update_units(id, units, options={})
         required = required_params(binding.send(:local_variables), binding, ["id"])
         call(:post, path("#{id}/actions/content/update/"), :payload => { :required => required })
       end
 
+      # Uninstall a set of units from a Consumer Group
+      #
+      # @param  [String]                id      the ID of the consumer group
+      # @param  [Array]                 units   array of units to uninstall
+      # @param  [Hash]                  options hash of uninstall options
+      # @return [RestClient::Response]
       def self.uninstall_units(id, units, options={})
         required = required_params(binding.send(:local_variables), binding, ["id"])
         call(:post, path("#{id}/actions/content/uninstall/"), :payload => { :required => required })

data/lib/runcible/resources/event_notifier.rb

@@ -1,6 +1,30 @@
+# 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/events/index.html
     class EventNotifier < Runcible::Base
 
       class EventTypes
@@ -14,22 +38,41 @@ module Runcible
         REST_API = 'rest-api'
       end
 
+      # Generates the API path for Event Notifiers
+      #
+      # @param  [String]  id  the ID of the event notifier
+      # @return [String]      the event notifier path, may contain the ID if passed
+      def self.path(id=nil)
+        (id == nil) ? "events/" : "events/#{id}/"
+      end
+
+      # Creates an Event Notification
+      #
+      # @param  [String]                notifier_type_id  the type ID of the event notifier
+      # @param  [Hash]                  notifier_config   configuration options for the notifier
+      # @param  [Hash]                  event_types       event types to include in the notifier
+      # @return [RestClient::Response]            
       def self.create(notifier_type_id, notifier_config, event_types)
         required = required_params(binding.send(:local_variables), binding)
         call(:post, path, :payload => {:required => required})
       end
 
+      # Deletes an Event Notification
+      #
+      # @param  [String]                id  the ID of the event notifier
+      # @return [RestClient::Response]            
       def self.delete(id)
         call(:delete, path(id))
       end
 
+      # List all Event Notifiers
+      #
+      # @param  [String]                id  the ID of the event notifier
+      # @return [RestClient::Response]            
       def self.list
         call(:get, path)
       end
 
-      def self.path(id=nil)
-        (id == nil) ? "events/" : "events/#{id}/"
-      end
     end
   end
 end

data/lib/runcible/resources/repository.rb

@@ -25,78 +25,159 @@ require 'active_support/core_ext/hash'
 
 module Runcible
   module Resources
+    # @see https://pulp-dev-guide.readthedocs.org/en/latest/rest-api/repo/index.html
     class Repository < Runcible::Base
 
+      # Generates the API path for Repositories
+      #
+      # @param  [String]  id  the id of the repository
+      # @return [String]      the repository path, may contain the id if passed      
       def self.path(id=nil)
         (id == nil) ? "repositories/" : "repositories/#{id}/" 
       end
 
+      # Creates a repository
+      #
+      # @param  [String]                id        the id of the repository
+      # @param  [Hash]                  optional  container for all optional parameters
+      # @return [RestClient::Response]            
       def self.create(id, optional={})
         required = required_params(binding.send(:local_variables), binding)
         call(:post, path, :payload => { :required => required, :optional => optional })
       end
 
+      # Retrieves a repository
+      #
+      # @param  [String]                id      the id of the repository
+      # @param  [Hash]                  params  container for optional query parameters
+      # @return [RestClient::Response]          
       def self.retrieve(id, params={})
         call(:get, path(id), :params => params)
       end
 
+      # Updates a repository
+      #
+      # @param  [String]                id        the id of the repository
+      # @param  [Hash]                  optional  container for all optional parameters
+      # @return [RestClient::Response]            
       def self.update(id, optional={})
         call(:put, path(id), :payload => { :delta => optional })
       end
 
+      # Deletes a repository
+      #
+      # @param  [String]                id  the id of the repository
+      # @return [RestClient::Response]            
       def self.delete(id)
         call(:delete, path(id))
       end
 
+      # Retrieve all repositories
+      #
+      # @param  [Hash]                  optional  container for all optional parameters
+      # @return [RestClient::Response]            
       def self.retrieve_all(optional={})
         call(:get, path, :payload => { :optional => optional })
       end
 
+      # Searches for repositories based on criteria
+      #
+      # @param  [Hash]                  criteria  criteria object containing Mongo syntax
+      # @param  [Hash]                  optional  container for all optional parameters
+      # @return [RestClient::Response]            
       def self.search(criteria, optional={})
         required = required_params(binding.send(:local_variables), binding)
         call(:post, path("search"), :payload => { :required => required, :optional => optional })
       end
 
+      # Associates an importer to a repository
+      #
+      # @param  [String]                id                the ID of the repository
+      # @param  [String]                importer_type_id  the type ID of the importer being associated
+      # @param  [Hash]                  importer_config   configuration options for the importer
+      # @return [RestClient::Response]            
       def self.associate_importer(id, importer_type_id, importer_config)
         required = required_params(binding.send(:local_variables), binding)
         call(:post, path("#{id}/importers"), :payload => { :required => required })
       end
 
+      # Associates a distributor to a repository
+      #
+      # @param  [String]                id                  the ID of the repository
+      # @param  [String]                distributor_type_id the type ID of the distributor being associated
+      # @param  [Hash]                  distributor_config  configuration options for the distributor
+      # @param  [Hash]                  optional            container for all optional parameters
+      # @return [RestClient::Response]            
       def self.associate_distributor(id, distributor_type_id, distributor_config, optional={})
         required = required_params(binding.send(:local_variables), binding, ["id"])
         call(:post, path("#{id}/distributors"), :payload => { :required => required, :optional => optional })
       end
 
+      # Syncs a repository
+      #
+      # @param  [String]                id        the id of the repository
+      # @param  [Hash]                  optional  container for all optional parameters
+      # @return [RestClient::Response]            
       def self.sync(id, optional={})
         call(:post, "#{path(id)}actions/sync/", :payload => { :optional => optional })
       end
 
+      # History of all sync actions on a repository
+      #
+      # @param  [String]                id  the id of the repository
+      # @return [RestClient::Response]            
       def self.sync_history(id)
         call(:get, "#{path(id)}/history/sync/")
       end
 
-      def self.unit_copy(destination_repo_id, source_repo_id, optional={:criteria=>{}})
+      # Copies units from one repository to another
+      #
+      # @param  [String]                destination_repo_id the id of the destination repository
+      # @param  [String]                source_repo_id      the id of the source repository
+      # @param  [Hash]                  optional            container for all optional parameters
+      # @return [RestClient::Response]            
+      def self.unit_copy(destination_repo_id, source_repo_id, optional={})
         required = required_params(binding.send(:local_variables), binding, ["destination_repo_id"])
         call(:post, "#{path(destination_repo_id)}actions/associate/",
-             :payload => { :required => required, :optional=> optional })
+             :payload => { :required => required, :optional => optional })
       end
 
+      # Unassociates units from the repository
+      #
+      # @param  [String]                source_repo_id  the id of the source repository
+      # @param  [Hash]                  criteria        criteria object containing Mongo syntax
+      # @return [RestClient::Response]            
       def self.unassociate_units(source_repo_id, criteria={})
         required = required_params(binding.send(:local_variables), binding, ["source_repo_id"])
         call(:post, "#{path(source_repo_id)}actions/unassociate/",
-             :payload => { :required => { :criteria => criteria }})
+             :payload => { :required => required })
       end
 
+      # Searches the repository for units based on criteria
+      #
+      # @param  [String]                id        the id of the repository
+      # @param  [Hash]                  criteria  criteria object containing Mongo syntax
+      # @return [RestClient::Response]            
       def self.unit_search(id, criteria={})
         call(:post, "#{path(id)}search/units/", :payload=>{:required=>{:criteria=>criteria}})
       end
 
-      def self.publish(repo_id, distributor_id)
-        call(:post, "#{path(repo_id)}actions/publish/", :payload=>{:required=>{:id=>distributor_id}})
+      # Publishes a repository using the specified distributor
+      #
+      # @param  [String]                id              the id of the repository
+      # @param  [String]                distributor_id  the id of the distributor
+      # @return [RestClient::Response]            
+      def self.publish(id, distributor_id)
+        call(:post, "#{path(id)}actions/publish/", :payload=>{:required=>{:id=>distributor_id}})
       end
 
-      def self.delete_distributor(repo_id, distributor_id)
-        call(:delete, "#{path(repo_id)}/distributors/#{distributor_id}/")
+      # Deletes the specified distributor from the repository
+      #
+      # @param  [String]                id              the id of the repository
+      # @param  [String]                distributor_id  the id of the distributor
+      # @return [RestClient::Response]            
+      def self.delete_distributor(id, distributor_id)
+        call(:delete, "#{path(id)}/distributors/#{distributor_id}/")
       end
 
     end

data/lib/runcible/resources/repository_schedule.rb

@@ -25,32 +25,64 @@ require 'active_support/core_ext/hash'
 
 module Runcible
   module Resources
+    # @see https://pulp-dev-guide.readthedocs.org/en/latest/rest-api/repo/sync.html#scheduling-a-sync
     class RepositorySchedule < Runcible::Base
 
-      def self.path(repo_id, importer, schedule_id=nil)
+      # Generates the API path for Repository Schedules
+      #
+      # @param  [String]  repo_id     the ID of the repository
+      # @param  [String]  importer_id the ID of the importer
+      # @param  [String]  schedule_id the ID of the schedule
+      # @return [String]              the repository schedule path, may contain the ID of the schedule if passed
+      def self.path(repo_id, importer_id, schedule_id=nil)
         repo_path = Runcible::Resources::Repository.path(repo_id)
-        path = "#{repo_path}importers/#{importer}/schedules/sync/"
+        path = "#{repo_path}importers/#{importer_id}/schedules/sync/"
         (schedule_id == nil) ? path : "#{path}#{schedule_id}/"
       end
 
+      # List the schedules for a repository for a given importer type
+      #
+      # @param  [String]                repo_id       the ID of the repository
+      # @param  [String]                importer_type the importer type
+      # @return [RestClient::Response]
       def self.list(repo_id, importer_type)
         call(:get, path(repo_id, importer_type))
       end
 
+      # Create a schedule for a repository for a given importer type
+      #
+      # @param  [String]                repo_id       the ID of the repository
+      # @param  [String]                importer_type the importer type
+      # @param  [Hash]                  schedule      a hash representing a schedule
+      # @param  [Hash]                  optional      container for all optional parameters
+      # @return [RestClient::Response]
       def self.create(repo_id, importer_type, schedule, optional={})
         call(:post, path(repo_id, importer_type),
              :payload => { :required => {:schedule=>schedule}, :optional => optional })
       end
 
-      # specific call to just update the sync schedule for a repo
+      # Update a schedule for a repository for a given importer type
+      #
+      # @param  [String]                repo_id       the ID of the repository
+      # @param  [String]                importer_type the importer type
+      # @param  [String]                schedule_id   the ID of the schedule
+      # @param  [Hash]                  optional      container for all optional parameters
+      # @return [RestClient::Response]
       def self.update(repo_id, importer_type, schedule_id, optional={})
         call(:put, path(repo_id, importer_type, schedule_id),
              :payload => {:optional => optional })
       end
 
+      # Delete a schedule for a repository for a given importer type
+      #
+      # @param  [String]                repo_id       the ID of the repository
+      # @param  [String]                importer_type the importer type
+      # @param  [String]                schedule_id   the ID of the schedule
+      # @return [RestClient::Response]
       def self.delete(repo_id, importer_type, schedule_id)
         call(:delete, path(repo_id, importer_type, schedule_id))
       end
+
     end
   end
 end

data/lib/runcible/resources/role.rb

@@ -24,17 +24,32 @@
 
 module Runcible
   module Resources
+    # @see https://pulp-dev-guide.readthedocs.org/en/latest/rest-api/role/index.html
     class Role < Runcible::Base
 
-      def self.path(role=nil)
-        (role == nil) ? "roles/" : "roles/#{role}/" 
+      # Generates the API path for Roles
+      #
+      # @param  [String]  id  the ID of the role
+      # @return [String]      the role path, may contain the ID if passed
+      def self.path(id=nil)
+        (id == nil) ? "roles/" : "roles/#{id}/" 
       end
 
+      # Adds a user to a role
+      #
+      # @param  [String]                id    the ID of the role
+      # @param  [String]                login the login of the user being added
+      # @return [RestClient::Response]            
       def self.add(id, login)
         required = required_params(binding.send(:local_variables), binding, ["id"])
         call(:post, "#{path(id)}users/", :payload => { :required => required })
       end
 
+      # Removes a user from a role
+      #
+      # @param  [String]                id    the ID of the role
+      # @param  [String]                login the login of the user being removed
+      # @return [RestClient::Response]            
       def self.remove(id, login)
         call(:delete, "#{path(id)}users/#{login}/")
       end

data/lib/runcible/resources/task.rb

@@ -24,29 +24,49 @@
 
 module Runcible
   module Resources
+    # @see https://pulp-dev-guide.readthedocs.org/en/latest/rest-api/dispatch/index.html
     class Task < Runcible::Base
 
+      # Generates the API path for Tasks
+      #
+      # @param  [String]  id  the id of the task
+      # @return [String]      the task path, may contain the id if passed      
       def self.path(id=nil)
         (id == nil) ? "tasks/" : "tasks/#{id}/" 
       end
 
+      # Polls for the status of a task
+      #
+      # @param  [String]              id  the id of the task
+      # @return [RestClient::Response]            
       def self.poll(id)
         call(:get, path(id))
       end
 
+      # Cancels a task
+      #
+      # @param  [String]              id  the id of the task
+      # @return [RestClient::Response]            
       def self.cancel(id)
         #cancelling a task may require cancelling some higher level
         #  task, so query the tasks _href field to make sure
         call(:delete, poll(id)['_href'])
       end
 
+      # List all tasks based on a set of tags
+      #
+      # @param  [Array]                 tags array of tags to scope the list on
+      # @return [RestClient::Response]            
       def self.list(tags=[])
         call(:get, path, :params=>{:tag=>tags})
       end
 
+      # Polls all tasks based on array of IDs
+      # temporary solution until https://bugzilla.redhat.com/show_bug.cgi?id=860089
+      #
+      # @param  [Array] ids array of ids to poll the status of
+      # @return [Array]     array of RestClient::Response task poll objects           
       def self.poll_all(ids)
-        # temporary solution until https://bugzilla.redhat.com/show_bug.cgi?id=860089
-        #  is resolved
         return ids.collect{|id| self.poll(id)}
       end
 

data/lib/runcible/resources/unit.rb

@@ -1,11 +1,46 @@
+# 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

data/lib/runcible/resources/user.rb

@@ -24,27 +24,48 @@
 
 module Runcible
   module Resources
+    # @see https://pulp-dev-guide.readthedocs.org/en/latest/rest-api/user/index.html
     class User < Runcible::Base
 
+      # Generates the API path for Users
+      #
+      # @param  [String]  login the user's login
+      # @return [String]        the user path, may contain the login if passed
       def self.path(login=nil)
         (login == nil) ? "users/" : "users/#{login}/" 
       end
 
+      # Retrieves all users
+      #
+      # @return [RestClient::Response]            
       def self.retrieve_all
         call(:get, path)
       end
 
+      # Creates a user
+      #
+      # @param  [String]                login     the login requested for the user
+      # @param  [Hash]                  optional  container for all optional parameters
+      # @return [RestClient::Response]            
       def self.create(login, optional={})
         required = required_params(binding.send(:local_variables), binding)
         call(:post, path, :payload => { :required => required, :optional => optional })
       end
 
-      def self.retrieve(id)
-        call(:get, path(id))
+      # Retrieves a user
+      #
+      # @param  [String]                login the login of the user being retrieved
+      # @return [RestClient::Response]            
+      def self.retrieve(login)
+        call(:get, path(login))
       end
 
-      def self.delete(id)
-        call(:delete, path(id))
+      # Deletes a user
+      #
+      # @param  [String]                login the login of the user being deleted
+      # @return [RestClient::Response]            
+      def self.delete(login)
+        call(:delete, path(login))
       end
 
     end

data/lib/runcible/version.rb

@@ -1,3 +1,3 @@
 module Runcible
-  VERSION = "0.1.4"
+  VERSION = "0.2"
 end

metadata

@@ -1,33 +1,23 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: runcible
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: '0.2'
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 4
-  version: 0.1.4
 platform: ruby
-authors: 
+authors:
 - Eric D Helms
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-11-12 00:00:00 Z
+date: 2012-11-16 00:00:00.000000000 Z
 dependencies: []
-
 description: Exposing Pulp's juiciest components to the Ruby world.
-email: 
+email:
 - ehelms@redhat.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/runcible.rb
 - lib/runcible/base.rb
 - lib/runcible/extensions/errata.rb
@@ -54,36 +44,27 @@ files:
 - lib/runcible/resources/unit.rb
 homepage: https://github.com/Katello/runcible
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: ""
+summary: ''
 test_files: []
-
+has_rdoc: