ilo-sdk 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ab6bf099aad85914a4e0a9b4c9399d9f263e722
-  data.tar.gz: ec8b5d88be00336190a2ee51f9f2e279c9fe75a9
+  metadata.gz: 3e3d66a47d72463a4564931c4c6764ccdcc9799f
+  data.tar.gz: 872a83c910c87089bc9ec82318f2ca9eb43a14c5
 SHA512:
-  metadata.gz: cacb3f0f39fc3bba895f1b1d7d2d8297c5ea9e850b3e967856fd965332f09168ee39e09e3d6467d4fa97e708bcf604a4cb22c819b477bba0e19e0bb7ba1efc13
-  data.tar.gz: 3e4a180967d557b4581d36c56042a39cf8cc945729db1ea4d0715da9d6ad9f7919f67e9a6886810edfeecf793be421f8e17ea3e3efabb450f316f9a3a512c693
+  metadata.gz: 1a184e445883fdaa526d4511d5a84bbccfbbbfcb56fc3fe530b161f73e2b72c9faeca92d69dcbef638db95fae104bdd68b8107e7430147bdde6fcc4b1f7a7ca0
+  data.tar.gz: 97689bb3dfb16e23afff23f3e232b7ad4df00cee038d4f3f241beff3986d71f078aab9bb6a57728ef6ac3056a52f035f3730431b6bc7420332cad218eb59935f

data/CHANGELOG.md

@@ -1,8 +1,14 @@
 ### New (Unreleased)
+
+#### v1.2.1
+ - Added rest command to cli
+
+### v1.2.0
  - Added custom exception classes
  - Added disable_proxy client option
  - Added CLI
  - Support environment variables
+ - New BIOS and ComputerSystem helper methods (deprecated old ones)
 
 ### v1.1.0
  - Added ManagerAccountHelper (to allow setting user permissions)

data/README.md

@@ -1,6 +1,7 @@
 # Ruby SDK for HPE iLO
 
 [![Gem Version](https://badge.fury.io/rb/ilo-sdk.svg)](https://badge.fury.io/rb/ilo-sdk)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/ilo-sdk)
 
 Software Development Kit for interacting with the Hewlett Packard Enterprise iLO (Integrated Lights-Out) server management technology.
 
@@ -292,7 +293,7 @@ empty = client.logs_empty?(log_type)
 # Get a specific type of logs based on severity level and duration:
 severity_level = 'OK'
 duration = 10 # hours
-logs = client.get_log(severity_level, duration, log_type)
+logs = client.get_logs(severity_level, duration, log_type)
 ```
 
 #### Manager Account
@@ -397,7 +398,7 @@ client.eject_virtual_media(id)
 
 ## Custom requests
 
-In most cases, interacting with the client object is enough, but sometimes you need to make your own custom requests to the iLO.
+This gem includes some usefull helper methods, but sometimes you need to make your own custom requests to the iLO.
 This project makes it extremely easy to do with some built-in methods for the client object. Here are some examples:
 
 ```ruby
@@ -408,10 +409,18 @@ response = client.rest_get('/rest/v1/Schemas')
 
 # Then we can validate the response and convert the response body into a hash...
 data = client.response_handler(response)
+
+# For updating iLO resources, use patch:
+options = { ServiceName: 'iLO Admin', ServiceEmail: 'admin@domain.com' }
+response = rest_patch('/redfish/v1/Systems/1/bios/Settings/', body: options)
+
+# For creating new iLO resources, use post:
+options = { UserName: 'admin', Password: '123' }
+response = rest_post('/redfish/v1/AccountService/Accounts/', body: options)
 ```
 
-This example is about as basic as it gets, but you can make any type of iLO request.
-If a resource does not do what you need, this will allow you to do it.
+These example are about as basic as it gets, but you can make any type of iLO API request.
+If a helper does not do what you need, this will allow you to do it.
 Please refer to the documentation and [code](lib/ilo-sdk/rest.rb) for complete list of methods and information about how to use them.
 
 

data/lib/ilo-sdk/cli.rb

@@ -60,6 +60,10 @@ module ILO_SDK
       desc: 'Username. Can also use ENV[\'ILO_USER\']',
       aliases: '-u'
 
+    class_option :password,
+      desc: 'Password. Can also use ENV[\'ILO_PASSWORD\']',
+      aliases: '-p'
+
     class_option :log_level,
       desc: 'Log level to use',
       aliases: '-l',
@@ -118,12 +122,56 @@ module ILO_SDK
       client_setup
       @client.response_handler(@client.rest_get('/redfish/v1/Sessions/'))
       puts 'Login Successful!'
+    rescue StandardError => e
+      fail_nice(e.message)
+    end
+
+    method_option :format,
+      desc: 'Output format (for response)',
+      aliases: '-f',
+      enum: %w(json yaml raw),
+      default: 'json'
+    method_option :data,
+      desc: 'Data to pass in the request body (in JSON format)',
+      aliases: '-d'
+    rest_examples =  "\n  ilo-ruby rest get   redfish/v1/"
+    rest_examples << "\n  ilo-ruby rest patch redfish/v1/Systems/1/bios/Settings/"
+    rest_examples << " -d '{\"ServiceName\":\"iLO Admin\",\"ServiceEmail\":\"admin@domain.com\"}'"
+    rest_examples << "\n  ilo-ruby rest post  redfish/v1/Managers/1/LogServices/IEL/ -d '{\"Action\":\"ClearLog\"}'"
+    desc 'rest METHOD URI', "Make REST call to the iLO API. Examples:#{rest_examples}"
+    def rest(method, uri)
+      client_setup('log_level' => :error)
+      uri_copy = uri.dup
+      uri_copy.prepend('/') unless uri_copy.start_with?('/')
+      if @options['data']
+        begin
+          data = { body: JSON.parse(@options['data']) }
+        rescue JSON::ParserError => e
+          fail_nice("Failed to parse data as JSON\n#{e.message}")
+        end
+      end
+      data ||= {}
+      response = @client.rest_api(method, uri_copy, data)
+      if response.code.to_i.between?(200, 299)
+        case @options['format']
+        when 'yaml'
+          puts JSON.parse(response.body).to_yaml
+        when 'json'
+          puts JSON.pretty_generate(JSON.parse(response.body))
+        else # raw
+          puts response.body
+        end
+      else
+        fail_nice("Request failed: #{response.inspect}\nHeaders: #{response.to_hash}\nBody: #{response.body}")
+      end
+    rescue ILO_SDK::InvalidRequest => e
+      fail_nice(e.message)
     end
 
     private
 
     def fail_nice(msg = nil)
-      puts "ERROR: #{msg}" if msg
+      $stderr.puts "ERROR: #{msg}" if msg
       exit 1
     end
 
@@ -132,6 +180,7 @@ module ILO_SDK
       client_params['ssl_enabled'] = false if @options['ssl_verify'] == false
       client_params['host'] ||= @options['host'] if @options['host']
       client_params['user'] ||= @options['user'] if @options['user']
+      client_params['password'] ||= @options['password'] if @options['password']
       client_params['log_level'] ||= @options['log_level'].to_sym if @options['log_level']
       @client = ILO_SDK::Client.new(client_params)
     rescue StandardError => e

data/lib/ilo-sdk/rest.rb

@@ -151,7 +151,7 @@ module ILO_SDK
       when 'delete', :delete
         request = Net::HTTP::Delete.new(uri.request_uri)
       else
-        raise InvalidRequest, "Invalid rest call: #{type}"
+        raise InvalidRequest, "Invalid rest method: #{type}. Valid methods are: get, post, put, patch, delete"
       end
       options['Content-Type'] ||= 'application/json'
       options.delete('Content-Type') if [:none, 'none', nil].include?(options['Content-Type'])

data/lib/ilo-sdk/version.rb

@@ -11,5 +11,5 @@
 
 # Gem version defined here
 module ILO_SDK
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.2.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ilo-sdk
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Anirudh Gupta
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-25 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor