katello_api 0.0.1

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+gemspec
+
+group :generator do
+  gem 'activesupport'
+  gem 'thor'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Red Hat, Inc.
+
+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,53 @@
+= Katello API bindings for Ruby
+
+== Summary
+
+  require 'katello_api'
+  environments = KatelloApi::Resources::Environment.new(:base_url => 'http://localhost:3000', 
+                                                          :username => 'admin', 
+                                                          :password => 'changeme')
+
+  data, raw_response architectures.index(:organization_id => "ACME_Corporation")
+  pp data # parsed data of the response
+  pp raw_response # raw string of the response body
+
+== Description
+
+This gem contains Katello API bindings for the Ruby language. The
+bindings are generated from API documentation using
+{Apidoc}[https://github.com/Pajk/apipie-rails] tool.
+
+The bindings brings support for new versioned API which is not
+complete yet. The number of supported controllers is limited but more
+are coming soon.
+
+=== Regenerating bindings
+
+The code for generating the bindings is a part of this repo. The
+generator needs a running Katello instance to load the apidoc.json.
+
+Usage:
+
+    bin/generate.rb -h
+    Script for generating API bindings for Katello API from Apipie docs.
+        -u, --url KATELLO_APIDOC_URL     By default http://localhost:3000/apidoc
+        -h, --help
+
+Only files under +lib/katello_api/resources+ are touched by the generator.
+
+=== Authentication
+
+Katello API supports authentication with username/password and OAuth.
+For use of OAuth with the bindings you only have to change the params
+
+  environments = KatelloApi::Resources::Environment.new(:base_url => 'http://localhost:3000', 
+                                                          :oauth    => { :consumer_key    => 'mykey',
+                                                                         :consumer_secret => 'shhhh' })
+
+== License
+
+The bindings are released under MIT license
+
+
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/katello_api.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/katello_api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Katello"]
+  gem.email         = ["katello-devel@redhat.com"]
+  gem.description   = %q{Helps you to use Katello's API calls from your app}
+  gem.summary       = %q{Ruby bindings for Katello's rest API}
+  gem.homepage      = "http://github.com/katello/Katello"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.files.reject! do |fn|
+    fn.start_with?("lib/katello_api/generator") ||
+      fn == 'bin/generate.rb' ||
+      fn == 'rubygem-katello_api.spec'
+  end
+  gem.name          = "katello_api"
+  gem.require_paths = ["lib"]
+  gem.version       = KatelloApi::VERSION
+
+  gem.add_dependency 'json'
+  gem.add_dependency 'rest-client', '>= 1.6.1'
+  gem.add_dependency 'oauth'
+end

data/lib/katello_api/base.rb

@@ -0,0 +1,134 @@
+require 'rest_client'
+require 'oauth'
+require 'json'
+require 'katello_api/rest_client_oauth'
+
+module KatelloApi
+  class Base
+    API_VERSION = "1.0"
+
+    attr_reader :client, :config
+
+    def initialize(config, options = { })
+      @client = RestClient::Resource.new(
+          config[:base_url],
+          { :user => config[:username],
+            :password => config[:password],
+            :oauth => config[:oauth],
+            :headers => { :content_type => 'application/json',
+                          :accept => "application/json;version=#{API_VERSION}",
+                          'HTTP_KATELLO_USER' => 'admin' }
+          }.merge(options))
+      @config = config
+    end
+
+    def call(method, path, params = { }, headers = { })
+      headers ||= { }
+
+      args = [method]
+      if [:post, :put].include?(method)
+        args << params.to_json
+      else
+        headers[:params] = params if params
+      end
+
+      args << headers if headers
+      process_data client[path].send(*args)
+    end
+
+    def self.doc
+      raise NotImplementedError
+    end
+
+    def self.validation_hash(method)
+      validation_hashes[method.to_s]
+    end
+
+    def self.method_doc(method)
+      method_docs[method.to_s]
+    end
+
+    def validate_params!(params, rules)
+      return unless params.is_a?(Hash)
+
+      invalid_keys = params.keys.map(&:to_s) - (rules.is_a?(Hash) ? rules.keys : rules)
+      raise ArgumentError, "Invalid keys: #{invalid_keys.join(", ")}" unless invalid_keys.empty?
+
+      if rules.is_a? Hash
+        rules.each do |key, sub_keys|
+          validate_params!(params[key], sub_keys) if params[key]
+        end
+      end
+    end
+
+    protected
+
+    def process_data(response)
+      data = begin
+               JSON.parse(response.body)
+             rescue JSON::ParserError
+               response.body
+             end
+      return data, response
+    end
+
+    def check_params(params, options = { })
+      raise ArgumentError unless (method = options[:method])
+      return unless config[:enable_validations]
+
+      case options[:allowed]
+      when true
+        validate_params!(params, self.class.validation_hash(method))
+      when false
+        raise ArgumentError, "this method '#{method}' does not support params" if params && !params.empty?
+      else
+        raise ArgumentError, "options :allowed should be true or false, it was #{options[:allowed]}"
+      end
+    end
+
+    # @return url and rest of the params
+    def fill_params_in_url(url, params)
+      params          ||= { }
+      # insert param values
+      url_param_names = params_in_path(url)
+      url             = params_in_path(url).inject(url) do |url, param_name|
+        param_value = params[param_name] or
+          raise ArgumentError, "missing param '#{param_name}' in parameters"
+        url.sub(":#{param_name}", param_value.to_s)
+      end
+
+      return url, params.reject { |param_name, _| url_param_names.include? param_name }
+    end
+
+    private
+
+    def self.method_docs
+      @method_docs ||= doc['methods'].inject({ }) do |hash, method|
+        hash[method['name']] = method
+        hash
+      end
+    end
+
+    def self.validation_hashes
+      @validation_hashes ||= method_docs.inject({ }) do |hash, pair|
+        name, method_doc = pair
+        hash[name]       = construct_validation_hash method_doc
+        hash
+      end
+    end
+
+    def self.construct_validation_hash(method)
+      if method['params'].any? { |p| p['params'] }
+        method['params'].reduce({ }) do |h, p|
+          h.update(p['name'] => (p['params'] ? p['params'].map { |pp| pp['name'] } : nil))
+        end
+      else
+        method['params'].map { |p| p['name'] }
+      end
+    end
+
+    def params_in_path(url)
+      url.scan(/:([^\/]*)/).map { |m| m.first }
+    end
+  end
+end

data/lib/katello_api/config.yml

@@ -0,0 +1,6 @@
+---
+:base_url: http://localhost:3000
+:enable_validations: false
+:oauth:
+  :consumer_key: consumer
+  :consumer_secret: shhhh

data/lib/katello_api/resources/activation_key.rb

@@ -0,0 +1,104 @@
+module KatelloApi
+  module Resources
+    class ActivationKey < KatelloApi::Base
+      def self.doc
+        @doc ||= KatelloApi.doc['resources']["activation_keys"]
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] name  lists by activation key name 
+      #
+      # @param [Hash] headers additional http headers
+      def index(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        # we don't use the default path here from apipie
+        url, params = fill_params_in_url "/api/environments/:environment_id/activation_keys", 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/activation_keys/:id", params
+        call(:"get", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [Hash] activation_key 
+      #   allowed keys are: 
+      #   * content_view_id [String, nil]  content view id ,
+      #   * description [String, nil],
+      #   * name [String]  activation key identifier (alphanum characters, space, _ and -) ,
+      #
+      # @param [Hash] headers additional http headers
+      def create(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/activation_keys", params
+        call(:"post", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [Hash] activation_key 
+      #   allowed keys are: 
+      #   * content_view_id [String, nil]  content view id ,
+      #   * description [String, nil],
+      #   * environment_id [String, nil],
+      #   * name [String]  activation key identifier (alphanum characters, space, _ and -) ,
+      #
+      # @param [Hash] headers additional http headers
+      def update(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/activation_keys/: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 add_pool(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/activation_keys/:id/pools", 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_pool(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/activation_keys/:id/pools/:poolid", 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 destroy(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/activation_keys/: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 add_system_groups(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/organizations/:organization_id/activation_keys/:id/system_groups", 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_system_groups(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/organizations/:organization_id/activation_keys/:id/system_groups", params
+        call(:"delete", url, params, headers)
+      end
+
+    end
+  end
+end

data/lib/katello_api/resources/architecture.rb

@@ -0,0 +1,64 @@
+module KatelloApi
+  module Resources
+    class Architecture < KatelloApi::Base
+      def self.doc
+        @doc ||= KatelloApi.doc['resources']["architectures"]
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      #
+      # @param [Hash] headers additional http headers
+      def index(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/architectures", params
+        call(:"get", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id  architecture name 
+      #
+      # @param [Hash] headers additional http headers
+      def show(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/architectures/:id", params
+        call(:"get", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [Hash] architecture  architecture info 
+      #   allowed keys are: 
+      #   * name [String]  architecture name ,
+      #
+      # @param [Hash] headers additional http headers
+      def create(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/architecture", params
+        call(:"post", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id  architecture name 
+      # @option params [Hash] architecture  architecture info 
+      #   allowed keys are: 
+      #   * name [String]  architecture name ,
+      #
+      # @param [Hash] headers additional http headers
+      def update(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/architectures/: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  architecture name 
+      #
+      # @param [Hash] headers additional http headers
+      def destroy(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/architectures/:id", params
+        call(:"delete", url, params, headers)
+      end
+
+    end
+  end
+end

data/lib/katello_api/resources/changeset.rb

@@ -0,0 +1,83 @@
+module KatelloApi
+  module Resources
+    class Changeset < KatelloApi::Base
+      def self.doc
+        @doc ||= KatelloApi.doc['resources']["changesets"]
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] name  an optional changeset name to filter upon 
+      #
+      # @param [Hash] headers additional http headers
+      def index(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/organizations/:organization_id/environments/:environment_id/changesets", 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/changesets/:id", params
+        call(:"get", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [Hash] changeset 
+      #   allowed keys are: 
+      #   * description [String, nil]  the description of the changeset ,
+      #   * name [String]  the name of the changeset ,
+      #
+      # @param [Hash] headers additional http headers
+      def update(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/changesets/: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 dependencies(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/changesets/:id/dependencies", params
+        call(:"get", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [Hash] changeset 
+      #   allowed keys are: 
+      #   * description [String, nil]  the description of the changeset ,
+      #   * name [String]  the name of the changeset ,
+      #   * type [String],
+      #
+      # @param [Hash] headers additional http headers
+      def create(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/organizations/:organization_id/environments/:environment_id/changesets", 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 promote(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/changesets/:id/promote", 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 destroy(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/changesets/:id", params
+        call(:"delete", url, params, headers)
+      end
+
+    end
+  end
+end

data/lib/katello_api/resources/changesets_content.rb

@@ -0,0 +1,149 @@
+module KatelloApi
+  module Resources
+    class ChangesetsContent < KatelloApi::Base
+      def self.doc
+        @doc ||= KatelloApi.doc['resources']["changesets_content"]
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] product_id  the id of the product which should be added 
+      #
+      # @param [Hash] headers additional http headers
+      def add_product(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/changesets/:changeset_id/products", params
+        call(:"post", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] content_id  the id of the product to remove 
+      #
+      # @param [Hash] headers additional http headers
+      def remove_product(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/changesets/:changeset_id/products/: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  the nvrea of the package to add 
+      # @option params [String] product_id  the id of the product which contains the package 
+      #
+      # @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/changesets/:changeset_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] product_id  the id of the product which contains the package 
+      #
+      # @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/changesets/:changeset_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] erratum_id  the id of the errata to add 
+      # @option params [String] product_id  the product which contains the errata 
+      #
+      # @param [Hash] headers additional http headers
+      def add_erratum(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/changesets/:changeset_id/errata", params
+        call(:"post", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] product_id  the product which contains the errata 
+      #
+      # @param [Hash] headers additional http headers
+      def remove_erratum(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/changesets/:changeset_id/errata/:id", params
+        call(:"delete", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] repository_id  the id of the repository to add 
+      #
+      # @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/changesets/:changeset_id/repositories", 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_repo(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/changesets/:changeset_id/repositories/:id", params
+        call(:"delete", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] template_id  the id of the template to add 
+      #
+      # @param [Hash] headers additional http headers
+      def add_template(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/changesets/:changeset_id/templates", 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_template(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/changesets/:changeset_id/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] content_view_id  the id of the content view to add 
+      #
+      # @param [Hash] headers additional http headers
+      def add_content_view(params = { }, headers = { })
+        check_params params, :allowed => true, :method => __method__
+        url, params = fill_params_in_url "/api/changesets/:changeset_id/content_views", 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_content_view(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/changesets/:changeset_id/content_views/:id", params
+        call(:"delete", url, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] distribution_id  the id of the distribution to add 
+      # @option params [String] product_id  the product which contains the distribution 
+      #
+      # @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/changesets/:changeset_id/distributions", 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_distribution(params = { }, headers = { })
+        check_params params, :allowed => false, :method => __method__
+        url, params = fill_params_in_url "/api/changesets/:changeset_id/distributions/:id", params
+        call(:"delete", url, params, headers)
+      end
+
+    end
+  end
+end