foreman_api 0.1.3 → 0.1.4

data/README.rdoc

@@ -2,17 +2,20 @@
 
 == Summary
 
+Usage:
+
   require 'foreman_api'
-  architectures = ForemanApi::Resources::Architecture.new(:base_url => 'http://localhost:3000', 
-                                                          :username => 'admin', 
-                                                          :password => 'changeme')
+  require 'logger' # optional
+
+  architectures = ForemanApi::Resources::Architecture.new(
+    {
+      :logger => Logger.new(STDOUT), # optional
+      :base_url => 'http://foreman-url', 
+      :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
+  puts architectures.index.inspect
 
 == Description
 
@@ -40,17 +43,31 @@ Only files under +lib/foreman_api/resources+ are touched by the generator.
 
 === 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
+Foreman API uses OAuth for authentication, you need to provide url, key and
+secret. Also, it is required to provide user which will be used for the request
+if oauth_map_users setting in the Foreman instance is set, otherwise 401 error
+will occur and Foreman log will state "users mapping error".
 
-The bindings are released under MIT license 
+When setting base_url make sure it *does not* include trailing slash, otherwise
+request can be refused with 401.
 
+  require 'foreman_api'
 
+  architectures = ForemanApi::Resources::Architecture.new(
+    {
+      :base_url => 'http://foreman-url', 
+      :oauth => {
+        :consumer_key    => 'katello',
+        :consumer_secret => "shhhh" 
+      }
+    },{
+      :headers => {
+        :foreman_user => "admin",
+      }
+    })
+
+  puts architectures.index.inspect
 
+== License
 
+The bindings are released under MIT license 

data/doc/ForemanApi/Resources/Architecture.html

@@ -6,7 +6,7 @@
 <title>
   Class: ForemanApi::Resources::Architecture
   
-    &mdash; Documentation by YARD 0.8.5.2
+    &mdash; Documentation by YARD 0.8.3
   
 </title>
 
@@ -164,9 +164,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-First item: parsed data; second item: raw body.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>First item: parsed data; second item: raw body.</p>
 </div></span>
   
 </li>
@@ -189,9 +188,8 @@ First item: parsed data; second item: raw body.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-First item: parsed data; second item: raw body.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>First item: parsed data; second item: raw body.</p>
 </div></span>
   
 </li>
@@ -214,9 +212,8 @@ First item: parsed data; second item: raw body.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-First item: parsed data; second item: raw body.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>First item: parsed data; second item: raw body.</p>
 </div></span>
   
 </li>
@@ -239,9 +236,8 @@ First item: parsed data; second item: raw body.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-First item: parsed data; second item: raw body.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>First item: parsed data; second item: raw body.</p>
 </div></span>
   
 </li>
@@ -264,9 +260,8 @@ First item: parsed data; second item: raw body.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-First item: parsed data; second item: raw body.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>First item: parsed data; second item: raw body.</p>
 </div></span>
   
 </li>
@@ -304,10 +299,9 @@ First item: parsed data; second item: raw body.
     <td>
       <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/architecture.rb', line 4</span>
 
-<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_doc identifier id'>doc</span>
-  <span class='rubyid_@doc ivar id'>@doc</span> <span class='opasgn op'>||=</span> <span class='rubyid_ForemanApi constant id'>ForemanApi</span><span class='dot token'>.</span><span class='rubyid_doc identifier id'>doc</span><span class='lbrack token'>[</span><span class='string val'>'resources'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>&quot;architectures&quot;</span><span class='rbrack token'>]</span>
-<span class='rubyid_end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
+  <span class='ivar'>@doc</span> <span class='op'>||=</span> <span class='const'>ForemanApi</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>resources</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>architectures</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
@@ -330,9 +324,8 @@ First item: parsed data; second item: raw body.
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>
-First item: parsed data; second item: raw body
-</p>
+    
+<p>First item: parsed data; second item: raw body</p>
 
 
   </div>
@@ -353,9 +346,8 @@ First item: parsed data; second item: raw body
       
       
         &mdash;
-        <div class='inline'><p>
-a hash of params to be passed to the service
-</p>
+        <div class='inline'>
+<p>a hash of params to be passed to the service</p>
 </div>
       
     </li>
@@ -372,9 +364,8 @@ a hash of params to be passed to the service
       
       
         &mdash;
-        <div class='inline'><p>
-additional http headers
-</p>
+        <div class='inline'>
+<p>additional http headers</p>
 </div>
       
     </li>
@@ -394,17 +385,13 @@ additional http headers
             
           </span>
           
-            &mdash; <div class='inline'><p>
-allowed keys are:
-</p>
-<ul>
-<li>operatingsystem_ids [String] Operatingsystem id&amp;#8217;s
-
-</li>
-<li>name [String]
-
-</li>
-</ul>
+            &mdash; <div class='inline'>
+<p>allowed keys are:</p>
+<ul><li>
+<p>operatingsystem_ids [String] Operatingsystem id&amp;#8217;s</p>
+</li><li>
+<p>name [String]</p>
+</li></ul>
 </div>
           
         </li>
@@ -425,9 +412,8 @@ allowed keys are:
       
       
         &mdash;
-        <div class='inline'><p>
-First item: parsed data; second item: raw body
-</p>
+        <div class='inline'>
+<p>First item: parsed data; second item: raw body</p>
 </div>
       
     </li>
@@ -447,10 +433,9 @@ First item: parsed data; second item: raw body
     <td>
       <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/architecture.rb', line 37</span>
 
-<span class='rubyid_def def kw'>def</span> <span class='rubyid_create identifier id'>create</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
-  <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
-<span class='rubyid_end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
@@ -467,9 +452,8 @@ First item: parsed data; second item: raw body
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>
-First item: parsed data; second item: raw body
-</p>
+    
+<p>First item: parsed data; second item: raw body</p>
 
 
   </div>
@@ -490,9 +474,8 @@ First item: parsed data; second item: raw body
       
       
         &mdash;
-        <div class='inline'><p>
-a hash of params to be passed to the service
-</p>
+        <div class='inline'>
+<p>a hash of params to be passed to the service</p>
 </div>
       
     </li>
@@ -509,9 +492,8 @@ a hash of params to be passed to the service
       
       
         &mdash;
-        <div class='inline'><p>
-additional http headers
-</p>
+        <div class='inline'>
+<p>additional http headers</p>
 </div>
       
     </li>
@@ -549,9 +531,8 @@ additional http headers
       
       
         &mdash;
-        <div class='inline'><p>
-First item: parsed data; second item: raw body
-</p>
+        <div class='inline'>
+<p>First item: parsed data; second item: raw body</p>
 </div>
       
     </li>
@@ -571,10 +552,9 @@ First item: parsed data; second item: raw body
     <td>
       <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/architecture.rb', line 59</span>
 
-<span class='rubyid_def def kw'>def</span> <span class='rubyid_destroy identifier id'>destroy</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
-  <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
-<span class='rubyid_end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
@@ -591,9 +571,8 @@ First item: parsed data; second item: raw body
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>
-First item: parsed data; second item: raw body
-</p>
+    
+<p>First item: parsed data; second item: raw body</p>
 
 
   </div>
@@ -614,9 +593,8 @@ First item: parsed data; second item: raw body
       
       
         &mdash;
-        <div class='inline'><p>
-a hash of params to be passed to the service
-</p>
+        <div class='inline'>
+<p>a hash of params to be passed to the service</p>
 </div>
       
     </li>
@@ -633,9 +611,8 @@ a hash of params to be passed to the service
       
       
         &mdash;
-        <div class='inline'><p>
-additional http headers
-</p>
+        <div class='inline'>
+<p>additional http headers</p>
 </div>
       
     </li>
@@ -655,9 +632,8 @@ additional http headers
             
           </span>
           
-            &mdash; <div class='inline'><p>
-Sort results
-</p>
+            &mdash; <div class='inline'>
+<p>Sort results</p>
 </div>
           
         </li>
@@ -669,9 +645,8 @@ Sort results
             
           </span>
           
-            &mdash; <div class='inline'><p>
-Paginate results
-</p>
+            &mdash; <div class='inline'>
+<p>Paginate results</p>
 </div>
           
         </li>
@@ -683,9 +658,8 @@ Paginate results
             
           </span>
           
-            &mdash; <div class='inline'><p>
-Number of entries per request
-</p>
+            &mdash; <div class='inline'>
+<p>Number of entries per request</p>
 </div>
           
         </li>
@@ -697,9 +671,8 @@ Number of entries per request
             
           </span>
           
-            &mdash; <div class='inline'><p>
-Filter results
-</p>
+            &mdash; <div class='inline'>
+<p>Filter results</p>
 </div>
           
         </li>
@@ -720,9 +693,8 @@ Filter results
       
       
         &mdash;
-        <div class='inline'><p>
-First item: parsed data; second item: raw body
-</p>
+        <div class='inline'>
+<p>First item: parsed data; second item: raw body</p>
 </div>
       
     </li>
@@ -742,10 +714,9 @@ First item: parsed data; second item: raw body
     <td>
       <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/architecture.rb', line 16</span>
 
-<span class='rubyid_def def kw'>def</span> <span class='rubyid_index identifier id'>index</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
-  <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
-<span class='rubyid_end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
@@ -762,9 +733,8 @@ First item: parsed data; second item: raw body
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>
-First item: parsed data; second item: raw body
-</p>
+    
+<p>First item: parsed data; second item: raw body</p>
 
 
   </div>
@@ -785,9 +755,8 @@ First item: parsed data; second item: raw body
       
       
         &mdash;
-        <div class='inline'><p>
-a hash of params to be passed to the service
-</p>
+        <div class='inline'>
+<p>a hash of params to be passed to the service</p>
 </div>
       
     </li>
@@ -804,9 +773,8 @@ a hash of params to be passed to the service
       
       
         &mdash;
-        <div class='inline'><p>
-additional http headers
-</p>
+        <div class='inline'>
+<p>additional http headers</p>
 </div>
       
     </li>
@@ -844,9 +812,8 @@ additional http headers
       
       
         &mdash;
-        <div class='inline'><p>
-First item: parsed data; second item: raw body
-</p>
+        <div class='inline'>
+<p>First item: parsed data; second item: raw body</p>
 </div>
       
     </li>
@@ -866,10 +833,9 @@ First item: parsed data; second item: raw body
     <td>
       <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/architecture.rb', line 25</span>
 
-<span class='rubyid_def def kw'>def</span> <span class='rubyid_show identifier id'>show</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
-  <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
-<span class='rubyid_end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='id identifier rubyid_show'>show</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
@@ -886,9 +852,8 @@ First item: parsed data; second item: raw body
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>
-First item: parsed data; second item: raw body
-</p>
+    
+<p>First item: parsed data; second item: raw body</p>
 
 
   </div>
@@ -909,9 +874,8 @@ First item: parsed data; second item: raw body
       
       
         &mdash;
-        <div class='inline'><p>
-a hash of params to be passed to the service
-</p>
+        <div class='inline'>
+<p>a hash of params to be passed to the service</p>
 </div>
       
     </li>
@@ -928,9 +892,8 @@ a hash of params to be passed to the service
       
       
         &mdash;
-        <div class='inline'><p>
-additional http headers
-</p>
+        <div class='inline'>
+<p>additional http headers</p>
 </div>
       
     </li>
@@ -959,17 +922,13 @@ additional http headers
             
           </span>
           
-            &mdash; <div class='inline'><p>
-allowed keys are:
-</p>
-<ul>
-<li>operatingsystem_ids [String] Operatingsystem id&amp;#8217;s
-
-</li>
-<li>name [String]
-
-</li>
-</ul>
+            &mdash; <div class='inline'>
+<p>allowed keys are:</p>
+<ul><li>
+<p>operatingsystem_ids [String] Operatingsystem id&amp;#8217;s</p>
+</li><li>
+<p>name [String]</p>
+</li></ul>
 </div>
           
         </li>
@@ -990,9 +949,8 @@ allowed keys are:
       
       
         &mdash;
-        <div class='inline'><p>
-First item: parsed data; second item: raw body
-</p>
+        <div class='inline'>
+<p>First item: parsed data; second item: raw body</p>
 </div>
       
     </li>
@@ -1012,10 +970,9 @@ First item: parsed data; second item: raw body
     <td>
       <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/architecture.rb', line 50</span>
 
-<span class='rubyid_def def kw'>def</span> <span class='rubyid_update identifier id'>update</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
-  <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
-<span class='rubyid_end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
@@ -1026,9 +983,9 @@ First item: parsed data; second item: raw body
 </div>
 
     <div id="footer">
-  Generated on Tue Mar 19 09:50:27 2013 by
+  Generated on Thu Jun 20 12:05:23 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.5.2 (ruby-1.8.7).
+  0.8.3 (ruby-1.9.3).
 </div>
 
   </body>