katello_api 0.0.1 → 0.0.2

data/lib/katello_api/resources/task.rb

@@ -9,20 +9,18 @@ module KatelloApi
       # @option params [String] organization_id  organization 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/organizations/:organization_id/tasks", params
-        call(:"get", url, params, headers)
+      # @return [Array] First item: parsed data; second item: raw body
+      def index(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] id  task 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/tasks/:id", params
-        call(:"get", url, params, headers)
+      # @return [Array] First item: parsed data; second item: raw body
+      def show(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
     end

data/lib/katello_api/resources/template.rb

@@ -10,96 +10,88 @@ module KatelloApi
       # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def index(params = {}, headers = {})
+        perform_call(__method__, 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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def show(params = {}, headers = {})
+        perform_call(__method__, 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 [Hash] template
+      #   allowed keys are:
+      #   * parent_id [String, nil]  parent template numeric identifier 
+      #   * description [String, nil]  template description 
+      #   * name [String]  new template 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/templates", params
-        call(:"post", url, params, headers)
+      # @return [Array] First item: parsed data; second item: raw body
+      def create(params = {}, headers = {})
+        perform_call(__method__, 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 ,
+      # @option params [Hash] template
+      #   allowed keys are:
+      #   * parent_id [String, nil]  parent template numeric identifier 
+      #   * description [String, nil]  template description 
+      #   * name [String]  new template 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/templates/:id", params
-        call(:"put", url, params, headers)
+      # @return [Array] First item: parsed data; second item: raw body
+      def update(params = {}, headers = {})
+        perform_call(__method__, 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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def destroy(params = {}, headers = {})
+        perform_call(__method__, 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 [Hash] template
+      #   allowed keys are:
+      #   * parent_id [String, nil]  parent template numeric identifier 
+      #   * description [String, nil]  template description 
+      #   * name [String]  new template name 
       # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def import(params = {}, headers = {})
+        perform_call(__method__, 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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def validate(params = {}, headers = {})
+        perform_call(__method__, 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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def export(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
     end

data/lib/katello_api/resources/templates_content.rb

@@ -6,14 +6,13 @@ module KatelloApi
       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 
+      # @option params [String] name  package 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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def add_package(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
@@ -21,22 +20,20 @@ module KatelloApi
       # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def remove_package(params = {}, headers = {})
+        perform_call(__method__, 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] name  parameter 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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def add_parameter(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
@@ -44,21 +41,19 @@ module KatelloApi
       # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def remove_parameter(params = {}, headers = {})
+        perform_call(__method__, 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 
+      # @option params [String] name  package group 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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def add_package_group(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
@@ -66,21 +61,19 @@ module KatelloApi
       # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def remove_package_group(params = {}, headers = {})
+        perform_call(__method__, 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 
+      # @option params [String] name  package group category 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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def add_package_group_category(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
@@ -88,10 +81,9 @@ module KatelloApi
       # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def remove_package_group_category(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
@@ -99,10 +91,9 @@ module KatelloApi
       # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def add_distribution(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
@@ -110,10 +101,9 @@ module KatelloApi
       # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def remove_distribution(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
@@ -121,10 +111,9 @@ module KatelloApi
       # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def add_repo(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
@@ -132,10 +121,9 @@ module KatelloApi
       # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def remove_repo(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
     end

data/lib/katello_api/resources/uebercert.rb

@@ -6,13 +6,13 @@ module KatelloApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
+      # @option params [Object] organization_id Part of +/api/organizations/:organization_id/uebercert+ path
       # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def show(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
     end

data/lib/katello_api/resources/user.rb

@@ -11,101 +11,98 @@ module KatelloApi
       # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def index(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
+      # @option params [Object] id Part of +/api/users/:id+ path
       #
       # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def show(params = {}, headers = {})
+        perform_call(__method__, 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 
+      # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def create(params = {}, headers = {})
+        perform_call(__method__, 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 [Object] id Part of +/api/users/:id+ path
+      # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def update(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
+      # @option params [Object] id Part of +/api/users/:id+ path
       #
       # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def destroy(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
+      # @option params [Object] user_id Part of +/api/users/:user_id/roles+ path
       #
       # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def list_roles(params = {}, headers = {})
+        perform_call(__method__, 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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def sync_ldap_roles(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [Numeric] role_id 
+      # @option params [Numeric] role_id
+      # @option params [Object] user_id Part of +/api/users/:user_id/roles+ path
       #
       # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def add_role(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
       # @param [Hash] params a hash of params to be passed to the service
+      # @option params [Object] id Part of +/api/users/:user_id/roles/:id+ path
+      # @option params [Object] user_id Part of +/api/users/:user_id/roles/:id+ path
       #
       # @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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def remove_role(params = {}, headers = {})
+        perform_call(__method__, 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)
+      # @return [Array] First item: parsed data; second item: raw body
+      def report(params = {}, headers = {})
+        perform_call(__method__, params, headers)
       end
 
     end

data/lib/katello_api/version.rb

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

data/lib/katello_api.rb

@@ -2,19 +2,6 @@ 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'