runcible 0.4.12 → 1.0.0

data/lib/runcible/extensions/rpm.rb

@@ -31,17 +31,17 @@ module Runcible
       end
 
       # This function is not implemented for RPMs since they do not have content IDs
-      def self.find
+      def find
         raise NotImplementedError
       end
 
       # This function is not implemented for RPMs since they do not have content IDs
-      def self.find_all
+      def find_all
         raise NotImplementedError
       end
 
       # This function is not implemented for RPMs since they do not have content IDs
-      def self.unassociate_ids_from_repo(repo_id, ids)
+      def unassociate_ids_from_repo(repo_id, ids)
         raise NotImplementedError
       end
     end

data/lib/runcible/extensions/unit.rb

@@ -25,24 +25,28 @@
 module Runcible
   module Extensions
     class Unit < Runcible::Resources::Unit
-      
+
       # The content type (e.g. rpm, errata)
       def self.content_type
-        ''
+        raise "Content type not defined"
+      end
+
+      def content_type
+        self.class.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, {})
+      def all
+        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={})
+      def find(id, optional={})
         optional[:include_repos] ||= true
         find_all([id], optional).first
       end
@@ -51,16 +55,16 @@ module Runcible
       #
       # @param  [Array]                ids  list of content IDs to retrieve
       # @return [RestClient::Response]      list of content
-      def self.find_all(ids, optional={})
+      def find_all(ids, optional={})
         optional[:include_repos] ||= true
-        self.search(content_type, { :filters => {'id'=> {'$in'=> ids}} }, optional)
+        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={})
+      def find_by_unit_id(id, optional={})
         optional[:include_repos] ||= true
         find_all_by_unit_ids([id], [], optional).first
       end
@@ -70,11 +74,11 @@ module Runcible
       # @param  [Array]                ids    list of content unit IDs to retrieve
       # @param  [Array]                fields optional list of to retrieve
       # @return [RestClient::Response]        list of content
-      def self.find_all_by_unit_ids(ids, fields=[], optional={})
+      def find_all_by_unit_ids(ids, fields=[], optional={})
         optional[:include_repos] ||= true
         criteria = { :filters => { :_id => { '$in'=> ids } } }
         criteria[:fields] = fields unless fields.empty?
-        self.search(content_type, criteria, optional)
+        search(content_type, criteria, optional)
       end
 
       # unassociates content units from a repository
@@ -82,10 +86,10 @@ module Runcible
       # @param  [String]                repo_id the repository ID to remove units from
       # @param  [Hash]                  filters the filters to find the units  this content type to remove
       # @return [RestClient::Response]          a task representing the unit unassociate operation
-      def self.unassociate_from_repo(repo_id, filters)
+      def unassociate_from_repo(repo_id, filters)
         criteria = {:type_ids => [content_type]}
         criteria[:filters] = filters
-        Runcible::Extensions::Repository.unassociate_units(repo_id, criteria)
+        Runcible::Extensions::Repository.new(self.config).unassociate_units(repo_id, criteria)
       end
 
       # unassociates content units from a repository
@@ -96,7 +100,7 @@ module Runcible
       #                                       ex: "RHEA-2010:0001" for errata..,
       #                                       Note rpms do not have ids, so cant use this.
       # @return [RestClient::Response]          a task representing the unit unassociate operation
-      def self.unassociate_ids_from_repo(repo_id, ids)
+      def unassociate_ids_from_repo(repo_id, ids)
         unassociate_from_repo(repo_id, :unit => {'id' => {'$in' => ids}})
       end
 
@@ -108,7 +112,7 @@ module Runcible
       #                                     for example: "efdd2d63-b275-4728-a298-f68cf4c174e7"
       #
       # @return [RestClient::Response]          a task representing the unit unassociate operation
-      def self.unassociate_unit_ids_from_repo(repo_id, ids)
+      def unassociate_unit_ids_from_repo(repo_id, ids)
         unassociate_from_repo(repo_id, :association => {'unit_id' => {'$in' => ids}})
       end
 
@@ -118,15 +122,16 @@ module Runcible
       # @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.copy(source_repo_id, destination_repo_id, optional={})
+      def copy(source_repo_id, destination_repo_id, optional={})
         criteria = {:type_ids => [content_type], :filters => {}}
         criteria[:filters]['association'] = {'unit_id' => {'$in' => optional[:ids]}} if optional[:ids]
+        criteria[:filters] = optional[:filters] if optional[:filters]
         criteria[:fields] = {:unit => optional[:fields]} if optional[:fields]
 
         payload = {:criteria => criteria}
         payload[:override_config] = {:copy_children => optional[:copy_children]} if optional.has_key?(:copy_children)
 
-        Runcible::Extensions::Repository.unit_copy(destination_repo_id, source_repo_id, payload)
+        Runcible::Extensions::Repository.new(self.config).unit_copy(destination_repo_id, source_repo_id, payload)
       end
 
     end

data/lib/runcible/instance.rb

@@ -0,0 +1,129 @@
+# Copyright (c) 2013 Red Hat Inc.
+#
+# 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
+  class Instance
+
+    def self.resource_classes
+      @@resource_classes ||= gather_classes("resources")
+      @@resource_classes
+    end
+
+    def self.extension_classes
+      @@extension_classes ||= gather_classes("extensions")
+      @@extension_classes
+    end
+
+
+    attr_accessor :resources
+    attr_accessor :extensions
+
+    # Initialize a Runcible instance
+    #
+    # @param [Hash] config
+    # @option config [String]  :user  Pulp username
+    # @option config [String]  :oauth Oauth credentials
+    # @option config [Hash]    :headers Additional headers e.g. content-type => "application/json"
+    # @option config [String]  :url  Scheme and hostname for the pulp server e.g. https://localhost/
+    # @option config [String]  :api_path URL path for the api e.g. pulp/api/v2/
+    # @option config [String]  :timeout Timeout in seconds for the connection (defaults to rest client's default)
+    # @option config [String]  :open_timeout timeout in seconds for the connection to open(defaults to rest client's default)
+    # @option config [Hash]    :http_auth Needed when using simple http auth
+    # @option http_auth [String] :password The password to use for simple auth
+    def initialize(config={})
+      @config = {
+              :api_path   => '/pulp/api/v2/',
+              :url        => 'https://localhost',
+              :user       => '',
+              :http_auth  => {:password => {} },
+              :headers    => {:content_type => 'application/json',
+                              :accept       => 'application/json'},
+              :logging    => {}
+            }.merge(config).with_indifferent_access
+
+
+      initialize_wrappers(config)
+    end
+
+    # Update an existing config value
+    # @param [String, Symbol]    key   The key of the config to update
+    # @param [Object]            value  The value of the config to update
+    def update_config(key, value)
+      @config[key] = value
+    end
+
+    private
+
+    def initialize_wrappers(config)
+      self.resources = Wrapper.new('resources')
+      self.extensions = Wrapper.new('extensions')
+
+      self.class.resource_classes.each do |runcible_class|
+        instance = runcible_class.new(@config)
+        self.resources.set_instance(accessible_class(runcible_class), instance)
+      end
+
+      self.class.extension_classes.each do |runcible_class|
+        instance = runcible_class.new(@config)
+        self.extensions.set_instance(accessible_class(runcible_class), instance)
+      end
+    end
+
+    def accessible_class(class_object)
+      #converts a class (Runcible::Resources::ConsumerGroup) to a user friendly name:
+      #  (e.g. consumer_group)
+      class_object.name.split("::").last.underscore
+    end
+
+    def self.gather_classes(type)
+      const = Runcible
+      const = const.const_get(type.camelize)
+      path = File.dirname(__FILE__) + "/#{type}/*.rb"
+      base_names = Dir.glob(path).collect{|f| File.basename(f, '.rb')  }
+      classes = base_names.collect{|name| const.const_get(name.camelize)}
+    end
+
+  end
+
+
+  #Wrapper class to provide access to instances
+  class Wrapper
+
+    def initialize(name)
+      @name = name
+      @methods = []
+    end
+
+    def set_instance(attr_name, instance)
+      @methods << attr_name
+      define_singleton_method(attr_name) { instance }
+    end
+
+    def to_s
+      "#{@name} - #{@methods.uniq.sort.to_s}"
+    end
+  end
+
+
+end
+

data/lib/runcible/{extensions → models}/distributor.rb

@@ -25,14 +25,18 @@ require 'active_support/json'
 require 'securerandom'
 
 module Runcible
-  module Extensions
+  module Models
     class Distributor
       attr_accessor 'auto_publish', 'id'
 
       def initialize(params={})
         @auto_publish = false
-        self.id = params[:id] || SecureRandom.hex(10)
-        params.each{|k,v| self.send("#{k.to_s}=",v)}
+        id = params[:id] || SecureRandom.hex(10)
+        params.each{|k,v| send("#{k.to_s}=",v)}
+      end
+
+      def type_id
+        self.class.type_id
       end
 
       # Distributor Type id

data/lib/runcible/{extensions → models}/export_distributor.rb

@@ -25,7 +25,7 @@ require 'active_support/json'
 require 'securerandom'
 
 module Runcible
-  module Extensions
+  module Models
     class ExportDistributor < Distributor
       #required
       attr_accessor "http", "https"
@@ -39,9 +39,12 @@ module Runcible
         @http = http
         @https = https
         # Pulp seems to expect the ID to be export_distributor, not a random
-        super({:id => self.type_id})
+        super({:id => type_id})
       end
 
+      # Distributor Type id
+      #
+      # @return [string]
       def self.type_id
         'export_distributor'
       end
@@ -50,7 +53,7 @@ module Runcible
       #
       # @return [Hash]
       def config
-        to_ret = self.as_json
+        to_ret = as_json
         to_ret.delete('auto_publish')
         to_ret.delete('id')
         to_ret

data/lib/runcible/{extensions → models}/importer.rb

@@ -26,13 +26,13 @@ require 'active_support/json'
 
 
 module Runcible
-  module Extensions
+  module Models
 
     # 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)}
+        params.each{|k,v| send("#{k.to_s}=",v)}
       end
     end
 

data/lib/runcible/{extensions → models}/iso_distributor.rb

@@ -25,7 +25,7 @@ require 'active_support/json'
 require 'securerandom'
 
 module Runcible
-  module Extensions
+  module Models
     class IsoDistributor < Distributor
       #required
       attr_accessor "serve_http", "serve_https"
@@ -41,6 +41,9 @@ module Runcible
         super({})
       end
 
+      # Distributor Type id
+      #
+      # @return [string]
       def self.type_id
         'iso_distributor'
       end
@@ -49,7 +52,7 @@ module Runcible
       #
       # @return [Hash]
       def config
-        to_ret = self.as_json
+        to_ret = as_json
         to_ret.delete('auto_publish')
         to_ret.delete('id')
         to_ret

data/lib/runcible/{extensions → models}/iso_importer.rb

@@ -22,7 +22,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 module Runcible
-  module Extensions
+  module Models
     class IsoImporter < Importer
       ID = 'iso_importer'
 
@@ -41,7 +41,7 @@ module Runcible
       #
       # @return [Hash]
       def config
-          self.as_json
+          as_json
       end
     end
   end

data/lib/runcible/models/nodes_http_distributor.rb

@@ -0,0 +1,61 @@
+# Copyright (c) 2013 Red Hat Inc.
+#
+# 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.
+
+require 'active_support/json'
+require 'securerandom'
+
+module Runcible
+  module Models
+    class NodesHttpDistributor < Distributor
+      #required
+      attr_accessor "http", "https"
+
+      # Instantiates a export distributor
+      #
+      # @param  [boolean]         http  serve the contents over http
+      # @param  [boolean]         https serve the contents over https
+      # @return [Runcible::Extensions::ExportDistributor]
+      def initialize()
+        # Pulp seems to expect the ID to be export_distributor, not a random
+        super({:id => type_id})
+      end
+
+      # Distributor Type id
+      #
+      # @return [string]
+      def self.type_id
+        'nodes_http_distributor'
+      end
+
+      # generate the pulp config for the export distributor
+      #
+      # @return [Hash]
+      def config
+        to_ret = as_json
+        to_ret.delete('auto_publish')
+        to_ret.delete('id')
+        to_ret
+      end
+    end
+  end
+end

data/lib/runcible/{extensions → models}/yum_clone_distributor.rb

@@ -25,7 +25,9 @@ require 'active_support/json'
 require 'securerandom'
 
 module Runcible
-  module Extensions
+  module Models
+    # Requires the pulp-katello-plugins
+    #  https://github.com/Katello/pulp-katello-plugins
     class YumCloneDistributor < Distributor
 
       #optional

data/lib/runcible/{extensions → models}/yum_distributor.rb

@@ -25,7 +25,7 @@ require 'active_support/json'
 require 'securerandom'
 
 module Runcible
-  module Extensions
+  module Models
     class YumDistributor < Distributor
       #required
       attr_accessor "relative_url", "http", "https"
@@ -46,7 +46,7 @@ module Runcible
       end
 
       def config
-        to_ret = self.as_json
+        to_ret = as_json
         to_ret.delete('auto_publish')
         to_ret.delete('id')
         to_ret

data/lib/runcible/{extensions → models}/yum_importer.rb

@@ -22,7 +22,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 module Runcible
-  module Extensions
+  module Models
     class YumImporter < Importer
         ID = 'yum_importer'
 
@@ -37,7 +37,7 @@ module Runcible
         end
 
         def config
-            self.as_json
+            as_json
         end
       end
   end

data/lib/runcible/resources/consumer.rb

@@ -40,7 +40,7 @@ module Runcible
       # @param  [String]                id        the ID of the consumer
       # @param  [Hash]                  optional  container for all optional parameters
       # @return [RestClient::Response]
-      def self.create(id, optional={})
+      def create(id, optional={})
         required = required_params(binding.send(:local_variables), binding)
         call(:post, path, :payload => { :required => required, :optional => optional })
       end
@@ -49,7 +49,7 @@ module Runcible
       #
       # @param  [String]                id  the ID of the consumer
       # @return [RestClient::Response]
-      def self.retrieve(id)
+      def retrieve(id)
         call(:get, path(id))
       end
 
@@ -58,7 +58,7 @@ module Runcible
       # @param  [String]                id        the ID of the consumer
       # @param  [Hash]                  optional  container for all optional parameters
       # @return [RestClient::Response]
-      def self.update(id, optional={})
+      def update(id, optional={})
         call(:put, path(id), :payload => { :delta => optional })
       end
 
@@ -66,7 +66,7 @@ module Runcible
       #
       # @param  [String]                id  the id of the consumer
       # @return [RestClient::Response]
-      def self.delete(id)
+      def delete(id)
         call(:delete, path(id))
       end
 
@@ -76,7 +76,7 @@ module Runcible
       # @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)
+      def upload_profile(id, content_type, profile)
         required = required_params(binding.send(:local_variables), binding, ["id"])
         call(:post, path("#{id}/profiles/"), :payload => { :required => required })
       end
@@ -86,7 +86,7 @@ module Runcible
       # @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)
+      def retrieve_profile(id, content_type)
         call(:get, path("#{id}/profiles/#{content_type}/"))
       end
 
@@ -96,7 +96,7 @@ module Runcible
       # @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)
+      def retrieve_binding(id, repo_id, distributor_id)
         call(:get, path("#{id}/bindings/#{repo_id}/#{distributor_id}"))
       end
 
@@ -104,7 +104,7 @@ module Runcible
       #
       # @param  [String]                id  the ID of the consumer
       # @return [RestClient::Response]
-      def self.retrieve_bindings(id)
+      def retrieve_bindings(id)
         call(:get, path("#{id}/bindings/"))
       end
 
@@ -115,7 +115,7 @@ module Runcible
       # @param  [String]                distributor_id  the ID of the distributor
       # @param  [Hash]                  optional optional parameters
       # @return [RestClient::Response]
-      def self.bind(id, repo_id, distributor_id, optional={})
+      def bind(id, repo_id, distributor_id, optional={})
         required = required_params(binding.send(:local_variables), binding, ["id"])
         call(:post, path("#{id}/bindings/"), :payload => { :required => required, :optional=>optional })
       end
@@ -126,7 +126,7 @@ module Runcible
       # @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)
+      def unbind(id, repo_id, distributor_id)
         call(:delete, path("#{id}/bindings/#{repo_id}/#{distributor_id}"))
       end
 
@@ -136,7 +136,7 @@ module Runcible
       # @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={})
+      def 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
@@ -147,7 +147,7 @@ module Runcible
       # @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={})
+      def 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
@@ -158,7 +158,7 @@ module Runcible
       # @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={})
+      def uninstall_units(id, units, options={})
         required = required_params(binding.send(:local_variables), binding, ["id"])
         call(:post, path("#{id}/actions/content/uninstall/"), :payload => { :required => required })
       end
@@ -167,7 +167,7 @@ module Runcible
       #
       # @param  [Hash]                  options hash of uninstall options
       # @return [RestClient::Response]
-      def self.applicability(options={})
+      def applicability(options={})
         call(:post, path("actions/content/applicability/"), :payload => { :required => options })
       end