runcible 0.2.1 → 0.3

data/lib/runcible.rb

@@ -29,6 +29,7 @@ resources += Dir[File.dirname(__FILE__) + '/runcible/base.rb']
 resources += Dir[File.dirname(__FILE__) + '/runcible/resources/*.rb']
 resources += Dir[File.dirname(__FILE__) + '/runcible/extensions/importer.rb']
 resources += Dir[File.dirname(__FILE__) + '/runcible/extensions/distributor.rb']
+resources += Dir[File.dirname(__FILE__) + '/runcible/extensions/unit.rb']
 resources += Dir[File.dirname(__FILE__) + '/runcible/extensions/*.rb']
 
-resources.each{ |f| require f }
+resources.uniq.each{ |f| require f }

data/lib/runcible/extensions/consumer.rb

@@ -26,32 +26,63 @@ module Runcible
   module Extensions
     class Consumer < Runcible::Resources::Consumer
 
+      # Bind a consumer to all repositories with a given ID
+      #
+      # @param  [String]               id       the consumer ID
+      # @param  [String]               repo_id  the repo ID to bind to
+      # @return [RestClient::Response]          set of tasks representing each bind operation
       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'].collect do |d|
           self.bind(id, repo_id, d['id'])
         end.flatten
       end
 
+      # Unbind a consumer to all repositories with a given ID
+      #
+      # @param  [String]               id       the consumer ID
+      # @param  [String]               repo_id  the repo ID to unbind from
+      # @return [RestClient::Response]          set of tasks representing each unbind operation
       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'].collect do |d|
           self.unbind(id, repo_id, d['id'])
         end.flatten
       end
 
+      # Install content to a consumer
+      #
+      # @param  [String]               id       the consumer ID
+      # @param  [String]               type_id  the type of content to install (e.g. rpm, errata)
+      # @param  [Array]                units    array of units to install
+      # @return [RestClient::Response]          task representing the install operation
       def self.install_content(id, type_id, units)
         self.install_units(id, generate_content(type_id, units))
       end
 
+      # Update content on a consumer
+      #
+      # @param  [String]               id       the consumer ID
+      # @param  [String]               type_id  the type of content to update (e.g. rpm, errata)
+      # @param  [Array]                units    array of units to update
+      # @return [RestClient::Response]          task representing the update operation
       def self.update_content(id, type_id, units)
         self.update_units(id, generate_content(type_id, units))
       end
 
+      # Uninstall content from a consumer
+      #
+      # @param  [String]               id       the consumer ID
+      # @param  [String]               type_id  the type of content to uninstall (e.g. rpm, errata)
+      # @param  [Array]                units    array of units to uninstall
+      # @return [RestClient::Response]          task representing the uninstall operation
       def self.uninstall_content(id, type_id, units)
         self.uninstall_units(id, generate_content(type_id, units))
       end
 
+      # Generate the content units used by other functions
+      #
+      # @param  [String]  type_id the type of content (e.g. rpm, errata)
+      # @param  [Array]   units   array of units
+      # @return [Array]           array of formatted content units
       def self.generate_content(type_id, units)
         content = []
         units.each do |unit|

data/lib/runcible/extensions/consumer_group.rb

@@ -26,14 +26,28 @@ module Runcible
   module Extensions
     class ConsumerGroup < Runcible::Resources::ConsumerGroup
 
+      # Add consumers by ID to a consumer group
+      #
+      # @param  [String]                id            the consumer group ID
+      # @param  [Array]                 consumer_ids  array of consumer IDs to add to the group
+      # @return [RestClient::Response]                list of consumer IDs
       def self.add_consumers_by_id(id, consumer_ids)
         self.associate(id, make_consumer_criteria(consumer_ids))
       end
 
+      # Remove consumers by ID from a consumer group
+      #
+      # @param  [String]                id            the consumer group ID
+      # @param  [Array]                 consumer_ids  array of consumer IDs to remove from the group
+      # @return [RestClient::Response]                list of consumer IDs
       def self.remove_consumers_by_id(id, consumer_ids)
         self.unassociate(id, make_consumer_criteria(consumer_ids))
       end
 
+      # Generates consumer criteria query
+      #
+      # @param  [Array] consumer_ids  array of consumer IDs
+      # @return [Hash]                the formatted query for consumers
       def self.make_consumer_criteria(consumer_ids)
         {:criteria =>
               {:filters =>
@@ -42,18 +56,41 @@ module Runcible
         }
       end
 
+      # Install content to a consumer group
+      #
+      # @param  [String]               id       the consumer group ID
+      # @param  [String]               type_id  the type of content to install (e.g. rpm, errata)
+      # @param  [Array]                units    array of units to install
+      # @return [RestClient::Response]          task representing the install operation
       def self.install_content(id, type_id, units)
         self.install_units(id, generate_content(type_id, units))
       end
 
+      # Update content on a consumer group
+      #
+      # @param  [String]               id       the consumer group ID
+      # @param  [String]               type_id  the type of content to update (e.g. rpm, errata)
+      # @param  [Array]                units    array of units to update
+      # @return [RestClient::Response]          task representing the update operation
       def self.update_content(id, type_id, units)
         self.update_units(id, generate_content(type_id, units))
       end
 
+      # Uninstall content from a consumer group
+      #
+      # @param  [String]               id       the consumer group ID
+      # @param  [String]               type_id  the type of content to uninstall (e.g. rpm, errata)
+      # @param  [Array]                units    array of units to uninstall
+      # @return [RestClient::Response]          task representing the uninstall operation
       def self.uninstall_content(id, type_id, units)
         self.uninstall_units(id, generate_content(type_id, units))
       end
 
+      # Generate the content units used by other functions
+      #
+      # @param  [String]  type_id the type of content (e.g. rpm, errata)
+      # @param  [Array]   units   array of units
+      # @return [Array]           array of formatted content units
       def self.generate_content(type_id, units)
         content = []
         units.each do |unit|

data/lib/runcible/extensions/distribution.rb

@@ -24,23 +24,10 @@
 
 module Runcible
   module Extensions
-    class Distribution < Runcible::Resources::Unit
-      TYPE = 'distribution'
+    class Distribution < Runcible::Extensions::Unit
 
-      def self.all()
-        search(TYPE, {})
-      end
-
-      def self.find(id)
-         find_all([id]).first
-       end
-
-      def self.find_all(ids)
-        search(TYPE, :filters=> {:id=> {'$in'=> ids}})
-      end
-
-      def self.find_all_by_unit_ids(ids)
-        search(TYPE, :filters=> {:_id=> {'$in'=> ids}})
+      def self.content_type
+        'distribution'
       end
 
     end

data/lib/runcible/extensions/errata.rb

@@ -24,23 +24,10 @@
 
 module Runcible
   module Extensions
-    class Errata < Runcible::Resources::Unit
-      TYPE = 'erratum'
+    class Errata < Runcible::Extensions::Unit
 
-      def self.all()
-        search(TYPE, {})
-      end
-
-      def self.find(id)
-         find_all([id]).first
-       end
-
-      def self.find_all(ids)
-        search(TYPE, {:filters=> {:_id=> {'$in'=> ids}}}, {:include_repos=>true})
-      end
-
-      def self.find_all_by_errata_ids(ids)
-        search(TYPE, {:filters=>{:id=> {'$in'=> ids}}}, {:include_repos => true})
+      def self.content_type
+        'erratum'
       end
 
     end

data/lib/runcible/extensions/importer.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Justin Sherrill
+# Copyright (c) 2012
 #
 # MIT License
 #
@@ -27,7 +27,9 @@ require 'active_support/json'
 
 module Runcible
   module Extensions
-    #Importers should supply  id & config methods
+
+    # Generic class to represent Pulp Importers 
+    # Child classes should supply id & config methods
     class Importer
       def initialize(params={})
         params.each{|k,v| self.send("#{k.to_s}=",v)}
@@ -35,4 +37,4 @@ module Runcible
     end
 
   end
-end
+end

data/lib/runcible/extensions/package_category.rb

@@ -1,22 +1,33 @@
-module Runcible
-  module Extensions
-    class PackageCategory < Runcible::Base
-      TYPE = 'package_category'
-
-      def self.all
-        Runcible::Resources::Unit.search(TYPE, {})
-      end
+# Copyright (c) 2012
+#
+# 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.
 
-      def self.find(id)
-        find_all([id]).first
-      end
 
-      def self.find_all(ids)
-        Runcible::Resources::Unit.search(TYPE, :filters => {'id'=> {'$in'=> ids}})
-      end
+module Runcible
+  module Extensions
+    class PackageCategory < Runcible::Extensions::Unit
 
-      def self.find_all_by_unit_ids(ids)
-        Runcible::Resources::Unit.search(TYPE, :filters => {:_id=> {'$in'=> ids}})
+      def self.content_type
+        'package_category'
       end
 
     end

data/lib/runcible/extensions/package_group.rb

@@ -1,22 +1,33 @@
-module Runcible
-  module Extensions
-    class PackageGroup < Runcible::Base
-      TYPE = 'package_group'
-
-      def self.all
-        Runcible::Resources::Unit.search(TYPE, {})
-      end
+# Copyright (c) 2012
+#
+# 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.
 
-      def self.find(id)
-        find_all([id]).first
-      end
 
-      def self.find_all(ids)
-        Runcible::Resources::Unit.search(TYPE, :filters => {'id'=> {'$in'=> ids}})
-      end
+module Runcible
+  module Extensions
+    class PackageGroup < Runcible::Extensions::Unit
 
-      def self.find_all_by_unit_ids(ids)
-        Runcible::Resources::Unit.search(TYPE, :filters => {:_id=> {'$in'=> ids}})
+      def self.content_type
+        'package_group'
       end
 
     end

data/lib/runcible/extensions/repository.rb

@@ -26,14 +26,31 @@ module Runcible
   module Extensions
     class Repository < Runcible::Resources::Repository
 
+      # Utility function that allows an importer to be added at repository creation time
+      #
+      # @param  [String]                               id       the id of the repository being created
+      # @param  [Hash, Runcible::Extensions::Importer] importer either a hash representing an importer or an Importer object
+      # @return [RestClient::Response]                          the created repository         
       def self.create_with_importer(id, importer)
         create_with_importer_and_distributors(id, importer)
       end
 
+      # Utility function that allows distributors to be added at repository creation time
+      #
+      # @param  [String]                id            the id of the repository being created
+      # @param  [Array]                 distributors  an array of hashes representing distributors or an array of Distributor objects
+      # @return [RestClient::Response]                the created repository         
       def self.create_with_distributors(id, distributors)
         create_with_importer_and_distributors(id, nil, distributors)
       end
 
+      # Utility function that allows an importer and distributors to be added at repository creation time
+      #
+      # @param  [String]                                id            the id of the repository being created
+      # @param  [Hash, Runcible::Extensions::Importer]  importer      either a hash representing an importer or an Importer object
+      # @param  [Array]                                 distributors  an array of hashes representing distributors or an array of Distributor objects
+      # @param  [Hash]                                  optional      container for all optional parameters
+      # @return [RestClient::Response]                                the created repository         
       def self.create_with_importer_and_distributors(id, importer, distributors=[], optional={})
         if importer.is_a?(Importer)
           optional[:importer_type_id] = importer.id
@@ -62,10 +79,18 @@ module Runcible
         create(id, optional)
       end
 
+      # Retrieves the sync status for a repository
+      #
+      # @param  [String]                repo_id the repository ID
+      # @return [RestClient::Response]          a task representing the sync status
       def self.sync_status(repo_id)
         Runcible::Resources::Task.list(["pulp:repository:#{repo_id}", "pulp:action:sync"])
       end
 
+      # Retrieves a set of repositories by their IDs
+      #
+      # @param  [Array]                repository_ids the repository ID
+      # @return [RestClient::Response]                the set of repositories requested
       def self.search_by_repository_ids(repository_ids)
         criteria = {:filters => 
                       { "id" => {"$in" => repository_ids}}
@@ -73,9 +98,16 @@ module Runcible
         search(criteria)
       end
 
+      # Copies RPMs from one repository to another
+      #
       # optional
       #   :package_ids
       #   :name_blacklist
+      #
+      # @param  [String]                source_repo_id      the source repository ID
+      # @param  [String]                destination_repo_id the destination repository ID
+      # @param  [Hash]                  optional            container for all optional parameters
+      # @return [RestClient::Response]                      a task representing the unit copy operation
       def self.rpm_copy(source_repo_id, destination_repo_id, optional={})
 
         criteria = {:type_ids => ['rpm'], :filters => {}}
@@ -87,14 +119,26 @@ module Runcible
         unit_copy(destination_repo_id, source_repo_id, payload)
       end
 
-      def self.rpm_remove(repo_id, package_ids)
+      # Removes RPMs from a repository
+      #
+      # @param  [String]                repo_id the repository ID to remove RPMs from
+      # @param  [Array]                 rpm_ids array of RPM IDs to remove
+      # @return [RestClient::Response]          a task representing the unit unassociate operation
+      def self.rpm_remove(repo_id, rpm_ids)
         criteria = {:type_ids => ['rpm'], :filters => {}}
-        criteria[:filters]['association'] = {'unit_id' => {'$in' => package_ids}}
+        criteria[:filters]['association'] = {'unit_id' => {'$in' => rpm_ids}}
         self.unassociate_units(repo_id, criteria)
       end
 
-       #optional
-      #  errata_ids
+      # Copies errata from one repository to another
+      #
+      # optional
+      #   :errata_ids
+      #
+      # @param  [String]                source_repo_id      the source repository ID
+      # @param  [String]                destination_repo_id the destination repository ID
+      # @param  [Hash]                  optional            container for all optional parameters
+      # @return [RestClient::Response]                      a task representing the unit copy operation
       def self.errata_copy(source_repo_id, destination_repo_id, optional={})
         criteria = {:type_ids => ['erratum'], :filters => {}}
         criteria[:filters]['association'] = {'unit_id' => {'$in' => optional[:errata_ids]}} if optional[:errata_ids]
@@ -102,14 +146,26 @@ module Runcible
         unit_copy(destination_repo_id, source_repo_id, payload)
       end
 
+      # Removes errata from a repository
+      #
+      # @param  [String]                repo_id     the repository ID to remove errata from
+      # @param  [Array]                 errata_ids  array of errata IDs to remove
+      # @return [RestClient::Response]              a task representing the unit unassociate operation
       def self.errata_remove(repo_id, errata_ids)
         criteria = {:type_ids => ['erratum'], :filters => {}}
         criteria[:filters]['association'] = {'unit_id' => {'$in' => errata_ids}}
         self.unassociate_units(repo_id, criteria)
       end
 
-      #optoinal
-      #  distribution_ids
+      # Copies distributions from one repository to another
+      #
+      # optoinal
+      #   :distribution_ids
+      #
+      # @param  [String]                source_repo_id      the source repository ID
+      # @param  [String]                destination_repo_id the destination repository ID
+      # @param  [Hash]                  optional            container for all optional parameters
+      # @return [RestClient::Response]                      a task representing the unit copy operation
       def self.distribution_copy(source_repo_id, destination_repo_id, optional={})
         criteria = {:type_ids => ['distribution'], :filters => {}}
         criteria[:filters][:unit] = { :id=>{ '$in' => optional[:distribution_ids] } } if optional[:distribution_ids]
@@ -117,30 +173,60 @@ module Runcible
         unit_copy(destination_repo_id, source_repo_id, payload)
       end
 
-      def self.package_group_copy(source_repo_id, destination_repo_id, optional={})
-        criteria = {:type_ids => [Runcible::Extensions::PackageGroup::TYPE], :filters => {}}
-        criteria[:filters][:unit] = { :id=>{ '$in' => optional[:package_group_ids] } } if optional[:package_group_ids]
-        payload = {:criteria => criteria}
-        unit_copy(destination_repo_id, source_repo_id, payload)
-      end
-
+      # Removes a distribution from a repository
+      #
+      # @param  [String]                repo_id         the repository ID to remove the distribution from
+      # @param  [String]                distribution_id the distribution ID to remove
+      # @return [RestClient::Response]                  a task representing the unit unassociate operation
       def self.distribution_remove(repo_id, distribution_id)
         criteria = {:type_ids => ['distribution'], :filters => {}}
         criteria[:filters][:unit] = { :id=>{ '$in' => [distribution_id] } }
         self.unassociate_units(repo_id, criteria)
       end
 
+      # Copies package groups from one repository to another
+      #
+      # optoinal
+      #   :package_group_ids
+      #
+      # @param  [String]                source_repo_id      the source repository ID
+      # @param  [String]                destination_repo_id the destination repository ID
+      # @param  [Hash]                  optional            container for all optional parameters
+      # @return [RestClient::Response]                      a task representing the unit copy operation
+      def self.package_group_copy(source_repo_id, destination_repo_id, optional={})
+        criteria = {:type_ids => [Runcible::Extensions::PackageGroup.content_type], :filters => {}}
+        criteria[:filters][:unit] = { :id=>{ '$in' => optional[:package_group_ids] } } if optional[:package_group_ids]
+        payload = {:criteria => criteria}
+        unit_copy(destination_repo_id, source_repo_id, payload)
+      end
+
+      # Retrieves the RPM IDs for a single repository
+      #
+      # @param [String]                 id the ID of the repository
+      # @return [RestClient::Response]     the set of repository RPM IDs
       def self.rpm_ids(id)
         criteria = {:type_ids=>['rpm']}
         self.unit_search(id, criteria).collect{|i| i['unit_id']}
       end
 
+      # Retrieves the RPMs for a single repository
+      #
+      # @param  [String]                id the ID of the repository
+      # @return [RestClient::Response]     the set of repository RPMs
       def self.rpms(id)
         criteria = {:type_ids=>['rpm']}
         self.unit_search(id, criteria).collect{|i| i['metadata'].with_indifferent_access}
       end
 
-      def self.packages_by_nvre(id, name, version=nil, release=nil, epoch=nil)
+      # Retrieves the RPMs by NVRE for a single repository
+      #
+      # @param  [String]                id      the ID of the repository
+      # @param  [String]                name    the name of the RPMs
+      # @param  [String]                version the version of the RPMs
+      # @param  [String]                release the release of the RPMs
+      # @param  [String]                epoch   the epoch of the RPMs
+      # @return [RestClient::Response]          the set of repository RPMs
+      def self.rpms_by_nvre(id, name, version=nil, release=nil, epoch=nil)
         and_condition = []
         and_condition << {:name=>name} if name
         and_condition << {:version=>version} if version
@@ -159,34 +245,60 @@ module Runcible
         self.unit_search(id, criteria).collect{|p| p['metadata'].with_indifferent_access}
       end
 
-      def self.errata_ids(id, filter = {})
+      # Retrieves the errata IDs for a single repository
+      #
+      # @param  [String]                id the ID of the repository
+      # @return [RestClient::Response]     the set of repository errata IDs
+      def self.errata_ids(id)
          criteria = {:type_ids=>['erratum']}
 
          self.unit_search(id, criteria).collect{|i| i['unit_id']}
       end
 
-      def self.errata(id, filter = {})
+      # Retrieves the errata for a single repository
+      #
+      # @param  [String]                id the ID of the repository
+      # @return [RestClient::Response]     the set of repository errata
+      def self.errata(id)
          criteria = {:type_ids=>['erratum']}
          self.unit_search(id, criteria).collect{|i| i['metadata'].with_indifferent_access}
       end
 
+      # Retrieves the distributions for a single repository
+      #
+      # @param  [String]                id the ID of the repository
+      # @return [RestClient::Response]     the set of repository distributions
       def self.distributions(id)
         criteria = {:type_ids=>['distribution']}
 
         self.unit_search(id, criteria).collect{|i| i['metadata'].with_indifferent_access}
       end
 
+      # Retrieves the package groups for a single repository
+      #
+      # @param  [String]                id the ID of the repository
+      # @return [RestClient::Response]     the set of repository package groups
       def self.package_groups(id)
-        criteria = {:type_ids=>[Runcible::Extensions::PackageGroup::TYPE]}
+        criteria = {:type_ids=>[Runcible::Extensions::PackageGroup.content_type]}
 
         self.unit_search(id, criteria).collect{|i| i['metadata'].with_indifferent_access}
       end
 
+      # Retrieves the package group categoriess for a single repository
+      #
+      # @param  [String]                id the ID of the repository
+      # @return [RestClient::Response]     the set of repository package group categories
       def self.package_categories(id)
-        criteria = {:type_ids=>[Runcible::Extensions::PackageCategory::TYPE]}
+        criteria = {:type_ids=>[Runcible::Extensions::PackageCategory.content_type]}
         self.unit_search(id, criteria).collect{|i| i['metadata'].with_indifferent_access}
       end
 
+      # Creates or updates a sync schedule for a repository
+      #
+      # @param  [String]                repo_id   the ID of the repository
+      # @param  [String]                type      the importer type
+      # @param  [String]                schedule  the time as an iso8601 interval
+      # @return [RestClient::Response]            the newly created or updated schedule
       def self.create_or_update_schedule(repo_id, type, schedule)
         schedules = Runcible::Resources::RepositorySchedule.list(repo_id, type)
         if schedules.empty?
@@ -196,6 +308,11 @@ module Runcible
         end
       end
 
+      # Removes a scheduled sync from a repository
+      #
+      # @param  [String]                repo_id   the ID of the repository
+      # @param  [String]                type      the importer type
+      # @return [RestClient::Response]            
       def self.remove_schedules(repo_id, type)
         schedules = Runcible::Resources::RepositorySchedule.list(repo_id, type)
         schedules.each do |schedule|
@@ -203,6 +320,10 @@ module Runcible
         end
       end
 
+      # Publishes a repository for all of it's distributors
+      #
+      # @param  [String]                repo_id the ID of the repository
+      # @return [RestClient::Response]          set of tasks representing each publish  
       def self.publish_all(repo_id)
         to_ret = []
         self.retrieve_with_details(repo_id)['distributors'].each do |d|
@@ -211,9 +332,14 @@ module Runcible
         to_ret
       end
 
+      # Retrieves a repository with details that include importer and distributors
+      #
+      # @param  [String]                repo_id the ID of the repository
+      # @return [RestClient::Response]          the repository with full details
       def self.retrieve_with_details(repo_id)
         self.retrieve(repo_id, {:details => true})
       end
+
     end
   end
 end

data/lib/runcible/extensions/rpm.rb

@@ -24,20 +24,22 @@
 
 module Runcible
   module Extensions
-    class Rpm < Runcible::Resources::Unit
-      TYPE = 'rpm'
+    class Rpm < Runcible::Extensions::Unit
 
-      def self.all
-        search(TYPE, {})
+      def self.content_type
+        'rpm'
       end
 
-      def self.find(id)
-        find_all([id]).first
+      # This function is not implemented for RPMs since they do not have content IDs
+      def self.find
+        raise NotImplementedError
       end
 
-      def self.find_all(ids)
-        search(TYPE, {:filters => {'_id'=> {'$in'=> ids}}}, {:include_repos=>true})
+      # This function is not implemented for RPMs since they do not have content IDs
+      def self.find_all
+        raise NotImplementedError
       end
+
     end
   end
 end

data/lib/runcible/extensions/unit.rb

@@ -0,0 +1,79 @@
+# Copyright (c) 2012
+#
+# 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 Unit < Runcible::Resources::Unit
+      
+      # The content type (e.g. rpm, errata)
+      def self.content_type
+        ''
+      end
+
+      # Retrieves all content of a certain @@type
+      #
+      # @return [RestClient::Response]  list of all content for the given type
+      def self.all
+        self.search(content_type, {})
+      end
+
+      # Retrieves a single content by it's content ID
+      #
+      # @param  [Array]                id   the content ID of the content to retrieve
+      # @return [RestClient::Response]      the requested content
+      def self.find(id, optional={})
+        optional ||= { :include_repos => true }
+        find_all([id], optional).first
+      end
+
+      # Retrieves a set of content by the contents IDs
+      #
+      # @param  [Array]                ids  list of content IDs to retrieve
+      # @return [RestClient::Response]      list of content
+      def self.find_all(ids, optional={})
+        optional ||= { :include_repos => true }
+        self.search(content_type, { :filters => {'id'=> {'$in'=> ids}} }, optional)
+      end
+
+      # Retrieves a single content by it's unit ID
+      #
+      # @param  [Array]                id   the unit ID of the content to retrieve
+      # @return [RestClient::Response]      the requested content
+      def self.find_by_unit_id(id, optional={})
+        optional ||= { :include_repos => true }
+        find_all_by_unit_ids([id], optional).first
+      end
+
+      # Retrieves a set of content by the Pulp unit IDs
+      #
+      # @param  [Array]                ids  list of content unit IDs to retrieve
+      # @return [RestClient::Response]      list of content
+      def self.find_all_by_unit_ids(ids, optional={})
+        optional ||= { :include_repos => true }
+        self.search(content_type, { :filters => {:_id=> {'$in'=> ids}} }, optional)
+      end
+
+    end
+  end
+end

data/lib/runcible/extensions/yum_importer.rb

@@ -41,4 +41,4 @@ module Runcible
         end
       end
   end
-end
+end

data/lib/runcible/resources/event_notifier.rb

@@ -28,14 +28,14 @@ module Runcible
     class EventNotifier < Runcible::Base
 
       class EventTypes
-        REPO_SYNC_COMPLETE = 'repo.sync.finish'
-        REPO_SYNC_START = 'repo.sync.start'
+        REPO_SYNC_COMPLETE    = 'repo.sync.finish'
+        REPO_SYNC_START       = 'repo.sync.start'
         REPO_PUBLISH_COMPLETE = 'repo.publish.finish'
-        REPO_PUBLISH_START = 'repo.publish.start'
+        REPO_PUBLISH_START    = 'repo.publish.start'
       end
 
       class NotifierTypes
-        REST_API = 'rest-api'
+        REST_API = 'http'
       end
 
       # Generates the API path for Event Notifiers

data/lib/runcible/version.rb

@@ -1,3 +1,3 @@
 module Runcible
-  VERSION = "0.2.1"
+  VERSION = "0.3"
 end

metadata

@@ -1,90 +1,71 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: runcible
-version: !ruby/object:Gem::Version 
-  hash: 21
+version: !ruby/object:Gem::Version
+  version: '0.3'
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 1
-  version: 0.2.1
 platform: ruby
-authors: 
+authors:
 - Eric D Helms
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-11-29 00:00:00 Z
+date: 2013-01-11 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/resources/role.rb
-- lib/runcible/resources/unit.rb
-- lib/runcible/resources/consumer_group.rb
-- lib/runcible/resources/user.rb
-- lib/runcible/resources/task.rb
-- lib/runcible/resources/repository.rb
-- lib/runcible/resources/event_notifier.rb
-- lib/runcible/resources/consumer.rb
-- lib/runcible/resources/repository_schedule.rb
 - lib/runcible/base.rb
-- lib/runcible/version.rb
 - lib/runcible/extensions/consumer_group.rb
+- lib/runcible/extensions/consumer.rb
+- lib/runcible/extensions/rpm.rb
+- lib/runcible/extensions/errata.rb
 - lib/runcible/extensions/repository.rb
 - lib/runcible/extensions/package_category.rb
 - lib/runcible/extensions/yum_importer.rb
-- lib/runcible/extensions/consumer.rb
-- lib/runcible/extensions/package_group.rb
-- lib/runcible/extensions/yum_distributor.rb
 - lib/runcible/extensions/importer.rb
+- lib/runcible/extensions/unit.rb
 - lib/runcible/extensions/distributor.rb
-- lib/runcible/extensions/rpm.rb
 - lib/runcible/extensions/distribution.rb
-- lib/runcible/extensions/errata.rb
+- lib/runcible/extensions/yum_distributor.rb
+- lib/runcible/extensions/package_group.rb
+- lib/runcible/resources/task.rb
+- lib/runcible/resources/consumer_group.rb
+- lib/runcible/resources/consumer.rb
+- lib/runcible/resources/repository_schedule.rb
+- lib/runcible/resources/user.rb
+- lib/runcible/resources/repository.rb
+- lib/runcible/resources/role.rb
+- lib/runcible/resources/unit.rb
+- lib/runcible/resources/event_notifier.rb
+- lib/runcible/version.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.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: ""
+summary: ''
 test_files: []
-
 has_rdoc: