rhn_satellite 0.0.4

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem "mocha", "~> 0.9.10"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    mocha (0.9.12)
+    rake (0.9.2)
+    rcov (0.9.10)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  mocha (~> 0.9.10)
+  rcov
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 duritong
+
+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.

data/README.rdoc

@@ -0,0 +1,94 @@
+= rhn_satellite
+
+RhnSatellite is a ruby api to the RedHat Satellite
+
+It provides an easy way to interact with a RedHat Satellite API. Mainly the XMLRPC calls are wrapped with a few
+methods, so that talking to the API from ruby is much easier.
+
+It is far from complete, but most methods that have been added have been tested and used in real environments with
+the latest satellite. The existing methods should get you an idea how to add missing methods.
+
+Patches (including tests) are welcomed!
+
+RedHat's API is documented here: http://docs.redhat.com/docs/en-US/Red_Hat_Network_Satellite/5.4.1/html/API_Overview/index.html
+
+== Credentials
+
+By default rhn_satellite will look for a yaml containing credentials in `~/.satellite.yaml` or in `/etc/satellite.yaml` .
+This file should contain the following options:
+
+    hostname: satellite.example.com
+    username: foobar
+    password: foobar
+
+However, you can always set later your own credentials for the whole API:
+
+    RhnSatellite::Connection::Handler.default_hostname = 'satellite2.example.com'
+    RhnSatellite::Connection::Handler.default_username = 'testuser'
+    RhnSatellite::Connection::Handler.default_password = 'testpwd'
+
+Or different ones on subparts of the api:
+
+
+    RhnSatellite::Channel.hostname = 'satellite.example.com'
+    RhnSatellite::Channel.username = 'channel'
+    RhnSatellite::Channel.password = 'channel'
+
+== Examples
+
+A few examples should give an idea how things should work:
+
+=== Get a system
+
+Fetch a system from the satellite.
+
+    satellite_system = RhnSatellite::System.get('somenode.example.com')
+
+=== clone channel
+
+Clone a new channel.
+
+    RhnSatellite::ChannelSoftware.clone(
+      'original_label',
+      'new_label',
+      'new_label,
+      "Some clone of original_label",
+      false
+    )
+
+=== Schedule update of all updateable packages
+
+This will get all packages that can be upgraded for a system and will schedule the immediate upgrade of these packages.
+
+    satellite_system = RhnSatellite::System.get('somenode.example.com')
+    packages_to_update = RhnSatellite::System.latest_upgradable_packages(satellite_system['id']).inject({}) { |res,p|
+      # sometimes the satellite lists some weird packages, so we check if they actually exist.
+      key = "#{p['name']}-#{p['version']}-#{p['release']}"
+      if res[key]
+        res[key] = p['to_package_id'] if RhnSatellite::Package.exists?(p['to_package_id'])
+      else
+        res[key] = p['to_package_id']
+      end
+      res
+    }.values.compact
+    if packages_to_update.size > 0
+      now = Time.now
+      patch_time = XMLRPC::DateTime.new(now.year,now.month,now.day,now.hour,now.min, now.sec)
+      RhnSatellite::System.schedule_package_install(satellite_system['id'],packages_to_update,patch_time)
+    end
+
+== Contributing to rhn_satellite
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 duritong. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rhn_satellite"
+  gem.homepage = "http://github.com/duritong/ruby-rhn_satellite"
+  gem.license = "MIT"
+  gem.summary = %Q{RhnSatellite is a ruby api to the RedHat Satellite}
+  gem.description = %Q{It provides an easy way to interact with a RedHat Satellite API.}
+  gem.email = "peter.meier@immerda.ch"
+  gem.authors = ["duritong"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rhn_satellite #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/lib/rhn_satellite.rb

@@ -0,0 +1,25 @@
+require 'date'
+
+require 'xmlrpc/client'
+require 'rhn_satellite/common/misc'
+require 'rhn_satellite/common/debug'
+require 'rhn_satellite/connection/handler'
+require 'rhn_satellite/connection/base'
+require 'rhn_satellite/common/collection'
+
+require 'rhn_satellite/activation_key'
+require 'rhn_satellite/api'
+require 'rhn_satellite/channel'
+require 'rhn_satellite/channel_software'
+require 'rhn_satellite/channel_access'
+require 'rhn_satellite/system'
+require 'rhn_satellite/systemgroup'
+require 'rhn_satellite/package'
+
+if File.exists?(file=File.expand_path('~/.satellite.yaml')) || File.exists?(file='/etc/satellite.yaml')
+  require 'yaml'
+  global_options = YAML.load_file(file)
+  RhnSatellite::Connection::Handler.default_hostname = global_options['hostname']
+  RhnSatellite::Connection::Handler.default_username = global_options['username']
+  RhnSatellite::Connection::Handler.default_password = global_options['password']
+end

data/lib/rhn_satellite/activation_key.rb

@@ -0,0 +1,5 @@
+module RhnSatellite
+  class ActivationKey < RhnSatellite::Connection::Base
+    collection 'activationkey.listActivationKeys'
+  end
+end

data/lib/rhn_satellite/api.rb

@@ -0,0 +1,36 @@
+module RhnSatellite
+  class Api < RhnSatellite::Connection::Base
+    class << self
+      def api_version(disconnect=true)
+        @api_version ||= get_version('getVersion',disconnect)
+      end
+      
+      def satellite_version(disconnect=true)
+        @satellite_version ||= get_version('systemVersion',disconnect)
+      end
+      
+      def test_connection(user=nil,pwd=nil)
+        reset
+        test_base = RhnSatellite::Connection::Handler.instance_for(self.name, hostname, user||username, pwd||password, https)
+        test_base.connect
+        result = test_base.login && test_base.logout
+        test_base.disconnect
+        result
+      end
+      
+      def reset
+        @api_version = @satellite_version = nil
+        super
+      end
+      
+      private
+      
+      def get_version(cmd,disconnect=true)
+        base.connect unless base.connected?
+        result = base.make_call("api.#{cmd}")
+        base.disconnect if disconnect
+        result
+      end
+    end
+  end
+end

data/lib/rhn_satellite/channel.rb

@@ -0,0 +1,5 @@
+module RhnSatellite
+  class Channel < RhnSatellite::Connection::Base
+    collection 'channel.listAllChannels'
+  end
+end

data/lib/rhn_satellite/channel_access.rb

@@ -0,0 +1,20 @@
+module RhnSatellite
+  class ChannelAccess < RhnSatellite::Connection::Base
+    
+    class << self
+      def disable_user_restrictions(channel_label)
+        base.default_call('channel.access.disableUserRestrictions',channel_label)
+      end
+      def enable_user_restrictions(channel_label)
+        base.default_call('channel.access.enableUserRestrictions',channel_label)
+      end
+      def get_org_sharing(channel_label)
+        base.default_call('channel.access.getOrgSharing',channel_label)
+      end
+      def set_org_sharing(channel_label,access)
+        base.default_call('channel.access.setOrgSharing',channel_label,access)
+      end
+    end
+    
+  end
+end

data/lib/rhn_satellite/channel_software.rb

@@ -0,0 +1,20 @@
+module RhnSatellite
+  class ChannelSoftware < RhnSatellite::Connection::Base
+    
+    class << self
+      def clone(original_label,name,label,summary,original_state=true,additional_options = {})
+        channel_details = {
+          'name' => name,
+          'label' => label,
+          'summary' => summary
+        }.merge(additional_options)
+        base.default_call('channel.software.clone',original_label,channel_details,original_state)
+      end
+
+      def list_children(channel_label)
+        base.default_call('channel.software.listChildren',channel_label)
+      end
+    end
+    
+  end
+end

data/lib/rhn_satellite/common/collection.rb

@@ -0,0 +1,15 @@
+module RhnSatellite
+  module Common
+    module Collection
+      def all(&blk)
+        result = base.default_call(@collection_cmd).to_a
+        result.each {|record| yield(record) } if block_given?
+        result
+      end
+
+      def get(name)
+        all.find{|item| item["name"] =~ /#{name}/ }
+      end
+    end
+  end
+end

data/lib/rhn_satellite/common/debug.rb

@@ -0,0 +1,35 @@
+module RhnSatellite
+    module Common
+        module Debug
+            def self.included(base)
+                base.extend(ClassMethods)
+            end
+            
+            def debug(msg)
+                self.class.debug(msg)
+            end
+            
+            module ClassMethods
+                def debug_enabled
+                    @debug_enabled ||= false
+                end
+                
+                def debug_enabled=(enable)
+                    @debug_enabled = enable
+                end
+                
+                def output=(output)
+                    @output = output
+                end
+                
+                def output
+                    @output ||= STDOUT
+                end
+                
+                def debug(msg)
+                    output.puts msg if @debug_enabled
+                end
+            end
+        end
+    end
+end

data/lib/rhn_satellite/common/misc.rb

@@ -0,0 +1,24 @@
+module RhnSatellite
+  module Common
+    module Misc
+      def gen_date_time(time='now')
+        if time == 'now'
+          t = Time.now
+        elsif time.is_a?(DateTime) || time.is_a?(Time)
+          t = time
+        else
+          return time
+        end
+        XMLRPC::DateTime.new(
+          t.year,
+          t.month,
+          t.day,
+          t.hour,
+          t.min,
+          t.sec
+        )
+      end
+      module_function :gen_date_time
+    end
+  end
+end

data/lib/rhn_satellite/connection/base.rb

@@ -0,0 +1,25 @@
+module RhnSatellite
+  module Connection
+    class Base
+      class << self
+        attr_accessor :hostname, :username, :password, :https
+
+        attr_reader :collection_cmd
+        
+        def reset
+          RhnSatellite::Connection::Handler.reset_instance(self.name)
+        end
+
+        private
+        def base
+          RhnSatellite::Connection::Handler.instance_for(self.name, hostname, username, password, https)
+        end
+        
+        def collection(cmd)
+          @collection_cmd = cmd 
+          extend RhnSatellite::Common::Collection
+        end
+      end
+    end
+  end
+end