katello_api 0.0.1

data/lib/katello_api/resources/template.rb

@@ -0,0 +1,107 @@
+module KatelloApi
+  module Resources
+    class Template < KatelloApi::Base
+      def self.doc
+        @doc ||= KatelloApi.doc['resources']["templates"]
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] environment_id  environment numeric identifier 
+      # @option params [String] name  system template identifier 
+      #
+      # @param [Hash] headers additional http headers
+      def index(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/environments/:environment_id/templates", params
+        call(:"get", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id  system template numeric identifier 
+      #
+      # @param [Hash] headers additional http headers
+      def show(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates/:id", params
+        call(:"get", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] environment_id  environment numeric identifier 
+      # @option params [Hash] template 
+      #   allowed keys are: 
+      #   * description [String, nil]  template description ,
+      #   * name [String]  new template name ,
+      #   * parent_id [String, nil]  parent template numeric identifier ,
+      #
+      # @param [Hash] headers additional http headers
+      def create(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates", params
+        call(:"post", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id  template numeric identifier 
+      # @option params [Hash] template 
+      #   allowed keys are: 
+      #   * description [String, nil]  template description ,
+      #   * name [String]  new template name ,
+      #   * parent_id [String, nil]  parent template numeric identifier ,
+      #
+      # @param [Hash] headers additional http headers
+      def update(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates/:id", params
+        call(:"put", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id  template numeric identifier 
+      #
+      # @param [Hash] headers additional http headers
+      def destroy(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates/:id", params
+        call(:"delete", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] environment_id  environment numeric identifier 
+      # @option params [Hash] template 
+      #   allowed keys are: 
+      #   * description [String, nil]  template description ,
+      #   * name [String]  new template name ,
+      #   * parent_id [String, nil]  parent template numeric identifier ,
+      # @option params [String] template_file  template file to import 
+      #
+      # @param [Hash] headers additional http headers
+      def import(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates/import", params
+        call(:"post", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id  template numeric identifier 
+      #
+      # @param [Hash] headers additional http headers
+      def validate(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates/:id/validate", params
+        call(:"get", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id  template numeric identifier 
+      #
+      # @param [Hash] headers additional http headers
+      def export(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates/:id/export", params
+        call(:"get", url, params, headers)
+      end
+
+    end
+  end
+end

data/lib/katello_api/resources/templates_content.rb

@@ -0,0 +1,143 @@
+module KatelloApi
+  module Resources
+    class TemplatesContent < KatelloApi::Base
+      def self.doc
+        @doc ||= KatelloApi.doc['resources']["templates_content"]
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] name  package identifier 
+      # @option params [String] template_id  template numeric identifier 
+      #
+      # @param [Hash] headers additional http headers
+      def add_package(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates/:template_id/packages", params
+        call(:"post", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id  package identifier 
+      # @option params [String] template_id  template numeric identifier 
+      #
+      # @param [Hash] headers additional http headers
+      def remove_package(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates/:template_id/packages/:id", params
+        call(:"delete", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] name  parameter identifier 
+      # @option params [String] template_id  template numeric identifier 
+      # @option params [String] value  parameter value 
+      #
+      # @param [Hash] headers additional http headers
+      def add_parameter(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates/:template_id/parameters", params
+        call(:"post", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id  parameter identifier 
+      # @option params [String] template_id  template numeric identifier 
+      #
+      # @param [Hash] headers additional http headers
+      def remove_parameter(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates/:template_id/parameters/:id", params
+        call(:"delete", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] name  package group identifier 
+      # @option params [String] template_id  template numeric identifier 
+      #
+      # @param [Hash] headers additional http headers
+      def add_package_group(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates/:template_id/package_groups", params
+        call(:"post", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id  package group identifier 
+      # @option params [String] template_id  template numeric identifier 
+      #
+      # @param [Hash] headers additional http headers
+      def remove_package_group(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates/:template_id/package_groups/:id", params
+        call(:"delete", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] name  package group category identifier 
+      # @option params [String] template_id  template numeric identifier 
+      #
+      # @param [Hash] headers additional http headers
+      def add_package_group_category(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates/:template_id/package_group_categories", params
+        call(:"post", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id  package group category identifier 
+      # @option params [String] template_id  template numeric identifier 
+      #
+      # @param [Hash] headers additional http headers
+      def remove_package_group_category(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates/:template_id/package_group_categories/:id", params
+        call(:"delete", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id  distribution identifier 
+      # @option params [String] template_id  template numeric identifier 
+      #
+      # @param [Hash] headers additional http headers
+      def add_distribution(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates/:template_id/distributions", params
+        call(:"post", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id  distribution identifier 
+      # @option params [String] template_id  template numeric identifier 
+      #
+      # @param [Hash] headers additional http headers
+      def remove_distribution(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates/:template_id/distributions/:id", params
+        call(:"delete", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id  repository numeric identifier 
+      # @option params [String] template_id  template numeric identifier 
+      #
+      # @param [Hash] headers additional http headers
+      def add_repo(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates/:template_id/repositories", params
+        call(:"post", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id  repository numeric identifier 
+      # @option params [String] template_id  template numeric identifier 
+      #
+      # @param [Hash] headers additional http headers
+      def remove_repo(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/templates/:template_id/repositories/:id", params
+        call(:"delete", url, params, headers)
+      end
+
+    end
+  end
+end

data/lib/katello_api/resources/uebercert.rb

@@ -0,0 +1,20 @@
+module KatelloApi
+  module Resources
+    class Uebercert < KatelloApi::Base
+      def self.doc
+        @doc ||= KatelloApi.doc['resources']["uebercerts"]
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] regenerate  when set to ‘true’ certificate will be re-issued 
+      #
+      # @param [Hash] headers additional http headers
+      def show(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/organizations/:organization_id/uebercert", params
+        call(:"get", url, params, headers)
+      end
+
+    end
+  end
+end

data/lib/katello_api/resources/user.rb

@@ -0,0 +1,113 @@
+module KatelloApi
+  module Resources
+    class User < KatelloApi::Base
+      def self.doc
+        @doc ||= KatelloApi.doc['resources']["users"]
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] disabled  filter by disabled flag 
+      # @option params [String] email  filter by email 
+      # @option params [String] username  filter by username 
+      #
+      # @param [Hash] headers additional http headers
+      def index(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/users", params
+        call(:"get", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      #
+      # @param [Hash] headers additional http headers
+      def show(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/users/:id", params
+        call(:"get", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [Numeric, nil] default_environment_id 
+      # @option params [String, nil] disabled 
+      # @option params [String] email 
+      # @option params [String] password 
+      # @option params [String] username 
+      #
+      # @param [Hash] headers additional http headers
+      def create(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/users", params
+        call(:"post", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [Numeric, nil] default_environment_id 
+      # @option params [String, nil] disabled 
+      # @option params [String] email 
+      # @option params [String] password 
+      #
+      # @param [Hash] headers additional http headers
+      def update(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/users/:id", params
+        call(:"put", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      #
+      # @param [Hash] headers additional http headers
+      def destroy(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/users/:id", params
+        call(:"delete", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      #
+      # @param [Hash] headers additional http headers
+      def list_roles(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/users/:user_id/roles", params
+        call(:"get", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      #
+      # @param [Hash] headers additional http headers
+      def sync_ldap_roles(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/users/sync_ldap_roles", params
+        call(:"get", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [Numeric] role_id 
+      #
+      # @param [Hash] headers additional http headers
+      def add_role(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/users/:user_id/roles", params
+        call(:"post", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      #
+      # @param [Hash] headers additional http headers
+      def remove_role(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/users/:user_id/roles/:id", params
+        call(:"delete", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      #
+      # @param [Hash] headers additional http headers
+      def report(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/users/report", params
+        call(:"get", url, params, headers)
+      end
+
+    end
+  end
+end

data/lib/katello_api/rest_client_oauth.rb

@@ -0,0 +1,19 @@
+unless RestClient.const_defined? :OAUTH_EXTENSION
+  RestClient::OAUTH_EXTENSION = lambda do |request, args|
+    if args[:oauth]
+      uri             = URI.parse args[:url]
+      default_options = { :site               => "#{uri.scheme}://#{uri.host}:#{uri.port.to_s}",
+                          :request_token_path => "",
+                          :authorize_path     => "",
+                          :access_token_path  => "" }
+      options         = default_options.merge args[:oauth][:options] || { }
+      consumer        = OAuth::Consumer.new(args[:oauth][:consumer_key], args[:oauth][:consumer_secret], options)
+
+      consumer.sign!(request)
+    end
+  end
+end
+
+unless RestClient.before_execution_procs.include? RestClient::OAUTH_EXTENSION
+  RestClient.add_before_execution_proc &RestClient::OAUTH_EXTENSION
+end

data/lib/katello_api/version.rb

@@ -0,0 +1,3 @@
+module KatelloApi
+  VERSION = "0.0.1" unless defined? KatelloApi::VERSION
+end

data/lib/katello_api.rb

@@ -0,0 +1,23 @@
+require 'json'
+require 'yaml'
+
+module KatelloApi
+  def self.client_config
+    @client_config ||= YAML.load_file("#{root}/katello_api/config.yml")
+  end
+
+  def self.root
+    @root ||= File.expand_path(File.dirname(__FILE__))
+  end
+
+  def self.doc
+    @doc ||= File.open("#{root}/katello_api/documentation.json", 'r') do |f|
+      JSON.load(f.read)['docs']
+    end
+  end
+end
+
+require 'katello_api/base'
+require 'katello_api/version'
+resource_files = Dir[File.expand_path("#{KatelloApi.root}/katello_api/resources/*.rb", __FILE__)]
+resource_files.each { |f| require f }

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification 
+name: katello_api
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Katello
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-03-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 6
+        - 1
+        version: 1.6.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Helps you to use Katello's API calls from your app
+email: 
+- katello-devel@redhat.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- katello_api.gemspec
+- lib/katello_api.rb
+- lib/katello_api/base.rb
+- lib/katello_api/config.yml
+- lib/katello_api/resources/activation_key.rb
+- lib/katello_api/resources/architecture.rb
+- lib/katello_api/resources/changeset.rb
+- lib/katello_api/resources/changesets_content.rb
+- lib/katello_api/resources/compute_resource.rb
+- lib/katello_api/resources/config_template.rb
+- lib/katello_api/resources/content_view.rb
+- lib/katello_api/resources/content_view_definition.rb
+- lib/katello_api/resources/crl.rb
+- lib/katello_api/resources/distribution.rb
+- lib/katello_api/resources/distributor.rb
+- lib/katello_api/resources/domain.rb
+- lib/katello_api/resources/environment.rb
+- lib/katello_api/resources/erratum.rb
+- lib/katello_api/resources/gpg_key.rb
+- lib/katello_api/resources/hardware_model.rb
+- lib/katello_api/resources/organization.rb
+- lib/katello_api/resources/package.rb
+- lib/katello_api/resources/permission.rb
+- lib/katello_api/resources/ping.rb
+- lib/katello_api/resources/product.rb
+- lib/katello_api/resources/provider.rb
+- lib/katello_api/resources/repository.rb
+- lib/katello_api/resources/repository_set.rb
+- lib/katello_api/resources/role.rb
+- lib/katello_api/resources/role_ldap_group.rb
+- lib/katello_api/resources/smart_proxy.rb
+- lib/katello_api/resources/statu.rb
+- lib/katello_api/resources/subnet.rb
+- lib/katello_api/resources/subscription.rb
+- lib/katello_api/resources/sync.rb
+- lib/katello_api/resources/sync_plan.rb
+- lib/katello_api/resources/system.rb
+- lib/katello_api/resources/system_group.rb
+- lib/katello_api/resources/system_group_erratum.rb
+- lib/katello_api/resources/system_group_package.rb
+- lib/katello_api/resources/system_package.rb
+- lib/katello_api/resources/task.rb
+- lib/katello_api/resources/template.rb
+- lib/katello_api/resources/templates_content.rb
+- lib/katello_api/resources/uebercert.rb
+- lib/katello_api/resources/user.rb
+- lib/katello_api/rest_client_oauth.rb
+- lib/katello_api/version.rb
+homepage: http://github.com/katello/Katello
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Ruby bindings for Katello's rest API
+test_files: []
+