foreman_api 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

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,37 @@
+= Foreman API bindings for Ruby
+
+== Summary
+
+  require 'foreman_api'
+  architectures = ForemanApi::Resources::Architecture.new(:base_url => 'http://localhost:3000', 
+                                                          :username => 'admin', 
+                                                          :password => 'changeme')
+
+  pp architectures.index
+  [[{"architecture"=>{"id"=>5, "name"=>"i386"}},
+    {"architecture"=>{"id"=>9, "name"=>"ppc"}},
+    {"architecture"=>{"id"=>14, "name"=>"x86_64"}}],
+   "[{\"architecture\":{\"name\":\"i386\",\"id\":5}},{\"architecture\":{\"name\":\"ppc\",\"id\":9}},{\"architecture\":{\"name\":\"x86_64\",\"id\":14}}]"]
+  => nil
+
+== Description
+  
+This gem contains Foreman 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 comming soon.
+
+=== Authentication
+
+Foreman API supports authentication with username/password and OAuth. For use of OAuth with the bindings you only have to change the params
+
+  architectures = ForemanApi::Resources::Architecture.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/foreman_api.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/foreman_api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Martin Bačovský"]
+  gem.email         = ["mbacovsk@redhat.com"]
+  gem.description   = %q{Helps you to use Foreman's API calls from your app}
+  gem.summary       = %q{Ruby bindings for Forman's rest API}
+  gem.homepage      = "http://github.com/mbacovsky/foreman_api"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "foreman_api"
+  gem.require_paths = ["lib"]
+  gem.version       = ForemanApi::VERSION
+
+  gem.add_dependency 'json'
+  gem.add_dependency 'rest-client', '>= 1.6.1'
+  gem.add_dependency 'oauth'
+end

data/lib/foreman_api.rb

@@ -0,0 +1,13 @@
+require 'foreman_api/base'
+require 'foreman_api/version'
+
+resource_files = Dir[File.expand_path('../foreman_api/resources/*.rb', __FILE__)]
+resource_files.each { |f| require f }
+
+module ForemanApi
+  def self.client_config
+    @client_config ||= { :base_url => "http://localhost:3000",
+                         :oauth    => { :consumer_key    => 'consumer',
+                                        :consumer_secret => 'shhhh' } }
+  end
+end

data/lib/foreman_api/base.rb

@@ -0,0 +1,48 @@
+require 'rest_client'
+require 'oauth'
+require 'json'
+require 'foreman_api/rest_client_oauth'
+
+module ForemanApi
+  class Base
+    attr_reader :client
+
+    def initialize(config = ForemanApi.client_config)
+      @client = RestClient::Resource.new(config[:base_url],
+                                         :user     => config[:username],
+                                         :password => config[:password],
+                                         :oauth    => config[:oauth],
+                                         :headers  => { :content_type => 'application/json',
+                                                        :accept       => 'application/json' })
+    end
+
+    def call(method, path, payload = nil)
+      if payload && (method == :post || method == :put)
+        # TODO: is this neccessary? RestClient converts it automaticaly for me.
+        payload = payload.to_json
+      end
+      ret  = client[path].send(*([method, payload].compact))
+      data = begin
+        JSON.parse(ret.body)
+      rescue JSON::ParserError
+        ret.body
+      end
+      return data, ret
+    end
+
+    def validate_params!(options, valid_keys)
+      return unless options.is_a?(Hash)
+      invalid_keys = options.keys - (valid_keys.is_a?(Hash) ? valid_keys.keys : valid_keys)
+      raise ArgumentError, "Invalid keys: #{invalid_keys.join(", ")}" unless invalid_keys.empty?
+
+      if valid_keys.is_a? Hash
+        valid_keys.each do |key, keys|
+          if options[key]
+            validate_params!(options[key], keys)
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/foreman_api/resources/architecture.rb

@@ -0,0 +1,29 @@
+module ForemanApi
+  module Resources
+    class Architecture < ForemanApi::Base
+
+      def index
+        call(:get, "/api/architectures")
+      end
+
+      def show(id)
+        call(:get, "/api/architectures/#{id}")
+      end
+
+      def create(params = {})
+        validate_params!(params, {"architecture"=>["name"]})
+        call(:post, "/api/architectures", params)
+      end
+
+      def update(id, params = {})
+        validate_params!(params, {"architecture"=>["name"]})
+        call(:put, "/api/architectures/#{id}", params)
+      end
+
+      def destroy(id)
+        call(:delete, "/api/architectures/#{id}")
+      end
+
+    end
+  end
+end

data/lib/foreman_api/resources/bookmark.rb

@@ -0,0 +1,29 @@
+module ForemanApi
+  module Resources
+    class Bookmark < ForemanApi::Base
+
+      def index
+        call(:get, "/api/bookmarks")
+      end
+
+      def show(id)
+        call(:get, "/api/bookmarks/#{id}")
+      end
+
+      def create(params = {})
+        validate_params!(params, {"bookmark"=>["name", "controller", "query"]})
+        call(:post, "/api/bookmarks", params)
+      end
+
+      def update(id, params = {})
+        validate_params!(params, {"bookmark"=>["name", "controller", "query"]})
+        call(:put, "/api/bookmarks/#{id}", params)
+      end
+
+      def destroy(id)
+        call(:delete, "/api/bookmarks/#{id}")
+      end
+
+    end
+  end
+end

data/lib/foreman_api/resources/home.rb

@@ -0,0 +1,15 @@
+module ForemanApi
+  module Resources
+    class Home < ForemanApi::Base
+
+      def index
+        call(:get, "/api")
+      end
+
+      def status
+        call(:get, "/api/status")
+      end
+
+    end
+  end
+end

data/lib/foreman_api/resources/operating_system.rb

@@ -0,0 +1,34 @@
+module ForemanApi
+  module Resources
+    class OperatingSystem < ForemanApi::Base
+
+      def index
+        call(:get, "/api/operatingsystems")
+      end
+
+      def show(id)
+        call(:get, "/api/operatingsystems/#{id}")
+      end
+
+      def create(params = {})
+        validate_params!(params, {"operatingsystem"=>["name", "major", "minor"]})
+        call(:post, "/api/operatingsystems", params)
+      end
+
+      def update(id, params = {})
+        validate_params!(params, {"operatingsystem"=>["name", "major", "minor"]})
+        call(:put, "/api/operatingsystems/#{id}", params)
+      end
+
+      def destroy(id)
+        call(:delete, "/api/operatingsystems/#{id}")
+      end
+
+      def bootfiles(id, params = {})
+        validate_params!(params, ["medium", "architecture"])
+        call(:get, "/api/operatingsystems/#{id}/bootfiles", :params => params)
+      end
+
+    end
+  end
+end

data/lib/foreman_api/resources/user.rb

@@ -0,0 +1,29 @@
+module ForemanApi
+  module Resources
+    class User < ForemanApi::Base
+
+      def index
+        call(:get, "/api/users")
+      end
+
+      def show(id)
+        call(:get, "/api/users/#{id}")
+      end
+
+      def create(params = {})
+        validate_params!(params, {"user"=>["login", "firstname", "lastname", "mail", "admin"]})
+        call(:post, "/api/users", params)
+      end
+
+      def update(id, params = {})
+        validate_params!(params, {"user"=>["login", "firstname", "lastname", "mail", "admin"]})
+        call(:put, "/api/users/#{id}", params)
+      end
+
+      def destroy(id)
+        call(:delete, "/api/users/#{id}")
+      end
+
+    end
+  end
+end

data/lib/foreman_api/rest_client_oauth.rb

@@ -0,0 +1,29 @@
+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)
+
+
+      method_to_http_request = { :get    => Net::HTTP::Get,
+                                 :post   => Net::HTTP::Post,
+                                 :put    => Net::HTTP::Put,
+                                 :delete => Net::HTTP::Delete }
+
+      http_request = method_to_http_request[args[:method]].
+          new(args[:url]) # create Net::HTTPRequest to get oauth header,
+                          # because RestClient::Request is not supported by Oauth
+      consumer.sign!(http_request)
+      request['Authorization'] = http_request['Authorization'] # add oauth header to rest_client request
+    end
+  end
+end
+
+unless RestClient.before_execution_procs.include? RestClient::OAUTH_EXTENSION
+  RestClient.add_before_execution_proc &RestClient::OAUTH_EXTENSION
+end

data/lib/foreman_api/version.rb

@@ -0,0 +1,3 @@
+module ForemanApi
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: foreman_api
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Martin Ba\xC4\x8Dovsk\xC3\xBD"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-08-09 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 Foreman's API calls from your app
+email: 
+- mbacovsk@redhat.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- foreman_api.gemspec
+- lib/foreman_api.rb
+- lib/foreman_api/base.rb
+- lib/foreman_api/resources/architecture.rb
+- lib/foreman_api/resources/bookmark.rb
+- lib/foreman_api/resources/home.rb
+- lib/foreman_api/resources/operating_system.rb
+- lib/foreman_api/resources/user.rb
+- lib/foreman_api/rest_client_oauth.rb
+- lib/foreman_api/version.rb
+homepage: http://github.com/mbacovsky/foreman_api
+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.11
+signing_key: 
+specification_version: 3
+summary: Ruby bindings for Forman's rest API
+test_files: []
+