Sha256: de6f3b83005f15589a17d92c231d89235e1953c9f5fcab1f09712a2ca65d2065

Contents?: true

Size: 1.5 KB

Versions: 10

Compression:

Stored size: 1.5 KB

Contents

= 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 




Version data entries

10 entries across 10 versions & 1 rubygems

Version Path
foreman_api-0.0.10 README.rdoc
foreman_api-0.0.9 README.rdoc
foreman_api-0.0.8 README.rdoc
foreman_api-0.0.7 README.rdoc
foreman_api-0.0.6 README.rdoc
foreman_api-0.0.5 README.rdoc
foreman_api-0.0.4 README.rdoc
foreman_api-0.0.3 README.rdoc
foreman_api-0.0.2 README.rdoc
foreman_api-0.0.1 README.rdoc